PyCharm 2021.1 Help

Code Style. JSON

Use this page to configure formatting options for JSON files. When you change these settings, the Preview pane shows how this will affect your code.

Tabs and Indents

Use tab character
  • If this checkbox is selected, tab characters are used:

    • On pressing the Tab key

    • For indentation

    • For reformatting code

  • If the checkbox is cleared, PyCharm uses spaces instead of tabs.

Smart tabs

An indentation consists of two parts. One part results from nesting code blocks, and the other part is determined by alignment.

  • If this checkbox is selected, the part that results from nesting contains both tabs and spaces (if necessary), while the part defined by alignment consists only of spaces.

  • If this checkbox is cleared, only tabs are used. This means that after reformatting a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.

Tab sizeIn this field, specify the number of spaces that fits in a tab.
IndentIn 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 linesIf this checkbox is selected, PyCharm retains indents on empty lines as if they contained some code. If the checkbox is cleared, PyCharm deletes the tab characters and spaces on empty lines.

Spaces

Use this tab to specify where you want PyCharm to insert spaces automatically. Select the checkboxes next to the description of relevant locations and check the results in the Preview pane.

Wrapping and braces

In this tab, customize the exceptions, brace placement and alignment options that PyCharm will apply to various code constructs on reformatting the source code. Check the results in the Preview pane.
Hard wrap atIn this field, specify the number of spaces required to the right of an element. If you accept the Default option then the value from the global settings is used.
Wrap on typing

In this field, specify how the edited text is fitted in the specified Hard wrap at field.

  • Default: choose this option to use the Wrap on typing value from the global settings.

  • Yes: choose this option to use the value from the Right Margin field.

  • No: if you choose this option a line can exceed the value specified in the right margin.

Visual guidesIn this field, 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 PyCharm 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 reformatting.

Wrapping options

A wrapping style applies to various code constructs, specified in the left-hand pane (for example, method call arguments, or assignment statements).

  • Do not wrap- When this option is selected, no special wrapping style is applied, the nested alignment and braces settings are ignored.

  • Wrap if long- Select this option to wrap lines that go beyond the right margin with proper indentation.

  • Wrap always- Select this option to wrap all elements in lists so that there is one element per line with proper indentation.

  • Chop down if long- Select this option to wrap elements in lists that go beyond the right margin so that there is one element per line with proper indentation.

  • Ensure right margin is not exceeded- If this checkbox is selected, the formatter will do its best to avoid having document lines exceeding the right margin. This option takes precedence over the Do not wrap wrapping style.

Alignment options

  • Objects- From the list, choose how to align objects:

    • Do not align: the attributes in sequential lines will be not aligned.

    • On colon: the attributes in sequential lines will be aligned against the colon.

    • On value: the attributes in sequential lines will be aligned against the value.

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. The results are displayed in the Preview pane.

Keep Maximum Blank LinesIn this area, specify the number of extra blank lines to be kept after reformatting.
Last modified: 08 March 2021