Merge pull request #520 from JaskRendix/ruff

Enable Ruff UP & TCH Rules and Apply Automatic Fixes

Author: ppizarror

.github/workflows/ci.yml

@@ -37,10 +37,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.12'
 
@@ -57,3 +57,18 @@ jobs:
       - name: Run Semgrep
         run: |
           semgrep --config p/ci .
+
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - 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 .

.gitignore

@@ -27,10 +27,6 @@ run_gource.bat
 # Tox
 tox.ini
 
-# Pyproject
-pyproject_update.py
-pyproject.toml
-
 # Lock file
 *.lock
 

docs/add_widgets.py

@@ -68,7 +68,7 @@ def change_background_color(selected_value, color, **kwargs):
     print('Change widget color to', value_tuple[0])  # selected_value format ('Color', surface, color)
     if color == (-1, -1, -1):  # Generate a random color
         color = (randrange(0, 255), randrange(0, 255), randrange(0, 255))
-    widget: 'pygame_menu.widgets.Selector' = kwargs.get('widget')
+    widget: pygame_menu.widgets.Selector = kwargs.get('widget')
     widget.update_font({'selected_color': color})
     widget.get_selection_effect().color = color
 
@@ -252,7 +252,7 @@ def open_link(*args) -> None:
         """
         Opens link.
         """
-        link: 'pygame_menu.widgets.MenuLink' = args[-1]
+        link: pygame_menu.widgets.MenuLink = args[-1]
         link.open()
 
 

docs/conf.py

@@ -13,6 +13,7 @@
 # -- Path setup ---------------------------------------------------------------
 
 import sys
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use pathlib to build absolute paths in a portable way.

pygame_menu/__pyinstaller/hook-pygame_menu.py

@@ -43,6 +43,7 @@ def _append_to_datas(file_path: str, target_folder: str, base_target_folder: Pat
 
 
 from pygame_menu.baseimage import IMAGE_EXAMPLES
+
 # Append data
 from pygame_menu.font import FONT_EXAMPLES
 from pygame_menu.sound import SOUND_EXAMPLES

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
@@ -63,7 +63,7 @@ def __repr__(self) -> str:
 
         return sup_repr
 
-    def _update__repr___(self, obj: 'Base') -> None:
+    def _update__repr___(self, obj: Base) -> None:
         """
         Update __repr__ from other Base object.
 
@@ -72,7 +72,7 @@ def _update__repr___(self, obj: 'Base') -> None:
         self._class_id__repr__ = obj._class_id__repr__
         self._id__repr__ = obj._id__repr__
 
-    def set_attribute(self, key: str, value: Any = None) -> 'Base':
+    def set_attribute(self, key: str, value: Any = None) -> Base:
         """
         Set an attribute.
 
@@ -147,7 +147,7 @@ def has_attribute(self, key: str) -> bool:
 
         return self._attributes is not None and key in self._attributes
 
-    def remove_attribute(self, key: str) -> 'Base':
+    def remove_attribute(self, key: str) -> Base:
         """
         Removes the given attribute from the object. Throws ``IndexError`` if
         the given key does not exist.

pygame_menu/_decorator.py

@@ -12,22 +12,36 @@
 __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
 import pygame.gfxdraw as gfxdraw
 
 import pygame_menu
 from pygame_menu._base import Base
-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)
+from pygame_menu._types import (
+    CallableNoArgsType,
+    ColorInputType,
+    NumberInstance,
+    NumberType,
+    Tuple2IntType,
+    Tuple2NumberType,
+)
+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
@@ -62,21 +76,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:
@@ -112,15 +126,15 @@ def __init__(
         self._cache_needs_update = {DECOR_TYPE_PREV: False, DECOR_TYPE_POST: False}
         self._cache_surface = {DECOR_TYPE_PREV: None, DECOR_TYPE_POST: None}
 
-    def __copy__(self) -> 'Decorator':
+    def __copy__(self) -> Decorator:
         """
         Copy method.
 
         :return: Raises copy exception
         """
         raise _DecoratorCopyException('Decorator class cannot be copied')
 
-    def __deepcopy__(self, memodict: dict[int, Any]) -> 'Decorator':
+    def __deepcopy__(self, memodict: dict[int, Any]) -> Decorator:
         """
         Deep-copy method.
 
@@ -180,7 +194,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 +210,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 +250,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,
@@ -396,7 +410,7 @@ def add_surface(
         self,
         x: NumberType,
         y: NumberType,
-        surface: 'pygame.Surface',
+        surface: pygame.Surface,
         prev: bool = True,
         centered: bool = False,
         **kwargs
@@ -427,7 +441,7 @@ def add_baseimage(
         self,
         x: NumberType,
         y: NumberType,
-        image: 'pygame_menu.BaseImage',
+        image: pygame_menu.BaseImage,
         prev: bool = True,
         centered: bool = False,
         **kwargs
@@ -463,7 +477,7 @@ def add_rect(
         self,
         x: NumberType,
         y: NumberType,
-        rect: 'pygame.Rect',
+        rect: pygame.Rect,
         color: ColorInputType,
         width: int = 0,
         prev: bool = True,
@@ -639,7 +653,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 +685,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,
@@ -811,7 +825,7 @@ def add_vline(
         assert y1 != y2
         return self.add_line((x, y1), (x, y2), color, width, prev, **kwargs)
 
-    def disable(self, decorid: str) -> 'Decorator':
+    def disable(self, decorid: str) -> Decorator:
         """
         Disable a certain decoration from ID. Raises ``IndexError`` if decoration was
         not found.
@@ -825,7 +839,7 @@ def disable(self, decorid: str) -> 'Decorator':
         self.force_cache_update(prev=decorid in self._decor_prev_id)
         return self
 
-    def enable(self, decorid: str) -> 'Decorator':
+    def enable(self, decorid: str) -> Decorator:
         """
         Enable a certain decoration from ID. Raises ``IndexError`` if decoration
         was not found.
@@ -851,7 +865,7 @@ def is_enabled(self, decorid: str) -> bool:
             raise IndexError(f'decoration<"{decorid}"> was not found')
         return self._decor_enabled[decorid]
 
-    def remove(self, decorid: str) -> 'Decorator':
+    def remove(self, decorid: str) -> Decorator:
         """
         Remove a decoration from a given ID. Raises ``IndexError`` if decoration
         was not found.
@@ -873,7 +887,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.
 
@@ -894,7 +908,7 @@ def _draw_assemble_cache(
         self,
         prev: str,
         deco: list[tuple[int, str, Any]],
-        surface: 'pygame.Surface'
+        surface: pygame.Surface
     ) -> None:
         """
         Draw cache, assemble if needed.
@@ -931,7 +945,7 @@ def _draw_assemble_cache(
 
         surface.blit(self._cache_surface[prev], (0, 0))
 
-    def draw_prev(self, surface: 'pygame.Surface') -> 'Decorator':
+    def draw_prev(self, surface: pygame.Surface) -> Decorator:
         """
         Draw prev.
 
@@ -944,7 +958,7 @@ def draw_prev(self, surface: 'pygame.Surface') -> 'Decorator':
             self._draw_assemble_cache(DECOR_TYPE_PREV, self._decor[DECOR_TYPE_PREV], surface)
         return self
 
-    def draw_post(self, surface: 'pygame.Surface') -> 'Decorator':
+    def draw_post(self, surface: pygame.Surface) -> Decorator:
         """
         Draw post.
 
@@ -957,7 +971,7 @@ def draw_post(self, surface: 'pygame.Surface') -> 'Decorator':
             self._draw_assemble_cache(DECOR_TYPE_POST, self._decor[DECOR_TYPE_POST], surface)
         return self
 
-    def _draw(self, deco: list[tuple[int, str, Any]], surface: 'pygame.Surface') -> None:
+    def _draw(self, deco: list[tuple[int, str, Any]], surface: pygame.Surface) -> None:
         """
         Draw.
 
@@ -1055,7 +1069,7 @@ def _draw(self, deco: list[tuple[int, str, Any]], surface: 'pygame.Surface') ->
                 surface.fill(data, rect)
 
             elif dtype == DECORATION_RECT:
-                d_rect: 'pygame.Rect'
+                d_rect: pygame.Rect
                 pos, d_rect, color, width, kwargs = data
                 pos = self._update_pos_list(rect, decoid, pos, **kwargs)[0]
                 d_rect = d_rect.copy()
@@ -1078,11 +1092,11 @@ def _draw(self, deco: list[tuple[int, str, Any]], surface: 'pygame.Surface') ->
 
     def _update_pos_list(
         self,
-        rect: 'pygame.Rect',
+        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.