Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / Python

Referencias adelantadas en anotaciones de tipo

En Python 3.12, pon entre comillas el nombre de un tipo que aún no está disponible al definir un método. Resuelve la referencia más tarde si necesitas el objeto de clase.

Versión: Python 3.12

Sintaxis

# Quote a name that is not bound yet:
def f(value: "Later") -> "Later": ...

# For a union, quote the entire expression:
def g(value: "int | Later") -> None: ...

# Alternatively, as a separate module using postponed evaluation:
from __future__ import annotations

def f(value: Later) -> Later: ...

Una referencia adelantada en una anotación de tipo apunta a un tipo cuyo nombre aún no está disponible donde se define la función. En Python 3.12, sin evaluación diferida, las anotaciones de función se evalúan al ejecutar def, no al llamar a la función. Si el nombre del tipo no está disponible en ese momento, usarlo sin comillas provoca NameError. Las anotaciones ayudan a los verificadores estáticos; Python no las usa para comprobar argumentos ni valores de retorno.

En WorkItem.from_dict, -> "WorkItem" se refiere a la clase cuyo cuerpo todavía se está ejecutando. En Project.add_module, module: "Module" apunta a una clase definida más abajo. En ambos casos, el literal de cadena registra la referencia sin buscar el nombre de inmediato. Para una unión, pon entre comillas la expresión entera: "int | Module". Sin evaluación diferida, int | "Module" provoca TypeError porque | recibe un tipo y una cadena.

Otra opción es poner from __future__ import annotations al principio del módulo, después de la cadena de documentación si la hay. En Python 3.12, esta importación almacena las anotaciones de función como cadenas, así que puedes escribir -> WorkItem y module: Module sin comillas. No difiere la evaluación de expresiones ordinarias ajenas a las anotaciones, como los valores predeterminados de los parámetros.

En el ejemplo, __annotations__ contiene cadenas. Una vez definidas ambas clases, typing.get_type_hints() busca los nombres en los espacios de nombres correspondientes y resuelve las referencias a los objetos de clase. Si falta un nombre, por ejemplo porque solo se importó dentro de if TYPE_CHECKING:, aún puede producirse NameError. No resuelvas anotaciones que no sean de confianza: evaluar sus expresiones puede ejecutar código.

Ejemplos

from typing import get_type_hints


class WorkItem:
    def __init__(self, title: str) -> None:
        self.title = title

    @classmethod
    def from_dict(cls, data: dict[str, str]) -> "WorkItem":
        return cls(data["title"])


class Project:
    def __init__(self) -> None:
        self.modules = []

    def add_module(self, module: "Module") -> None:
        self.modules.append(module)


class Module:
    pass


print(repr(WorkItem.from_dict.__annotations__["return"]))
print(repr(Project.add_module.__annotations__["module"]))
print(get_type_hints(WorkItem.from_dict)["return"] is WorkItem)
print(get_type_hints(Project.add_module)["module"] is Module)

Resultado

'WorkItem'
'Module'
True
True

Las dos primeras líneas muestran las representaciones de las cadenas de `__annotations__`. Los dos resultados `True` confirman que las anotaciones resueltas son exactamente los objetos de clase `WorkItem` y `Module`.

Lecciones relacionadas

  • Python · Lección 3 · Avanzado · Versión: 5
  • Python · Lección 7 · Avanzado · Versión: 5

Fuentes