Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

property.setter — contrôler l’écriture d’une propriété

Avec `property.setter`, une affectation ordinaire à un attribut d’instance appelle une fonction qui peut valider la nouvelle valeur avant de la stocker.

Version : 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)

En Python 3.12, @property crée une propriété dotée d’un accesseur en lecture (getter). property.setter est une méthode d’un objet property existant. Elle reçoit une fonction d’écriture et renvoie une nouvelle propriété où cette fonction devient fset, sans changer le getter ni l’éventuel accesseur de suppression. L’objet d’origine n’est pas modifié.

Placez @priority.setter après le getter et nommez aussi la fonction d’écriture priority. Dans le corps de la classe, le résultat du décorateur est lié au nom de la fonction. Avec un autre nom, la nouvelle propriété ne remplace pas la propriété priority d’origine.

Lire task.priority appelle le getter. L’affectation task.priority = value appelle le setter avec l’instance comme self et la nouvelle valeur comme value. Sans setter, l’affectation lève AttributeError. Le setter ne stocke rien automatiquement et l’affectation ignore sa valeur de retour.

Validez la valeur avant de la stocker dans un attribut distinct, par exemple self._priority. Une affectation à self.priority dans son propre setter rappellerait celui-ci. Le trait de soulignement initial est une simple convention : écrire directement dans _priority contourne la validation.

Exemples

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)

Résultat

2
ValueError
4

Le constructeur et les affectations ultérieures utilisent le même setter. Il n’accepte que des valeurs de type `int` de `1` à `5`. Affecter `0` lève `ValueError` ; le programme intercepte l’exception et montre que la valeur stockée reste `4`.

Leçons associées

  • Python · Leçon 2 · Avancé · Version : 5

Sources