Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Python

Typová unie X | None a anotace s dopřednými odkazy

Pomocí `X | None` povolíš hodnotu typu `X` nebo `None`. Pokud je třída definovaná až později, zapiš celou anotaci do uvozovek nebo použij import z `__future__`.

Verze: Python 3.12

Syntaxe

# 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: ...

V Pythonu 3.12 označuje X | None hodnotu typu X nebo None. Tento zápis je dostupný od Pythonu 3.10 a odpovídá typing.Optional[X] a typing.Union[X, None], nikoli volání typing.Union(...). Operátor | zde obvykle vytváří typovou unii, neprovádí bitové OR nad celými čísly; metatřída s vlastní metodou __or__ může výsledek změnit. Anotace za běhu nevynucuje typ ani neumožňuje vynechat argument bez výchozí hodnoty.

Bez importu z __future__ vyhodnocuje Python 3.12 běžné anotace funkce při její definici. Pokud User ještě není definováno, User | None vyvolá NameError. Zapiš celou unii do uvozovek: "User|None". Při okamžitém vyhodnocení zápis "User" | None vyvolá TypeError. Podobně "Ticket" a "Board" v signatuře odkazují na později definované třídy, ne na hodnoty typu str.

Místo toho můžeš na začátek modulu přidat from __future__ import annotations a v anotacích psát User | None, Ticket a Board bez uvozovek. Python 3.12 pak anotace ukládá jako řetězce. Import neodloží vyhodnocení běžného přiřazení, například Alias = User | None.

Jakmile jsou třídy definované, může typing.get_type_hints() vyřešit odkazy uložené v __annotations__. V tu chvíli musí být jména dostupná ve správném jmenném prostoru; podle potřeby předej globalns nebo localns. Chybějící jméno může způsobit NameError. Vyhodnocení anotací může spustit libovolný kód, proto nevyhodnocuj anotace z nedůvěryhodných zdrojů.

Příklady

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)

Výsledek

User|None
True
True True
True

První řádek vypíše původní řetězec `User|None`. Druhý potvrdí vyhodnocení unie a třetí potvrzuje, že oba odkazy ukazují na správné třídy. Čtvrtý ukazuje, že kód vytvoří `Ticket` s hodnotou `None` jako vlastníkem.

Související lekce

  • Python · Lekce 1 · Pokročilá · Verze: 5

Zdroje