PyCharm 2016.2 Help

Code Style. Python

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

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

Note that when a piece of code is selected in the editor, PyCharm suggests the quick fix Adjust code style settings.

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, PyCharm uses spaces instead of tabs.
Smart tabs
  • If this check box is selected, PyCharm inserts tabs for indentation and reformatting. PyCharm inserts tabs in the beginning of each line until a symbol other than the tab is inserted. After that when you press the tab key, PyCharm will enter 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 cleared, then PyCharm will keep indents on the empty lines as if they contained some code.
If this check box is not selected, PyCharm will delete the tabulation characters.
Indent all chained calls in a group The check box is available only when the Indent chained methods check box is selected.

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 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 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, 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 PyCharm uses the Wrap on typing option that is specified in the global settings.
  • Yes - in this case PyCharm 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 PyCharm 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 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.

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
Sort import statementsSelect or clear this check box to enable or disable sorting imports within individual import groups according to PEP 8. The following two check boxes affect the sorting order.
Sort imported names in "from" importsIf this check box is selected, the imports in the from ... import ... statements are sorted alphabetically.
Not selectedSelected
from sys import version, path, modules
from sys import modules, path, version
Sort imports by type first within their sectionsIf this check box is not selected, the imports from the same module, regardless of their type, are grouped together, but so that import statements go first, and from ... import ... statements go next.

If this check box is selected, the imports are at first sorted by there type (first import, next from ... import ...), and then alphabetically.

Not selectedSelected
import os from os import getenv import sys from sys import path
import os import sys from os import getenv from sys import path
Join "from" imports with the same sourceIf this check box is selected, the "from" imports of the same source are combined.
Not selectedSelected
from os.path import join from os.path import relpath, abspath from os.path import dirname, basename
from os.path import join, relpath, abspath, dirname, basename

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 August 2016