如何覆盖抽象属性方法而不忘记在子类中添加属性装饰器？

Question

如果我重写了抽象属性方法，但忘记指定它仍然是子类中的属性方法，我希望 Python 解释器对我大喊大叫。

class Parent(metaclass=ABCMeta):
  @property
  @abstractmethod
  def name(self) -> str:
    pass

class Child(Parent):
  @property # If I forget this, I want Python to yell at me.
  def name(self) -> str:
    return 'The Name'

if __name__ == '__main__':
  print(Child().name)

Python 真的没有内置方法可以做到这一点吗？我真的必须创建自己的装饰器来处理这种类型的行为吗？

Answer 1

您可以使用metaclass：

class Parent(type):
  def __new__(cls, name, bases, body):
    if 'name' not in body.keys() or body['name'].__class__.__name__ != 'property':
      raise TypeError(f"Can't instantiate class {name} without property name")
    return super().__new__(cls, name, bases, body)


class Child(metaclass=Parent):
  @property # If I forget this, raise TypeError
  def name(self) -> str: # also, name must be implemented
    return 'The Name'

if __name__ == '__main__':
  print(Child().name)

这会引发TypeError: Can't instantiate class Child without property name - 当@property 被注释掉时！

Answer 2

您可以在 Parent 的 __init__ 方法中进行运行时检查，如果 name 是一个方法，则引发异常。

class Parent(metaclass=ABCMeta):
  def __init__(self):
    assert not callable(self.name)

  @abstractmethod
  def name(self) -> str:
    pass


class GoodChild(Parent):
  @property
  def name(self) -> str:
    return 'The Name'


class BadChild(Parent):
  def name(self) -> str:
    return 'Whoops, not a property'


if __name__ == '__main__':
  good_child = GoodChild()
  print(good_child.name)   # Prints 'The Name'
  bad_child = BadChild()   # Raises an AssertionError when initialized

Answer 3

TLDR - 在我看来，不值得麻烦：

在 linting/mypy 和单元测试之间，应该涵盖您的大部分需求以及围绕类分析/元类的小技巧可能不值得它们带来额外的认知负担。您只会“失败”一次装饰，但会每次都必须阅读异国情调的脚手架代码以了解您想做的事情。

详细信息 - 实际使用被标记为什么？

即if badchild1.name.startswith("John"): 将在运行时失败，我希望 mypy 或 pylint 例如也能在分析中进行标记，因为它将是一个方法对象。串联也是如此。唯一真正需要监督的是 f 字符串、直接布尔值或 ==、!= 相等比较，它们不在乎它不是字符串。

pylint 这么说：

test_171_prop.py:11 Method 'name' was expected to be 'property', found it instead as 'method' (invalid-overridden-method)

mypy 没有问题。

但是，如果我添加这个：

child = Child()

print("name:" + child.name)

然后 mypy 说：

test_171_prop.py:16: error: Unsupported operand types for + ("str" and "Callable[[], str]")
Found 1 error in 1 file (checked 1 source file)

并用 2 个新行运行代码：

TypeError: can only concatenate str (not "method") to str