PyLint 的優(yōu)點(diǎn)、缺點(diǎn)和危險(xiǎn)
充分利用 PyLint。
敲黑板:PyLint 實(shí)際上很好!
“PyLint 可以拯救你的生命”,這是一句夸張的描述,但沒有你想象的那么夸張。PyLint 可以讓你遠(yuǎn)離非常難找到的和復(fù)雜的缺陷。最差的情況下,它只可以節(jié)省測(cè)試運(yùn)行的時(shí)間。最好的情況下,它可以幫你避免生產(chǎn)環(huán)境中復(fù)雜的錯(cuò)誤。
優(yōu)點(diǎn)
我不好意思說這種情況是多么普遍。測(cè)試的命名總是那么奇怪:沒有人關(guān)心這個(gè)名稱,而且通常也找不到一個(gè)自然的名稱。例如以下代碼:
測(cè)試生效:
但問題是:如果你覆蓋了一個(gè)測(cè)試的名稱,測(cè)試框架將愉快地跳過這個(gè)測(cè)試!
實(shí)際上,這些文件可能有數(shù)百行,而添加新測(cè)試的人可能并不知道所有的名稱。除非有人仔細(xì)查看測(cè)試輸出,否則一切看起來都很好。
最糟糕的是,被覆蓋測(cè)試的添加、被覆蓋測(cè)試造成的破壞,以及連鎖反應(yīng)的問題可能要幾天、幾月甚至幾年才能發(fā)現(xiàn)。
PyLint 會(huì)找到它
就像一個(gè)好朋友一樣,PyLint 可以幫助你。
缺點(diǎn)
就像 90 年代的情景喜劇一樣,你對(duì) PyLint 了解的越多,問題就越多。以下是一個(gè)庫存建模程序的常規(guī)代碼:
但 PyLint 似乎有自己的觀點(diǎn)(可能形成于 90 年代),并且不怕把它們作為事實(shí)陳述出來:
危險(xiǎn)
有沒有想過在一個(gè)數(shù)百萬人使用的工具中加入自己未證實(shí)的觀點(diǎn)?PyLint 每月有 1200 萬次下載。
“如果太挑剔,人們會(huì)取消檢查” — 這是 PyLint GitHub 的 6987 號(hào)議題,于 2022 年 7 月 3 號(hào)提出
對(duì)于添加一個(gè)可能有許多誤報(bào)的測(cè)試,它的態(tài)度是 ... “嗯”。
讓它為你工作
PyLint 很好,但你需要小心地與它配合。為了讓 PyLint 為你工作,以下是我推薦的三件事:
1、固定版本
固定你使用的 PyLint 版本,避免任何驚喜!
在你的 ??.toml?
? 文件中定義:
在代碼中定義:
這與以下代碼對(duì)應(yīng):
2、默認(rèn)禁止
禁用所有檢查,然后啟用那些你認(rèn)為誤報(bào)比率高的。(不僅僅是漏報(bào)/誤報(bào)的比率!)
3、檢查器
以下是我喜歡的檢查器。加強(qiáng)項(xiàng)目的一致性,避免一些明顯的錯(cuò)誤。
使用 PyLint
你可以只使用 PyLint 好的部分。在 CI 中運(yùn)行它以保持一致性,并使用常用檢查器。
放棄不好的部分:默認(rèn)禁止檢查器。
避免危險(xiǎn)的部分:固定版本以避免意外。