VS Code 中的 Python 代码格式化插件

在 VS Code 中，有几款非常出色的 Python 代码格式化插件可以帮助你保持代码的整洁与规范。下面这个表格整理了目前主流的几款工具，你可以根据它们的特点进行选择。

🔧 如何安装与配置

选好工具后，只需简单几步就能在 VS Code 中启用它们。这里以 Black 为例（因其使用最广且配置简单），其他工具的配置流程类似。

1. 安装 VS Code 插件：在 VS Code 的扩展商店中搜索并安装 “Black Formatter” 插件。官方 Python 扩展（ms-python.python）也内置了对这些格式化器的支持。
2. 进行关键配置：打开 VS Code 的设置 ( Ctrl+, )，搜索 “format on save”，并勾选 Editor: Format On Save 选项。这样每次保存文件时都会自动格式化。
3. 设置默认格式化器：在设置中搜索 “default formatter”，为 Python 语言设置默认格式化器。在下拉列表中选择 ms-python.black-formatter。

安装格式化工具：首先，确保你已经在你的 Python 环境中通过 pip 安装了该工具。

pip install black 

完成以上配置后，当你编辑或保存一个 Python 文件时，VS Code 就会自动使用 Black 来格式化你的代码了。

💡 使用建议与技巧

• 手动格式化：除了自动保存时格式化，你还可以随时使用快捷键 Shift + Alt + F（Windows）或 Shift + Option + F（Mac）来手动格式化当前文档。

自定义行宽：Black 默认的行宽是 88 字符，但你可以根据项目要求调整。在 VS Code 的设置中，添加如下配置即可将行宽改为 100：

"python.formatting.blackArgs":["--line-length","100"]

解决工具冲突：如果你同时安装了多个格式化工具或 Linter（如 flake8），可能会产生规则冲突。如果确定使用 Black，可以在设置中禁用其他格式化器以避免冲突。

"python.formatting.autopep8Enabled":false,"python.formatting.yapfEnabled":false

💎 如何选择

简单来说：

• 如果你追求极简、统一，不想在代码风格上做任何决策，直接选择 Black。
• 如果你的项目有非常特殊或严格的定制化格式要求，可以尝试 yapf。
• 如果你只需要一个工具来辅助修复代码使其符合 PEP 8，autopep8 是个温和的选择。