Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / Python

Typová únia X | None a anotácie s doprednými odkazmi

Pomocou `X | None` povolíš hodnotu typu `X` alebo `None`. Ak je trieda definovaná až neskôr, daj celú anotáciu do úvodzoviek alebo použi import z `__future__`.

Verzia: Python 3.12

Syntax

# 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 Pythone 3.12 zápis X | None povoľuje hodnotu typu X alebo None. Táto syntax je dostupná od Pythonu 3.10 a zodpovedá typing.Optional[X] a typing.Union[X, None], nie volaniu typing.Union(...). Operátor | tu zvyčajne vytvára typovú úniu, nevykonáva bitové OR nad celými číslami; metatrieda s vlastnou metódou __or__ môže výsledok zmeniť. Anotácia za behu nevynucuje typ ani nedovoľuje vynechať argument bez predvolenej hodnoty.

Bez importu z __future__ vyhodnocuje Python 3.12 bežné anotácie funkcie pri jej definovaní. Ak trieda User ešte nie je definovaná, User | None vyvolá NameError. Daj celú úniu do úvodzoviek: "User|None". Pri okamžitom vyhodnotení zápis "User" | None vyvolá TypeError. Podobne "Ticket" a "Board" v signatúre odkazujú na triedy definované neskôr, nie na hodnoty typu str.

Namiesto toho môžeš na začiatok modulu vložiť from __future__ import annotations a v anotáciách písať User | None, Ticket a Board bez úvodzoviek. Python 3.12 potom ukladá anotácie ako reťazce. Import neodkladá vyhodnotenie bežného priradenia, ako je Alias = User | None.

Keď sú triedy definované, typing.get_type_hints() môže vyhodnotiť odkazy uložené v __annotations__. Mená musia byť vtedy dostupné v správnom mennom priestore; podľa potreby odovzdaj globalns alebo localns. Chýbajúce meno môže spôsobiť NameError. Vyhodnocovanie anotácií môže spustiť ľubovoľný kód, preto nevyhodnocuj anotácie z nedôveryhodných zdrojov.

Prí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ýsledok

User|None
True
True True
True

Prvý riadok zobrazí pôvodný reťazec `User|None`. Druhý potvrdí vyhodnotenie únie a tretí potvrdí, že oba odkazy smerujú na správne triedy. Štvrtý ukazuje, že kód vytvorí `Ticket` s hodnotou `None` ako vlastníkom.

Súvisiace lekcie

  • Python · Lekcia 1 · Pokročilá · Verzia: 5

Zdroje