入门¶
你是 *Black* 的新手吗?别担心,你已经找到了最适合入门的资源!
你喜欢 *Black* 代码风格吗?¶
在将 *Black* 用于你的部分代码之前,最好先了解 *Black* 如何格式化你的代码。*Black* 并非适合所有人,你可能会发现一些对你个人来说是致命缺陷的东西,这是正常的!当前的 *Black* 代码风格 在这里描述。
在线试用¶
你也可以在由 José Padilla 创建的 Black Playground 上在线试用 *Black*,以获得最小的麻烦。
安装¶
可以通过运行 pip install black
来安装 *Black*。它需要 Python 3.8+ 才能运行。如果你想格式化 Jupyter Notebooks,请使用 pip install "black[jupyter]"
安装。
如果你使用 pipx,可以使用 pipx install black
安装 Black。
如果你迫不及待想体验最新功能,并希望从 GitHub 安装,请使用
pip install git+https://github.com/psf/black
基本用法¶
要立即使用合理默认值,请
black {source_file_or_directory}...
如果以脚本方式运行不起作用,则可以将 *Black* 作为包运行
python -m black {source_file_or_directory}...
下一步¶
看过了 *Black* 代码风格 并尝试过 *Black* 吗?太棒了,你已经准备好了解更多。为什么不通过阅读 使用和配置:基础知识 来进一步了解 *Black* 的使用?或者,你可以查看 将 *Black* 引入你的项目 指南。