PyCharm配置代码格式化工具Black

PyCharm配置代码格式化工具Black

一 简介

一个代码规范、可读性强是我们在写代码或者看代码时最期望的，也便于我们理解代码的功能和思路。而对于格式不是很规范的代码，要去修改其格式，如果单纯靠人工更正格式，对于简短的代码，难度不是很高；但是遇到一个较长、功能复杂的代码或者项目，人工修改的难度是很大的。
    而目前，大多数编译器中都都会自带代码格式规范的工具，而今天要介绍的就是Pycharm中的代码规范工具——Black

其他代码格式化工具：PEP8、flake8、autopep8
参考：https://blog.csdn.net/The_Time_Runner/article/details/106456152

二 安装Black

pip install black

注意：一般安装后，black.exe目录会在python3.10/Scripts/目录下。

三 在PyCharm中配置Black

settings --> External Tools --> + 配置信息如下：

Name：工具名称，用户自定义，建议与Blcak相关的名称，例如：BlackFormatter

Program：选择自己电脑中刚才安装black.exe的位置（通常，black.exe目录会在python3.10/Scripts/目录下。），
例如：C:\Python\Python3.10\Scripts\black.exe

Arguments：固定填写” $FilePath$ ”

Working directory：固定填写“ $ProjectFileDir$ “;

点击OK，即配置完成。

四 使用Black

在要格式化的.py文件中，执行如下操作：