访问官网
Github
文档
不妥协的代码格式化工具
"你喜欢的任何颜色。"
Black 是一个不妥协的 Python 代码格式化工具。使用它，你需要放弃对手动格式化细节的控制。作为回报，Black 给你带来速度、确定性，以及摆脱 pycodestyle 对格式的唠叨。你将节省时间和精力，专注于更重要的事情。
经 Black 格式化的代码，无论你在阅读哪个项目，看起来都是一样的。一段时间后，格式化变得透明，你可以专注于内容本身。
Black 通过产生尽可能小的差异，使代码审查更快。
现在就在 Black Playground 上试试吧。观看 PyCon 2019 演讲 了解更多。
安装和使用
安装
可以通过运行 pip install black 来安装 Black。它需要 Python 3.8+ 才能运行。如果你想格式化 Jupyter Notebooks，请使用 pip install "black[jupyter]" 安装。
如果你迫不及待想要最新版本，想从 GitHub 安装，请使用：
pip install git+https://github.com/psf/black
使用
要立即开始使用合理的默认设置：
black {源文件或目录}
如果作为脚本运行不起作用，你可以将 Black 作为包运行：
python -m black {源文件或目录}
更多信息可以在我们的文档中找到：
Black 已经被许多大大小小的项目成功使用。Black 有一个全面的测试套件，具有高效的并行测试，以及我们自己的自动格式化和并行持续集成运行器。现在我们已经变得稳定，你不应该期望将来会有大的格式化变化。风格变化主要是对错误报告的响应和对新 Python 语法的支持。更多信息请参考 Black 代码风格。
此外，作为一种降低处理速度的安全措施，Black 会检查重新格式化的代码是否仍然产生与原始代码实际等效的有效 AST（详情请参阅 实用主义 部分）。如果你有信心，可以使用 --fast。
Black 代码风格
Black 是一个符合 PEP 8 的固执己见的格式化工具。Black 就地重新格式化整个文件。风格配置选项被故意限制，很少添加。它不考虑之前的格式（例外情况请参见 实用主义）。
我们的文档涵盖了当前的 Black 代码风格，但计划中的变更也有记录。两者都值得一看：
Black 代码风格的变更受稳定性政策约束：
提交问题之前请参考此文档。看似是 bug 的可能是预期行为。
实用主义
Black 的早期版本在某些方面是绝对主义的。它们追随其最初的作者。当时这很好，因为它使实现更简单，而且也没有太多用户。没有报告太多边缘情况。作为一个成熟的工具，Black 确实对它坚持的规则做了一些例外。
在提交问题之前，请像参考上面的文档一样参考此文档。看似是 bug 的可能是预期行为。
配置
Black 能够从 pyproject.toml 文件中读取项目特定的命令行选项默认值。这对于为你的项目指定自定义 --include 和 --exclude/--force-exclude/--extend-exclude 模式特别有用。
你可以在我们的文档中找到更多详细信息：
如果你在寻找更一般的配置文档：
专业提示：如果你在问自己"我需要配置什么吗？"答案是"不需要"。Black 都是关于合理默认的。应用这些默认设置将使你的代码符合许多其他 Black 格式化的项目。
使用者
以下著名的开源项目信任 Black 来强制执行一致的代码风格：pytest、tox、Pyramid、Django、Django Channels、Hypothesis、attrs、SQLAlchemy、Poetry、PyPA 应用程序（Warehouse、Bandersnatch、Pipenv、virtualenv）、pandas、Pillow、Twisted、LocalStack、每个 Datadog Agent Integration、Home Assistant、Zulip、Kedro、OpenOA、FLORIS、ORBIT、WOMBAT 等等。
以下组织使用 Black：Facebook、Dropbox、KeepTruckin、Lyft、Mozilla、Quora、Duolingo、QuantumBlack、Tesla、Archer Aviation。
我们是否遗漏了谁？请告诉我们。
推荐语
Mike Bayer，SQLAlchemy 的作者：
在我整个编程生涯中，我想不出任何一个工具能像它的引入那样给我带来如此巨大的生产力提升。现在我可以用大约 1% 的按键次数完成重构，而在以前我们没有代码自动格式化的方式时，这需要更多的操作。
Dusty Phillips，作家：
Black 有自己的主见，这样你就不用有了。
Hynek Schlawack，attrs 的创建者，Twisted 和 CPython 的核心开发者：
一个不糟糕的自动格式化工具就是我圣诞节想要的全部！
Carl Meyer，Django 核心开发者：
至少名字不错。
Kenneth Reitz，requests 和 pipenv 的创建者：
这极大地改善了我们代码的格式。非常感谢！
展示你的风格
在你项目的 README.md 中使用这个徽章：
[](https://github.com/psf/black)
在 README.rst 中使用徽章：
.. image:: https://yellow-cdn.veclightyear.com/2b54e442/51407ae1-8254-4d14-91f4-543a4243b9b7.svg
:target: https://github.com/psf/black
看起来像这样：
许可证
MIT
贡献
欢迎！很高兴看到你愿意让项目变得更好。你可以从阅读这个开始：
你也可以看看其他的贡献文档或与开发者交谈：
更新日志
日志变得相当长。它已移至自己的文件。
查看 CHANGES。
作者
作者列表现在相当长，所以它存放在自己的文件中。
查看 AUTHORS.md
行为准则
参与 Black 项目的每个人，特别是在问题追踪器、拉取请求和社交媒体活动中，都应该尊重他人，更一般地说，遵循 Python 社区行为准则 中阐明的准则。
同时，鼓励幽默。事实上，我们期望你对 Monty Python's Flying Circus 有基本的了解。我们不是野蛮人。
如果你真的需要打某人，请在跳舞时用鱼打。
