ruff

Author: JaskRendix

.github/workflows/ruff.yml

@@ -0,0 +1,19 @@
+name: Python package
+
+on: [push, pull_request]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.9'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - name: Run Ruff
+        run: ruff check . --select UP,TCH --target-version py39

pygame_menu/_base.py

@@ -10,7 +10,7 @@
 
 __all__ = ['Base']
 
-from typing import Any, Optional
+from typing import Any
 
 from pygame_menu._types import NumberInstance, NumberType
 from pygame_menu.utils import uuid4
@@ -20,7 +20,7 @@ class Base:
     """
     Base object.
     """
-    _attributes: Optional[dict[str, Any]]
+    _attributes: dict[str, Any] | None
     _class_id__repr__: bool
     _id: str
     _id__repr__: bool

pygame_menu/_decorator.py

@@ -12,9 +12,8 @@
 __all__ = ['Decorator']
 
 import math
-from collections.abc import Callable
 from math import pi
-from typing import Any, Optional, Union
+from typing import TYPE_CHECKING, Any
 
 import pygame
 import pygame.draw as pydraw
@@ -25,10 +24,14 @@
 from pygame_menu._types import (CallableNoArgsType, ColorInputType,
                                 NumberInstance, NumberType, Tuple2IntType,
                                 Tuple2NumberType)
-from pygame_menu.font import FontType
 from pygame_menu.utils import (assert_color, assert_list_vector, assert_vector,
                                make_surface, uuid4, warn)
 
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from pygame_menu.font import FontType
+
 # Decoration constants
 DECORATION_ARC: int = 2000
 DECORATION_BASEIMAGE: int = 2001
@@ -62,21 +65,21 @@ class Decorator(Base):
     :param verbose: Enable/disable verbose mode (warnings/errors)
     """
     _coord_cache: dict[
-        str, tuple[int, int, Union[tuple[Tuple2NumberType, ...], Tuple2NumberType]]]  # centerx, centery, coords
+        str, tuple[int, int, tuple[Tuple2NumberType, ...] | Tuple2NumberType]]  # centerx, centery, coords
     _cache_last_status: dict[str, tuple[int, int, int, int, int, int]]
     _cache_needs_update: dict[str, bool]
-    _cache_surface: dict[str, Optional[pygame.Surface]]
+    _cache_surface: dict[str, pygame.Surface | None]
     _decor: dict[str, list[tuple[int, str, Any]]]  # type, id, data
     _decor_enabled: dict[str, bool]
     _decor_prev_id: list[str]
-    _obj: Union[pygame_menu.widgets.Widget, pygame_menu._scrollarea.ScrollArea, pygame_menu.Menu]
+    _obj: pygame_menu.widgets.Widget | pygame_menu._scrollarea.ScrollArea | pygame_menu.Menu
     _post_enabled: bool
     _prev_enabled: bool
     cache: bool
 
     def __init__(
         self,
-        obj: Union[pygame_menu.widgets.Widget, pygame_menu._scrollarea.ScrollArea, pygame_menu.Menu],
+        obj: pygame_menu.widgets.Widget | pygame_menu._scrollarea.ScrollArea | pygame_menu.Menu,
         decorator_id: str = '',
         verbose: bool = True
     ) -> None:
@@ -180,7 +183,7 @@ def _total_decor(self) -> int:
         """
         return len(self._decor[DECOR_TYPE_PREV]) + len(self._decor[DECOR_TYPE_POST])
 
-    def force_cache_update(self, prev: Optional[bool] = None) -> Decorator:
+    def force_cache_update(self, prev: bool | None = None) -> Decorator:
         """
         Forces cache update.
 
@@ -196,7 +199,7 @@ def force_cache_update(self, prev: Optional[bool] = None) -> Decorator:
 
     def add_polygon(
         self,
-        coords: Union[list[Tuple2NumberType], tuple[Tuple2NumberType, ...]],
+        coords: list[Tuple2NumberType] | tuple[Tuple2NumberType, ...],
         color: ColorInputType,
         filled: bool,
         width: int = 0,
@@ -236,7 +239,7 @@ def add_polygon(
 
     def add_bezier(
         self,
-        coords: Union[list[Tuple2NumberType], tuple[Tuple2NumberType, ...]],
+        coords: list[Tuple2NumberType] | tuple[Tuple2NumberType, ...],
         color: ColorInputType,
         steps: int = 5,
         prev: bool = True,
@@ -639,7 +642,7 @@ def add_pixel(
 
     def add_callable(
         self,
-        fun: Union[Callable[[pygame.Surface, Any], Any], CallableNoArgsType],
+        fun: Callable[[pygame.Surface, Any], Any] | CallableNoArgsType,
         prev: bool = True,
         pass_args: bool = True
     ) -> str:
@@ -671,8 +674,8 @@ def add_callable(
 
     def add_textured_polygon(
         self,
-        coords: Union[list[Tuple2NumberType], tuple[Tuple2NumberType, ...]],
-        texture: Union[pygame.Surface, pygame_menu.BaseImage],
+        coords: list[Tuple2NumberType] | tuple[Tuple2NumberType, ...],
+        texture: pygame.Surface | pygame_menu.BaseImage,
         tx: int = 0,
         ty: int = 0,
         prev: bool = True,
@@ -873,7 +876,7 @@ def remove(self, decorid: str) -> Decorator:
                     return self
         raise IndexError(f'decoration<"{decorid}"> was not found')
 
-    def remove_all(self, prev: Optional[bool] = None) -> Decorator:
+    def remove_all(self, prev: bool | None = None) -> Decorator:
         """
         Remove all decorations.
 
@@ -1080,9 +1083,9 @@ def _update_pos_list(
         self,
         rect: pygame.Rect,
         decoid: str,
-        pos: Union[Tuple2NumberType, tuple[Tuple2NumberType, ...]],  # only (x, y) or ((x1,y1), ...
+        pos: Tuple2NumberType | tuple[Tuple2NumberType, ...],  # only (x, y) or ((x1,y1), ...
         use_center_positioning=True
-    ) -> Union[tuple[Tuple2IntType, ...], Tuple2IntType]:
+    ) -> tuple[Tuple2IntType, ...] | Tuple2IntType:
         """
         Updates position list based on rect center. If position of the rect changes,
         update the coords.

pygame_menu/_scrollarea.py

@@ -19,7 +19,7 @@
 ]
 
 from itertools import product
-from typing import Any, Optional, Union
+from typing import Any
 
 import pygame
 
@@ -46,7 +46,7 @@
 
 def get_scrollbars_from_position(
     position: str
-) -> Union[str, tuple[str, str], tuple[str, str, str, str]]:
+) -> str | tuple[str, str] | tuple[str, str, str, str]:
     """
     Return the scrollbars from the given position.
 
@@ -125,41 +125,41 @@ class ScrollArea(Base):
     :param shadow_position: Position of the scrollbar shadow. See :py:mod:`pygame_menu.locals`
     :param world: Surface to draw and scroll
     """
-    _area_color: Optional[Union[ColorInputType, pygame_menu.BaseImage]]
-    _border_color: Optional[Union[ColorInputType, pygame_menu.BaseImage]]
+    _area_color: ColorInputType | pygame_menu.BaseImage | None
+    _border_color: ColorInputType | pygame_menu.BaseImage | None
     _border_tiles: list[pygame.Surface]
     _border_tiles_size: Tuple2IntType
     _border_width: int
-    _bg_surface: Optional[pygame.Surface]
+    _bg_surface: pygame.Surface | None
     _decorator: Decorator
     _extend_x: int
     _extend_y: int
-    _menu: Optional[pygame_menu.Menu]
+    _menu: pygame_menu.Menu | None
     _menubar: pygame_menu.widgets.MenuBar
     _parent_scrollarea: ScrollArea
     _rect: pygame.Rect
-    _scrollbar_positions: Union[str, tuple[str, ...]]
+    _scrollbar_positions: str | tuple[str, ...]
     _scrollbars: list[ScrollBar]
     _scrollbars_props: tuple[Any, ...]
     _translate: Tuple2IntType
     _view_rect: pygame.Rect
-    _world: Optional[pygame.Surface]
+    _world: pygame.Surface | None
 
     def __init__(
         self,
         area_width: int,
         area_height: int,
-        area_color: Optional[Union[ColorInputType, pygame_menu.BaseImage]] = None,
-        border_color: Optional[Union[ColorInputType, pygame_menu.BaseImage]] = None,
+        area_color: ColorInputType | pygame_menu.BaseImage | None = None,
+        border_color: ColorInputType | pygame_menu.BaseImage | None = None,
         border_width: int = 0,
         controls_joystick: bool = True,
         controls_keyboard: bool = True,
         controls_mouse: bool = True,
         controls_touchscreen: bool = True,
         extend_x: int = 0,
         extend_y: int = 0,
-        menubar: Optional[pygame_menu.widgets.MenuBar] = None,
-        parent_scrollarea: Optional[ScrollArea] = None,
+        menubar: pygame_menu.widgets.MenuBar | None = None,
+        parent_scrollarea: ScrollArea | None = None,
         scrollarea_id: str = '',
         scrollbar_color: ColorInputType = (235, 235, 235),
         scrollbar_cursor: CursorInputType = None,  # type: ignore
@@ -172,7 +172,7 @@ def __init__(
         shadow_color: ColorInputType = (0, 0, 0),
         shadow_offset: int = 2,
         shadow_position: str = POSITION_SOUTHEAST,
-        world: Optional[pygame.Surface] = None
+        world: pygame.Surface | None = None
     ) -> None:
         super().__init__(object_id=scrollarea_id)
 
@@ -344,7 +344,7 @@ def _make_background_surface(self) -> None:
 
     def update_area_color(
         self,
-        color: Optional[Union[ColorInputType, pygame_menu.BaseImage]]
+        color: ColorInputType | pygame_menu.BaseImage | None
     ) -> ScrollArea:
         """
         Updates area color (background).
@@ -357,7 +357,7 @@ def update_area_color(
         self._make_background_surface()
         return self
 
-    def set_parent_scrollarea(self, parent: Optional[ScrollArea]) -> ScrollArea:
+    def set_parent_scrollarea(self, parent: ScrollArea | None) -> ScrollArea:
         """
         Set parent ScrollArea.
 
@@ -368,7 +368,7 @@ def set_parent_scrollarea(self, parent: Optional[ScrollArea]) -> ScrollArea:
         self._parent_scrollarea = parent
         return self
 
-    def get_parent(self) -> Optional[ScrollArea]:
+    def get_parent(self) -> ScrollArea | None:
         """
         Return the parent ScrollArea.
 
@@ -547,7 +547,7 @@ def draw(self, surface: pygame.Surface) -> ScrollArea:
             top -= th
 
             # draw top and bottom tiles
-            area: Optional[tuple[int, int, int, int]]
+            area: tuple[int, int, int, int] | None
 
             for x in range(border_rect.left, border_rect.right, tw):
                 if x + tw >= border_rect.right:
@@ -1072,7 +1072,7 @@ def set_world(self, surface: pygame.Surface) -> ScrollArea:
         self._apply_size_changes()
         return self
 
-    def get_world(self) -> Optional[pygame.Surface]:
+    def get_world(self) -> pygame.Surface | None:
         """
         Return the world surface area.
 
@@ -1140,9 +1140,9 @@ def get_absolute_view_rect(self) -> pygame.Rect:
 
     def to_real_position(
         self,
-        virtual: Union[pygame.Rect, Tuple2NumberType],
+        virtual: pygame.Rect | Tuple2NumberType,
         visible: bool = False
-    ) -> Union[pygame.Rect, Tuple2IntType]:
+    ) -> pygame.Rect | Tuple2IntType:
         """
         Return the real position/Rect according to the ScrollArea origin of a
         position/Rect in the world surface reference.
@@ -1174,8 +1174,8 @@ def to_real_position(
 
     def to_world_position(
         self,
-        real: Union[pygame.Rect, Tuple2NumberType]
-    ) -> Union[pygame.Rect, Tuple2IntType]:
+        real: pygame.Rect | Tuple2NumberType
+    ) -> pygame.Rect | Tuple2IntType:
         """
         Return the position/Rect in the world surface reference of a real
         position/Rect according to the ScrollArea origin.
@@ -1242,7 +1242,7 @@ def set_menu(self, menu: pygame_menu.Menu) -> ScrollArea:
             sbar.set_menu(menu)
         return self
 
-    def get_menu(self) -> Optional[pygame_menu.Menu]:
+    def get_menu(self) -> pygame_menu.Menu | None:
         """
         Return the Menu reference (if exists).
 
@@ -1252,7 +1252,7 @@ def get_menu(self) -> Optional[pygame_menu.Menu]:
 
     def collide(
         self,
-        widget: Union[pygame_menu.widgets.Widget, pygame.Rect],
+        widget: pygame_menu.widgets.Widget | pygame.Rect,
         event: EventType
     ) -> bool:
         """
@@ -1269,7 +1269,7 @@ def collide(
             widget_rect = widget
         return bool(widget_rect.collidepoint(*get_finger_pos(self._menu, event)))
 
-    def get_scrollbar(self, position: str) -> Optional[ScrollBar]:
+    def get_scrollbar(self, position: str) -> ScrollBar | None:
         """
         Returns the scrollbar at the given position, or None if not present.
         :param position: The position of the scrollbar (e.g., POSITION_NORTH, POSITION_EAST).