Type annotation infrastructure and initial typing for qtbot.py

[herobank110]

Initial version of adding type annotations to the library.

• infrastructure of mypy in precommit (ci and local type checking)

• Typing focused around qtbot.py to start with

• Note: qt objects are typed with aliases refering to Any - this may be upgraded in future to use correct types.

Fixes #417

[nicoddemus]

Thanks a lot @herobank110!

Left some comments, please take a look!

[nicoddemus]

Thanks a lot @herobank110, this looks great!

[nicoddemus]

Thanks @herobank110!

Leaving it open for a few days to give @The-Compiler a chance to review too. 👍

[herobank110]

Thanks @herobank110!

Leaving it open for a few days to give @The-Compiler a chance to review too. 👍

Keen to continue contributing with the typing and other stuff you may have

[The-Compiler]

Thank you, I'm pretty excited for this! ✨

I added a couple of comments for things I noticed, mostly they're minor things and shouldn't block anything though. A todo-list for follow-ups if we don't do them as part of this PR:

• Use Type Hinting Generics in Standard Collections (list, dict, type over typing.List etc.)
• Use from __future__ import annotations
  • Use PEP 604: New Type Union Operator, i.e. TheType | None instead of Optional[TheType]
  • Use "bare" annotations for forward declarations instead of stringified ones
  • Configure ruff to enforce from __future__ import annotations on every file for consistency
• Remove redundant type annotations from Sphinx docstrings (and possibly configure Sphinx to pick up the annotations, not sure what's needed for that nowadays)

[The-Compiler]

Those seem somewhat confusing - I wonder if we should from ... import SignalEmittedError as SignalEmittedError_ or something to make clear what happens here?

[herobank110]

I believe it could introduce breaking changes to remove or alias the imports, eg if users wrote from pytestqt.qtbot import TimeoutError

Another option to reduce confusion in the member variables: eg SignalEmittedError = wait_signal.SignalEmittedError

[herobank110]

Thank you, I'm pretty excited for this! ✨

I added a couple of comments for things I noticed, mostly they're minor things and shouldn't block anything though. A todo-list for follow-ups if we don't do them as part of this PR:

• Use Type Hinting Generics in Standard Collections (list, dict, type over typing.List etc.)

• Use from __future__ import annotations

  • Use PEP 604: New Type Union Operator, i.e. TheType | None instead of Optional[TheType]
  • Use "bare" annotations for forward declarations instead of stringified ones
  • Configure ruff to enforce from __future__ import annotations on every file for consistency

• Remove redundant type annotations from Sphinx docstrings (and possibly configure Sphinx to pick up the annotations, not sure what's needed for that nowadays)

Thanks both for reviewing. Changed to use the Type Hinting Generics in Standard Collections. Saving the rest for later if its OK :)

[The-Compiler]

Looking great, thanks again!

[The-Compiler]

Ugh, meant to squash merge but clicked too fast.... sorry @nicoddemus 😅

[nicoddemus]

No worries, it happens. 👍