context_management: add a type stub override to fix typing #457
Conversation
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 54s |
|
/packit build |
|
/packit-stg build |
|
/packit rebuild-failed |
|
/packit-stg rebuild-failed |
Type checkers (mypy, pyright, et al.) don't understand the
ContextManager descriptor class.
With a stub file, we can tell the type checker to treat ContextManager
as a simple decorator function which is something that it understands.
``` python
from typing import reveal_type
import specfile
s = specfile.Specfile("./fedora/python-specfile.spec")
\# Before: types.MethodType
\# After: (allow_duplicates: bool = False, default_to_implicit_numbering: bool = False, default_source_number_digits: int = 1) -> GeneratorContextManager[Sources]
reveal_type(s.sources)
\# Before: Any
\# After: GeneratorContextManager[Sources]
reveal_type(s.sources())
\# Before: Any
\# After: Sources
reveal_type(s.sources().__enter__())
reveal_type(s.sources().content)
```
gotmax23
force-pushed
the
contextmanager-type-check
branch
from
a604ec9 to
51565f1
Compare
|
Build succeeded. ✔️ pre-commit SUCCESS in 1m 52s |
|
/packit build |
|
/packit-stg build |
|
regate |
|
Build succeeded (gate pipeline). ✔️ pre-commit SUCCESS in 1m 59s |
softwarefactory-project-zuul
bot
merged commit eab3524
into
packit:main
Type checkers (mypy, pyright, et al.) don't understand the ContextManager descriptor class.
With a stub file, we can tell the type checker to treat ContextManager as a simple decorator function which is something that it understands.
RELEASE NOTES BEGIN
context_management: add a type stub override to fix typing. Type checkers like mypy and pyright can now correctly determine the types for
.sources(),.sections(), and the otherSpecfilemethods that return context managers.RELEASE NOTES END