Merge pull request #2824 from cclauss/ruff-format-instead-of-black

ankith26 · web-flow · commit 810b1eb82fe4 · 2024-05-08T12:22:45.000+05:30
Format Python code with ruff format instead of black
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -5,20 +5,14 @@
 # Then in the project root directory run `pre-commit install`
 
 repos:
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.3.0
-    hooks:
-      - id: black
-        exclude: |
-            (?x)^(
-                ^buildconfig/.*$
-                | ^docs/reST/.*$
-                | setup.py
-            )$
-
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.2
+    hooks:  # See pyproject.toml for configuration options.
+      - id: ruff-format  # Run the formatter
+        types_or: [ python, pyi, jupyter ]
 
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v18.1.2
+    rev: v18.1.4
     hooks:
       - id: clang-format
         exclude: |
diff --git a/examples/aliens.py b/examples/aliens.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.aliens
+"""pygame.examples.aliens
 
 Shows a mini game where you have to defend against aliens.
 
diff --git a/examples/arraydemo.py b/examples/arraydemo.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.arraydemo
+"""pygame.examples.arraydemo
 
 Welcome to the arraydemo!
 
diff --git a/examples/audiocapture.py b/examples/audiocapture.py
@@ -1,11 +1,12 @@
 #!/usr/bin/env python
-""" pygame.examples.audiocapture
+"""pygame.examples.audiocapture
 
 A pygame 2 experiment.
 
 * record sound from a microphone
 * play back the recorded sound
 """
+
 import pygame
 import time
 
diff --git a/examples/blend_fill.py b/examples/blend_fill.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.blend_fill
+"""pygame.examples.blend_fill
 
 BLEND_ing colors in different ways with Surface.fill().
 
@@ -10,6 +10,7 @@
 * A - ADD, S- SUB, M- MULT, - MIN, + MAX to change the blend modes
 
 """
+
 import os
 import pygame
 from pygame import K_1, K_2, K_3, K_4, K_5, K_6, K_7, K_8, K_9
diff --git a/examples/blit_blends.py b/examples/blit_blends.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.blit_blends
+"""pygame.examples.blit_blends
 
 Blending colors in different ways with different blend modes.
 
@@ -19,6 +19,7 @@
 * 1, 2, 3, 4 - use different images.
 
 """
+
 import os
 import pygame
 import time
diff --git a/examples/camera.py b/examples/camera.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.camera
+"""pygame.examples.camera
 
 Basic image capturing and display using pygame.camera
 
@@ -11,6 +11,7 @@
 - 9, start camera 9.
 - 10, start camera... wait a minute! There's not 10 key!
 """
+
 import pygame
 import pygame.camera
 
diff --git a/examples/chimp.py b/examples/chimp.py
@@ -1,13 +1,12 @@
 #!/usr/bin/env python
-""" pygame.examples.chimp
+"""pygame.examples.chimp
 
 This simple example is used for the line-by-line tutorial
 that comes with pygame. It is based on a 'popular' web banner.
 Note there are comments here, but for the full explanation,
 follow along in the tutorial.
 """
 
-
 # Import Modules
 import os
 import pygame
diff --git a/examples/cursors.py b/examples/cursors.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.cursors
+"""pygame.examples.cursors
 Click a button and the cursor will change.
 This example will show you:
 *The different types of cursors that exist
diff --git a/examples/dropevent.py b/examples/dropevent.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.dropfile
+"""pygame.examples.dropfile
 
 Drag and drop an image on here.
 
@@ -10,6 +10,7 @@
 * DROPTEXT
 * DROPFILE
 """
+
 import pygame
 
 pygame.init()
diff --git a/examples/eventlist.py b/examples/eventlist.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.eventlist
+"""pygame.examples.eventlist
 
 Learn about pygame events and input.
 
diff --git a/examples/font_viewer.py b/examples/font_viewer.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.font_viewer
+"""pygame.examples.font_viewer
 Scroll through your system fonts from a list of surfaces or one huge buffer.
 
 This example exhibits:
@@ -22,6 +22,7 @@
 * Press up or down to scroll
 * Press escape to exit
 """
+
 import sys
 import os
 
diff --git a/examples/fonty.py b/examples/fonty.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.fonty
+"""pygame.examples.fonty
 
 Here we load a .TTF True Type font file, and display it in
 a basic pygame window.
@@ -8,6 +8,7 @@
 
 - basic window, event, and font management.
 """
+
 import pygame
 
 
diff --git a/examples/freetype_misc.py b/examples/freetype_misc.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.freetype_misc
+"""pygame.examples.freetype_misc
 
 
 Miscellaneous (or misc) means:
@@ -29,6 +29,7 @@
 
 Enjoy!
 """
+
 import os
 import pygame
 import pygame.freetype as freetype
diff --git a/examples/glcube.py b/examples/glcube.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.glcube
+"""pygame.examples.glcube
 
 Draw a cube on the screen.
 
@@ -23,6 +23,7 @@
 * f key to toggle fullscreen.
 
 """
+
 import math
 import ctypes
 
diff --git a/examples/go_over_there.py b/examples/go_over_there.py
@@ -1,4 +1,4 @@
-""" pygame.examples.go_over_there
+"""pygame.examples.go_over_there
 This simple tech demo is showcasing the use of Vector2.move_towards()
 using multiple circles to represent Vectors. Each circle will have a
 random position and speed once the demo starts.
diff --git a/examples/headless_no_windows_needed.py b/examples/headless_no_windows_needed.py
@@ -1,12 +1,13 @@
 #!/usr/bin/env python
-""" pygame.examples.headless_no_windows_needed
+"""pygame.examples.headless_no_windows_needed
 
 How to use pygame-ce with no windowing system, like on headless servers.
 
 Thumbnail generation with scaling is an example of what you can do with pygame.
 NOTE: the pygame scale function uses mmx/sse if available, and can be run
   in multiple threads.
 """
+
 usage = """-scale inputimage outputimage new_width new_height
 eg.  -scale in.png out.png 50 50
 
diff --git a/examples/liquid.py b/examples/liquid.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.liquid
+"""pygame.examples.liquid
 
 This example demonstrates a simplish water effect of an
 image. It attempts to create a hardware display surface that
diff --git a/examples/midi.py b/examples/midi.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.midi
+"""pygame.examples.midi
 
 midi input, and a separate example of midi output.
 
diff --git a/examples/moveit.py b/examples/moveit.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.moveit
+"""pygame.examples.moveit
 
 This is the full and final example from the Pygame Tutorial,
 "How Do I Make It Move". It creates 10 objects and animates
@@ -11,6 +11,7 @@
 Fortunately, this is python, and we needn't wrestle with a pile of
 error codes.
 """
+
 import os
 import pygame
 
diff --git a/examples/music_drop_fade.py b/examples/music_drop_fade.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.music_drop_fade
+"""pygame.examples.music_drop_fade
 Fade in and play music from a list while observing several events
 
 Adds music files to a playlist whenever played by one of the following methods
diff --git a/examples/pixelarray.py b/examples/pixelarray.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.pixelarray
+"""pygame.examples.pixelarray
 
 PixelArray does array processing of pixels.
 Sort of like another array processor called 'numpy' - But for pixels.
@@ -13,6 +13,7 @@
 
 To see different effects - press a key or click a mouse.
 """
+
 import os
 import pygame
 
diff --git a/examples/playmus.py b/examples/playmus.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.playmus
+"""pygame.examples.playmus
 
 A simple music player.
 
@@ -17,6 +17,7 @@
 q     - stop
 
 """
+
 import sys
 
 import pygame
diff --git a/examples/prevent_display_stretching.py b/examples/prevent_display_stretching.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.prevent_display_stretching
+"""pygame.examples.prevent_display_stretching
 
 Prevent display stretching on Windows.
 
diff --git a/examples/scaletest.py b/examples/scaletest.py
@@ -1,9 +1,10 @@
 #!/usr/bin/env python
-""" pygame.examples.scaletest
+"""pygame.examples.scaletest
 
 Shows an interactive image scaler.
 
 """
+
 import sys
 import time
 import pygame as pygame
diff --git a/examples/scrap_clipboard.py b/examples/scrap_clipboard.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.scrap_clipboard
+"""pygame.examples.scrap_clipboard
 
 Demonstrates the clipboard capabilities of pygame.
 
@@ -13,7 +13,6 @@
 
 """
 
-
 import pygame
 
 
diff --git a/examples/scroll.py b/examples/scroll.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.scroll
+"""pygame.examples.scroll
 
 An zoomed image viewer that demonstrates Surface.scroll
 
@@ -14,6 +14,7 @@
 the triangle points. Or use the arrow keys. Close the window or press ESC
 to quit.
 """
+
 import sys
 import os
 
diff --git a/examples/setmodescale.py b/examples/setmodescale.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.setmodescale
+"""pygame.examples.setmodescale
 
 On high resolution displays(4k, 1080p) and tiny graphics games (640x480)
 show up very small so that they are unplayable. SCALED scales up the window
diff --git a/examples/sound.py b/examples/sound.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.sound
+"""pygame.examples.sound
 
 Playing a soundfile and waiting for it to finish. You'll need the
 pygame.mixer module for this to work. Note how in this simple example
@@ -8,6 +8,7 @@
 
 Optional command line argument: audio file name
 """
+
 import os
 import sys
 import pygame
diff --git a/examples/sound_array_demos.py b/examples/sound_array_demos.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.sound_array_demos
+"""pygame.examples.sound_array_demos
 
 Creates an echo effect on any Sound object.
 
@@ -13,6 +13,7 @@
 - put into a function.
 - Uses numpy by default, but falls back on Numeric.
 """
+
 import os
 import pygame
 from numpy import zeros, int32, int16
diff --git a/examples/sprite_texture.py b/examples/sprite_texture.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.sprite_texture
+"""pygame.examples.sprite_texture
 
 Experimental! Uses APIs which may disappear in the next release (_sdl2 is private).
 
@@ -9,6 +9,7 @@
 _sdl2.video.Image is a backwards compatible way with to use Texture with
 pygame.sprite groups.
 """
+
 import os
 import pygame
 
diff --git a/examples/stars.py b/examples/stars.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-""" pygame.examples.stars
+"""pygame.examples.stars
 
 We are all in the gutter,
 but some of us are looking at the stars.
diff --git a/examples/testsprite.py b/examples/testsprite.py
diff --git a/examples/textinput.py b/examples/textinput.py
diff --git a/examples/vgrade.py b/examples/vgrade.py
diff --git a/examples/video.py b/examples/video.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/src_py/__init__.py b/src_py/__init__.py
diff --git a/src_py/_debug.py b/src_py/_debug.py
diff --git a/src_py/colordict.py b/src_py/colordict.py
diff --git a/src_py/sprite.py b/src_py/sprite.py
diff --git a/src_py/surfarray.py b/src_py/surfarray.py
diff --git a/src_py/sysfont.py b/src_py/sysfont.py
diff --git a/test/cursors_test.py b/test/cursors_test.py
diff --git a/test/font_test.py b/test/font_test.py
diff --git a/test/freetype_test.py b/test/freetype_test.py
diff --git a/test/rwobject_test.py b/test/rwobject_test.py
