WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

property.setter — kontrolliertes Schreiben einer Property

Mit `property.setter` ruft eine gewöhnliche Zuweisung an ein Instanzattribut eine Funktion auf, die den neuen Wert vor dem Speichern prüfen kann.

Version: Python 3.12

Syntax

class Task:
    @property
    def priority(self):
        return self._priority

    @priority.setter
    def priority(self, value):
        self._priority = value

# Functional form for an existing property p and a setter function set_priority:
# p = p.setter(set_priority)

In Python 3.12 erzeugt @property eine Property mit einem Getter. property.setter ist eine Methode eines vorhandenen property-Objekts. Sie nimmt eine Schreibfunktion entgegen und gibt eine neue Property mit dieser Funktion als fset zurück. Der Getter und ein eventuell vorhandener Deleter bleiben erhalten. Das ursprüngliche Objekt wird nicht verändert.

Setze @priority.setter nach den Getter und nenne auch die Setter-Funktion priority. Im Klassenrumpf wird das Ergebnis des Dekorators an den Namen der Funktion gebunden. Mit einem anderen Namen ersetzt die neue Property die ursprüngliche Property priority nicht.

Beim Lesen von task.priority wird der Getter aufgerufen. task.priority = value ruft den Setter mit der Instanz als self und dem neuen Wert als value auf. Ohne Setter löst die Zuweisung AttributeError aus. Der Setter speichert nichts automatisch; die Zuweisung ignoriert seinen Rückgabewert.

Prüfe den Wert, bevor du ihn in einem separaten Attribut wie self._priority speicherst. Eine Zuweisung an self.priority im eigenen Setter würde diesen erneut aufrufen. Der führende Unterstrich ist nur eine Konvention: Wer direkt in _priority schreibt, umgeht die Prüfung.

Beispiele

class Task:
    def __init__(self, priority):
        self.priority = priority

    @property
    def priority(self):
        return self._priority

    @priority.setter
    def priority(self, value):
        if type(value) is not int:
            raise TypeError("priority must be an int")
        if not 1 <= value <= 5:
            raise ValueError("priority must be between 1 and 5")
        self._priority = value


task = Task(2)
print(task.priority)
task.priority = 4
try:
    task.priority = 0
except ValueError:
    print("ValueError")
print(task.priority)

Ergebnis

2
ValueError
4

Der Konstruktor und spätere Zuweisungen nutzen denselben Setter. Er akzeptiert nur Werte vom Typ `int` von `1` bis `5`. Die Zuweisung von `0` löst `ValueError` aus; das Programm fängt die Ausnahme ab und zeigt, dass weiterhin `4` gespeichert ist.

Zugehörige Lektionen

  • Python · Lektion 2 · Fortgeschritten · Version: 5

Quellen