Jak tworzyć abstrakcyjne właściwości w klasach abstrakcyjnych Pythona

118

W poniższym kodzie tworzę podstawową klasę abstrakcyjną Base. Chcę, aby wszystkie klasy, które dziedziczą, Basezapewniały namewłaściwość, więc utworzyłem tę właściwość jako @abstractmethod.

Potem stworzył podklasę Baseo nazwie Base_1, które mają za zadanie dostarczyć pewną funkcjonalność, ale nadal pozostają abstrakcyjne. W programie nie ma namewłasności Base_1, ale mimo to Python instatinuje obiekt tej klasy bez błędu. Jak tworzyć abstrakcyjne właściwości?

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
źródło
Gotcha: Jeśli zapomnisz użyć dekoratora @propertyw class C, namepowróci do metody.
kevinarpe

Odpowiedzi:

117

Od Pythona 3.3 naprawiono błąd, co oznacza, że property()dekorator jest teraz poprawnie identyfikowany jako abstrakcyjny po zastosowaniu do metody abstrakcyjnej.

Uwaga: zamówienie ma znaczenie, musisz użyć @propertywcześniej@abstractmethod

Python 3.3+: ( dokumentacja pythona ):

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

Python 2: ( dokumentacja pythona )

class C(ABC):
    @abstractproperty
    def my_abstract_property(self):
        ...
James
źródło
1
@James Jak sprawić, by był kompatybilny z Pythonem 2, a także?
himanshu219
@James właściwie miałem na myśli obu, ale nieważne, opublikowałem odpowiedź na podstawie twojego rozwiązania
himanshu219
45

Do wersji Python 3.3 nie można zagnieżdżać @abstractmethodi @property.

Służy @abstractpropertydo tworzenia właściwości abstrakcyjnych ( dokumentów ).

from abc import ABCMeta, abstractmethod, abstractproperty

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

Kod zgłasza teraz poprawny wyjątek:

Traceback (ostatnie ostatnie połączenie):
  Plik „foo.py”, wiersz 36, w formacie 
    b1 = Baza_1 ('abc')  
TypeError: Nie można utworzyć wystąpienia klasy abstrakcyjnej Base_1 z nazwą metody abstrakcyjnej
codeape
źródło
42
w rzeczywistości ta odpowiedź jest błędna w przypadku młodszych Pythonów: od wersji 3.3 @abstractpropertyjest przestarzała na rzecz kombinacji takich jak OP.
latające owce
a więc do 3.3, po prosturaise NotImplementedError
Sławomir Lenart
czy możemy dziedziczyć po obiekcie i nadal używać adnotacji ABC? Czy będzie działać tak, jak pokazano w przykładzie?
santhosh kumar
3

Na podstawie powyższej odpowiedzi Jamesa

def compatibleabstractproperty(func):

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

i użyj go jako dekoratora

@compatibleabstractproperty
def env(self):
    raise NotImplementedError()
himanshu219
źródło