在Python中,如何强制抽象方法在子类上是静态的?

时间:2015-04-05 08:55:17

标签: python abstract-class static-methods abc

这是我想要的设置: A应该是一个带有静态&的抽象基类。抽象方法f()。 B应该从A继承。要求: 1.你不应该能够实例化A. 2.您不应该实例化B,除非它实现静态f()

this问题中汲取灵感,我尝试了几种方法。有了这些定义:

class abstractstatic(staticmethod):
    __slots__ = ()
    def __init__(self, function):
        super(abstractstatic, self).__init__(function)
        function.__isabstractmethod__ = True
    __isabstractmethod__ = True

class A:
    __metaclass__ = abc.ABCMeta
    @abstractstatic
    def f():
        pass

class B(A):
    def f(self):
        print 'f'

class A2:
    __metaclass__ = abc.ABCMeta
    @staticmethod
    @abc.abstractmethod
    def f():
        pass

class B2(A2):
    def f(self):
        print 'f'

这里使用通常的Python惯例和A& A定义A2和B2。 B使用this答案中建议的方式定义。以下是我尝试的一些操作以及不希望的结果。

使用A / B类:

>>> B().f()
f
#This should have thrown, since B doesn't implement a static f()

使用A2 / B2类:

>>> A2()
<__main__.A2 object at 0x105beea90>
#This should have thrown since A2 should be an uninstantiable abstract class

>>> B2().f()
f
#This should have thrown, since B2 doesn't implement a static f()

由于这些方法都没有给我我想要的输出,我如何实现我的目标?

1 个答案:

答案 0 :(得分:8)

您只需ABCMeta即可完成所需操作。 ABC执行不进行任何类型检查,只强制存在具有正确名称的属性

以例如:

>>> from abc import ABCMeta, abstractmethod, abstractproperty
>>> class Abstract(object):
...     __metaclass__ = ABCMeta
...     @abstractmethod
...     def foo(self): pass
...     @abstractproperty
...     def bar(self): pass
... 
>>> class Concrete(Abstract):
...     foo = 'bar'
...     bar = 'baz'
... 
>>> Concrete()
<__main__.Concrete object at 0x104b4df90>

即使Concrete()foo都是简单属性,我也可以构建bar

ABCMeta元类只跟踪__isabstractmethod__属性为真的剩余对象数;当从元类创建一个类(调用ABCMeta.__new__)时,cls.__abstractmethods__属性被设置为一个frozenset对象,其中所有名称仍然是抽象的。

type.__new__然后测试frozenset并在尝试创建实例时抛出TypeError

您必须在此处制作自己的 __new__方法;子类ABCMeta并在新的__new__方法中添加类型检查。该方法应在基类上查找__abstractmethods__集,在MRO中找到具有__isabstractmethod__属性的相应对象,然后对当前类属性进行类型检查。

这意味着您在定义时抛出异常,而不是实例。为此,您需要向__call__子类添加ABCMeta方法,并根据您自己的__new__方法收集的有关哪些类型错误的信息抛出异常;与ABCMetatype.__new__目前所做的类似的两阶段流程。或者,更新类上的__abstractmethods__集以添加已实现但具有错误类型的任何名称,并将其留给type.__new__以抛出异常。

以下实施采用最后一种方法;如果实现的类型不匹配(使用映射),则将名称添加回__abstractmethods__

from types import FunctionType

class ABCMetaTypeCheck(ABCMeta):
    _typemap = {  # map abstract type to expected implementation type
        abstractproperty: property,
        abstractstatic: staticmethod,
        # abstractmethods return function objects
        FunctionType: FunctionType,
    }
    def __new__(mcls, name, bases, namespace):
        cls = super(ABCMetaTypeCheck, mcls).__new__(mcls, name, bases, namespace)
        wrong_type = set()
        seen = set()
        abstractmethods = cls.__abstractmethods__
        for base in bases:
            for name in getattr(base, "__abstractmethods__", set()):
                if name in seen or name in abstractmethods:
                    continue  # still abstract or later overridden
                value = base.__dict__.get(name)  # bypass descriptors
                if getattr(value, "__isabstractmethod__", False):
                    seen.add(name)
                    expected = mcls._typemap[type(value)]
                    if not isinstance(namespace[name], expected):
                        wrong_type.add(name)
        if wrong_type:
            cls.__abstractmethods__ = abstractmethods | frozenset(wrong_type)
        return cls

使用此元类,您可以获得预期的输出:

>>> class Abstract(object):
...     __metaclass__ = ABCMetaTypeCheck
...     @abstractmethod
...     def foo(self): pass
...     @abstractproperty
...     def bar(self): pass
...     @abstractstatic
...     def baz(): pass
... 
>>> class ConcreteWrong(Abstract):
...     foo = 'bar'
...     bar = 'baz'
...     baz = 'spam'
... 
>>> ConcreteWrong()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: Can't instantiate abstract class ConcreteWrong with abstract methods bar, baz, foo
>>> 
>>> class ConcreteCorrect(Abstract):
...     def foo(self): return 'bar'
...     @property
...     def bar(self): return 'baz'
...     @staticmethod
...     def baz(): return  'spam'
... 
>>> ConcreteCorrect()
<__main__.ConcreteCorrect object at 0x104ce1d10>