Code Style. Python
Use this page to configure formatting options for Python files. When you change these settings, the Preview pane shows how this will affect your code.
Before you start working with Python, make sure that Python plugin is installed and enabled. Press Ctrl+Alt+S, go to Plugins and inspect the Installed tab to ensure the plugin is enabled.
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|
The Smart Tabs checkbox is available if the Use tab character checkbox is selected.
|Tab size||In this field, specify the number of spaces included in a tab.|
|Indent||In this field, specify the number of spaces (or tabs if the Use tab character checkbox is selected) to be inserted for each indent level.|
|Continuation indent||In this field, specify the number of spaces (or tabs if the Use tab character checkbox 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 checkbox is selected, IntelliJ IDEA will keep indents on the empty lines as if they contained some code. |
If this checkbox is cleared, 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 checkbox 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, and so on) The right-hand pane shows preview.
Alignment takes precedence over indentation options.
Hard wrap at
Use the Hard wrap at 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 the Wrap on typing settings to specify how the edited text is fitted in the specified Hard wrap at. 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.
Use the Visual guides field to specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.
Keep when reformatting
Use the checkboxes to configure exceptions that IntelliJ IDEA will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox before you reformat the source code.
The wrapping style applies to the various code constructs, specified in the left-hand pane (for example, method call arguments, method declaration parameters, or assignment statements).
From this list, select the desired wrapping style:
|Ensure right margin is not exceeded||If this checkbox is selected, the formatter will do its best to avoid having document lines exceeding the right margin. This option takes precedence over the Do not wrap wrapping style.|
|Align when multiline||If this checkbox is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level.|
|Align parenthesised when multiline||If this checkbox is selected, a parenthesised code construct starts at the column of the opening parenthesis each next line. Otherwise, the position of a code construct is determined by the current indentation level.|
|Select this checkbox to have the specified character or characters moved to the next line when the lines are wrapped.|
|'else' on new line||Use this checkbox to have the corresponding statements or characters moved to the next line.|
|New line after ||Select this checkbox to have the code after the specified character moved to a new line.|
|Special else if treatment|
If this checkbox is selected,
|Indent case branches||If this checkbox is selected, the |
Braces placement options
|Braces placement style|
Use this list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
From this list, choose the braces introduction method for
Chained method calls
Use the following options to format chained method calls and make them easier to read. Note that builder method calls are always wrapped regardless of the settings for chained calls.
|Wrap first call||Allow wrapping the first method call in chained methods.|
|Align when multiline||Align several method calls.|
Specify comma-separated names (identifiers) of methods that you want to be treated as builder methods.
|Keep builder methods indents||Keep additional indents that you insert manually intact as you reformat 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.
This table lists actions to be performed when imports are optimized.
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.
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.
From the drop-down list, select the type of
|Add line feed at the end of file||Select this checkbox to add line feed character at the end of file.|
|Use continuation indent for||Select the Method call argument checkbox to use continuation indent for list of arguments and the Collections and comprehensions checkbox for multi-line collection literals and comprehensions. By default, the Method declaration parameters is selected, so that parameters within a method be indented using the continuation indent value. The value of the continuation indent is defined in the Tabs and Indents tab. If these checkboxes are 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. 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.