API可以告诉Pylint不要在客户端代码中抱怨吗?

时间:2010-08-18 06:48:58

标签: python pylint

我在可重用的类中有一些代码可以修改某些类型。这是一个简化版本。

class Foo:
    def __init__(self):
        self.count = 0

    def increment(self):
        self.count += 1

# Add another method outside of the class definition.
# Pylint doesn't care about this, and rates this file 10/10.

Foo.__dict__["current_count"] = lambda self: self.count

在实际代码中,“current_count”是一个变量,而不是一个固定的字符串,这就是我没写的原因:

Foo.current_count = lambda self: self.count # Cannot do in my scenario.

现在,当我的客户来使用新功能时,Pylint惊恐地跳起来。

import server_api

def main():
    foo_count = server_api.Foo()
    foo_count.increment()


    print foo_count.current_count()
    # Pylint complains here:
    #     E1101:  8:main: Instance of 'Foo' has no 'current_count' member
    # I don't want to have to tell pylint to disable that message in every client.

main()

每个使用这个新函数的类都受到惩罚,我被迫在每个引用中禁用该消息。我会在API中添加一些代码,告诉Pylint在这个类上有未知的引用时会发冷。

唉,pylint文件是......嗯...不是有利于我理解的质量,我一直在那里找不到任何建议。

如此沸腾:我能告诉我的API代码中的pylint关闭与此类相关的E1101规则,只要客户引用它吗?还有其他解决方案吗?

3 个答案:

答案 0 :(得分:5)

以下是ActiveState cookbook recipe Yoni H中提供的answer中的示例启发我的解决方案。

对于Foo类,我添加了这个无用的__getattr__方法。

def __getattr__(self, name):
    # This is only called when the normal mechanism fails, so in practice should never be called.
    # It is only provided to satisfy pylint that it is okay not to raise E1101 errors in the client code.
    raise AttributeError("%r instance has no attribute %r" % (self, name))

这应该与以前的版本几乎无法区分。它不应该在正常的事件过程中被调用,但它足以说服pylint对此错误保持安静。

P.S。你可以抱怨这段代码不是很漂亮。我赞同这个意见。但我认为它对客户的好处超过了它的代码味道。

答案 1 :(得分:2)

根据您的评论,由于您要使用枚举类型,为什么不看看at this SO questionthis ActiveState cookbook recipe

出于个人偏好,我会选择将枚举类型添加到类中,就像SO question 中的一个答案一样(为上下文无耻地复制):

class Animal:
   def __init__(self, name):
       self.name = name

   def __str__(self):
       return self.name

   def __repr__(self):
       return "<Animal: %s>" % self

Animal.DOG = Animal("dog")
Animal.CAT = Animal("cat")

答案 2 :(得分:0)

从语用上讲,为什么假设pylint(或任何lint)应该是沉默的?鉴于假阳性和假阴性之间的偏差,棉绒应该更喜欢前者。在我看来,因为Pylint将其结果表达为人们认为应该最大化的分数,但是没有“获胜”奖。

另一方面,它抱怨的构造肯定是丑陋的。我知道server_api是为了方便而简化的,但你真的需要搞清楚模块名称空间吗?从您的客户端代码看,current_count方法名称是硬编码的,为什么不在服务器中呢?