断言&类中派生类中所需方法的文档[重复]

Question

class Bird:

    def fly(self):
        self.flap_wings()

class Eagle(Bird):

    def flap_wings(self):
        print('flapping wings')

对于Bird来说，FLAP_WINGS既断言其派生类具有FLAP_WINGS方法，又包含关于FLAP_WINGS应该做什么的文档，有什么好的、明确的方法呢？

现在，我正在使用__init_subclass__:

class Bird:

    def fly(self):
        self.flap_wings()

    def __init_subclass__(cls, **kwargs):
        assert hasattr(cls, 'flap_wings'), (
            "Derived classes have to have a flap_wings method which should "
            "print 'flapping wings'."
        )

但是，assert表达式只在创建Bird类之后才显示，并且不是可以通过help访问的“真正的”docstring。

我知道这是一个悬而未决的问题，但还有什么更好的方法？首先在bird中定义flap_wings并不违反规则，可能只是使用bodypass和一个docString。但我就是找不到处理这种情况的“标准”方法。所以我在寻找任何建议。

Answer 1

您可以将abc库用于抽象方法：

from abc import ABCMeta, abstractmethod
import six

class Bird(six.with_metaclass(ABCMeta)):
    def fly(self):
        """Take flight.

        Notes
        -----
        This depends on the abstract method `flap_wings`. If you've
        not implemented this at the subclass level, your subclass
        cannot be properly instantiated.
        """
        self.flap_wings()

    @abstractmethod
    def flap_wings(self):
        """Subclasses must implement this"""

这就建立了某种契约。任何不实现flap_wings方法的子类都将在实例化时引发错误：

class Flamingo(Bird):
    pass

>>> Flamingo()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class Flamingo with abstract methods flap_wings

而实现抽象方法的子类可以很好地工作：

class BlueJay(Bird):
    def flap_wings(self):
        print("Flappity flap")

>>> BlueJay().fly()
Flappity flap