跳转到内容

Black 格式化

Black 是 Python 生态中极具盛名的开源代码格式化工具。它的座右铭是“The Uncompromising Code Formatter(不妥协的代码格式化器)”。 它 几乎不提供任何可配置的样式选项,旨在用唯一的标准彻底终结团队内部关于代码风格(如单双引号、换行折叠)的无休止争论,从而让开发者将精力集中在业务逻辑而非排版上。


Terminal window
pip install black

直接对单个文件或整个目录执行原位格式化覆写:

Terminal window
black {source_file_or_directory}

为了在编写代码时实现“保存即格式化”,建议将 Black 集成到常用的 IDE 中。

可以通过配置外部工具 (External Tools) 来实现。 路径File -> Settings -> Tools -> External Tools

  • Name: Black
  • Program: 定位到虚拟环境中的 black 可执行文件路径(如 .venv/bin/black)。
  • Arguments: $FilePath$ (代表当前聚焦的文件)。
  • Working directory: $ProjectFileDir$

配置完成后,可以为该工具绑定一个快捷键(如 Ctrl+Alt+L 的替代),一键格式化当前文档。