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