Introducing wxPython type stubs

invesalius/gui/widgets/gradient.py

@@ -153,7 +153,7 @@ def OnPaint(self, evt: wx.Event) -> None:
 
         width_transparency = self.max_position - self.min_position
 
-        gc: wx.GraphicsContext = wx.GraphicsContext.Create(dc)
+        gc = wx.GraphicsContext.Create(dc)
 
         points: Sequence[Tuple[int, int, ColourType, ColourType]] = (
             (0, PUSH_WIDTH, (0, 0, 0), (0, 0, 0)),
@@ -162,8 +162,12 @@ def OnPaint(self, evt: wx.Event) -> None:
         )
 
         # Drawing the gradient background
+        p1: float
+        p2: float
         for p1, p2, c1, c2 in points:
-            brush = gc.CreateLinearGradientBrush(p1, 0, p2, h, c1, c2)
+            brush: Union[wx.GraphicsBrush, wx.Brush] = gc.CreateLinearGradientBrush(
+                p1, 0, p2, h, c1, c2
+            )
             gc.SetBrush(brush)
             path = gc.CreatePath()
             path.AddRectangle(p1, 0, p2 - p1, h)

invesalius/gui/widgets/inv_spinctrl.py

@@ -39,10 +39,9 @@ def __init__(
         super().__init__(parent, id, size=size)
 
         self._textctrl = wx.TextCtrl(self, -1, style=style)
+        self._spinbtn: Optional[wx.SpinButton] = None
         if spin_button and wx.Platform != "__WXGTK__":
             self._spinbtn = wx.SpinButton(self, -1)
-        else:
-            self._spinbtn = None
 
         self._value = 0
         self._last_value = 0
@@ -94,7 +93,7 @@ def SetRange(self, min_value: int, max_value: int) -> None:
     def GetValue(self) -> int:
         return self._value
 
-    def SetValue(self, value: Any) -> None:
+    def SetValue(self, value: Union[float, str]) -> None:
         try:
             value = int(value)
         except ValueError:
@@ -193,10 +192,9 @@ def __init__(
         super().__init__(parent, id, size=size)
 
         self._textctrl = wx.TextCtrl(self, -1, style=style)
+        self._spinbtn: Optional[wx.SpinButton] = None
         if spin_button and wx.Platform != "__WXGTK__":
             self._spinbtn = wx.SpinButton(self, -1)
-        else:
-            self._spinbtn = None
 
         self._digits = digits
         self._dec_context = decimal.Context(prec=digits)

invesalius/gui/widgets/slice_menu.py

@@ -19,19 +19,17 @@
 #    detalhes.
 # --------------------------------------------------------------------------
 import sys
-
-
 from collections import OrderedDict
-from typing import Dict
+from typing import Dict, Optional, Union
 
 import wx
-from invesalius.pubsub import pub as Publisher
 
 import invesalius.constants as const
 import invesalius.data.slice_ as sl
 import invesalius.presets as presets
 from invesalius.gui.dialogs import ClutImagedataDialog
 from invesalius.i18n import tr as _
+from invesalius.pubsub import pub as Publisher
 
 PROJECTIONS_ID = OrderedDict(
     (
@@ -47,10 +45,10 @@
 
 
 class SliceMenu(wx.Menu):
-    def __init__(self):
+    def __init__(self) -> None:
         wx.Menu.__init__(self)
-        self.ID_TO_TOOL_ITEM = {}
-        self.cdialog = None
+        self.ID_TO_TOOL_ITEM: Dict[Union[wx.WindowIDRef, int], wx.MenuItem] = {}
+        self.cdialog: Optional[ClutImagedataDialog] = None
 
         # ------------ Sub menu of the window and level ----------
         submenu_wl = wx.Menu()
@@ -92,7 +90,7 @@ def __init__(self):
             mkind = wx.ITEM_RADIO
 
         submenu_pseudo_colours = wx.Menu()
-        self.pseudo_color_items: Dict[int, wx.MenuItem] = {}
+        self.pseudo_color_items: Dict[wx.WindowIDRef, wx.MenuItem] = {}
         new_id = self.id_pseudo_first = wx.NewIdRef()
         color_item = submenu_pseudo_colours.Append(new_id, _("Default "), kind=mkind)
         color_item.Check(True)
@@ -119,13 +117,11 @@ def __init__(self):
         self.pseudo_color_items[new_id] = color_item
 
         # --------------- Sub menu of the projection type ---------------------
-        self.projection_items = {}
+        self.projection_items: Dict[Union[wx.WindowIDRef, int], wx.MenuItem] = {}
         submenu_projection = wx.Menu()
         for name in PROJECTIONS_ID:
             new_id = wx.NewIdRef()
-            projection_item = submenu_projection.Append(
-                new_id, name, kind=wx.ITEM_RADIO
-            )
+            projection_item = submenu_projection.Append(new_id, name, kind=wx.ITEM_RADIO)
             self.ID_TO_TOOL_ITEM[new_id] = projection_item
             self.projection_items[PROJECTIONS_ID[name]] = projection_item
 
@@ -134,9 +130,7 @@ def __init__(self):
         submenu_image_tiling = wx.Menu()
         for name in sorted(const.IMAGE_TILING):
             new_id = wx.NewIdRef()
-            image_tiling_item = submenu_image_tiling.Append(
-                new_id, name, kind=wx.ITEM_RADIO
-            )
+            image_tiling_item = submenu_image_tiling.Append(new_id, name, kind=wx.ITEM_RADIO)
             self.ID_TO_TOOL_ITEM[new_id] = image_tiling_item
 
             # Save first id item
@@ -161,14 +155,14 @@ def __init__(self):
 
         self.__bind_events()
 
-    def __bind_events(self):
+    def __bind_events(self) -> None:
         Publisher.subscribe(self.CheckWindowLevelOther, "Check window and level other")
         Publisher.subscribe(self.FirstItemSelect, "Select first item from slice menu")
         Publisher.subscribe(self._close, "Close project data")
 
         Publisher.subscribe(self._check_projection_menu, "Check projection menu")
 
-    def FirstItemSelect(self):
+    def FirstItemSelect(self) -> None:
         item = self.ID_TO_TOOL_ITEM[self.id_wl_first]
         item.Check(True)
 
@@ -182,26 +176,24 @@ def FirstItemSelect(self):
         #  item = self.ID_TO_TOOL_ITEM[self.id_tiling_first]
         #  item.Check(True)
 
-    def CheckWindowLevelOther(self):
+    def CheckWindowLevelOther(self) -> None:
         item = self.ID_TO_TOOL_ITEM[self.other_wl_id]
         item.Check()
 
-    def _check_projection_menu(self, projection_id):
+    def _check_projection_menu(self, projection_id: int) -> None:
         item = self.projection_items[projection_id]
         item.Check()
 
-    def OnPopup(self, evt):
-        id = evt.GetId()
+    def OnPopup(self, evt: wx.CommandEvent) -> None:
+        # id = evt.GetId()
         item = self.ID_TO_TOOL_ITEM[evt.GetId()]
         key = item.GetItemLabelText()
         if key in const.WINDOW_LEVEL.keys():
             window, level = const.WINDOW_LEVEL[key]
             Publisher.sendMessage(
                 "Bright and contrast adjustment image", window=window, level=level
             )
-            Publisher.sendMessage(
-                "Update window level value", window=window, level=level
-            )
+            Publisher.sendMessage("Update window level value", window=window, level=level)
             #  Publisher.sendMessage('Update window and level text',
             #  "WL: %d  WW: %d"%(level, window))
             Publisher.sendMessage("Update slice viewer")
@@ -211,9 +203,7 @@ def OnPopup(self, evt):
 
         elif key in const.SLICE_COLOR_TABLE.keys():
             values = const.SLICE_COLOR_TABLE[key]
-            Publisher.sendMessage(
-                "Change colour table from background image", values=values
-            )
+            Publisher.sendMessage("Change colour table from background image", values=values)
             Publisher.sendMessage("Update slice viewer")
 
             if sys.platform.startswith("linux"):
@@ -275,11 +265,11 @@ def OnPopup(self, evt):
 
         evt.Skip()
 
-    def HideClutDialog(self):
+    def HideClutDialog(self) -> None:
         if self.cdialog:
             self.cdialog.Hide()
 
-    def _close(self):
+    def _close(self) -> None:
         if self.cdialog:
             self.cdialog.Destroy()
             self.cdialog = None

pyproject.toml

@@ -17,6 +17,7 @@ requires-python = ">=3.8"
 packages = ["invesalius", "invesalius_cy"]
 
 [tool.mypy]
+mypy_path = "typings"
 show_error_codes = true
 check_untyped_defs = false
 disallow_any_generics = false
@@ -31,10 +32,15 @@ warn_unreachable = false
 warn_unused_configs = false
 no_implicit_reexport = false
 follow_imports = "normal"
-
-disable_error_code =  ["attr-defined", "no-redef"]
 explicit_package_bases = true
+disable_error_code =  ["attr-defined", "no-redef"]
 
+[[tool.mypy.overrides]]
+module = 'invesalius.gui.widgets.listctrl'
+ignore_errors = true
+[[tool.mypy.overrides]]
+module = 'wx.*'
+disable_error_code = ["no-redef"] # because some classes are redefined in the stubs
 [[tool.mypy.overrides]]
 module = [
     'wx.*',
@@ -85,11 +91,12 @@ ignore_missing_imports = true
 
 [tool.ruff]
 include = ["pyproject.toml", "invesalius/**/*.py",'setup.py','app.py']
+extend-exclude = ["./invesalius/gui/widgets/listctrl.py"]
 line-length = 100
 # extend-exclude = ["plugins"]
 
 [tool.ruff.lint]
-extend-select = ["UP"] # Introduces linting rules for pyupgrade
+extend-select = ["UP","I"] # Introduces linting rules for pyupgrade
 # We can extend the list with 'I' and 'PL' in the future
 
 [tool.ruff.format]

typings/utils/__init__.pyi

@@ -0,0 +1,19 @@
+from typing import Generic, Protocol, TypeVar
+
+import wx
+from typing_extensions import Self
+
+from invesalius.gui.widgets.canvas_renderer import CanvasRendererCTX
+
+T = TypeVar("T", covariant=True)
+
+class SupportsGetItem(Protocol, Generic[T]):
+    def __getitem__(self, key: int, /) -> T: ...
+
+class CanvasObjects(Protocol):
+    parent: Self | None
+    def is_over(self, x: int, y: int) -> Self | None: ...
+    def draw_to_canvas(self, gc: wx.GraphicsContext, canvas: CanvasRendererCTX) -> None: ...
+
+class CanvasElement(Protocol):
+    def draw_to_canvas(self, gc: wx.GraphicsContext, canvas: CanvasRendererCTX) -> None: ...

typings/wx/__init__.pyi

@@ -0,0 +1 @@
+from .core import *