主流工具对比
| 工具名称 | 核心特点 | 风格理念 | 推荐适用场景 |
|---|---|---|---|
| Black | 开箱即用，几乎无需配置；强制统一的代码风格，可预测性强。 | '无妥协'的格式化器。它决定格式，讨论空间小，保证所有代码风格一致。 | 团队协作项目；希望零配置快速上手的开发者；追求极简和一致性。 |
| autopep8 | 基于 PEP 8 规范，主要修复代码风格问题（如缩进、空格）。 | 相对保守，专注于修复而非重新排版。 | 希望代码严格遵循 PEP 8；对现有代码进行温和的格式化修复。 |
| yapf | 高度可定制，可以模仿多种代码风格；格式化策略更'激进'，会重新排版代码。 | '自成风格'。目标是通过调整代码来达到最佳可读性，而非严格遵循某一规范。 | 需要高度自定义格式化规则；项目有特殊的代码风格要求。 |
安装与配置
选好工具后，只需简单几步就能在 VS Code 中启用它们。这里以 Black 为例（因其使用最广且配置简单），其他工具的配置流程类似。
- 安装 VS Code 插件：在 VS Code 的扩展商店中搜索并安装 'Black Formatter' 插件。官方 Python 扩展（ms-python.python）也内置了对这些格式化器的支持。
- 进行关键配置：打开 VS Code 的设置 (
Ctrl+,)，搜索 'format on save'，并勾选Editor: Format On Save选项。这样每次保存文件时都会自动格式化。 - 设置默认格式化器：在设置中搜索 '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"]
