CKTIS / Python
property.setter — escritura controlada de una propiedad
Usa `property.setter` para que una asignación normal a un atributo de instancia llame a una función que pueda validar el valor antes de guardarlo.
Versión: Python 3.12
Sintaxis
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 crea una propiedad con un método de lectura (getter). property.setter es un método de un objeto property existente. Recibe una función de escritura y devuelve una propiedad nueva que la usa como fset, conservando el getter y el método de borrado, si existe. No modifica el objeto original.
Escribe @priority.setter después del getter y llama también priority a la función de escritura. En el cuerpo de la clase, el resultado del decorador se vincula al nombre de la función. Con otro nombre, la propiedad nueva no sustituye a la propiedad priority original.
Leer task.priority llama al getter. La asignación task.priority = value llama al setter con la instancia como self y el nuevo valor como value. Sin setter, la asignación lanza AttributeError. El setter no guarda nada automáticamente y la asignación ignora su valor de retorno.
Valida el valor antes de guardarlo en un atributo distinto, como self._priority. Asignar a self.priority dentro de su propio setter volvería a llamarlo. El guion bajo inicial es solo una convención: escribir directamente en _priority elude la validación.
Ejemplos
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
El constructor y las asignaciones posteriores usan el mismo setter. Solo admite valores de tipo `int` del `1` al `5`. Asignar `0` lanza `ValueError`; el programa captura la excepción y muestra que el valor guardado sigue siendo `4`.
Lecciones relacionadas
- Python · Lección 2 · Avanzado · Versión: 5