Getting Started with Sourcery for JetBrains - Intellij, PyCharm and more¶
Installation¶
- In your JetBrains IDE (IntelliJ, PyCharm, etc), press Ctrl+Alt+S or Cmd+, to open the preferences dialog and select Plugins.
- Search for Sourcery in the Marketplace tab and click Install
- Click the Restart IDE button
Logging In¶
Log in by opening the IDE commands
(Ctrl+Shift+A or
Shift+Cmd+A) and running Sourcery: Login
or
by clicking the Log in in browser
or Log in with token
options on the
notification that pops up in your IDE.
If you choose to log in through your browser, you'll be taken to a log in page and then you'll be asked to confirm that the code in your browser matches what you're shown in your IDE.
To log in with your token, copy the token from your Sourcery dashboard and paste it in the input box in your IDE extension settings.
If you do not have a Sourcery account you can sign up for one here
Chatting with the Coding Assistant¶
Once you’ve opted into the Coding Assistant you can start interacting with it. You can ask a question right away - try asking it to write you code for any purpose or ask it a general coding question.
To have it update existing sections of your code or answer a question about a specific piece of your code, highlight that section first in your IDE and then type your question into the Coding Assistant sidebar.
Generate Tests & Docstrings¶
Sourcery can generate tests and docstrings for your code on demand. The easiest
way to start is to click the Generate Test
or Generate Docstring
code lens
above a function. This will immediately start to generate tests or a docstring
in the sidebar.
You can then click the “copy” button to copy the generated code, or the “inset at cursor” button to add the code into your open file at your cursor’s current location.
You also can select a section of code, go to the “Recipes” tab of the sidebar
and choose the Generate Test
or Generate Docstring
button to generate tests
or a docstring for that selected section of code.
Review Your Code¶
Click on the Review Code tab in the Sourcery sidebar to bring up the Code Review mode. In this mode Sourcery will review the diff of your uncommitted changes to a branch (typically main) or the diff between two branches and generate a code review based on those changes.
It will try to provide you with a high level summary of the changes, a high level review for those changes, and then specific comments about the changes that you can then choose to apply or not.
Select the two branches you want to compare and click the Review button to start your first review.
Seeing Your First Suggestions¶
When you first install Sourcery you should see a welcome file open in your JetBrains IDE. This will include a few instructions for getting started and a demo function with a suggested refactoring.
Any suggestion from Sourcery will be highlighted/underlined. Hover your mouse over the underlined/highlighted section to see a description of the proposed change and a diff of the changes. There are three wys you can interact with a Sourcery suggestion
- Press Alt+Enter when you have selected the highlighted line and then choose to apply the refactoring
- Click on the lightbulb icon next to the highlighted line and then select to accept the refactoring
- In the Problems window, right click on the suggested refactoring, and select Refactor Function
You can also try out Sourcery by copying this code into a Python file in PyCharm or Intellij Ultimate:
def merge_nested_if(a, b):
if a:
if b:
return c
Sourcery will suggest merging together the nested if statements so you get:
def merge_nested_if(a, b):
if a and b:
return c
Accept a Suggestion¶
To accept a suggestion you can:
- Press Alt+Enter when you have selected the highlighted line and then choose to apply the refactoring
- Click on the lightbulb icon next to the highlighted line and then select to accept the refactoring
- In the Problems window, right click on the suggested refactoring, and select Refactor Function
Sourcery Hub¶
The Sourcery Hub allows you to quickly configure Sourcery. To open it, find the
section on the status bar which says Sourcery
and click on it. The hub should
then open in your default browser.
The Project Config
screen allows you to switch Sourcery rules on and off. When
you do so it will edit or create a .sourcery.yaml
file in your project. This
is the configuration file used by Sourcery.
You can also go to the Your Plan
section to get information about your
Sourcery account, and the benefits of upgrading to Pro
and Team
accounts.
Skip a Suggestion¶
You can skip a Sourcery suggestion once by choosing the skip option from the Sourcery action items menu:
- Press Alt+Enter when you have selected the highlighted line and then choose to skip the refactoring
- Click on the lightbulb icon next to the highlighted line and then select to skip the refactoring
- In the Problems window, right click on the suggested refactoring, and select Skip
You can also tell Sourcery not to suggest anything or a specific type of rule for a function.
-
Add a comment
# sourcery skip
to a function to skip all rules for that function -
Add a comment
# sourcery skip: <rule-id>
to a function to skip the specific rule in that function. A full list of rules and their IDs are available at: - JavaScript Rules.
See Code Quality Metrics¶
Sourcery gives each of your functions a quality score on 4 different metrics:
- Complexity
- Method Length
- Working Memory
- Overall Quality
To see the metrics for any function, simply hover your mouse of the line defining the function and the Sourcery metrics will pop up. Each metric will have a numeric score, along with a quick qualitative guide ranging from bad to excellent.
Sourcery will also automatically flag functions with too low of an overall quality score. By default this is set for functions with a quality score under 25%, but you can adjust this threshold.
Extract Duplicate Code Into Methods¶
Sourcery will automatically detect opportunities for repeated or nearly repeated sections of code within a function to be extracted out into their own methods. When these refactorings are suggested, the new methods will be given a generic name based on the function it was extracted from and you can easily rename it.
Configuring Sourcery¶
See our section on Configuring Sourcery for details on customizing your Sourcery configuration.