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

CKTIS / Python

Unión de tipos X | None y anotaciones con referencias adelantadas

Usa `X | None` para admitir un valor de tipo `X` o `None`. Si una clase se define más adelante, entrecomilla toda la anotación o usa la importación de `__future__`.

Versión: Python 3.12

Sintaxis

# Without the future import
class X: ...

value: X | None
value: "X | None"
def make_board(ticket: "Ticket") -> "Board": ...

# Alternative in Python 3.12: copy the next three lines without
# their comment prefixes into a separate module, with the import first.
# from __future__ import annotations
# value: X | None
# def make_board(ticket: Ticket) -> Board: ...

En Python 3.12, X | None admite un valor de tipo X o None. Esta sintaxis, disponible desde Python 3.10, equivale a typing.Optional[X] y a typing.Union[X, None], no a una llamada a typing.Union(...). Aquí | normalmente construye una unión de tipos, no un OR bit a bit entre enteros; una metaclase con su propio método __or__ puede cambiar el resultado. La anotación no impone el tipo en tiempo de ejecución ni permite omitir un argumento sin valor predeterminado.

Sin la importación de __future__, Python 3.12 evalúa las anotaciones ordinarias de una función al definirla. Si User aún no está definido, User | None provoca NameError. Entrecomilla toda la unión: "User|None". Si se evalúa de inmediato, "User" | None provoca TypeError. Del mismo modo, "Ticket" y "Board" en una firma se refieren a clases definidas más adelante, no a valores de tipo str.

Como alternativa, coloca from __future__ import annotations al principio del módulo y escribe User | None, Ticket y Board sin comillas en las anotaciones. Python 3.12 almacena entonces las anotaciones como cadenas. Esta importación no aplaza la evaluación de una asignación ordinaria como Alias = User | None.

Una vez definidas las clases, typing.get_type_hints() puede resolver las referencias almacenadas en __annotations__. En ese momento, los nombres deben estar disponibles en el espacio de nombres adecuado; proporciona globalns o localns si hace falta. Un nombre ausente puede provocar NameError. Evaluar anotaciones puede ejecutar código arbitrario, así que no resuelvas anotaciones de fuentes no fiables.

Ejemplos

from typing import get_type_hints


def make_board(ticket: "Ticket") -> "Board":
    return Board(ticket)


class Ticket:
    def __init__(self, owner: "User|None") -> None:
        self.owner = owner


class Board:
    def __init__(self, ticket: Ticket) -> None:
        self.ticket = ticket


class User:
    pass


print(Ticket.__init__.__annotations__["owner"])
print(get_type_hints(Ticket.__init__)["owner"] == (User | None))
board_hints = get_type_hints(make_board)
print(board_hints["ticket"] is Ticket, board_hints["return"] is Board)
print(make_board(Ticket(None)).ticket.owner is None)

Resultado

User|None
True
True True
True

La primera línea muestra la cadena original `User|None`. La segunda confirma que se resuelve la unión; la tercera, que se resuelven las dos referencias a clases. La cuarta muestra que el código crea un `Ticket` cuyo propietario es `None`.

Lecciones relacionadas

  • Python · Lección 1 · Avanzado · Versión: 5

Fuentes