在 VS Code 中格式化 Python

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

Linting 通过分析代码是否存在常见的语法、样式和功能错误以及非传统的编程实践来帮助防止错误。尽管格式化和 linting 之间存在一些重叠，但这两种功能是互补的。

选择格式化程序

在 VS Code Marketplace 中搜索你选择的格式化程序扩展。

Microsoft 发布了以下格式化程序扩展

社区提供的格式化程序扩展

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

注意：如果你在上面的表格或 Marketplace 中找不到你喜欢的格式化程序，你可以通过扩展添加对其的支持。你可以使用 Python 扩展模板 将新的 Python 工具集成到 VS Code 中。

设置默认格式化程序

安装格式化程序扩展后，你可以按照以下步骤将其设置为 VS Code 中 Python 文件的默认格式化程序

1. 在 VS Code 中打开一个 Python 文件。
2. 右键单击编辑器以显示上下文菜单。
3. 选择 使用以下方式格式化文档...。
4. 从下拉菜单中选择 配置默认格式化程序...。
5. 从列表中选择你喜欢的格式化程序扩展。

或者，你可以在你的用户 settings.json 文件中的 [python] 范围内设置 "editor.defaultFormatter"，将其设置为所有 Python 文件的默认格式化程序。你可以使用 首选项：打开用户设置 (JSON) 命令打开 settings.json。

例如，要将 Black Formatter 设置为默认格式化程序，请在你的用户 settings.json 文件中添加以下设置

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

为了将格式化程序扩展设置为导入排序器，你可以在你的用户 settings.json 文件或你的工作区 settings.json 文件的 [python] 范围下设置 "editor.codeActionsOnSave"。你可以分别使用 首选项：打开用户设置 (JSON) 和 首选项：打开工作区设置 (JSON) 命令打开这些 settings.json 文件。这将为所有 Python 文件启用保存时导入排序。

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

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

格式化你的代码

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

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

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

常规格式化设置

有关支持的设置的更多详细信息，你可以参考每个格式化程序扩展的 README。大多数格式化程序扩展都支持以下设置

格式化故障排除

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

注意：如果你在上面没有找到你喜欢的格式化程序，你可以通过扩展添加支持。 Python 扩展模板 使将新的 Python 工具集成到 VS Code 中变得容易。

后续步骤

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