Upgrade tooling to use ruff+black over isort/black (#59)

AbstractUmbra · web-flow · commit 8a527d9ffb57 · 2023-10-21T10:22:38.000+10:00
* Add recommended extensions for tooling

* update deps for ruff

* run ruff

* add git blame ignore revs

* fix gh action to use ruff
diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,2 @@
+# run ruff
+174ab9e3d7bc643805ac97acf71a225dd9523977
diff --git a/.github/workflows/coverage_and_lint.yml b/.github/workflows/coverage_and_lint.yml
@@ -71,13 +71,5 @@ jobs:
           no-comments: ${{ matrix.python-version != '3.x' }}
 
       - name: Lint
-        uses: github/super-linter/slim@v4
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DEFAULT_BRANCH: main
-          VALIDATE_ALL_CODEBASE: false
-          VALIDATE_PYTHON_BLACK: true
-          VALIDATE_PYTHON_ISORT: true
-          LINTER_RULES_PATH: /
-          PYTHON_ISORT_CONFIG_FILE: pyproject.toml
-          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
+        if: ${{ always() && steps.install-deps.outcome == 'success' }}
+        uses: chartboost/ruff-action@v1
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "ms-python.black-formatter"
+    ]
+}
diff --git a/README.md b/README.md
@@ -43,6 +43,11 @@ which will enable all services and snekbox.
 
 This also means that it will use internal docker networking to resolve the database and snekbox names. By default these will be `database` and `snekbox`, but these will be the **service names** in `docker-compose.yml` if you change them. Please keep this in mind when editing your config file.
 
+We also provide a file for ignoring git blame references. You can enable this with:-
+```sh
+git config blame.ignoreRevsFile .git-blame-ignore-revs
+```
+
 ### Support
 
 As this bot is not really designed for use outside of our Guild, support provided will be **very** limited.
diff --git a/constants/__init__.py b/constants/__init__.py
@@ -22,5 +22,4 @@
 """
 from .constants import *
 
-
 GUILD_ID: int = 490948346773635102
diff --git a/constants/_meta.py b/constants/_meta.py
@@ -26,7 +26,6 @@
 
 import toml
 
-
 if TYPE_CHECKING:
     from typing_extensions import Self
 
diff --git a/constants/constants.py b/constants/constants.py
@@ -22,7 +22,6 @@
 """
 from ._meta import CONSTANTS
 
-
 __all__ = (
     "Roles",
     "Colours",
diff --git a/core/bot.py b/core/bot.py
@@ -31,24 +31,24 @@
 from collections import deque
 from typing import TYPE_CHECKING, Any
 
-import aiohttp
-import asyncpg
 import discord
 from discord.ext import commands
-from discord.ext.commands.cog import Cog  # type: ignore # stubs
 
 from constants import GUILD_ID
 
 from .context import Context
 from .core import CONFIG
-from .utils import LogHandler
-
 
 if TYPE_CHECKING:
     from asyncio import Queue
     from logging import LogRecord
 
+    import aiohttp
+    import asyncpg
     import mystbin
+    from discord.ext.commands.cog import Cog  # type: ignore # stubs
+
+    from .utils import LogHandler
 
 
 class Bot(commands.Bot):
@@ -67,7 +67,7 @@ class Bot(commands.Bot):
         "_previous_websocket_events",
     )
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__(
             command_prefix=commands.when_mentioned_or(CONFIG["prefix"]),
             intents=discord.Intents.all(),
diff --git a/core/checks.py b/core/checks.py
@@ -27,12 +27,12 @@
 from discord.ext import commands
 
 import constants
-from core.context import GuildContext
-
 
 if TYPE_CHECKING:
     from discord.ext.commands._types import Check  # type: ignore # why would this need stubs
 
+    from core.context import GuildContext
+
 
 def is_role_or_higher(role_id: int) -> Check[Any]:
     def predicate(ctx: GuildContext) -> bool:
diff --git a/core/context.py b/core/context.py
@@ -7,7 +7,6 @@
 
 from constants import GUILD_ID, Roles
 
-
 if TYPE_CHECKING:
     from .bot import Bot
 
diff --git a/core/converters.py b/core/converters.py
@@ -27,7 +27,6 @@
 
 from core.context import Context
 
-
 __all__ = ("Codeblock", "CodeblockConverter")
 
 
diff --git a/core/core.py b/core/core.py
@@ -27,7 +27,6 @@
 import toml
 from discord.ext import commands
 
-
 if TYPE_CHECKING:
     from types_.config import Config
 
diff --git a/core/enums.py b/core/enums.py
@@ -1,6 +1,5 @@
 from discord.enums import Enum
 
-
 __all__ = ("DiscordPyModerationEvent",)
 
 
diff --git a/core/errors.py b/core/errors.py
@@ -20,7 +20,6 @@
 """
 from discord.ext import commands
 
-
 __all__ = ("InvalidEval",)
 
 
diff --git a/core/utils/formatters.py b/core/utils/formatters.py
@@ -25,7 +25,6 @@
 from discord import Colour
 from discord.utils import escape_markdown
 
-
 __all__ = (
     "to_codeblock",
     "random_pastel_colour",
@@ -38,7 +37,7 @@ def to_codeblock(
     replace_existing: bool = True,
     escape_md: bool = True,
     new: str = "'''",
-):
+) -> str:
     """
     Quick function to put our content into a Discord accepted codeblock.
     """
diff --git a/core/utils/logging.py b/core/utils/logging.py
@@ -9,7 +9,6 @@
 
 import core
 
-
 if TYPE_CHECKING:
     from typing_extensions import Self
 
diff --git a/core/utils/paginator.py b/core/utils/paginator.py
@@ -30,13 +30,12 @@
 from discord.ext.commands import CommandError, Paginator as _Paginator  # type: ignore # why does this need a stub file?
 from discord.utils import MISSING
 
-from core import Bot, Context
-
-
 if TYPE_CHECKING:
     from discord.abc import MessageableChannel
     from typing_extensions import Self
 
+    from core import Bot, Context
+
 
 __all__ = ("CannotPaginate", "Pager", "KVPager", "TextPager")
 
@@ -63,7 +62,7 @@ def __init__(
         author_url: str | None = None,
         stop: bool = False,
         reply_author_takes_paginator: bool = False,
-    ):
+    ) -> None:
         super().__init__()
         self.bot: Bot = ctx.bot
         self.stoppable: bool = stop
@@ -117,7 +116,7 @@ def __init__(
     def setup_buttons(self) -> None:
         self.clear_items()
         for emoji, button in self.reaction_emojis:
-            btn = ui.Button[Self](emoji=emoji)
+            btn = ui.Button["Self"](emoji=emoji)
             btn.callback = button  # type: ignore
             self.add_item(btn)
 
@@ -175,7 +174,7 @@ async def show_page(
 
         self.message = await self.channel.send(content=content, embed=embed, view=self)
 
-    async def checked_show_page(self, page: int):
+    async def checked_show_page(self, page: int) -> None:
         if page != 0 and page <= self.maximum_pages:
             await self.show_page(page)
 
@@ -226,7 +225,7 @@ def message_check(m: discord.Message) -> bool:
         except (AttributeError, discord.HTTPException):
             pass
 
-    async def stop_pages(self, interaction: discord.Interaction | None = None):
+    async def stop_pages(self, interaction: discord.Interaction | None = None) -> None:
         """stops the interactive pagination session"""
         if self.delete_after and self.message:
             await self.message.delete()
@@ -235,7 +234,7 @@ async def stop_pages(self, interaction: discord.Interaction | None = None):
 
     stop = stop_pages  # type: ignore
 
-    def _check(self, interaction: discord.Interaction):
+    def _check(self, interaction: discord.Interaction) -> bool:
         if interaction.user.id != self.author.id:
             return False
 
@@ -249,7 +248,7 @@ async def interaction_check(self, interaction: discord.Interaction) -> bool:
 
         return resp
 
-    async def paginate(self, msg_kwargs: dict[str, Any] | None = None):
+    async def paginate(self, msg_kwargs: dict[str, Any] | None = None) -> None:
         if self.maximum_pages > 1:
             self.paginating = True
 
@@ -276,7 +275,7 @@ def __init__(
         title: str | None = None,
         embed_color: discord.Colour = discord.Colour.blurple(),
         **kwargs: Any,
-    ):
+    ) -> None:
         super().__init__(
             ctx,
             entries=entries,
@@ -288,7 +287,7 @@ def __init__(
         )
         self.description = description
 
-    def prepare_embed(self, entries: list[Any], page: int, *, first: bool = False):
+    def prepare_embed(self, entries: list[Any], page: int, *, first: bool = False) -> None:
         self.embed.clear_fields()
         self.embed.description = self.description or MISSING
         self.embed.title = self.title or MISSING
diff --git a/modules/__init__.py b/modules/__init__.py
@@ -1,7 +1,6 @@
 import pathlib
 from pkgutil import ModuleInfo, iter_modules
 
-
 _ext: list[ModuleInfo] = []
 _ext.extend(
     [
diff --git a/modules/admin.py b/modules/admin.py
@@ -28,7 +28,6 @@
 from constants import GUILD_ID
 from core.context import Context
 
-
 LOGGER = logging.getLogger(__name__)
 
 
diff --git a/modules/api.py b/modules/api.py
@@ -37,7 +37,6 @@
     PAPIWebsocketSubscriptions,
 )
 
-
 LOGGER = logging.getLogger(__name__)
 
 
@@ -69,7 +68,7 @@ async def cog_unload(self) -> None:
             try:
                 self.connection_task.cancel()
             except Exception as e:
-                LOGGER.error(f'Unable to cancel Pythonista API connection_task in "cog_unload": {e}')
+                LOGGER.error('Unable to cancel Pythonista API connection_task in "cog_unload": %s', e)
 
         if self.is_connected():
             assert self.websocket
@@ -79,7 +78,7 @@ async def cog_unload(self) -> None:
             try:
                 self.keep_alive_task.cancel()
             except Exception as e:
-                LOGGER.error(f'Unable to cancel Pythonista API keep_alive_task in "cog_unload": {e}')
+                LOGGER.error('Unable to cancel Pythonista API keep_alive_task in "cog_unload": %s', e)
 
     def dispatch(self, *, data: dict[str, Any]) -> None:
         subscription: str = data["subscription"]
@@ -99,7 +98,7 @@ async def connect(self) -> None:
             try:
                 self.keep_alive_task.cancel()
             except Exception as e:
-                LOGGER.warning(f"Failed to cancel Pythonista API Websocket keep alive. This is likely not a problem: {e}")
+                LOGGER.warning("Failed to cancel Pythonista API Websocket keep alive. This is likely not a problem: %s", e)
 
         while True:
             try:
@@ -109,13 +108,13 @@ async def connect(self) -> None:
                     LOGGER.critical("Unable to connect to Pythonista API Websocket, due to an incorrect token.")
                     return
                 else:
-                    LOGGER.error(f"Unable to connect to Pythonista API Websocket: {e}.")
+                    LOGGER.error("Unable to connect to Pythonista API Websocket: %s.", e)
 
             if self.is_connected():
                 break
             else:
                 delay: float = self.backoff.delay()  # type: ignore
-                LOGGER.warning(f'Retrying Pythonista API Websocket connection in "{delay}" seconds.')
+                LOGGER.warning("Retrying Pythonista API Websocket connection in '%s' seconds.", delay)
 
                 await asyncio.sleep(delay)
 
@@ -149,7 +148,7 @@ async def keep_alive(self) -> None:
             op: int | None = data.get("op")
 
             if op == PAPIWebsocketOPCodes.HELLO:
-                LOGGER.debug(f'Received HELLO from Pythonista API: user={data["user_id"]}')
+                LOGGER.debug("Received HELLO from Pythonista API: user=%s", data["user_id"])
 
             elif op == PAPIWebsocketOPCodes.EVENT:
                 self.dispatch(data=data)
@@ -159,12 +158,12 @@ async def keep_alive(self) -> None:
 
                 if type_ == PAPIWebsocketNotificationTypes.SUBSCRIPTION_ADDED:
                     subscribed: str = ", ".join(data["subscriptions"])
-                    LOGGER.info(f"Pythonista API added our subscription, currently subscribed: `{subscribed}`")
+                    LOGGER.info("Pythonista API added our subscription, currently subscribed: `%s`", subscribed)
                 elif type_ == PAPIWebsocketNotificationTypes.SUBSCRIPTION_REMOVED:
                     subscribed: str = ", ".join(data["subscriptions"])
-                    LOGGER.info(f"Pythonista API removed our subscription, currently subscribed: `{subscribed}`")
+                    LOGGER.info("Pythonista API removed our subscription, currently subscribed: `%s`", subscribed)
                 elif type_ == PAPIWebsocketNotificationTypes.UNKNOWN_OP:
-                    LOGGER.info(f'We sent an UNKNOWN OP to Pythonista API: `{data["received"]}`')
+                    LOGGER.info("We sent an UNKNOWN OP to Pythonista API: `%s`", data["received"])
 
             else:
                 LOGGER.info("Received an UNKNOWN OP from Pythonista API.")
diff --git a/modules/eval.py b/modules/eval.py
@@ -33,7 +33,6 @@
 from core.errors import InvalidEval
 from core.utils import formatters
 
-
 LOGGER = logging.getLogger(__name__)
 
 
diff --git a/modules/github.py b/modules/github.py
@@ -31,7 +31,6 @@
 import constants
 import core
 
-
 GITHUB_ISSUE_URL = "https://github.com/{}/issues/{}"
 LIB_ISSUE_REGEX = re.compile(r"(?P<lib>[a-z]+)?(?P<pounds>#{2,})(?P<number>[0-9]+)", flags=re.IGNORECASE)
 GITHUB_CODE_REGION_REGEX = re.compile(
@@ -166,8 +165,9 @@ async def format_highlight_block(self, url: str, line_adjustment: int = 10) -> d
 
         github_dict = {
             "path": file_path,
-            "min": (_min_boundary if _min_boundary > 0 else highlighted_line - 1)
-            + 1,  # Do not display negative numbers if <0
+            "min": (
+                _min_boundary if _min_boundary > 0 else highlighted_line - 1
+            ) + 1,  # Do not display negative numbers if <0
             "max": _max_boundary + 1,
             "msg": msg,
         }
@@ -182,7 +182,7 @@ def _smart_guess_lib(self, msg: discord.Message) -> LibEnum | None:
             return None  # there's not much hope here, stay quick
 
         if isinstance(msg.channel, discord.Thread) and msg.channel.parent_id == constants.Channels.HELP_FORUM:
-            tags = set(x.name for x in msg.channel.applied_tags)
+            tags = {x.name for x in msg.channel.applied_tags}
 
             if "twitchio-help" in tags:
                 return LibEnum.twitchio
diff --git a/modules/help.py b/modules/help.py
diff --git a/modules/info.py b/modules/info.py
diff --git a/modules/logging.py b/modules/logging.py
diff --git a/modules/manuals.py b/modules/manuals.py
diff --git a/modules/moderation.py b/modules/moderation.py
diff --git a/modules/suggestions.py b/modules/suggestions.py
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/types_/config.py b/types_/config.py
diff --git a/types_/papi.py b/types_/papi.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# run ruff`
	`2`	`+174ab9e3d7bc643805ac97acf71a225dd9523977`