Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Python

property.setter — řízený zápis do vlastnosti

Pomocí `property.setter` zajistíte, aby běžné přiřazení do atributu instance zavolalo funkci, která může novou hodnotu před uložením ověřit.

Verze: Python 3.12

Syntaxe

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)

V Pythonu 3.12 vytvoří @property vlastnost s funkcí pro čtení (getterem). property.setter je metoda existujícího objektu property. Přijme funkci pro zápis a vrátí novou vlastnost s touto funkcí v fset. Getter i případná funkce pro mazání zůstanou zachovány. Původní objekt se nezmění.

Umístěte @priority.setter za getter a funkci pro zápis pojmenujte také priority. V těle třídy se výsledek dekorátoru přiřadí ke jménu funkce. Při jiném názvu nová vlastnost nenahradí původní vlastnost priority.

Čtení task.priority zavolá getter. Přiřazení task.priority = value zavolá setter s instancí jako self a novou hodnotou jako value. Bez setteru přiřazení vyvolá AttributeError. Setter nic automaticky neukládá a přiřazení ignoruje jeho návratovou hodnotu.

Hodnotu ověřte před uložením do samostatného atributu, například self._priority. Přiřazení do self.priority uvnitř jeho setteru by setter zavolalo znovu. Úvodní podtržítko je jen konvence: přímý zápis do _priority ověření obchází.

Příklady

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)

Výsledek

2
ValueError
4

Konstruktor i pozdější přiřazení používají stejný setter. Ten přijímá pouze hodnoty typu `int` od `1` do `5`. Přiřazení hodnoty `0` vyvolá `ValueError`; program výjimku zachytí a ukáže, že uložená hodnota je stále `4`.

Související lekce

  • Python · Lekce 2 · Pokročilá · Verze: 5

Zdroje