一個簡單的步驟讓你的 Python 代碼更干凈
作者：somenzz
你可以將這兩個文件拷貝到自己的項目根目錄中，然后執行一次 pre-commit install，這樣每次提交代碼的時候，都是干凈的代碼，是不是很方便？
說起來容易做起來難，我們都知道代碼可讀性非常重要，但是寫的時候總是隨心所欲，不考慮類型提示、import 排序、PEP8 規范。今天分享一個小技巧，通過一個簡單的步驟就可以讓你的 Python 代碼更干凈。
這就是 pre-commit：
可以讓你的代碼提交之前自動檢查是否符合你想要的規范。
使用之前，先 pip 安裝一下：
然后在項目的根目錄下創建兩個文件：.pre-commit-config.yaml 和 pyproject.toml。
.pre-commit-config.yaml 文件內容如下：
這里面配置了 black、mypy、check-docstring-first、isort 等工具，id 就是對應的工具，可以說這個配置文件基本上就夠用了。
在 .pre-commit-config.yaml 文件中，我們可以指定將使用哪些掛鉤，在 pyproject.toml 中，我們可以為這些單獨的鉤子指定參數。
pyproject.toml 文件內容如下：
這里配置了 black 和 isort 的相關配置。
然后執行在項目的根目錄執行 pre-commit install 命令，就可以安裝 pre-commit 插件。
然后每次更新代碼，提交代碼時，這些鉤子都會觸發，會自動執行如下操作：
排序 import
PEP8 的格式代碼
檢查您的 yaml 和 json 文件的正確性
類型檢查（如果你使用了類型提示）
最后
你可以將這兩個文件拷貝到自己的項目根目錄中，然后執行一次 pre-commit install，這樣每次提交代碼的時候，都是干凈的代碼，是不是很方便？
責任編輯：武曉燕
來源：
Python七號
