Improved type-hinting and overall sanity checks implemented.

2024-12-16 20:34:37 +01:00
parent 5c763fc02e
commit c05cf64ae0
14 changed files with 193 additions and 165 deletions
--- a/cogs/admin.py
+++ b/cogs/admin.py
@@ -1,14 +1,23 @@
 import logging
 import sys
+from typing import Union

-from discord import ApplicationContext, Embed, User, option, slash_command
+from discord import (
+    ApplicationContext,
+    Embed,
+    User,
+    option,
+    slash_command,
+    Role,
+    TextChannel,
+)
 from discord import utils as ds_utils
 from discord.ext import commands
 from libbot import config_get
 from libbot.pycord.classes import PycordBot
 from libbot.sync import config_get as sync_config_get

-from enums.colors import Color
+from enums import Color
 from modules.scheduled import scheduler
 from modules.utils_sync import guild_name
 from modules.waifu_pics import waifu_pics
@@ -20,7 +29,7 @@ class Admin(commands.Cog):
    """Cog with utility commands for admins."""

    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

    # Disabled because warning functionality is temporarily not needed
    # @slash_command(
@@ -117,7 +126,7 @@ class Admin(commands.Cog):
        ctx: ApplicationContext,
        amount: int,
        user: User,
-    ):
+    ) -> None:
        if ctx.user.id in self.client.owner_ids:
            logging.info(
                "User %s removed %s message(s) in %s",
@@ -148,46 +157,51 @@ class Admin(commands.Cog):
            embed=Embed(
                title="Відмовлено в доступі",
                description="Здається, це команда лише для модераторів",
-                color=Color.fail,
+                color=Color.FAIL,
            )
        )

-        mod_role = ds_utils.get(
+        mod_role: Union[Role, None] = ds_utils.get(
            ctx.user.guild.roles, id=await config_get("moderators", "roles")
        )
-        admin_chan = ds_utils.get(
+        admin_chan: Union[TextChannel, None] = ds_utils.get(
            ctx.user.guild.channels,
            id=await config_get("adminchat", "channels", "text"),
        )

-        await admin_chan.send(
-            content=f"{mod_role.mention}",
-            embed=Embed(
-                title="Неавторизований запит",
-                description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
-                color=Color.fail,
-            ),
-        )
+        if admin_chan is not None:
+            await admin_chan.send(
+                content="" if mod_role is None else mod_role.mention,
+                embed=Embed(
+                    title="Неавторизований запит",
+                    description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
+                    color=Color.FAIL,
+                ),
+            )

    @slash_command(
        name="reboot",
        description="Перезапустити бота",
        guild_ids=[sync_config_get("guild")],
    )
-    async def reboot_cmd(self, ctx: ApplicationContext):
+    async def reboot_cmd(self, ctx: ApplicationContext) -> None:
        await ctx.defer(ephemeral=True)

        if ctx.user.id in self.client.owner_ids:
            logging.info("Calling shutdown initiated by %s", guild_name(ctx.user))
+
            await ctx.respond(
                embed=Embed(
                    title="Вимикаюсь...",
                    description="Спробую перезавантажитись за 5 секунд",
                )
            )
+
            scheduler.shutdown()
+
            await self.client.close()
            await waifu_pics._client_session.close()
+
            sys.exit()

        logging.warning(
@@ -199,27 +213,28 @@ class Admin(commands.Cog):
            embed=Embed(
                title="Відмовлено в доступі",
                description="Здається, це команда лише для модераторів",
-                color=Color.fail,
+                color=Color.FAIL,
            )
        )

-        mod_role = ds_utils.get(
+        mod_role: Union[Role, None] = ds_utils.get(
            ctx.user.guild.roles, id=await config_get("moderators", "roles")
        )
-        admin_chan = ds_utils.get(
+        admin_chan: Union[TextChannel, None] = ds_utils.get(
            ctx.user.guild.channels,
            id=await config_get("adminchat", "channels", "text"),
        )

-        await admin_chan.send(
-            content=f"{mod_role.mention}",
-            embed=Embed(
-                title="Неавторизований запит",
-                description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
-                color=Color.fail,
-            ),
-        )
+        if admin_chan is not None:
+            await admin_chan.send(
+                content="" if mod_role is None else mod_role.mention,
+                embed=Embed(
+                    title="Неавторизований запит",
+                    description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
+                    color=Color.FAIL,
+                ),
+            )


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(Admin(client))
--- a/cogs/analytics.py
+++ b/cogs/analytics.py
@@ -1,4 +1,5 @@
 import logging
+from typing import Dict, List, Any

 from discord import Cog, Message
 from discord.ext import commands
@@ -11,16 +12,17 @@ logger = logging.getLogger(__name__)

 class Analytics(commands.Cog):
    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

    @Cog.listener()
-    async def on_message(self, message: Message):
+    async def on_message(self, message: Message) -> None:
        if (
            (message.author != self.client.user)
            and (message.author.bot is False)
            and (message.author.system is False)
        ):
-            stickers = []
+            stickers: List[Dict[str, Any]] = []
+
            for sticker in message.stickers:
                stickers.append(
                    {
@@ -31,7 +33,8 @@ class Analytics(commands.Cog):
                    }
                )

-            attachments = []
+            attachments: List[Dict[str, Any]] = []
+
            for attachment in message.attachments:
                attachments.append(
                    {
@@ -57,5 +60,5 @@ class Analytics(commands.Cog):
            )


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(Analytics(client))
--- a/cogs/custom_channels.py
+++ b/cogs/custom_channels.py
@@ -1,4 +1,6 @@
-from discord import ApplicationContext, Embed, option
+from typing import Any, Dict, List, Union
+
+from discord import ApplicationContext, Embed, option, TextChannel
 from discord import utils as ds_utils
 from discord.abc import GuildChannel
 from discord.commands import SlashCommandGroup
@@ -8,24 +10,26 @@ from libbot.pycord.classes import PycordBot
 from libbot.sync import config_get as sync_config_get

 from classes.holo_user import HoloUser
-from enums.colors import Color
+from enums import Color
 from modules.database import col_users
 from modules.utils_sync import guild_name


 class CustomChannels(commands.Cog):
    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

    @commands.Cog.listener()
-    async def on_guild_channel_delete(self, channel: GuildChannel):
+    async def on_guild_channel_delete(self, channel: GuildChannel) -> None:
        await col_users.find_one_and_update(
            {"customchannel": channel.id}, {"$set": {"customchannel": None}}
        )

-    customchannel = SlashCommandGroup("customchannel", "Керування особистим каналом")
+    custom_channel_group: SlashCommandGroup = SlashCommandGroup(
+        "customchannel", "Керування особистим каналом"
+    )

-    @customchannel.command(
+    @custom_channel_group.command(
        name="get",
        description="Отримати персональний текстовий канал",
        guild_ids=[sync_config_get("guild")],
@@ -35,8 +39,8 @@ class CustomChannels(commands.Cog):
    @option("threads", description="Дозволити гілки")
    async def customchannel_get_cmd(
        self, ctx: ApplicationContext, name: str, reactions: bool, threads: bool
-    ):
-        holo_user_ctx = HoloUser(ctx.user)
+    ) -> None:
+        holo_user_ctx: HoloUser = HoloUser(ctx.user)

        # Return if the user already has a custom channel
        if holo_user_ctx.customchannel is not None:
@@ -45,14 +49,14 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Помилка виконання",
                    description="У вас вже є особистий канал.\nДля редагування каналу є `/customchannel edit` або просто відкрийте меню керування вашим каналом.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )
            return

        await ctx.defer()

-        created_channel = await ctx.user.guild.create_text_channel(
+        created_channel: TextChannel = await ctx.user.guild.create_text_channel(
            name=name,
            reason=f"Користувач {guild_name(ctx.user)} отримав власний приватний канал",
            category=ds_utils.get(
@@ -83,11 +87,11 @@ class CustomChannels(commands.Cog):
            embed=Embed(
                title="Створено канал",
                description=f"Вітаємо! Ви створили канал {created_channel.mention}. Для керування ним користуйтесь меню налаштувань каналу а також командою `/customchannel edit`",
-                color=Color.success,
+                color=Color.SUCCESS,
            )
        )

-        bots = await config_get("bots")
+        bots: List[Dict[str, Any]] = await config_get("bots")

        for bot in bots:
            await created_channel.set_permissions(
@@ -95,7 +99,7 @@ class CustomChannels(commands.Cog):
                view_channel=False,
            )

-    @customchannel.command(
+    @custom_channel_group.command(
        name="edit",
        description="Змінити параметри особистого каналу",
        guild_ids=[sync_config_get("guild")],
@@ -105,10 +109,10 @@ class CustomChannels(commands.Cog):
    @option("threads", description="Дозволити гілки")
    async def customchannel_edit_cmd(
        self, ctx: ApplicationContext, name: str, reactions: bool, threads: bool
-    ):
-        holo_user_ctx = HoloUser(ctx.user)
+    ) -> None:
+        holo_user_ctx: HoloUser = HoloUser(ctx.user)

-        custom_channel = ds_utils.get(
+        custom_channel: Union[TextChannel, None] = ds_utils.get(
            ctx.guild.channels, id=holo_user_ctx.customchannel
        )

@@ -118,7 +122,7 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Канал не знайдено",
                    description="Канал, вказаний як ваш, не існує. Можливо, його було вручну видалено раніше.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )
            return
@@ -136,11 +140,11 @@ class CustomChannels(commands.Cog):
            embed=Embed(
                title="Канал змінено",
                description=f"Назва каналу тепер `{name}`, реакції `{reactions}` та дозволено треди `{threads}`",
-                color=Color.fail,
+                color=Color.FAIL,
            )
        )

-    @customchannel.command(
+    @custom_channel_group.command(
        name="remove",
        description="Відібрати канал, знищуючи його, та частково повернути кошти",
        guild_ids=[sync_config_get("guild")],
@@ -148,8 +152,8 @@ class CustomChannels(commands.Cog):
    @option("confirm", description="Підтвердження операції")
    async def customchannel_remove_cmd(
        self, ctx: ApplicationContext, confirm: bool = False
-    ):
-        holo_user_ctx = HoloUser(ctx.user)
+    ) -> None:
+        holo_user_ctx: HoloUser = HoloUser(ctx.user)

        # Return if the user does not have a custom channel
        if holo_user_ctx.customchannel is None:
@@ -158,14 +162,14 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Помилка виконання",
                    description="У вас немає особистого каналу.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )
            return

        await ctx.defer()

-        custom_channel = ds_utils.get(
+        custom_channel: Union[TextChannel, None] = ds_utils.get(
            ctx.guild.channels, id=holo_user_ctx.customchannel
        )

@@ -175,7 +179,7 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Канал не знайдено",
                    description="Канал, вказаний як ваш, не існує. Можливо, його було вручну видалено раніше.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )
            await holo_user_ctx.set("customchannel", None)
@@ -187,7 +191,7 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Підтвердження не надано",
                    description="Для підтвердження операції додайте до команди параметр `confirm` зі значенням `True`.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )
            return
@@ -201,10 +205,10 @@ class CustomChannels(commands.Cog):
                embed=Embed(
                    title="Канал знищено",
                    description="Ви відмовились від каналу та видалили його.",
-                    color=Color.default,
+                    color=Color.DEFAULT,
                )
            )


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(CustomChannels(client))
--- a/cogs/data.py
+++ b/cogs/data.py
@@ -1,9 +1,10 @@
 import logging
 from os import makedirs
 from pathlib import Path
+from typing import Union, List, Dict, Any
 from uuid import uuid4

-from discord import ApplicationContext, Embed, File, option
+from discord import ApplicationContext, Embed, File, option, Role, TextChannel
 from discord import utils as ds_utils
 from discord.commands import SlashCommandGroup
 from discord.ext import commands
@@ -13,7 +14,7 @@ from libbot.sync import config_get as sync_config_get
 from libbot.sync import json_write as sync_json_write

 from classes.holo_user import HoloUser
-from enums.colors import Color
+from enums import Color
 from modules.database import col_users
 from modules.utils_sync import guild_name

@@ -22,9 +23,9 @@ logger = logging.getLogger(__name__)

 class Data(commands.Cog):
    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

-    data = SlashCommandGroup("data", "Керування даними користувачів")
+    data: SlashCommandGroup = SlashCommandGroup("data", "Керування даними користувачів")

    @data.command(
        name="export",
@@ -34,9 +35,8 @@ class Data(commands.Cog):
    @option(
        "kind", description="Тип даних, які треба експортувати", choices=["Користувачі"]
    )
-    async def data_export_cmd(self, ctx: ApplicationContext, kind: str):
+    async def data_export_cmd(self, ctx: ApplicationContext, kind: str) -> None:
        await ctx.defer()
-        holo_user = HoloUser(ctx.author)

        # Return if the user is not an owner and not in the council
        if (ctx.user.id not in self.client.owner_ids) and not (
@@ -51,24 +51,24 @@ class Data(commands.Cog):
                embed=Embed(
                    title="Відмовлено в доступі",
                    description="Здається, це команда лише для модераторів",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )

-            mod_role = ds_utils.get(
+            mod_role: Union[Role, None] = ds_utils.get(
                ctx.user.guild.roles, id=await config_get("moderators", "roles")
            )
-            admin_chan = ds_utils.get(
+            admin_chan: Union[TextChannel, None] = ds_utils.get(
                ctx.user.guild.channels,
                id=await config_get("adminchat", "channels", "text"),
            )

            await admin_chan.send(
-                content=f"{mod_role.mention}",
+                content="" if mod_role is None else mod_role.mention,
                embed=Embed(
                    title="Неавторизований запит",
                    description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
-                    color=Color.fail,
+                    color=Color.FAIL,
                ),
            )

@@ -78,10 +78,10 @@ class Data(commands.Cog):

        makedirs("tmp", exist_ok=True)

-        uuid = str(uuid4())
+        uuid: str = str(uuid4())

        if kind == "Користувачі":
-            users = []
+            users: List[Dict[str, Any]] = []

            for member in ctx.guild.members:
                users.append(
@@ -105,7 +105,7 @@ class Data(commands.Cog):
    @option(
        "kind", description="Тип даних, які треба експортувати", choices=["Користувачі"]
    )
-    async def data_migrate_cmd(self, ctx: ApplicationContext, kind: str):
+    async def data_migrate_cmd(self, ctx: ApplicationContext, kind: str) -> None:
        await ctx.defer()

        # Return if the user is not an owner and not in the council
@@ -121,26 +121,27 @@ class Data(commands.Cog):
                embed=Embed(
                    title="Відмовлено в доступі",
                    description="Здається, це команда лише для модераторів",
-                    color=Color.fail,
+                    color=Color.FAIL,
                )
            )

-            mod_role = ds_utils.get(
+            mod_role: Union[Role, None] = ds_utils.get(
                ctx.user.guild.roles, id=await config_get("moderators", "roles")
            )
-            admin_chan = ds_utils.get(
+            admin_chan: Union[TextChannel, None] = ds_utils.get(
                ctx.user.guild.channels,
                id=await config_get("adminchat", "channels", "text"),
            )

-            await admin_chan.send(
-                content=f"{mod_role.mention}",
-                embed=Embed(
-                    title="Неавторизований запит",
-                    description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
-                    color=Color.fail,
-                ),
-            )
+            if admin_chan is not None:
+                await admin_chan.send(
+                    content="" if mod_role is None else mod_role.mention,
+                    embed=Embed(
+                        title="Неавторизований запит",
+                        description=f"Користувач {ctx.user.mention} запитав у каналі {ctx.channel.mention} команду, до якої не повинен мати доступу/бачити.",
+                        color=Color.FAIL,
+                    ),
+                )

            return

@@ -155,8 +156,8 @@ class Data(commands.Cog):
                    continue

                if (await col_users.find_one({"user": member.id})) is None:
-                    user = {}
-                    defaults = await config_get("user", "defaults")
+                    user: Dict[str, Any] = {}
+                    defaults: Dict[str, Any] = await config_get("user", "defaults")

                    user["user"] = member.id

@@ -173,10 +174,10 @@ class Data(commands.Cog):
            embed=Embed(
                title="Міграцію завершено",
                description="Всім користувачам сервера було створено записи в базі даних.",
-                color=Color.success,
+                color=Color.SUCCESS,
            )
        )


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(Data(client))
--- a/cogs/fun.py
+++ b/cogs/fun.py
@@ -14,7 +14,7 @@ logger = logging.getLogger(__name__)

 class Fun(commands.Cog):
    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

    @slash_command(
        name="action",
@@ -27,13 +27,13 @@ class Fun(commands.Cog):
        choices=sync_config_get("actions").keys(),
    )
    @option("user", description="Користувач")
-    async def action_cmd(self, ctx: ApplicationContext, type: str, user: User):
+    async def action_cmd(self, ctx: ApplicationContext, type: str, user: User) -> None:
        await ctx.defer()

-        action = await config_get("category", "actions", type)
-        action_verb = await config_get("action", "actions", type)
+        action: str = await config_get("category", "actions", type)
+        action_verb: str = await config_get("action", "actions", type)

-        image = await waifu_pics.sfw(action)
+        image_url: str = await waifu_pics.sfw(action)

        logger.info(
            "User %s (%s) %s %s (%s) with image %s",
@@ -42,17 +42,17 @@ class Fun(commands.Cog):
            action_verb,
            guild_name(user),
            user.id,
-            image,
+            image_url,
        )

-        embed = Embed(
+        embed: Embed = Embed(
            description=f"**{guild_name(ctx.user)}** {action_verb} **{guild_name(user)}**",
            color=0x2F3136,
        )
-        embed.set_image(url=image)
+        embed.set_image(url=image_url)

        await ctx.respond(embed=embed)


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(Fun(client))
--- a/cogs/logger.py
+++ b/cogs/logger.py
@@ -1,4 +1,6 @@
-from discord import Member, Message
+from typing import Dict, Any, Union
+
+from discord import Member, Message, TextChannel
 from discord import utils as ds_utils
 from discord.ext import commands
 from libbot import config_get
@@ -9,7 +11,7 @@ from modules.database import col_users

 class Logger(commands.Cog):
    def __init__(self, client: PycordBot):
-        self.client = client
+        self.client: PycordBot = client

    @commands.Cog.listener()
    async def on_message(self, message: Message):
@@ -19,8 +21,8 @@ class Logger(commands.Cog):
            and (message.author.system is False)
        ):
            if (await col_users.find_one({"user": message.author.id})) is None:
-                user = {}
-                defaults = await config_get("user", "defaults")
+                user: Dict[str, Any] = {}
+                defaults: Dict[str, Any] = await config_get("user", "defaults")

                user["user"] = message.author.id

@@ -30,12 +32,12 @@ class Logger(commands.Cog):
                await col_users.insert_one(document=user)

    @commands.Cog.listener()
-    async def on_member_join(self, member: Member):
-        welcome_chan = ds_utils.get(
+    async def on_member_join(self, member: Member) -> None:
+        welcome_chan: Union[TextChannel, None] = ds_utils.get(
            self.client.get_guild(await config_get("guild")).channels,
            id=await config_get("welcome", "channels", "text"),
        )
-        rules_chan = ds_utils.get(
+        rules_chan: Union[TextChannel, None] = ds_utils.get(
            self.client.get_guild(await config_get("guild")).channels,
            id=await config_get("rules", "channels", "text"),
        )
@@ -52,8 +54,8 @@ class Logger(commands.Cog):
            )

            if (await col_users.find_one({"user": member.id})) is None:
-                user = {}
-                defaults = await config_get("user", "defaults")
+                user: Dict[str, Any] = {}
+                defaults: Dict[str, Any] = await config_get("user", "defaults")

                user["user"] = member.id

@@ -63,5 +65,5 @@ class Logger(commands.Cog):
                await col_users.insert_one(document=user)


-def setup(client: PycordBot):
+def setup(client: PycordBot) -> None:
    client.add_cog(Logger(client))