CKTIS / Python
Type-unie X | None en annotaties met voorwaartse verwijzingen
Gebruik `X | None` om een waarde van type `X` of `None` toe te staan. Definieer je een klasse pas later, zet dan de hele annotatie tussen aanhalingstekens of gebruik de `__future__`-import.
Versie: 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: ...In Python 3.12 betekent X | None dat een waarde van type X of None is toegestaan. Deze syntaxis bestaat sinds Python 3.10 en komt overeen met typing.Optional[X] en typing.Union[X, None], niet met een aanroep van typing.Union(...). Hier vormt | normaal gesproken een type-unie en voert het geen bitsgewijze OF op gehele getallen uit; een metaklasse met een eigen __or__-methode kan het resultaat veranderen. De annotatie dwingt het type tijdens uitvoering niet af en laat je geen argument zonder standaardwaarde weglaten.
Zonder de __future__-import evalueert Python 3.12 gewone functieannotaties zodra de functie wordt gedefinieerd. Als User nog niet is gedefinieerd, geeft User | None een NameError. Zet de hele unie tussen aanhalingstekens: "User|None". Bij onmiddellijke evaluatie geeft "User" | None een TypeError. Ook "Ticket" en "Board" in een signatuur verwijzen naar later gedefinieerde klassen, niet naar waarden van type str.
Je kunt ook from __future__ import annotations bovenaan de module zetten en User | None, Ticket en Board zonder aanhalingstekens in annotaties gebruiken. Python 3.12 slaat de annotaties dan op als tekenreeksen. Deze import stelt een gewone toewijzing zoals Alias = User | None niet uit.
Zodra de klassen zijn gedefinieerd, kan typing.get_type_hints() de verwijzingen in __annotations__ oplossen. De namen moeten dan beschikbaar zijn in de juiste naamruimte; geef zo nodig globalns of localns op. Een ontbrekende naam kan een NameError veroorzaken. Bij evaluatie van annotaties kan willekeurige code worden uitgevoerd. Los daarom geen annotaties uit onbetrouwbare bronnen op.
Voorbeelden
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)
Resultaat
User|None True True True True
De eerste regel toont de oorspronkelijke tekenreeks `User|None`. De tweede bevestigt dat de unie is opgelost en de derde dat beide klasseverwijzingen zijn opgelost. De vierde laat zien dat de code een `Ticket` met `None` als eigenaar maakt.
Gerelateerde lessen
- Python · Les 1 · Gevorderd · Versie: 5