如何配置pylint以获得更高的准确性

how to configure pylint for greater accuracy

从 pylint 获取误报

考虑这段代码:

previous = None
for word in ['you', 'cannot', 'be', 'serious']:
    if previous is not None:
        print(previous[0], word)
    previous = word

这是输出(这里没有惊喜):

$ python3 test.py
y cannot
c be
b serious

使用 pylint 检查结果如下:

$ pylint3 test.py
No config file found, using default configuration
************* Module test
C:  1, 0: Missing module docstring (missing-docstring)
C:  1, 0: Constant name "previous" doesn't conform to UPPER_CASE naming style (invalid-name)
E:  4,14: Value 'previous' is unsubscriptable (unsubscriptable-object)

--------------------------------------------------------------------
Your code has been rated at -4.00/10 (previous run: -4.00/10, +0.00)

如您所见,pylint 已根据 previous 初始化为 None 的事实抱怨表达式 previous[0],即使该语句不能当它具有该值时达到。此外,尽管在最后一行进行了赋值,但它基于 previous 是常量的基础上抱​​怨命名风格。

问题:是否有任何合适的 pylint 配置可以避免此类误报而不引入同样明显的漏报,如果是这样,为什么这不是默认设置?

尝试的解决方案:禁用测试(导致假阴性)

例如,我可以完全抑制 unsubscriptable-object 警告,方法是创建一个包含 pylint3 --generate-rcfile 输出的 $HOME/.pylintrc,然后编辑它以将 unsubscriptable-object 添加到禁用测试列表(参见 [MESSAGES CONTROL] 部分中的 disable=)。

但是,如果我简单地以这种方式禁用测试,然后验证以下代码:

"false negative"  # silence docstring warning (fair enough)

print(None[0])  # this line will fail

它告诉我:

$ pylint3 test2.py
Using config file /home/<myuser>/.pylintrc

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

所以仅仅禁用测试并不是真正的答案。

版本和平台信息

版本信息:

$ pylint3 --version
Using config file /home/<myuser>/.pylintrc
pylint3 1.8.3, 
astroid 1.6.0
Python 3.6.9 (default, Apr 18 2020, 01:56:04) 
[GCC 8.4.0]

平台:Ubuntu 18.04.4 LTS

Pylint 是一种静态类型检查器,具有该类型实用程序的所有限制。它不会读懂你的想法,它只会读你的代码。它的目的是告诉你看起来可疑的代码,有时你不得不告诉它忽略某些事情,因为你实际上想那样写程序。

如果您期望 Pylint 是一个完美无缺的代码纳粹,它可以识别您的每一个错误,永远不会被冲昏头脑,也不会遗漏任何东西,那么您会失望的。如果您认为它是一个友好的观察者,可以在您 运行 您的程序之前发现您的一些错误,那么它非常强大。我认为它是必不可少的工具,只要您对它的要求不高。

你说 previous 不是常数,但这不是 Pylint 使用该术语的方式。您在模块的最外层缩进级别声明 previous,因此它是全局的; Pylint 认为全局变量的唯一有效用途是作为常量。因此错误。

要让 pylint 接受常量的任何格式,请在资源配置文件中使用此行:

const-rgx=[A-Za-z0-9_]{1,30}$

这就是我找到默认设置后所做的,即

const-naming-style=UPPER_CASE

太严格了。

RC 文件很重要,IMO。它允许您对 Pylint 的功能进行大量控制。如果您的 RC 文件被命名为 pylint.rc,您可以使用标志 --rcfile=pylint.rc 调用 pylint。根据您的环境设置方式,您可能必须提供完整路径名。

根据描述的配置,Pylint 毫无怨言地接受此代码:

previous = ''
for word in ['you', 'cannot', 'be', 'serious']:
    if previous:
        print(previous[0], word)
    previous = word

同样的逻辑,但是更容易理解,因为它明确了previous是一个字符串。所以 Pylint 确实帮助你编写了更具可读性的代码。

有时也需要告诉 Pylint 停止抱怨特定线路。在您的示例中,如果您真的想在 None 之前进行初始化,您所要做的就是添加一个内联编译指示,如下所示:

previous = None
for word in ['you', 'cannot', 'be', 'serious']:
    if previous is not None:
        print(previous[0], word)   # pylint: disable=unsubscriptable-object
    previous = word

这是比您尝试过的解决方案更好的解决方案,因为它仅解决了一行中的错误,并且会标记其他出现的相同错误。