一個簡單的步驟讓你的 Python 程式碼更乾淨

說起來容易做起來難，我們都知道程式碼可讀性非常重要，但是寫的時候總是隨心所欲，不考慮類型提示、import 排序、PEP8 規範。今天就分享一個小技巧，透過一個簡單的步驟就可以讓你的 Python 程式碼更乾淨。

這就是 pre-commit：

可以讓你的程式碼提交之前自動檢查是否符合你想要的規格。

使用之前，先 pip 安裝一下：

pip install pre-commit

然後在專案的根目錄下建立兩個檔案：.pre-commit-config.yaml 和 pyproject.toml。

.pre-commit-config.yaml 檔案內容如下：

exclude: _pb2.py$
repos:
- repo: https://github.com/psf/black
rev: 22.3.0
hooks:
- id: black
args: [--skip-string-normalization]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
hooks:
- id: check-docstring-first
- id: check-json
- id: check-merge-conflict
- id: check-yaml
- id: debug-statements
- id: end-of-file-fixer
- id: trailing-whitespace
- id: requirements-txt-fixer
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.9.0
hooks:
- id: python-check-mock-methods
- id: python-use-type-annotations
- repo: https://github.com/pre-commit/mirrors-mypy
rev: "v0.910"
hooks:
- id: mypy
args:
[
--ignore-missing-imports,
--warn-no-return,
--warn-redundant-casts,
--disallow-incomplete-defs,
]
additional_dependencies: [types-all]
- repo: https://github.com/PyCQA/isort
rev: 5.9.3
hooks:
- id: isort
args: [--profile, black, --filter-files]

這裡面配置了black、mypy、check-docstring-first、isort 等工具，id 就是對應的工具，可以說這個設定檔基本上就夠用了。

在 .pre-commit-config.yaml 檔案中，我們可以指定將使用哪些掛鉤，在 pyproject.toml 中，我們可以為這些單獨的鉤子指定參數。

pyproject.toml 檔案內容如下：

[tool.black]
line-length = 88
target-version = ["py38"]

[tool.isort]
profile = "black"
multi_line_output = 3

這裡配置了 black 和 isort 的相關設定。

接著執行在專案的根目錄執行 pre-commit install 指令，就可以安裝 pre-commit 外掛程式。

然後每次更新程式碼，提交程式碼時，這些鉤子都會觸發，會自動執行如下操作：

排序import

PEP8 的格式代碼

檢查您的yaml 和json 檔案的正確性

類型檢查（如果你使用了類型提示）

##最後

你可以將這兩個檔案拷貝到自己的專案根目錄中，然後執行一次 pre-commit install，這樣每次提交程式碼的時候，都是乾淨的程式碼，是不是很方便？

以上是一個簡單的步驟讓你的 Python 程式碼更乾淨的詳細內容。更多資訊請關注PHP中文網其他相關文章！