chore(deps): update actions/setup-uv digest to d4b2f3b

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [mkdocs-material](https://github.com/squidfunk/mkdocs-material) ([changelog](https://squidfunk.github.io/mkdocs-material/changelog/)) | dependency-groups | patch | `==9.6.9` -> `==9.6.10` |

---

### Release Notes

<details>
<summary>squidfunk/mkdocs-material (mkdocs-material)</summary>

### [`v9.6.10`](https://github.com/squidfunk/mkdocs-material/releases/tag/9.6.10): mkdocs-material-9.6.10

[Compare Source](https://github.com/squidfunk/mkdocs-material/compare/9.6.9...9.6.10)

This version is a pure refactoring release, and does not contain new features or bug fixes. It strives to improve the compatibility of our templates with alternative Jinja-like template engines that we're currently exploring, including [minijinja].

Additionally, it replaces several instances of Python function invocations with idiomatic use of template filters. All instances where variables have been mutated inside templates have been replaced. Most changes have been made in partials, and only a few in blocks, and all of them are fully backward compatible, so no changes to overrides are necessary.

Note that this release does not replace the Jinja template engine with minijinja. However, our templates are now 99% compatible with minijinja, which means we can explore alternative Jinja-compatible implementations. Additionally, immutability and removal of almost all Python function invocations means much more idiomatic templating.

[minijinja]: https://github.com/mitsuhiko/minijinja

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4yMTEuMCIsInVwZGF0ZWRJblZlciI6IjM5LjIxMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Reviewed-on: #85
Co-authored-by: Renovate <renovate@csw.im>
Co-committed-by: Renovate <renovate@csw.im>

.devcontainer/Dockerfile

@@ -1,34 +0,0 @@
-FROM ghcr.io/astral-sh/uv:0.5.24@sha256:2381d6aa60c326b71fd40023f921a0a3b8f91b14d5db6b90402e65a635053709 AS uv
-FROM python:3.11-slim@sha256:6ed5bff4d7d377e2a27d9285553b8c21cfccc4f00881de1b24c9bc8d90016e82 AS python
-
-FROM mcr.microsoft.com/vscode/devcontainers/base:bookworm@sha256:6155a486f236fd5127b76af33086029d64f64cf49dd504accb6e5f949098eb7e
-LABEL repository="www.coastalcommits.com/cswimr/SeaCogs"
-LABEL maintainer="cswimr <seaswimmerthefsh@gmail.com>"
-
-RUN apt-get update; \
-    apt-get install -y --no-install-recommends \
-    # Red-DiscordBot
-    build-essential \
-    git \
-    # PyNaCl
-    libsodium-dev \
-    # CFFI
-    libffi-dev \
-    # SSH repository support
-    openssh-client \
-    # Cog dependencies
-    # Audio
-    openjdk-17-jre-headless \
-    # PyLav
-    libaio1 \
-    libaio-dev \
-    # SeaUtils
-    dnsutils; \
-    apt-get clean; \
-    rm -rf /var/lib/apt/lists/*
-
-COPY --from=uv --chown=vscode: /uv /uvx /bin/
-COPY --from=python --chown=vscode: /usr/local /usr/local
-
-RUN ln -s /usr/local/bin/python3.11 /usr/local/bin/python; \
-    python --version

.devcontainer/devcontainer.json

@@ -1,35 +0,0 @@
-{
-  "name": "Red-DiscordBot: SeaCogs",
-  "build": {
-    "context": "..",
-    "dockerfile": "Dockerfile"
-  },
-  "customizations": {
-    "vscode": {
-      "extensions": [
-        "charliermarsh.ruff",
-        "ms-azuretools.vscode-docker",
-        "ms-python.python",
-        "tekumara.typos-vscode",
-        "tamasfe.even-better-toml",
-        "redhat.vscode-yaml",
-        "DavidAnson.vscode-markdownlint",
-        "yy0931.vscode-sqlite3-editor",
-        "aaron-bond.better-comments",
-        "donjayamanne.githistory",
-        "eamodio.gitlens"
-      ]
-    }
-  },
-  "containerEnv": {
-    "DISPLAY": "dummy",
-    "PYTHONUNBUFFERED": "True",
-    "UV_LINK_MODE": "copy",
-    "UV_PYTHON_PREFERENCE": "only-system",
-    "UV_PYTHON_DOWNLOADS": "never",
-    "PROJECT_DIR": "/workspaces/SeaCogs"
-  },
-  "mounts": ["source=seacogs-persistent-data,target=/workspaces/SeaCogs/.data,type=volume"],
-  "postCreateCommand": "uv sync --frozen",
-  "remoteUser": "vscode"
-}

.docs/aurora/index.md

@@ -12,5 +12,5 @@ Aurora is a fully-featured moderation system. It is heavily inspired by Galactic
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs aurora
-[p]cog load aurora
+[p]load aurora
 ```

.docs/backup.md

@@ -7,7 +7,7 @@ Backup allows you to export a JSON list of all of your installed repositories an
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs backup
-[p]cog load backup
+[p]load backup
 ```
 
 ## Version Compatibility

.docs/bible.md

@@ -8,7 +8,7 @@ This cog does require an api key to work.
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs bible
-[p]cog load bible
+[p]load bible
 ```
 
 ## Setup
@@ -21,8 +21,9 @@ Then, you can use `[p]set api` to set the API key. Make sure your formatting mat
 ## Commands
 
 ### bible passage
- - Usage: `[p]bible passage <book> <passage>`
- - Aliases: `verse`
+
+- Usage: `[p]bible passage <book> <passage>`
+- Aliases: `verse`
 
 Get a Bible passage.
 
@@ -31,6 +32,7 @@ Example usage:
 `[p]bible passage John 3:16-3:17`
 
 ### bible random
- - Usage: `[p]bible random`
+
+- Usage: `[p]bible random`
 
 Get a random Bible verse.

.docs/emojiinfo.md

@@ -7,7 +7,7 @@ EmojiInfo allows you to retrieve information about an emoji.
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs emojiinfo
-[p]cog load emojiinfo
+[p]load emojiinfo
 ```
 
 ## Commands

.docs/hotreload.md

@@ -0,0 +1,26 @@
+# HotReload
+
+HotReload automatically reloads cogs in local cog paths on file change.  
+This is useful for development, as it allows you to make changes to your cogs and see the changes reflected in Discord immediately, without having to manually `[p]reload` the cog.
+
+## Installation
+
+```bash
+[p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
+[p]cog install seacogs hotreload
+[p]load hotreload
+```
+
+## Commands
+
+### hotreload compile
+
+Determines if the cog should try to compile a modified Python file before reloading the associated cog. Useful for catching syntax errors. Disabled by default.
+
+### hotreload notifychannel
+
+Set the channel where hotreload will send notifications when a cog is reloaded.
+
+### hotreload list
+
+Debugging command that shows the list of currently active observers. May be expanded in the future to show watched file paths.

.docs/nerdify.md

@@ -7,7 +7,7 @@ Nerdify allows you to nerdify other people's text.
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs nerdify
-[p]cog load nerdify
+[p]load nerdify
 ```
 
 ## Commands

.docs/pterodactyl/index.md

@@ -12,5 +12,5 @@ Pterodactyl allows for connecting to a Pterodactyl server through websockets. It
 ```bash
 [p]repo add seacogs https://www.coastalcommits.com/cswimr/SeaCogs
 [p]cog install seacogs pterodactyl
-[p]cog load aurora
+[p]load pterodactyl
 ```

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

.envrc

@@ -0,0 +1 @@
+use flake

.forgejo/pull_request_template.md

@@ -2,5 +2,5 @@
 
 <!-- Create a new issue, if it doesn't exist yet -->
 
-- [ ] By submitting this pull request, I permit cswimr to license my work under
+- [ ] By submitting this pull request, I permit [cswimr](https://www.coastalcommits.com/cswimr) to license my work under
   the [Mozilla Public License Version 2.0](https://www.coastalcommits.com/cswimr/SeaCogs/src/branch/main/LICENSE).

.forgejo/workflows/config/.pylintrc

@@ -12,6 +12,7 @@
     too-many-locals,
     too-many-public-methods,
     too-many-statements,
+    too-many-positional-arguments,
     arguments-differ,
     too-many-return-statements,
     import-outside-toplevel,

.forgejo/workflows/workflow.yaml

@@ -1,21 +1,28 @@
 name: Actions
 on:
   push:
+    branches:
+      - main
   pull_request:
 
 jobs:
   lint:
     name: Lint Code (Ruff & Pylint)
     runs-on: docker
-    container: www.coastalcommits.com/cswimr/actions:uv@sha256:211aaf7d9ac98087579ebf9fab87a9122f51b2697e3a3649ac9f4bd3b03b8e5d
+    container: catthehacker/ubuntu:act-latest@sha256:cd837565ef74f3d0f94e89ff6723292caa415306bddabfe566932ae892ca9334
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
-      - name: Install python
-        run: uv python install 3.11
+      - name: "Setup uv"
+        uses: actions/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
+        with:
+          version: "latest"
+          enable-cache: true
+          prune-cache: false
+          github-token: ${{ secrets.GITHUBTOKEN }}
 
-      - name: Install dependencies
+      - name: "Install dependencies"
         run: uv sync
 
       - name: Analysing code with Ruff
@@ -27,23 +34,27 @@ jobs:
 
   docs:
     name: Build Documentation (MkDocs)
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     runs-on: docker
-    container: www.coastalcommits.com/cswimr/actions:docs@sha256:e405cd6b9b1182a570ddee32ed8dd1b2f899edc625d006c8b4b2f18c100e724f
+    container: catthehacker/ubuntu:act-latest@sha256:cd837565ef74f3d0f94e89ff6723292caa415306bddabfe566932ae892ca9334
     steps:
       - name: Checkout
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
         with:
           fetch-depth: 0
 
-      - name: Install python
-        run: uv python install 3.11
+      - name: "Setup uv"
+        uses: actions/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
+        with:
+          version: "latest"
+          enable-cache: true
+          prune-cache: false
+          github-token: ${{ secrets.GITHUBTOKEN }}
 
       - name: Install dependencies
-        run: uv sync --no-dev --extra=documentation
+        run: uv sync --no-dev --group=documentation
 
       - name: Set environment variables
-        uses: actions/env@v2
+        uses: actions/env@1791216cd180e6578dd1d67fb8d2852b883a5f53 # v2
 
       - name: Build documentation
         run: |
@@ -63,13 +74,13 @@ jobs:
           echo "${YELLOW}Deploying to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}...\n"
 
           npx -p "@getmeli/cli" meli upload ./site \
-            --url "https://pages.coastalcommits.com" \
+            --url "https://meli.csw.im" \
             --site "${{ vars.MELI_SITE_ID }}" \
             --token "${{ secrets.MELI_TOKEN }}" \
             --release "$CI_ACTION_REF_NAME_SLUG/${{ env.GITHUB_SHA }}" \
             --branch "$CI_ACTION_REF_NAME_SLUG"
 
           echo "\n${YELLOW}Deployed to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}!"
-          echo "${GREEN}https://$CI_ACTION_REF_NAME_SLUG.seacogs.coastalcommits.com/"
+          echo "${GREEN}https://$CI_ACTION_REF_NAME_SLUG.seacogs.csw.im/"
         env:
           GITEA_TOKEN: ${{ secrets.COASTALCOMMITSTOKEN }}

.gitignore

@@ -3,3 +3,6 @@ site
 .venv
 .data
 __pycache__
+.mypy_cache/
+.ruff_cache/
+.direnv/

.vscode/launch.json

@@ -1,15 +1,12 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
     {
-            "name": "Red-DiscordBot",
+      "name": "Python: Red-DiscordBot",
       "type": "debugpy",
       "request": "launch",
       "module": "redbot",
-            "args": ["local"]
+      "args": ["local", "--dev", "-vvv", "--load-cogs=hotreload"]
     }
   ]
 }

.vscode/settings.json

@@ -1,6 +1,5 @@
 {
     "[python]": {
-        "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
             "source.fixAll": "explicit"
         },
@@ -8,5 +7,26 @@
     },
     "[json]": {
         "editor.defaultFormatter": "vscode.json-language-features"
-    }
+    },
+    "[jsonc]": {
+        "editor.defaultFormatter": "vscode.json-language-features"
+    },
+    "files.exclude": {
+        "**/.git": true,
+        "**/__pycache__": true,
+        "**/.ruff_cache": true,
+        "**/.mypy_cache": true
+    },
+    "python.analysis.diagnosticSeverityOverrides": {
+        "reportAttributeAccessIssue": false, // disabled because `commands.group.command` is listed as Any / Unknown for some reason
+        "reportCallIssue": "information"
+    },
+    "python.analysis.diagnosticMode": "workspace",
+    "python.analysis.supportDocstringTemplate": true,
+    "python.analysis.typeCheckingMode": "basic",
+    "python.analysis.typeEvaluation.enableReachabilityAnalysis": true,
+    "python.analysis.typeEvaluation.strictDictionaryInference": true,
+    "python.analysis.typeEvaluation.strictListInference": true,
+    "python.analysis.typeEvaluation.strictSetInference": true,
+    "editor.formatOnSave": true,
 }

README.md

@@ -1,27 +1,56 @@
 # SeaCogs
 
 [![Discord](https://img.shields.io/discord/1070058354925383681?logo=discord&color=%235661f6)](https://discord.gg/eMUMe77Yb8)
-[![Documentation](https://img.shields.io/badge/docs-CoastalCommits%20Pages-3e83fd?logo=materialformkdocs)](https://seacogs.coastalcommits.com)
+[![Documentation](https://img.shields.io/badge/docs-CoastalCommits%20Pages-3e83fd?logo=materialformkdocs)](https://seacogs.csw.im)
 ![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11-%233776ab?logo=python)
 
 My assorted cogs for Red-DiscordBot.
 
-## Development
+## Developing
 
-To get started with a development environment, first clone this repository.
+You'll need some prerequisites before you can start working on my cogs.  
+[git](https://git-scm.com) - [uv](https://docs.astral.sh/uv)  
+Additionally, I recommend a code editor of some variety. [Visual Studio Code](https://code.visualstudio.com) is a good, beginner-friendly option.
 
-```sh
-git clone https://coastalcommits.com/cswimr/SeaCogs.git
+### Installing Prerequisites
+
+_This section of the guide only applies to Windows systems.
+If you're on Linux, refer to the documentation of the projects listed above. I also offer a [Nix Flake](./flake.nix) that contains all of the required prerequisites, if you're a Nix user._
+
+#### [`git`](https://git-scm.com)
+
+You can download git from the [git download page](https://git-scm.com/downloads/win).
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=Git.Git -e --source=winget
 ```
 
-Then, install Poetry.
+#### [`uv`](https://docs.astral.sh/uv)
 
-```sh
-pip install poetry
+You can install uv with the following Powershell command:
+
+```ps1
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-Finally, use Poetry to create a virtual environment with all of the dependencies required by my cogs.
+Alternatively, you can use `winget`:
 
-```sh
-poetry install
+```ps1
+winget install --id=astral-sh.uv -e
+```
+
+### Getting the Source Code
+
+Once you have [`git`](https://git-scm.com) installed, you can use the `git clone` command to get a copy of the repository on your system.
+
+```bash
+git clone https://c.csw.im/cswimr/SeaCogs.git
+```
+
+Then, you can use `uv` to install the Python dependencies required for development.
+
+```bash
+uv sync --frozen
 ```

antipolls/antipolls.py

@@ -17,7 +17,7 @@ class AntiPolls(commands.Cog):
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.0.1"
+    __version__ = "1.0.3"
     __documentation__ = "https://seacogs.coastalcommits.com/antipolls/"
 
     def __init__(self, bot: Red):
@@ -49,7 +49,7 @@ class AntiPolls(commands.Cog):
         """Nothing to delete."""
         return
 
-    @commands.Cog.listener('on_message')
+    @commands.Cog.listener("on_message")
     async def polls_listener(self, message: discord.Message) -> None:
         if message.guild is None:
             return self.logger.verbose("Message in direct messages ignored")
@@ -62,13 +62,13 @@ class AntiPolls(commands.Cog):
 
         guild_config = await self.config.guild(message.guild).all()
 
-        if guild_config['manage_messages'] is True and message.author.guild_permissions.manage_messages:
+        if guild_config["manage_messages"] is True and message.author.guild_permissions.manage_messages:
             return self.logger.verbose("Message from user with Manage Messages permission ignored")
 
-        if message.channel.id in guild_config['channel_whitelist']:
+        if message.channel.id in guild_config["channel_whitelist"]:
             return self.logger.verbose("Message in whitelisted channel %s ignored", message.channel.id)
 
-        if any(role.id in guild_config['role_whitelist'] for role in message.author.roles):
+        if any(role.id in guild_config["role_whitelist"] for role in message.author.roles):
             return self.logger.verbose("Message from whitelisted role %s ignored", message.author.roles)
 
         if not message.content and not message.embeds and not message.attachments and not message.stickers:
@@ -80,9 +80,9 @@ class AntiPolls(commands.Cog):
                 return self.logger.error("Failed to delete message: %s", e)
 
             return self.logger.trace("Deleted poll message %s", message.id)
-        self.logger.verbose("Message %s is not a poll, ignoring", message.id)
+        return self.logger.verbose("Message %s is not a poll, ignoring", message.id)
 
-    @commands.group(name="antipolls", aliases=["ap"])
+    @commands.group(name="antipolls", aliases=["ap"])  # type: ignore
     @commands.guild_only()
     @commands.admin_or_permissions(manage_guild=True)
     async def antipolls(self, ctx: commands.Context) -> None:
@@ -95,6 +95,8 @@ class AntiPolls(commands.Cog):
     @antipolls_roles.command(name="add")
     async def antipolls_roles_add(self, ctx: commands.Context, *roles: discord.Role) -> None:
         """Add roles to the whitelist."""
+        assert ctx.guild is not None  # using `assert` here and in the rest of this file to satisfy typecheckers
+        # this is safe because the commands are part of a guild-only command group
         async with self.config.guild(ctx.guild).role_whitelist() as role_whitelist:
             role_whitelist: list
             failed: list[discord.Role] = []
@@ -110,6 +112,7 @@ class AntiPolls(commands.Cog):
     @antipolls_roles.command(name="remove")
     async def antipolls_roles_remove(self, ctx: commands.Context, *roles: discord.Role) -> None:
         """Remove roles from the whitelist."""
+        assert ctx.guild is not None
         async with self.config.guild(ctx.guild).role_whitelist() as role_whitelist:
             role_whitelist: list
             failed: list[discord.Role] = []
@@ -123,13 +126,14 @@ class AntiPolls(commands.Cog):
             await ctx.send(f"The following roles were not in the whitelist: {humanize_list([role.mention for role in failed])}", delete_after=10)
 
     @antipolls_roles.command(name="list")
-    async def antipolls_roles_list(self, ctx: commands.Context) -> None:
+    async def antipolls_roles_list(self, ctx: commands.Context) -> discord.Message:
         """List roles in the whitelist."""
+        assert ctx.guild is not None
         role_whitelist = await self.config.guild(ctx.guild).role_whitelist()
         if not role_whitelist:
             return await ctx.send("No roles in the whitelist.")
-        roles = [ctx.guild.get_role(role) for role in role_whitelist]
-        await ctx.send(humanize_list([role.mention for role in roles]))
+        roles = [role for role in (ctx.guild.get_role(role) for role in role_whitelist) if role is not None]
+        return await ctx.send(humanize_list([role.mention for role in roles]))
 
     @antipolls.group(name="channels")
     async def antipolls_channels(self, ctx: commands.Context) -> None:
@@ -138,6 +142,7 @@ class AntiPolls(commands.Cog):
     @antipolls_channels.command(name="add")
     async def antipolls_channels_add(self, ctx: commands.Context, *channels: discord.TextChannel) -> None:
         """Add channels to the whitelist."""
+        assert ctx.guild is not None
         async with self.config.guild(ctx.guild).channel_whitelist() as channel_whitelist:
             channel_whitelist: list
             failed: list[discord.TextChannel] = []
@@ -153,6 +158,7 @@ class AntiPolls(commands.Cog):
     @antipolls_channels.command(name="remove")
     async def antipolls_channels_remove(self, ctx: commands.Context, *channels: discord.TextChannel) -> None:
         """Remove channels from the whitelist."""
+        assert ctx.guild is not None
         async with self.config.guild(ctx.guild).channel_whitelist() as channel_whitelist:
             channel_whitelist: list
             failed: list[discord.TextChannel] = []
@@ -166,16 +172,21 @@ class AntiPolls(commands.Cog):
             await ctx.send(f"The following channels were not in the whitelist: {humanize_list([channel.mention for channel in failed])}", delete_after=10)
 
     @antipolls_channels.command(name="list")
-    async def antipolls_channels_list(self, ctx: commands.Context) -> None:
+    async def antipolls_channels_list(self, ctx: commands.Context) -> discord.Message:
         """List channels in the whitelist."""
+        assert ctx.guild is not None
         channel_whitelist = await self.config.guild(ctx.guild).channel_whitelist()
         if not channel_whitelist:
             return await ctx.send("No channels in the whitelist.")
-        channels = [ctx.guild.get_channel(channel) for channel in channel_whitelist]
-        await ctx.send(humanize_list([channel.mention for channel in channels]))
+        channels = [channel for channel in (ctx.guild.get_channel(channel) for channel in channel_whitelist) if channel is not None]
+        for c in channels:
+            if not c:
+                channels.remove(c)
+        return await ctx.send(humanize_list([channel.mention for channel in channels]))
 
     @antipolls.command(name="managemessages")
     async def antipolls_managemessages(self, ctx: commands.Context, enabled: bool) -> None:
         """Toggle Manage Messages permission check."""
+        assert ctx.guild is not None
         await self.config.guild(ctx.guild).manage_messages.set(enabled)
         await ctx.tick()

antipolls/info.json

@@ -1,17 +1,14 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing AntiPolls!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
-  "name" : "AntiPolls",
-  "short" : "AntiPolls deletes messages that contain polls.",
-  "description" : "AntiPolls deletes messages that contain polls, with a configurable per-guild role and channel whitelist and support for default Discord permissions (Manage Messages).",
-  "end_user_data_statement" : "This cog does not store any user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing AntiPolls!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
+  "name": "AntiPolls",
+  "short": "AntiPolls deletes messages that contain polls.",
+  "description": "AntiPolls deletes messages that contain polls, with a configurable per-guild role and channel whitelist and support for default Discord permissions (Manage Messages).",
+  "end_user_data_statement": "This cog does not store any user data.",
   "hidden": true,
   "disabled": false,
   "min_bot_version": "3.5.0",
   "min_python_version": [3, 10, 0],
-  "tags": [
-      "automod",
-      "automoderation",
-      "polls"
-  ]
+  "tags": ["automod", "automoderation", "polls"]
 }

aurora/aurora.py

@@ -40,7 +40,7 @@ class Aurora(commands.Cog):
     This cog stores all of its data in an SQLite database."""
 
     __author__ = ["cswimr"]
-    __version__ = "2.1.3"
+    __version__ = "2.1.5"
     __documentation__ = "https://seacogs.coastalcommits.com/aurora/"
 
     async def red_delete_data_for_user(self, *, requester, user_id: int):
@@ -70,7 +70,8 @@ class Aurora(commands.Cog):
             await config.user_from_id(user_id).clear()
         else:
             logger.warning(
-                "Invalid requester passed to red_delete_data_for_user: %s", requester
+                "Invalid requester passed to red_delete_data_for_user: %s",
+                requester,
             )
 
     def __init__(self, bot: Red):
@@ -135,8 +136,7 @@ class Aurora(commands.Cog):
             if await config.guild(entry.guild).ignore_other_bots() is True:
                 if entry.user.bot or entry.target.bot:
                     return
-            else:
-                if entry.user.id == self.bot.user.id:
+            elif entry.user.id == self.bot.user.id:
                 return
 
             duration = "NULL"
@@ -159,10 +159,10 @@ class Aurora(commands.Cog):
             elif entry.action == discord.AuditLogAction.member_update:
                 if entry.after.timed_out_until is not None:
                     timed_out_until_aware = entry.after.timed_out_until.replace(
-                        tzinfo=timezone.utc
+                        tzinfo=timezone.utc,
                     )
                     duration_datetime = timed_out_until_aware - datetime.now(
-                        tz=timezone.utc
+                        tz=timezone.utc,
                     )
                     minutes = round(duration_datetime.total_seconds() / 60)
                     duration = timedelta(minutes=minutes)
@@ -209,7 +209,7 @@ class Aurora(commands.Cog):
             return
 
         await interaction.response.send_message(
-            content=f"{target.mention} has recieved a note!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has recieved a note!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -239,7 +239,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has received a note! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has received a note! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -268,7 +268,7 @@ class Aurora(commands.Cog):
             return
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been warned!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been warned!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -298,7 +298,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been warned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been warned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -342,7 +342,8 @@ class Aurora(commands.Cog):
             parsed_time = parse_timedelta(duration)
             if parsed_time is None:
                 await interaction.response.send_message(
-                    content=error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"),
+                    ephemeral=True,
                 )
                 return
         else:
@@ -350,12 +351,15 @@ class Aurora(commands.Cog):
 
         if role.id not in addrole_whitelist:
             await interaction.response.send_message(
-                content=error("That role isn't whitelisted!"), ephemeral=True
+                content=error("That role isn't whitelisted!"),
+                ephemeral=True,
             )
             return
 
         if not await check_moddable(
-            target, interaction, ["moderate_members", "manage_roles"]
+            target,
+            interaction,
+            ["moderate_members", "manage_roles"],
         ):
             return
 
@@ -390,7 +394,7 @@ class Aurora(commands.Cog):
             reason=f"Role added by {interaction.user.id}{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''} for: {reason}",
         )
         response: discord.WebhookMessage = await interaction.followup.send(
-            content=f"{target.mention} has been given the {role.mention} role{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''}!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been given the {role.mention} role{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''}!\n**Reason** - `{reason}`",
         )
 
         moderation_id = await mysql_log(
@@ -448,7 +452,8 @@ class Aurora(commands.Cog):
             parsed_time = parse_timedelta(duration)
             if parsed_time is None:
                 await interaction.response.send_message(
-                    content=error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"),
+                    ephemeral=True,
                 )
                 return
         else:
@@ -456,12 +461,15 @@ class Aurora(commands.Cog):
 
         if role.id not in addrole_whitelist:
             await interaction.response.send_message(
-                content=error("That role isn't whitelisted!"), ephemeral=True
+                content=error("That role isn't whitelisted!"),
+                ephemeral=True,
             )
             return
 
         if not await check_moddable(
-            target, interaction, ["moderate_members", "manage_roles"]
+            target,
+            interaction,
+            ["moderate_members", "manage_roles"],
         ):
             return
 
@@ -496,7 +504,7 @@ class Aurora(commands.Cog):
             reason=f"Role removed by {interaction.user.id}{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''} for: {reason}",
         )
         response: discord.WebhookMessage = await interaction.followup.send(
-            content=f"{target.mention} has had the {role.mention} role removed{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''}!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has had the {role.mention} role removed{' for ' + humanize_timedelta(timedelta=parsed_time) if parsed_time != 'NULL' else ''}!\n**Reason** - `{reason}`",
         )
 
         moderation_id = await mysql_log(
@@ -553,21 +561,24 @@ class Aurora(commands.Cog):
             parsed_time = parse_timedelta(duration, maximum=timedelta(days=28))
             if parsed_time is None:
                 await interaction.response.send_message(
-                    error("Please provide a valid duration!"), ephemeral=True
+                    error("Please provide a valid duration!"),
+                    ephemeral=True,
                 )
                 return
         except commands.BadArgument:
             await interaction.response.send_message(
-                error("Please provide a duration that is less than 28 days."), ephemeral=True
+                error("Please provide a duration that is less than 28 days."),
+                ephemeral=True,
             )
             return
 
         await target.timeout(
-            parsed_time, reason=f"Muted by {interaction.user.id} for: {reason}"
+            parsed_time,
+            reason=f"Muted by {interaction.user.id} for: {reason}",
         )
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -598,7 +609,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been muted for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -636,14 +647,15 @@ class Aurora(commands.Cog):
 
         if reason:
             await target.timeout(
-                None, reason=f"Unmuted by {interaction.user.id} for: {reason}"
+                None,
+                reason=f"Unmuted by {interaction.user.id} for: {reason}",
             )
         else:
             await target.timeout(None, reason=f"Unbanned by {interaction.user.id}")
             reason = "No reason given."
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been unmuted!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been unmuted!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -673,7 +685,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been unmuted! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been unmuted! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -702,7 +714,7 @@ class Aurora(commands.Cog):
             return
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been kicked!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been kicked!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -734,7 +746,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been kicked! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been kicked! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -750,7 +762,7 @@ class Aurora(commands.Cog):
             Choice(name="1 Day", value=86400),
             Choice(name="3 Days", value=259200),
             Choice(name="7 Days", value=604800),
-        ]
+        ],
     )
     async def ban(
         self,
@@ -786,7 +798,8 @@ class Aurora(commands.Cog):
         try:
             await interaction.guild.fetch_ban(target)
             await interaction.response.send_message(
-                content=error(f"{target.mention} is already banned!"), ephemeral=True
+                content=error(f"{target.mention} is already banned!"),
+                ephemeral=True,
             )
             return
         except discord.errors.NotFound:
@@ -796,19 +809,21 @@ class Aurora(commands.Cog):
             parsed_time = parse_relativedelta(duration)
             if parsed_time is None:
                 await interaction.response.send_message(
-                    content=error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"),
+                    ephemeral=True,
                 )
                 return
             try:
                 parsed_time = timedelta_from_relativedelta(parsed_time)
             except ValueError:
                 await interaction.response.send_message(
-                    content=error("Please provide a valid duration!"), ephemeral=True
+                    content=error("Please provide a valid duration!"),
+                    ephemeral=True,
                 )
                 return
 
             await interaction.response.send_message(
-                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}!\n**Reason** - `{reason}`",
             )
 
             try:
@@ -842,7 +857,7 @@ class Aurora(commands.Cog):
                 reason,
             )
             await interaction.edit_original_response(
-                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id}`)\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned for {humanize_timedelta(timedelta=parsed_time)}! (Case `#{moderation_id}`)\n**Reason** - `{reason}`",
             )
             await log(interaction, moderation_id)
 
@@ -850,14 +865,14 @@ class Aurora(commands.Cog):
             await send_evidenceformat(interaction, case)
         else:
             await interaction.response.send_message(
-                content=f"{target.mention} has been banned!\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned!\n**Reason** - `{reason}`",
             )
 
             if silent is None:
                 silent = not await config.guild(interaction.guild).dm_users()
             if silent is False:
                 try:
-                    embed = embed = await message_factory(
+                    embed = await message_factory(
                         await self.bot.get_embed_color(interaction.channel),
                         guild=interaction.guild,
                         moderator=interaction.user,
@@ -886,7 +901,7 @@ class Aurora(commands.Cog):
                 reason,
             )
             await interaction.edit_original_response(
-                content=f"{target.mention} has been banned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+                content=f"{target.mention} has been banned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
             )
             await log(interaction, moderation_id)
 
@@ -918,22 +933,25 @@ class Aurora(commands.Cog):
             await interaction.guild.fetch_ban(target)
         except discord.errors.NotFound:
             await interaction.response.send_message(
-                content=error(f"{target.mention} is not banned!"), ephemeral=True
+                content=error(f"{target.mention} is not banned!"),
+                ephemeral=True,
             )
             return
 
         if reason:
             await interaction.guild.unban(
-                target, reason=f"Unbanned by {interaction.user.id} for: {reason}"
+                target,
+                reason=f"Unbanned by {interaction.user.id} for: {reason}",
             )
         else:
             await interaction.guild.unban(
-                target, reason=f"Unbanned by {interaction.user.id}"
+                target,
+                reason=f"Unbanned by {interaction.user.id}",
             )
             reason = "No reason given."
 
         await interaction.response.send_message(
-            content=f"{target.mention} has been unbanned!\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been unbanned!\n**Reason** - `{reason}`",
         )
 
         if silent is None:
@@ -963,7 +981,7 @@ class Aurora(commands.Cog):
             reason,
         )
         await interaction.edit_original_response(
-            content=f"{target.mention} has been unbanned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`"
+            content=f"{target.mention} has been unbanned! (Case `#{moderation_id:,}`)\n**Reason** - `{reason}`",
         )
         await log(interaction, moderation_id)
 
@@ -1001,42 +1019,28 @@ class Aurora(commands.Cog):
         export: bool
             Exports the server's entire moderation history to a JSON file"""
         if ephemeral is None:
-            ephemeral = (
-                await config.user(interaction.user).history_ephemeral()
-                or await config.guild(interaction.guild).history_ephemeral()
-                or False
-            )
+            ephemeral = await config.user(interaction.user).history_ephemeral() or await config.guild(interaction.guild).history_ephemeral() or False
 
         if inline is None:
-            inline = (
-                await config.user(interaction.user).history_inline()
-                or await config.guild(interaction.guild).history_inline()
-                or False
-            )
+            inline = await config.user(interaction.user).history_inline() or await config.guild(interaction.guild).history_inline() or False
 
         if pagesize is None:
             if inline is True:
-                pagesize = (
-                    await config.user(interaction.user).history_inline_pagesize()
-                    or await config.guild(interaction.guild).history_inline_pagesize()
-                    or 6
-                )
+                pagesize = await config.user(interaction.user).history_inline_pagesize() or await config.guild(interaction.guild).history_inline_pagesize() or 6
             else:
-                pagesize = (
-                    await config.user(interaction.user).history_pagesize()
-                    or await config.guild(interaction.guild).history_pagesize()
-                    or 5
-                )
+                pagesize = await config.user(interaction.user).history_pagesize() or await config.guild(interaction.guild).history_pagesize() or 5
 
         await interaction.response.defer(ephemeral=ephemeral)
 
         permissions = check_permissions(
-            interaction.client.user, ["embed_links"], interaction
+            interaction.client.user,
+            ["embed_links"],
+            interaction,
         )
         if permissions:
             await interaction.followup.send(
                 error(
-                    f"I do not have the `{permissions}` permission, required for this action."
+                    f"I do not have the `{permissions}` permission, required for this action.",
                 ),
                 ephemeral=True,
             )
@@ -1061,18 +1065,15 @@ class Aurora(commands.Cog):
                 cases.append(case)
 
             try:
-                filename = (
-                    str(data_manager.cog_data_path(cog_instance=self))
-                    + str(os.sep)
-                    + f"moderation_{interaction.guild.id}.json"
-                )
+                filename = str(data_manager.cog_data_path(cog_instance=self)) + str(os.sep) + f"moderation_{interaction.guild.id}.json"
 
                 with open(filename, "w", encoding="utf-8") as f:
                     json.dump(cases, f, indent=2)
 
                 await interaction.followup.send(
                     file=discord.File(
-                        filename, f"moderation_{interaction.guild.id}.json"
+                        filename,
+                        f"moderation_{interaction.guild.id}.json",
                     ),
                     ephemeral=ephemeral,
                 )
@@ -1081,7 +1082,7 @@ class Aurora(commands.Cog):
             except json.JSONDecodeError as e:
                 await interaction.followup.send(
                     content=error(
-                        "An error occured while exporting the moderation history.\nError:\n"
+                        "An error occured while exporting the moderation history.\nError:\n",
                     )
                     + box(e, "py"),
                     ephemeral=ephemeral,
@@ -1127,7 +1128,7 @@ class Aurora(commands.Cog):
         embed = discord.Embed(color=await self.bot.get_embed_color(interaction.channel))
         embed.set_author(icon_url=interaction.guild.icon.url, name="Infraction History")
         embed.set_footer(
-            text=f"Page {page:,}/{page_quantity:,} | {case_quantity:,} Results"
+            text=f"Page {page:,}/{page_quantity:,} | {case_quantity:,} Results",
         )
 
         memory_dict = {}
@@ -1136,33 +1137,30 @@ class Aurora(commands.Cog):
             if case["target_id"] not in memory_dict:
                 if case["target_type"] == "USER":
                     memory_dict[str(case["target_id"])] = await fetch_user_dict(
-                        interaction.client, case["target_id"]
+                        interaction.client,
+                        case["target_id"],
                     )
                 elif case["target_type"] == "CHANNEL":
                     memory_dict[str(case["target_id"])] = await fetch_channel_dict(
-                        interaction.guild, case["target_id"]
+                        interaction.guild,
+                        case["target_id"],
                     )
             target_user = memory_dict[str(case["target_id"])]
 
             if case["target_type"] == "USER":
-                target_name = (
-                    f"`{target_user['name']}`"
-                    if target_user["discriminator"] == "0"
-                    else f"`{target_user['name']}#{target_user['discriminator']}`"
-                )
+                target_name = f"`{target_user['name']}`" if target_user["discriminator"] == "0" else f"`{target_user['name']}#{target_user['discriminator']}`"
             elif case["target_type"] == "CHANNEL":
                 target_name = f"`{target_user['mention']}`"
+            else:
+                target_name = ""
 
             if case["moderator_id"] not in memory_dict:
                 memory_dict[str(case["moderator_id"])] = await fetch_user_dict(
-                    interaction.client, case["moderator_id"]
+                    interaction.client,
+                    case["moderator_id"],
                 )
             moderator_user = memory_dict[str(case["moderator_id"])]
-            moderator_name = (
-                f"`{moderator_user['name']}`"
-                if moderator_user["discriminator"] == "0"
-                else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
-            )
+            moderator_name = f"`{moderator_user['name']}`" if moderator_user["discriminator"] == "0" else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
 
             field_name = f"Case #{case['moderation_id']:,} ({str.title(case['moderation_type'])})"
             field_value = f"**Target:** {target_name} ({target_user['id']})\n**Moderator:** {moderator_name} ({moderator_user['id']})"
@@ -1177,20 +1175,15 @@ class Aurora(commands.Cog):
                     **{
                         unit: int(val)
                         for unit, val in zip(
-                            ["hours", "minutes", "seconds"], case["duration"].split(":")
+                            ["hours", "minutes", "seconds"],
+                            case["duration"].split(":"),
                         )
-                    }
-                )
-                duration_embed = (
-                    f"{humanize_timedelta(timedelta=td)} | <t:{case['end_timestamp']}:R>"
-                    if bool(case["expired"]) is False
-                    else f"{humanize_timedelta(timedelta=td)} | Expired"
+                    },
                 )
+                duration_embed = f"{humanize_timedelta(timedelta=td)} | <t:{case['end_timestamp']}:R>" if bool(case["expired"]) is False else f"{humanize_timedelta(timedelta=td)} | Expired"
                 field_value += f"\n**Duration:** {duration_embed}"
 
-            field_value += (
-                f"\n**Timestamp:** <t:{case['timestamp']}> | <t:{case['timestamp']}:R>"
-            )
+            field_value += f"\n**Timestamp:** <t:{case['timestamp']}> | <t:{case['timestamp']}:R>"
 
             if case["role_id"] != "0":
                 role = interaction.guild.get_role(int(case["role_id"]))
@@ -1208,7 +1201,10 @@ class Aurora(commands.Cog):
 
     @app_commands.command(name="resolve")
     async def resolve(
-        self, interaction: discord.Interaction, case: int, reason: str = None
+        self,
+        interaction: discord.Interaction,
+        case: int,
+        reason: str = None,
     ):
         """Resolve a specific case.
 
@@ -1226,7 +1222,7 @@ class Aurora(commands.Cog):
         if permissions:
             await interaction.response.send_message(
                 error(
-                    f"I do not have the `{permissions}` permission, required for this action."
+                    f"I do not have the `{permissions}` permission, required for this action.",
                 ),
                 ephemeral=True,
             )
@@ -1235,9 +1231,7 @@ class Aurora(commands.Cog):
         database = connect()
         cursor = database.cursor()
 
-        query_1 = (
-            f"SELECT * FROM moderation_{interaction.guild.id} WHERE moderation_id = ?;"
-        )
+        query_1 = f"SELECT * FROM moderation_{interaction.guild.id} WHERE moderation_id = ?;"
         cursor.execute(query_1, (case,))
         result_1 = cursor.fetchone()
         if result_1 is None or case == 0:
@@ -1253,7 +1247,7 @@ class Aurora(commands.Cog):
         if result_2 is None:
             await interaction.response.send_message(
                 content=error(
-                    f"This moderation has already been resolved!\nUse `/case {case}` for more information."
+                    f"This moderation has already been resolved!\nUse `/case {case}` for more information.",
                 ),
                 ephemeral=True,
             )
@@ -1267,7 +1261,7 @@ class Aurora(commands.Cog):
         if len(changes) > 25:
             await interaction.response.send_message(
                 content=error(
-                    "Due to limitations with Discord's embed system, you cannot edit a case more than 25 times."
+                    "Due to limitations with Discord's embed system, you cannot edit a case more than 25 times.",
                 ),
                 ephemeral=True,
             )
@@ -1279,7 +1273,7 @@ class Aurora(commands.Cog):
                     "timestamp": case_dict["timestamp"],
                     "reason": case_dict["reason"],
                     "user_id": case_dict["moderator_id"],
-                }
+                },
             )
         changes.append(
             {
@@ -1287,7 +1281,7 @@ class Aurora(commands.Cog):
                 "timestamp": int(time.time()),
                 "reason": reason,
                 "user_id": interaction.user.id,
-            }
+            },
         )
 
         if case_dict["moderation_type"] in ["UNMUTE", "UNBAN"]:
@@ -1301,11 +1295,12 @@ class Aurora(commands.Cog):
             if case_dict["moderation_type"] == "MUTE":
                 try:
                     member = await interaction.guild.fetch_member(
-                        case_dict["target_id"]
+                        case_dict["target_id"],
                     )
 
                     await member.timeout(
-                        None, reason=f"Case #{case:,} resolved by {interaction.user.id}"
+                        None,
+                        reason=f"Case #{case:,} resolved by {interaction.user.id}",
                     )
                 except discord.NotFound:
                     pass
@@ -1315,7 +1310,8 @@ class Aurora(commands.Cog):
                     user = await interaction.client.fetch_user(case_dict["target_id"])
 
                     await interaction.guild.unban(
-                        user, reason=f"Case #{case} resolved by {interaction.user.id}"
+                        user,
+                        reason=f"Case #{case} resolved by {interaction.user.id}",
                     )
                 except discord.NotFound:
                     pass
@@ -1340,7 +1336,8 @@ class Aurora(commands.Cog):
             case_dict=await fetch_case(case, interaction.guild.id),
         )
         await interaction.response.send_message(
-            content=f"✅ Moderation #{case:,} resolved!", embed=embed
+            content=f"✅ Moderation #{case:,} resolved!",
+            embed=embed,
         )
         await log(interaction, case, resolved=True)
 
@@ -1352,7 +1349,7 @@ class Aurora(commands.Cog):
         export=[
             Choice(name="Export as File", value="file"),
             Choice(name="Export as Codeblock", value="codeblock"),
-        ]
+        ],
     )
     async def case(
         self,
@@ -1376,41 +1373,35 @@ class Aurora(commands.Cog):
         export: bool
             Export the case to a JSON file or codeblock"""
         permissions = check_permissions(
-            interaction.client.user, ["embed_links"], interaction
+            interaction.client.user,
+            ["embed_links"],
+            interaction,
         )
         if permissions:
             await interaction.response.send_message(
                 error(
-                    f"I do not have the `{permissions}` permission, required for this action."
+                    f"I do not have the `{permissions}` permission, required for this action.",
                 ),
                 ephemeral=True,
             )
             return
 
         if ephemeral is None:
-            ephemeral = (
-                await config.user(interaction.user).history_ephemeral()
-                or await config.guild(interaction.guild).history_ephemeral()
-                or False
-            )
+            ephemeral = await config.user(interaction.user).history_ephemeral() or await config.guild(interaction.guild).history_ephemeral() or False
 
         if case != 0:
             case_dict = await fetch_case(case, interaction.guild.id)
             if case_dict:
                 if export:
                     if export.value == "file" or len(str(case_dict)) > 1800:
-                        filename = (
-                            str(data_manager.cog_data_path(cog_instance=self))
-                            + str(os.sep)
-                            + f"moderation_{interaction.guild.id}_case_{case}.json"
-                        )
+                        filename = str(data_manager.cog_data_path(cog_instance=self)) + str(os.sep) + f"moderation_{interaction.guild.id}_case_{case}.json"
 
                         with open(filename, "w", encoding="utf-8") as f:
                             json.dump(case_dict, f, indent=2)
 
                         if export.value == "codeblock":
                             content = f"Case #{case:,} exported.\n" + warning(
-                                "Case was too large to export as codeblock, so it has been uploaded as a `.json` file."
+                                "Case was too large to export as codeblock, so it has been uploaded as a `.json` file.",
                             )
                         else:
                             content = f"Case #{case:,} exported."
@@ -1427,34 +1418,41 @@ class Aurora(commands.Cog):
                         os.remove(filename)
                         return
                     await interaction.response.send_message(
-                        content=box(json.dumps(case_dict, indent=2), 'json'),
+                        content=box(json.dumps(case_dict, indent=2), "json"),
                         ephemeral=ephemeral,
                     )
                     return
                 if changes:
                     embed = await changes_factory(
-                        interaction=interaction, case_dict=case_dict
+                        interaction=interaction,
+                        case_dict=case_dict,
                     )
                     await interaction.response.send_message(
-                        embed=embed, ephemeral=ephemeral
+                        embed=embed,
+                        ephemeral=ephemeral,
                     )
                 elif evidenceformat:
                     content = await evidenceformat_factory(
-                        interaction=interaction, case_dict=case_dict
+                        interaction=interaction,
+                        case_dict=case_dict,
                     )
                     await interaction.response.send_message(
-                        content=content, ephemeral=ephemeral
+                        content=content,
+                        ephemeral=ephemeral,
                     )
                 else:
                     embed = await case_factory(
-                        interaction=interaction, case_dict=case_dict
+                        interaction=interaction,
+                        case_dict=case_dict,
                     )
                     await interaction.response.send_message(
-                        embed=embed, ephemeral=ephemeral
+                        embed=embed,
+                        ephemeral=ephemeral,
                     )
                 return
         await interaction.response.send_message(
-            content=f"No case with case number `{case}` found.", ephemeral=True
+            content=f"No case with case number `{case}` found.",
+            ephemeral=True,
         )
 
     @app_commands.command(name="edit")
@@ -1476,13 +1474,16 @@ class Aurora(commands.Cog):
         duration: str
             What is the new duration? Does not reapply the moderation if it has already expired.
         """
+        end_timestamp = None
         permissions = check_permissions(
-            interaction.client.user, ["embed_links"], interaction
+            interaction.client.user,
+            ["embed_links"],
+            interaction,
         )
         if permissions:
             await interaction.response.send_message(
                 error(
-                    f"I do not have the `{permissions}` permission, required for this action."
+                    f"I do not have the `{permissions}` permission, required for this action.",
                 ),
                 ephemeral=True,
             )
@@ -1496,26 +1497,25 @@ class Aurora(commands.Cog):
                     parsed_time = parse_timedelta(duration)
                     if parsed_time is None:
                         await interaction.response.send_message(
-                            error("Please provide a valid duration!"), ephemeral=True
+                            error("Please provide a valid duration!"),
+                            ephemeral=True,
                         )
                         return
 
                     end_timestamp = case_dict["timestamp"] + parsed_time.total_seconds()
 
                     if case_dict["moderation_type"] == "MUTE":
-                        if (
-                            time.time() - case_dict["timestamp"]
-                        ) + parsed_time.total_seconds() > 2419200:
+                        if (time.time() - case_dict["timestamp"]) + parsed_time.total_seconds() > 2419200:
                             await interaction.response.send_message(
                                 error(
-                                    "Please provide a duration that is less than 28 days from the initial moderation."
-                                )
+                                    "Please provide a duration that is less than 28 days from the initial moderation.",
+                                ),
                             )
                             return
 
                         try:
                             member = await interaction.guild.fetch_member(
-                                case_dict["target_id"]
+                                case_dict["target_id"],
                             )
 
                             await member.timeout(
@@ -1529,7 +1529,7 @@ class Aurora(commands.Cog):
                 if len(changes) > 25:
                     await interaction.response.send_message(
                         content=error(
-                            "Due to limitations with Discord's embed system, you cannot edit a case more than 25 times."
+                            "Due to limitations with Discord's embed system, you cannot edit a case more than 25 times.",
                         ),
                         ephemeral=True,
                     )
@@ -1543,9 +1543,10 @@ class Aurora(commands.Cog):
                             "user_id": case_dict["moderator_id"],
                             "duration": case_dict["duration"],
                             "end_timestamp": case_dict["end_timestamp"],
-                        }
+                        },
                     )
                 if parsed_time:
+                    assert end_timestamp is not None
                     changes.append(
                         {
                             "type": "EDIT",
@@ -1554,7 +1555,7 @@ class Aurora(commands.Cog):
                             "user_id": interaction.user.id,
                             "duration": convert_timedelta_to_str(parsed_time),
                             "end_timestamp": end_timestamp,
-                        }
+                        },
                     )
                 else:
                     changes.append(
@@ -1565,7 +1566,7 @@ class Aurora(commands.Cog):
                             "user_id": interaction.user.id,
                             "duration": case_dict["duration"],
                             "end_timestamp": case_dict["end_timestamp"],
-                        }
+                        },
                     )
 
                 database = connect()
@@ -1602,7 +1603,8 @@ class Aurora(commands.Cog):
                 database.close()
                 return
         await interaction.response.send_message(
-            content=error(f"No case with case number `{case}` found."), ephemeral=True
+            content=error(f"No case with case number `{case}` found."),
+            ephemeral=True,
         )
 
     @tasks.loop(minutes=1)
@@ -1634,14 +1636,11 @@ class Aurora(commands.Cog):
                 unban_num = 0
                 for target_id, moderation_id in zip(target_ids, moderation_ids):
                     user: discord.User = await self.bot.fetch_user(target_id)
-                    name = (
-                        f"{user.name}#{user.discriminator}"
-                        if user.discriminator != "0"
-                        else user.name
-                    )
+                    name = f"{user.name}#{user.discriminator}" if user.discriminator != "0" else user.name
                     try:
                         await guild.unban(
-                            user, reason=f"Automatic unban from case #{moderation_id}"
+                            user,
+                            reason=f"Automatic unban from case #{moderation_id}",
                         )
 
                         embed = await message_factory(
@@ -1690,13 +1689,16 @@ class Aurora(commands.Cog):
                 role_ids = [row[2] for row in result]
 
                 for target_id, moderation_id, role_id in zip(
-                    target_ids, moderation_ids, role_ids
+                    target_ids,
+                    moderation_ids,
+                    role_ids,
                 ):
                     try:
                         member = await guild.fetch_member(target_id)
 
                         await member.remove_roles(
-                            Object(role_id), reason=f"Automatic role removal from case #{moderation_id}"
+                            Object(role_id),
+                            reason=f"Automatic role removal from case #{moderation_id}",
                         )
 
                         removerole_num = removerole_num + 1
@@ -1725,13 +1727,16 @@ class Aurora(commands.Cog):
                 role_ids = [row[2] for row in result]
 
                 for target_id, moderation_id, role_id in zip(
-                    target_ids, moderation_ids, role_ids
+                    target_ids,
+                    moderation_ids,
+                    role_ids,
                 ):
                     try:
                         member = await guild.fetch_member(target_id)
 
                         await member.add_roles(
-                            Object(role_id), reason=f"Automatic role addition from case #{moderation_id}"
+                            Object(role_id),
+                            reason=f"Automatic role addition from case #{moderation_id}",
                         )
 
                         addrole_num = addrole_num + 1
@@ -1827,15 +1832,11 @@ class Aurora(commands.Cog):
     @commands.admin()
     async def aurora_import_aurora(self, ctx: commands.Context):
         """Import moderation history from another bot using Aurora."""
-        if (
-            ctx.message.attachments
-            and ctx.message.attachments[0].content_type
-            == "application/json; charset=utf-8"
-        ):
+        if ctx.message.attachments and ctx.message.attachments[0].content_type == "application/json; charset=utf-8":
             message = await ctx.send(
                 warning(
-                    "Are you sure you want to import moderations from another bot?\n**This will overwrite any moderations that already exist in this guild's moderation table.**\n*The import process will block the rest of your bot until it is complete.*"
-                )
+                    "Are you sure you want to import moderations from another bot?\n**This will overwrite any moderations that already exist in this guild's moderation table.**\n*The import process will block the rest of your bot until it is complete.*",
+                ),
             )
             await message.edit(view=ImportAuroraView(60, ctx, message))
         else:
@@ -1845,20 +1846,16 @@ class Aurora(commands.Cog):
     @commands.admin()
     async def aurora_import_galacticbot(self, ctx: commands.Context):
         """Import moderation history from GalacticBot."""
-        if (
-            ctx.message.attachments
-            and ctx.message.attachments[0].content_type
-            == "application/json; charset=utf-8"
-        ):
+        if ctx.message.attachments and ctx.message.attachments[0].content_type == "application/json; charset=utf-8":
             message = await ctx.send(
                 warning(
-                    "Are you sure you want to import GalacticBot moderations?\n**This will overwrite any moderations that already exist in this guild's moderation table.**\n*The import process will block the rest of your bot until it is complete.*"
-                )
+                    "Are you sure you want to import GalacticBot moderations?\n**This will overwrite any moderations that already exist in this guild's moderation table.**\n*The import process will block the rest of your bot until it is complete.*",
+                ),
             )
             await message.edit(view=ImportGalacticBotView(60, ctx, message))
         else:
             await ctx.send(
-                error("Please provide a valid GalacticBot moderation export file.")
+                error("Please provide a valid GalacticBot moderation export file."),
             )
 
     @aurora.command(aliases=["tdc", "td", "timedeltaconvert"])

aurora/importers/aurora.py

@@ -17,13 +17,9 @@ class ImportAuroraView(ui.View):
         self.message: Message = message
 
     @ui.button(label="Yes", style=ButtonStyle.success)
-    async def import_button_y(
-        self, interaction: Interaction, button: ui.Button
-    ): # pylint: disable=unused-argument
+    async def import_button_y(self, interaction: Interaction, button: ui.Button):  # pylint: disable=unused-argument
         await self.message.delete()
-        await interaction.response.send_message(
-            "Deleting original table...", ephemeral=True
-        )
+        await interaction.response.send_message("Deleting original table...", ephemeral=True)
 
         database = connect()
         cursor = database.cursor()
@@ -101,16 +97,10 @@ class ImportAuroraView(ui.View):
 
         await interaction.edit_original_response(content="Import complete.")
         if failed_cases:
-            await interaction.edit_original_response(
-                content="Import complete.\n"
-                + warning("Failed to import the following cases:\n")
-                + box(failed_cases)
-            )
+            await interaction.edit_original_response(content="Import complete.\n" + warning("Failed to import the following cases:\n") + box(failed_cases))
 
     @ui.button(label="No", style=ButtonStyle.danger)
-    async def import_button_n(
-        self, interaction: Interaction, button: ui.Button
-    ): # pylint: disable=unused-argument
+    async def import_button_n(self, interaction: Interaction, button: ui.Button):  # pylint: disable=unused-argument
         await self.message.edit(content="Import cancelled.", view=None)
         await self.message.delete(10)
         await self.ctx.message.delete(10)

aurora/importers/galacticbot.py

@@ -16,13 +16,9 @@ class ImportGalacticBotView(ui.View):
         self.message: Message = message
 
     @ui.button(label="Yes", style=ButtonStyle.success)
-    async def import_button_y(
-        self, interaction: Interaction, button: ui.Button
-    ): # pylint: disable=unused-argument
+    async def import_button_y(self, interaction: Interaction, button: ui.Button):  # pylint: disable=unused-argument
         await self.message.delete()
-        await interaction.response.send_message(
-            "Deleting original table...", ephemeral=True
-        )
+        await interaction.response.send_message("Deleting original table...", ephemeral=True)
 
         database = connect()
         cursor = database.cursor()
@@ -92,9 +88,7 @@ class ImportGalacticBotView(ui.View):
                 if resolved_by is None:
                     resolved_by = "?"
                 if resolved_reason is None:
-                    resolved_reason = (
-                        "Could not get resolve reason during moderation import."
-                    )
+                    resolved_reason = "Could not get resolve reason during moderation import."
                 if resolved_timestamp is None:
                     resolved_timestamp = timestamp
                 changes = [
@@ -142,16 +136,10 @@ class ImportGalacticBotView(ui.View):
 
         await interaction.edit_original_response(content="Import complete.")
         if failed_cases:
-            await interaction.edit_original_response(
-                content="Import complete.\n"
-                + warning("Failed to import the following cases:\n")
-                + box(failed_cases)
-            )
+            await interaction.edit_original_response(content="Import complete.\n" + warning("Failed to import the following cases:\n") + box(failed_cases))
 
     @ui.button(label="No", style=ButtonStyle.danger)
-    async def import_button_n(
-        self, interaction: Interaction, button: ui.Button
-    ): # pylint: disable=unused-argument
+    async def import_button_n(self, interaction: Interaction, button: ui.Button):  # pylint: disable=unused-argument
         await self.message.edit(content="Import cancelled.", view=None)
         await self.message.delete(10)
         await self.ctx.message.delete(10)

aurora/menus/guild.py

@@ -107,7 +107,11 @@ class Guild(ui.View):
         await interaction.message.edit(embed=await guild_embed(self.ctx))
 
     @ui.select(placeholder="History Pagesize", options=create_pagesize_options(), row=2)
-    async def pagesize(self, interaction: Interaction, select: ui.Select,):
+    async def pagesize(
+        self,
+        interaction: Interaction,
+        select: ui.Select,
+    ):
         if not interaction.user.guild_permissions.manage_guild and not interaction.user.guild_permissions.administrator:
             await interaction.response.send_message("You must have the manage guild permission to change this setting.", ephemeral=True)
             return
@@ -119,7 +123,11 @@ class Guild(ui.View):
         await interaction.message.edit(embed=await guild_embed(self.ctx))
 
     @ui.select(placeholder="History Inline Pagesize", options=create_pagesize_options(), row=3)
-    async def inline_pagesize(self, interaction: Interaction, select: ui.Select,):
+    async def inline_pagesize(
+        self,
+        interaction: Interaction,
+        select: ui.Select,
+    ):
         if not interaction.user.guild_permissions.manage_guild and not interaction.user.guild_permissions.administrator:
             await interaction.response.send_message("You must have the manage guild permission to change this setting.", ephemeral=True)
             return

aurora/menus/overrides.py

@@ -62,7 +62,11 @@ class Overrides(ui.View):
         await interaction.message.edit(embed=await overrides_embed(self.ctx))
 
     @ui.select(placeholder="Inline Pagesize", options=create_pagesize_options(), row=1)
-    async def inline_pagesize(self, interaction: Interaction, select: ui.Select,):
+    async def inline_pagesize(
+        self,
+        interaction: Interaction,
+        select: ui.Select,
+    ):
         if self.ctx.author != interaction.user:
             await interaction.response.send_message("You cannot change this setting for other users.", ephemeral=True)
             return
@@ -74,7 +78,11 @@ class Overrides(ui.View):
         await interaction.message.edit(embed=await overrides_embed(self.ctx))
 
     @ui.select(placeholder="Pagesize", options=create_pagesize_options(), row=2)
-    async def pagesize(self, interaction: Interaction, select: ui.Select,):
+    async def pagesize(
+        self,
+        interaction: Interaction,
+        select: ui.Select,
+    ):
         if self.ctx.author != interaction.user:
             await interaction.response.send_message("You cannot change this setting for other users.", ephemeral=True)
             return

aurora/utilities/database.py

@@ -8,23 +8,18 @@ from discord import Guild
 from redbot.core import data_manager
 
 from .logger import logger
-from .utils import (convert_timedelta_to_str, generate_dict,
-                    get_next_case_number)
+from .utils import convert_timedelta_to_str, generate_dict, get_next_case_number
 
 
 def connect() -> sqlite3.Connection:
     """Connects to the SQLite database, and returns a connection object."""
     try:
-        connection = sqlite3.connect(
-            database=data_manager.cog_data_path(raw_name="Aurora") / "aurora.db"
-        )
-        return connection
+        return sqlite3.connect(database=data_manager.cog_data_path(raw_name="Aurora") / "aurora.db")
 
     except sqlite3.OperationalError as e:
         logger.error("Unable to access the SQLite database!\nError:\n%s", e.msg)
-        raise ConnectionRefusedError(
-            f"Unable to access the SQLite Database!\n{e.msg}"
-        ) from e
+        msg = f"Unable to access the SQLite Database!\n{e.msg}"
+        raise ConnectionRefusedError(msg) from e
 
 
 async def create_guild_table(guild: Guild):

aurora/utilities/factory.py

@@ -75,7 +75,9 @@ async def message_factory(
 
     if await config.guild(guild).show_moderator() and moderator is not None:
         embed.add_field(
-            name="Moderator", value=f"`{moderator.name} ({moderator.id})`", inline=False
+            name="Moderator",
+            value=f"`{moderator.name} ({moderator.id})`",
+            inline=False,
         )
 
     embed.add_field(name="Reason", value=f"`{reason}`", inline=False)
@@ -94,7 +96,9 @@ async def message_factory(
 
 
 async def log_factory(
-    interaction: Interaction, case_dict: dict, resolved: bool = False
+    interaction: Interaction,
+    case_dict: dict,
+    resolved: bool = False,
 ) -> Embed:
     """This function creates a log embed from set parameters, meant for moderation logging.
 
@@ -103,14 +107,11 @@ async def log_factory(
         case_dict (dict): The case dictionary.
         resolved (bool, optional): Whether the case is resolved or not. Defaults to False.
     """
+    target_name = ""
     if resolved:
         if case_dict["target_type"] == "USER":
             target_user = await fetch_user_dict(interaction.client, case_dict["target_id"])
-            target_name = (
-                f"`{target_user['name']}`"
-                if target_user["discriminator"] == "0"
-                else f"`{target_user['name']}#{target_user['discriminator']}`"
-            )
+            target_name = f"`{target_user['name']}`" if target_user["discriminator"] == "0" else f"`{target_user['name']}#{target_user['discriminator']}`"
         elif case_dict["target_type"] == "CHANNEL":
             target_user = await fetch_channel_dict(interaction.guild, case_dict["target_id"])
             if target_user["mention"]:
@@ -119,11 +120,7 @@ async def log_factory(
                 target_name = f"`{target_user['name']}`"
 
         moderator_user = await fetch_user_dict(interaction.client, case_dict["moderator_id"])
-        moderator_name = (
-            f"`{moderator_user['name']}`"
-            if moderator_user["discriminator"] == "0"
-            else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
-        )
+        moderator_name = f"`{moderator_user['name']}`" if moderator_user["discriminator"] == "0" else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
 
         embed = Embed(
             title=f"📕 Case #{case_dict['moderation_id']:,} Resolved",
@@ -140,40 +137,24 @@ async def log_factory(
                         ["hours", "minutes", "seconds"],
                         case_dict["duration"].split(":"),
                     )
-                }
-            )
-            duration_embed = (
-                f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
-                if case_dict["expired"] == "0"
-                else str(humanize_timedelta(timedelta=td))
-            )
-            embed.description = (
-                embed.description
-                + f"\n**Duration:** {duration_embed}\n**Expired:** {bool(case_dict['expired'])}"
+                },
             )
+            duration_embed = f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>" if case_dict["expired"] == "0" else str(humanize_timedelta(timedelta=td))
+            embed.description = embed.description + f"\n**Duration:** {duration_embed}\n**Expired:** {bool(case_dict['expired'])}"
 
         embed.add_field(name="Reason", value=box(case_dict["reason"]), inline=False)
 
         resolved_user = await fetch_user_dict(interaction.client, case_dict["resolved_by"])
-        resolved_name = (
-            resolved_user["name"]
-            if resolved_user["discriminator"] == "0"
-            else f"{resolved_user['name']}#{resolved_user['discriminator']}"
-        )
+        resolved_name = resolved_user["name"] if resolved_user["discriminator"] == "0" else f"{resolved_user['name']}#{resolved_user['discriminator']}"
         embed.add_field(
             name="Resolve Reason",
-            value=f"Resolved by `{resolved_name}` ({resolved_user['id']}) for:\n"
-            + box(case_dict["resolve_reason"]),
+            value=f"Resolved by `{resolved_name}` ({resolved_user['id']}) for:\n" + box(case_dict["resolve_reason"]),
             inline=False,
         )
     else:
         if case_dict["target_type"] == "USER":
             target_user = await fetch_user_dict(interaction.client, case_dict["target_id"])
-            target_name = (
-                f"`{target_user['name']}`"
-                if target_user["discriminator"] == "0"
-                else f"`{target_user['name']}#{target_user['discriminator']}`"
-            )
+            target_name = f"`{target_user['name']}`" if target_user["discriminator"] == "0" else f"`{target_user['name']}#{target_user['discriminator']}`"
         elif case_dict["target_type"] == "CHANNEL":
             target_user = await fetch_channel_dict(interaction.guild, case_dict["target_id"])
             if target_user["mention"]:
@@ -182,11 +163,7 @@ async def log_factory(
                 target_name = f"`{target_user['name']}`"
 
         moderator_user = await fetch_user_dict(interaction.client, case_dict["moderator_id"])
-        moderator_name = (
-            f"`{moderator_user['name']}`"
-            if moderator_user["discriminator"] == "0"
-            else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
-        )
+        moderator_name = f"`{moderator_user['name']}`" if moderator_user["discriminator"] == "0" else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
 
         embed = Embed(
             title=f"📕 Case #{case_dict['moderation_id']:,}",
@@ -202,12 +179,9 @@ async def log_factory(
                         ["hours", "minutes", "seconds"],
                         case_dict["duration"].split(":"),
                     )
-                }
-            )
-            embed.description = (
-                embed.description
-                + f"\n**Duration:** {humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
+                },
             )
+            embed.description = embed.description + f"\n**Duration:** {humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
 
         embed.add_field(name="Reason", value=box(case_dict["reason"]), inline=False)
     return embed
@@ -220,13 +194,10 @@ async def case_factory(interaction: Interaction, case_dict: dict) -> Embed:
         interaction (Interaction): The interaction object.
         case_dict (dict): The case dictionary.
     """
+    target_name = ""
     if case_dict["target_type"] == "USER":
         target_user = await fetch_user_dict(interaction.client, case_dict["target_id"])
-        target_name = (
-            f"`{target_user['name']}`"
-            if target_user["discriminator"] == "0"
-            else f"`{target_user['name']}#{target_user['discriminator']}`"
-        )
+        target_name = f"`{target_user['name']}`" if target_user["discriminator"] == "0" else f"`{target_user['name']}#{target_user['discriminator']}`"
     elif case_dict["target_type"] == "CHANNEL":
         target_user = await fetch_channel_dict(interaction.guild, case_dict["target_id"])
         if target_user["mention"]:
@@ -235,11 +206,7 @@ async def case_factory(interaction: Interaction, case_dict: dict) -> Embed:
             target_name = f"`{target_user['name']}`"
 
     moderator_user = await fetch_user_dict(interaction.client, case_dict["moderator_id"])
-    moderator_name = (
-        f"`{moderator_user['name']}`"
-        if moderator_user["discriminator"] == "0"
-        else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
-    )
+    moderator_name = f"`{moderator_user['name']}`" if moderator_user["discriminator"] == "0" else f"`{moderator_user['name']}#{moderator_user['discriminator']}`"
 
     embed = Embed(
         title=f"📕 Case #{case_dict['moderation_id']:,}",
@@ -252,41 +219,28 @@ async def case_factory(interaction: Interaction, case_dict: dict) -> Embed:
             **{
                 unit: int(val)
                 for unit, val in zip(
-                    ["hours", "minutes", "seconds"], case_dict["duration"].split(":")
+                    ["hours", "minutes", "seconds"],
+                    case_dict["duration"].split(":"),
                 )
-            }
-        )
-        duration_embed = (
-            f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>"
-            if bool(case_dict["expired"]) is False
-            else str(humanize_timedelta(timedelta=td))
+            },
         )
+        duration_embed = f"{humanize_timedelta(timedelta=td)} | <t:{case_dict['end_timestamp']}:R>" if bool(case_dict["expired"]) is False else str(humanize_timedelta(timedelta=td))
         embed.description += f"\n**Duration:** {duration_embed}\n**Expired:** {bool(case_dict['expired'])}"
 
-    embed.description += (
-        f"\n**Changes:** {len(case_dict['changes']) - 1}"
-        if case_dict["changes"]
-        else "\n**Changes:** 0"
-    )
+    embed.description += f"\n**Changes:** {len(case_dict['changes']) - 1}" if case_dict["changes"] else "\n**Changes:** 0"
 
     if case_dict["role_id"]:
         embed.description += f"\n**Role:** <@&{case_dict['role_id']}>"
 
     if case_dict["metadata"]:
         if case_dict["metadata"]["imported_from"]:
-            embed.description += (
-                f"\n**Imported From:** {case_dict['metadata']['imported_from']}"
-            )
+            embed.description += f"\n**Imported From:** {case_dict['metadata']['imported_from']}"
 
     embed.add_field(name="Reason", value=box(case_dict["reason"]), inline=False)
 
     if case_dict["resolved"] == 1:
         resolved_user = await fetch_user_dict(interaction.client, case_dict["resolved_by"])
-        resolved_name = (
-            f"`{resolved_user['name']}`"
-            if resolved_user["discriminator"] == "0"
-            else f"`{resolved_user['name']}#{resolved_user['discriminator']}`"
-        )
+        resolved_name = f"`{resolved_user['name']}`" if resolved_user["discriminator"] == "0" else f"`{resolved_user['name']}#{resolved_user['discriminator']}`"
         embed.add_field(
             name="Resolve Reason",
             value=f"Resolved by {resolved_name} ({resolved_user['id']}) for:\n{box(case_dict['resolve_reason'])}",
@@ -314,15 +268,12 @@ async def changes_factory(interaction: Interaction, case_dict: dict) -> Embed:
         for change in case_dict["changes"]:
             if change["user_id"] not in memory_dict:
                 memory_dict[str(change["user_id"])] = await fetch_user_dict(
-                    interaction.client, change["user_id"]
+                    interaction.client,
+                    change["user_id"],
                 )
 
             user = memory_dict[str(change["user_id"])]
-            name = (
-                user["name"]
-                if user["discriminator"] == "0"
-                else f"{user['name']}#{user['discriminator']}"
-            )
+            name = user["name"] if user["discriminator"] == "0" else f"{user['name']}#{user['discriminator']}"
 
             timestamp = f"<t:{change['timestamp']}> | <t:{change['timestamp']}:R>"
 
@@ -360,24 +311,17 @@ async def evidenceformat_factory(interaction: Interaction, case_dict: dict) -> s
         interaction (Interaction): The interaction object.
         case_dict (dict): The case dictionary.
     """
+    target_name = ""
     if case_dict["target_type"] == "USER":
         target_user = await fetch_user_dict(interaction.client, case_dict["target_id"])
-        target_name = (
-            target_user["name"]
-            if target_user["discriminator"] == "0"
-            else f"{target_user['name']}#{target_user['discriminator']}"
-        )
+        target_name = target_user["name"] if target_user["discriminator"] == "0" else f"{target_user['name']}#{target_user['discriminator']}"
 
     elif case_dict["target_type"] == "CHANNEL":
         target_user = await fetch_channel_dict(interaction.guild, case_dict["target_id"])
         target_name = target_user["name"]
 
     moderator_user = await fetch_user_dict(interaction.client, case_dict["moderator_id"])
-    moderator_name = (
-        moderator_user["name"]
-        if moderator_user["discriminator"] == "0"
-        else f"{moderator_user['name']}#{moderator_user['discriminator']}"
-    )
+    moderator_name = moderator_user["name"] if moderator_user["discriminator"] == "0" else f"{moderator_user['name']}#{moderator_user['discriminator']}"
 
     content = f"Case: {case_dict['moderation_id']:,} ({str.title(case_dict['moderation_type'])})\nTarget: {target_name} ({target_user['id']})\nModerator: {moderator_name} ({moderator_user['id']})"
 
@@ -419,17 +363,11 @@ async def overrides_embed(ctx: commands.Context) -> Embed:
     }
 
     override_str = [
-        "- "
-        + bold("Auto Evidence Format: ")
-        + get_bool_emoji(override_settings["auto_evidenceformat"]),
+        "- " + bold("Auto Evidence Format: ") + get_bool_emoji(override_settings["auto_evidenceformat"]),
         "- " + bold("Ephemeral: ") + get_bool_emoji(override_settings["ephemeral"]),
         "- " + bold("History Inline: ") + get_bool_emoji(override_settings["inline"]),
-        "- "
-        + bold("History Inline Pagesize: ")
-        + get_pagesize_str(override_settings["inline_pagesize"]),
-        "- "
-        + bold("History Pagesize: ")
-        + get_pagesize_str(override_settings["pagesize"]),
+        "- " + bold("History Inline Pagesize: ") + get_pagesize_str(override_settings["inline_pagesize"]),
+        "- " + bold("History Pagesize: ") + get_pagesize_str(override_settings["pagesize"]),
     ]
     override_str = "\n".join(override_str)
 
@@ -451,7 +389,7 @@ async def guild_embed(ctx: commands.Context) -> Embed:
     guild_settings = {
         "show_moderator": await config.guild(ctx.guild).show_moderator(),
         "use_discord_permissions": await config.guild(
-            ctx.guild
+            ctx.guild,
         ).use_discord_permissions(),
         "ignore_modlog": await config.guild(ctx.guild).ignore_modlog(),
         "ignore_other_bots": await config.guild(ctx.guild).ignore_other_bots(),
@@ -461,7 +399,7 @@ async def guild_embed(ctx: commands.Context) -> Embed:
         "history_inline": await config.guild(ctx.guild).history_inline(),
         "history_pagesize": await config.guild(ctx.guild).history_pagesize(),
         "history_inline_pagesize": await config.guild(
-            ctx.guild
+            ctx.guild,
         ).history_inline_pagesize(),
         "auto_evidenceformat": await config.guild(ctx.guild).auto_evidenceformat(),
         "respect_hierarchy": await config.guild(ctx.guild).respect_hierarchy(),
@@ -474,37 +412,17 @@ async def guild_embed(ctx: commands.Context) -> Embed:
         channel = channel.mention
 
     guild_str = [
-        "- "
-        + bold("Show Moderator: ")
-        + get_bool_emoji(guild_settings["show_moderator"]),
-        "- "
-        + bold("Use Discord Permissions: ")
-        + get_bool_emoji(guild_settings["use_discord_permissions"]),
-        "- "
-        + bold("Respect Hierarchy: ")
-        + get_bool_emoji(guild_settings["respect_hierarchy"]),
-        "- "
-        + bold("Ignore Modlog: ")
-        + get_bool_emoji(guild_settings["ignore_modlog"]),
-        "- "
-        + bold("Ignore Other Bots: ")
-        + get_bool_emoji(guild_settings["ignore_other_bots"]),
+        "- " + bold("Show Moderator: ") + get_bool_emoji(guild_settings["show_moderator"]),
+        "- " + bold("Use Discord Permissions: ") + get_bool_emoji(guild_settings["use_discord_permissions"]),
+        "- " + bold("Respect Hierarchy: ") + get_bool_emoji(guild_settings["respect_hierarchy"]),
+        "- " + bold("Ignore Modlog: ") + get_bool_emoji(guild_settings["ignore_modlog"]),
+        "- " + bold("Ignore Other Bots: ") + get_bool_emoji(guild_settings["ignore_other_bots"]),
         "- " + bold("DM Users: ") + get_bool_emoji(guild_settings["dm_users"]),
-        "- "
-        + bold("Auto Evidence Format: ")
-        + get_bool_emoji(guild_settings["auto_evidenceformat"]),
-        "- "
-        + bold("Ephemeral: ")
-        + get_bool_emoji(guild_settings["history_ephemeral"]),
-        "- "
-        + bold("History Inline: ")
-        + get_bool_emoji(guild_settings["history_inline"]),
-        "- "
-        + bold("History Pagesize: ")
-        + get_pagesize_str(guild_settings["history_pagesize"]),
-        "- "
-        + bold("History Inline Pagesize: ")
-        + get_pagesize_str(guild_settings["history_inline_pagesize"]),
+        "- " + bold("Auto Evidence Format: ") + get_bool_emoji(guild_settings["auto_evidenceformat"]),
+        "- " + bold("Ephemeral: ") + get_bool_emoji(guild_settings["history_ephemeral"]),
+        "- " + bold("History Inline: ") + get_bool_emoji(guild_settings["history_inline"]),
+        "- " + bold("History Pagesize: ") + get_pagesize_str(guild_settings["history_pagesize"]),
+        "- " + bold("History Inline Pagesize: ") + get_pagesize_str(guild_settings["history_inline_pagesize"]),
         "- " + bold("Log Channel: ") + channel,
     ]
     guild_str = "\n".join(guild_str)
@@ -528,17 +446,21 @@ async def addrole_embed(ctx: commands.Context) -> Embed:
         for role in whitelist:
             evalulated_role = ctx.guild.get_role(role) or error(f"`{role}` (Not Found)")
             if isinstance(evalulated_role, Role):
-                roles.append({
+                roles.append(
+                    {
                         "id": evalulated_role.id,
                         "mention": evalulated_role.mention,
-                    "position": evalulated_role.position
-                })
+                        "position": evalulated_role.position,
+                    },
+                )
             else:
-                roles.append({
+                roles.append(
+                    {
                         "id": role,
                         "mention": error(f"`{role}` (Not Found)"),
-                    "position": 0
-                })
+                        "position": 0,
+                    },
+                )
 
     if roles:
         roles = sorted(roles, key=lambda x: x["position"], reverse=True)
@@ -549,9 +471,7 @@ async def addrole_embed(ctx: commands.Context) -> Embed:
 
     e = await _config(ctx)
     e.title += ": Addrole Whitelist"
-    e.description = (
-        "Use the select menu below to manage this guild's addrole whitelist."
-    )
+    e.description = "Use the select menu below to manage this guild's addrole whitelist."
 
     if len(whitelist_str) > 4000 and len(whitelist_str) < 5000:
         lines = whitelist_str.split("\n")
@@ -581,17 +501,21 @@ async def immune_embed(ctx: commands.Context) -> Embed:
         for role in immune_roles:
             evalulated_role = ctx.guild.get_role(role) or error(f"`{role}` (Not Found)")
             if isinstance(evalulated_role, Role):
-                roles.append({
+                roles.append(
+                    {
                         "id": evalulated_role.id,
                         "mention": evalulated_role.mention,
-                    "position": evalulated_role.position
-                })
+                        "position": evalulated_role.position,
+                    },
+                )
             else:
-                roles.append({
+                roles.append(
+                    {
                         "id": role,
                         "mention": error(f"`{role}` (Not Found)"),
-                    "position": 0
-                })
+                        "position": 0,
+                    },
+                )
 
     if roles:
         roles = sorted(roles, key=lambda x: x["position"], reverse=True)

aurora/utilities/utils.py

@@ -32,24 +32,17 @@ def check_permissions(
         raise (KeyError)
 
     for permission in permissions:
-        if (
-            not getattr(resolved_permissions, permission, False)
-            and resolved_permissions.administrator is not True
-        ):
+        if not getattr(resolved_permissions, permission, False) and resolved_permissions.administrator is not True:
             return permission
 
     return False
 
 
-async def check_moddable(
-    target: Union[User, Member], interaction: Interaction, permissions: list
-) -> bool:
+async def check_moddable(target: Union[User, Member], interaction: Interaction, permissions: list) -> bool:
     """Checks if a moderator can moderate a target."""
     if check_permissions(interaction.client.user, permissions, guild=interaction.guild):
         await interaction.response.send_message(
-            error(
-                f"I do not have the `{permissions}` permission, required for this action."
-            ),
+            error(f"I do not have the `{permissions}` permission, required for this action."),
             ephemeral=True,
         )
         return False
@@ -57,43 +50,30 @@ async def check_moddable(
     if await config.guild(interaction.guild).use_discord_permissions() is True:
         if check_permissions(interaction.user, permissions, guild=interaction.guild):
             await interaction.response.send_message(
-                error(
-                    f"You do not have the `{permissions}` permission, required for this action."
-                ),
+                error(f"You do not have the `{permissions}` permission, required for this action."),
                 ephemeral=True,
             )
             return False
 
     if interaction.user.id == target.id:
-        await interaction.response.send_message(
-            content="You cannot moderate yourself!", ephemeral=True
-        )
+        await interaction.response.send_message(content="You cannot moderate yourself!", ephemeral=True)
         return False
 
     if target.bot:
-        await interaction.response.send_message(
-            content="You cannot moderate bots!", ephemeral=True
-        )
+        await interaction.response.send_message(content="You cannot moderate bots!", ephemeral=True)
         return False
 
     if isinstance(target, Member):
         if interaction.user.top_role <= target.top_role and await config.guild(interaction.guild).respect_hierarchy() is True:
             await interaction.response.send_message(
-                content=error(
-                    "You cannot moderate members with a higher role than you!"
-                ),
+                content=error("You cannot moderate members with a higher role than you!"),
                 ephemeral=True,
             )
             return False
 
-        if (
-            interaction.guild.get_member(interaction.client.user.id).top_role
-            <= target.top_role
-        ):
+        if interaction.guild.get_member(interaction.client.user.id).top_role <= target.top_role:
             await interaction.response.send_message(
-                content=error(
-                    "You cannot moderate members with a role higher than the bot!"
-                ),
+                content=error("You cannot moderate members with a role higher than the bot!"),
                 ephemeral=True,
             )
             return False
@@ -118,15 +98,13 @@ async def get_next_case_number(guild_id: str, cursor=None) -> int:
     if not cursor:
         database = connect()
         cursor = database.cursor()
-    cursor.execute(
-        f"SELECT moderation_id FROM `moderation_{guild_id}` ORDER BY moderation_id DESC LIMIT 1"
-    )
+    cursor.execute(f"SELECT moderation_id FROM `moderation_{guild_id}` ORDER BY moderation_id DESC LIMIT 1")
     result = cursor.fetchone()
     return (result[0] + 1) if result else 1
 
 
 def generate_dict(result) -> dict:
-    case = {
+    return {
         "moderation_id": result[0],
         "timestamp": result[1],
         "moderation_type": result[2],
@@ -144,7 +122,6 @@ def generate_dict(result) -> dict:
         "changes": json.loads(result[14]),
         "metadata": json.loads(result[15]),
     }
-    return case
 
 
 async def fetch_user_dict(client: commands.Bot, user_id: str) -> dict:
@@ -171,7 +148,6 @@ async def fetch_user_dict(client: commands.Bot, user_id: str) -> dict:
                 "discriminator": "0",
             }
 
-
     return user_dict
 
 
@@ -198,11 +174,9 @@ async def fetch_role_dict(guild: Guild, role_id: int) -> dict:
     """This function returns a dictionary containing either role information or a standard deleted role template."""
     role = guild.get_role(int(role_id))
     if not role:
-        role_dict = {"id": role_id, "name": "Deleted Role"}
+        pass
 
-    role_dict = {"id": role.id, "name": role.name}
-
-    return role_dict
+    return {"id": role.id, "name": role.name}
 
 
 async def log(interaction: Interaction, moderation_id: int, resolved: bool = False) -> None:
@@ -216,9 +190,7 @@ async def log(interaction: Interaction, moderation_id: int, resolved: bool = Fal
 
         case = await fetch_case(moderation_id, interaction.guild.id)
         if case:
-            embed = await log_factory(
-                interaction=interaction, case_dict=case, resolved=resolved
-            )
+            embed = await log_factory(interaction=interaction, case_dict=case, resolved=resolved)
             try:
                 await logging_channel.send(embed=embed)
             except Forbidden:
@@ -229,11 +201,7 @@ async def send_evidenceformat(interaction: Interaction, case_dict: dict) -> None
     """This function sends an ephemeral message to the moderator who took the moderation action, with a pre-made codeblock for use in the mod-evidence channel."""
     from .factory import evidenceformat_factory
 
-    send_evidence_bool = (
-        await config.user(interaction.user).auto_evidenceformat()
-        or await config.guild(interaction.guild).auto_evidenceformat()
-        or False
-    )
+    send_evidence_bool = await config.user(interaction.user).auto_evidenceformat() or await config.guild(interaction.guild).auto_evidenceformat() or False
     if send_evidence_bool is False:
         return
 
@@ -274,24 +242,19 @@ def create_pagesize_options() -> list[SelectOption]:
             label="Default",
             value="default",
             description="Reset the pagesize to the default value.",
+        ),
     )
-    )
-    for i in range(1, 21):
-        options.append(
-            SelectOption(
-                label=str(i),
-                value=str(i),
-                description=f"Set the pagesize to {i}.",
-            )
-        )
+    options.extend(SelectOption(label=str(i), value=str(i), description=f"Set the pagesize to {i}") for i in range(1, 21))
     return options
 
+
 def timedelta_from_relativedelta(relativedelta: rd) -> td:
     """Converts a relativedelta object to a timedelta object."""
     now = datetime.now()
     then = now - relativedelta
     return now - then
 
+
 def get_footer_image(coginstance: commands.Cog) -> File:
     """Returns the footer image for the embeds."""
     image_path = data_manager.bundled_data_path(coginstance) / "arrow.png"

backup/backup.py

@@ -17,13 +17,16 @@ from redbot.core.bot import Red
 from redbot.core.utils.chat_formatting import bold, error, humanize_list, text_to_file
 
 
+# Disable Ruff & Pylint complaining about accessing private members
+# That's kind of necessary for this cog to function because the Downloader cog has a limited public API
+# ruff: noqa: SLF001 # Private member access
 # pylint: disable=protected-access
 class Backup(commands.Cog):
     """A utility to make reinstalling repositories and cogs after migrating the bot far easier."""
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.1.1"
+    __version__ = "1.1.4"
     __documentation__ = "https://seacogs.coastalcommits.com/backup/"
 
     def __init__(self, bot: Red):
@@ -42,22 +45,18 @@ class Backup(commands.Cog):
         ]
         return "\n".join(text)
 
-    @commands.group(autohelp=True)
+    @commands.group(autohelp=True)  # type: ignore
     @commands.is_owner()
-    async def backup(self, ctx: commands.Context):
+    async def backup(self, ctx: commands.Context) -> None:
         """Backup your installed cogs."""
 
     @backup.command(name="export")
     @commands.is_owner()
-    async def backup_export(self, ctx: commands.Context):
+    async def backup_export(self, ctx: commands.Context) -> None:
         """Export your installed repositories and cogs to a file."""
         downloader = ctx.bot.get_cog("Downloader")
         if downloader is None:
-            await ctx.send(
-                error(
-                    f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."
-                )
-            )
+            await ctx.send(error(f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."))
             return
 
         all_repos = list(downloader._repo_manager.repos)
@@ -78,7 +77,7 @@ class Backup(commands.Cog):
                 if cog.repo_name == repo.name:
                     cog_dict = {
                         "name": cog.name,
-                        # "loaded": cog.name in ctx.bot.extensions.keys(),
+                        # "loaded": cog.name in ctx.bot.extensions.keys(),  # noqa: ERA001
                         # this functionality was planned but never implemented due to Red limitations
                         # and the possibility of restoration functionality being added to Core
                         "pinned": cog.pinned,
@@ -88,30 +87,24 @@ class Backup(commands.Cog):
 
             export_data.append(repo_dict)
 
-        await ctx.send(
-            file=text_to_file(json.dumps(export_data, indent=4), "backup.json")
-        )
+        await ctx.send(file=text_to_file(json.dumps(export_data, indent=4), "backup.json"))
 
     @backup.command(name="import")
     @commands.is_owner()
-    async def backup_import(self, ctx: commands.Context):
+    async def backup_import(self, ctx: commands.Context) -> None:
         """Import your installed repositories and cogs from an export file."""
         try:
             export = json.loads(await ctx.message.attachments[0].read())
         except (json.JSONDecodeError, IndexError):
             try:
-                export = json.loads(await ctx.message.reference.resolved.attachments[0].read())
+                export = json.loads(await ctx.message.reference.resolved.attachments[0].read())  # type: ignore - this is fine to let error because it gets handled
             except (json.JSONDecodeError, IndexError, AttributeError):
                 await ctx.send(error("Please provide a valid JSON export file."))
                 return
 
         downloader = ctx.bot.get_cog("Downloader")
         if downloader is None:
-            await ctx.send(
-                error(
-                    f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."
-                )
-            )
+            await ctx.send(error(f"You do not have the `Downloader` cog loaded. Please run `{ctx.prefix}load downloader` and try again."))
             return
 
         repo_s = []
@@ -133,32 +126,20 @@ class Backup(commands.Cog):
                     repo_e.append("PyLav cogs are not supported.")
                     continue
                 if name.startswith(".") or name.endswith("."):
-                    repo_e.append(
-                        f"Invalid repository name: {name}\nRepository names cannot start or end with a dot."
-                    )
+                    repo_e.append(f"Invalid repository name: {name}\nRepository names cannot start or end with a dot.")
                     continue
                 if re.match(r"^[a-zA-Z0-9_\-\.]+$", name) is None:
-                    repo_e.append(
-                        f"Invalid repository name: {name}\nRepository names may only contain letters, numbers, underscores, hyphens, and dots."
-                    )
+                    repo_e.append(f"Invalid repository name: {name}\nRepository names may only contain letters, numbers, underscores, hyphens, and dots.")
                     continue
 
                 try:
-                    repository = await downloader._repo_manager.add_repo(
-                        url, name, branch
-                    )
-                    repo_s.append(
-                        f"Added repository {name} from {url} on branch {branch}."
-                    )
-                    self.logger.debug(
-                        "Added repository %s from %s on branch %s", name, url, branch
-                    )
+                    repository = await downloader._repo_manager.add_repo(url, name, branch)
+                    repo_s.append(f"Added repository {name} from {url} on branch {branch}.")
+                    self.logger.debug("Added repository %s from %s on branch %s", name, url, branch)
 
                 except errors.ExistingGitRepo:
                     repo_e.append(f"Repository {name} already exists.")
-                    repository = downloader._repo_manager.get_repo(
-                        name
-                    )
+                    repository = downloader._repo_manager.get_repo(name)
                     self.logger.debug("Repository %s already exists", name)
 
                 except errors.AuthenticationError as err:
@@ -172,9 +153,7 @@ class Backup(commands.Cog):
                     continue
 
                 except errors.CloningError as err:
-                    repo_e.append(
-                        f"Cloning error while adding repository {name}. See logs for more information."
-                    )
+                    repo_e.append(f"Cloning error while adding repository {name}. See logs for more information.")
                     self.logger.exception(
                         "Something went wrong whilst cloning %s (to revision %s)",
                         url,
@@ -184,9 +163,7 @@ class Backup(commands.Cog):
                     continue
 
                 except OSError:
-                    repo_e.append(
-                        f"OS error while adding repository {name}. See logs for more information."
-                    )
+                    repo_e.append(f"OS error while adding repository {name}. See logs for more information.")
                     self.logger.exception(
                         "Something went wrong trying to add repo %s under name %s",
                         url,
@@ -206,23 +183,19 @@ class Backup(commands.Cog):
                         continue
                     cog_modules.append(cog_module)
 
-                for cog in set(cog.name for cog in cog_modules):
+                for cog in {cog.name for cog in cog_modules}:
                     poss_installed_path = (await downloader.cog_install_path()) / cog
                     if poss_installed_path.exists():
                         with contextlib.suppress(commands.ExtensionNotLoaded):
                             await ctx.bot.unload_extension(cog)
                             await ctx.bot.remove_loaded_package(cog)
-                        await downloader._delete_cog(
-                            poss_installed_path
-                        )
+                        await downloader._delete_cog(poss_installed_path)
                         uninstall_s.append(f"Uninstalled {cog}")
                         self.logger.debug("Uninstalled %s", cog)
                     else:
                         uninstall_e.append(f"Failed to uninstall {cog}")
                         self.logger.warning("Failed to uninstall %s", cog)
-                await downloader._remove_from_installed(
-                    cog_modules
-                )
+                await downloader._remove_from_installed(cog_modules)
 
                 for cog in cogs:
                     cog_name = cog["name"]
@@ -236,25 +209,15 @@ class Backup(commands.Cog):
                     if cog_name == "backup" and "cswimr/SeaCogs" in url:
                         continue
 
-                    async with repository.checkout(
-                        commit, exit_to_rev=repository.branch
-                    ):
-                        cogs_c, message = (
-                            await downloader._filter_incorrect_cogs_by_names(
-                                repository, [cog_name]
-                            )
-                        )
+                    async with repository.checkout(commit, exit_to_rev=repository.branch):
+                        cogs_c, message = await downloader._filter_incorrect_cogs_by_names(repository, [cog_name])
                         if not cogs_c:
                             install_e.append(message)
                             self.logger.error(message)
                             continue
-                        failed_reqs = await downloader._install_requirements(
-                            cogs_c
-                        )
+                        failed_reqs = await downloader._install_requirements(cogs_c)
                         if failed_reqs:
-                            install_e.append(
-                                f"Failed to install {cog_name} due to missing requirements: {failed_reqs}"
-                            )
+                            install_e.append(f"Failed to install {cog_name} due to missing requirements: {failed_reqs}")
                             self.logger.error(
                                 "Failed to install %s due to missing requirements: %s",
                                 cog_name,
@@ -262,51 +225,37 @@ class Backup(commands.Cog):
                             )
                             continue
 
-                        installed_cogs, failed_cogs = await downloader._install_cogs(
-                            cogs_c
-                        )
+                        installed_cogs, failed_cogs = await downloader._install_cogs(cogs_c)
 
                         if repository.available_libraries:
-                            installed_libs, failed_libs = (
-                                await repository.install_libraries(
+                            installed_libs, failed_libs = await repository.install_libraries(
                                 target_dir=downloader.SHAREDLIB_PATH,
                                 req_target_dir=downloader.LIB_PATH,
                             )
-                            )
                         else:
                             installed_libs = None
                             failed_libs = None
 
                         if cog_pinned:
-                            for cog in installed_cogs:
+                            for cog in installed_cogs:  # noqa: PLW2901
                                 cog.pinned = True
 
-                        await downloader._save_to_installed(
-                            installed_cogs + installed_libs
-                            if installed_libs
-                            else installed_cogs
-                        )
+                        await downloader._save_to_installed(installed_cogs + installed_libs if installed_libs else installed_cogs)
                         if installed_cogs:
                             installed_cog_name = installed_cogs[0].name
                             install_s.append(f"Installed {installed_cog_name}")
                             self.logger.debug("Installed %s", installed_cog_name)
                         if installed_libs:
                             for lib in installed_libs:
-                                install_s.append(
-                                    f"Installed {lib.name} required for {cog_name}"
-                                )
-                                self.logger.debug(
-                                    "Installed %s required for %s", lib.name, cog_name
-                                )
+                                install_s.append(f"Installed {lib.name} required for {cog_name}")
+                                self.logger.debug("Installed %s required for %s", lib.name, cog_name)
                         if failed_cogs:
                             failed_cog_name = failed_cogs[0].name
                             install_e.append(f"Failed to install {failed_cog_name}")
                             self.logger.error("Failed to install %s", failed_cog_name)
                         if failed_libs:
                             for lib in failed_libs:
-                                install_e.append(
-                                    f"Failed to install {lib.name} required for {cog_name}"
-                                )
+                                install_e.append(f"Failed to install {lib.name} required for {cog_name}")
                                 self.logger.error(
                                     "Failed to install %s required for %s",
                                     lib.name,

backup/info.json

@@ -1,15 +1,22 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing Backup!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
-  "name" : "Backup",
-  "short" : "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
-  "description" : "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
-  "end_user_data_statement" : "This cog does not store end user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": [
+    "cswimr"
+  ],
+  "install_msg": "Thank you for installing Backup!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
+  "name": "Backup",
+  "short": "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
+  "description": "A utility to make reinstalling repositories and cogs after migrating the bot far easier.",
+  "end_user_data_statement": "This cog does not store end user data.",
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.6",
-  "max_bot_version": "3.5.13",
-  "min_python_version": [3, 9, 0],
+  "max_bot_version": "3.5.17",
+  "min_python_version": [
+    3,
+    9,
+    0
+  ],
   "tags": [
     "utility",
     "backup",

bible/bible.py

@@ -6,6 +6,7 @@
 # |_____/ \___|\__,_|___/ \_/\_/ |_|_| |_| |_|_| |_| |_|\___|_|
 
 import random
+from asyncio import create_task
 from io import BytesIO
 
 import aiohttp
@@ -26,20 +27,21 @@ class Bible(commands.Cog):
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.1.1"
+    __version__ = "1.1.4"
     __documentation__ = "https://seacogs.coastalcommits.com/pterodactyl/"
 
     def __init__(self, bot: Red):
         super().__init__()
         self.bot = bot
         self.session = aiohttp.ClientSession()
-        self.config = Config.get_conf(
-            self, identifier=481923957134912, force_registration=True
-        )
+        self.config = Config.get_conf(self, identifier=481923957134912, force_registration=True)
         self.logger = getLogger("red.SeaCogs.Bible")
         self.config.register_global(bible="de4e12af7f28f599-02")
         self.config.register_user(bible=None)
 
+    async def cog_unload(self):
+        create_task(self.session.close())
+
     def format_help_for_context(self, ctx: commands.Context) -> str:
         pre_processed = super().format_help_for_context(ctx) or ""
         n = "\n" if "\n\n" not in pre_processed else ""
@@ -51,7 +53,6 @@ class Bible(commands.Cog):
         ]
         return "\n".join(text)
 
-
     def get_icon(self, color: Colour) -> File:
         """Get the docs.api.bible favicon with a given color."""
         image_path = data_manager.bundled_data_path(self) / "api.bible-logo.png"
@@ -70,9 +71,7 @@ class Bible(commands.Cog):
 
     async def translate_book_name(self, bible_id: str, book_name: str) -> str:
         """Translate a book name to a book ID."""
-        book_name_list = [
-            w.lower() if w.lower() == "of" else w.title() for w in book_name.split()
-        ]
+        book_name_list = [w.lower() if w.lower() == "of" else w.title() for w in book_name.split()]
         book_name = " ".join(book_name_list)
         books = await self._get_books(bible_id)
         for book in books:
@@ -92,20 +91,20 @@ class Bible(commands.Cog):
                 response.status,
             )
             if response.status == 401:
-                raise bible.errors.Unauthorized()
+                raise bible.errors.UnauthorizedError
             if response.status == 403:
-                raise bible.errors.BibleAccessError()
+                raise bible.errors.BibleAccessError
             if response.status == 503:
-                raise bible.errors.ServiceUnavailable()
+                raise bible.errors.ServiceUnavailableError
             return Version(
-                bible_id,
-                data["data"]["abbreviation"],
-                data["data"]["language"]["name"],
-                data["data"]["abbreviationLocal"],
-                data["data"]["language"]["nameLocal"],
-                data["data"]["description"],
-                data["data"]["descriptionLocal"],
-                data["data"]["copyright"],
+                bible_id=bible_id,
+                abbreviation=data["data"]["abbreviation"],
+                language=data["data"]["language"]["name"],
+                abbreviation_local=data["data"]["abbreviationLocal"],
+                language_local=data["data"]["language"]["nameLocal"],
+                description=data["data"]["description"],
+                description_local=data["data"]["descriptionLocal"],
+                version_copyright=data["data"]["copyright"],
             )
 
     async def _get_passage(
@@ -136,16 +135,17 @@ class Bible(commands.Cog):
                 response.status,
             )
             if response.status == 400:
-                raise bible.errors.InexplicableError()
+                raise bible.errors.InexplicableError
             if response.status == 401:
-                raise bible.errors.Unauthorized()
+                raise bible.errors.UnauthorizedError
             if response.status == 403:
-                raise bible.errors.BibleAccessError()
+                raise bible.errors.BibleAccessError
             if response.status == 404:
-                raise bible.errors.NotFound()
+                raise bible.errors.NotFoundError
             if response.status == 503:
-                raise bible.errors.ServiceUnavailable()
+                raise bible.errors.ServiceUnavailableError
 
+        assert self.bot.user is not None  # bot will always be logged in
         fums_url = "https://fums.api.bible/f3"
         fums_params = {
             "t": data["meta"]["fumsToken"],
@@ -177,11 +177,11 @@ class Bible(commands.Cog):
                 response.status,
             )
             if response.status == 401:
-                raise bible.errors.Unauthorized()
+                raise bible.errors.UnauthorizedError
             if response.status == 403:
-                raise bible.errors.BibleAccessError()
+                raise bible.errors.BibleAccessError
             if response.status == 503:
-                raise bible.errors.ServiceUnavailable()
+                raise bible.errors.ServiceUnavailableError
             return data["data"]
 
     async def _get_chapters(self, bible_id: str, book_id: str) -> dict:
@@ -196,11 +196,11 @@ class Bible(commands.Cog):
                 response.status,
             )
             if response.status == 401:
-                raise bible.errors.Unauthorized()
+                raise bible.errors.UnauthorizedError
             if response.status == 403:
-                raise bible.errors.BibleAccessError()
+                raise bible.errors.BibleAccessError
             if response.status == 503:
-                raise bible.errors.ServiceUnavailable()
+                raise bible.errors.ServiceUnavailableError
             return data["data"]
 
     async def _get_verses(self, bible_id: str, book_id: str, chapter: int) -> dict:
@@ -215,11 +215,11 @@ class Bible(commands.Cog):
                 response.status,
             )
             if response.status == 401:
-                raise bible.errors.Unauthorized()
+                raise bible.errors.UnauthorizedError
             if response.status == 403:
-                raise bible.errors.BibleAccessError()
+                raise bible.errors.BibleAccessError
             if response.status == 503:
-                raise bible.errors.ServiceUnavailable()
+                raise bible.errors.ServiceUnavailableError
             return data["data"]
 
     @commands.group(autohelp=True)
@@ -247,41 +247,34 @@ class Bible(commands.Cog):
                 from_verse, to_verse = passage.replace(":", ".").split("-")
                 if "." not in to_verse:
                     to_verse = f"{from_verse.split('.')[0]}.{to_verse}"
-                passage = await self._get_passage(
-                    ctx, bible_id, f"{book_id}.{from_verse}-{book_id}.{to_verse}", True
-                )
+                retrieved_passage = await self._get_passage(ctx, bible_id, f"{book_id}.{from_verse}-{book_id}.{to_verse}", True)
             else:
-                passage = await self._get_passage(
-                    ctx, bible_id, f"{book_id}.{passage.replace(':', '.')}", False
-                )
+                retrieved_passage = await self._get_passage(ctx, bible_id, f"{book_id}.{passage.replace(':', '.')}", False)
         except (
             bible.errors.BibleAccessError,
-            bible.errors.NotFound,
+            bible.errors.NotFoundError,
             bible.errors.InexplicableError,
-            bible.errors.ServiceUnavailable,
-            bible.errors.Unauthorized,
+            bible.errors.ServiceUnavailableError,
+            bible.errors.UnauthorizedError,
         ) as e:
             await ctx.send(e.message)
             return
 
-        if len(passage["content"]) > 4096:
+        if len(retrieved_passage["content"]) > 4096:
             await ctx.send("The passage is too long to send.")
             return
 
         if await ctx.embed_requested():
             icon = self.get_icon(await ctx.embed_color())
             embed = Embed(
-                title=f"{passage['reference']}",
-                description=passage["content"].replace("¶ ", ""),
+                title=f"{retrieved_passage['reference']}",
+                description=retrieved_passage["content"].replace("¶ ", ""),
                 color=await ctx.embed_color(),
             )
-            embed.set_footer(
-                text=f"{ctx.prefix}bible passage - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})",
-                icon_url="attachment://icon.png"
-            )
+            embed.set_footer(text=f"{ctx.prefix}bible passage - Powered by API.Bible - {version.abbreviation_local} ({version.language_local}, {version.description_local})", icon_url="attachment://icon.png")
             await ctx.send(embed=embed, file=icon)
         else:
-            await ctx.send(f"## {passage['reference']}\n{passage['content']}")
+            await ctx.send(f"## {retrieved_passage['reference']}\n{retrieved_passage['content']}")
 
     @bible.command(name="random")
     async def bible_random(self, ctx: commands.Context):
@@ -302,10 +295,10 @@ class Bible(commands.Cog):
             passage = await self._get_passage(ctx, bible_id, verse, False)
         except (
             bible.errors.BibleAccessError,
-            bible.errors.NotFound,
+            bible.errors.NotFoundError,
             bible.errors.InexplicableError,
-            bible.errors.ServiceUnavailable,
-            bible.errors.Unauthorized,
+            bible.errors.ServiceUnavailableError,
+            bible.errors.UnauthorizedError,
         ) as e:
             await ctx.send(e.message)
             return
@@ -317,10 +310,7 @@ class Bible(commands.Cog):
                 description=passage["content"].replace("¶ ", ""),
                 color=await ctx.embed_color(),
             )
-            embed.set_footer(
-                text=f"{ctx.prefix}bible random - Powered by API.Bible - {version.abbreviationLocal} ({version.languageLocal}, {version.descriptionLocal})",
-                icon_url="attachment://icon.png"
-            )
+            embed.set_footer(text=f"{ctx.prefix}bible random - Powered by API.Bible - {version.abbreviation_local} ({version.language_local}, {version.description_local})", icon_url="attachment://icon.png")
             await ctx.send(embed=embed, file=icon)
         else:
             await ctx.send(f"## {passage['reference']}\n{passage['content']}")

bible/errors.py

@@ -4,26 +4,22 @@ from redbot.core.utils.chat_formatting import error
 class BibleAccessError(Exception):
     def __init__(
         self,
-        message: str = error(
-            "The provided API key cannot retrieve sections from the configured Bible. Please report this to the bot owner."
-        ),
+        message: str = error("The provided API key cannot retrieve sections from the configured Bible. Please report this to the bot owner."),
     ):
         super().__init__(message)
         self.message = message
 
 
-class Unauthorized(Exception):
+class UnauthorizedError(Exception):
     def __init__(
         self,
-        message: str = error(
-            "The API key for API.Bible is missing or invalid. Please report this to the bot owner.\nIf you are the bot owner, please check the documentation [here](<https://seacogs.coastalcommits.com/bible/#setup>)."
-        ),
+        message: str = error("The API key for API.Bible is missing or invalid. Please report this to the bot owner.\nIf you are the bot owner, please check the documentation [here](<https://seacogs.coastalcommits.com/bible/#setup>)."),
     ):
         super().__init__(message)
         self.message = message
 
 
-class NotFound(Exception):
+class NotFoundError(Exception):
     def __init__(
         self,
         message: str = error("The requested passage was not found."),
@@ -32,7 +28,7 @@ class NotFound(Exception):
         self.message = message
 
 
-class ServiceUnavailable(Exception):
+class ServiceUnavailableError(Exception):
     def __init__(
         self,
         message: str = error("The API.Bible service is currently unavailable."),
@@ -44,9 +40,7 @@ class ServiceUnavailable(Exception):
 class InexplicableError(Exception):
     def __init__(
         self,
-        message: str = error(
-            "An inexplicable 'Bad Request' error occurred. This error happens occassionally with the API.Bible service. Please try again. If the error persists, please report this to the bot owner."
-        ),
+        message: str = error("An inexplicable 'Bad Request' error occurred. This error happens occasionally with the API.Bible service. Please try again. If the error persists, please report this to the bot owner."),
     ):
         super().__init__(message)
         self.message = message

bible/info.json

@@ -1,18 +1,15 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing Bible!\nThis cog requires setting an API key for API.Bible. Please read the [documentation](https://seacogs.coastalcommits.com/bible/#setup) for more information.\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
-  "name" : "Bible",
-  "short" : "Retrieve Bible verses from API.Bible.",
-  "description" : "Retrieve Bible verses from the API.Bible API. This cog requires an API.Bible api key.",
-  "end_user_data_statement" : "This cog does not store end user data, however it does send the following data to the API.Bible API:\n- The bot user's ID\n- The timestamp of the invoking message\n- The hashed user id of the invoking user",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing Bible!\nThis cog requires setting an API key for API.Bible. Please read the [documentation](https://seacogs.coastalcommits.com/bible/#setup) for more information.\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
+  "name": "Bible",
+  "short": "Retrieve Bible verses from API.Bible.",
+  "description": "Retrieve Bible verses from the API.Bible API. This cog requires an API.Bible api key.",
+  "end_user_data_statement": "This cog does not store end user data, however it does send the following data to the API.Bible API:\n- The bot user's ID\n- The timestamp of the invoking message\n- The hashed user id of the invoking user",
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.0",
   "min_python_version": [3, 10, 0],
   "requirements": ["numpy", "pillow"],
-  "tags": [
-    "fun",
-    "utility",
-    "api"
-  ]
+  "tags": ["fun", "utility", "api"]
 }

bible/models.py

@@ -4,23 +4,23 @@ class Version:
         bible_id,
         abbreviation,
         language,
-        abbreviationLocal,
-        languageLocal,
+        abbreviation_local,
+        language_local,
         description,
-        descriptionLocal,
+        description_local,
         version_copyright,
     ):
         self.bible_id = bible_id
         self.abbreviation = abbreviation
         self.language = language
-        self.abbreviationLocal = abbreviationLocal
-        self.languageLocal = languageLocal
+        self.abbreviation_local = abbreviation_local
+        self.language_local = language_local
         self.description = description
-        self.descriptionLocal = descriptionLocal
+        self.description_local = description_local
         self.copyright = version_copyright
 
     def __str__(self):
-        return self.abbreviationLocal
+        return self.abbreviation_local
 
     def __repr__(self):
-        return f'bible.models.Version("{self.bible_id}", "{self.abbreviation}", "{self.language}", "{self.abbreviationLocal}", "{self.languageLocal}", "{self.description}", "{self.descriptionLocal}", "{self.copyright}")'
+        return f'bible.models.Version("{self.bible_id}", "{self.abbreviation}", "{self.language}", "{self.abbreviation_local}", "{self.language_local}", "{self.description}", "{self.description_local}", "{self.copyright}")'

emojiinfo/emojiinfo.py

@@ -16,13 +16,13 @@ class EmojiInfo(commands.Cog):
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.0.1"
+    __version__ = "1.0.3"
     __documentation__ = "https://seacogs.coastalcommits.com/emojiinfo/"
 
     def __init__(self, bot: Red) -> None:
         super().__init__()
         self.bot: Red = bot
-        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.Emoji")
+        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.EmojiInfo")
 
     def format_help_for_context(self, ctx: commands.Context) -> str:
         pre_processed = super().format_help_for_context(ctx) or ""
@@ -35,14 +35,12 @@ class EmojiInfo(commands.Cog):
         ]
         return "\n".join(text)
 
-
     async def fetch_twemoji(self, unicode_emoji) -> str:
         base_url = "https://cdn.jsdelivr.net/gh/jdecked/twemoji@latest/assets/72x72/"
         emoji_codepoint = "-".join([hex(ord(char))[2:] for char in unicode_emoji])
         segments = emoji_codepoint.split("-")
         valid_segments = [seg for seg in segments if len(seg) >= 4]
-        emoji_url = f"{base_url}{valid_segments[0]}.png"
-        return emoji_url
+        return f"{base_url}{valid_segments[0]}.png"
 
     async def fetch_primary_color(self, emoji_url: str) -> discord.Color | None:
         async with aiohttp.ClientSession() as session:
@@ -51,8 +49,7 @@ class EmojiInfo(commands.Cog):
                     return None
                 image = await response.read()
         dominant_color = ColorThief(io.BytesIO(image)).get_color(quality=1)
-        color = discord.Color.from_rgb(*dominant_color)
-        return color
+        return discord.Color.from_rgb(*dominant_color)
 
     async def get_emoji_info(self, emoji: PartialEmoji) -> tuple[str, str]:
         if emoji.is_unicode_emoji():
@@ -72,59 +69,51 @@ class EmojiInfo(commands.Cog):
         else:
             emoji_id = ""
             markdown = f"`{emoji}`"
-            name = f"{bold('Name:')} {emoji.aliases.pop(0)}\n"
+            name = f"{bold('Name:')} {emoji.aliases.pop(0) if emoji.aliases else emoji.name}\n"
             aliases = f"{bold('Aliases:')} {', '.join(emoji.aliases)}\n" if emoji.aliases else ""
             group = f"{bold('Group:')} {emoji.group}\n"
 
-        return (
-            f"{name}"
-            f"{emoji_id}"
-            f"{bold('Native:')} {emoji.is_unicode_emoji()}\n"
-            f"{group}"
-            f"{aliases}"
-            f"{bold('Animated:')} {emoji.animated}\n"
-            f"{bold('Markdown:')} {markdown}\n"
-            f"{bold('URL:')} [Click Here]({emoji_url})"
-        ), emoji_url
+        return (f"{name}{emoji_id}{bold('Native:')} {emoji.is_unicode_emoji()}\n{group}{aliases}{bold('Animated:')} {emoji.animated}\n{bold('Markdown:')} {markdown}\n{bold('URL:')} [Click Here]({emoji_url})"), emoji_url
 
     @app_commands.command(name="emoji")
-    @app_commands.describe(
-        emoji="What emoji would you like to get information on?",
-        ephemeral="Would you like the response to be hidden?"
-    )
+    @app_commands.describe(emoji="What emoji would you like to get information on?", ephemeral="Would you like the response to be hidden?")
     async def emoji_slash(self, interaction: discord.Interaction, emoji: str, ephemeral: bool = True) -> None:
         """Retrieve information about an emoji."""
         await interaction.response.defer(ephemeral=ephemeral)
 
         try:
-            emoji: PartialEmoji = PartialEmoji.from_str(self, value=emoji)
-            string, emoji_url, = await self.get_emoji_info(emoji)
+            retrieved_emoji: PartialEmoji = PartialEmoji.from_str(self, value=emoji)
+            string, emoji_url = await self.get_emoji_info(retrieved_emoji)
             self.logger.verbose(f"Emoji:\n{string}")
         except (IndexError, UnboundLocalError):
             return await interaction.followup.send("Please provide a valid emoji!")
 
+        assert isinstance(interaction.channel, discord.TextChannel)
         if await self.bot.embed_requested(channel=interaction.channel):
-            embed = embed = discord.Embed(title="Emoji Information", description=string, color = await self.fetch_primary_color(emoji_url) or await self.bot.get_embed_color(interaction.channel))
+            embed = discord.Embed(title="Emoji Information", description=string, color=await self.fetch_primary_color(emoji_url) or await self.bot.get_embed_color(interaction.channel))
             embed.set_thumbnail(url=emoji_url)
 
             await interaction.followup.send(embed=embed)
-        else:
+            return None
         await interaction.followup.send(content=string)
+        return None
 
     @commands.command(name="emoji")
     async def emoji(self, ctx: commands.Context, *, emoji: str) -> None:
         """Retrieve information about an emoji."""
         try:
-            emoji: PartialEmoji = PartialEmoji.from_str(self, value=emoji)
-            string, emoji_url, = await self.get_emoji_info(emoji)
+            retrieved_emoji: PartialEmoji = PartialEmoji.from_str(self, value=emoji)
+            string, emoji_url = await self.get_emoji_info(retrieved_emoji)
             self.logger.verbose(f"Emoji:\n{string}")
         except (IndexError, UnboundLocalError):
-            return await ctx.send("Please provide a valid emoji!")
+            await ctx.send("Please provide a valid emoji!")
+            return
 
         if await ctx.embed_requested():
-            embed = embed = discord.Embed(title="Emoji Information", description=string, color = await self.fetch_primary_color(emoji_url) or await ctx.embed_color)
+            embed = discord.Embed(title="Emoji Information", description=string, color=await self.fetch_primary_color(emoji_url) or await ctx.embed_color())
             embed.set_thumbnail(url=emoji_url)
 
             await ctx.send(embed=embed)
-        else:
+            return
         await ctx.send(content=string)
+        return

emojiinfo/info.json

@@ -1,16 +1,15 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing Emoji!",
-  "name" : "Emoji",
-  "short" : "Retrieve information about emojis.",
-  "description" : "Retrieve information about emojis.",
-  "end_user_data_statement" : "This cog does not store end user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing Emoji!",
+  "name": "Emoji",
+  "short": "Retrieve information about emojis.",
+  "description": "Retrieve information about emojis.",
+  "end_user_data_statement": "This cog does not store end user data.",
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.0",
   "min_python_version": [3, 10, 0],
   "requirements": ["colorthief"],
-  "tags": [
-    "utility"
-  ]
+  "tags": ["utility"]
 }

emojiinfo/model.py

@@ -39,7 +39,7 @@ class PartialEmoji(discord.PartialEmoji):
         The group name of the emoji if it is a native emoji.
     """
 
-    def __init__(self, *, name: str, animated: bool = False, id: int | None = None, group: str | None = None, aliases: list | None = None) -> None: # pylint: disable=redefined-builtin
+    def __init__(self, *, name: str, animated: bool = False, id: int | None = None, group: str | None = None, aliases: list | None = None) -> None:  # pylint: disable=redefined-builtin  # noqa: A002
         super().__init__(name=name, animated=animated, id=id)
         self.group = group
         self.aliases = aliases
@@ -72,12 +72,12 @@ class PartialEmoji(discord.PartialEmoji):
         match = cls._CUSTOM_EMOJI_RE.match(value)
         if match is not None:
             groups = match.groupdict()
-            animated = bool(groups['animated'])
-            emoji_id = int(groups['id'])
-            name = groups['name']
+            animated = bool(groups["animated"])
+            emoji_id = int(groups["id"])
+            name = groups["name"]
             return cls(name=name, animated=animated, id=emoji_id)
 
-        path: data_manager.Path = data_manager.bundled_data_path(coginstance) / "emojis.json"
+        path = data_manager.bundled_data_path(coginstance) / "emojis.json"
         with open(path, "r", encoding="UTF-8") as file:
             emojis: dict = json.load(file)
         emoji_aliases = []

flake.lock

@@ -0,0 +1,25 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1738680400,
+        "narHash": "sha256-ooLh+XW8jfa+91F1nhf9OF7qhuA/y1ChLx6lXDNeY5U=",
+        "rev": "799ba5bffed04ced7067a91798353d360788b30d",
+        "revCount": 747653,
+        "type": "tarball",
+        "url": "https://api.flakehub.com/f/pinned/NixOS/nixpkgs/0.1.747653%2Brev-799ba5bffed04ced7067a91798353d360788b30d/0194d302-29da-7009-8f43-5b8a58825954/source.tar.gz"
+      },
+      "original": {
+        "type": "tarball",
+        "url": "https://flakehub.com/f/NixOS/nixpkgs/0.1.%2A.tar.gz"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,72 @@
+{
+  description = "SeaCogs Nix Flake";
+  inputs.nixpkgs.url = "https://flakehub.com/f/NixOS/nixpkgs/0.1.*.tar.gz";
+
+  outputs =
+    { self, nixpkgs }:
+    let
+      supportedSystems = [
+        "x86_64-linux"
+        "aarch64-linux"
+        "x86_64-darwin"
+        "aarch64-darwin"
+      ];
+      forEachSupportedSystem =
+        f:
+        nixpkgs.lib.genAttrs supportedSystems (
+          system:
+          f {
+            pkgs = import nixpkgs { inherit system; };
+            lib = nixpkgs.lib;
+          }
+        );
+    in
+    {
+      devShells = forEachSupportedSystem (
+        { pkgs, lib }:
+        let
+          myPython = pkgs.python311;
+          lib-path =
+            with pkgs;
+            lib.makeLibraryPath [
+              stdenv.cc.cc
+              # Red-DiscordBot dependencies
+              libffi
+              libsodium
+              # PyLav dependency
+              libaio
+              # Material for MkDocs dependency
+              cairo
+            ];
+        in
+        {
+          default = pkgs.mkShell {
+            lib-path = lib-path;
+            packages = with pkgs; [
+              myPython
+              uv
+              ruff # the ruff pip package installs a dynamically linked binary that cannot run on NixOS
+              forgejo-runner
+              # Red-DiscordBot dependencies
+              git
+              jdk17
+              # Material for MkDocs dependencies
+              pngquant
+              # SeaCogs dependencies
+              dig
+            ];
+            shellHook = # bash
+              ''
+                export "LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${lib-path}"
+                export "UV_PYTHON_PREFERENCE=only-system"
+                export "UV_PYTHON_DOWNLOADS=never"
+                uv sync --all-groups
+                source ./.venv/bin/activate
+                export "PYTHONPATH=`pwd`/.venv/${myPython.sitePackages}/:$PYTHONPATH"
+                export "PATH=${pkgs.ruff}/bin:$PATH"
+              '';
+          };
+        }
+      );
+    };
+}

hotreload/__init__.py

@@ -0,0 +1,5 @@
+from .hotreload import HotReload
+
+
+async def setup(bot):
+    await bot.add_cog(HotReload(bot))

hotreload/hotreload.py

@@ -0,0 +1,192 @@
+import py_compile
+from asyncio import run_coroutine_threadsafe
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+from typing import Generator, List, Sequence
+
+import discord
+from red_commons.logging import RedTraceLogger, getLogger
+from redbot.core import Config, checks, commands
+from redbot.core.bot import Red
+from redbot.core.core_commands import CoreLogic
+from redbot.core.utils.chat_formatting import bold, box, humanize_list
+from typing_extensions import override
+from watchdog.events import FileSystemEvent, FileSystemMovedEvent, RegexMatchingEventHandler
+from watchdog.observers import Observer
+from watchdog.observers.api import BaseObserver
+
+
+class HotReload(commands.Cog):
+    """Automatically reload cogs in local cog paths on file change."""
+
+    __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
+    __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
+    __version__ = "1.4.2"
+    __documentation__ = "https://seacogs.coastalcommits.com/hotreload/"
+
+    def __init__(self, bot: Red) -> None:
+        super().__init__()
+        self.bot: Red = bot
+        self.config: Config = Config.get_conf(cog_instance=self, identifier=294518358420750336, force_registration=True)
+        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.HotReload")
+        self.observers: List[BaseObserver] = []
+        self.config.register_global(notify_channel=None, compile_before_reload=False)
+        watchdog_loggers = [getLogger(name="watchdog.observers.inotify_buffer")]
+        for watchdog_logger in watchdog_loggers:
+            watchdog_logger.setLevel("INFO")  # SHUT UP!!!!
+
+    @override
+    async def cog_load(self) -> None:
+        """Start the observer when the cog is loaded."""
+        _ = self.bot.loop.create_task(self.start_observer())
+
+    @override
+    async def cog_unload(self) -> None:
+        """Stop the observer when the cog is unloaded."""
+        for observer in self.observers:
+            observer.stop()
+            observer.join()
+            self.logger.info("Stopped observer. No longer watching for file changes.")
+
+    @override
+    def format_help_for_context(self, ctx: commands.Context) -> str:
+        pre_processed = super().format_help_for_context(ctx) or ""
+        n = "\n" if "\n\n" not in pre_processed else ""
+        text = [
+            f"{pre_processed}{n}",
+            f"{bold('Cog Version:')} [{self.__version__}]({self.__git__})",
+            f"{bold('Author:')} {humanize_list(self.__author__)}",
+            f"{bold('Documentation:')} {self.__documentation__}",
+        ]
+        return "\n".join(text)
+
+    # pylint: disable=protected-access
+    async def get_paths(self) -> Generator[Path, None, None]:
+        """Retrieve user defined paths."""
+        cog_manager = self.bot._cog_mgr  # noqa: SLF001 # We have to use this private method because there is no public API to get user defined paths
+        cog_paths = await cog_manager.user_defined_paths()
+        return (Path(path) for path in cog_paths)
+
+    async def start_observer(self) -> None:
+        """Start the observer to watch for file changes."""
+        self.observers.append(Observer())
+        paths = await self.get_paths()
+        is_first = True
+        for observer in self.observers:
+            if not is_first:
+                observer.stop()
+                observer.join()
+                self.logger.debug("Stopped hanging observer.")
+                continue
+            for path in paths:
+                if not path.exists():
+                    self.logger.warning("Path %s does not exist. Skipping.", path)
+                    continue
+                self.logger.debug("Adding observer schedule for path %s.", path)
+                observer.schedule(event_handler=HotReloadHandler(cog=self, path=path), path=str(path), recursive=True)
+            observer.start()
+            self.logger.info("Started observer. Watching for file changes.")
+            is_first = False
+
+    @checks.is_owner()
+    @commands.group(name="hotreload")
+    async def hotreload_group(self, ctx: commands.Context) -> None:
+        """HotReload configuration commands."""
+
+    @hotreload_group.command(name="notifychannel")
+    async def hotreload_notifychannel(self, ctx: commands.Context, channel: discord.TextChannel) -> None:
+        """Set the channel to send notifications to."""
+        await self.config.notify_channel.set(channel.id)
+        await ctx.send(f"Notifications will be sent to {channel.mention}.")
+
+    @hotreload_group.command(name="compile")  # type: ignore
+    async def hotreload_compile(self, ctx: commands.Context, compile_before_reload: bool) -> None:
+        """Set whether to compile modified files before reloading."""
+        await self.config.compile_before_reload.set(compile_before_reload)
+        await ctx.send(f"I {'will' if compile_before_reload else 'will not'} compile modified files before hotreloading cogs.")
+
+    @hotreload_group.command(name="list")  # type: ignore
+    async def hotreload_list(self, ctx: commands.Context) -> None:
+        """List the currently active observers."""
+        if not self.observers:
+            await ctx.send("No observers are currently active.")
+            return
+        await ctx.send(f"Currently active observers (If there are more than one of these, report an issue): {box(humanize_list([str(o) for o in self.observers], style='unit'))}")
+
+
+class HotReloadHandler(RegexMatchingEventHandler):
+    """Handler for file changes."""
+
+    def __init__(self, cog: HotReload, path: Path) -> None:
+        super().__init__(regexes=[r".*\.py$"])
+        self.cog: HotReload = cog
+        self.path: Path = path
+        self.logger: RedTraceLogger = getLogger(name="red.SeaCogs.HotReload.Observer")
+
+    def on_any_event(self, event: FileSystemEvent) -> None:
+        """Handle filesystem events."""
+        if event.is_directory:
+            return
+
+        allowed_events = ("moved", "deleted", "created", "modified")
+        if event.event_type not in allowed_events:
+            return
+
+        relative_src_path = Path(str(event.src_path)).relative_to(self.path)
+        src_package_name = relative_src_path.parts[0]
+        cogs_to_reload = [src_package_name]
+
+        if isinstance(event, FileSystemMovedEvent):
+            dest = f" to {event.dest_path}"
+            relative_dest_path = Path(str(event.dest_path)).relative_to(self.path)
+            dest_package_name = relative_dest_path.parts[0]
+            if dest_package_name != src_package_name:
+                cogs_to_reload.append(dest_package_name)
+        else:
+            dest = ""
+
+        self.logger.info("File %s has been %s%s.", event.src_path, event.event_type, dest)
+
+        run_coroutine_threadsafe(
+            coro=self.reload_cogs(
+                cog_names=cogs_to_reload,
+                paths=[Path(str(p)) for p in (event.src_path, getattr(event, "dest_path", None)) if p],
+            ),
+            loop=self.cog.bot.loop,
+        )
+
+    # pylint: disable=protected-access
+    async def reload_cogs(self, cog_names: Sequence[str], paths: Sequence[Path]) -> None:
+        """Reload modified cogs."""
+        if not self.compile_modified_files(cog_names, paths):
+            return
+
+        core_logic = CoreLogic(bot=self.cog.bot)
+        self.logger.info("Reloading cogs: %s", humanize_list(cog_names, style="unit"))
+        await core_logic._reload(pkg_names=cog_names)  # noqa: SLF001 # We have to use this private method because there is no public API to reload other cogs
+        self.logger.info("Reloaded cogs: %s", humanize_list(cog_names, style="unit"))
+
+        channel = self.cog.bot.get_channel(await self.cog.config.notify_channel())
+        if channel and isinstance(channel, discord.TextChannel):
+            await channel.send(f"Reloaded cogs: {humanize_list(cog_names, style='unit')}")
+
+    def compile_modified_files(self, cog_names: Sequence[str], paths: Sequence[Path]) -> bool:
+        """Compile modified files to ensure they are valid Python files."""
+        for path in paths:
+            if not path.exists() or path.suffix != ".py":
+                self.logger.debug("Path %s does not exist or does not point to a Python file. Skipping compilation step.", path)
+                continue
+
+            try:
+                with NamedTemporaryFile() as temp_file:
+                    self.logger.debug("Attempting to compile %s", path)
+                    py_compile.compile(file=str(path), cfile=temp_file.name, doraise=True)
+                    self.logger.debug("Successfully compiled %s", path)
+
+            except py_compile.PyCompileError as e:
+                e.__suppress_context__ = True
+                self.logger.exception("%s failed to compile. Not reloading cogs %s.", path, humanize_list(cog_names, style="unit"))
+                return False
+            except OSError:
+                self.logger.exception("Failed to create tempfile for compilation step. Skipping.")
+        return True

hotreload/info.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing HotReload! Please see the [documentation](https://seacogs.coastalcommits.com/hotreload) to get started.",
+  "name": "HotReload",
+  "short": "Automatically reload cogs in local cog paths on file change.",
+  "description": "Automatically reload cogs in local cog paths on file change.",
+  "end_user_data_statement": "This cog does not store end user data.",
+  "hidden": false,
+  "disabled": false,
+  "min_bot_version": "3.5.0",
+  "min_python_version": [3, 8, 0],
+  "requirements": ["watchdog"],
+  "tags": ["utility", "development"]
+}

info.json

@@ -1,7 +1,6 @@
 {
-    "author": [
-        "cswimr"
-    ],
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
   "install_msg": "Thanks for installing my repo!\n\nIf you have any issues with any of the cogs, please create an issue [here](https://coastalcommits.com/cswimr/SeaCogs/issues) or join my [Discord Server](https://discord.gg/eMUMe77Yb8 ).",
   "index_name": "sea-cogs",
   "short": "Various cogs for Red, by cswimr",

mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: SeaCogs Documentation
-site_url: !ENV [SITE_URL, 'https://seacogs.coastalcommits.com']
+site_url: !ENV [SITE_URL, "https://seacogs.coastalcommits.com"]
 repo_name: CoastalCommits
 repo_url: https://coastalcommits.com/cswimr/SeaCogs
-edit_uri: !ENV [EDIT_URI, 'src/branch/main/.docs']
+edit_uri: !ENV [EDIT_URI, "src/branch/main/.docs"]
 copyright: Copyright © 2023-2024, cswimr
 docs_dir: .docs
 
@@ -19,6 +19,7 @@ nav:
   - Bible: bible.md
   - Backup: backup.md
   - EmojiInfo: emojiinfo.md
+  - HotReload: hotreload.md
   - Nerdify: nerdify.md
   - Pterodactyl:
       - pterodactyl/index.md
@@ -72,7 +73,7 @@ markdown_extensions:
 theme:
   name: material
   palette:
-    - media: '(prefers-color-scheme: light)'
+    - media: "(prefers-color-scheme: light)"
       scheme: default
       primary: white
       accent: light blue
@@ -80,7 +81,7 @@ theme:
         icon: material/toggle-switch
         name: Switch to dark mode
 
-    - media: '(prefers-color-scheme: dark)'
+    - media: "(prefers-color-scheme: dark)"
       scheme: slate
       primary: black
       accent: light blue

nerdify/info.json

@@ -1,17 +1,14 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing Nerdify!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs). Based off of PhasecoreX's [UwU](<https://github.com/PhasecoreX/PCXCogs/tree/master/uwu>) cog.",
-  "name" : "Nerdify",
-  "short" : "Nerdify your text!",
-  "description" : "Nerdify your text!",
-  "end_user_data_statement" : "This cog does not store end user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing Nerdify!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs). Based off of PhasecoreX's [UwU](<https://github.com/PhasecoreX/PCXCogs/tree/master/uwu>) cog.",
+  "name": "Nerdify",
+  "short": "Nerdify your text!",
+  "description": "Nerdify your text!",
+  "end_user_data_statement": "This cog does not store end user data.",
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.0",
   "min_python_version": [3, 8, 0],
-  "tags": [
-      "fun",
-      "text",
-      "meme"
-  ]
+  "tags": ["fun", "text", "meme"]
 }

nerdify/nerdify.py

@@ -37,16 +37,20 @@ class Nerdify(commands.Cog):
         ]
         return "\n".join(text)
 
-
     @commands.command(aliases=["nerd"])
     async def nerdify(
-        self, ctx: commands.Context, *, text: Optional[str] = None
+        self,
+        ctx: commands.Context,
+        *,
+        text: Optional[str] = None,
     ) -> None:
         """Nerdify the replied to message, previous message, or your own text."""
         if not text:
             if hasattr(ctx.message, "reference") and ctx.message.reference:
                 with suppress(
-                    discord.Forbidden, discord.NotFound, discord.HTTPException
+                    discord.Forbidden,
+                    discord.NotFound,
+                    discord.HTTPException,
                 ):
                     message_id = ctx.message.reference.message_id
                     if message_id:
@@ -62,7 +66,9 @@ class Nerdify(commands.Cog):
             ctx.channel,
             self.nerdify_text(text),
             allowed_mentions=discord.AllowedMentions(
-                everyone=False, users=False, roles=False
+                everyone=False,
+                users=False,
+                roles=False,
             ),
         )
 
@@ -77,7 +83,10 @@ class Nerdify(commands.Cog):
         return f'"{text}" 🤓'
 
     async def type_message(
-        self, destination: discord.abc.Messageable, content: str, **kwargs: Any
+        self,
+        destination: discord.abc.Messageable,
+        content: str,
+        **kwargs: Any,
     ) -> Union[discord.Message, None]:
         """Simulate typing and sending a message to a destination.
 

pterodactyl/config.py

@@ -2,28 +2,29 @@ from redbot.core import Config
 
 config: Config = Config.get_conf(None, identifier=457581387213637448123567, cog_name="Pterodactyl", force_registration=True)
 
+
 def register_config(config_obj: Config) -> None:
     config_obj.register_global(
         base_url=None,
         server_id=None,
         console_channel=None,
         console_commands_enabled=False,
-        current_status='',
+        current_status="",
         chat_regex=r"^\[\d{2}:\d{2}:\d{2}\sINFO\]: (?!\[(?:Server|Rcon)\])(?:<|\[)(\w+)(?:>|\]) (.*)",
         server_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]:(?: \[Not Secure\])? \[(?:Server|Rcon)\] (.*)",
         join_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]: ([^<\n]+) joined the game$",
         leave_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]: ([^<\n]+) left the game$",
         achievement_regex=r"^\[\d{2}:\d{2}:\d{2} INFO\]: (.*) has (made the advancement|completed the challenge) \[(.*)\]$",
         chat_command='tellraw @a ["",{"text":".$N ","color":".$C","insertion":"<@.$I>","hoverEvent":{"action":"show_text","contents":"Shift click to mention this user inside Discord"}},{"text":"(DISCORD):","color":"blue","clickEvent":{"action":"open_url","value":".$V"},"hoverEvent":{"action":"show_text","contents":"Click to join the Discord Server"}},{"text":" .$M","color":"white"}]',  # noqa: E501
-        topic='Server IP: .$H\nServer Players: .$P/.$M',
+        topic="Server IP: .$H\nServer Players: .$P/.$M",
         topic_hostname=None,
         topic_port=25565,
         api_endpoint="minecraft",
         chat_channel=None,
-        startup_msg='Server started!',
-        shutdown_msg='Server stopped!',
-        join_msg='Welcome to the server! 👋',
-        leave_msg='Goodbye! 👋',
+        startup_msg="Server started!",
+        shutdown_msg="Server stopped!",
+        join_msg="Welcome to the server! 👋",
+        leave_msg="Goodbye! 👋",
         mask_ip=True,
         invite=None,
         regex_blacklist={},

pterodactyl/info.json

@@ -1,19 +1,18 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing Pterodactyl!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).\nDocumentation can be found [here](https://seacogs.coastalcommits.com/pterodactyl ).",
-  "name" : "Pterodactyl",
-  "short" : "Interface with Pterodactyl through websockets.",
-  "description" : "Interface with Pterodactyl through websockets.",
-  "end_user_data_statement" : "This cog does not store end user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing Pterodactyl!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).\nDocumentation can be found [here](https://seacogs.coastalcommits.com/pterodactyl ).",
+  "name": "Pterodactyl",
+  "short": "Interface with Pterodactyl through websockets.",
+  "description": "Interface with Pterodactyl through websockets.",
+  "end_user_data_statement": "This cog does not store end user data.",
   "hidden": false,
   "disabled": false,
   "min_bot_version": "3.5.0",
-  "min_python_version": [3, 8, 0],
-  "requirements": ["git+https://github.com/cswimr/pydactyl", "websockets"],
-  "tags": [
-      "pterodactyl",
-      "minecraft",
-      "server",
-      "management"
-  ]
+  "min_python_version": [3, 10, 0],
+  "requirements": [
+    "git+https://github.com/iamkubi/pydactyl@v2.0.5",
+    "websockets"
+  ],
+  "tags": ["pterodactyl", "minecraft", "server", "management"]
 }

pterodactyl/logger.py

@@ -1,8 +1,8 @@
 from red_commons import logging
 from red_commons.logging import getLogger
 
-logger = getLogger('red.SeaCogs.Pterodactyl')
-websocket_logger = getLogger('red.SeaCogs.Pterodactyl.websocket')
+logger = getLogger("red.SeaCogs.Pterodactyl")
+websocket_logger = getLogger("red.SeaCogs.Pterodactyl.Websocket")
 if logger.level >= logging.VERBOSE:
     websocket_logger.setLevel(logging.logging.INFO)
 elif logger.level < logging.VERBOSE:

pterodactyl/mcsrvstatus.py

@@ -2,9 +2,17 @@ import aiohttp
 
 
 async def get_status(host: str, port: int = 25565) -> tuple[bool, dict]:
+    """Get the status of a Minecraft server using the [mcsrvstat.us API](https://api.mcsrvstat.us).
+
+    Args:
+        host (str): The host of the server.
+        port (int, optional): The port to connect to. Defaults to 25565.
+
+    Returns:
+        A tuple containing a boolean and a dictionary. The boolean is True if the server is online, or False if it is offline. The dictionary contains the response from the API."""
     async with aiohttp.ClientSession() as session:
-        async with session.get(f'https://api.mcsrvstat.us/2/{host}:{port}') as response:
-            response = await response.json()
-            if response['online']:
+        async with session.get(f"https://api.mcsrvstat.us/2/{host}:{port}") as response:
+            response = await response.json()  # noqa: PLW2901
+            if response["online"]:
                 return (True, response)
             return (False, response)

pterodactyl/pterodactyl.py

@@ -1,6 +1,6 @@
 import asyncio
 import json
-from typing import Mapping, Optional, Tuple, Union
+from typing import AsyncIterable, Iterable, Mapping, Optional, Tuple, Union
 
 import discord
 import websockets
@@ -9,8 +9,9 @@ from pydactyl import PterodactylClient
 from redbot.core import app_commands, commands
 from redbot.core.app_commands import Choice
 from redbot.core.bot import Red
-from redbot.core.utils.chat_formatting import bold, box, error, humanize_list
+from redbot.core.utils.chat_formatting import bold, box, humanize_list
 from redbot.core.utils.views import ConfirmView
+from typing_extensions import override
 
 from pterodactyl import mcsrvstatus
 from pterodactyl.config import config, register_config
@@ -22,19 +23,20 @@ class Pterodactyl(commands.Cog):
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "2.0.4"
+    __version__ = "2.0.9"
     __documentation__ = "https://seacogs.coastalcommits.com/pterodactyl/"
 
     def __init__(self, bot: Red):
         self.bot = bot
         self.client: Optional[PterodactylClient] = None
         self.task: Optional[asyncio.Task] = None
-        self.websocket: Optional[websockets.WebSocketClientProtocol] = None
+        self.websocket: Optional[websockets.ClientConnection] = None
         self.retry_counter: int = 0
         register_config(config)
-        self.task = self.get_task()
+        self.task = self._get_task()
         self.update_topic.start()
 
+    @override
     def format_help_for_context(self, ctx: commands.Context) -> str:
         pre_processed = super().format_help_for_context(ctx) or ""
         n = "\n" if "\n\n" not in pre_processed else ""
@@ -46,47 +48,57 @@ class Pterodactyl(commands.Cog):
         ]
         return "\n".join(text)
 
+    @override
     async def cog_load(self) -> None:
         pterodactyl_keys = await self.bot.get_shared_api_tokens("pterodactyl")
         api_key = pterodactyl_keys.get("api_key")
         if api_key is None:
-            self.task.cancel()
-            raise ValueError("Pterodactyl API key not set. Please set it using `[p]set api`.")
+            self.maybe_cancel_task()
+            logger.error("Pterodactyl API key not set. Please set it using `[p]set api`.")
+            return
         base_url = await config.base_url()
         if base_url is None:
-            self.task.cancel()
-            raise ValueError("Pterodactyl base URL not set. Please set it using `[p]pterodactyl config url`.")
+            self.maybe_cancel_task()
+            logger.error("Pterodactyl base URL not set. Please set it using `[p]pterodactyl config url`.")
+            return
         server_id = await config.server_id()
         if server_id is None:
-            self.task.cancel()
-            raise ValueError("Pterodactyl server ID not set. Please set it using `[p]pterodactyl config serverid`.")
+            self.maybe_cancel_task()
+            logger.error("Pterodactyl server ID not set. Please set it using `[p]pterodactyl config serverid`.")
+            return
 
         self.client = PterodactylClient(base_url, api_key).client
 
+    @override
     async def cog_unload(self) -> None:
         self.update_topic.cancel()
-        self.task.cancel()
-        self.retry_counter = 0
-        await self.client._session.close() # pylint: disable=protected-access
+        self.maybe_cancel_task()
 
-    def get_task(self) -> asyncio.Task:
+    def maybe_cancel_task(self, reset_retry_counter: bool = True) -> None:
+        if self.task:
+            self.task.cancel()
+        if reset_retry_counter:
+            self.retry_counter = 0
+
+    def _get_task(self) -> asyncio.Task:
         from pterodactyl.websocket import establish_websocket_connection
+
         task = self.bot.loop.create_task(establish_websocket_connection(self), name="Pterodactyl Websocket Connection")
-        task.add_done_callback(self.error_callback)
+        task.add_done_callback(self._error_callback)
         return task
 
-    def error_callback(self, fut) -> None: #NOTE - Thanks flame442 and zephyrkul for helping me figure this out
+    def _error_callback(self, fut) -> None:  # NOTE Thanks flame442 and zephyrkul for helping me figure this out
         try:
             fut.result()
         except asyncio.CancelledError:
             logger.info("WebSocket task has been cancelled.")
         except Exception as e:  # pylint: disable=broad-exception-caught
             logger.error("WebSocket task has failed: %s", e, exc_info=e)
-            self.task.cancel()
+            self.maybe_cancel_task(reset_retry_counter=False)
             if self.retry_counter < 5:
                 self.retry_counter += 1
                 logger.info("Retrying in %s seconds...", 5 * self.retry_counter)
-                self.task = self.bot.loop.call_later(5 * self.retry_counter, self.get_task)
+                self.task = self.bot.loop.call_later(5 * self.retry_counter, self._get_task)
             else:
                 logger.info("Retry limit reached. Stopping task.")
 
@@ -97,9 +109,9 @@ class Pterodactyl(commands.Cog):
         console = self.bot.get_channel(await config.console_channel())
         chat = self.bot.get_channel(await config.chat_channel())
         if console:
-            await console.edit(topic=topic)
+            await console.edit(topic=topic)  # type: ignore
         if chat:
-            await chat.edit(topic=topic)
+            await chat.edit(topic=topic)  # type: ignore
 
     @commands.Cog.listener()
     async def on_message_without_command(self, message: discord.Message) -> None:
@@ -110,13 +122,7 @@ class Pterodactyl(commands.Cog):
                 return
             logger.debug("Received console command from %s: %s", message.author.id, message.content)
             await message.channel.send(f"Received console command from {message.author.id}: {message.content[:1900]}", allowed_mentions=discord.AllowedMentions.none())
-            try:
-                await self.websocket.send(json.dumps({"event": "send command", "args": [message.content]}))
-            except websockets.exceptions.ConnectionClosed as e:
-                logger.error("WebSocket connection closed: %s", e)
-                self.task.cancel()
-                self.retry_counter = 0
-                self.task = self.get_task()
+            await self._send(json.dumps({"event": "send command", "args": [message.content]}))
         if message.channel.id == await config.chat_channel() and message.author.bot is False:
             logger.debug("Received chat message from %s: %s", message.author.id, message.content)
             channel = self.bot.get_channel(await config.console_channel())
@@ -124,13 +130,22 @@ class Pterodactyl(commands.Cog):
                 await channel.send(f"Received chat message from {message.author.id}: {message.content[:1900]}", allowed_mentions=discord.AllowedMentions.none())
             msg = json.dumps({"event": "send command", "args": [await self.get_chat_command(message)]})
             logger.debug("Sending chat message to server:\n%s", msg)
+            await self._send(message=msg)
+
+    async def _send(self, message: Union[websockets.Data, Iterable[websockets.Data], AsyncIterable[websockets.Data]], text: bool = False):
+        """Send a message through the websocket connection. Restarts the websocket connection task if it is closed, and reinvokes itself."""
         try:
-                await self.websocket.send(msg)
+            await self.websocket.send(message=message, text=text)  # type: ignore - we want this to error if `self.websocket` is none
         except websockets.exceptions.ConnectionClosed as e:
             logger.error("WebSocket connection closed: %s", e)
-                self.task.cancel()
-                self.retry_counter = 0
-                self.task = self.get_task()
+            self.maybe_cancel_task()
+            self.task = self._get_task()
+            try:
+                await asyncio.wait_for(fut=self.task, timeout=60)
+                await self._send(message=message, text=text)
+            except asyncio.TimeoutError:
+                logger.error("Timeout while waiting for websocket connection")
+                raise
 
     async def get_topic(self) -> str:
         topic: str = await config.topic()
@@ -141,23 +156,27 @@ class Pterodactyl(commands.Cog):
         if await config.api_endpoint() == "minecraft":
             status, response = await mcsrvstatus.get_status(await config.topic_hostname(), await config.topic_port())
             if status:
-                placeholders.update({
-                    "I": response['ip'],
-                    "M": str(response['players']['max']),
-                    "P": str(response['players']['online']),
-                    "V": response['version'],
-                    "D": response['motd']['clean'][0] if response['motd']['clean'] else "unset",
-                })
+                placeholders.update(
+                    {
+                        "I": response["ip"],
+                        "M": str(response["players"]["max"]),
+                        "P": str(response["players"]["online"]),
+                        "V": response["version"],
+                        "D": response["motd"]["clean"][0] if response["motd"]["clean"] else "unset",
+                    },
+                )
             else:
-                placeholders.update({
-                    "I": response['ip'],
+                placeholders.update(
+                    {
+                        "I": response["ip"],
                         "M": "0",
                         "P": "0",
                         "V": "Server Offline",
                         "D": "Server Offline",
-                })
+                    },
+                )
         for key, value in placeholders.items():
-            topic = topic.replace('.$' + key, value)
+            topic = topic.replace(".$" + key, value)
         return topic
 
     async def get_chat_command(self, message: discord.Message) -> str:
@@ -166,42 +185,45 @@ class Pterodactyl(commands.Cog):
             "C": str(message.author.color),
             "D": message.author.discriminator,
             "I": str(message.author.id),
-            "M": message.content.replace('"','').replace("\n", " "),
+            "M": message.content.replace('"', "").replace("\n", " "),
             "N": message.author.display_name,
             "U": message.author.name,
             "V": await config.invite() or "use [p]pterodactyl config invite to change me",
         }
         for key, value in placeholders.items():
-            command = command.replace('.$' + key, value)
+            command = command.replace(".$" + key, value)
         return command
 
     async def get_player_list(self) -> Optional[Tuple[str, list]]:
         if await config.api_endpoint() == "minecraft":
             status, response = await mcsrvstatus.get_status(await config.topic_hostname(), await config.topic_port())
-            if status and 'list' in response['players']:
-                output_str = '\n'.join(response['players']['list'])
-                return output_str, response['players']['list']
+            if status and "list" in response["players"]:
+                output_str = "\n".join(response["players"]["list"])
+                return output_str, response["players"]["list"]
+            return None
         return None
 
     async def get_player_list_embed(self, ctx: Union[commands.Context, discord.Interaction]) -> Optional[discord.Embed]:
         player_list = await self.get_player_list()
-        if player_list:
+        if player_list and isinstance(ctx.channel, discord.abc.Messageable):
             embed = discord.Embed(color=await self.bot.get_embed_color(ctx.channel), title="Players Online")
             embed.description = player_list[0]
             return embed
         return None
 
-    async def power(self, ctx: Union[discord.Interaction, commands.Context], action: str, action_ing: str, warning: str = '') -> None:
+    async def power(self, ctx: Union[discord.Interaction, commands.Context], action: str, action_ing: str, warning: str = "") -> None:
         if isinstance(ctx, discord.Interaction):
             ctx = await self.bot.get_context(ctx)
 
         current_status = await config.current_status()
 
         if current_status == action_ing:
-            return await ctx.send(f"Server is already {action_ing}.", ephemeral=True)
+            await ctx.send(f"Server is already {action_ing}.", ephemeral=True)
+            return
 
         if current_status in ["starting", "stopping"] and action != "kill":
-            return await ctx.send("Another power action is already in progress.", ephemeral=True)
+            await ctx.send("Another power action is already in progress.", ephemeral=True)
+            return
 
         view = ConfirmView(ctx.author, disable_buttons=True)
 
@@ -212,12 +234,13 @@ class Pterodactyl(commands.Cog):
         if view.result is True:
             await message.edit(content=f"Sending websocket command to {action} server...", view=None)
 
-            await self.websocket.send(json.dumps({"event": "set state", "args": [action]}))
+            await self._send(json.dumps({"event": "set state", "args": [action]}))
 
             await message.edit(content=f"Server {action_ing}", view=None)
+            return
 
-        else:
         await message.edit(content="Cancelled.", view=None)
+        return
 
     async def send_command(self, ctx: Union[discord.Interaction, commands.Context], command: str):
         channel = self.bot.get_channel(await config.console_channel())
@@ -225,27 +248,19 @@ class Pterodactyl(commands.Cog):
             ctx = await self.bot.get_context(ctx)
         if channel:
             await channel.send(f"Received console command from {ctx.author.id}: {command[:1900]}", allowed_mentions=discord.AllowedMentions.none())
-        try:
-            await self.websocket.send(json.dumps({"event": "send command", "args": [command]}))
+        await self._send(json.dumps({"event": "send command", "args": [command]}))
         await ctx.send(f"Command sent to server. {box(command, 'json')}")
-        except websockets.exceptions.ConnectionClosed as e:
-            logger.error("WebSocket connection closed: %s", e)
-            await ctx.send(error("WebSocket connection closed."))
-            self.task.cancel()
-            self.retry_counter = 0
-            self.task = self.get_task()
 
     @commands.Cog.listener()
-    async def on_red_api_tokens_update(self, service_name: str, api_tokens: Mapping[str,str]): # pylint: disable=unused-argument
+    async def on_red_api_tokens_update(self, service_name: str, api_tokens: Mapping[str, str]):  # pylint: disable=unused-argument
         if service_name == "pterodactyl":
             logger.info("Configuration value set: api_key\nRestarting task...")
-            self.task.cancel()
-            self.retry_counter = 0
-            self.task = self.get_task()
+            self.maybe_cancel_task(reset_retry_counter=True)
+            self.task = self._get_task()
 
     slash_pterodactyl = app_commands.Group(name="pterodactyl", description="Pterodactyl allows you to manage your Pterodactyl Panel from Discord.")
 
-    @slash_pterodactyl.command(name = "command", description = "Send a command to the server console.")
+    @slash_pterodactyl.command(name="command", description="Send a command to the server console.")
     async def slash_pterodactyl_command(self, interaction: discord.Interaction, command: str) -> None:
         """Send a command to the server console.
 
@@ -255,7 +270,7 @@ class Pterodactyl(commands.Cog):
             The command to send to the server."""
         return await self.send_command(interaction, command)
 
-    @slash_pterodactyl.command(name = "players", description = "Retrieve a list of players on the server.")
+    @slash_pterodactyl.command(name="players", description="Retrieve a list of players on the server.")
     async def slash_pterodactyl_players(self, interaction: discord.Interaction) -> None:
         """Retrieve a list of players on the server."""
         e = await self.get_player_list_embed(interaction)
@@ -264,13 +279,8 @@ class Pterodactyl(commands.Cog):
         else:
             await interaction.response.send_message("No players online.", ephemeral=True)
 
-    @slash_pterodactyl.command(name = "power", description = "Send power actions to the server.")
-    @app_commands.choices(action=[
-        Choice(name="Start", value="start"),
-        Choice(name="Stop", value="stop"),
-        Choice(name="Restart", value="restart"),
-        Choice(name="⚠️ Kill ⚠️", value="kill")
-    ])
+    @slash_pterodactyl.command(name="power", description="Send power actions to the server.")
+    @app_commands.choices(action=[Choice(name="Start", value="start"), Choice(name="Stop", value="stop"), Choice(name="Restart", value="restart"), Choice(name="⚠️ Kill ⚠️", value="kill")])
     async def slash_pterodactyl_power(self, interaction: discord.Interaction, action: app_commands.Choice[str]) -> None:
         """Send power actions to the server.
 
@@ -284,11 +294,11 @@ class Pterodactyl(commands.Cog):
             return await self.power(interaction, action.value, "stopping...")
         return await self.power(interaction, action.value, f"{action.value}ing...")
 
-    @commands.group(autohelp = True, name = "pterodactyl", aliases = ["ptero"])
+    @commands.group(autohelp=True, name="pterodactyl", aliases=["ptero"])
     async def pterodactyl(self, ctx: commands.Context) -> None:
         """Pterodactyl allows you to manage your Pterodactyl Panel from Discord."""
 
-    @pterodactyl.command(name = "players", aliases=["list", "online", "playerlist", "who"])
+    @pterodactyl.command(name="players", aliases=["list", "online", "playerlist", "who"])
     async def pterodactyl_players(self, ctx: commands.Context) -> None:
         """Retrieve a list of players on the server."""
         e = await self.get_player_list_embed(ctx)
@@ -297,43 +307,43 @@ class Pterodactyl(commands.Cog):
         else:
             await ctx.send("No players online.")
 
-    @pterodactyl.command(name = "command", aliases = ["cmd", "execute", "exec"])
+    @pterodactyl.command(name="command", aliases=["cmd", "execute", "exec"])
     @commands.admin()
     async def pterodactyl_command(self, ctx: commands.Context, *, command: str) -> None:
         """Send a command to the server console."""
         return await self.send_command(ctx, command)
 
-    @pterodactyl.group(autohelp = True, name = "power")
+    @pterodactyl.group(autohelp=True, name="power")
     @commands.admin()
     async def pterodactyl_power(self, ctx: commands.Context) -> None:
         """Send power actions to the server."""
 
-    @pterodactyl_power.command(name = "start")
+    @pterodactyl_power.command(name="start")
     async def pterodactyl_power_start(self, ctx: commands.Context) -> Optional[discord.Message]:
         """Start the server."""
         return await self.power(ctx, "start", "starting...")
 
-    @pterodactyl_power.command(name = "stop")
+    @pterodactyl_power.command(name="stop")
     async def pterodactyl_power_stop(self, ctx: commands.Context) -> Optional[discord.Message]:
         """Stop the server."""
         return await self.power(ctx, "stop", "stopping...")
 
-    @pterodactyl_power.command(name = "restart")
+    @pterodactyl_power.command(name="restart")
     async def pterodactyl_power_restart(self, ctx: commands.Context) -> Optional[discord.Message]:
         """Restart the server."""
         return await self.power(ctx, "restart", "restarting...")
 
-    @pterodactyl_power.command(name = "kill")
+    @pterodactyl_power.command(name="kill")
     async def pterodactyl_power_kill(self, ctx: commands.Context) -> Optional[discord.Message]:
         """Kill the server."""
         return await self.power(ctx, "kill", "stopping... (forcefully killed)", warning="**⚠️ Forcefully killing the server process can corrupt data in some cases. ⚠️**\n")
 
-    @pterodactyl.group(autohelp = True, name = "config", aliases = ["settings", "set"])
+    @pterodactyl.group(autohelp=True, name="config", aliases=["settings", "set"])
     @commands.is_owner()
     async def pterodactyl_config(self, ctx: commands.Context) -> None:
         """Configure Pterodactyl settings."""
 
-    @pterodactyl_config.command(name = "url")
+    @pterodactyl_config.command(name="url")
     async def pterodactyl_config_base_url(self, ctx: commands.Context, *, base_url: str) -> None:
         """Set the base URL of your Pterodactyl Panel.
 
@@ -342,59 +352,57 @@ class Pterodactyl(commands.Cog):
         await config.base_url.set(base_url)
         await ctx.send(f"Base URL set to {base_url}")
         logger.info("Configuration value set: base_url = %s\nRestarting task...", base_url)
-        self.task.cancel()
-        self.retry_counter = 0
-        self.task = self.get_task()
+        self.maybe_cancel_task(reset_retry_counter=True)
+        self.task = self._get_task()
 
-    @pterodactyl_config.command(name = "serverid")
+    @pterodactyl_config.command(name="serverid")
     async def pterodactyl_config_server_id(self, ctx: commands.Context, *, server_id: str) -> None:
         """Set the ID of your server."""
         await config.server_id.set(server_id)
         await ctx.send(f"Server ID set to {server_id}")
         logger.info("Configuration value set: server_id = %s\nRestarting task...", server_id)
-        self.task.cancel()
-        self.retry_counter = 0
-        self.task = self.get_task()
+        self.maybe_cancel_task(reset_retry_counter=True)
+        self.task = self._get_task()
 
-    @pterodactyl_config.group(name = "console")
+    @pterodactyl_config.group(name="console")
     async def pterodactyl_config_console(self, ctx: commands.Context):
         """Configure console settings."""
 
-    @pterodactyl_config_console.command(name = "channel")
+    @pterodactyl_config_console.command(name="channel")
     async def pterodactyl_config_console_channel(self, ctx: commands.Context, channel: discord.TextChannel) -> None:
         """Set the channel to send console output to."""
         await config.console_channel.set(channel.id)
         await ctx.send(f"Console channel set to {channel.mention}")
 
-    @pterodactyl_config_console.command(name = "commands")
+    @pterodactyl_config_console.command(name="commands")
     async def pterodactyl_config_console_commands(self, ctx: commands.Context, enabled: bool) -> None:
         """Enable or disable console commands."""
         await config.console_commands_enabled.set(enabled)
         await ctx.send(f"Console commands set to {enabled}")
 
-    @pterodactyl_config.command(name = "invite")
+    @pterodactyl_config.command(name="invite")
     async def pterodactyl_config_invite(self, ctx: commands.Context, invite: str) -> None:
         """Set the invite link for your server."""
         await config.invite.set(invite)
         await ctx.send(f"Invite link set to {invite}")
 
-    @pterodactyl_config.group(name = "topic")
+    @pterodactyl_config.group(name="topic")
     async def pterodactyl_config_topic(self, ctx: commands.Context):
         """Set the topic for the console and chat channels."""
 
-    @pterodactyl_config_topic.command(name = "host", aliases = ["hostname", "ip"])
+    @pterodactyl_config_topic.command(name="host", aliases=["hostname", "ip"])
     async def pterodactyl_config_topic_host(self, ctx: commands.Context, host: str) -> None:
         """Set the hostname or IP address of your server."""
         await config.topic_hostname.set(host)
         await ctx.send(f"Hostname/IP set to `{host}`")
 
-    @pterodactyl_config_topic.command(name = "port")
+    @pterodactyl_config_topic.command(name="port")
     async def pterodactyl_config_topic_port(self, ctx: commands.Context, port: int) -> None:
         """Set the port of your server."""
         await config.topic_port.set(port)
         await ctx.send(f"Port set to `{port}`")
 
-    @pterodactyl_config_topic.command(name = "text")
+    @pterodactyl_config_topic.command(name="text")
     async def pterodactyl_config_topic_text(self, ctx: commands.Context, *, text: str) -> None:
         """Set the text for the console and chat channels.
 
@@ -408,19 +416,19 @@ class Pterodactyl(commands.Cog):
         - `.$V` (version)
         - `.$D` (description / Message of the Day)"""
         await config.topic.set(text)
-        await ctx.send(f"Topic set to:\n{box(text, 'yaml')}")
+        await ctx.send(f"Topic set to:\n{box(text, 'markdown')}")
 
-    @pterodactyl_config.group(name = "chat")
+    @pterodactyl_config.group(name="chat")
     async def pterodactyl_config_chat(self, ctx: commands.Context):
         """Configure chat settings."""
 
-    @pterodactyl_config_chat.command(name = "channel")
+    @pterodactyl_config_chat.command(name="channel")
     async def pterodactyl_config_chat_channel(self, ctx: commands.Context, channel: discord.TextChannel) -> None:
         """Set the channel to send chat output to."""
         await config.chat_channel.set(channel.id)
         await ctx.send(f"Chat channel set to {channel.mention}")
 
-    @pterodactyl_config_chat.command(name = "command")
+    @pterodactyl_config_chat.command(name="command")
     async def pterodactyl_config_chat_command(self, ctx: commands.Context, *, command: str) -> None:
         """Set the command that will be used to send messages from Discord.
 
@@ -429,11 +437,11 @@ class Pterodactyl(commands.Cog):
         await config.chat_command.set(command)
         await ctx.send(f"Chat command set to:\n{box(command, 'json')}")
 
-    @pterodactyl_config.group(name = "regex")
+    @pterodactyl_config.group(name="regex")
     async def pterodactyl_config_regex(self, ctx: commands.Context) -> None:
         """Set regex patterns."""
 
-    @pterodactyl_config_regex.command(name = "chat")
+    @pterodactyl_config_regex.command(name="chat")
     async def pterodactyl_config_regex_chat(self, ctx: commands.Context, *, regex: str) -> None:
         """Set the regex pattern to match chat messages on the server.
 
@@ -441,7 +449,7 @@ class Pterodactyl(commands.Cog):
         await config.chat_regex.set(regex)
         await ctx.send(f"Chat regex set to:\n{box(regex, 'regex')}")
 
-    @pterodactyl_config_regex.command(name = "server")
+    @pterodactyl_config_regex.command(name="server")
     async def pterodactyl_config_regex_server(self, ctx: commands.Context, *, regex: str) -> None:
         """Set the regex pattern to match server messages on the server.
 
@@ -449,7 +457,7 @@ class Pterodactyl(commands.Cog):
         await config.server_regex.set(regex)
         await ctx.send(f"Server regex set to:\n{box(regex, 'regex')}")
 
-    @pterodactyl_config_regex.command(name = "join")
+    @pterodactyl_config_regex.command(name="join")
     async def pterodactyl_config_regex_join(self, ctx: commands.Context, *, regex: str) -> None:
         """Set the regex pattern to match join messages on the server.
 
@@ -457,7 +465,7 @@ class Pterodactyl(commands.Cog):
         await config.join_regex.set(regex)
         await ctx.send(f"Join regex set to:\n{box(regex, 'regex')}")
 
-    @pterodactyl_config_regex.command(name = "leave")
+    @pterodactyl_config_regex.command(name="leave")
     async def pterodactyl_config_regex_leave(self, ctx: commands.Context, *, regex: str) -> None:
         """Set the regex pattern to match leave messages on the server.
 
@@ -465,7 +473,7 @@ class Pterodactyl(commands.Cog):
         await config.leave_regex.set(regex)
         await ctx.send(f"Leave regex set to:\n{box(regex, 'regex')}")
 
-    @pterodactyl_config_regex.command(name = "achievement")
+    @pterodactyl_config_regex.command(name="achievement")
     async def pterodactyl_config_regex_achievement(self, ctx: commands.Context, *, regex: str) -> None:
         """Set the regex pattern to match achievement messages on the server.
 
@@ -473,41 +481,41 @@ class Pterodactyl(commands.Cog):
         await config.achievement_regex.set(regex)
         await ctx.send(f"Achievement regex set to:\n{box(regex, 'regex')}")
 
-    @pterodactyl_config.group(name = "messages", aliases = ['msg', 'msgs', 'message'])
+    @pterodactyl_config.group(name="messages", aliases=["msg", "msgs", "message"])
     async def pterodactyl_config_messages(self, ctx: commands.Context):
         """Configure message settings."""
 
-    @pterodactyl_config_messages.command(name = "startup")
+    @pterodactyl_config_messages.command(name="startup")
     async def pterodactyl_config_messages_startup(self, ctx: commands.Context, *, message: str) -> None:
         """Set the message that will be sent when the server starts."""
         await config.startup_msg.set(message)
         await ctx.send(f"Startup message set to: {message}")
 
-    @pterodactyl_config_messages.command(name = "shutdown")
+    @pterodactyl_config_messages.command(name="shutdown")
     async def pterodactyl_config_messages_shutdown(self, ctx: commands.Context, *, message: str) -> None:
         """Set the message that will be sent when the server stops."""
         await config.shutdown_msg.set(message)
         await ctx.send(f"Shutdown message set to: {message}")
 
-    @pterodactyl_config_messages.command(name = "join")
+    @pterodactyl_config_messages.command(name="join")
     async def pterodactyl_config_messages_join(self, ctx: commands.Context, *, message: str) -> None:
         """Set the message that will be sent when a user joins the server. This is only shown in embeds."""
         await config.join_msg.set(message)
         await ctx.send(f"Join message set to: {message}")
 
-    @pterodactyl_config_messages.command(name = "leave")
+    @pterodactyl_config_messages.command(name="leave")
     async def pterodactyl_config_messages_leave(self, ctx: commands.Context, *, message: str) -> None:
         """Set the message that will be sent when a user leaves the server. This is only shown in embeds."""
         await config.leave_msg.set(message)
         await ctx.send(f"Leave message set to: {message}")
 
-    @pterodactyl_config.command(name = "ip")
+    @pterodactyl_config.command(name="ip")
     async def pterodactyl_config_mask_ip(self, ctx: commands.Context, mask: bool) -> None:
         """Mask the IP addresses of users in console messages."""
         await config.mask_ip.set(mask)
         await ctx.send(f"IP masking set to {mask}")
 
-    @pterodactyl_config.command(name = "api")
+    @pterodactyl_config.command(name="api")
     async def pterodactyl_config_api(self, ctx: commands.Context, endpoint: str) -> None:
         """Set the API endpoint for retrieving user avatars.
 
@@ -516,11 +524,14 @@ class Pterodactyl(commands.Cog):
         await config.api_endpoint.set(endpoint)
         await ctx.send(f"API endpoint set to {endpoint}")
 
-    @pterodactyl_config_regex.group(name = "blacklist", aliases = ['block', 'blocklist'],)
+    @pterodactyl_config_regex.group(
+        name="blacklist",
+        aliases=["block", "blocklist"],
+    )
     async def pterodactyl_config_regex_blacklist(self, ctx: commands.Context):
         """Blacklist regex patterns."""
 
-    @pterodactyl_config_regex_blacklist.command(name = "add")
+    @pterodactyl_config_regex_blacklist.command(name="add")
     async def pterodactyl_config_regex_blacklist_add(self, ctx: commands.Context, name: str, *, regex: str) -> None:
         """Add a regex pattern to the blacklist."""
         async with config.regex_blacklist() as blacklist:
@@ -538,7 +549,7 @@ class Pterodactyl(commands.Cog):
                 else:
                     await msg.edit(content="Cancelled.")
 
-    @pterodactyl_config_regex_blacklist.command(name = "remove")
+    @pterodactyl_config_regex_blacklist.command(name="remove")
     async def pterodactyl_config_regex_blacklist_remove(self, ctx: commands.Context, name: str) -> None:
         """Remove a regex pattern from the blacklist."""
         async with config.regex_blacklist() as blacklist:
@@ -555,7 +566,7 @@ class Pterodactyl(commands.Cog):
             else:
                 await ctx.send(f"Name `{name}` does not exist in the blacklist.")
 
-    @pterodactyl_config.command(name = 'view', aliases = ['show'])
+    @pterodactyl_config.command(name="view", aliases=["show"])
     async def pterodactyl_config_view(self, ctx: commands.Context) -> None:
         """View the current configuration."""
         base_url = await config.base_url()
@@ -580,7 +591,7 @@ class Pterodactyl(commands.Cog):
         topic_text = await config.topic()
         topic_hostname = await config.topic_hostname()
         topic_port = await config.topic_port()
-        embed = discord.Embed(color = await ctx.embed_color(), title="Pterodactyl Configuration")
+        embed = discord.Embed(color=await ctx.embed_color(), title="Pterodactyl Configuration")
         embed.description = f"""**Base URL:** {base_url}
                        **Server ID:** `{server_id}`
                        **Console Channel:** <#{console_channel}>
@@ -596,19 +607,19 @@ class Pterodactyl(commands.Cog):
 
                         **Topic Hostname:** `{topic_hostname}`
                         **Topic Port:** `{topic_port}`
-                        **Topic Text:** {box(topic_text, 'yaml')}
+                        **Topic Text:** {box(topic_text, "markdown")}
 
-                       **Chat Command:** {box(chat_command, 'json')}
-                       **Chat Regex:** {box(chat_regex, 're')}
-                       **Server Regex:** {box(server_regex, 're')}
-                       **Join Regex:** {box(join_regex, 're')}
-                       **Leave Regex:** {box(leave_regex, 're')}
-                       **Achievement Regex:** {box(achievement_regex, 're')}"""
+                       **Chat Command:** {box(chat_command, "json")}
+                       **Chat Regex:** {box(chat_regex, "regex")}
+                       **Server Regex:** {box(server_regex, "regex")}
+                       **Join Regex:** {box(join_regex, "regex")}
+                       **Leave Regex:** {box(leave_regex, "regex")}
+                       **Achievement Regex:** {box(achievement_regex, "regex")}"""
         await ctx.send(embed=embed)
         if not len(regex_blacklist) == 0:
-            regex_blacklist_embed = discord.Embed(color = await ctx.embed_color(), title="Regex Blacklist")
+            regex_blacklist_embed = discord.Embed(color=await ctx.embed_color(), title="Regex Blacklist")
             for name, regex in regex_blacklist.items():
-                regex_blacklist_embed.add_field(name=name, value=box(regex, 're'), inline=False)
+                regex_blacklist_embed.add_field(name=name, value=box(regex, "regex"), inline=False)
             await ctx.send(embed=regex_blacklist_embed)
 
     def get_bool_str(self, inp: bool) -> str:

pterodactyl/websocket.py

@@ -2,14 +2,14 @@
 import json
 import re
 from pathlib import Path
-from typing import Optional, Tuple, Union
+from typing import Any, Optional, Tuple, Union
 
 import aiohttp
 import discord
-import websockets
 from pydactyl import PterodactylClient
 from redbot.core.data_manager import bundled_data_path
 from redbot.core.utils.chat_formatting import bold, pagify
+from websockets.asyncio.client import connect
 
 from pterodactyl.config import config
 from pterodactyl.logger import logger, websocket_logger
@@ -19,16 +19,16 @@ from pterodactyl.pterodactyl import Pterodactyl
 async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
     await coginstance.bot.wait_until_red_ready()
     base_url = await config.base_url()
-    base_url = base_url[:-1] if base_url.endswith('/') else base_url
+    base_url = base_url[:-1] if base_url.endswith("/") else base_url
 
     logger.info("Establishing WebSocket connection")
 
     websocket_credentials = await retrieve_websocket_credentials(coginstance)
 
-    async with websockets.connect(websocket_credentials['data']['socket'], origin=base_url, ping_timeout=60, logger=websocket_logger) as websocket:
+    async with connect(websocket_credentials["data"]["socket"], origin=base_url, ping_timeout=60, logger=websocket_logger) as websocket:
         logger.info("WebSocket connection established")
 
-        auth_message = json.dumps({"event": "auth", "args": [websocket_credentials['data']['token']]})
+        auth_message = json.dumps({"event": "auth", "args": [websocket_credentials["data"]["token"]]})
         await websocket.send(auth_message)
         logger.info("Authentication message sent")
 
@@ -36,29 +36,31 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
 
         while True:  # pylint: disable=too-many-nested-blocks
             message = json.loads(await websocket.recv())
-            if message['event'] in ('token expiring', 'token expired'):
+            if message["event"] in ("token expiring", "token expired"):
                 logger.info("Received token expiring/expired event. Refreshing token.")
                 websocket_credentials = await retrieve_websocket_credentials(coginstance)
-                auth_message = json.dumps({"event": "auth", "args": [websocket_credentials['data']['token']]})
+                auth_message = json.dumps({"event": "auth", "args": [websocket_credentials["data"]["token"]]})
                 await websocket.send(auth_message)
                 logger.info("Authentication message sent")
 
-            if message['event'] == 'auth success':
+            if message["event"] == "auth success":
                 logger.info("WebSocket authentication successful")
 
-            if message['event'] == 'console output' and await config.console_channel() is not None:
+            if message["event"] == "console output" and await config.console_channel() is not None:
                 regex_blacklist: dict = await config.regex_blacklist()
-                matches = [re.search(regex, message['args'][0]) for regex in regex_blacklist.values()]
+                matches = [re.search(regex, message["args"][0]) for regex in regex_blacklist.values()]
 
-                if await config.current_status() in ('running', '') and not any(matches):
-                    content = remove_ansi_escape_codes(message['args'][0])
+                if await config.current_status() in ("running", "") and not any(matches):
+                    content = remove_ansi_escape_codes(message["args"][0])
                     if await config.mask_ip() is True:
                         content = mask_ip(content)
 
                     console_channel = coginstance.bot.get_channel(await config.console_channel())
+                    assert isinstance(console_channel, discord.abc.Messageable)
                     chat_channel = coginstance.bot.get_channel(await config.chat_channel())
+                    assert isinstance(chat_channel, discord.abc.Messageable)
                     if console_channel is not None:
-                        if content.startswith('['):
+                        if content.startswith("["):
                             pagified_content = pagify(content, delims=[" ", "\n"])
                             for page in pagified_content:
                                 await console_channel.send(content=page, allowed_mentions=discord.AllowedMentions.none())
@@ -66,24 +68,24 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
                     server_message = await check_if_server_message(content)
                     if server_message:
                         if chat_channel is not None:
-                            await chat_channel.send(server_message if len(server_message) < 2000 else server_message[:1997] + '...', allowed_mentions=discord.AllowedMentions.none())
+                            await chat_channel.send(server_message if len(server_message) < 2000 else server_message[:1997] + "...", allowed_mentions=discord.AllowedMentions.none())
 
                     chat_message = await check_if_chat_message(content)
                     if chat_message:
-                        info = await get_info(chat_message['username'])
+                        info = await get_info(chat_message["username"])
                         if info is not None:
-                            await send_chat_discord(coginstance, chat_message['username'], chat_message['message'], info['data']['player']['avatar'])
+                            await send_chat_discord(coginstance, chat_message["username"], chat_message["message"], info["data"]["player"]["avatar"])
                         else:
-                            await send_chat_discord(coginstance, chat_message['username'], chat_message['message'], 'https://seafsh.cc/u/j3AzqQ.png')
+                            await send_chat_discord(coginstance, chat_message["username"], chat_message["message"], "https://seafsh.cc/u/j3AzqQ.png")
 
                     join_message = await check_if_join_message(content)
                     if join_message:
                         if chat_channel is not None:
                             if coginstance.bot.embed_requested(chat_channel):
-                                embed, img = await generate_join_leave_embed(coginstance=coginstance, username=join_message,join=True)
+                                embed, img = await generate_join_leave_embed(coginstance=coginstance, username=join_message, join=True)
                                 if img:
-                                    with open(img, 'rb') as file:
-                                        await chat_channel.send(embed=embed, file=file)
+                                    with open(img, "rb") as file:
+                                        await chat_channel.send(embed=embed, file=discord.File(fp=file))
                                 else:
                                     await chat_channel.send(embed=embed)
                             else:
@@ -93,10 +95,10 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
                     if leave_message:
                         if chat_channel is not None:
                             if coginstance.bot.embed_requested(chat_channel):
-                                embed, img = await generate_join_leave_embed(coginstance=coginstance, username=leave_message,join=False)
+                                embed, img = await generate_join_leave_embed(coginstance=coginstance, username=leave_message, join=False)
                                 if img:
-                                    with open(img, 'rb') as file:
-                                        await chat_channel.send(embed=embed, file=file)
+                                    with open(img, "rb") as file:
+                                        await chat_channel.send(embed=embed, file=discord.File(fp=file))
                                 else:
                                     await chat_channel.send(embed=embed)
                             else:
@@ -106,13 +108,17 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
                     if achievement_message:
                         if chat_channel is not None:
                             if coginstance.bot.embed_requested(chat_channel):
-                                await chat_channel.send(embed=await generate_achievement_embed(coginstance, achievement_message['username'], achievement_message['achievement'], achievement_message['challenge']))
+                                embed, img = await generate_achievement_embed(coginstance, achievement_message["username"], achievement_message["achievement"], achievement_message["challenge"])
+                                if img:
+                                    await chat_channel.send(embed=embed, file=discord.File(fp=img))
+                                else:
+                                    await chat_channel.send(embed=embed)
                             else:
                                 await chat_channel.send(f"{achievement_message['username']} has {'completed the challenge' if achievement_message['challenge'] else 'made the advancement'} {achievement_message['achievement']}")
 
-            if message['event'] == 'status':
+            if message["event"] == "status":
                 old_status = await config.current_status()
-                current_status = message['args'][0]
+                current_status = message["args"][0]
                 if old_status != current_status:
                     await config.current_status.set(current_status)
                     if await config.console_channel() is not None:
@@ -120,81 +126,92 @@ async def establish_websocket_connection(coginstance: Pterodactyl) -> None:
                         if console is not None:
                             await console.send(f"Server status changed! `{current_status}`")
                     if await config.chat_channel() is not None:
-                        if current_status == 'running' and await config.startup_msg() is not None:
+                        if current_status == "running" and await config.startup_msg() is not None:
                             chat = coginstance.bot.get_channel(await config.chat_channel())
                             if chat is not None:
                                 await chat.send(await config.startup_msg())
-                        if current_status == 'stopping' and await config.shutdown_msg() is not None:
+                        if current_status == "stopping" and await config.shutdown_msg() is not None:
                             chat = coginstance.bot.get_channel(await config.chat_channel())
                             if chat is not None:
                                 await chat.send(await config.shutdown_msg())
 
-async def retrieve_websocket_credentials(coginstance: Pterodactyl) -> Optional[dict]:
+
+async def retrieve_websocket_credentials(coginstance: Pterodactyl) -> dict:
     pterodactyl_keys = await coginstance.bot.get_shared_api_tokens("pterodactyl")
     api_key = pterodactyl_keys.get("api_key")
     if api_key is None:
-        coginstance.task.cancel()
+        coginstance.maybe_cancel_task()
         raise ValueError("Pterodactyl API key not set. Please set it using `[p]set api`.")
     base_url = await config.base_url()
     if base_url is None:
-        coginstance.task.cancel()
+        coginstance.maybe_cancel_task()
         raise ValueError("Pterodactyl base URL not set. Please set it using `[p]pterodactyl config url`.")
     server_id = await config.server_id()
     if server_id is None:
-        coginstance.task.cancel()
+        coginstance.maybe_cancel_task()
         raise ValueError("Pterodactyl server ID not set. Please set it using `[p]pterodactyl config serverid`.")
 
     client = PterodactylClient(base_url, api_key).client
     coginstance.client = client
-    websocket_credentials = client.servers.get_websocket(server_id)
-    logger.debug("""Websocket connection details retrieved:
+    websocket_credentials: dict[str, Any] = client.servers.get_websocket(server_id)
+    if not websocket_credentials:
+        coginstance.maybe_cancel_task()
+        raise ValueError("Failed to retrieve websocket credentials. Please ensure the API details are correctly configured.")
+    logger.debug(
+        """Websocket connection details retrieved:
                         Socket: %s
                         Token: %s...""",
-                        websocket_credentials['data']['socket'],
-                        websocket_credentials['data']['token'][:20]
+        websocket_credentials["data"]["socket"],
+        websocket_credentials["data"]["token"][:20],
     )
     return websocket_credentials
-    #NOTE - The token is truncated to prevent it from being logged in its entirety, for security reasons
+    # NOTE - The token is truncated to prevent it from being logged in its entirety, for security reasons
+
 
 def remove_ansi_escape_codes(text: str) -> str:
-    ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
-    #NOTE - https://chat.openai.com/share/d92f9acf-d776-4fd6-a53f-b14ac15dd540
-    return ansi_escape.sub('', text)
+    ansi_escape = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
+    # NOTE - https://chat.openai.com/share/d92f9acf-d776-4fd6-a53f-b14ac15dd540
+    return ansi_escape.sub("", text)
 
-async def check_if_server_message(text: str) -> Union[bool, str]:
+
+async def check_if_server_message(text: str) -> Optional[str]:
     regex = await config.server_regex()
     match: Optional[re.Match[str]] = re.match(regex, text)
     if match:
         logger.trace("Message is a server message")
         return match.group(1)
-    return False
+    return None
 
-async def check_if_chat_message(text: str) -> Union[bool, dict]:
+
+async def check_if_chat_message(text: str) -> Optional[dict]:
     regex = await config.chat_regex()
     match: Optional[re.Match[str]] = re.match(regex, text)
     if match:
         groups = {"username": match.group(1), "message": match.group(2)}
         logger.trace("Message is a chat message\n%s", json.dumps(groups))
         return groups
-    return False
+    return None
 
-async def check_if_join_message(text: str) -> Union[bool, str]:
+
+async def check_if_join_message(text: str) -> Optional[str]:
     regex = await config.join_regex()
     match: Optional[re.Match[str]] = re.match(regex, text)
     if match:
         logger.trace("Message is a join message")
         return match.group(1)
-    return False
+    return None
 
-async def check_if_leave_message(text: str) -> Union[bool, str]:
+
+async def check_if_leave_message(text: str) -> Optional[str]:
     regex = await config.leave_regex()
     match: Optional[re.Match[str]] = re.match(regex, text)
     if match:
         logger.trace("Message is a leave message")
         return match.group(1)
-    return False
+    return None
 
-async def check_if_achievement_message(text: str) -> Union[bool, dict]:
+
+async def check_if_achievement_message(text: str) -> Optional[dict]:
     regex = await config.achievement_regex()
     match: Optional[re.Match[str]] = re.match(regex, text)
     if match:
@@ -205,7 +222,8 @@ async def check_if_achievement_message(text: str) -> Union[bool, dict]:
             groups["challenge"] = False
         logger.trace("Message is an achievement message")
         return groups
-    return False
+    return None
+
 
 async def get_info(username: str) -> Optional[dict]:
     logger.verbose("Retrieving player info for %s", username)
@@ -218,6 +236,7 @@ async def get_info(username: str) -> Optional[dict]:
             logger.warning("Failed to retrieve player info for %s: %s", username, response.status)
             return None
 
+
 async def send_chat_discord(coginstance: Pterodactyl, username: str, message: str, avatar_url: str) -> None:
     logger.trace("Sending chat message to Discord")
     channel = coginstance.bot.get_channel(await config.chat_channel())
@@ -231,6 +250,7 @@ async def send_chat_discord(coginstance: Pterodactyl, username: str, message: st
     else:
         logger.warning("Chat channel not set. Skipping sending chat message to Discord")
 
+
 async def generate_join_leave_embed(coginstance: Pterodactyl, username: str, join: bool) -> Tuple[discord.Embed, Optional[Union[str, Path]]]:
     embed = discord.Embed()
     embed.color = discord.Color.green() if join else discord.Color.red()
@@ -238,30 +258,32 @@ async def generate_join_leave_embed(coginstance: Pterodactyl, username: str, joi
     info = await get_info(username)
     if info:
         img = None
-        embed.set_author(name=username, icon_url=info['data']['player']['avatar'])
+        embed.set_author(name=username, icon_url=info["data"]["player"]["avatar"])
     else:
         img = bundled_data_path(coginstance) / "unknown.png"
-        embed.set_author(name=username, icon_url='attachment://unknown.png')
+        embed.set_author(name=username, icon_url="attachment://unknown.png")
     embed.timestamp = discord.utils.utcnow()
     return embed, img
 
+
 async def generate_achievement_embed(coginstance: Pterodactyl, username: str, achievement: str, challenge: bool) -> Tuple[discord.Embed, Optional[Union[str, Path]]]:
     embed = discord.Embed()
-    embed.color = discord.Color.from_str('#a800a7') if challenge else discord.Color.from_str('#54fb54')
+    embed.color = discord.Color.from_str("#a800a7") if challenge else discord.Color.from_str("#54fb54")
     embed.description = f"{bold(username)} has {'completed the challenge' if challenge else 'made the advancement'} {bold(achievement)}"
     info = await get_info(username)
     if info:
         img = None
-        embed.set_author(name=username, icon_url=info['data']['player']['avatar'])
+        embed.set_author(name=username, icon_url=info["data"]["player"]["avatar"])
     else:
         img = bundled_data_path(coginstance) / "unknown.png"
-        embed.set_author(name=username, icon_url='attachment://unknown.png')
+        embed.set_author(name=username, icon_url="attachment://unknown.png")
     embed.timestamp = discord.utils.utcnow()
     return embed, img
 
+
 def mask_ip(string: str) -> str:
     def check(match: re.Match[str]):
         ip = match.group(0)
-        masked_ip = '.'.join(r'\*' * len(octet) for octet in ip.split('.'))
-        return masked_ip
-    return re.sub(r'\b(?:\d{1,3}\.){3}\d{1,3}\b', check, string)
+        return ".".join(r"\*" * len(octet) for octet in ip.split("."))
+
+    return re.sub(r"\b(?:\d{1,3}\.){3}\d{1,3}\b", check, string)

pyproject.toml

@@ -2,44 +2,45 @@
 name = "seacogs"
 version = "0.1.0"
 description = "My assorted cogs for Red-DiscordBot."
-authors = [{name = "cswimr", email = "seaswimmerthefsh@gmail.com"}]
-license = {file="LICENSE"}
+authors = [{ name = "cswimr", email = "seaswimmerthefsh@gmail.com" }]
+license = { file = "LICENSE" }
 readme = "README.md"
 requires-python = ">=3.11"
 dependencies = [
-    "aiosqlite>=0.20.0",
-    "beautifulsoup4>=4.12.3",
-    "colorthief>=0.2.1",
-    "markdownify>=0.13.1",
-    "numpy>=2.1.2",
-    "phx-class-registry>=5.0.0",
-    "pillow>=10.4.0",
-    "pip>=24.3.1",
+  "aiosqlite==0.21.0",
+  "beautifulsoup4==4.13.3",
+  "colorthief==0.2.1",
+  "markdownify==1.1.0",
+  "numpy==2.2.4",
+  "phx-class-registry==5.1.1",
+  "pillow==10.4.0",
+  "pip==25.0.1",
   "py-dactyl",
-    "pydantic>=2.9.2",
-    "red-discordbot>=3.5.14",
-    "websockets>=13.1",
+  "pydantic==2.11.1",
+  "red-discordbot==3.5.18",
+  "watchdog==6.0.0",
+  "websockets==15.0.1",
 ]
 
-[project.optional-dependencies]
+[dependency-groups]
 documentation = [
-    "mkdocs>=1.6.1",
-    "mkdocs-git-authors-plugin>=0.9.0",
-    "mkdocs-git-revision-date-localized-plugin>=1.2.9",
-    "mkdocs-material[imaging]>=9.5.40",
-    "mkdocstrings[python]>=0.26.1",
-    "mkdocs-redirects>=1.2.1",
+  "mkdocs==1.6.1",
+  "mkdocs-git-authors-plugin==0.9.4",
+  "mkdocs-git-revision-date-localized-plugin==1.4.5",
+  "mkdocs-material[imaging]==9.6.10",
+  "mkdocs-redirects==1.2.2",
+  "mkdocstrings[python]==0.29.0",
 ]
 
 [tool.uv]
-dev-dependencies = [
-    "pylint>=3.3.1",
-    "ruff>=0.6.9",
-    "sqlite-web>=0.6.4",
-]
+dev-dependencies = ["pylint==3.3.6", "ruff==0.11.2", "sqlite-web==0.6.4"]
 
 [tool.uv.sources]
-py-dactyl = { git = "https://github.com/cswimr/pydactyl" }
+py-dactyl = { git = "https://github.com/iamkubi/pydactyl", tag = "v2.0.5" }
+
+[tool.basedpyright]
+typeCheckingMode = "basic"
+reportAttributeAccessIssue = false # disabled because `commands.group.command` is listed as Any / Unknown for some reason
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.
@@ -83,8 +84,32 @@ target-version = "py311"
 # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
 # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
 # McCabe complexity (`C901`) by default.
-select = ["F", "W", "E", "C901"]
-ignore = ["C901"]
+select = [
+  "I",
+  "N",
+  "F",
+  "W",
+  "E",
+  "G",
+  "A",
+  "COM",
+  "INP",
+  "T20",
+  "PLC",
+  "PLE",
+  "PLW",
+  "PLR",
+  "LOG",
+  "SLF",
+  "ERA",
+  "FIX",
+  "PERF",
+  "C4",
+  "EM",
+  "RET",
+  "RSE",
+]
+ignore = ["PLR0911", "PLR0912", "PLR0915", "PLR2004", "PLR0913", "EM101"]
 
 # Allow fix for all enabled rules (when `--fix`) is provided.
 fixable = ["ALL"]

seautils/info.json

@@ -1,10 +1,11 @@
 {
-  "author" : ["cswimr"],
-  "install_msg" : "Thank you for installing SeaUtils!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
-  "name" : "SeaUtils",
-  "short" : "A collection of useful utilities.",
-  "description" : "A collection of useful utilities.",
-  "end_user_data_statement" : "This cog does not store end user data.",
+  "$schema": "https://raw.githubusercontent.com/Cog-Creators/Red-DiscordBot/refs/heads/V3/develop/schema/red_cog_repo.schema.json",
+  "author": ["cswimr"],
+  "install_msg": "Thank you for installing SeaUtils!\nYou can find the source code of this cog [here](https://coastalcommits.com/cswimr/SeaCogs).",
+  "name": "SeaUtils",
+  "short": "A collection of useful utilities.",
+  "description": "A collection of useful utilities.",
+  "end_user_data_statement": "This cog does not store end user data.",
   "hidden": true,
   "disabled": false,
   "min_bot_version": "3.5.0",

seautils/seautils.py

@@ -29,18 +29,20 @@ from redbot.core.utils.views import SimpleMenu
 def md(soup: BeautifulSoup, **options) -> Any | str:
     return MarkdownConverter(**options).convert_soup(soup=soup)
 
+
 def format_rfc_text(text: str, number: int) -> str:
     one: str = re.sub(r"\(\.\/rfc(\d+)", r"(https://www.rfc-editor.org/rfc/rfc\1.html", text)
     two: str = re.sub(r"\((#(?:section|page)-\d+(?:.\d+)?)\)", f"(https://www.rfc-editor.org/rfc/rfc{number}.html\1)", one)
     three: str = re.sub(r"\n{3,}", "\n\n", two)
     return three
 
+
 class SeaUtils(commands.Cog):
     """A collection of random utilities."""
 
     __author__ = ["[cswimr](https://www.coastalcommits.com/cswimr)"]
     __git__ = "https://www.coastalcommits.com/cswimr/SeaCogs"
-    __version__ = "1.0.1"
+    __version__ = "1.0.2"
     __documentation__ = "https://seacogs.coastalcommits.com/seautils/"
 
     def __init__(self, bot: Red) -> None:
@@ -57,7 +59,6 @@ class SeaUtils(commands.Cog):
         ]
         return "\n".join(text)
 
-
     def format_src(self, obj: Any) -> str:
         """A large portion of this code is repurposed from Zephyrkul's RTFS cog.
         https://github.com/Zephyrkul/FluffyCogs/blob/master/rtfs/rtfs.py"""
@@ -73,9 +74,9 @@ class SeaUtils(commands.Cog):
             src = obj.function
         return inspect.getsource(object=src)
 
-    @commands.command(aliases=["source", "src", "code", "showsource"])
+    @commands.command(aliases=["source", "src", "code", "showsource"])  # type: ignore
     @commands.is_owner()
-    async def showcode(self, ctx: commands.Context, *, object: str) -> None: # pylint: disable=redefined-builtin
+    async def showcode(self, ctx: commands.Context, *, object: str) -> None:  # pylint: disable=redefined-builtin  # noqa: A002
         """Show the code for a particular object."""
         try:
             if object.startswith("/") and (obj := ctx.bot.tree.get_command(object[1:])):
@@ -86,11 +87,7 @@ class SeaUtils(commands.Cog):
                 text = self.format_src(obj)
             else:
                 raise AttributeError
-            temp_content = cf.pagify(
-                text=cleanup_code(text),
-                escape_mass_mentions=True,
-                page_length = 1977
-            )
+            temp_content = cf.pagify(text=cleanup_code(text), escape_mass_mentions=True, page_length=1977)
             content = []
             max_i = operator.length_hint(temp_content)
             i = 1
@@ -105,7 +102,7 @@ class SeaUtils(commands.Cog):
             else:
                 await ctx.send(content="Object not found!", reference=ctx.message.to_reference(fail_if_not_exists=False))
 
-    @commands.command(name='dig', aliases=['dnslookup', 'nslookup'])
+    @commands.command(name="dig", aliases=["dnslookup", "nslookup"])  # type: ignore
     @commands.is_owner()
     async def dig(self, ctx: commands.Context, name: str, record_type: str | None = None, server: str | None = None, port: int = 53) -> None:
         """Retrieve DNS information for a domain.
@@ -113,13 +110,13 @@ class SeaUtils(commands.Cog):
         Uses `dig` to perform a DNS query. Will fall back to `nslookup` if `dig` is not installed on the system.
         `nslookup` does not provide as much information as `dig`, so only the `name` parameter will be used if `nslookup` is used.
         Will return the A, AAAA, and CNAME records for a domain by default. You can specify a different record type with the `type` parameter."""
-        command_opts: list[str | int] = ['dig']
-        query_types: list[str] = [record_type] if record_type else ['A', 'AAAA', 'CNAME']
+        command_opts: list[str] = ["dig"]
+        query_types: list[str] = [record_type] if record_type else ["A", "AAAA", "CNAME"]
         if server:
-            command_opts.extend(['@', server])
+            command_opts.extend(["@", server])
         for query_type in query_types:
             command_opts.extend([name, query_type])
-        command_opts.extend(['-p', str(port), '+yaml'])
+        command_opts.extend(["-p", str(port), "+yaml"])
 
         try:
             process: Process = await asyncio.create_subprocess_exec(*command_opts, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
@@ -128,22 +125,18 @@ class SeaUtils(commands.Cog):
                 await ctx.maybe_send_embed(message="An error was encountered!\n" + cf.box(text=stderr.decode()))
             else:
                 data = yaml.safe_load(stdout.decode())
-                message_data: dict = data[0]['message']
-                response_data: dict = message_data['response_message_data']
+                message_data: dict = data[0]["message"]
+                response_data: dict = message_data["response_message_data"]
                 if ctx.embed_requested():
-                    embed = Embed(
-                        title="DNS Query Result",
-                        color=await ctx.embed_color(),
-                        timestamp=message_data['response_time']
-                    )
-                    embed.add_field(name="Response Address", value=message_data['response_address'], inline=True)
-                    embed.add_field(name="Response Port", value=message_data['response_port'], inline=True)
-                    embed.add_field(name="Query Address", value=message_data['query_address'], inline=True)
-                    embed.add_field(name="Query Port", value=message_data['query_port'], inline=True)
-                    embed.add_field(name="Status", value=response_data['status'], inline=True)
-                    embed.add_field(name="Flags", value=response_data['flags'], inline=True)
+                    embed = Embed(title="DNS Query Result", color=await ctx.embed_color(), timestamp=message_data["response_time"])
+                    embed.add_field(name="Response Address", value=message_data["response_address"], inline=True)
+                    embed.add_field(name="Response Port", value=message_data["response_port"], inline=True)
+                    embed.add_field(name="Query Address", value=message_data["query_address"], inline=True)
+                    embed.add_field(name="Query Port", value=message_data["query_port"], inline=True)
+                    embed.add_field(name="Status", value=response_data["status"], inline=True)
+                    embed.add_field(name="Flags", value=response_data["flags"], inline=True)
 
-                    if response_data.get('status') != 'NOERROR':
+                    if response_data.get("status") != "NOERROR":
                         embed.colour = Color.red()
                         embed.description = cf.error("Dig query did not return `NOERROR` status.")
 
@@ -151,19 +144,19 @@ class SeaUtils(commands.Cog):
                     answers = []
                     authorities = []
                     for m in data:
-                        response = m['message']['response_message_data']
-                        if 'QUESTION_SECTION' in response:
-                            for question in response['QUESTION_SECTION']:
+                        response = m["message"]["response_message_data"]
+                        if "QUESTION_SECTION" in response:
+                            for question in response["QUESTION_SECTION"]:
                                 if question not in questions:
                                     questions.append(question)
 
-                        if 'ANSWER_SECTION' in response:
-                            for answer in response['ANSWER_SECTION']:
+                        if "ANSWER_SECTION" in response:
+                            for answer in response["ANSWER_SECTION"]:
                                 if answer not in answers:
                                     answers.append(answer)
 
-                        if 'AUTHORITY_SECTION' in response:
-                            for authority in response['AUTHORITY_SECTION']:
+                        if "AUTHORITY_SECTION" in response:
+                            for authority in response["AUTHORITY_SECTION"]:
                                 if authority not in authorities:
                                     authorities.append(authority)
 
@@ -183,26 +176,22 @@ class SeaUtils(commands.Cog):
                         embed.add_field(name="Authority Section", value=f"{cf.box(text=authority_section, lang='prolog')}", inline=False)
                     await ctx.send(embed=embed)
                 else:
-                    await ctx.send(content=cf.box(text=stdout, lang='yaml'))
-        except (FileNotFoundError):
+                    await ctx.send(content=cf.box(text=str(stdout), lang="yaml"))
+        except FileNotFoundError:
             try:
-                ns_process = await asyncio.create_subprocess_exec('nslookup', name, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
+                ns_process = await asyncio.create_subprocess_exec("nslookup", name, stdout=asyncio.subprocess.PIPE, stderr=asyncio.subprocess.PIPE)
                 ns_stdout, ns_stderr = await ns_process.communicate()
                 if ns_stderr:
                     await ctx.maybe_send_embed(message="An error was encountered!\n" + cf.box(text=ns_stderr.decode()))
                 else:
                     warning = cf.warning("`dig` is not installed! Defaulting to `nslookup`.\nThis command provides more information when `dig` is installed on the system.\n")
                     if await ctx.embed_requested():
-                        embed = Embed(
-                            title="DNS Query Result",
-                            color=await ctx.embed_color(),
-                            timestamp=ctx.message.created_at
-                        )
+                        embed = Embed(title="DNS Query Result", color=await ctx.embed_color(), timestamp=ctx.message.created_at)
                         embed.description = warning + cf.box(text=ns_stdout.decode())
                         await ctx.send(embed=embed)
                     else:
-                        await ctx.send(content = warning + cf.box(text=ns_stdout.decode()))
-            except (FileNotFoundError):
+                        await ctx.send(content=warning + cf.box(text=ns_stdout.decode()))
+            except FileNotFoundError:
                 await ctx.maybe_send_embed(message=cf.error("Neither `dig` nor `nslookup` are installed on the system. Unable to resolve DNS query."))
 
     @commands.command()
@@ -217,38 +206,27 @@ class SeaUtils(commands.Cog):
             async with session.get(url=url) as response:
                 if response.status == 200:
                     html = await response.text()
-                    soup = BeautifulSoup(html, 'html.parser')
-                    pre_tags = soup.find_all('pre')
-                    content: list[Embed | str] = []
+                    soup = BeautifulSoup(html, "html.parser")
+                    pre_tags = soup.find_all("pre")
+                    content: list[str | Embed] = []
                     for pre_tag in pre_tags:
                         text = format_rfc_text(md(pre_tag), number)
                         if len(text) > 4096:
                             pagified_text = cf.pagify(text, delims=["\n\n"], page_length=4096)
                             for page in pagified_text:
                                 if await ctx.embed_requested():
-                                    embed = Embed(
-                                        title=f"RFC Document {number}",
-                                        url=datatracker_url,
-                                        description=page,
-                                        color=await ctx.embed_color()
-                                    )
+                                    embed = Embed(title=f"RFC Document {number}", url=datatracker_url, description=page, color=await ctx.embed_color())
                                     content.append(embed)
                                 else:
                                     content.append(page)
-                        else:
-                            if await ctx.embed_requested():
-                                embed = Embed(
-                                    title=f"RFC Document {number}",
-                                    url=datatracker_url,
-                                    description=text,
-                                    color=await ctx.embed_color()
-                                )
+                        elif await ctx.embed_requested():
+                            embed = Embed(title=f"RFC Document {number}", url=datatracker_url, description=text, color=await ctx.embed_color())
                             content.append(embed)
                         else:
                             content.append(text)
                     if await ctx.embed_requested():
                         for embed in content:
                             embed.set_footer(text=f"Page {content.index(embed) + 1}/{len(content)}")
-                    await SimpleMenu(pages=content, disable_after_timeout=True, timeout=300).start(ctx)
+                    await SimpleMenu(pages=content, disable_after_timeout=True, timeout=300).start(ctx)  # type: ignore
                 else:
                     await ctx.maybe_send_embed(message=cf.error(f"An error occurred while fetching RFC {number}. Status code: {response.status}."))

speedtest/__init__.py

@@ -1,5 +0,0 @@
-from .speedtest import Speedtest
-
-
-async def setup(bot):
-    await bot.add_cog(Speedtest(bot))

speedtest/info.json

@@ -1,14 +0,0 @@
-{
-  "author" : ["SeaswimmerTheFsh (seasw.)"],
-  "install_msg" : "Thank you for installing Speedtest!\nYou can find the source code of this cog [here](https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs).",
-  "name" : "Speedtest",
-  "short" : "A collection of useful utilities.",
-  "description" : "A collection of useful utilities.",
-  "end_user_data_statement" : "This cog does not store end user data.",
-  "hidden": true,
-  "disabled": false,
-  "min_bot_version": "3.5.0",
-  "min_python_version": [3, 10, 0],
-  "tags" : ["utility", "information"],
-  "requirements": ["pydantic"]
-}

speedtest/models.py

@@ -1,76 +0,0 @@
-from datetime import datetime
-
-from pydantic import BaseModel
-
-
-class Speedtest(BaseModel):
-    type: str
-    timestamp: datetime
-    ping: "Ping"
-    download: "Bandwidth"
-    upload: "Bandwidth"
-    isp: str
-    interface: "Interface"
-    server: "Server"
-    result: "Result"
-
-    @classmethod
-    def from_json(cls, data: dict) -> "Speedtest":
-        return cls(
-            type=data["type"],
-            timestamp=datetime.fromisoformat(data["timestamp"]),
-            ping=Ping(**data["ping"]),
-            download=Bandwidth(**data["download"]),
-            upload=Bandwidth(**data["upload"]),
-            isp=data["isp"],
-            interface=Interface(**data["interface"]),
-            server=Server(**data["server"]),
-            result=Result(**data["result"])
-        )
-
-class Bandwidth(BaseModel):
-    bandwidth: float
-    bytes: int
-    elapsed: int
-    latency: "Latency"
-
-    @property
-    def mbps(self) -> float:
-        return self.bandwidth / 1_000_000
-
-class Latency(BaseModel):
-    iqm: float
-    low: float
-    high: float
-    jitter: float
-
-class Interface(BaseModel):
-    internalIp: str
-    name: str
-    macAddr: str
-    isVpn: bool
-    externalIp: str
-
-class Ping(BaseModel):
-    jitter: float
-    latency: float
-    low: float
-    high: float
-
-class Server(BaseModel):
-    id: int
-    name: str
-    location: str
-    country: str
-    host: str
-    port: int
-    ip: str
-
-class Result(BaseModel):
-    id: str
-    url: str
-    persisted: bool
-
-    @property
-    def image(self) -> str:
-        return self.url + ".png"

speedtest/speedtest.py

@@ -1,71 +0,0 @@
-#   _____                         _
-#  / ____|                       (_)
-# | (___   ___  __ _ _____      ___ _ __ ___  _ __ ___   ___ _ __
-#  \___ \ / _ \/ _` / __\ \ /\ / / | '_ ` _ \| '_ ` _ \ / _ \ '__|
-#  ____) |  __/ (_| \__ \\ V  V /| | | | | | | | | | | |  __/ |
-# |_____/ \___|\__,_|___/ \_/\_/ |_|_| |_| |_|_| |_| |_|\___|_|
-
-import asyncio
-import json
-import subprocess
-
-import discord
-from redbot.core import commands
-from redbot.core.bot import Red
-from redbot.core.utils import chat_formatting as cf
-
-from .models import Speedtest as sp
-
-
-class Speedtest(commands.Cog):
-    """A collection of random utilities."""
-
-    __author__ = ["SeaswimmerTheFsh"]
-    __version__ = "1.0.0"
-
-    def __init__(self, bot: Red):
-        self.bot = bot
-
-    def format_help_for_context(self, ctx: commands.Context) -> str:
-        pre_processed = super().format_help_for_context(ctx) or ""
-        n = "\n" if "\n\n" not in pre_processed else ""
-        text = [
-            f"{pre_processed}{n}",
-            f"Cog Version: **{self.__version__}**",
-            f"Author: {cf.humanize_list(self.__author__)}"
-        ]
-        return "\n".join(text)
-
-    async def run_speedtest(self) -> str | sp:
-        try:
-            process = await asyncio.create_subprocess_exec(
-                "speedtest", "-f", "json", "--accept-license", "--accept-gdpr",
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE
-            )
-        except FileNotFoundError:
-            return "Speedtest CLI is not installed."
-        stdout, stderr = await process.communicate()
-        if process.returncode != 0:
-            return stderr.decode("utf-8")
-        return sp.from_json(json.loads(stdout.decode("utf-8")))
-
-    @commands.command()
-    @commands.is_owner()
-    async def speedtest(self, ctx: commands.Context) -> None:
-        """Run a speedtest."""
-        msg = await ctx.maybe_send_embed("Running speedtest...")
-        async with ctx.typing():
-            speedtest = await self.run_speedtest()
-            if await ctx.embed_requested():
-                if not isinstance(speedtest, sp):
-                    await msg.edit(embed=discord.Embed(description=f"An error occurred! {speedtest}", color=discord.Colour.red()))
-                    return
-                embed = discord.Embed(title="Speedtest Results", url=speedtest.result.url, color=await ctx.embed_color())
-                embed.set_image(url=speedtest.result.image)
-                await msg.edit(embed=embed)
-            else:
-                if not isinstance(speedtest, sp):
-                    await msg.edit(content=f"An error occurred! \n`{speedtest}`")
-                    return
-                await msg.edit(content=f"**[Result]({speedtest.result.url})**")