使用 black 格式化 python 代码

python 一直以语法灵活闻名于世。为保证多人合作时,能有良好的格式化规范,需要使用强大而专业的代码格式化工具。本文介绍常用的 python 格式化代码工具 Black

在 vscore 中使用 black

1.安装 black

pip install black

2.配置设置文件
直接在配置文件中搜索 python formatting provider,勾选 black

或者直接修改配置文件,添加如下配置文件

    "python.formatting.provider": "black",
    "python.formatting.blackArgs": [
        "--skip-string-normalization",
        "--line-length",
        "180"
    ],

说明: black默认是 88 个字节,就开始换行的,但由于现在的电脑屏幕普遍较大,所以一般我个人喜欢调整功能到 180个字符,再换行(对应如上配置文件的最后两行)

在 git 的钩子函数中使用 black

安装 pre-commit

sudo apt install pre-commit -y

下载 black

pip install black

创建文件 .pre-commit-config.yaml,内容如下

repos:
  - repo: https://github.com/python/black
    rev: 23.3.0
    hooks:
      - id: black
        language_version: python3
        exclude: src/ratel/pot
        args: ["--line-length", "180"]
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
        args: [ "--profile", "black", "--filter-files" ]
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v2.7.0
    hooks:
      - id: prettier
        files: ^mark_data/
        types: [ json ]
        args: [ "--print-width", "12" ]

执行 pre-commit install 后,便可以开始执行钩子函数。

posted @ 2023-05-25 20:00  沧海一声笑rush  阅读(618)  评论(0编辑  收藏  举报