delete_all.py

"""Contains cog classes for any delete_all interactions."""

from typing import TYPE_CHECKING

import discord

from db.core.models import (
    AssignedCommitteeAction,
    DiscordMemberStrikes,
    DiscordReminder,
    GroupMadeMember,
    SentGetRolesReminderMember,
    SentOneOffIntroductionReminderMember,
)
from utils import CommandChecks, TeXBotBaseCog

if TYPE_CHECKING:
    from collections.abc import Sequence

    from db.core.models.utils import AsyncBaseModel
    from utils import TeXBotApplicationContext

__all__: "Sequence[str]" = ("DeleteAllCommandsCog",)


class DeleteAllCommandsCog(TeXBotBaseCog):
    """Cog class that defines the "/delete-all" command group and command call-back methods."""

    delete_all: discord.SlashCommandGroup = discord.SlashCommandGroup(
        name="delete-all",
        description=(
            "Delete all instances of the selected object type from the backend database"
        ),
    )

    @staticmethod
    async def _delete_all(
        ctx: "TeXBotApplicationContext", delete_model: type["AsyncBaseModel"]
    ) -> None:
        """Perform the actual deletion process of all instances of the given model class."""
        await delete_model._default_manager.all().adelete()

        delete_model_instances_name_plural: str = (
            delete_model.INSTANCES_NAME_PLURAL
            if hasattr(delete_model, "INSTANCES_NAME_PLURAL")
            else "objects"
        )

        await ctx.respond(
            f"All {delete_model_instances_name_plural} deleted successfully.", ephemeral=True
        )

    @delete_all.command(
        name="reminders", description="Deletes all Reminders from the backend database."
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_reminders(self, ctx: "TeXBotApplicationContext") -> None:
        """
        Definition & callback response of the "delete_all_reminders" command.

        The "delete_all_reminders" command uses the _delete_all() function
        to delete all `DiscordReminder` instance objects stored in the database.
        """
        await self._delete_all(ctx, delete_model=DiscordReminder)

    @delete_all.command(
        name="group-made-members",
        description="Deletes all Group Made Members from the backend database.",
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_group_made_members(self, ctx: "TeXBotApplicationContext") -> None:
        """
        Definition & callback response of the "delete_all_group_made_members" command.

        The "delete_all_group_made_members" command uses the _delete_all() function
        to delete all `GroupMadeMember` instance objects stored in the database.
        """
        await self._delete_all(ctx, delete_model=GroupMadeMember)

    @delete_all.command(
        name="actions", description="Deletes all the Actions from the backend database."
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_actions(self, ctx: "TeXBotApplicationContext") -> None:
        """
        Definition & callback respoonse of the "delete-all-actions" command.

        The "delete-all-actions" command uses the _delete_all() function
        to delete all `Action` instance objects stored in the database.
        """
        await self._delete_all(ctx, delete_model=AssignedCommitteeAction)

    @delete_all.command(
        name="strikes", description="Deletes all the Strikes from the backend database."
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_strikes(self, ctx: "TeXBotApplicationContext") -> None:
        """
        Definition & callback response of the "delete-all-strikes" command.

        The "delete-all-strikes" command uses the _delete_all() function
        to delete all `Strike` instance objects stored in the database.
        """
        await self._delete_all(ctx, delete_model=DiscordMemberStrikes)

    @delete_all.command(
        name="sent-get-roles-reminders",
        description="Deletes all SentGetRolesReminderMember objects from the backend database.",  # noqa: E501
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_sent_get_role_reminders(
        self, ctx: "TeXBotApplicationContext"
    ) -> None:
        """
        Definition & callback response of the "delete_all_sent_get_role_reminders" command.

        The "delete_all_sent_get_role_reminders" command uses the _delete_all() function
        to delete all `SentGetRolesReminderMember` instance objects in the database.
        """
        await self._delete_all(ctx, delete_model=SentGetRolesReminderMember)

    @delete_all.command(
        name="sent-introduction-reminders",
        description="Deletes all SentOneOffIntroductionReminderMember objects from the backend database.",  # noqa: E501
    )
    @CommandChecks.check_interaction_user_has_committee_role
    @CommandChecks.check_interaction_user_in_main_guild
    async def delete_all_sent_one_off_introduction_reminders(
        self, ctx: "TeXBotApplicationContext"
    ) -> None:
        """
        Definition & callback response of the "delete_all_sent_one_off_introduction_reminders" command.

        The "delete_all_sent_one_off_introduction_reminders" command uses the _delete_all()
        function to delete all `SentOneOffIntroductionReminderMember`
        instance objects in the database.
        """  # noqa: E501, W505
        await self._delete_all(ctx, delete_model=SentOneOffIntroductionReminderMember)