如何评论/记录Pylint内联选项的使用?

时间:2014-09-01 16:38:40

标签: python pylint

禁用Pylint检查或绕过其中一个警告,不应该没有明确的原因。我希望能够在我禁用它的地方评论这些原因;到目前为止,没有成功。

举个例子,让一个只有构造函数和单个方法的类。 Pylint有种原因警告的事情,尽管可能有很多理由在本地禁用此警告。

class Foo(object):  # pylint: disable=R0903 --- Closure object

    def __init__(self, data):
        …

    def single_method(argument):
       …

有了上述内容,Pylint不仅仍然警告“公共方法太少”,而且还抱怨“选项价值不好' R0903 ---关闭对象'”。

这个问题比这个例子有更广泛的理性(可能我不知道在Python中实现闭包的更好方法),我希望能够对大多数这些内联指​​令进行评论。 ,为了清晰和简单,在同一条线上。顺便说一句,也可能有助于提醒选项的用途。例如,提醒# pylint: disable=R0903 --- Too few public methods(保持相同的例子)。

用更少的话说:有没有办法评论Pylint内联指令?

3 个答案:

答案 0 :(得分:5)

Since pylint 1.5.0,您可以# pylint: disable=no-member; any text here

答案 1 :(得分:2)

This works for me:

class Foo(object):  # (Closure object) pylint: disable=R0903

def __init__(self, data):
    …

def single_method(argument):
   …

My pylint version is

(doisub)> $ pylint --version                                              
pylint 1.5.4,
astroid 1.4.4
Python 2.7.11 (default, Dec 22 2015, 11:45:03)
[GCC 4.4.7 20120313 (Red Hat 4.4.7-16)]

答案 2 :(得分:1)

Pylint不支持评论指令。但从0.25.3开始,您可以使用符号名http://docs.pylint.org/faq.html#do-i-have-to-remember-all-these-numbers。如果你需要/想要评论,你将不得不使用第二行(我通常在我的Pylint指令上面添加注释)