Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

Unia typów X | None i odwołania wprzód w adnotacjach

Użyj `X | None`, aby dopuścić wartość typu `X` lub `None`. Jeśli klasa jest zdefiniowana niżej, zapisz całą adnotację jako napis albo użyj importu z `__future__`.

Wersja: Python 3.12

Składnia

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

W Pythonie 3.12 adnotacja X | None dopuszcza wartość typu X albo None. Ten zapis jest dostępny od Pythona 3.10 i odpowiada typing.Optional[X] oraz typing.Union[X, None], a nie wywołaniu typing.Union(...). | normalnie tworzy tu unię typów, nie wykonuje bitowej alternatywy na liczbach; metaklasa z własną metodą __or__ może zmienić wynik. Adnotacja nie wymusza typu podczas wykonywania programu ani nie pozwala pominąć argumentu bez wartości domyślnej.

Bez importu z __future__ Python 3.12 oblicza zwykłe adnotacje funkcji podczas jej definiowania. Niezdefiniowana jeszcze nazwa w User | None powoduje NameError. Zapisz całą unię jako napis: "User|None". Zapis "User" | None bez odroczenia spowoduje TypeError. Analogicznie "Ticket" i "Board" w sygnaturze oznaczają odwołania do klas zdefiniowanych niżej, a nie typ str.

Alternatywnie umieść from __future__ import annotations na początku modułu i użyj w adnotacjach User | None, Ticket oraz Board bez cudzysłowów. W Pythonie 3.12 adnotacje są wtedy przechowywane jako napisy. Import nie odracza obliczania zwykłego przypisania, takiego jak Alias = User | None.

Gdy klasy są już zdefiniowane, typing.get_type_hints() może rozwiązać odwołania zapisane w __annotations__. Nazwy muszą być wtedy dostępne w odpowiedniej przestrzeni nazw; w razie potrzeby przekaż globalns lub localns. Brak nazwy może spowodować NameError. Obliczanie adnotacji może uruchomić dowolny kod, więc nie rozwiązuj adnotacji z niezaufanych źródeł.

Przykłady

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)

Wynik

User|None
True
True True
True

Pierwszy wiersz pokazuje surowy napis `User|None`. Drugi potwierdza rozwiązanie unii, trzeci — obu odwołań do klas, a czwarty pokazuje, że kod tworzy `Ticket` z wartością `None` jako właścicielem.

Powiązane lekcje

  • Python · Lekcja 1 · Zaawansowany · Wersja: 5

Źródła