Use ParamSpec to type check Actor args #515
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR introduces ParamSpec (PEP 612) to type annotate that
Actor.__call__
and similar expect all the same arguments as the wrapped handler function. A few clarifications on the black magic that happening:if TYPE_CHECKING
block, so dramatiq doesn't depend on typing-extensions at runtime. At static type checking time by mypy, typing-extensions are guaranteed to be available because they are a dependency of mypy (and pyright has their stubs bundled).from __future__ import annotations
, so that imports are lazy. See PEP 563. I've added it because initially I made it so that ParamSpec is not available at runtime. I later had to mock it for runtime (see the next point) but decided to leave this lazy annotations hack, it's quite handy on its own for many reasons.Generic
is a base class, not an annotation, and so its arguments are evaluated at runtime. I tried to pass the ParamSpec as a string, but then it explodes inruntime with TypeError. So, I replaceParamSpec
withTypeVar
in runtime.*args
and**kwargs
, somessage_with_options
andsend_with_options
cannot be annotated.