『插件』代码格式化工具 Black Formatter

• 目标：自动格式化python代码（增强可读性，按照规范统一代码风格）
• 要解决的问题：
  • 每个人写代码风格不一致，代码学习成本高
  • 历史代码很多，人工修改难度大，如何批量修改风格
  • 新增代码如何快速统一风格
  • 降低代码审查时间，避免常见错误

安装

vscode 的扩展中搜索black Formatter安装即可

设置及使用

1. 自动规范，可设置保存时自动格式化，设置方法:
   点击「设置」–>在检索框输入「format on save」，勾选空框。

2. 手动格式化
   打开一个.py文件，在文件空白处「右击」，选择 「格式化文档」，该文档自动完善格式。

3. 更改插件的每行字符数限制

   • 在vscode中打开setting.json（ctrl+shift+P后搜索“Open User Settings(JSON)”）
   • 在配置文件中增加以下信息（其它插件的配置调整也是类似的步骤）

{
    "[python]": {
        "editor.formatOnType": true,
        "editor.defaultFormatter": "ms-python.black-formatter"
    },
    "black-formatter.args": [
        "--line-length",
        "120"
    ],
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

4. Black Formatter升级后，格式化不起作用

「说明：」
black Formatter前几天突然发现格式化不论是自动格式化还是手动格式化都不起作用了，百度也没有找到原因，然后卸载插件重启电脑都没有作用，最后想着去它扩展的GitHub的issue区看看有没有相同问题，然后在readme中才发现写了支持python版本最低是python 3.8，而个人使用的是python 3.7😔

• 解决办法1：安装python3.8及以上版本的python，开发环境是python3.7 的话就3.7用来开发，格式化的时候使用高版本的python环境（是不是好麻烦…）
• 解决办法2：安装一个black的python包，用命令执行，这样就可以在同一个python环境使用

安装及使用

pip install black

• 1

在代码开头导入

import black

• 1

在终端运行Black，以修改XXX.py的代码规范为例

black xxx.py

• 1

如果返回以下信息说明修改成功

All done! ✨ 🍰 ✨
1 file reformatted.

• 1
• 2