PyCharm Usage

How does it work?

Sourcery scans the currently open Python file. If it finds improvements in your code it returns them as a list of refactorings. You can see these in the editor as highlighted sections of code.

How do I see all the refactorings?

The refactorings appear in the Sourcery tool window (which appears at the bottom of the screen). You can click on each refactoring to scroll to it. To see a diff of the suggested changes, click on the arrow next to it in the tool window to expand it.

How do I apply a refactoring?

There are 3 options:

1. Press Alt+Enter on the suggested refactoring and apply the refactoring
2. Hover the mouse over the refactoring and a lightbulb will appear. Click the lightbulb and apply the refactoring.
3. Right click on the suggested refactoring in the Sourcery window and select the Refactor function option

How do I configure Sourcery?

You can configure Sourcery to ignore certain files or folders in your project. Please see the Sourcery configuration section for details.

How do I disable Sourcery on a function?

There are 3 options:

1. Add this comment to the function definition: # sourcery off.
   For example:

   def func(a, b):  # sourcery off
       return a + b

2. Press Alt+Enter on the suggested refactoring and select the Disable Sourcery for this function option
3. Right click on the suggested refactoring in the code editor and select the Disable Sourcery for this function option