Code Style. Python
Use this page to configure formatting options for Python files. View the result in the Preview pane on the right.
On this page:
- Tabs and Indents
- Wrapping and braces
- Blank lines
- Set from...
Before you start working with Python, make sure that Python plugin is installed and enabled. The plugin is not bundled with IntelliJ IDEA.
Also make sure that the following prerequisites are met:
- Python SDK is downloaded and installed on your machine.
- The required framework SDKs are downloaded and installed on your machine.
Refer to their respective download and installation pages for details:
Tabs and Indents
|Use tab character|| |
|Smart tabs|| |
The Smart Tabs check box is available if the Use Tab Character check box is selected.
|Tab size||In this text box, specify the number of spaces included in a tab.|
|Indent||In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted for each indent level.|
|Continuation indent||In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted between the elements of an array, in expressions, method declarations and method calls.|
|Keep indents on empty lines||If this check box is selected, then IntelliJ IDEA will keep indents on the empty lines as if they contained some code.|
If this check box is not selected, IntelliJ IDEA will delete the tab characters and spaces.
Use this tab to specify where you want spaces in your code. To have IntelliJ IDEA automatically insert a space at a location, select the check box next to this location in the list. The results are displayed in the Preview pane.
Wrapping and braces
In this tab, customize the code style options, which IntelliJ IDEA will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, etc.) The right-hand pane shows preview.
Alignment takes precedence over indentation options.
Right Margin (columns)
Use Right Margin field to specify a margin space required on the right side of an element. If you select Default option then a value of the right margin from the global settings is used.
Wrap on typing
Use Wrap on typing settings to specify how the edited text is fitted in the specified Right margin. You can select one the following options:
- Default - in this case IntelliJ IDEA uses the Wrap on typing option that is specified in the global settings.
- Yes - in this case IntelliJ IDEA uses the value specified in the Right Margin field.
- No - in this case this option is switched off and a line can exceed the value specified in the right margin.
Keep when reformatting
Use the check boxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line breaks check box is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks check box before you reformat the source code.
Use this tab to define where and how many blank lines you want IntelliJ IDEA to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the Preview pane.
|Keep Maximum Blank Lines||In this area, specify the number of blank lines to be kept after reformatting in the specified locations.|
|Minimum Blank Lines||In the text boxes in this area, specify the number of blank lines to be present in the specified locations. |
These settings do not influence the number of blank lines before the first and after the last item.
This table lists actions to be performed when imports are optimized.
|General||In this area, configure general import options. |
|JSP Imports Layout||In this area, configure how JSP import statements should be organized in your code. The introduced changes are displayed in the Preview pane below. |
|Packages to Use Import with '*'||In this area, configure a list of packages and classes to be always imported completely. |
|Import Layout|| In this area, configure how import statements should be organized in your code. You can set up certain classes to be positioned first, or last, or one after another. Imported classes will be grouped as per their packages and sorted alphabetically within a package. |
|Dict alignment||From the drop-down list, select the type of |
|Add line feed at the end of file||Select this check box to add line feed character at the end of file.|
|Use continuation indent for arguments||Select this check box to use continuation indent (defined in the Tabs and Indents tab) for list of arguments. If this check box is not selected, then the indent value is used.|
Click this link to reveal the list of languages to be used as the base for the current language code style. So doing, only the settings that are applicable to the current language are taken. All the other settings are not affected.
This link appears in the upper-right corner of the language-specific code style page, when applicable.
Click Reset to discard changes and return to the initial set of code style settings.