Code Style. Python

Use this page to configure code style 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	If this checkbox is selected, tab characters are used: On pressing the `Tab` key For indentation For code reformatting When the checkbox is cleared, CLion 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, CLion will keep indents on the empty lines as if they contained some code. If this checkbox is cleared, CLion will delete the tab characters and spaces.

Spaces

Use this tab to specify where you want spaces in your code. To have CLion 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 CLion 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 CLion uses the Wrap on typing option that is specified in the global settings.
Yes: in this case CLion 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 CLion 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.

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	Use this list to specify the position of the opening brace in class declarations, function 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 CLion analyzes the number of lines in the entire statement but not only its condition. For example, if the code is int foo (int Days) { if ((Days % 10) == 3) return 1; else return 0; } CLion will insert braces automatically: int foo (int Days) { if ((Days % 10) == 3) { return 1; } else { return 0; } } Always: select this checkbox to have braces always introduced automatically.

Item

Description

Braces placement style

Use this list to specify the position of the opening brace in class declarations, function 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 CLion analyzes the number of lines in the entire statement but not only its condition.
For example, if the code is
int foo (int Days) { if ((Days % 10) == 3) return 1; else return 0; }
CLion will insert braces automatically:
int foo (int Days) { if ((Days % 10) == 3) { return 1; } else { return 0; } }
Always: select this checkbox to have braces always introduced automatically.

Blank lines

Use this tab to define where and how many blank lines you want CLion 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

Other

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.

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.

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.

Click Reset to discard changes and return to the initial set of code style settings.

Last modified: 08 December 2021