Black 是一项开源的 python 代码格式化工具,使用方便,号称“零妥协代码格式化工具(The uncompromising code formatter)”。
这里介绍一下在命令行安装和使用 Black 的方法。注意这里推荐 python 版本为3.6.2以上。
安装
使用pip下载
pip install black
如果想在 Jupyter Notebooks 中使用,可以通过如下方法安装
pip install black[jupyter]
或者通过 Github 安装(不推荐)
pip install git+git://github.com/psf/black
# pip install git+https://github.com/psf/black
使用
直接在控制台使用
black FILE_OR_DIRECTORY_PATH
或者使用 python 运行
python -m black FILE_OR_DIRECTORY_PATH
跳过字符串格式化。Black 会默认将字符串格式化为使用双引号包裹,但有些项目已经使用了单引号的规范且不应修改为双引号,就需要加上一个 -S / --skip-string-normalization 的选项。
black -S FILR_OR_DIRECTORY_PATH