Como criar propriedades abstratas em classes abstratas python

118

No código a seguir, crio uma classe abstrata base Base. Quero que todas as classes que herdam de Baseforneçam a namepropriedade, portanto, tornei essa propriedade um @abstractmethod.

Em seguida, criei uma subclasse de Base, chamada Base_1, que deve fornecer algumas funcionalidades, mas ainda permanece abstrata. Não há nenhuma namepropriedade em Base_1, mas, apesar disso, python instatinates um objeto dessa classe sem um erro. Como criar propriedades abstratas?

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')  
Boris Gorelik
fonte
Pegadinha: se você esquecer de usar o decorador @propertyno class C, nameirá reverter para um método
kevinarpe

Respostas:

117

Desde o Python 3.3, um bug foi corrigido, o que significa que o property()decorador agora está corretamente identificado como abstrato quando aplicado a um método abstrato.

Nota: O pedido é importante, você deve usar @propertyantes@abstractmethod

Python 3.3+: ( documentos python ):

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

Python 2: ( documentos python )

class C(ABC):
    @abstractproperty
    def my_abstract_property(self):
        ...
James
fonte
1
@James Como torná-lo compatível para python 2 e também?
himanshu219
@James na verdade eu quis dizer para os dois, mas deixa pra lá, eu postei uma resposta baseada na sua solução
himanshu219
45

Até o Python 3.3 , você não pode aninhar @abstractmethode @property.

Use @abstractpropertypara criar propriedades abstratas ( documentos ).

from abc import ABCMeta, abstractmethod, abstractproperty

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

O código agora levanta a exceção correta:

Traceback (última chamada mais recente):
  Arquivo "foo.py", linha 36, ​​em 
    b1 = Base_1 ('abc')  
TypeError: Não é possível instanciar a classe abstrata Base_1 com o nome de métodos abstratos
codeape
fonte
42
na verdade, essa resposta está errada para pítons mais jovens: desde 3.3, @abstractpropertyestá obsoleto em favor de uma combinação como os OPs.
ovelhas voadoras
então, até 3,3, apenasraise NotImplementedError
Sławomir Lenart
podemos herdar do objeto e ainda usar as anotações ABC? Funcionará conforme mostrado no exemplo?
santhosh kumar
3

Com base na resposta de James acima

def compatibleabstractproperty(func):

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

e usá-lo como um decorador

@compatibleabstractproperty
def env(self):
    raise NotImplementedError()
himanshu219
fonte