Type annotation infrastructure and initial typing for qtbot.py

.pre-commit-config.yaml

@@ -46,3 +46,9 @@ repos:
         files: ^(HOWTORELEASE.rst|README.rst)$
         language: python
         additional_dependencies: [pygments, restructuredtext_lint]
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.16.0'
+    hooks:
+    -   id: mypy
+        additional_dependencies: [pytest]
+        exclude: ^docs/

CHANGELOG.rst

@@ -4,6 +4,7 @@ UNRELEASED
 - Added official support for Python 3.13.
 - Dropped support for EOL Python 3.8.
 - Dropped support for EOL PySide 2.
+- Type annotations are now provided. Note that because the Qt library used is defined at runtime, Qt classes are currently annotated as ``Any``.
 - Fixed PySide6 exceptions / warnings about being unable to disconnect signals
   with ``qtbot.waitSignal`` (`#552`_, `#558`_).
 - Reduced the likelyhood of trouble when using ``qtbot.waitSignal(s)`` and

mypy.ini

@@ -0,0 +1,8 @@
+[mypy]
+exclude = ^docs/
+pretty = True
+show_error_codes = True
+strict_equality = True
+warn_redundant_casts = True
+warn_unused_configs = True
+warn_unused_ignores = True

setup.py

@@ -8,7 +8,7 @@
     packages=find_packages(where="src"),
     package_dir={"": "src"},
     entry_points={"pytest11": ["pytest-qt = pytestqt.plugin"]},
-    install_requires=["pytest", "pluggy>=1.1"],
+    install_requires=["pytest", "pluggy>=1.1", "typing_extensions"],
     extras_require={
         "doc": ["sphinx", "sphinx_rtd_theme"],
         "dev": ["pre-commit", "tox"],

src/pytestqt/__init__.py

@@ -1,4 +1,4 @@
 # _version is automatically generated by setuptools_scm
 from pytestqt._version import version
 
-__version__ = version
+__version__: str = version

src/pytestqt/exceptions.py

@@ -2,10 +2,14 @@
 import sys
 import traceback
 from contextlib import contextmanager
+from types import TracebackType
 
 import pytest
 from pytestqt.utils import get_marker
 
+CapturedException = tuple[type[BaseException], BaseException, TracebackType]
+CapturedExceptions = list[CapturedException]
+
 
 @contextmanager
 def capture_exceptions():

src/pytestqt/py.typed

@@ -0,0 +1 @@
+partial

src/pytestqt/qt_compat.py

@@ -162,7 +162,7 @@ def exec(self, obj, *args, **kwargs):
 
     def get_versions(self):
         if self.pytest_qt_api == "pyside6":
-            import PySide6
+            import PySide6  # type: ignore[import-not-found,unused-ignore]
 
             version = PySide6.__version__