Как создать абстрактные свойства в абстрактных классах Python

118

В следующем коде я создаю базовый абстрактный класс Base. Я хочу, чтобы все классы, от которых наследуются, Baseпредоставляли nameсвойство, поэтому я сделал это свойство свойством @abstractmethod.

Затем я создал подкласс Base, называемый Base_1, который предназначен для обеспечения некоторой функциональности, но при этом остается абстрактным. В нем нет nameсвойства Base_1, но, тем не менее, python без ошибок инсталлирует объект этого класса. Как создать абстрактные свойства?

from abc import ABCMeta, abstractmethod
class Base(object):
    __metaclass__ = ABCMeta
    def __init__(self, strDirConfig):
        self.strDirConfig = strDirConfig

    @abstractmethod
    def _doStuff(self, signals):
        pass

    @property    
    @abstractmethod
    def name(self):
        #this property will be supplied by the inheriting classes
        #individually
        pass


class Base_1(Base):
    __metaclass__ = ABCMeta
    # this class does not provide the name property, should raise an error
    def __init__(self, strDirConfig):
        super(Base_1, self).__init__(strDirConfig)

    def _doStuff(self, signals):
        print 'Base_1 does stuff'


class C(Base_1):
    @property
    def name(self):
        return 'class C'


if __name__ == '__main__':
    b1 = Base_1('abc')  
Борис Горелик
источник
Понял: Если вы забыли использовать декоратор @propertyв class C, nameвозвращается к методу.
kevinarpe

Ответы:

118

Начиная с Python 3.3 была исправлена ​​ошибка, означающая, что property()декоратор теперь правильно идентифицируется как абстрактный при применении к абстрактному методу.

Примечание: порядок имеет значение, вы должны использовать @propertyперед@abstractmethod

Python 3.3+: ( документы Python ):

class C(ABC):
    @property
    @abstractmethod
    def my_abstract_property(self):
        ...

Python 2: ( документы Python )

class C(ABC):
    @abstractproperty
    def my_abstract_property(self):
        ...
Джеймс
источник
1
@James Как сделать его совместимым с Python 2 и также?
himanshu219
@James на самом деле я имел в виду и то, и другое, но неважно, что я опубликовал ответ, основанный на вашем решении
himanshu219
45

До Python 3.3 вы не можете вкладывать @abstractmethodи @property.

Используйте @abstractpropertyдля создания абстрактных свойств ( документов ).

from abc import ABCMeta, abstractmethod, abstractproperty

class Base(object):
    # ...
    @abstractproperty
    def name(self):
        pass

Теперь код вызывает правильное исключение:

Отслеживание (последний вызов последний):
  Файл "foo.py", строка 36, в 
    b1 = Base_1 ('abc')  
TypeError: не удается создать экземпляр абстрактного класса Base_1 с именем абстрактного метода
codeape
источник
42
на самом деле этот ответ неверен для более молодых питонов: начиная с 3.3, @abstractpropertyон устарел в пользу комбинации, такой как OP.
летучая овца
10
Из документов 3.3: docs.python.org/3/library/abc.html#abc.abstractproperty
codeape
так до 3.3, простоraise NotImplementedError
Славомир Ленарт
можем ли мы унаследовать от объекта и по-прежнему использовать аннотации ABC? Будет ли работать так, как показано в примере?
Сантос Кумар
3

На основе ответа Джеймса выше

def compatibleabstractproperty(func):

    if sys.version_info > (3, 3):             
        return property(abstractmethod(func))
    else:
        return abstractproperty(func)

и использовать как декоратор

@compatibleabstractproperty
def env(self):
    raise NotImplementedError()
himanshu219
источник