Use ruff to also sort imports (#3237)

* sort imports with ruff

* sorted imports (that's a lot of modified files)

* some more dev.py alling ig

* reconfigure the hooks to be more concise

* future-proofing? ruff lint config, sth like that

* combine as imports for ruff isort

* rerun import sorting after configuration update

* Select only the I rule

* Update pyproject.toml

* add the missing import and rewrite the method as how it is typically written elsewhere (e.g., the CPython repository)

* add spaces around [] for consistency

* some more unformatted files

* exclude python files in buildconfig only

* format and sort imports for buildconfig/stubs/pygame

* ignore .ruff_cache

* ignore typing.pyi explicitly since it's supposed to be an exact copy of typing.py

* ignore import sorting in stubs __init__.py only as it's auto-generated

---------

Co-authored-by: Dan Lawrence <[email protected]>

Author: Matiiss

.gitignore

@@ -32,6 +32,9 @@
 # mypy
 .mypy_cache/
 
+# Ruff
+.ruff_cache
+
 # Other
 envdev*
 .virtualenv*

.pre-commit-config.yaml

@@ -28,6 +28,9 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.4.2
     hooks:  # See pyproject.toml for configuration options.
+      - id: ruff
+        name: ruff-sort-imports
+        args: [ --select, I, --fix ]
       - id: ruff-format  # Run the formatter
         types_or: [ python, pyi, jupyter ]
 

buildconfig/stubs/gen_stubs.py

@@ -128,6 +128,7 @@ def get_all(mod: Any):
     # write the module docstring of this file in the generated file, so that
     # people know this file exists
     f.write(info_header)
+    f.write("# ruff: noqa: I001\n")
     f.write(misc_stubs)
 
     for mod, items in pygame_all_imports.items():

buildconfig/stubs/pygame/__init__.pyi

@@ -1,6 +1,7 @@
 # buildconfig/stubs/gen_stubs.py
 # A script to auto-generate locals.pyi, constants.pyi and __init__.pyi typestubs
 # IMPORTANT NOTE: Do not edit this file by hand!
+# ruff: noqa: I001
 
 from . import (
     display as display,

buildconfig/stubs/pygame/_debug.pyi

@@ -1,8 +1,10 @@
 from collections.abc import Callable
-from typing import Union, Optional
+from typing import Optional, Union
 
 ImportResult = tuple[str, bool, Optional[Callable]]
 
 def str_from_tuple(version_tuple: Union[tuple[int, int, int], None]) -> str: ...
-def attempt_import(module: str, function_name: str, output_str: str = "") -> ImportResult: ...
+def attempt_import(
+    module: str, function_name: str, output_str: str = ""
+) -> ImportResult: ...
 def print_debug_info(filename: Optional[str] = None) -> None: ...

buildconfig/stubs/pygame/_sdl2/controller.pyi

@@ -1,12 +1,12 @@
 from typing import final
+
 from pygame.joystick import JoystickType
 
 def init() -> None: ...
 def get_init() -> bool: ...
 def quit() -> None: ...
 def is_controller(device_index: int) -> bool: ...
 def get_count() -> int: ...
-
 @final
 class Controller:
     def __new__(cls, device_index: int) -> Controller: ...

buildconfig/stubs/pygame/_sdl2/touch.pyi

@@ -1,4 +1,4 @@
-from typing import TypedDict, Optional
+from typing import Optional, TypedDict
 
 class _FingerDict(TypedDict):
     id: int

buildconfig/stubs/pygame/_sdl2/video.pyi

@@ -4,10 +4,9 @@ from typing import Any, Optional, Union
 from pygame.color import Color
 from pygame.rect import Rect
 from pygame.surface import Surface
+from pygame.typing import ColorLike, Point, RectLike
 from pygame.window import Window as Window
 
-from pygame.typing import ColorLike, RectLike, Point
-
 WINDOWPOS_UNDEFINED: int
 WINDOWPOS_CENTERED: int
 
@@ -160,18 +159,10 @@ class Renderer:
     def draw_point(self, point: Point) -> None: ...
     def draw_rect(self, rect: RectLike) -> None: ...
     def fill_rect(self, rect: RectLike) -> None: ...
-    def draw_triangle(
-        self, p1: Point, p2: Point, p3: Point
-    ) -> None: ...
-    def fill_triangle(
-        self, p1: Point, p2: Point, p3: Point
-    ) -> None: ...
-    def draw_quad(
-        self, p1: Point, p2: Point, p3: Point, p4: Point
-    ) -> None: ...
-    def fill_quad(
-        self, p1: Point, p2: Point, p3: Point, p4: Point
-    ) -> None: ...
+    def draw_triangle(self, p1: Point, p2: Point, p3: Point) -> None: ...
+    def fill_triangle(self, p1: Point, p2: Point, p3: Point) -> None: ...
+    def draw_quad(self, p1: Point, p2: Point, p3: Point, p4: Point) -> None: ...
+    def fill_quad(self, p1: Point, p2: Point, p3: Point, p4: Point) -> None: ...
     def to_surface(
         self, surface: Optional[Surface] = None, area: Optional[RectLike] = None
     ) -> Surface: ...

buildconfig/stubs/pygame/camera.pyi

@@ -1,9 +1,8 @@
 from abc import ABC, abstractmethod
-from typing import Optional, Union, Literal
-
-from pygame.typing import IntPoint
+from typing import Literal, Optional, Union
 
 from pygame.surface import Surface
+from pygame.typing import IntPoint
 
 def get_backends() -> list[str]: ...
 def init(backend: Optional[str] = None) -> None: ...

buildconfig/stubs/pygame/color.pyi

@@ -1,8 +1,8 @@
 from collections.abc import Collection, Iterator
 from typing import Any, ClassVar, SupportsIndex, Union, overload
-from typing_extensions import deprecated  # added in 3.13
 
 from pygame.typing import ColorLike
+from typing_extensions import deprecated  # added in 3.13
 
 THECOLORS: dict[str, tuple[int, int, int, int]]