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.
Tabs and Indents
Item | Description |
---|---|
Use tab character | Use the Tab key for indentation. When the checkbox is cleared, PyCharm uses spaces instead of tabs. |
Smart tabs |
The Smart tabs checkbox is available if the Use tab character option is enabled. |
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 | Specify the indentation for lines that continue from the previous line, making it clear that they are part of the same statement or block of code. Continuation indents are used when a single statement is too long to fit on one line. |
Keep indents on empty lines | If this checkbox is selected, PyCharm will keep indents on the empty lines as if they contained some code. If this checkbox is cleared, PyCharm will delete the tab characters and spaces. |
Spaces
Use this tab to specify where you want spaces in your code. To have PyCharm 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 PyCharm 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.
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 PyCharm 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.
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.
Method declaration parameters
Click the field next to the setting to see the available options:
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.
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. |
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Place | Select this option to have the opening brace placed at the beginning of the line after the declaration line. |
Method call arguments
Click the field next to the setting to see the available options:
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.
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. |
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Place | Select this option to have the opening brace placed at the beginning of the line after the call line. |
Force new line after colon
With these option you can enable adding a new line after colon in single-clause statements and multi-clause statements (set by default).
Collections and Comprehensions
Select the Align when multiline checkbox to enable alignment of the elements in collections that formatted in several lines.
From import statements
Click the field next to the setting to see the available options:
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.
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. |
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Place | Select this option to have the opening brace placed at the beginning of the line after the import statement line. |
Force parentheses if multiline | Select this option to have braces introduced automatically, if a statement occupies more than one line. |
Force trailing comma if multiline | Select this option to add a comma automatically, if a statement occupies more than one line. |
Dictionary literals
Item | Description |
---|---|
New line after | Select this checkbox to have the code after the specified character moved to a new line. |
Place | Select this option to have the opening brace placed at the beginning of the line after the import statement line. |
Hang closing brackets
Select this checkbox to make the closing bracket indented. This option is disabled by default.
Blank lines
Use this tab to define where and how many blank lines you want PyCharm 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. |
Imports
This table lists actions to be performed when imports are optimized.
Item | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sort import statements | Select or clear this checkbox to enable or disable sorting imports within individual import groups according to PEP 8. The following checkboxes affect the sorting order. | ||||||||||||||||||||
| |||||||||||||||||||||
Structure of "from" imports | |||||||||||||||||||||
Leave as is | If this checkbox is selected, the "from" imports won't be restructured. | ||||||||||||||||||||
Join imports with the same source | If this checkbox is selected, the "from" imports of the same source are combined.
| ||||||||||||||||||||
Always split imports | If this checkbox is selected, the "from" imports are always placed separately.
|
Other
Item | Description |
---|---|
Dict alignment | 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 a 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.