21.3    Setter und Getter und Property Attributes 

Manchmal ist es wünschenswert, den Zugriff auf die Attribute einer Klasse nach bestimmten Regeln zu beeinflussen. So gibt es Attribute, für die nur bestimmte Werte Sinn ergeben. In unserer Klasse Konto (siehe Abschnitt 21.1.2) gibt es zum Beispiel das Attribut Tagesumsatz, dessen Werte sinnvollerweise immer positiv sein sollten.

 

21.3.1    Setter und Getter 

Ein Konzept der objektorientierten Programmierung, um den Zugriff auf Attribute zu steuern, stellen die Setter-Methoden und Getter-Methoden dar. Anstatt direkt auf das Attribut zuzugreifen, wird der Zugriff dabei über spezielle Methoden geregelt.

Um das folgende Beispiel übersichtlich zu halten, werden wir eine neue Klasse A einführen, die ein über Setter- und Getter-Methoden verwaltetes Attribut besitzt. Die Übertragung auf das Kontobeispiel ist dann eine einfache Übungsaufgabe.

class A:
    def __init__(self):
        self._X = 100       
    def getX(self):
        return self._X    
    def setX(self, wert):
        if wert < 0:
            return
        self._X = wert

Mithilfe der Getter-Methode getX und der Setter-Methode setX kann nun mit dem Attribut _X von A gearbeitet werden, wobei negative Belegungen von _X durch setX verhindert werden:

a = A()
print(a.getX())
a.setX(300)
print(a.getX())
a.setX(-20)
print(a.getX())

Die Ausgabe dieses Beispiels zeigt, dass der Versuch, _X auf den Wert -20 zu setzen, fehlschlägt.

100
300
300

 

21.3.2    Property-Attribute 

Die explizite Verwaltung von Attributen mittels Setter- und Getter-Methoden ist unschön, da man nun bei der Benutzung einer Klasse zwischen Attributen unterscheiden muss, die man direkt verwenden darf, und solchen, deren Zugriffe durch Setter- und Getter-Methoden gesteuert werden müssen.

Die sogenannten Property-Attribute lösen dieses Problem, indem Setter- und Getter-Methoden beim Schreiben bzw. Lesen eines Attributs implizit aufgerufen werden.

Wir können damit unsere Klasse so anpassen, dass sie sich folgendermaßen verwenden lässt und wir trotzdem für gültige Belegungen von X sorgen können:

a = A()
a.X = 300
print(a.X)
a.X = -20
print(a.X)

Um dies zu erreichen, müssen wir X mithilfe der Built-in Function property als Property-Attribut anlegen.

property([fget, fset, fdel, doc])

Für den Parameter fget wird eine Referenz auf eine Getter-Methode für das neue Attribut erwartet. Der Parameter fset gibt die dazugehörige Setter-Methode an. Mit dem Parameter fdel kann zusätzlich eine Methode angegeben werden, die dann ausgeführt werden soll, wenn das Attribut per del gelöscht wird. Über den Parameter doc kann das Attribut mit einem sogenannten Docstring versehen werden. Was ein Docstring ist, können Sie in Abschnitt 36.1, »Docstrings«, nachlesen.

Wir erweitern die Klasse A nun um ein Property-Attribut X, das die Methoden getX und setX für den Zugriff verwendet. Intern wird der Wert von X weiterhin in dem Attribut _X gespeichert. Außerdem fügen wir den Methoden getX und setX Ausgaben hinzu, um zu sehen, dass sie tatsächlich implizit aufgerufen werden.

class A:
    def __init__(self):
        self._X = 100        
    def getX(self):
        print("Getter gerufen")
        return self._X    
    def setX(self, wert):
        print("Setter gerufen")
        if wert < 0:
            return 
        self._X = wert
    X = property(getX, setX)
a = A()
a.X = 300
print(a.X)
a.X = -20
print(a.X)

Wie Sie der Ausgabe entnehmen, wurden die Setter- und die Getter-Methode implizit beim Zugriff auf das Attribut gerufen. Außerdem wurde die ungültige Zuweisung des Wertes -20 verhindert.

Setter gerufen
Getter gerufen
300
Setter gerufen
Getter gerufen
300

Sie sollten bei der Verwendung von Setter- und Getter-Methoden im Hinterkopf behalten, dass dadurch bei jedem Attributzugriff eine Methode gerufen wird, was das Programm bei sehr vielen Zugriffen ausbremsen kann.