相关资料:https://muzing.top/posts/a29e4743/#the-black-code-style
Black 自称“零妥协代码格式化工具(The uncompromising code formatter)”。
截止到 2022 年 5 月,Black 已经在 GitHub 斩获 27.4k 个 Stars,由 Google 开发维护的 YAPF 为 12.5k ,而 autopep8 则只有 4.1k 。可以说 Black 是目前最广受好评的 Python 代码格式化工具。
安装
可以通过 pip 直接从 PyPI 下载安装:
pip install black
集成到PyCharm
相比于每次都专门打开一个终端,手动使用命令行调用 Black 格式化代码,我们更希望能把 Black 集成到我们常用的 IDE / 编辑器中,不需要离开写代码的界面即可完成格式化操作。
确认Black安装位置
在 macOS / Linux / BSD 上:
$ which black
/usr/local/bin/black # 可能的位置
在 Windows 上:
$ where black
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # 可能的位置
在 PyCharm 中添加外部工具
打开 文件 -> 设置 -> 工具 -> 外部工具
File -> Settings -> Tools -> External Tools
创建工具
- 名称:Black
- 描述:毫不妥协的 Python 代码格式化工具
- 程序:「上一小节得到的安装位置」
- 参数:
$FilePath$ - 工作目录:
$ProjectFileDir$
设置-工具-外部工具
使用
在已经打开的代码编辑界面(或项目文件树的某个目录上)鼠标右键,找到 External Tools -> Black,点击即可。
设置快捷键
还可以在 设置 -> 键盘映射 -> 外部工具 -> Black 上右键,打开编辑快捷键的菜单,添加键盘快捷键:

设置快捷键
保存文件时自动格式化(可选)
1.确保已经安装了 File Watchers 插件
2.进入 设置 -> 工具 -> File Watchers,点击 + 以添加一个新的 watcher:
- Name: Black
- File type: Python
- Scope: Project Files
- Program: 上一小节得到的安装位置
- Arguments:
$FilePath$ - Output paths to refresh:
$FilePath$ - Working directory:
$ProjectFileDir$
3.在高级选项中:
- 取消勾选
“Auto-save edited files to trigger the watcher” - 取消勾选
“Trigger the watcher on external changes”
