Switch from black to ruff format (#2550)

* Improve make.py a bit

* ruff format changes on arcade

* Switch from black to ruff format

* Fix ruff-check in .github/workflows/test.yml

---------

Co-authored-by: Einar Forselv <eforselv@gmail.com>

Author: cdeil

.github/workflows/test.yml

@@ -36,6 +36,14 @@ jobs:
         id: wheel
         run: |
           python -m pip install -e .[dev]
+      - name: "code-inspection: formatting"
+        if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
+        run: |
+          python ./make.py format --check
+      - name: "code-inspection: ruff-check"
+        if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
+        run: | 
+          python ./make.py ruff-check
       - name: "code-inspection: mypy"
         if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
         run: | 
@@ -44,14 +52,6 @@ jobs:
         if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
         run: | 
           python ./make.py pyright
-      - name: "code-inspection: ruff"
-        if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
-        run: | 
-          python ./make.py ruff
-      - name: "code-inspection: formatting"
-        if: ${{ (success() || failure()) && steps.wheel.outcome == 'success' }}
-        run: |
-          python ./make.py format --check
       # Prepare the Pull Request Payload artifact. If this fails,
       # we fail silently using the `continue-on-error` option. It's
       # nice if this succeeds, but if it fails for any reason, it

CONTRIBUTING.md

@@ -81,24 +81,20 @@ steps at the end of this document.
 
 ## Formatting
 
-Arcade uses [Black](https://black.readthedocs.io/en/stable) for autoformatting our code.
+Arcade uses [ruff format](https://docs.astral.sh/ruff/formatter/) for autoformatting our code
+as well as sorting imports.
 
 This can be run both with our `make.py` script, as well as setup for your editor to run it automatically.
-See [this link](https://black.readthedocs.io/en/stable/integrations/editors.html) for more information on
-Black integration for your specific editor.
+See [this link](https://docs.astral.sh/ruff/editors/) for more information on ruff editor integration.
 
-The following command will run black for you if you do not want to configure your editor to do it. It can be
-a good idea to run this command when you are finished working anyway, as our CI will use this to check that
-the formatting is correct.
+The following command will run ``ruff format`` for you if you do not want to configure your editor to do it.
+It can be  a good idea to run this command when you are finished working anyway,
+as our CI will use this to check that the formatting is correct.
 
 ```bash
 python make.py format
 ```
 
-In addition to Black, this will sort the imports using [Ruff](https://docs.astral.sh/ruff/). If you want to set up
-your editor to run this, please see [this link](https://docs.astral.sh/ruff/integrations/) for more information on
-Ruff integration for your specific editor.
-
 Docstring should be formatted using [Google Style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
 
 The minium for docstrings is covering all parameters in an `Args:` block.

arcade/application.py

@@ -962,7 +962,7 @@ def show_view(self, new_view: View) -> None:
         """
         if not isinstance(new_view, View):
             raise TypeError(
-                f"Window.show_view() takes an arcade.View," f"but it got a {type(new_view)}."
+                f"Window.show_view() takes an arcade.View, but it got a {type(new_view)}."
             )
 
         self._ctx.screen.use()

arcade/camera/camera_2d.py

@@ -124,15 +124,15 @@ def __init__(
         if projection is not None:
             if left == right:
                 raise ZeroProjectionDimension(
-                    (f"projection width is 0 due to equal {left=}" f"and {right=} values")
+                    f"projection width is 0 due to equal {left=} and {right=} values"
                 )
             if bottom == top:
                 raise ZeroProjectionDimension(
-                    (f"projection height is 0 due to equal {bottom=}" f"and {top=}")
+                    f"projection height is 0 due to equal {bottom=} and {top=}"
                 )
         if near == far:
             raise ZeroProjectionDimension(
-                f"projection depth is 0 due to equal {near=}" f"and {far=} values"
+                f"projection depth is 0 due to equal {near=} and {far=} values"
             )
 
         pos_x = position[0] if position is not None else half_width
@@ -223,17 +223,17 @@ def from_camera_data(
             left, right = projection_data.left, projection_data.right
             if projection_data.left == projection_data.right:
                 raise ZeroProjectionDimension(
-                    (f"projection width is 0 due to equal {left=}" f"and {right=} values")
+                    (f"projection width is 0 due to equal {left=}and {right=} values")
                 )
             bottom, top = projection_data.bottom, projection_data.top
             if bottom == top:
                 raise ZeroProjectionDimension(
-                    (f"projection height is 0 due to equal {bottom=}" f"and {top=}")
+                    (f"projection height is 0 due to equal {bottom=}and {top=}")
                 )
             near, far = projection_data.near, projection_data.far
             if near == far:
                 raise ZeroProjectionDimension(
-                    f"projection depth is 0 due to equal {near=}" f"and {far=} values"
+                    f"projection depth is 0 due to equal {near=}and {far=} values"
                 )
 
         # build a new camera with defaults and then apply the provided camera objects.

arcade/camera/data_types.py

@@ -84,7 +84,6 @@ def __init__(
         forward: Point3 = (0.0, 0.0, -1.0),
         zoom: float = 1.0,
     ):
-
         self.position: tuple[float, float, float] = position
         """A 3D vector which describes where the camera is located."""
 
@@ -260,9 +259,7 @@ def lrbt(self, new_lrbt: tuple[float, float, float, float]):
         self.rect = LRBT(*new_lrbt)
 
     def __str__(self):
-        return (
-            f"OrthographicProjection<" f"LRBT={self.rect.lrbt}, " f"{self.near=}, " f"{self.far=}"
-        )
+        return f"OrthographicProjection<LRBT={self.rect.lrbt}, {self.near=}, {self.far=}>"
 
     def __repr__(self):
         return self.__str__()

arcade/camera/static.py

@@ -27,7 +27,6 @@
 
 
 class _StaticCamera:
-
     def __init__(
         self,
         view_matrix: Mat4,

arcade/draw/rect.py

@@ -187,10 +187,10 @@ def draw_lrbt_rectangle_outline(
         ValueError: Raised if left > right or top < bottom.
     """
     if left > right:
-        raise ValueError("Left coordinate must be less than or equal to " "the right coordinate")
+        raise ValueError("Left coordinate must be less than or equal to the right coordinate")
 
     if bottom > top:
-        raise ValueError("Bottom coordinate must be less than or equal to " "the top coordinate")
+        raise ValueError("Bottom coordinate must be less than or equal to the top coordinate")
 
     draw_rect_outline(LRBT(left, right, bottom, top), color, border_width)
 

arcade/experimental/atlas_render_into.py

@@ -10,7 +10,6 @@
 
 
 class AtlasRenderDemo(arcade.Window):
-
     def __init__(self):
         super().__init__(1280, 720, "Atlas Render Demo")
         self.atlas = arcade.DefaultTextureAtlas((600, 600))

arcade/experimental/atlas_replace_image.py

@@ -68,7 +68,6 @@
 
 
 class AtlasReplaceImage(arcade.Window):
-
     def __init__(self):
         super().__init__(800, 600, "Replacing images in atlas")
         self.sprite_1 = arcade.Sprite(TEXTURE_PATHS[-1], center_x=200, center_y=300)

arcade/experimental/geo_culling_check.py

@@ -16,7 +16,6 @@
 
 
 class GeoCullingTest(arcade.Window):
-
     def __init__(self):
         super().__init__(1280, 720, "Cull test", resizable=True)
         self.proj = 0, self.width, 0, self.height

arcade/experimental/perspective_parallax.py

@@ -20,7 +20,6 @@
 
 
 class PerspectiveParallax(arcade.Window):
-
     def __init__(self):
         super().__init__(SCREEN_WIDTH, SCREEN_HEIGHT, "Perspective Parallax")
         self.t = 0.0

arcade/experimental/postprocessing.py

@@ -54,7 +54,6 @@ def resize(self, size: tuple[int, int]):
 
 
 class GaussianBlurPass(PostProcessing):
-
     def __init__(self, size, kernel_size=5, sigma=2, multiplier=0, step=1):
         super().__init__(size)
         self._kernel_size = kernel_size

arcade/experimental/query_demo.py

@@ -12,7 +12,6 @@
 
 
 class MyGame(arcade.Window):
-
     def __init__(self, width, height, title):
         super().__init__(width, height, title)
         # vsync must be off when measuring rendering calls

arcade/experimental/render_offscreen_animated.py

@@ -63,7 +63,6 @@ def make_skyline(
     color_list = []
 
     while building_center_x < width:
-
         # Is there a gap between the buildings?
         if random.random() < gap_chance:
             gap_width = random.randrange(10, 50)

arcade/experimental/shadertoy_demo.py

@@ -7,7 +7,6 @@
 
 
 class MyGame(arcade.Window):
-
     def __init__(self, width, height, title):
         super().__init__(width, height, title, resizable=True)
         self.shadertoy = Shadertoy.create_from_file(

arcade/experimental/shadertoy_demo_simple.py

@@ -10,7 +10,6 @@
 
 
 class MyGame(arcade.Window):
-
     def __init__(self, width, height, title):
         super().__init__(width, height, title, resizable=True)
         self.shadertoy = Shadertoy(

arcade/experimental/shadertoy_textures.py

@@ -15,7 +15,6 @@
 
 
 class MyGame(arcade.Window):
-
     def __init__(self, width, height, title):
         super().__init__(width, height, title, resizable=True)
         self.shadertoy = Shadertoy(

arcade/experimental/shapes_perf.py

@@ -76,7 +76,6 @@ def random_radius(start=5, end=25):
 
 
 class GameWindow(arcade.Window):
-
     def __init__(self, width, height, title):
         super().__init__(width, height, title, antialiasing=True, resizable=True)
         self.set_vsync(False)

arcade/experimental/texture_transforms.py

@@ -18,7 +18,6 @@
 
 
 class App(arcade.Window):
-
     def __init__(self):
         super().__init__(1200, 600, "Atlas Revamp Check")
         paths = [

arcade/future/background/__init__.py

@@ -55,7 +55,6 @@ def background_from_file(
     shader: gl.Program | None = None,
     geometry: gl.Geometry | None = None,
 ) -> Background:
-
     texture = BackgroundTexture.from_file(tex_src, offset, scale, angle, filters)
     if size is None:
         size = texture.texture.size

arcade/future/input/input_manager_example.py

@@ -25,7 +25,6 @@
 
 
 class Player(arcade.Sprite):
-
     def __init__(
         self,
         texture,
@@ -58,7 +57,6 @@ def on_action(self, action: str, state: ActionState):
 
 
 class Game(arcade.Window):
-
     def __init__(
         self,
         player_textures: Sequence[str] = DEFAULT_TEXTURES,
@@ -76,7 +74,7 @@ def __init__(
 
         self._max_players = max_players
         self.key_to_player_index: dict[Keys, int] = {
-            getattr(Keys, f"KEY_{i + 1 }"): i for i in range(0, max_players)
+            getattr(Keys, f"KEY_{i + 1}"): i for i in range(0, max_players)
         }
 
         self.players: list[Player | None] = []
@@ -201,7 +199,6 @@ def on_draw(self):
         self.device_labels_batch.draw()
 
     def on_key_press(self, key, modifiers):
-
         player_index = self.key_to_player_index.get(Keys(key), None)
         if player_index is None or player_index >= len(self.players):
             return

arcade/future/input/input_mapping.py

@@ -7,7 +7,6 @@
 
 
 class Action:
-
     def __init__(self, name: str) -> None:
         self.name = name
         self._mappings: set[ActionMapping] = set()
@@ -20,7 +19,6 @@ def remove_mapping(self, mapping: ActionMapping) -> None:
 
 
 class Axis:
-
     def __init__(self, name: str) -> None:
         self.name = name
         self._mappings: set[AxisMapping] = set()
@@ -51,7 +49,6 @@ def __init__(self, input: inputs.InputEnum):
 
 
 class ActionMapping(InputMapping):
-
     def __init__(
         self,
         input: inputs.InputEnum,
@@ -71,7 +68,6 @@ def __init__(
 
 
 class AxisMapping(InputMapping):
-
     def __init__(self, input: inputs.InputEnum, scale: float):
         super().__init__(input)
         self._scale = scale

arcade/future/input/manager.py

@@ -64,7 +64,6 @@ class InputDevice(Enum):
 
 
 class InputManager:
-
     def __init__(
         self,
         controller: Controller | None = None,

arcade/gl/buffer.py

@@ -56,7 +56,6 @@ def __init__(
         reserve: int = 0,
         usage: str = "static",
     ):
-
         self._ctx = ctx
         self._glo = glo = gl.GLuint()
         self._size = -1

arcade/isometric.py

@@ -33,7 +33,6 @@ def screen_to_isometric_grid(
 def create_isometric_grid_lines(
     width: int, height: int, tile_width: int, tile_height: int, color: RGBA255, line_width: int
 ) -> ShapeElementList:
-
     # Grid lines 1
     shape_list: ShapeElementList = ShapeElementList()
 

arcade/math.py

@@ -388,8 +388,7 @@ def rescale_relative_to_point(source: Point2, target: Point2, factor: AsFloat |
                 return target
         except ValueError:
             raise ValueError(
-                "factor must be a float, int, or tuple-like "
-                "which unpacks as two float-like values"
+                "factor must be a float, int, or tuple-like which unpacks as two float-like values"
             )
         except TypeError:
             raise TypeError(

arcade/perf_graph.py

@@ -320,7 +320,6 @@ def update_graph(self, delta_time: float) -> None:
         # Render to the internal texture
         # This ugly spacing is intentional to make type checking work.
         with atlas.render_into(self.minimap_texture, projection=self.proj) as fbo:  # type: ignore
-
             # Set the background color
             fbo.clear(color=self.background_color)
 

arcade/physics_engines.py

@@ -115,15 +115,13 @@ def _move_sprite(
     # --- Rotate
     rotating_hit_list = []
     if moving_sprite.change_angle:
-
         # Rotate
         moving_sprite.angle += moving_sprite.change_angle
 
         # Resolve collisions caused by rotating
         rotating_hit_list = check_for_collision_with_lists(moving_sprite, can_collide)
 
         if len(rotating_hit_list) > 0:
-
             max_distance = (moving_sprite.width + moving_sprite.height) / 2
 
             # Resolve any collisions by this weird kludge
@@ -199,7 +197,6 @@ def _move_sprite(
 
         exit_loop = False
         while not exit_loop:
-
             loop_count += 1
             # print(f"{cur_x_change=}, {upper_bound=}, {lower_bound=}, {loop_count=}")
 
@@ -782,7 +779,6 @@ def update(self) -> list[BasicSprite]:
         for platform_list in self.platforms:
             for platform in platform_list:
                 if platform.change_x != 0 or platform.change_y != 0:
-
                     # Check x boundaries and move the platform in x direction
                     if platform.boundary_left and platform.left <= platform.boundary_left:
                         platform.left = platform.boundary_left