Merge branch '78-config-for-skipping-election-cycle'

DakinySettings.py

@@ -23,6 +23,7 @@ class ChannelIds:
 class Election:
     """Class defines relevant election dates."""
 
+    active: bool
     election_start: str
     highcouncil_election_announce: str
     highcouncil_election_end: str
@@ -40,6 +41,7 @@ class EventSettings:
 
     host_points: int
     participate_points: int
+    verify: bool
     weekly_limit: int
 
 
@@ -79,4 +81,3 @@ class DakinySettings(YAMLWizard):
 
 
 settings = DakinySettings.from_yaml_file(CONFIG_LOCATION)
-settings.save()

classes/election.py

@@ -49,6 +49,7 @@ class Election:
         """
         self.cycle = cycle
         self.election_cycle = settings.election_cycles[self.cycle]
+        self.active = self.election_cycle.active
         self.election_start: datetime = get_datetime(self.election_cycle.election_start)
         self.term_start: datetime = get_datetime(self.election_cycle.term_start)
         self.term_end: datetime = get_datetime(self.election_cycle.term_end)

cogs/commands/record.py

@@ -180,31 +180,74 @@ class EventView(nextcord.ui.View):
         Removes view and embed from recording message.
         Sends point information to database.
         """
-        discord_users = self.event_participants.values.members  # noqa: PD011 not a pandas object
-        if discord_users:
-            discord_users_list: list[str] = [str(user.id) for user in discord_users if user.id is not self.host_id]
-            record_event_points(
-                discord_users_list,
-                settings.event_settings.participate_points,
-                is_member=True,
+        if settings.event_settings.verify:
+            verification_channel: nextcord.TextChannel = interaction.guild.get_channel(settings.channel_ids.admin)
+            verification_view = EventVerification(
+                self.event_participants.values.members, interaction.message.embeds[0].fields[1].value, self.host_id
+            )
+            await verification_channel.send(
+                content="Event record request.", embed=interaction.message.embeds[0], view=verification_view
+            )
+            submission_response = "Event has been submitted to admins for approval."
+        else:
+            process_event(
+                self.event_participants.values.members,
+                interaction.message.embeds[0].fields[1].value,
+                self.host_id,
             )
 
-        non_discord_users = interaction.message.embeds[0].fields[1].value
-        if non_discord_users:
-            non_discord_users_list: list[str] = non_discord_users.split("\n")
-            record_event_points(
-                non_discord_users_list,
-                settings.event_settings.participate_points,
-                is_member=False,
-            )
+            event_channel: nextcord.TextChannel = interaction.guild.get_channel(settings.channel_ids.event_post)
+            await event_channel.send(embed=interaction.message.embeds[0])
+            submission_response = "Event has been submitted."
 
-        record_event_points([self.host_id], settings.event_settings.host_points, is_member=True)
+        await interaction.response.edit_message(content=submission_response, view=None, embed=None)
+        self.stop()
 
+
+class EventVerification(nextcord.ui.View):
+    """Class contains code to approve/deny event submissions."""
+
+    def __init__(
+        self,
+        discord_users: list[nextcord.Member],
+        non_discord_users: str,
+        host_id: int,
+    ):
+        super().__init__(timeout=None, auto_defer=True)
+        self.discord_users: list[nextcord.Member] = discord_users
+        self.non_discord_users: str = non_discord_users
+        self.host_id: int = host_id
+
+    @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green)
+    async def approve(self, button: nextcord.ui.Button, interaction: nextcord.Interaction) -> None:  # noqa: ARG002
+        """
+        Approve button for an event submission.
+
+        Calls the process event function. Records who approved the event.
+        Removes the view from the interaction message.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+        process_event(self.discord_users, self.non_discord_users, self.host_id)
         event_channel: nextcord.TextChannel = interaction.guild.get_channel(settings.channel_ids.event_post)
         await event_channel.send(embed=interaction.message.embeds[0])
-        await interaction.response.edit_message(content="Event has been submitted.", view=None, embed=None)
 
-        self.stop()
+        content = f"\nApproved by <@{interaction.user.id}>."
+        await interaction.response.edit_message(content=content, view=None)
+
+    @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red)
+    async def deny(self, button: nextcord.ui.Button, interaction: nextcord.Interaction) -> None:  # noqa: ARG002
+        """
+        Deny button for an event submission. Just removes the view and logs who denied the request.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+        content = f"\nDenied by <@{interaction.user.id}>."
+        await interaction.response.edit_message(content=content, view=None)
 
 
 class ParticipantModal(nextcord.ui.Modal):
@@ -281,3 +324,31 @@ class ParticipantSelect(nextcord.ui.UserSelect):
         participants: str = "\n".join([f"<@{participant.id}>" for participant in self.values.members])
         embed.set_field_at(0, name="Participants", value=participants)
         await interaction.response.edit_message(embed=embed)
+
+
+def process_event(discord_users: list[nextcord.Member], non_discord_users: str, host_id: int) -> None:
+    """
+    Processes all points to give to participants and host for an event.
+
+    Args:
+        discord_users (list[nextcord.Member]): List of discord members that participated in event.
+        non_discord_users (str): Newline separated list of non discord members that participated in event.
+        host_id (int): Discord ID of host.
+    """
+    if discord_users:
+        discord_users_list: list[str] = [str(user.id) for user in discord_users if user.id is not host_id]
+        record_event_points(
+            discord_users_list,
+            settings.event_settings.participate_points,
+            is_member=True,
+        )
+
+    if non_discord_users:
+        non_discord_users_list: list[str] = non_discord_users.split("\n")
+        record_event_points(
+            non_discord_users_list,
+            settings.event_settings.participate_points,
+            is_member=False,
+        )
+
+    record_event_points([host_id], settings.event_settings.host_points, is_member=True)

cogs/commands/request.py

@@ -109,7 +109,7 @@ class UsernameRequest(nextcord.ui.View):
                 await interaction.followup.edit_message(interaction.message.id, content=content, view=None)
         else:
             await interaction.response.edit_message(
-                content="An error occured while changing the user's nickname.",
+                content="An error occurred while changing the user's nickname.",
                 view=None,
             )
 

cogs/commands/settings.py

@@ -160,7 +160,7 @@ class SettingsCog(commands.Cog, name="Settings Commands"):
 
         Args:
             interaction (nextcord.Interaction): Discord interaction of command.
-            points (nextcord.TextChannel): Number of points to set.
+            points (int): Number of points to set.
         """
         settings.event_settings.host_points = points
         settings.save()
@@ -181,12 +181,32 @@ class SettingsCog(commands.Cog, name="Settings Commands"):
 
         Args:
             interaction (nextcord.Interaction): Discord interaction of command.
-            points (nextcord.TextChannel): Number of points to set.
+            points (int): Number of points to set.
         """
         settings.event_settings.participate_points = points
         settings.save()
         await interaction.response.send_message(f"Event Participation Points set to {points}.", ephemeral=True)
 
+    @event_settings.subcommand(description="Sets Event Participation Points value.")
+    async def verify(
+        self,
+        interaction: nextcord.Interaction,
+        do_verification: bool = nextcord.SlashOption(  # noqa: FBT001
+            required=True,
+            description="Whether an event should be verified or not.",
+        ),
+    ) -> None:
+        """
+        Sets DakinySettings event_settings.verify to the given number of points.
+
+        Args:
+            interaction (nextcord.Interaction): Discord interaction of command.
+            do_verification (bool): If the bot should verify events.
+        """
+        settings.event_settings.verify = do_verification
+        settings.save()
+        await interaction.response.send_message(f"Event verification set to {do_verification}.", ephemeral=True)
+
     @event_settings.subcommand(description="Sets Event Weekly Limit value.")
     async def weekly_limit(
         self,
@@ -200,7 +220,7 @@ class SettingsCog(commands.Cog, name="Settings Commands"):
 
         Args:
             interaction (nextcord.Interaction): Discord interaction of command.
-            points (nextcord.TextChannel): Number of points to set.
+            points (int): Number of points to set.
         """
         settings.event_settings.weekly_limit = points
         settings.save()

cogs/commands/test.py

@@ -5,7 +5,7 @@ from nextcord.ext import application_checks, commands
 
 from classes.election import Election
 from DakinySettings import settings
-from utils import GUILDS, get_current_election_cycle
+from utils import GUILDS, get_active_election_cycle
 
 ME = 206602713511886849
 
@@ -40,7 +40,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.election_start_action()
@@ -56,7 +56,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.voting_start_action()
@@ -72,7 +72,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.voting_end_action()
@@ -88,7 +88,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.highcouncil_election_start_action()
@@ -104,7 +104,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.election_reminder()
@@ -120,7 +120,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.check_date()
@@ -136,7 +136,7 @@ class TestCog(commands.Cog, name="Test commands."):
             interaction (nextcord.Interaction): Interaction with the message.
         """
         cycle = Election(
-            get_current_election_cycle(),
+            get_active_election_cycle(),
             self.bot.get_guild(settings.params.guild_id),
         )
         await cycle.term_start_action()

cogs/loops/daily_loop.py

@@ -13,7 +13,7 @@ from classes.election import Election
 from DakinySettings import settings
 from database_setup.sql_data_classes import UserBirthday, engine
 from main import birthday_list
-from utils import get_current_election_cycle
+from utils import get_active_election_cycle
 
 if TYPE_CHECKING:
     import nextcord
@@ -75,13 +75,15 @@ class DailyLoop(commands.Cog, name="Daily Loop"):
         Returns:
             Election: Current election cycle, None if there is no election happening.
         """
-        cycle = get_current_election_cycle()
+        cycle = get_active_election_cycle()
 
         # prevent exception from using cycle as an Int in an array
         if cycle is None:
             return None
 
-        return Election(cycle, self.bot.get_guild(settings.params.guild_id))
+        election = Election(cycle, self.bot.get_guild(settings.params.guild_id))
+
+        return election if election.active else None
 
     def update_birthdays(self) -> None:
         """Goes through database to collect all birthdays that are today. Adds user's id to birthday list."""

pyproject.toml

@@ -85,6 +85,7 @@ ignore = [
     "E117",
     "ISC001",
     "ISC002",
+    "PD011",  # doesn't like me using '.values' on embeds....
     "Q000",
     "Q001",
     "Q002",

utils.py

@@ -64,7 +64,7 @@ def get_election_name() -> str:
     Returns:
         str: the name of the election cycle
     """
-    cycle = get_current_election_cycle()
+    cycle = get_active_election_cycle()
     current_cycle = settings.election_cycles[cycle]
     return f"vote-{get_datetime(current_cycle.term_start).year}-{current_cycle.name}"
 
@@ -82,7 +82,7 @@ def get_quarter_name() -> str:
     return f"{get_datetime(current_cycle.term_start).year}-{current_cycle.name}"
 
 
-def get_current_election_cycle() -> int:
+def get_active_election_cycle() -> int:
     """
     Returns index for active election. An election is considered active between the election start and the term start.
 
@@ -104,7 +104,9 @@ def get_current_election_cycle() -> int:
 
 def get_quarter_cycle() -> int:
     """
-    Returns the index for the current cycle/quarter. Defined as between term start and end. Shouldn't return none.
+    Returns the index for the current cycle/quarter. Defined as between term start and end.
+
+    Can return None if entire year isn't covered by cycles.
 
     Returns:
         int: cycle index for current cycle.