So erstellen Sie abstrakte Eigenschaften in abstrakten Python-Klassen

117

Im folgenden Code erstelle ich eine abstrakte Basisklasse Base. Ich möchte, dass alle Klassen, die von erben Base, die nameEigenschaft bereitstellen , also habe ich diese Eigenschaft zu einer gemacht @abstractmethod.

Dann habe ich eine Unterklasse von Basenamens erstellt Base_1, die einige Funktionen bereitstellen soll, aber dennoch abstrakt bleibt. Es gibt keine nameEigenschaft in Base_1, aber Python installiert dennoch ein Objekt dieser Klasse ohne Fehler. Wie schafft man abstrakte Eigenschaften?

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
quelle
Gotcha: Wenn Sie vergessen, Dekorator @propertyin zu verwenden class C, namewird auf eine Methode zurückgegriffen.
Kevinarpe

Antworten:

117

Seit Python 3.3 wurde ein Fehler behoben, der bedeutet, dass der property()Dekorator jetzt korrekt als abstrakt identifiziert wird, wenn er auf eine abstrakte Methode angewendet wird.

Hinweis: Reihenfolge ist wichtig, müssen Sie verwenden @propertyvor@abstractmethod

Python 3.3+: ( Python-Dokumente ):

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

Python 2: ( Python-Dokumente )

class C(ABC):
    @abstractproperty
    def my_abstract_property(self):
        ...
James
quelle
1
@James Wie macht man es kompatibel für Python 2 und auch?
himanshu219
@ James eigentlich meinte ich für beide, aber egal, ich habe eine Antwort basierend auf Ihrer Lösung gepostet
himanshu219
45

Bis Python 3.3 , können Sie nicht nisten @abstractmethodund @property.

Verwenden Sie @abstractpropertydiese Option , um abstrakte Eigenschaften ( Dokumente ) zu erstellen .

from abc import ABCMeta, abstractmethod, abstractproperty

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

Der Code löst jetzt die richtige Ausnahme aus:

Traceback (letzter Anruf zuletzt):
  Datei "foo.py", Zeile 36, in 
    b1 = Base_1 ('abc')  
TypeError: Die abstrakte Klasse Base_1 kann nicht mit dem Namen der abstrakten Methode instanziiert werden
Codeape
quelle
42
Tatsächlich ist diese Antwort für jüngere Pythons falsch: Seit 3.3 @abstractpropertywird sie zugunsten einer Kombination wie der von OP veraltet.
fliegende Schafe
10
Aus den 3.3-Dokumenten: docs.python.org/3/library/abc.html#abc.abstractproperty
Codeape
also bis 3.3, nurraise NotImplementedError
Sławomir Lenart
Können wir vom Objekt erben und trotzdem die ABC-Annotationen verwenden? Funktioniert es wie im Beispiel gezeigt?
Santhosh Kumar
3

Basierend auf James Antwort oben

def compatibleabstractproperty(func):

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

und benutze es als Dekorateur

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