PyLint 的優點、缺點和危險

Moshe Zadka]發表於2022-10-16

充分利用 PyLint。

敲黑板：PyLint 實際上很好！

“PyLint 可以拯救你的生命”，這是一句誇張的描述，但沒有你想象的那麼誇張。PyLint 可以讓你遠離非常難找到的和複雜的缺陷。最差的情況下，它只可以節省測試執行的時間。最好的情況下，它可以幫你避免生產環境中複雜的錯誤。

優點

我不好意思說這種情況是多麼普遍。測試的命名總是那麼奇怪：沒有人關心這個名稱，而且通常也找不到一個自然的名稱。例如以下程式碼：

def test_add_small():
    # Math, am I right?
    assert 1 + 1 == 3
    
def test_add_large():
    assert 5 + 6 == 11
    
def test_add_small():
    assert 1 + 10 == 11

測試生效：

collected 2 items                                                                         
test.py .. 
2 passed

但問題是：如果你覆蓋了一個測試的名稱，測試框架將愉快地跳過這個測試！

實際上，這些檔案可能有數百行，而新增新測試的人可能並不知道所有的名稱。除非有人仔細檢視測試輸出，否則一切看起來都很好。

最糟糕的是，被覆蓋測試的新增、被覆蓋測試造成的破壞，以及連鎖反應的問題可能要幾天、幾月甚至幾年才能發現。

PyLint 會找到它

就像一個好朋友一樣，PyLint 可以幫助你。

test.py:8:0: E0102: function already defined line 1
     (function-redefined)

缺點

就像 90 年代的情景喜劇一樣，你對 PyLint 瞭解的越多，問題就越多。以下是一個庫存建模程式的常規程式碼：

"""Inventory abstractions"""

import attrs

@attrs.define
class Laptop:
    """A laptop"""
    ident: str
    cpu: str

但 PyLint 似乎有自己的觀點（可能形成於 90 年代），並且不怕把它們作為事實陳述出來：

$ pylint laptop.py | sed -n '/^laptop/s/[^ ]*: //p'
R0903: Too few public methods (0/2) (too-few-public-methods)

危險

有沒有想過在一個數百萬人使用的工具中加入自己未證實的觀點？PyLint 每月有 1200 萬次下載。

“如果太挑剔，人們會取消檢查” — 這是 PyLint GitHub 的 6987 號議題，於 2022 年 7 月 3 號提出

對於新增一個可能有許多誤報的測試，它的態度是 ... “嗯”。

讓它為你工作

PyLint 很好，但你需要小心地與它配合。為了讓 PyLint 為你工作，以下是我推薦的三件事：

1、固定版本

固定你使用的 PyLint 版本，避免任何驚喜！

在你的 .toml 檔案中定義:

[project.optional-dependencies]
pylint = ["pylint"]

在程式碼中定義：

from unittest import mock

這與以下程式碼對應：

# noxfile.py
...
@nox.session(python=VERSIONS[-1])
def refresh_deps(session):
    """Refresh the requirements-*.txt files"""
    session.install("pip-tools")
    for deps in [..., "pylint"]:
        session.run(
            "pip-compile",
            "--extra",
            deps,
            "pyproject.toml",
            "--output-file",
            f"requirements-{deps}.txt",
        )

2、預設禁止

禁用所有檢查，然後啟用那些你認為誤報比率高的。（不僅僅是漏報/誤報的比率！）

# noxfile.py
...
@nox.session(python="3.10")
def lint(session):
    files = ["src/", "noxfile.py"]
    session.install("-r", "requirements-pylint.txt")
    session.install("-e", ".")
    session.run(
        "pylint",
        "--disable=all",
        *(f"--enable={checker}" for checker in checkers)
        "src",
    )

3、檢查器

以下是我喜歡的檢查器。加強專案的一致性，避免一些明顯的錯誤。

checkers = [
    "missing-class-docstring",
    "missing-function-docstring",
    "missing-module-docstring",
    "function-redefined",
]

使用 PyLint

你可以只使用 PyLint 好的部分。在 CI 中執行它以保持一致性，並使用常用檢查器。

放棄不好的部分：預設禁止檢查器。

避免危險的部分：固定版本以避免意外。

via: https://opensource.com/article/22/9/pylint-good-bad-ugly

作者：Moshe Zadka 選題：lkxed 譯者：MjSeven 校對：wxy

本文由 LCTT 原創編譯，Linux中國 榮譽推出

相關文章