Type annotation infrastructure and initial typing for qtbot.py #605
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicoddemus
reviewed
May 26, 2025
herobank110
changed the title
herobank110
commented
Jun 8, 2025
| @@ -617,9 +668,9 @@ def captureExceptions(self): | |||
| with capture_exceptions() as exceptions: | |||
| yield exceptions | |||
|
|
|||
| capture_exceptions = captureExceptions | |||
There was a problem hiding this comment.
Note: removed this line becausemypy gave a warning about this also being assigned in the constructor here: https://github.com/pytest-dev/pytest-qt/blob/master/src/pytestqt/qtbot.py#L153
nicoddemus
requested changes
Jun 10, 2025
There was a problem hiding this comment.
Thanks a lot @herobank110!
Left some comments, please take a look!
| @@ -174,7 +174,7 @@ | |||
| # 'pointsize': '10pt', | |||
| # Additional stuff for the LaTeX preamble. | |||
| # 'preamble': '', | |||
| } | |||
| } # type: dict[str, str] | |||
There was a problem hiding this comment.
I think we should add a mypy.ini file and add some options:
[mypy]
files = src,tests
no_implicit_optional = True
pretty = True
show_error_codes = True
strict_equality = True
warn_redundant_casts = True
warn_unused_configs = True
warn_unused_ignores = TrueThis way we can remove this type annotation:
Suggested change
| } # type: dict[str, str] | |
| } |
|
|
||
| __version__ = version | ||
| __version__ = cast("str", version) |
There was a problem hiding this comment.
Does this work?
Suggested change
| __version__ = cast("str", version) | |
| __version__: str = version |
Comment on lines
+36
to
+39
| QWidget = Any | ||
| SignalInstance = Any | ||
| QRect = Any | ||
| QKeySequence = Any |
There was a problem hiding this comment.
Suggested change
| QWidget = Any | |
| SignalInstance = Any | |
| QRect = Any | |
| QKeySequence = Any | |
| QWidget: TypeAlias = Any | |
| SignalInstance: TypeAlias = Any | |
| QRect: TypeAlias = Any | |
| QKeySequence: TypeAlias = Any |
| if value in (True, False): | ||
| return value | ||
| return cast("bool", value) |
There was a problem hiding this comment.
Suggested change
| return cast("bool", value) | |
| return cast(bool, value) |
| try: | ||
| return {"true": True, "false": False}[value.lower()] | ||
| return {"true": True, "false": False}[cast("str", value).lower()] |
There was a problem hiding this comment.
Suggested change
| return {"true": True, "false": False}[cast("str", value).lower()] | |
| return {"true": True, "false": False}[cast(str, value).lower()] |
Or:
Suggested change
| return {"true": True, "false": False}[cast("str", value).lower()] | |
| return {"true": True, "false": False}[str(value).lower()] |
| @@ -593,7 +644,7 @@ def waitCallback(self, *, timeout=5000, raising=None): | |||
| return blocker | |||
|
|
|||
| @contextlib.contextmanager | |||
| def captureExceptions(self): | |||
| def captureExceptions(self) -> Generator["CapturedExceptions", None, None]: | |||
There was a problem hiding this comment.
Suggested change
| def captureExceptions(self) -> Generator["CapturedExceptions", None, None]: | |
| def captureExceptions(self) -> Iterator["CapturedExceptions"]: |
|
|
||
|
|
||
| def _add_widget(item, widget, *, before_close_func=None): | ||
| QtBot.SignalEmittedError = SignalEmittedError # type: ignore[attr-defined] |
There was a problem hiding this comment.
Does using ignore[attr-defined] here means that the type checker does not know about QtBot.SignalEmittedError?
If so, we should move this to the class declaration:
class QtBot:
...
SignalEmittedError: ClassVar[Type[SignalEmittedError]] = SignalEmittedError(Same for the other exceptions of course)
| @@ -46,3 +46,7 @@ repos: | |||
| files: ^(HOWTORELEASE.rst|README.rst)$ | |||
| language: python | |||
| additional_dependencies: [pygments, restructuredtext_lint] | |||
| - repo: https://github.com/pre-commit/mirrors-mypy | |||
| rev: 'v1.15.0' | |||
There was a problem hiding this comment.
Suggested change
| rev: 'v1.15.0' | |
| rev: 'v1.16.0' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Initial version of adding type annotations to the library.
infrastructure of mypy in precommit (ci and local type checking)
Typing focused around qtboy.py to start with
Note: qt objects are typed with aliases refering to Any - this may be upgraded in future to use correct types.