База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / Python

Предварителни препратки в анотациите за типове

В Python 3.12 постави името на типа в кавички, ако още не е достъпно при дефинирането на метода. Разреши препратката по-късно, ако ти трябва обектът на класа.

Версия: Python 3.12

Синтаксис

# Quote a name that is not bound yet:
def f(value: "Later") -> "Later": ...

# For a union, quote the entire expression:
def g(value: "int | Later") -> None: ...

# Alternatively, as a separate module using postponed evaluation:
from __future__ import annotations

def f(value: Later) -> Later: ...

Предварителната препратка в анотация за тип сочи към тип, чието име още не е достъпно на мястото, където се дефинира функцията. В Python 3.12 без отложено оценяване анотациите на функцията се оценяват при изпълнението на def, а не при извикването ѝ. Ако името на типа тогава не е достъпно, използването му без кавички предизвиква NameError. Анотациите помагат на инструментите за статична проверка на типове; самият Python не проверява чрез тях аргументите или върнатите стойности.

В WorkItem.from_dict анотацията -> "WorkItem" сочи към класа, чието тяло още се изпълнява. В Project.add_module анотацията module: "Module" сочи към клас, дефиниран по-надолу. И в двата случая низовият литерал записва препратката, без веднага да се търси името. При обединение на типове постави целия израз в кавички: "int | Module". Без отложено оценяване int | "Module" предизвиква TypeError, защото операторът | получава тип и низ.

Друг вариант е да поставиш from __future__ import annotations в началото на модула, след документационния низ, ако има такъв. В Python 3.12 този импорт съхранява анотациите на функциите като низове, така че можеш да напишеш -> WorkItem и module: Module без кавички. Това не отлага оценяването на обикновени изрази извън анотациите, например стойностите по подразбиране на параметрите.

В примера __annotations__ съдържа низове. След дефинирането на двата класа typing.get_type_hints() търси имената в съответните пространства от имена и разрешава препратките до обекти на класове. Ако дадено име липсва, например защото е импортирано само в if TYPE_CHECKING:, все още може да възникне NameError. Не разрешавай анотации от ненадежден източник: оценяването на изразите им може да изпълни код.

Примери

from typing import get_type_hints


class WorkItem:
    def __init__(self, title: str) -> None:
        self.title = title

    @classmethod
    def from_dict(cls, data: dict[str, str]) -> "WorkItem":
        return cls(data["title"])


class Project:
    def __init__(self) -> None:
        self.modules = []

    def add_module(self, module: "Module") -> None:
        self.modules.append(module)


class Module:
    pass


print(repr(WorkItem.from_dict.__annotations__["return"]))
print(repr(Project.add_module.__annotations__["module"]))
print(get_type_hints(WorkItem.from_dict)["return"] is WorkItem)
print(get_type_hints(Project.add_module)["module"] is Module)

Резултат

'WorkItem'
'Module'
True
True

Първите два реда показват представянията на низовете от `__annotations__`. Двата резултата `True` потвърждават, че разрешените анотации са точно обектите на класовете `WorkItem` и `Module`.

Свързани уроци

  • Python · Урок 3 · Напреднало · Версия: 5
  • Python · Урок 7 · Напреднало · Версия: 5

Източници