在 VS Code 中格式化 Python

格式化使源代码更易于人类阅读。通过强制执行特定的规则和约定，例如行距、缩进和运算符周围的间距，代码在视觉上变得更有条理和易于理解。您可以在 autopep8 页面上查看一个示例。请记住，格式化不会影响代码本身的功能。

代码检查 (Linting) 通过分析代码中常见的语法、风格和功能错误以及非常规的编程实践来帮助防止错误。尽管格式化和代码检查之间有一些重叠，但这两种功能是互补的。

选择格式化工具

在 VS Code 市场中搜索您选择的格式化工具扩展。

Microsoft 发布了以下格式化工具扩展

社区提供的格式化工具扩展

此外，以下是支持导入排序的格式化工具扩展

注意：如果您在上面的表格或市场中找不到您偏好的格式化工具，您可以通过扩展来添加对它的支持。您可以使用 Python 扩展模板 将新的 Python 工具集成到 VS Code 中。

设置默认格式化工具

安装格式化工具扩展后，您可以按照以下步骤将其选为 VS Code 中 Python 文件的默认格式化工具

1. 在 VS Code 中打开一个 Python 文件。
2. 在编辑器上右键单击以显示上下文菜单。
3. 选择 使用...格式化文档 (Format Document With...)。
4. 从下拉菜单中选择 配置默认格式化工具... (Configure Default Formatter...)。
5. 从列表中选择您偏好的格式化工具扩展。

或者，您可以在用户 settings.json 文件中，在 [python] 作用域下设置 "editor.defaultFormatter"，将其设为所有 Python 文件的默认格式化工具。您可以使用 首选项: 打开用户设置 (JSON) (Preferences: Open User Settings (JSON)) 命令打开 settings.json。

例如，要将 Black Formatter 设置为默认格式化工具，请将以下设置添加到您的用户 settings.json 文件中

  "[python]": {
    "editor.defaultFormatter": "ms-python.black-formatter"
  }

要将格式化工具扩展设置为导入排序器，您可以在用户 settings.json 文件或工作区 settings.json 文件中，在 [python] 作用域下设置您的偏好于 "editor.codeActionsOnSave"。您可以分别使用 首选项: 打开用户设置 (JSON) (Preferences: Open User Settings (JSON)) 和 首选项: 打开工作区设置 (JSON) (Preferences: Open Workspace Settings (JSON)) 命令打开这些 settings.json 文件。这将为所有 Python 文件启用保存时导入排序。

例如，要将 Ruff 设置为您偏好的导入排序器，您可以将以下设置添加到您的用户 settings.json 或工作区 settings.json 文件中

{
  "[python]": {
    "editor.codeActionsOnSave": {
      "source.organizeImports.ruff": "explicit"
    }
  }
}

格式化您的代码

您可以通过右键单击编辑器并选择 格式化文档 (Format Document)，或使用 ⇧⌥F (Windows Shift+Alt+F, Linux Ctrl+Shift+I) 键盘快捷键来格式化您的代码。

您还可以将以下设置添加到您的用户 settings.json 文件中，以启用保存时格式化您的代码

  "[python]": {
    "editor.formatOnSave": true
  }

通用格式化设置

您可以参考每个格式化工具扩展的 README 以获取有关支持的设置的更多详细信息。以下设置受大多数格式化工具扩展支持

格式化问题排查

如果格式化失败，请检查以下可能的原因

注意：如果您在上面没有找到您偏好的格式化工具，您可以通过扩展来添加支持。Python 扩展模板可以轻松地将新的 Python 工具集成到 VS Code 中。

后续步骤

• 调试 - 了解如何在本地和远程调试 Python。
• 测试 - 配置测试环境以及发现、运行和调试测试。
• 基本编辑 - 了解功能强大的 VS Code 编辑器。
• 代码导航 - 快速浏览您的源代码。
• Python 扩展模板 - 创建一个扩展，将您最喜欢的代码检查器集成到 VS Code 中。