【PyCharm教程】PyCharm 配置代码风格

如果公司中存在某些编码准则，则在创建源代码时必须遵循这些准则。PyCharm 可帮助您保持所需的代码风格。

IDE 带有两个预定义的方案：项目方案和默认方案。

在项目方案中，您配置的设置仅适用于您当前的项目。

这些设置存储在.idea下的codeStyles文件夹中，并通过 VCS 与项目一起共享。

在您修改项目的代码样式设置后，IDE 会创建该文件夹。

在默认方案（IDE 级方案）中，您配置的设置适用于选择了默认代码样式方案的所有现有项目。

这些设置存储在PyCharm配置目录下的codestyles文件夹中，不通过 VCS 共享。

如果您想使用项目代码样式方案作为您的默认方案，您可以将其复制到 IDE 级别。另一种方法也是可能的：您可以使用 IDE 级别方案中的设置覆盖当前项目设置，并与团队的其他成员共享它们。

只能有一个项目代码样式方案。在 IDE 级别上，您可以有多个方案。多个项目可以引用相同的 IDE 级代码样式方案。

配置方案

在 PyCharm 中，代码样式设置是特定于语言的，因此您需要为您在项目中使用的每种语言分别配置它们。您还可以从一种语言复制设置并将其应用到另一种语言。

配置语言的代码样式

按Ctrl+Alt+S打开 IDE 设置并选择Editor | 代码风格。

要为新项目配置方案，请转到文件 | 新项目设置 | 新项目的设置/首选项 | 编辑 | 代码风格。

选择要为其配置代码样式的语言。
选择您要配置的代码样式方案：项目方案或IDE 级方案之一。

单击默认方案旁边的并选择复制以创建方案的副本。

浏览选项卡并配置代码样式首选项。

使用对话框的右侧部分预览更改。更改设置时，预览区域中会出现一个或多个闪烁区域，强调更改。

应用其他语言的代码样式

对于大多数受支持的语言，您可以从其他语言或框架复制代码样式设置。

按Ctrl+Alt+S打开 IDE 设置并选择Editor | 代码风格。

要为新项目配置方案，请转到文件 | 新项目设置 | 新项目的设置/首选项 | 编辑 | 代码风格。

选择要为其配置代码样式的语言。
选择要修改的代码样式方案：项目方案或IDE 级方案之一。
单击右上角的设置自。

仅当可以应用其他语言的代码样式设置时，才会显示该链接。

从出现的列表中，选择要从中复制代码样式的语言。

仅从另一种语言复制适用的设置，其他设置保持不变。

复制代码样式设置

按Ctrl+Alt+S打开 IDE 设置并选择Editor | 代码风格。

要为新项目配置方案，请转到文件 | 新项目设置 | 新项目的设置/首选项 | 编辑 | 代码风格。

选择要复制的代码样式方案：项目方案或IDE 级方案之一。
单击该图标并选择以下选项之一：
- Copy to IDE (for the Project scheme)：将选中的scheme复制到IDE层级。
PyCharm 将具有指定名称的新代码样式保存到 PyCharm 主目录。
- 复制到项目（对于 IDE 级方案）：使用所选 IDE 级配置文件中的设置覆盖当前项目设置。
- 复制（对于 IDE 级别的方案）：在同一级别上创建所选 IDE 方案的副本。

在方案字段中，输入新方案的名称并按Enter保存更改。

进出口方案

导入方案

开箱即用，PyCharm 允许您以IntelliJ IDEA 代码样式 XML格式导入设置。

按Ctrl+Alt+S打开 IDE 设置并选择Editor | 代码风格。
单击并选择导入方案。
在打开的对话框中，选择包含设置的文件，然后单击打开。
如有必要，重命名方案并选择当前方案以将方案中的设置应用于您的代码。

导出方案

您可以以PyCharm 代码样式 XML或EditorConfig格式导出项目级和 IDE 级方案（如果启用了EditorConfig插件）。

按Ctrl+Alt+S打开 IDE 设置并选择Editor | 代码风格。
选择要导出的代码样式方案：项目方案或IDE 级方案之一。
单击，选择Export，选择必要的格式，然后选择要将代码样式设置导出到的目录。

使用 EditorConfig 在目录级别管理代码样式

要使用 EditorConfig，请确保在Settings/Preferences |上启用EditorConfig插件。插件页面，标签Installed。

PyCharm 允许您管理具有EditorConfig支持的每组文件的所有代码样式设置（默认情况下在设置/首选项对话框 ( Ctrl+Alt+S) 中启用）。您需要做的就是在根目录中放置一个.editorconfig文件，其中包含您要定义其代码样式的文件。您可以根据需要在项目中拥有任意数量的.editorconfig文件，因此您可以为不同的模块指定不同的样式。

.editorconfig文件中的所有选项都应用于它所在的目录以及当前项目代码样式之上的所有子目录。如果中未定义任何内容.editorconfig，则从项目设置中获取。

.editorconfig文件中的所有选项分为以下几类：

标准选项，例如indent_size、indent_style等。这些选项没有任何特定于域的前缀。
具有ij_前缀并适用于所有语言的通用 IntelliJ 选项：
- 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
许多（但不是全部）语言支持的通用 IntelliJ 选项。它们以ij_any前缀开头，例如ij_any_brace_style.
IntelliJ 语言特定选项以ij_<lang>_前缀开头，其中<lang>是语言域 ID（通常是小写语言名称），例如ij_java_blank_lines_after_imports.

相同的选项可以定义为通用选项和特定语言选项，例如ij_<...>_brace_style. 特定于语言的选项比通用或通用选项具有更高的优先级。

添加 .editorconfig 文件

在Project视图中，右键单击包含要定义其代码样式的文件的源目录，然后选择New | 上下文菜单中的EditorConfig。
选择要定义的属性，以便 PyCharm 为它们创建存根，或者将所有复选框留空以手动添加所需的属性。
要预览对代码样式设置的更改将如何影响实际源文件，请单击.editorconfig文件的装订线并选择受其影响的源文件。预览将在右侧打开。

您可以在预览窗格中进行更改，以尝试测试您的配置更改是如何反映的，而不必担心对源代码进行不必要的更改：当您关闭.editorconfig文件时，所有这些更改都会被丢弃。

【PyCharm教程】PyCharm 配置代码风格