提高程式碼品質 | 利用 Python Pre-commit 自動化檢測

Alan Syue
2 min readJan 29, 2020

--

為了提高之後協作專案的程式碼品質,這兩天在研究如何在 commit 前先自動檢查一些 coding style 或 syntax error, 這次會分享運用 git hooks、python 的 pre-commit framework 來自動化檢查的執行步驟:

一、安裝 Pre-commit

使用 pip 安裝: pip install pre-commit

二、撰寫 pre-commit 設定檔

可參考以下寫法,其中 hooks 的 id 可以從此處查找選用。

我選擇的有:

1. trailing-whitespace : 去除尾端的空白格

2. check-json:檢查所有 json 檔案格式

3. flake8 :執行 flake8 檢查 coding style

4. detect-private-key:檢查檔案中是否存在 private key

三、git commit 後即可自動檢查

設置完成後,每當執行 commit 指令,就會自動檢查所選的項目,下圖可看到通過就會呈現 Passed d,沒通過就會出現 Failed 及錯誤訊息。

總結

透過簡單設置 pre-commit,希望在之後的協作開發專案上,能夠增加程式碼的質量,並且幫助 Code review 時不必再額外花時間檢查這些基本問題,更專注在邏輯上。

參考資料

Sign up to discover human stories that deepen your understanding of the world.

Free

Distraction-free reading. No ads.

Organize your knowledge with lists and highlights.

Tell your story. Find your audience.

Membership

Read member-only stories

Support writers you read most

Earn money for your writing

Listen to audio narrations

Read offline with the Medium app

--

--

Alan Syue
Alan Syue

Written by Alan Syue

Backend Engineer at UPN | Love to share everything

No responses yet

Write a response