Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

property.setter — escrita controlada numa propriedade

Usa `property.setter` para que uma atribuição normal a um atributo de instância chame uma função que possa validar o novo valor antes de o guardar.

Versão: Python 3.12

Sintaxe

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)

Em Python 3.12, @property cria uma propriedade com uma função de leitura (getter). property.setter é um método de um objeto property existente. Recebe uma função de escrita e devolve uma nova propriedade com essa função como fset, mantendo o getter e a eventual função de eliminação. Não modifica o objeto original.

Coloca @priority.setter a seguir ao getter e dá também o nome priority à função de escrita. No corpo da classe, o resultado do decorador fica associado ao nome da função. Com outro nome, a nova propriedade não substitui a propriedade priority original.

Ler task.priority chama o getter. A atribuição task.priority = value chama o setter com a instância como self e o novo valor como value. Sem setter, a atribuição lança AttributeError. O setter não guarda nada automaticamente e a atribuição ignora o valor que este devolve.

Valida o valor antes de o guardares num atributo distinto, como self._priority. Atribuir um valor a self.priority dentro do seu próprio setter voltaria a chamar o setter. O sublinhado inicial é só uma convenção: escrever diretamente em _priority contorna a validação.

Exemplos

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)

Resultado

2
ValueError
4

O construtor e as atribuições posteriores usam o mesmo setter. Este só aceita valores do tipo `int` entre `1` e `5`, inclusive. Atribuir `0` lança `ValueError`; o programa interceta a exceção e mostra que o valor guardado continua a ser `4`.

Lições relacionadas

  • Python · Lição 2 · Avançado · Versão: 5

Fontes