Mis apuntes · Aprende Python desde PHP

Se guardan solos en este navegador mientras escribes. Puedes usar Markdown. Al descargarlos, la primera línea es tu enlace personal al curso.

Lección 22 de 47 · De clases a clases ✦ WebMCP implementado

@dataclass frente al constructor promovido

10 min de lectura 4 retos

En la lección anterior escribiste __init__, __repr__ y __eq__ a mano para una clase que solo guarda datos. Es muchísimo código repetido. El decorador @dataclass los escribe por ti: es lo más parecido al constructor promovido y al readonly de PHP 8.5. Con él nace la Tarea definitiva de nuestra app.

¿De dónde vienen los nombres?

dataclass = inglés data class (clase de datos)
Una clase cuyo trabajo principal es guardar datos. El decorador le fabrica el __init__, el __repr__ y el __eq__.
field = inglés field (campo)
Función para dar opciones a un campo concreto: su valor por defecto, si entra en la comparación, etc.
default_factory = inglés default (por defecto) + factory (fábrica)
Una función que fabrica el valor por defecto cada vez que se crea un objeto. Así cada tarea recibe su propia lista.
frozen = inglés frozen (congelado)
Un objeto congelado no admite cambios después de crearse. Es el readonly de PHP.
slots = inglés slot (hueco, ranura)
Reserva un hueco fijo por cada campo, en vez de un diccionario por objeto: ocupa menos memoria y no deja inventar atributos.
En 4 ideas
1/4

@dataclass + campos con tipo (titulo: str) generan __init__, __repr__ y __eq__. Es el constructor promovido de PHP (public function __construct(public string $titulo)), pero sin escribir el constructor.

1 · De la clase a mano a @dataclass

Mira la Tarea de la lección anterior, para guardar solo tres datos. Y ahora la misma con @dataclass. Las dos hacen exactamente lo mismo:

Pythonmain.py
from dataclasses import dataclass


class TareaManual:
    def __init__(self, id, titulo, hecha=False):
        self.id = id
        self.titulo = titulo
        self.hecha = hecha

    def __repr__(self):
        return f"TareaManual(id={self.id!r}, titulo={self.titulo!r}, hecha={self.hecha!r})"

    def __eq__(self, otra):
        if not isinstance(otra, TareaManual):
            return NotImplemented
        return (self.id, self.titulo, self.hecha) == (otra.id, otra.titulo, otra.hecha)


@dataclass
class Tarea:
    id: int
    titulo: str
    hecha: bool = False


print(TareaManual(1, "Comprar pan"))
print(Tarea(1, "Comprar pan"))
print(Tarea(1, "Comprar pan") == Tarea(1, "Comprar pan"))
print(Tarea(1, "Comprar pan") == Tarea(1, "Comprar pan", True))
PHP 8.5Tarea.php
<?php
declare(strict_types=1);

final class Tarea
{
    public function __construct(
        public int $id,
        public string $titulo,
        public bool $hecha = false,
    ) {
    }
}

$tarea = new Tarea(1, "Comprar pan");
var_dump($tarea == new Tarea(1, "Comprar pan"));
var_dump($tarea == new Tarea(1, "Comprar pan", true));
Pythonmain.py
from dataclasses import dataclass


@dataclass
class Tarea:
    id: int
    titulo: str
    hecha: bool = False


tarea = Tarea(1, "Comprar pan")
print(tarea == Tarea(1, "Comprar pan"))
print(tarea == Tarea(1, "Comprar pan", True))
  1. Los campos son las líneas nombre: tipo del cuerpo de la clase. En un @dataclass el tipo no es opcional: es lo que le dice qué campos hay (y en qué orden).
  2. Los campos con valor (hecha: bool = False) van después de los que no lo tienen, igual que los parámetros con valor por defecto en una función.
  3. Python no comprueba el tipo al ejecutar: Tarea("uno", 2) funciona. Los tipos son para ti, el editor y herramientas como mypy.
  4. La clase sigue siendo una clase normal: puedes añadirle métodos (completar, __str__…) como siempre.

¿Por qué? · En PHP no existe

¿Por qué @dataclass y no un constructor promovido como en PHP?

Python no tiene propiedades declaradas en la clase: los atributos nacen al asignarlos, como viste. Para el caso, tan común, de «una clase solo para guardar datos» se creó este decorador, que genera código a partir de las anotaciones de tipo.

El resultado es el mismo ahorro que el constructor promovido de PHP 8, con una ventaja: también te regala __repr__ y __eq__ correctos. Antes tenías que escribirlos tú o aceptar el <Tarea object at 0x...> inútil.

2 · Valores por defecto y la trampa de la lista

Nuestra Tarea del dominio tiene una lista de etiquetas. Aquí está la trampa que ya conoces, pero con una diferencia: @dataclass te avisa, porque sabe lo peligroso que es:

Pythonmain.py
from dataclasses import dataclass

try:
    @dataclass
    class Tarea:
        id: int
        titulo: str
        etiquetas: list[str] = []
except ValueError as error:
    print("ValueError:", error)

La solución es field(default_factory=list): en vez de un valor, le das una función que fabrica uno nuevo para cada objeto.

Pythonmain.py
from dataclasses import dataclass, field


@dataclass
class Tarea:
    id: int
    titulo: str
    hecha: bool = False
    etiquetas: list[str] = field(default_factory=list)


a = Tarea(1, "Comprar pan")
b = Tarea(2, "Llamar al banco")
a.etiquetas.append("casa")
print(a.etiquetas, b.etiquetas)
print(a.etiquetas is b.etiquetas)
PHP 8.5Tarea.php
<?php
declare(strict_types=1);

final class Tarea
{
    /**
     * @param list<string> $etiquetas
     */
    public function __construct(
        public int $id,
        public string $titulo,
        public array $etiquetas = [],
    ) {
    }
}

$a = new Tarea(1, "Comprar pan");
$b = new Tarea(2, "Llamar al banco");
$a->etiquetas[] = "casa";
echo json_encode($a->etiquetas) . " " . json_encode($b->etiquetas) . PHP_EOL;
Pythonmain.py
from dataclasses import dataclass, field


@dataclass
class Tarea:
    id: int
    titulo: str
    etiquetas: list[str] = field(default_factory=list)


a = Tarea(1, "Comprar pan")
b = Tarea(2, "Llamar al banco")
a.etiquetas.append("casa")
print(a.etiquetas, b.etiquetas)

¿Por qué? · En PHP no existe

¿Por qué hace falta default_factory? En PHP basta con = []

En PHP, array $etiquetas = [] es seguro: los arrays se copian al asignar, así que cada tarea tiene el suyo. En Python una lista no se copia: es un objeto que se comparte, y el valor por defecto se evalúa una sola vez, al definir la clase (la misma trampa del [] por defecto de mutable frente a inmutable).

@dataclass rechaza list, dict y set como valor por defecto para que no cometas el error. Con default_factory=list Python llama a list() en cada objeto nuevo, y cada tarea recibe la suya.

3 · frozen=True: el readonly de PHP

Por defecto una dataclass se puede cambiar (tarea.hecha = True). Si quieres un objeto de solo lectura, como una clase readonly de PHP 8.5, pon frozen=True. Para «cambiar» una tarea congelada creas una copia con el campo nuevo, con replace:

Pythonmain.py
from dataclasses import dataclass, replace


@dataclass(frozen=True)
class Tarea:
    id: int
    titulo: str
    hecha: bool = False


tarea = Tarea(1, "Comprar pan")

try:
    tarea.hecha = True
except Exception as error:
    print(type(error).__name__ + ":", error)

hecha = replace(tarea, hecha=True)
print(tarea)
print(hecha)
print(tarea is hecha)

# Un objeto congelado se puede meter en un set o usar de clave de un dict.
print(len({tarea, hecha, Tarea(1, "Comprar pan")}))
PHP 8.5Tarea.php
<?php
declare(strict_types=1);

final readonly class Tarea
{
    public function __construct(
        public int $id,
        public string $titulo,
        public bool $hecha = false,
    ) {
    }

    public function completar(): self
    {
        return new self($this->id, $this->titulo, true);
    }
}

$tarea = new Tarea(1, "Comprar pan");
$hecha = $tarea->completar();
var_dump($tarea->hecha, $hecha->hecha);

try {
    $tarea->hecha = true;
} catch (Error $e) {
    echo get_class($e) . PHP_EOL;
}
Pythonmain.py
from dataclasses import dataclass, replace


@dataclass(frozen=True)
class Tarea:
    id: int
    titulo: str
    hecha: bool = False

    def completar(self):
        return replace(self, hecha=True)


tarea = Tarea(1, "Comprar pan")
hecha = tarea.completar()
print(tarea.hecha, hecha.hecha)

try:
    tarea.hecha = True
except Exception as error:
    print(type(error).__name__)

¿Por qué? · En PHP no existe

¿Por qué congelar un objeto? En PHP no era obligatorio

En el módulo anterior viste que los objetos de Python se comparten: si una función recibe una tarea y la cambia, todos los que la tienen ven el cambio. Un objeto congelado te quita ese susto: si te lo pasan, sabes que no cambiará por debajo.

Además, un frozen=True con eq=True (el valor por defecto) es hashable: puede ir dentro de un set o ser clave de un dict. Una dataclass normal con eq=True no lo es, por lo que viste con __eq__ sin __hash__.

4 · order=True, slots=True y __post_init__

Tres opciones más del decorador, y un método especial para validar:

  1. order=True: genera <, <=, > y >= comparando los campos en el orden en que están escritos, como compara PHP dos arrays (<=>). Con eso sorted(...) y max(...) funcionan solos.
  2. slots=True: guarda los datos en huecos fijos, no en un diccionario por objeto. Ocupa menos memoria y evita que inventes atributos (tarea.titullo = ... da error, justo la errata que PHP deja pasar).
  3. __post_init__: método que Python llama justo después del __init__ generado. Sirve para validar o normalizar los datos.
Pythonmain.py
from dataclasses import dataclass


@dataclass(order=True, slots=True)
class Tarea:
    prioridad: int
    titulo: str

    def __post_init__(self):
        self.titulo = self.titulo.strip()
        if not self.titulo:
            raise ValueError("El título no puede estar vacío")


tareas = [Tarea(2, "Llamar al banco"), Tarea(3, "  Comprar pan  "), Tarea(2, "Barrer")]
print(max(tareas))
print([t.titulo for t in sorted(tareas)])

try:
    Tarea(1, "   ")
except ValueError as error:
    print("ValueError:", error)

try:
    tareas[0].titullo = "oops"
except AttributeError:
    print("AttributeError: con slots no se inventan atributos")

5 · Equivalencia POO: PHP frente a Python

Equivalencia POO · PHP → Python

La clase de datos de PHP 8.5 y su equivalente en Python, opción a opción.

PHPPythonQuién lo ve
__construct(public int $id, public string $titulo) (constructor promovido)@dataclass con id: int y titulo: strQuien llama a Tarea(1, "x")
public bool $hecha = falsehecha: bool = FalseEl campo y su valor por defecto
public array $etiquetas = []etiquetas: list[str] = field(default_factory=list)Cada objeto recibe su lista; = [] da ValueError
final readonly class@dataclass(frozen=True)Asignar un campo lanza FrozenInstanceError
new self(...) con un campo cambiado (el «with»)dataclasses.replace(tarea, hecha=True)Crea una copia con el campo cambiado
== entre objetos (propiedades)__eq__ generado (compara todos los campos)tarea == otra
<=> entre arraysorder=Truesorted, max, min, <
__toString() o var_dump__repr__ generadoprint(tarea) muestra Tarea(id=1, ...)
validar dentro del constructor__post_init__Se ejecuta tras el __init__ generado

Hora de practicar

Retos · 0/4 resueltos

Reto 1 de 4

Tu primera dataclass

Convierte la clase Tarea en una @dataclass con los campos id: int, titulo: str y hecha: bool = False, sin escribir __init__ ni __repr__. print(Tarea(1, "Comprar pan")) debe mostrar Tarea(id=1, titulo='Comprar pan', hecha=False). Es el constructor promovido de PHP.

Al pulsar Comprobar, unos tests ocultos prueban tu código en tu navegador, con Python 3.14.

Pythonmain.py · editable

Resumen

Lo que te llevas de esta lección

  1. @dataclass genera __init__, __repr__ y __eq__ a partir de campo: tipo (en PHP, el constructor promovido).
  2. Listas, diccionarios y sets por defecto van con field(default_factory=list); = [] da ValueError (en PHP, = [] es seguro porque el array se copia).
  3. frozen=True hace el objeto de solo lectura y hashable (el readonly de PHP 8.5); replace() crea una copia con un campo cambiado.
  4. order=True compara campo a campo, en el orden escrito; el primero manda.
  5. slots=True ahorra memoria y caza las erratas en los nombres de atributos.
  6. __post_init__ valida o normaliza justo después del __init__ (en PHP, el cuerpo del constructor).

Para recordarlo: «Fábrica, Hielo y Orden»

FFábrica
field(default_factory=list) para lo mutable
HHielo
frozen=True: congelado, como readonly
OOrden
order=True: el primer campo manda

Si el campo es una lista, fábrica; si no debe cambiar, hielo; si hay que ordenar, orden.