0

从 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[0]previousNoneprevious

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

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

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

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

"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

4

1 回答 1

2

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 你调用 pylint 带有标志--rcfile=pylint.rc。根据环境的设置方式,您可能必须提供完整的路径名。

使用所描述的配置,Pylint 毫无怨言地接受此代码:

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

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

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

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

这是一个比您尝试过的更好的解决方案,因为它仅在一行中解决了错误,并且相同错误的其他事件将被标记。

于 2020-06-26T01:54:32.070 回答