在 VS Code 里,保持 Python 代码整洁规范离不开合适的格式化工具。市面上主流的 Python 格式化工具主要有三款,它们在理念和使用场景上各有侧重,你可以根据项目需求来选。
| 工具名称 | 核心特点 | 风格理念 | 推荐适用场景 |
|---|---|---|---|
| Black | 开箱即用,几乎无需配置;强制统一的代码风格,可预测性强。 | '无妥协'的格式化器。它决定格式,讨论空间小,保证所有代码风格一致。 | 团队协作项目;希望零配置快速上手的开发者;追求极简和一致性。 |
| autopep8 | 基于 PEP 8 规范,主要修复代码风格问题(如缩进、空格)。 | 相对保守,专注于修复而非重新排版。 | 希望代码严格遵循 PEP 8;对现有代码进行温和的格式化修复。 |
| yapf | 高度可定制,可以模仿多种代码风格;格式化策略更'激进',会重新排版代码。 | '自成风格'。目标是通过调整代码来达到最佳可读性,而非严格遵循某一规范。 | 需要高度自定义格式化规则;项目有特殊的代码风格要求。 |
配置流程
选定工具后,配置过程其实很直接。我们以使用最广泛的 Black 为例,其他工具的流程也大同小异。
- 安装扩展:在 VS Code 的扩展商店搜索并安装 'Black Formatter'。官方 Python 扩展(ms-python.python)通常也内置了对这些格式化器的支持。
- 启用自动保存:打开设置 (
Ctrl+,),搜索format on save,勾选Editor: Format On Save。这样每次保存文件时都会自动触发格式化。 - 指定默认格式化器:在设置里搜
default formatter,为 Python 语言选择ms-python.black-formatter。
别忘了确保你的 Python 环境里已经安装了底层工具:
pip install black
做完这些,编辑或保存 Python 文件时,VS Code 就会乖乖用 Black 帮你整理代码了。
进阶技巧
- 手动触发:除了自动保存,随时可以用快捷键
Shift + Alt + F(Windows) 或Shift + Option + F(Mac) 手动格式化当前文档。
自定义行宽:Black 默认行宽是 88 字符,但有些团队习惯 100 或 120。在 VS Code 设置里添加以下配置即可生效:
{
"python.formatting.blackArgs": ["--line-length", "100"]

