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.

Prerequisites

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

Item	Description
Use tab character	If this checkbox is selected, tab characters are used: On pressing the `Tab` key For indentation For code reformatting When the checkbox is cleared, IntelliJ IDEA uses spaces instead of tabs.
Smart tabs	If this checkbox is selected, the part of indentation defined by the nesting of code blocks, is made of the tabs and (if necessary) spaces, while the part of indentation defined by the alignment is made only of spaces. If this checkbox is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment. 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 to be inserted for each indent level.
Continuation indent	In this field, specify the number of spaces 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.

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 the 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 the 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:

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.

Visual guides

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.

Wrapping options

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).

Item	Description
Wrapping style	From this list, select the desired wrapping style: Do not wrap: when this option is selected, no special wrapping style is applied. With this option selected, the nested alignment and braces settings are ignored. Wrap if long: select this option to have lines going beyond the right margin wrapped with proper indentation. Wrap always: select this option to have all elements in lists wrapped, so that there is one element per line with proper indentation. Chop down if long: select this option to have elements in lists that go beyond the right margin wrapped, so that there is one element per line with proper indentation.
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.

Item

Description

Wrapping style

From this list, select the desired wrapping style:

Do not wrap: when this option is selected, no special wrapping style is applied.
With this option selected, the nested alignment and braces settings are ignored.
Wrap if long: select this option to have lines going beyond the right margin wrapped with proper indentation.
Wrap always: select this option to have all elements in lists wrapped, so that there is one element per line with proper indentation.
Chop down if long: select this option to have elements in lists that go beyond the right margin wrapped, so that there is one element per line with proper indentation.

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.

Alignment options

Item	Description
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.
`<character(s)>` on next line	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 `<character>`	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, `else if` statements are located in the same line. Otherwise, `else if` statements are moved to the next line to the corresponding indent level.
Indent case branches	If this checkbox is selected, the `case` statement is located at the corresponding indent level. Otherwise, `case` statement is placed at the same indent level with `switch`.

Braces placement options

Item Description

Braces placement style

Item	Description
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: End of line: select this option to have the opening brace placed at the declaration line end. Next line if wrapped: select this option to have the opening brace placed at the beginning of the line after the multiline declaration line. Next line: select this option to have the opening brace placed at the beginning of the line after the declaration line. Next line shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level. Next line, each shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.
Force braces	From this list, choose the braces introduction method for `if`, `for`, `while`, and `do () while` statements. The available options are: Do not force: select this option to suppress introducing braces automatically. When multiline: select this option to have braces introduced automatically if a statement occupies more than one line. Note that IntelliJ IDEA analyzes the number of lines in the entire statement but not only its condition. IntelliJ IDEA will insert braces automatically: Always: select this checkbox to have braces always introduced automatically.

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:

End of line: select this option to have the opening brace placed at the declaration line end.
Next line if wrapped: select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.
Next line: select this option to have the opening brace placed at the beginning of the line after the declaration line.
Next line shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.
Next line, each shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.

Force braces

From this list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:

Do not force: select this option to suppress introducing braces automatically.
When multiline: select this option to have braces introduced automatically if a statement occupies more than one line. Note that IntelliJ IDEA analyzes the number of lines in the entire statement but not only its condition.
IntelliJ IDEA will insert braces automatically:
Always: select this checkbox to have braces always introduced automatically.

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.

Item	Description
Wrap first call	Allow wrapping the first method call in chained methods.
Align when multiline	Align several method calls.
Builder methods	Specify comma-separated names (identifiers) of methods that you want to be treated as builder methods. For example: `withTitle,withYear,addAuthor,withName,withLastName,end,build`
Keep builder methods indents	Keep additional indents that you insert manually intact as you reformat code.

Blank lines

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.

Item	Description
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 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.

Imports

This table lists actions to be performed when imports are optimized.

Item	Description
General	In this area, configure general import options. Options: Use single class import: import only a particular class from a package during code generation or import optimization. Otherwise, a statement that imports an entire package is inserted. Use fully qualified class names: use the fully qualified name of the class to be imported during code generation or import optimization. Otherwise, a normal import statement is inserted. Insert imports for inner classes: create imports for the inner classes referenced in your code. Use fully qualified names in JavaDoc: use fully qualified class names in Javadocs. Otherwise, a class is imported. Class count to use import with '': specify the number of classes to be imported from a single package until all statements that import a single class are substituted with a statement that imports an entire package. Names count to use static import with '': in this field, specify the number of members to be imported from a single class until all statements that import a single member are substituted with a statement that imports an entire class.
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. Options: Prefer comma separated import list: select this option to import statements organized in a comma separated list. Prefer one import statement per page directive: select this option to have one import statement created per line.
Packages to Use Import with '*'	In this area, configure a list of packages and classes to be always imported completely. Options: Static: select this checkbox, if you want to declare static import for the selected class. Package: in the text fields of this column, specify the packages and classes to be always imported completely. Note that IntelliJ IDEA automatically adds `.*` at the end of the package name once you finish typing. With Subpackages: select this checkbox to have all the subpackages of the selected package imported completely. Add Package: click this button to add a new entry to the list of packages and classes. Add Blank: click this button to add an empty separator to the list of packages and classes. Remove: click this button to delete the selected package or class from the list.
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. Options: Layout static imports separately: if this checkbox is selected, all static imports will be kept in a separate section. Otherwise, all import statements will be sorted according to the specified layout rules. Static: select this checkbox, if you want to declare static import for the selected package. Package: in the text fields of this column, specify the packages to be imported. With Subpackages: select this checkbox to have IntelliJ IDEA apply the layout rules to all the subpackages of the selected package. Add Package: click this button to add a new entry to the list of packages. Add Blank: click this button to have a blank line inserted after the selected entry, which indicates that a blank line should be inserted between the corresponding import statements. Move Up / Move Down: click these buttons to move a package or a blank line up or down in the list thus defining the order of import statements. Remove: click this button to delete the selected package from the list.

Other

Item Description

Dict alignment

Item	Description
Dict alignment	From the drop-down list, select the type of `dict` alignment: Do not align: the `dict` 's elements in sequential lines will be not aligned. Align on colon: the `dict` 's elements in sequential lines will be aligned against the colon. Align on value: the `dict` 's elements in sequential lines will be aligned against the value.
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.

From the drop-down list, select the type of dict alignment:

Do not align: the dict 's elements in sequential lines will be not aligned.
Align on colon: the dict 's elements in sequential lines will be aligned against the colon.
Align on value: the dict 's elements in sequential lines will be aligned against the value.

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.

Set from...

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.

Last modified: 08 March 2021