black-严格的Python代码格式化工具

Black是严格的Python代码格式化工具。使用它,您可以放弃对手工格式化细节的控制。

作为回报,Black可为您提供速度、确定性和免于pycodestyle格式化的自由。您可以为更重要的事情节省时间和精力。

无论您正在阅读的项目如何,涂黑的代码看起来都一样。一段时间后,格式变得透明,您可以专注于内容。

黑色通过产生尽可能小的差异使代码检查更快。

安装及使用

黑色可以通过运行安装pip install black或者在网盘下载black源代码,它需要运行在Python 3.6.0+,但是您也可以使用它重新格式化Python 2代码。

要立即开始使用默认设置,请执行以下操作:

black {source_file_or_directory}

如果无法将Black作为脚本运行,则可以将Black作为软件包运行:

python -m black {source_file_or_directory}

Black是行为良好的Unix风格的命令行工具:

  • 如果没有源传递给它,它什么都不做;

  • 如果-用作文件名,它将从标准输入读取并写入标准输出;

  • 它仅在出现标准错误时才向用户输出消息;

  • 除非发生内部错误(或--check已使用),否则以代码0退出。

将Black与其他工具一起使用

虽然Black强制执行符合PEP 8的格式设置,但其他工具可能会发出有关Black更改的警告或将覆盖Black的更改。isort就是一个很好的例子 。由于Black几乎不可配置,因此应将这些工具配置为既不警告也不覆盖Black的更改。

可以在compatible_configs中找到有关各种工具与Black兼容的配置的 实际详细信息。

(0)

相关推荐