【Python 軍火庫🧨 - Ruff】更加豐富強大的Python Linter

2023/10/28閱讀時間約 6 分鐘

我們在「【🔒 Python 先修班】⬆️ 培養良好的Coding Style讓專業度 Up!Up!Up!」談到了Coding Style，在文末也分享了pylint的程式碼檢查工具，雖然內建、簡單快速上手，但隨著技術的演進，我們總需要又快、又好、又簡單的工具做為預設的工具庫， Ruff就是一個新世代的Python Linter工具，底層由Rust程式語言進行開發，我們可以看看官方的效能評比報告，根本就是開跑車啊！！！

功能也接近Flake8的完整功能，這一套也是非常熱門的一套工具，因此想嚐鮮的朋友也不妨試試。

什麼是Linter？

它是一種程式碼檢查工具，幫助我們在開發的過程中檢查出語法錯誤、漏洞…等，可能危害程式的語法，就如同我們的編輯器會抱怨出紅字一樣的告警。

目的都是為了自動化的幫我們進行QA， feat.【🔒 Python 先修班】⬆️ 培養良好的Coding Style讓專業度 Up!Up!Up!

安裝無負擔

雖然是rust開發，但ruff一樣有將工具打包成pypi並上傳至平台(feat.【🔒 Python 先修班】教你親手打包專屬套件庫的手作課(pip install…))，因此我們也可以輕鬆的進行安裝。

pip install ruff

如果我們不打算安裝，只想要初淺的玩玩語法檢查，那可以來這裡 https://play.ruff.rs/ 試玩看看…

基本指令導覽

我們可以對某個python檔案進行檢查

ruff check xxx.py

也可以檢查目錄

ruff check 目錄

當然也可以僅針對某個目錄底下的.py檔案檢查

ruff check 目錄/*.py

修復錯誤可以這樣做:

ruff check --fix .
Found 1 error (1 fixed, 0 remaining).

要怎麼假裝看不見的忽略錯誤？

一切都不是我的錯，我不想看到錯誤，我們開發到很煩躁的時候應該都非常想這樣做吧！雖然這個作法不太建議啦，但有時候我們幾乎可以不用理會一些非必要的錯誤時(註解、docstring…)，我們就可以這樣做。

# Ignore F841.
x = 1  # noqa: F841

# Ignore E741 and F841.
i = 1  # noqa: E741, F841

# Ignore _all_ violations.
x = 1  # noqa

當然在docstring也可以如此。

""Lorem ipsum dolor sit amet.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor.
"""  # noqa

配置檔與規則

我們可以在這裡「settings/#top-level」看到一堆密密麻麻的規則，當然我們不需要嚴謹的每一條都列上，這取決於團隊的風格與偏好去進行選擇。

P.S 不論是老牌的pylint到flake8，各種配置應有盡有，只是團隊要轉移時需要有一次性的工序，將原本的配置檔進行轉換一下。

至於檔案的名稱雖然支援了「pyproject.toml」、「ruff.toml」、「.ruff.toml」，但會比較建議另外的檔案去管理這些規則，如果都納入「pyproject.toml」，我們除了安裝的配置也要有Lint的配置，會稍微混亂一些。

如果還是堅持想要直接在「pyproject.toml」裡面描述的話，那需要一個區塊來進行區隔。

[tool.ruff]
select = ["E4", "E7", "E9", "F"]
ignore = []

如果是獨立的「.ruff.toml」與「ruff.toml」時，我們就不需要多一層進行區隔了。

# Enable flake8-bugbear (`B`) rules.
select = ["E", "F", "B"]

# Never enforce `E501` (line length violations).
ignore = ["E501"]

以下是個人習慣的簡易配置。

line-length = 80

[pydocstyle]
convention = "google"

[format]
quote-style = "single"

如何與編輯器vscode整合？

下載Ruff VS Code 擴展，它支援修復操作、導入排序等。

安裝完畢之後，我們只要在專案目錄底下撰寫.toml配置檔， vscode就能夠根據我們的配置檔幫我們進行程式碼的檢查與格式化了。

我們可以使用Ctrl + Shift + P並設定預設的「文件格式化方式」，這邊會有三個選項，我們可以選擇ruff即可(記得重新載入VSCode才會生效唷)。

接下來我們就可以直接對程式碼文件進行Ctrl + Shift + I 就可以幫我們進行排版了。

結合自動化檢核流程讓我們更省事

既然我們已經學會怎麼搭建Linter之後，但會面臨到一個問題，我們通常在開發的過程會使用Git來管理原始碼，如果能夠在提交之前自動幫我們檢查那該有多好啊！正好，Python的開發模式也提供了pre-commit套件，它可以在commit之前進行一些前置作業流程，詳細請參考：「【🔒 Python 先修班】🧐 請加入自動化QA(pre-commit)來幫我們檢核程式碼」