Как избежать ошибки стабтеста «[символ] отсутствует во время выполнения»
Пример
Учитывая файл ./mylib/minimalistic_repro.py
class Foo:
def __init__(self, param):
self.param = param
class Bar:
def __init__(self, param):
self.param = param
def foobar(par1, par2):
return par1.param + par2.param
и его заглушка ./mylib/minimalistic_repro.pyi
from typing import TypeAlias
FooBar: TypeAlias = Foo | Bar
class Foo:
param: int
def __init__(self, param: int) -> None: ...
class Bar:
param: int
def __init__(self, param: int) -> None: ...
def foobar(par1: FooBar, par2: FooBar) -> int: ...
Обратите внимание на псевдоним типа в третьей строке: FooBar: TypeAlias = Foo | Bar
mypy --strict mylib, flake8 mylib и ruff check --select E,F,B,SIM все проходит.
Однако при запуске стабтеста:python -m mypy.stubtest mylib
Я получаю следующую ошибку:error: mylib.minimalistic_repro.FooBar is not present at runtime …
Мой текущий обходной путь — использовать белый список (stubtest --generate-allowlist).
Вопрос(ы)
● Есть ли «лучший» способ избежать этой «ошибки»? / …
● … Я делаю что-то в корне неправильное? …
● … а если нет: может быть, стоит запросить новую функцию?
Другие подходы
● Конечно, я мог бы заявить
def foobar(par1: Foo | Bar, par2: Foo | Bar),
но моя реальная задача (написание подсказок типов для стороннего пакета pypi) требует объединения до 18 типов.
● Я получил приведенный выше пример для запуска с stubtest, поместив определение псевдонима типа FooBar в файл .py (tp_aliases.py), а затем повторно импортировав его. Этот подход не сработал в случае с моей реальной задачей подсказки типа пакета pypi (tp_aliases.py не является частью пакета pypi).
Ответы 1
stubtest жалуется, потому что считает, что ваш FooBar является общедоступным символом API, что может привести к тому, что средства проверки типов/автозаполнения IDE будут делать неправильные предположения и предложения.
«Правильный» способ исправить это — сделать его приватным; то есть предваряйте имя подчеркиванием:
_FooBar: TypeAlias = Foo | Bar
def foobar(par1: _FooBar, par2: _FooBar) -> int: ...
Для классов и функций вы можете альтернативно использовать typing.type_check_only:
# type_check_only is not available at runtime and can only be used in stubs
from typing import type_check_only
@type_check_only
def this_function_is_not_available_at_runtime() -> None: ...
@type_check_only
class AndSoDoesThisClass: ...
Также есть опция командной строки --ignore-missing-stub, которая подавляет все ошибки такого рода.
Один недостаток: объявление, например. частный
_FooBar: TypeAlias = Foo | Barв модуле 1, но использование его только в модуле 2 приводит к тому, что ruff и flake8 по понятным причинам жалуются на «Частный TypeAlias _FooBarникогда не используется». Я решу эту проблему с помощью noqa (все равно это гораздо удобнее, чем работать с белым списком).