Introducing wxPython type stubs

[omar-abdelgawad]

📢 Describe your changes

• 📌 changes Summary
  • Type hinted all of invesalius/gui/widgets/ with few errors remaining for only two files.
  • Added wxPython type stubs in typings/wx where I would be improving it little by little across the project. (Most of the pyi file Now is still untyped).
  • Utility Protocols are added to typings/utils
• ⚠️ Breaking changes
  • Some internal method APIs were changed in their small scope for compliance with static typing. Examples Include initializing object in __init__ instead of assigning None to it, changing a name of a variable inside a function to avoid clash with a different type, etc. All changes are minor and local to methods. The API exported from all modules are still the same.
  • Changed Node class using slots for convenience and type compliance of __eq__ method.
• 🐞 Bug Fixes:
  • None

🧪 How to test this Pull Request

1. For testing type information using MyPy:

mypy invesalius/gui/widgets/ --follow-imports=skip --check-untyped-defs --disallow-any-generics \
--disallow-incomplete-defs --warn-redundant-casts --warn-unused-ignores --no-implicit-optional \
--strict-equality --warn-return-any --warn-unreachable --warn-unused-configs

1. For testing Ruff linting

ruff check invesalius/gui/widgets/

🗒️ Notes for future improvements

• Not all MyPy Errors in invesalius/gui/widgets/*.py files were fixed in this PR.
• I have been thinking about using Pyright instead of MyPy as I discovered that it is faster and usually provides better LSP support. What do you think?

[tfmoraes]

I'm not against the using Pyright instead of Mypy. It is faster and is already used as LSP (VSCode uses Pylance, but Pylance uses Pyright).

[omar-abdelgawad]

I'm not against the using Pyright instead of Mypy. It is faster and is already used as LSP (VSCode uses Pylance, but Pylance uses Pyright).

Then I will study the options and decide later. Until then I will be satisfying both type checkers.

[omar-abdelgawad]

Can you please inform me of the types of both self.draw_list = [] and self._ordered_draw_list = [] in CanvasRendererCTX since I am not able to trace their types.

[tfmoraes]

Can you please inform me of the types of both self.draw_list = [] and self._ordered_draw_list = [] in CanvasRendererCTX since I am not able to trace their types.

Both are a list of objects that implements the method draw_to_canvas. I think you can create a protocol class and use that to type both.

[omar-abdelgawad]

Hi @tfmoraes ! Can I get confirmation that the points are OK to be Tuple[float, float] instead of tuple of integers since I don't know sometimes if that is the correct type or did I make an assumption that I didn't notice.

[omar-abdelgawad]

On a side note, shouldn't CanvasHandlerBase be an abstract class?

[tfmoraes]

Hi @tfmoraes ! Can I get confirmation that the points are OK to be Tuple[float, float] instead of tuple of integers since I don't know sometimes if that is the correct type or did I make an assumption that I didn't notice.

You can use tuple of float for every position in this file.

[tfmoraes]

On a side note, shouldn't CanvasHandlerBase be an abstract class?

You mean an ABC class? OK. Also, draw_to_canvas has to be an abstractmethod.

[omar-abdelgawad]

Looks like handling all errors properly in this module (canvas_renderer.py) would take sometime which I think it more valuable in spending first on other modules first then return to it later. I think that this is enough for type hinting invesalius/gui/widgets. What do you think?

[tfmoraes]

Looks like handling all errors properly in this module (canvas_renderer.py) would take sometime which I think it more valuable in spending first on other modules first then return to it later. I think that this is enough for type hinting invesalius/gui/widgets. What do you think?

Ok. I think that is better.