等效于 Python 中的字段的 NotImplementedError

Question

在 Python 2.x 中，当你想将一个方法标记为抽象时，你可以这样定义它：

class Base:
    def foo(self):
        raise NotImplementedError("Subclasses should implement this!")

然后，如果您忘记覆盖它，您会得到一个很好的提醒异常。是否有等效的方法将字段标记为抽象？还是在类文档字符串中说明所有你能做的？

起初我以为我可以将该字段设置为 NotImplemented，但当我查看它的实际用途（丰富的比较）时，它似乎是滥用。

Answer 1

是的，你可以。使用 @property 装饰器。例如，如果您有一个名为“example”的字段，那么您不能这样做：

class Base(object):

    @property
    def example(self):
        raise NotImplementedError("Subclasses should implement this!")

运行以下命令会产生您想要的 NotImplementedError。

b = Base()
print b.example

Answer 2

替代答案：

@property
def NotImplementedField(self):
    raise NotImplementedError

class a(object):
    x = NotImplementedField

class b(a):
    # x = 5
    pass

b().x
a().x

这与 Evan 的类似，但简洁且便宜——您只会获得一个 NotImplementedField 实例。

Answer 3

更好的方法是使用Abstract Base Classes：

import abc

class Foo(abc.ABC):

    @property
    @abc.abstractmethod
    def demo_attribute(self):
        raise NotImplementedError

    @abc.abstractmethod
    def demo_method(self):
        raise NotImplementedError

class BadBar(Foo):
    pass

class GoodBar(Foo):

    demo_attribute = 'yes'

    def demo_method(self):
        return self.demo_attribute

bad_bar = BadBar()
# TypeError: Can't instantiate abstract class BadBar \
# with abstract methods demo_attribute, demo_method

good_bar = GoodBar()
# OK

请注意，您仍然应该使用raise NotImplementedError 而不是pass，因为没有什么可以阻止继承类调用super().demo_method()，如果抽象demo_method 只是pass，这将失败默默地。

Answer 4

def require_abstract_fields(obj, cls):
    abstract_fields = getattr(cls, "abstract_fields", None)
    if abstract_fields is None:
        return

    for field in abstract_fields:
        if not hasattr(obj, field):
            raise RuntimeError, "object %s failed to define %s" % (obj, field)

class a(object):
    abstract_fields = ("x", )
    def __init__(self):
        require_abstract_fields(self, a)

class b(a):
    abstract_fields = ("y", )
    x = 5
    def __init__(self):
        require_abstract_fields(self, b)
        super(b, self).__init__()

b()
a()

注意将类类型传递给require_abstract_fields，因此如果多个继承类使用它，它们不会全部验证最派生类的字段。您可能可以使用元类自动执行此操作，但我没有深入研究。接受将字段定义为 None。

Answer 5

似乎这个问题对实例属性和类属性都是开放的，我将只关注第一个主题。

因此，例如属性，Evan's 的替代答案是使用 pyfields 定义必填字段：

from pyfields import field

class Base(object):
    example = field(doc="This should contain an example.")

b = Base()
b.example

产量

pyfields.core.MandatoryFieldInitError: 
   Mandatory field 'example' has not been initialized yet 
   on instance <__main__.Base object at 0x000002C1000C0C18>.

当然，它不提供通过讨论子类来编辑错误消息的能力。但从某种意义上说，不谈论子类更为现实——实际上在 python 中，属性可以在基类的实例上覆盖——不仅在子类中。

注意：我是pyfields 的作者。详情请见documentation。

Answer 6

这是一个简单的示例，如何在 Python 3 中为子类设置所需的属性/方法。

class Base:
    requires = ('foo', 'bar')

    def __init_subclass__(cls, **kwargs):
        for requirement in cls.requires:
            if not hasattr(cls, requirement):
                raise NotImplementedError(
                        f'"{cls.__name__}" must have "{requirement}".')
        super().__init_subclass__(**kwargs)

Answer 7

这是我的解决方案：

def not_implemented_method(func):
    from functools import wraps
    from inspect import getargspec, formatargspec

    @wraps(func)
    def wrapper(self, *args, **kwargs):
        c = self.__class__.__name__
        m = func.__name__
        a = formatargspec(*getargspec(func))
        raise NotImplementedError('\'%s\' object does not implement the method \'%s%s\'' % (c, m, a))

    return wrapper


def not_implemented_property(func):
    from functools import wraps
    from inspect import getargspec, formatargspec

    @wraps(func)
    def wrapper(self, *args, **kwargs):
        c = self.__class__.__name__
        m = func.__name__
        raise NotImplementedError('\'%s\' object does not implement the property \'%s\'' % (c, m))

    return property(wrapper, wrapper, wrapper)

它可以用作

class AbstractBase(object):
    @not_implemented_method
    def test(self):
        pass

    @not_implemented_property
    def value(self):
        pass

class Implementation(AbstractBase):
    value = None

    def __init__(self):
        self.value = 42

    def test(self):
        return True

Answer 8

处理此问题的一个有趣模式是在父类中将属性设置为None，并使用确保已在子类中设置的函数访问该属性。

这是来自django-rest-framework的示例：

class GenericAPIView(views.APIView):

    [...]

    serializer_class = None

    [...]

    def get_serializer_class(self):
        assert self.serializer_class is not None, (
            "'%s' should either include a `serializer_class` attribute, "
            "or override the `get_serializer_class()` method."
            % self.__class__.__name__
        )

        return self.serializer_class