😡Ruff it up x4

Author: Aluerie

ext/custom_commands.py

@@ -77,7 +77,7 @@ async def event_message(self, message: twitchio.ChatMessage) -> None:
     @commands.is_moderator()
     @commands.group(invoke_fallback=True)
     async def cmd(self, ctx: commands.Context) -> None:
-        """Group command to define cmd"""
+        """Group command to define cmd."""
         await ctx.send('You need to use this with subcommands, i.e. "cmd add/delete/edit/list"')
 
     @commands.is_moderator()
@@ -93,7 +93,7 @@ async def add(self, ctx: commands.Context, cmd_name: str, *, text: str) -> None:
             await self.bot.pool.execute(query, ctx.broadcaster.id, cmd_name, text)
         except asyncpg.UniqueViolationError:
             msg = "There already exists a command with such name."
-            raise errors.BadArgumentError(msg)
+            raise errors.BadArgumentError(msg) from None
 
         self.command_cache.setdefault(ctx.broadcaster.id, {})[cmd_name] = text
         await ctx.send(f"Added the command {cmd_name}.")
@@ -139,7 +139,7 @@ async def cmd_list(self, ctx: commands.Context) -> None:
         """Get commands list."""
         cache_list = [f"!{name}" for v in self.command_cache.values() for name in v]
         # bot_cmds = [
-        #     f"!{v.full_name}" for v in self.bot.commands.values() if not v._checks and not isinstance(v, commands.Group)
+        # f"!{v.full_name}" for v in self.bot.commands.values() if not v._checks and not isinstance(v, commands.Group)
         # ]
         await ctx.send(", ".join(cache_list))
 

ext/dev.py

@@ -36,10 +36,9 @@ async def maintenance(self, ctx: commands.Context) -> None:
         await ctx.send("Shutting down the bot in 3 2 1")
         await asyncio.sleep(3)
         try:
-            # non systemctl users - sorry
-            os.system("sudo systemctl stop luebot")
-        except Exception as error:
-            log.error(error, stack_info=True)
+            await asyncio.create_subprocess_shell("sudo systemctl stop luebot")  # `os.system`
+        except Exception:
+            log.exception("Failed to Stop the bot's process", stack_info=True)
             # it might not go off
             await ctx.send("Something went wrong.")
 

ext/logs_via_webhook.py

@@ -97,7 +97,7 @@ async def send_log_record(self, record: logging.LogRecord) -> None:
 
         emoji = attributes.get(record.levelname, "\N{WHITE QUESTION MARK ORNAMENT}")
         dt = datetime.datetime.fromtimestamp(record.created, datetime.UTC)
-        msg = textwrap.shorten(f"{emoji} {discord.utils.format_dt(dt, style="T")} {record.message}", width=1995)
+        msg = textwrap.shorten(f"{emoji} {discord.utils.format_dt(dt, style='T')} {record.message}", width=1995)
         avatar_url = self.AVATAR_MAPPING.get(record.name, discord.utils.MISSING)
         username = record.name.replace("discord", "disсοrd")  # cSpell: ignore disсοrd  # noqa: RUF003
         await self.bot.logger_webhook.send(msg, username=username, avatar_url=avatar_url)

ext/misc_commands.py

@@ -29,10 +29,9 @@ async def erdoc(self, ctx: commands.Context) -> None:
     async def run(self, ctx: commands.Context) -> None:
         """Explanation of my first Sekiro hitless run."""
         msg = (
-            "All Memories & Unique MiniBosses (so no repetitions). "
+            "All Memories & Unique MiniBosses (so no repetitions) & save-file for Inner+Shura. "
             "The idea: I have to learn and practice all boss move-sets. "
-            "Even load Inner Father, Fire Isshin and Emma save-file. "
-            "Almost Charmless (take it back pre-demon). Mostly Sword+Shuriken (~29/37 boss fights). "
+            "Almost Charmless (take it back pre-demon). Mostly Sword+Shuriken (~31/39 boss fights). "
             "Somewhat loop-less. For more look !notes."
         )
         await ctx.send(msg)

pyproject.toml

@@ -105,21 +105,32 @@ select = [
     "DOC"       # Doc strings, kinda annoying for a bot, to be honest
 ]
 ignore = [
+    # General disagreement with Ruff
     "ANN401",   # `Any` is the correct type in some cases
-    "ASYNC109", # dpy commonly uses this parameter
+    "ASYNC109", # dpy and other libraries commonly use this parameter
     "ASYNC116", # Long sleeps are fine
     "C90",      # mc cabe complexity memes
     "F401",     # unused imports
     "F403",     # wildcard imports: `from math import *` are used in __init__.py a lot
-    "F405",     # wildcard imports
-    "INP001",   # due to how I load modules this results in annoyances
+    "F405",     # wildcard imports are not that bad
+    "INP001",   # due to how we load modules this results in annoyances
     "PLC0415",  # ruff gets this wrong, import needs to be not at top of file in some cases
+    "RUF001",   # ambiguous characters not something I want to enforce here.
+    "S101",     # use of assert here is a known quantity, blame typing memes
+    "S311",     # Yes, standard pseudo-random generators are not suitable for cryptographic purposes so what
+    "TRY003",   # over-eager rule
+    "TRY301",   # unrealistic rule
+    
+    # Personal problems
+    "PLR0904",  # too many public methods
     "PLR0912",  # too many branches
     "PLR0913",  # number of function arguments
     "PLR0914",  # too many variables: come on
     "PLR0915",  # too many statements: come on, not everything is solvable in <50 lines.
+    "PLR0917",  # too many positional arguments
+    "PLR2004",  # Magic value comparison, may remove later
     "PLR6301",  # discord.py uses `self` even if I don't
-    "S101",     # use of assert here is a known quantity, blame typing memes
+    "S608",     # I use f-strings with SQL and I don't know better;
 
     # OLD RULES
     # "F401",
@@ -133,15 +144,16 @@ ignore = [
     # "UP038",
 
     # DOC STRINGS
-    # 1. General doc string exceptions
+    # general doc string exceptions
     "D100",     # Missing docstring in module: no, module level docs aren't always needed
     "D105",     # Missing docstring in magic method: documenting magic methods is often dumb.
     "D107",     # Missing docstring in `__init__`: __init__ is the wrong place to doc this.
-    "D401",     # Doc should be starting with an imperative verb: dumb rule, to be honest.
-    # 2. Exceptions for this bot because it's pointless to document *everything* in one-man project.
+    "D401",     # Doc should be starting with an imperative verb: dumb rule tbh.
+    # doc string exceptions 
+    # for this bot because it's a bot and it's pointless to document *everything* in one-man project.
     "DOC201",   # `return` is not documented in docstring
     "DOC501",   # raised exception is missing from docstring
-    
+
     # "D104",    # Missing docstring in public package. Otherwise spams __init__.py and such.
     # "D417",    # Missing argument description. Otherwise, it keeps asking to document interaction/context args.
     # "D203", # one-blank-line-before-class

utils/__init__.py

@@ -1 +0,0 @@
-

utils/fuzzy.py

@@ -6,6 +6,12 @@
     https://github.com/Rapptz/RoboDanny/blob/rewrite/cogs/utils/fuzzy.py
 * Helpful article:
     http://chairnerd.seatgeek.com/fuzzywuzzy-fuzzy-string-matching-in-python/
+
+Notes
+-----
+* Unfortunately, Danny didn't make doc-strings for the functions in here so I mostly cross-checked with
+    https://github.com/seatgeek/thefuzz concepts and ideas, which are kinda the same
+    (but in my testing that library is slower than the code here, not sure why).
 """
 
 from __future__ import annotations
@@ -33,6 +39,7 @@ def quick_ratio(a: str, b: str) -> int:
 
 
 def partial_ratio(a: str, b: str) -> int:
+    """Return the ratio of the most similar substring as a number between 0 and 100."""
     short, long = (a, b) if len(a) <= len(b) else (b, a)
     m = SequenceMatcher(None, short, long)
 
@@ -61,6 +68,7 @@ def _sort_tokens(a: str) -> str:
 
 
 def token_sort_ratio(a: str, b: str) -> int:
+    """Return a measure of the sequences' similarity between 0 and 100 but sorting the token before comparing."""
     a = _sort_tokens(a)
     b = _sort_tokens(b)
     return ratio(a, b)
@@ -73,6 +81,10 @@ def quick_token_sort_ratio(a: str, b: str) -> int:
 
 
 def partial_token_sort_ratio(a: str, b: str) -> int:
+    """Return the ratio of the most similar substring as a number between 0 and 100.
+
+    But sorting the token before comparing.
+    """
     a = _sort_tokens(a)
     b = _sort_tokens(b)
     return partial_ratio(a, b)
@@ -144,6 +156,12 @@ def extract(
     score_cutoff: int = 0,
     limit: int | None = 10,
 ) -> list[tuple[str, int]] | list[tuple[str, int, T]]:
+    """Select the best match in a list or dictionary of choices.
+
+    Find best matches in a list or dictionary of choices, return a
+    list of tuples containing the match and its score. If a dictionary
+    is used, also returns the key for each match.
+    """
     it = _extraction_generator(query, choices, scorer, score_cutoff)
     if limit is not None:
         return heapq.nlargest(limit, it, key=operator.itemgetter(1))  # pyright: ignore[reportReturnType]
@@ -177,6 +195,11 @@ def extract_one(
     scorer: Callable[[str, str], int] = quick_ratio,
     score_cutoff: int = 0,
 ) -> tuple[str, int] | tuple[str, int, T] | None:
+    """Find the single best match above a score in a list of choices.
+
+    This is a convenience method which returns the single best choice.
+    See extract() for the full arguments list.
+    """
     it = _extraction_generator(query, choices, scorer, score_cutoff)
     try:
         return max(it, key=operator.itemgetter(1))