CKTIS / Python
Typeannotatie met een voorwaartse verwijzing
In Python 3.12 kan een typeannotatie tussen aanhalingstekens verwijzen naar een naam die pas na de functiedefinitie beschikbaar is.
Versie: Python 3.12
Syntax
def run_test(test: "Callable[[], None]") -> None:
test()In Python 3.12 worden functieannotaties zonder from __future__ import annotations geëvalueerd wanneer de def-instructie wordt uitgevoerd, niet wanneer de functie wordt aangeroepen. Een naam zonder aanhalingstekens die nog niet beschikbaar is, kan dan NameError veroorzaken. Bij een typeannotatie met een voorwaartse verwijzing kun je de type-expressie als string schrijven, bijvoorbeeld "Callable[[], None]", zodat deze later kan worden opgelost.
In de signatuur van run_test beschrijft Callable[[], None] een aanroepbaar object dat geen argumenten ([]) accepteert en None teruggeeft. Het afzonderlijke -> None geeft aan wat run_test zelf teruggeeft. De aanhalingstekens betekenen niet dat je een string moet meegeven, en Python controleert niet automatisch of het argument aan de annotatie voldoet.
run_test.__annotations__["test"] bevat de string. typing.get_type_hints(run_test) evalueert de expressie in de juiste naamruimte en kan NameError veroorzaken als Callable nog ontbreekt. Als Callable al beschikbaar is wanneer def wordt uitgevoerd, zijn de aanhalingstekens niet nodig. Los geen annotaties uit onbetrouwbare bronnen op: bij het evalueren van de expressies daarin kan code worden uitgevoerd.
Voorbeelden
from typing import get_type_hints
def run_test(test: "Callable[[], None]") -> None:
test()
from collections.abc import Callable # Deliberately imported after run_test.
def smoke_test() -> None:
print("Test ran", end="")
print(repr(run_test.__annotations__["test"]))
print(get_type_hints(run_test)["test"] == Callable[[], None])
run_test(smoke_test)Resultaat
'Callable[[], None]' True Test ran
De import uit `collections.abc` staat bewust na de definitie van `run_test`. De eerste regel toont de representatie van de string, `True` bevestigt dat het opgeloste type overeenkomt met het verwachte type en `Test ran` komt van de aangeroepen testfunctie.
Gerelateerde lessen
- Python · Les 26 · Basis · Versie: 3