PyCharm
 
2021.2
Shortcuts: Windows
Get PyCharm
You are viewing the documentation for an earlier version of PyCharm.
  1. Configure PyCharm
  2. Code style

Configuring code style

Last modified: 13 October 2021

If certain coding guidelines exist in a company, one has to follow these guidelines when creating source code. PyCharm helps you maintain the required code style.

Code styles are defined at the project level and at the IDE level (global).

  • At the project level, settings are grouped under the Project scheme, which is predefined and is marked in bold. The Project style scheme is applied to the current project only.

    You can copy the Project scheme to the IDE level, using the Copy to IDE command.

  • At the IDE level, settings are grouped under the predefined Default scheme (marked in bold), and any other scheme created by the user by the Duplicate command (marked as plain text). Global settings are used when the user doesn't want to keep code style settings with the project and share them.

    You can copy the IDE scheme to the current project, using the Copy to Project command.

Configure code style for a language

  1. Press Ctrl+Alt+S to open the IDE settings and select Editor | Code Style.

  2. Select the language-specific settings page.

  3. Choose the code style Scheme to be used as a base for your custom code style for the selected language.

  4. Browse through the tabs of the selected language page, and configure code style preferences for it.

Copy code style settings from other languages

For most of the supported languages, you can copy code style settings from other languages or frameworks.

  1. Press Ctrl+Alt+S to open the IDE settings and select Editor | Code Style.

  2. Select the language-specific settings page.

  3. Click Set From in the upper-right corner.

    The link is shown for those languages only, where defining settings on the base of other languages is applicable.

  4. From the list that appears, select the language to copy the code style from.

    Set code style

Create a copy of code style settings

You can define the code styles that differ from the pre-defined ones. These code style schemes are stored in XML files, in the config/codestyles folder under the user home directory. You can use the created copy for modifying code styles, and for export.

If you select a code style scheme other than Project, then this code style will be saved for a project. Thus you can assign a global (IDE) code style for each project.

  1. Press Ctrl+Alt+S to open the IDE settings and select Editor | Code Style.

  2. Select the desired scheme from the Scheme list and click the Scheme Settings icon.

  3. Select one of the following options:

    • Copy to IDE - select this option to store the selected scheme in a global level.

      PyCharm saves the new code style with the specified name in the config/codestyles/<code_style_name>.xml file under the PyCharm home directory.

    • Copy to Project - select this option to store the selected scheme in a project level.

      The selected code style is saved in the .idea directory in the file codeStyleSettings.xml.

    • Duplicate - select this option to make a copy of the selected scheme and store it in the same level.

  4. In the Scheme field, type the name of the new scheme and press Enter to save the changes.

Manage code style schemes

  1. In the Code Style page, select the desired scheme and click manage profiles.

  2. Select one of the following options:

    • Rename - select this option to change the name of the selected scheme.

    • Export - select this option to export your code style settings to the desired location.

    • Import Scheme - select this option to import PyCharm XML code style settings, JSCS config file, or Eclipse XML Profile.

  3. In the Scheme field, type the name of the new scheme and press Enter to save the changes.

Manage code style on a directory level with EditorConfig

note

To use EditorConfig, make sure the EditorConfig plugin is enabled on the Settings/Preferences | Plugins page, tab Installed, see Managing plugins for details.

PyCharm allows you to manage all code style settings for each individual set of files with EditorConfig support (enabled by default in the Settings/Preferences dialog Ctrl+Alt+S). All you need to do is place an .editorconfig file in the root directory containing the files whose code style you want to define. You can have as many .editorconfig files within a project as needed, so you can specify different styles for different modules.

All options from the .editorconfig file are applied to the directory where it resides as well as all of its sub-directories on top of the current project code style. If anything is not defined in .editorconfig, it's taken from the project settings.

All options in the .editorconfig file are divided into the following categories:

  • Standard options such as indent_size, indent_style, and so on. These options do not have any domain specific prefixes.

  • Generic IntelliJ options that have the ij_ prefix and are applicable to all languages:

    • ij_visual_guides

    • ij_formatter_off_tag

    • ij_formatter_on_tag

    • ij_formatter_tags_enabled

    • ij_wrap_on_typing

    • ij_continuation_indent_size

    • ij_smart_tabs

  • Common IntelliJ options supported by many (but not all) languages. They start with the ij_any prefix, for example, ij_any_brace_style.

  • IntelliJ language-specific options starting with the ij_<lang>_ prefix where <lang> is the language domain ID (normally a low-case language name), for example, ij_java_blank_lines_after_imports.

note

The same options can be defined as a common option and a language-specific option, for example, ij_<...>_brace_style. Language-specific options have higher priority over common or generic options.

Add an .editorconfig file

  1. In the Project view, right-click a source directory containing the files whose code style you want to define and choose New | EditorConfig from the context menu.

  2. Select the properties that you want to define so that PyCharm creates stubs for them, or leave all checkboxes empty to add the required properties manually.

  3. To preview how changes to your code style settings will impact the actual source files, click the eye icon in the gutter of the .editorconfig file and select a source file affected by it. The preview will open on the right.

    editorconfig preview

    You can make changes in the preview pane to try and test how your configuration changes are reflected without worrying about making unwanted changes to the source code: all these changes are discarded when you close the .editorconfig file.

See also

Procedures

Reference