Type annotation test

.pre-commit-config.yaml

@@ -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'
+    hooks:
+    -   id: mypy

docs/conf.py

@@ -174,7 +174,7 @@
     # 'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
-}
+}  # type: dict[str, str]
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).

src/pytestqt/qtbot.py

@@ -1,6 +1,7 @@
 import contextlib
 import weakref
 import warnings
+from typing import TYPE_CHECKING, Callable, Optional
 
 from pytestqt.exceptions import TimeoutError, ScreenshotError
 from pytestqt.qt_compat import qt_api
@@ -13,6 +14,11 @@
     CallbackCalledTwiceError,
 )
 
+if TYPE_CHECKING:
+    from qtpy.QtWidgets import QWidget
+
+BeforeCloseFunc = Callable[["QWidget"], None]
+
 
 def _parse_ini_boolean(value):
     if value in (True, False):
@@ -170,7 +176,9 @@ def _should_raise(self, raising_arg):
         else:
             return True
 
-    def addWidget(self, widget, *, before_close_func=None):
+    def addWidget(
+        self, widget: "QWidget", *, before_close_func: Optional[BeforeCloseFunc] = None
+    ):
         """
         Adds a widget to be tracked by this bot. This is not required, but will ensure that the
         widget gets closed by the end of the test, so it is highly recommended.
@@ -725,13 +733,18 @@ def mouseRelease(*args, **kwargs):
 
 
 # provide easy access to exceptions to qtbot fixtures
-QtBot.SignalEmittedError = SignalEmittedError
-QtBot.TimeoutError = TimeoutError
-QtBot.ScreenshotError = ScreenshotError
-QtBot.CallbackCalledTwiceError = CallbackCalledTwiceError
-
-
-def _add_widget(item, widget, *, before_close_func=None):
+QtBot.SignalEmittedError = SignalEmittedError  # type: ignore[attr-defined]
+QtBot.TimeoutError = TimeoutError  # type: ignore[attr-defined]
+QtBot.ScreenshotError = ScreenshotError  # type: ignore[attr-defined]
+QtBot.CallbackCalledTwiceError = CallbackCalledTwiceError  # type: ignore[attr-defined]
+
+
+def _add_widget(
+    item,
+    widget: "QWidget",
+    *,
+    before_close_func: Optional[BeforeCloseFunc] = None,
+):
     """
     Register a widget into the given pytest item for later closing.
     """

tests/test_modeltest.py

@@ -6,7 +6,7 @@
 pytestmark = pytest.mark.usefixtures("qtbot")
 
 
-class BasicModel(qt_api.QtCore.QAbstractItemModel):
+class BasicModel(qt_api.QtCore.QAbstractItemModel):  # type: ignore[name-defined]
     def data(self, index, role=qt_api.QtCore.Qt.ItemDataRole.DisplayRole):
         return None