Black格式化工具配置

black 格式化工具配置

用于格式化代码

pre-commit 配置

pip3 install pre-commit
cd gm_web_stock
pre-commit install

pycharm上配置方法

1.安装black:

pip3 install black

2.获取black安装路径

which black

(大概的位置，后面配置用得到：/usr/local/bin/black)

3.安装pycharm的File Watchers插件

Preferences(设置) > Plugins（插件）> 搜索并安装File Watchers插件

4.配置一个watcher

Preferences(设置) > File Watchers插件 > 点'+'增加下面的配置 > 保存

参考的watcher配置参数：
Name:   black
File Type:  Python
Scope:  Project Files

Program:    /usr/local/bin/black(第二步获得的black安装路径)
Arguments:  $FilePath$
Output paths to refresh:    $FilePath$

高级选项：可以选择black代码的时间、black代码的特殊情况

5.black运行时间

默认是在保存文件的时候触发black，但是可以有以下两种选择

1、可以在配置watcher的高级选项中勾选Auto-save选项，实现实时black

2、在Preferences(设置) > System setting中设置离开应用N秒之后自动保存，会自动触发black

VSCode 配置方法

在工程目录创建 .vscode/settings.json

{
    "python.formatting.provider": "black",
    "python.formatting.blackPath": "/usr/local/bin/black",
    "editor.formatOnSave": true,
}