PyCharm 2019.3 Help

Code Style. Python

File | Settings | Editor | Code Style | Python for Windows and Linux
PyCharm | Preferences | Editor | Code Style | Python for macOS
Ctrl+Alt+S the Settings/Preferences icon


Use this section to configure formatting options for Python files. When you change these settings, results of a change are displayed in the Preview pane.

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, PyCharm 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 (or tabs if the Use tab character checkbox is selected) to be inserted for each indent level.

Continuation indent

In this field, specify the number of spaces (or tabs if the Use tab character checkbox is selected) 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, 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.

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

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.

Sort imported names in "from" imports

If this checkbox is selected, the imports in the from ... import ... statements are sorted alphabetically.

Not selected

Selected

from sys import version, path, modules
from sys import modules, path, version

Sort plain and 'from' imports separately within a group

If this checkbox 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 checkbox is selected, the imports are at first sorted by there type (first import, next from ... import ...), and then alphabetically.

Not selected

Selected

import os from os import getenv import sys from sys import path
import os import sys from os import getenv from sys import path

Sort case-insensitively

This checkbox enables case-insensitive sorting of the import statements. By default, the import statements are sorted case-sensitively.

Not selected

Selected

from django.http import HttpResponseRedirect from django.http import cookie from django.shortcuts import render from django.urls import reverse
from django.http import cookie from django.http import HttpResponseRedirect from django.shortcuts import render from django.urls import reverse

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.

Not selected

Selected

from django.http import HttpResponseRedirect from django.shortcuts import get_object_or_404, render from django.http import HttpResponse
from django.http import HttpResponseRedirect, HttpResponse from django.shortcuts import get_object_or_404, render

Always split imports

If this checkbox is selected, the "from" imports are always placed separately.

Not selected

Selected

from django.http import HttpResponseRedirect from django.shortcuts import get_object_or_404, render from django.http import HttpResponse
from django.http import HttpResponse from django.http import HttpResponseRedirect from django.shortcuts import get_object_or_404 from django.shortcuts import render

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. 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: 2 April 2020