For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /developers/blog/2019-07-31-black.md.

采用 Black

今天我们正式采用了 Python 代码格式化工具 Black。所有代码都已用 Black 格式化,所有未来的贡献都将被检查以确保已使用 Black 格式化。

作为采用 Black 的一部分,flake8 和 pylint 中的所有 style 检查已被禁用。

为了确保在提交更改时所有文件都使用 Black 格式,我们使用 pre-commit。该 hook 会自动为新开发环境安装(作为 script/setup 的一部分)。

如果你有现有的开发者安装,请在你的 virtual environment 中运行:

pip install pre-commit
pre-commit install

pre-commit 不会更改你的文件,而只是确认更改的文件已由 Black 格式化。我们建议你设置编辑器,在保存时自动使用 Black 格式化文件。各种编辑器的说明可以在这里找到。