IntelliJ IDEA 2016.3 Help

Code Style. Python

File | Settings | Editor | Code Style | Python for Windows and Linux

IntelliJ IDEA | Preferences | Editor | Code Style | Python for OS X


Use this page to configure formatting options for Python files. View the result in the Preview pane on the right.

On this page:

Prerequisites

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

ItemDescription
Use tab character
  • If this check box is selected, tab characters are used:
    • On pressing the Tab key
    • For indentation
    • For code reformatting
  • When the check box is cleared, IntelliJ IDEA uses spaces instead of tabs.
Smart tabs
  • If this check box 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 check box 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 check box is available if the Use Tab Character check box is selected.

Tab sizeIn this text box, specify the number of spaces included in a tab.
IndentIn 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 indentIn 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 linesIf 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.

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.

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.

ItemDescription
Keep Maximum Blank LinesIn this area, specify the number of blank lines to be kept after reformatting in the specified locations.
Minimum Blank LinesIn the text boxes 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.

ItemDescription
GeneralIn this area, configure general import options.

Options:

  • Use single class import: Select this check box to have IntelliJ IDEA import only a particular class from a package during code generation or import optimization. Otherwise, a statement importing an entire package is inserted.
  • Use fully qualified class names: Select this check box to have IntelliJ IDEA 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: Select this check box to have IntelliJ IDEA create imports for the inner classes referenced in your code.
  • Use fully qualified names in Javadoc: Select this check box to have IntelliJ IDEA use a fully qualified class name in Javadoc. Otherwise, a class is imported.
  • Class count to use import with '*': In this text field, specify the number of classes to be imported from a single package until all statements importing a single class are substituted with a statement importing an entire package.
  • Names count to use static import with '*': In this text box, specify the number of members to be imported from a single class until all statements importing a single member are substituted with a statement importing an entire class.
JSP Imports LayoutIn 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 check box, 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.
  • With Subpackages: Select this check box 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 check box 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 check box, 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 check box 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

ItemDescription
Dict alignmentFrom 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 fileSelect this check box to add line feed character at the end of file.
Use continuation indent for argumentsSelect 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.

Set from...

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.

See Also

Last modified: 29 November 2016