Reformat and rearrange code
PyCharm lets you reformat your code according to the requirements you've specified in the Code Style settings. However, if you use EditorConfig in your project, options specified in the
.editorconfig file override the ones specified in the code style settings when you reformat the code.
You can reformat a part of code, the whole file, group of files, a directory, and a module. You can also exclude part of code or some files from the reformatting.
Reformat a code fragment in a file
In the editor, select a code fragment you want to reformat.
From the main menu, selectCtrl+Alt+L.
Reformat a file
Either open your file in the editor and press Ctrl+Shift+Alt+L or in the Project tool window, right-click the file and select .
In the dialog that opens, if you need, select the following reformatting options:
Optimize imports: select this option if you want to remove unused imports, add missing ones, or organize import statements.
Rearrange entries: select this option if you need to rearrange your code based on the arrangement rules specified in the code style settings.
Clean up code: select this option to run the code cleanup inspections.
Reformat line indents
You can reformat line indents based on the specified settings.
Exclude code or a file from reformatting
You can exclude a group of files or part of code from reformatting.
On the Formatter Control tab, select the Enable formatter markers in comments checkbox. The Scope area becomes active
In the Scope area, click to add a scope where you can specify files that you want to exclude from reformatting.
If you try reformatting the excluded file, PyCharm displays a popup notifying you that formatting for this file is disabled. If you need, click the link in the popup to open the Code Style settings page and change the exclusion scope.
Exclude code fragments from reformatting in the editor
In the editor, at the beginning of a region that you want to exclude, create a line comment Ctrl+/ and type
//@formatter:off, at the end of the region, again create a line comment and type
Keep existing formatting
You can select formatting rules which will be ignored when you reformat the code. For example, you can adjust the IDE to keep simple methods and functions in one line, whereas normally they are expanded into multiple lines after code reformatting.
Go to Wrapping and Braces tab., select your programming language, and open the
In the Keep when reformatting section, select the formatting rules which you want to ignore and deselect those which should be applied.
Reformat your code (Ctrl+Alt+L).
PyCharm will reformat your code in accordance with the current style settings, keeping existing formatting for the rules which you've selected.
You can rearrange your code according to the arrangement rules set in the Settings/Preferences dialog.
For example, if you need to sort your code entries alphabetically, select the appropriate matching rules entry and set the Order field to order by name.
Rearrange code entries
Select a language for which you want to create arrangement rules.
On the Arrangement tab, specify the appropriate options such as grouping and matching rules.
Click OK to save the changes.
In the editor, select the code entries you want to rearrange and from the main menu, select.