[All] Replace Black & Isort with Ruff (config files + reformatting).

Author: AAA3A-AAA3A

.github/workflows/rust.yml

@@ -0,0 +1,22 @@
+name: Ruff
+
+on:
+	push:
+	pull_request:
+	workflow_dispatch:
+
+jobs:
+	ruff:
+		runs-on: ubuntu-latest
+		steps:
+			- name: Checkout repository
+				uses: actions/checkout@v4
+
+			- name: Set up Ruff
+				uses: astral-sh/ruff-action@v3
+
+			- name: Run Ruff format
+				run: ruff format
+
+			- name: Run Ruff check
+				run: ruff check --fix --unsafe-fixes

.github/workflows/scripts/loadcheck.py

@@ -3,7 +3,7 @@
 import subprocess
 import sys
 import time
-from typing import Any, Dict, Tuple
+from typing import Any
 
 from dotenv import load_dotenv
 from jsonrpc_websocket import Server
@@ -55,18 +55,18 @@
     cogs.append(cog.lower())
 
 
-async def leswebsockets() -> Tuple[Dict[str, Any], Dict[str, Any]]:
+async def leswebsockets() -> tuple[dict[str, Any], dict[str, Any]]:
     print("Connecting to Red via RPC")
 
     server = Server("ws://localhost:6133")
     try:
         await server.ws_connect()
 
         print("Loading cogs")
-        load_results: Dict[str, Any] = await server.CORE__LOAD(cogs)
+        load_results: dict[str, Any] = await server.CORE__LOAD(cogs)
         await asyncio.sleep(1)
         print("Unloading cogs")
-        unload_results: Dict[str, Any] = await server.CORE__UNLOAD(cogs)
+        unload_results: dict[str, Any] = await server.CORE__UNLOAD(cogs)
     finally:
         await server.close()
 

.github/workflows/scripts/syncutils.py

@@ -3,12 +3,10 @@
 
 import datetime
 import json
-import os
 import shutil
 from pathlib import Path
 
 import git
-import requests
 from git import Repo
 
 README_MD_TEXT = """## My utils
@@ -26,13 +24,14 @@
 
 utils_repo_clone_location = Path("temp-utils-repo")
 utils_repo = Repo.clone_from(
-    "https://github.com/AAA3A-AAA3A/AAA3A_utils.git", utils_repo_clone_location
+    "https://github.com/AAA3A-AAA3A/AAA3A_utils.git",
+    utils_repo_clone_location,
 )
 
 utils_location = utils_repo_clone_location / "AAA3A_utils"
 
 readme = README_MD_TEXT.format(
-    time=datetime.datetime.now(tz=datetime.timezone.utc).strftime("%Y-%m-%d %H:%M:%S %Z"),
+    time=datetime.datetime.now(tz=datetime.UTC).strftime("%Y-%m-%d %H:%M:%S %Z"),
     commit=utils_repo.head.commit,
 )
 

.sourcery.yaml

@@ -1,15 +1,17 @@
-from redbot.core import errors  # isort:skip
 import importlib
 import sys
 
+from redbot.core import errors
+
 try:
     import AAA3A_utils
 except ModuleNotFoundError:
     raise errors.CogLoadError(
-        "The needed utils to run the cog were not found. Please execute the command `[p]pipinstall git+https://github.com/AAA3A-AAA3A/AAA3A_utils.git`. A restart of the bot isn't necessary."
+        "The needed utils to run the cog were not found. Please execute the command `[p]pipinstall git+https://github.com/AAA3A-AAA3A/AAA3A_utils.git`. A restart of the bot isn't necessary.",
     )
 modules = sorted(
-    [module for module in sys.modules if module.split(".")[0] == "AAA3A_utils"], reverse=True
+    [module for module in sys.modules if module.split(".")[0] == "AAA3A_utils"],
+    reverse=True,
 )
 for module in modules:
     try:
@@ -33,7 +35,7 @@
 #         "The needed utils to run the cog has a lower version than the one supported by this version of the cog. Please execute the command `[p]pipinstall --upgrade git+https://github.com/AAA3A-AAA3A/AAA3A_utils.git`. A restart of the bot isn't necessary."
 #     )
 
-from redbot.core.bot import Red  # isort:skip
+from redbot.core.bot import Red
 from redbot.core.utils import get_end_user_data_statement
 
 from .acronymgame import AcronymGame

acronymgame/__init__.py

@@ -1,8 +1,8 @@
-from AAA3A_utils import Cog  # isort:skip
-from redbot.core import commands  # isort:skip
-from redbot.core.i18n import Translator, cog_i18n  # isort:skip
-import discord  # isort:skip
-import typing  # isort:skip
+import discord
+
+from AAA3A_utils import Cog
+from redbot.core import commands
+from redbot.core.i18n import Translator, cog_i18n
 
 from .view import AcronymGameView
 
@@ -20,7 +20,7 @@ class AcronymGame(Cog):
     """Play a random match of Acrononym game, with Modals!"""
 
     @property
-    def games(self) -> typing.Dict[discord.Message, AcronymGameView]:
+    def games(self) -> dict[discord.Message, AcronymGameView]:
         return self.views
 
     @commands.guild_only()

acronymgame/acronymgame.py

@@ -10,5 +10,6 @@
     ],
     "requirements": ["git+https://github.com/AAA3A-AAA3A/AAA3A_utils.git", "prettytable"],
     "min_bot_version": "3.5.0",
+    "min_python_version": [3, 10, 0],
     "end_user_data_statement": "This cog does not persistently store data or metadata about users."
 }

acronymgame/info.json

@@ -1,15 +1,15 @@
-from redbot.core import commands  # isort:skip
-from redbot.core.i18n import Translator  # isort:skip
-import discord  # isort:skip
-import typing  # isort:skip
-
 import asyncio
 import datetime
 import random
 import string
+import typing
 from collections import Counter
 
+import discord
 from prettytable import PrettyTable
+
+from redbot.core import commands
+from redbot.core.i18n import Translator
 from redbot.core.utils.chat_formatting import box, humanize_list
 
 _: Translator = Translator("AcronymGame", __file__)
@@ -21,7 +21,9 @@ def __init__(self, parent: discord.ui.View) -> None:
         self._parent: discord.ui.View = parent
         self.answer: discord.ui.TextInput = discord.ui.TextInput(
             label=_("Answer for {acronym} acronym").format(acronym=self._parent.acronym),
-            placeholder=_("Your full name for {acronym} acronym").format(acronym=self._parent.acronym),
+            placeholder=_("Your full name for {acronym} acronym").format(
+                acronym=self._parent.acronym,
+            ),
             default=None,
             style=discord.TextStyle.short,
             custom_id="description",
@@ -37,26 +39,25 @@ async def on_submit(self, interaction: discord.Interaction) -> None:
         if interaction.user in self._parent.players:
             await interaction.response.send_message(
                 _("You have already joined this game, with `{answer}` answer.").format(
-                    answer=self._parent.players[interaction.user]
+                    answer=self._parent.players[interaction.user],
                 ),
                 ephemeral=True,
             )
             return
         if len(self._parent.players) >= 20:
-            await interaction.response.send_message(
-                _("Sorry, maximum 20 players."), ephemeral=True
-            )
+            await interaction.response.send_message(_("Sorry, maximum 20 players."), ephemeral=True)
             return
         if self._parent._mode != "join":
             await interaction.response.send_message(
-                _("Sorry, the vote has already started."), ephemeral=True
+                _("Sorry, the vote has already started."),
+                ephemeral=True,
             )
             return
         answer = self.answer.value.strip()
         if len(answer.split(" ")) != len(self._parent.acronym):
             await interaction.response.send_message(
                 _("Sorry, the number of words in your answer must be {len_words}.").format(
-                    len_words=len(self._parent.acronym)
+                    len_words=len(self._parent.acronym),
                 ),
                 ephemeral=True,
             )
@@ -65,7 +66,7 @@ async def on_submit(self, interaction: discord.Interaction) -> None:
             if answer.split(" ")[i][0].upper() != letter.upper():
                 await interaction.response.send_message(
                     _(
-                        "Sorry, the initial of each word in your answer must be each letter of the acronym ({acronym})."
+                        "Sorry, the initial of each word in your answer must be each letter of the acronym ({acronym}).",
                     ).format(acronym=self._parent.acronym),
                     ephemeral=True,
                 )
@@ -77,20 +78,22 @@ async def on_submit(self, interaction: discord.Interaction) -> None:
         for num, (__, answer) in enumerate(self._parent.players.items()):
             table.add_row([num + 1, answer])
         embed.description = _(
-            "Join the game by clicking on the button below and entering your acronym. Maximum 20 players.\n"
+            "Join the game by clicking on the button below and entering your acronym. Maximum 20 players.\n",
         ) + box(str(table), lang="py")
         self._parent._message: discord.Message = await self._parent._message.edit(embed=embed)
         await interaction.response.send_message(
-            _("Game joined with `{answer}` answer.").format(answer=answer), ephemeral=True
+            _("Game joined with `{answer}` answer.").format(answer=answer),
+            ephemeral=True,
         )
 
 
 class AnswerSelect(discord.ui.Select):
-    def __init__(self, parent: discord.ui.View, players: typing.Dict[discord.Member, int]) -> None:
+    def __init__(self, parent: discord.ui.View, players: dict[discord.Member, int]) -> None:
         self._parent: discord.ui.View = parent
         self._options = [
             discord.SelectOption(
-                label=f"{answer[:97]}..." if len(answer) > 100 else answer, value=str(num + 1)
+                label=f"{answer[:97]}..." if len(answer) > 100 else answer,
+                value=str(num + 1),
             )
             for num, (_, answer) in enumerate(players.items())
         ]
@@ -115,24 +118,29 @@ def __init__(
         self.cog: commands.Cog = cog
 
         self.acronym: str = None
-        self.players: typing.Dict[discord.Member, str] = {}
+        self.players: dict[discord.Member, str] = {}
         self.votes: Counter[int, int] = Counter()
 
         self._message: discord.Message = None
-        self._voters: typing.Dict[discord.Member, int] = {}
+        self._voters: dict[discord.Member, int] = {}
         self._mode: typing.Literal["join", "vote"] = None
 
     async def start(self, ctx: commands.Context) -> discord.Message:
         self.ctx: commands.Context = ctx
         self.acronym: str = self.get_acronym()
         embed: discord.Embed = discord.Embed(
             title=_("Acronym Game"),
-            description=_("Click the button below to **join the party**! Please note that the maximum amount of players is **20**."),
+            description=_(
+                "Click the button below to **join the party**! Please note that the maximum amount of players is **20**.",
+            ),
             color=await self.ctx.embed_color(),
         )
         embed.add_field(name=_("Random Acronym:"), value=self.acronym)
         end_time = int((datetime.datetime.now() + datetime.timedelta(seconds=120)).timestamp())
-        embed.add_field(name=_("End time for joining:"), value=f"<t:{end_time}:T> (<t:{end_time}:R>)")
+        embed.add_field(
+            name=_("End time for joining:"),
+            value=f"<t:{end_time}:T> (<t:{end_time}:R>)",
+        )
         embed.set_author(
             name=_("Hosted by {host.display_name}").format(host=self.ctx.author),
             icon_url=self.ctx.author.display_avatar,
@@ -146,9 +154,7 @@ async def start(self, ctx: commands.Context) -> discord.Message:
         if len(self.players) < 3:
             await self.on_timeout()
             self.stop()
-            raise commands.UserFeedbackCheckFailure(
-                _("At least three players are needed to play!")
-            )
+            raise commands.UserFeedbackCheckFailure(_("At least three players are needed to play!"))
         table = PrettyTable()
         table.field_names = ["#", "Answer"]
         for num, (__, answer) in enumerate(self.players.items()):
@@ -158,7 +164,7 @@ async def start(self, ctx: commands.Context) -> discord.Message:
             color=await self.ctx.embed_color(),
         )
         embed.description = _(
-            "Use the dropdown below to vote for the best answer for the random acronym. All guild members can vote.\n"
+            "Use the dropdown below to vote for the best answer for the random acronym. All guild members can vote.\n",
         ) + box(str(table), lang="py")
         embed.add_field(name="Random Acronym", value=self.acronym)
         end_time = int((datetime.datetime.now() + datetime.timedelta(seconds=60)).timestamp())
@@ -195,20 +201,20 @@ async def start(self, ctx: commands.Context) -> discord.Message:
                     ),
                     answer,
                     self.votes[list(self.players).index(player) + 1],
-                ]
+                ],
             )
         embed: discord.Embed = discord.Embed(
-            title="Acronym Game", color=await self.ctx.embed_color()
-        )
-        embed.description = _("Here is the leaderboard for this game:") + box(
-            str(table), lang="py"
+            title="Acronym Game",
+            color=await self.ctx.embed_color(),
         )
+        embed.description = _("Here is the leaderboard for this game:") + box(str(table), lang="py")
         embed.add_field(name="Random Acronym", value=self.acronym)
         self._message: discord.Message = await self._message.edit(embed=embed, view=self)
         await self._message.reply(
             _("Winner{s}: {winners}!").format(
-                winners=humanize_list(winners), s="s" if len(winners) > 1 else ""
-            )
+                winners=humanize_list(winners),
+                s="s" if len(winners) > 1 else "",
+            ),
         )
         return self._message
 
@@ -228,32 +234,39 @@ def get_acronym(self) -> str:
         return "".join(
             [
                 random.choice(string.ascii_uppercase) for __ in range(4)
-            ]  # range(random.choice(range(4, 5)))
+            ],  # range(random.choice(range(4, 5)))
         )
 
     @discord.ui.button(label="Join Game", emoji="🎮", style=discord.ButtonStyle.success)
     async def join_button(
-        self, interaction: discord.Interaction, button: discord.ui.Button
+        self,
+        interaction: discord.Interaction,
+        button: discord.ui.Button,
     ) -> None:
         modal = JoinGameModal(self)
         await interaction.response.send_modal(modal)
 
     async def _callback(
-        self, interaction: discord.Interaction, option: discord.SelectOption
+        self,
+        interaction: discord.Interaction,
+        option: discord.SelectOption,
     ) -> None:
         if interaction.user in self._voters:
             await interaction.response.send_message(
-                _("You have already voted in this game."), ephemeral=True
+                _("You have already voted in this game."),
+                ephemeral=True,
             )
             return
         value = int(option.value)
         if interaction.user == list(self.players)[value - 1]:
             await interaction.response.send_message(
-                _("You can't vote for yourself."), ephemeral=True
+                _("You can't vote for yourself."),
+                ephemeral=True,
             )
             return
         self._voters[interaction.user] = value
         self.votes[value] += 1
         await interaction.response.send_message(
-            _("Vote given for answer {num}.").format(num=value), ephemeral=True
+            _("Vote given for answer {num}.").format(num=value),
+            ephemeral=True,
         )