pycharmblack强迫症

# pycharm_black_强迫症

屁大点事写个帖子

pycharm 格式化 Ctrl+Shift+L，每次写完（改完）顺手格式化一下，非常的舒服。

最近开始接触开源项目，很多用的 black 格式化工具，还有 mypy 等等代码检查工具。

冲突点在于 pycharm 另起的一行的参数空 8 格， black 空四格。

在用 black 风格检查的代码的情况下， pycharm 的格式化显得不友好了。

最开始想直接 pycharm reformat 用上 black，但是看了看 jetbrain 的插件：

black-pycharm (opens new window) 多年未更新。
BlackConnect (opens new window) 更新挺多的。

BlackConnect 要起服务端，而且快捷键不同 (Alt + Shift + B)

# 解决方案

# 提交时修改

后面还是妥协普通编写时用 pycharm reformat 提交时统一 black 格式化

需要的是把Continuation indent 改为4

后期再通过 git hook 格式化或者检查代码

# 更换 pycharm format 工具

# step1 安装

windows 下先 python 安装 black isort

pip install black isort -U pip install black==22.1 isort==5.10 -U # 安装指定版本

# step2 工具位置

然后找到 black 和 isort 的命令位置

windows
- where black
- where isort
mac
- which black
- which isort

# step3 pycharm 配置扩展工具

File -> Settings -> Tools -> External Tools

按+号按钮增加新的拓展工具

Name: Black
Description: Black is the uncompromising Python code formatter.
Program: &lt;install_location_from_step_2>
# Program: d:/ProgramData/Miniconda3/Scripts/black.exe
Arguments: $FilePath$

Name: Isort
Description: Sort imports in current file
Program: &lt;install_location_from_step_2>
# Program: d:/ProgramData/Miniconda3/Scripts/black.exe
Arguments: -e -m 4 -w 120 $FilePath$

1
2
3
4
5
6
7
8
9
10
11

# step4 pycharm 配置快捷键

Settings -> Keymap -> External Tools -> External Tools

Black. 选择后输入 Ctrl+Alt+L 顶掉原来的快捷键
Isort. 同理，输入 Ctrl+Alt+O 顶掉原有的 import 格式化

# 配置完后就可以使用 black 和 isort 格式化代码了。

pycharm 原有设置（方便小伙伴还原）

拓展工具	原有快捷键名称	快捷键
Black	Reformat Code	`Ctrl+Alt+L`
Isort	Optimize Imports	`Ctrl+Alt+O`

# 关于 lint check

参考一下 fastapi (opens new window)

mypy fastapi
flake8 fastapi tests
black fastapi tests --check
isort fastapi tests docs_src scripts --check-only

1
2
3
4

或者用 python 插件 pre-commit-hooks (opens new window) 配置参考这个项目 simple_calculate_service (opens new window)

# cat .pre-commit-config.yaml
-   repo: https://github.com/pre-commit/pre-commit-hooks
    sha: v1.11.1
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-json
    -   id: flake8
        exclude: migrations|.*\_local.py|manage.py|settings.py

1
2
3
4
5
6
7
8
9

参考 fastapi-crudrouter (opens new window)

  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
    - name: Run Black Code Formatter
      uses: psf/black@stable
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -r tests/dev.requirements.txt
    - name: Check Typing with mypy
      run: |
        mypy fastapi_crudrouter
    - name: Lint with flake8
      run: |
        flake8 fastapi_crudrouter

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

# vscode 插件问题

报错：The Black Formatter server crashed 5 times in the last 3 minutes. The server will not be restarted. See the output for more

修改配置其他不用改：

{
  "black-formatter.path": [
    "C:\\Users\\z7407\\AppData\\Roaming\\Python\\Python310\\Scripts\\black.exe"
  ]
}

1
2
3
4
5

# Ctrl+Alt+L 不起作用

快捷键配置看是否能搜索到

命令窗搜索 Format Document with... 设置 black 为 Default

编辑

#屁大点事

上次更新: 2024-01-11 0:01:00