ci: Add ruff and build workflows

Author: CaedenPH

.github/workflows/ruff.yml

@@ -0,0 +1,16 @@
+# https://beta.ruff.rs
+name: ruff
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - run: pip install --user ruff
+    - run: ruff --format=github .

.github/workflows/run.yml

@@ -0,0 +1,23 @@
+name: "run"
+
+on:
+  push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements.txt
+          python -m pip install disnake-docs disnake-debug
+          python -m pip install pytest
+      - name: Run main file
+        run: python main.py
+      - name: Run tests
+        run: pytest .
+      

.pre-commit-config.yaml

@@ -2,20 +2,52 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
+      - id: check-executables-have-shebangs
       - id: check-toml
       - id: check-yaml
       - id: end-of-file-fixer
+        types: [python]
       - id: trailing-whitespace
-        args: [--markdown-linebreak-ext=md]
+      - id: requirements-txt-fixer
 
-  - repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
+  - repo: https://github.com/MarcoGorelli/auto-walrus
+    rev: v0.2.2
     hooks:
-      - id: python-check-blanket-noqa
+    -   id: auto-walrus
 
-  - repo: https://github.com/pycqa/flake8
-    rev: 6.0.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.0.270
     hooks:
-      - id: flake8
-        # additional_dependencies:
-        #   - flake8-docstrings~=1.6.0
+      - id: ruff
+
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
+
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: "0.11.2"
+    hooks:
+      - id: pyproject-fmt
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.13
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.3.0
+    hooks:
+      - id: mypy
+        args:
+          - --ignore-missing-imports
+          - --install-types # See mirrors-mypy README.md
+          - --non-interactive
+        additional_dependencies: [types-requests]

cogs/config.py

@@ -49,9 +49,7 @@ async def jokechannel(self, ctx: Context, channel: disnake.TextChannel = None):
             channel = await ctx.guild.create_text_channel(name="Joke Channel")
 
         await self.insert_values(channel.id, "joke")
-        await send_embed(
-            ctx, None, channel.mention + " now sends jokes on the hour!"
-        )
+        await send_embed(ctx, None, channel.mention + " now sends jokes on the hour!")
 
     @command()
     @has_permissions(manage_channels=True)
@@ -60,9 +58,7 @@ async def quotechannel(self, ctx: Context, channel: disnake.TextChannel = None):
             channel = await ctx.guild.create_text_channel(name="Joke Channel")
 
         await self.insert_values(channel.id, "quote")
-        await send_embed(
-            ctx, None, channel.mention + " now sends quotes on the hour!"
-        )
+        await send_embed(ctx, None, channel.mention + " now sends quotes on the hour!")
 
     @command()
     @has_permissions(manage_channels=True)
@@ -71,9 +67,7 @@ async def factchannel(self, ctx: Context, channel: disnake.TextChannel = None):
             channel = await ctx.guild.create_text_channel(name="Joke Channel")
 
         await self.insert_values(channel.id, "fact")
-        await send_embed(
-            ctx, None, channel.mention + " now sends facts on the hour!"
-        )
+        await send_embed(ctx, None, channel.mention + " now sends facts on the hour!")
 
     @command(
         aliases=["Welcomer", "welcome"],
@@ -83,7 +77,6 @@ async def factchannel(self, ctx: Context, channel: disnake.TextChannel = None):
     async def welcomechannel(
         self, ctx: Context, role: disnake.Role = "", *, message: str = ""
     ):
-
         with open("./dicts/Welcome.json", "r+") as f:
             data = json.load(f)
             if not role:
@@ -110,7 +103,8 @@ async def welcomechannel(
             await ctx.reply(embed=embed)
 
     @command(
-        aliases=["Unwelcome", "Stop_Welcome"], description="Removes the j.welcome command"
+        aliases=["Unwelcome", "Stop_Welcome"],
+        description="Removes the j.welcome command",
     )
     async def remove_welcome(self, ctx: Context):
         with open("./dicts/Welcome.json", "r+") as f:
@@ -130,7 +124,6 @@ async def suggestchannel(self, ctx: Context, channel: disnake.TextChannel):
         with open("./dicts/Suggest.json", "r+") as k:
             data = json.load(k)
             if str(channel.id) not in data:
-
                 data[str(channel.id)] = {"Yes": True}
                 update_json(k, data)
                 if channel.id != ctx.channel.id:
@@ -187,7 +180,6 @@ async def verifychannel(
             ).content
         ).lower()
         if received_msg != "y":
-
             embed = disnake.Embed(title="Goodbye!", colour=get_colour())
             return await ctx.reply(embed=embed)
 
@@ -198,14 +190,14 @@ async def verifychannel(
                 if "Yes" in data[key]:
                     if data[key]["Yes"]:
                         if data[key]["Guild"] == ctx.guild.id:
-
                             return await ctx.reply("There is already a verify here!")
         if not channel:
             channel = await ctx.guild.create_text_channel(name="⚘ verify ⚘")
         with open("./dicts/VerifyChannel.json", "r+") as k:
             if role is None:
                 await ctx.guild.create_role(
-                    name="⚘ Member ⚘", permissions=disnake.Permissions(send_messages=True)
+                    name="⚘ Member ⚘",
+                    permissions=disnake.Permissions(send_messages=True),
                 )
             membrole = disnake.utils.get(ctx.guild.roles, name="⚘ Member ⚘")
             await ctx.guild.create_role(
@@ -222,7 +214,6 @@ async def verifychannel(
                         read_messages=False,
                     )
                 else:
-
                     await x.set_permissions(
                         membrole,
                         speak=True,
@@ -270,7 +261,6 @@ async def verifychannel(
                                 read_messages=False,
                             )
                         else:
-
                             await z.set_permissions(
                                 g,
                                 speak=True,
@@ -311,7 +301,6 @@ async def verifychannel(
     @command(aliases=["remverify"], description="removes the need for a verification")
     @has_permissions(administrator=True)
     async def removeverify(self, ctx: Context):
-
         with open("./dicts/VerifyChannel.json", "r+") as k:
             data = json.load(k)
             for key in data:
@@ -332,9 +321,10 @@ async def leavechannel(self, ctx: Context, channel: disnake.TextChannel = None):
                     ctx, "Leaving", "This server is already registered!"
                 )
             else:
-
                 if not channel:
-                    channel = await ctx.guild.create_text_channel(name="Leaving Channel")
+                    channel = await ctx.guild.create_text_channel(
+                        name="Leaving Channel"
+                    )
                 data[str(ctx.guild.id)] = {"id": channel.id}
                 update_json(k, data)
         await send_embed(
@@ -345,7 +335,6 @@ async def leavechannel(self, ctx: Context, channel: disnake.TextChannel = None):
     @command()
     async def removeleavechannel(self, ctx: Context, channel: disnake.TextChannel):
         with open("./dicts/LeaveChannel.json", "r+") as k:
-
             data = json.load(k)
             if str(ctx.guild.id) not in data:
                 return await send_embed(

cogs/countries.py

@@ -50,7 +50,7 @@ async def findcountry(self, ctx: Context, *, name):
         y = []
         async with self.bot.client.get("https://restcountries.eu/rest/v2/all") as resp:
             x = await resp.json()
-            for (num, k) in enumerate(x):
+            for num, k in enumerate(x):
                 if x[num]["name"].lower().startswith(name[:1]):
                     y.append(x[num]["name"])
         await send_embed(ctx, "Countries relating to " + name, ", ".join(y))

cogs/crime.py

@@ -61,7 +61,7 @@ async def jailbase(
             json = await resp.json()
 
         choice = random.randint(0, len(json["records"]))
-        info = json["records"][choice]
+        json["records"][choice]
         await ctx.em(
             re.sub(
                 "\n{2,}",
@@ -95,7 +95,7 @@ async def police(self, ctx: Context) -> None:
         ) as resp:
             json = await resp.json()
 
-        police = ", ".join(json[k]["name"] for k in range(0, len(json)))
+        ", ".join(json[k]["name"] for k in range(0, len(json)))
         await ctx.em(
             """```yaml
         ++ -- All police forces in england -- ++

cogs/docs/cog.py

@@ -48,7 +48,9 @@ async def rtfm(self, ctx: Context, query):
 
     @commands.command()
     async def pypi(self, ctx: Context, package):
-        embed = disnake.Embed(title="", description="").set_thumbnail(url=self.PYPI_ICON)
+        embed = disnake.Embed(title="", description="").set_thumbnail(
+            url=self.PYPI_ICON
+        )
         async with self.bot.client.get(self.URL.format(package=package)) as response:
             if response.status == 404:
                 embed.description = "Package could not be found."
@@ -68,7 +70,9 @@ async def pypi(self, ctx: Context, package):
                     embed.description = "No summary provided."
 
             else:
-                embed.description = "There was an error when fetching your PyPi package."
+                embed.description = (
+                    "There was an error when fetching your PyPi package."
+                )
         await ctx.reply(embed=embed)
 
     @commands.command(aliases=["tags"])
@@ -102,7 +106,8 @@ async def zen(self, ctx: Context, search: int = None) -> None:
         if len(lines) > search:
             return await ctx.reply(
                 embed=disnake.Embed(
-                    title=f"The Zen of Python - Line {search}", description=lines[search]
+                    title=f"The Zen of Python - Line {search}",
+                    description=lines[search],
                 )
             )
 

cogs/docs/exts.py

@@ -102,11 +102,13 @@ def parse_object_inv(self, stream, url):
 
     async def build_rtfm_lookup_table(self, page_types):
         cache = {}
-        for (key, page) in page_types.items():
+        for key, page in page_types.items():
             cache[key] = {}
             async with self.bot.client.get(page + "/objects.inv") as resp:
                 if resp.status != 200:
-                    raise RuntimeError("Cannot build rtfm lookup table, try again later.")
+                    raise RuntimeError(
+                        "Cannot build rtfm lookup table, try again later."
+                    )
 
                 stream = SphinxObjectFileReader(await resp.read())
                 cache[key] = self.parse_object_inv(stream, page)

cogs/docs/fuzzy.py

@@ -20,7 +20,7 @@ def partial_ratio(a, b):
     blocks = m.get_matching_blocks()
 
     scores = []
-    for (i, j, n) in blocks:
+    for i, j, n in blocks:
         start = max(j - i, 0)
         end = start + len(short)
         o = SequenceMatcher(None, short, long[start:end])
@@ -61,7 +61,7 @@ def partial_token_sort_ratio(a, b):
 
 def _extraction_generator(query, choices, scorer=quick_ratio, score_cutoff=0):
     try:
-        for (key, value) in choices.items():
+        for key, value in choices.items():
             score = scorer(query, key)
             if score >= score_cutoff:
                 yield (key, score, value)

cogs/docs/menus.py

@@ -96,8 +96,7 @@ def _cast_emoji(obj, *, _custom_emoji=_custom_emoji):
         return obj
 
     obj = str(obj)
-    match = _custom_emoji.match(obj)
-    if match is not None:
+    if (match := _custom_emoji.match(obj)) is not None:
         groups = match.groupdict()
         animated = bool(groups["animated"])
         emoji_id = int(groups["id"])
@@ -258,15 +257,15 @@ def __new__(cls, name, bases, attrs, **kwargs):
         if inherit_buttons:
             # walk MRO to get all buttons even in subclasses
             for base in reversed(new_cls.__mro__):
-                for (elem, value) in base.__dict__.items():
+                for elem, value in base.__dict__.items():
                     try:
                         value.__menu_button__
                     except AttributeError:
                         continue
                     else:
                         buttons.append(value)
         else:
-            for (elem, value) in attrs.items():
+            for elem, value in attrs.items():
                 try:
                     value.__menu_button__
                 except AttributeError:
@@ -325,9 +324,8 @@ def __init__(
         delete_message_after=False,
         clear_reactions_after=False,
         check_embeds=False,
-        message=None
+        message=None,
     ):
-
         self.timeout = timeout
         self.delete_message_after = delete_message_after
         self.clear_reactions_after = clear_reactions_after
@@ -963,7 +961,9 @@ def should_add_reactions(self):
         return self._source.is_paginating()
 
     async def _get_kwargs_from_page(self, page):
-        value = await disnake.utils.maybe_coroutine(self._source.format_page, self, page)
+        value = await disnake.utils.maybe_coroutine(
+            self._source.format_page, self, page
+        )
         if isinstance(value, dict):
             return value
         elif isinstance(value, str):
@@ -1129,7 +1129,7 @@ def __init__(self, entries, *, key, per_page, sort=True):
         self.__entries = entries if not sort else sorted(entries, key=key)
         nested = []
         self.nested_per_page = per_page
-        for (k, g) in itertools.groupby(self.__entries, key=key):
+        for k, g in itertools.groupby(self.__entries, key=key):
             g = list(g)
             if not g:
                 continue