使用黑色使您的 Python 代码看起来不错 Fedora

Python 编程语言经常因其简单的语法而受到称赞。 事实上,该语言认识到代码的阅读频率远高于编写频率。 黑色的 是一个工具,可以自动格式化你的 Python 源代码,使其统​​一并符合 PEP-8 风格指南.

如何安装黑色 Fedora

安装黑色 Fedora 很简单。 黑色在官方存储库中维护。

$ sudo dnf install python3-black

Black 是一个命令行工具,因此它是从终端运行的。

$ black --help

用黑色格式化你的 Python 代码

使用 Black 格式化 Python 代码库非常简单。

$ black myfile.py
All done! ✨ ? ✨ 1 file left unchanged.
$ black path_to_my_python_project/
All done! ✨ ? ✨
165 files reformatted, 24 files left unchanged.

默认情况下,黑色允许每行 88 个字符,这意味着将重新格式化代码以适应每行 88 个字符。 可以将其更改为自定义值,例如 example :

$ black --line-length 100 my_python_file.py

这会将行长设置为允许 100 个字符。

作为 CI 管道的一部分运行 Black

当 Black 与其他工具(如持续集成管道)集成时,它确实会发光。

–check 选项允许验证是否需要重新格式化任何文件。 这对于作为 CI 测试运行以确保您的所有代码都以一致的方式格式化很有用。

$ black --check myfile.py
would reformat myfile.py
All done! ? ? ?
1 file would be reformatted.

将 Black 与您的代码编辑器集成

在持续集成测试期间运行 Black 是保持代码库格式正确的好方法。 但是开发人员真的想忘记格式化并让工具为他们管理它。

大多数流行的代码编辑器都支持 Black。 它允许开发人员在每次保存文件时运行格式化工具。 这 官方文档 详细说明每个编辑器所需的配置。

Black 是 Python 开发人员工具箱中的必备工具,可在 Fedora.