Sort nominees in voting views by display name.

Remove guild ids.

classes/election_cycle.py

@@ -239,7 +239,8 @@ class ElectionCycle:
         )
         await election_thread.send(message)
         vote_msg = await election_thread.send(
-            build_votes_str(self.config), view=VoteView(self.config, self.guild)
+            build_votes_str(self.config, self.guild),
+            view=VoteView(self.config, self.guild),
         )
 
         with Session(engine) as session:
@@ -324,7 +325,7 @@ class ElectionCycle:
         )
         await election_thread.send(message)
         vote_msg = await election_thread.send(
-            build_highcouncil_votes_str(self.config),
+            build_highcouncil_votes_str(self.config, self.guild),
             view=VoteHighcouncilView(self.config, self.guild),
         )
 

classes/voting_highcouncil_views.py

@@ -82,7 +82,7 @@ class VoteSelect(nextcord.ui.StringSelect):
                 session.execute(stmt)
                 session.commit()
 
-        vote_message_str = build_highcouncil_votes_str(self.config)
+        vote_message_str = build_highcouncil_votes_str(self.config, interaction.guild)
         vote_msg: nextcord.Message = await interaction.channel.fetch_message(
             vote_msg_id
         )
@@ -159,7 +159,10 @@ class VoteHighcouncilView(nextcord.ui.View):
                     else f"{self.guild.get_member(nominee).display_name}",
                     value=str(nominee),
                 )
-                for nominee in session.scalars(stmt)
+                for nominee in sorted(
+                    session.scalars(stmt),
+                    key=lambda nominee: self.guild.get_member(nominee).display_name,
+                )
             ]
             options.append(
                 SelectOption(
@@ -232,7 +235,10 @@ class VoteHighcouncilView(nextcord.ui.View):
                     else f"{self.guild.get_member(nominee).display_name}",
                     value=str(nominee),
                 )
-                for nominee in session.scalars(stmt)
+                for nominee in sorted(
+                    session.scalars(stmt),
+                    key=lambda nominee: self.guild.get_member(nominee).display_name,
+                )
             ]
             options.append(
                 SelectOption(

classes/voting_views.py

@@ -64,7 +64,7 @@ class VoteSelect(nextcord.ui.StringSelect):
                 session.execute(stmt)
                 session.commit()
 
-        vote_message_str = build_votes_str(self.config)
+        vote_message_str = build_votes_str(self.config, interaction.guild)
         vote_msg: nextcord.Message = await interaction.channel.fetch_message(
             vote_msg_id
         )
@@ -135,7 +135,10 @@ class VoteView(nextcord.ui.View):
                     else f"{self.guild.get_member(nominee).display_name}",
                     value=str(nominee),
                 )
-                for nominee in session.scalars(stmt)
+                for nominee in sorted(
+                    session.scalars(stmt),
+                    key=lambda nominee: self.guild.get_member(nominee).display_name,
+                )
             ]
             options.append(
                 SelectOption(

cogs/commands/__init__.py

@@ -4,6 +4,7 @@ Cog loader. Adds all command cogs to the bot.
 
 from nextcord.ext import commands
 
+from cogs.commands.remove import RemoveCog
 from cogs.commands.request import RequestCog
 from cogs.commands.set import setCog
 from cogs.commands.test import TestCog
@@ -17,7 +18,8 @@ def setup(bot: commands.Bot):
     Adds all command classes to bot.
     """
 
+    bot.add_cog(RemoveCog())
     bot.add_cog(RequestCog(bot))
     bot.add_cog(TestCog(bot))
-    bot.add_cog(setCog())
     bot.add_cog(ViewCog())
+    bot.add_cog(setCog())

cogs/commands/remove.py

@@ -0,0 +1,86 @@
+"""
+Commands for removing information in the database.
+"""
+
+import nextcord
+from nextcord.ext import commands
+from sqlalchemy import delete, select
+from sqlalchemy.orm import Session
+
+from database_setup.sql_data_classes import Presences, engine
+
+
+class RemoveCog(commands.Cog, name="Remove Commands"):
+    """
+    Holds the view commands.
+    """
+
+    def __init__(self) -> None:
+        """
+        Default constructor for RemoveCog class. Does nothing.
+        """
+
+    @nextcord.slash_command(
+        default_member_permissions=nextcord.Permissions(administrator=True),
+    )
+    async def remove(self, interaction: nextcord.Interaction):
+        """
+        Parent slash command for set. Never called.
+        """
+
+    @remove.subcommand(description="Remove a presence from the database.")
+    async def presence(
+        self,
+        interaction: nextcord.Interaction,
+        presence_str: str = nextcord.SlashOption(
+            description="The presence to remove", required=True
+        ),
+    ):
+        """
+        Deletes the given presence id from the database.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            presence (str): Is SlashOption. The presence to remove. Is the ID of the presence.
+        """
+
+        presence_id = int(presence_str)
+        with Session(engine) as session:
+            stmt = delete(Presences).where(Presences.Id == presence_id)
+            session.execute(stmt)
+            session.commit()
+
+        await interaction.response.send_message("Presence deleted.", ephemeral=True)
+
+    @presence.on_autocomplete("presence_str")
+    async def presence_autocomplete(
+        self, interaction: nextcord.Interaction, presence_str: str
+    ):
+        """
+        Collects all presences that start with the presence string.
+        Sends autocomplete dict {Presence Name, Presence Id}
+
+        Args:
+            interaction (nextcord.Interaction): Interaction with command.
+            presence_str (str): String to run autocomplete on.
+        """
+
+        with Session(engine) as session:
+            stmt = select(Presences)
+            presences_dict: "dict[str,str]" = {
+                pres.Presence: str(pres.Id) for pres in session.scalars(stmt)
+            }
+
+            # if empty compare string
+            if not presence_str:
+                await interaction.response.send_autocomplete(
+                    dict(list(presences_dict.items())[:25])
+                )
+                return
+
+            autofilled_presences: "dict[str,str]" = {
+                pres: pres_id
+                for pres, pres_id in presences_dict.items()
+                if presence_str.lower() in pres.lower()
+            }
+            await interaction.response.send_autocomplete(autofilled_presences[:25])

cogs/commands/request.py

@@ -4,8 +4,10 @@ Contains commands and views for request commands.
 
 import nextcord
 from nextcord.ext import commands
+from sqlalchemy.orm import Session
 
 from config import DakinyConfig
+from database_setup.sql_data_classes import Presences, engine
 
 
 class RequestCog(commands.Cog, name="Request Commands"):
@@ -25,12 +27,46 @@ class RequestCog(commands.Cog, name="Request Commands"):
         Parent slash command for help. Never called.
         """
 
+    @request.subcommand(
+        description="Request to add a presence to the bot's presence list."
+    )
+    async def add_presence(
+        self,
+        interaction: nextcord.Interaction,
+        presence: str = nextcord.SlashOption(
+            required=True,
+            min_length=1,
+            max_length=100,
+            description="The presence you want to add.",
+        ),
+    ):
+        """
+        Sends a message to admins to request to add a presence.
+
+        Args:
+            interaction (nextcord.Interaction): Interaction that invoked the command.
+            presence (str): The presence to add.
+        """
+
+        config: DakinyConfig = self.bot.config
+        content = f'<@{interaction.user.id}> would like to add presence "{presence}."'
+        view = PresenceChange(presence)
+        await self.bot.get_channel(config.params.admin_channel_id).send(
+            content=content, view=view
+        )
+        await interaction.response.send_message(
+            "Request sent to admins.", ephemeral=True
+        )
+
     @request.subcommand(description="Request to change your Dakiny nickname")
     async def change_nickname(
         self,
         interaction: nextcord.Interaction,
         new_nickname: str = nextcord.SlashOption(
-            required=True, min_length=2, max_length=32, description="Your requested new nickname."
+            required=True,
+            min_length=2,
+            max_length=32,
+            description="Your requested new nickname.",
         ),
     ):
         """
@@ -44,8 +80,12 @@ class RequestCog(commands.Cog, name="Request Commands"):
         config: DakinyConfig = self.bot.config
         content = f'<@{interaction.user.id}> would like to change their username to "{new_nickname}."'
         view = UsernameRequest(interaction.user.id, new_nickname)
-        await self.bot.get_channel(config.params.admin_channel_id).send(content=content, view=view)
-        await interaction.response.send_message("Request sent to admins.", ephemeral=True)
+        await self.bot.get_channel(config.params.admin_channel_id).send(
+            content=content, view=view
+        )
+        await interaction.response.send_message(
+            "Request sent to admins.", ephemeral=True
+        )
 
 
 class UsernameRequest(nextcord.ui.View):
@@ -53,13 +93,19 @@ class UsernameRequest(nextcord.ui.View):
     View provides approve and deny buttons and action for a username change request.
     """
 
-    def __init__(self, user_id: int, new_nickname: str, *, timeout: float | None = 180, auto_defer: bool = True):
-        super().__init__(timeout=timeout, auto_defer=auto_defer)
+    def __init__(
+        self,
+        user_id: int,
+        new_nickname: str,
+    ):
+        super().__init__(timeout=None, auto_defer=True)
         self.user_id = user_id
         self.new_nickname = new_nickname
 
     @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green)
-    async def approve(self, button: nextcord.ui.Button, interaction: nextcord.Interaction):
+    async def approve(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):
         """
         Approve button for a nickname change request. Changes the target's nickname to self.new_nickname.
         Catches an error if the target as a higher role than the bot.
@@ -73,7 +119,10 @@ class UsernameRequest(nextcord.ui.View):
         if user is not None:
             try:
                 await user.edit(nick=self.new_nickname)
-                content = interaction.message.content + f"\nApproved by <@{interaction.user.id}>."
+                content = (
+                    interaction.message.content
+                    + f"\nApproved by <@{interaction.user.id}>."
+                )
                 await interaction.response.edit_message(content=content, view=None)
             except nextcord.errors.Forbidden:
                 await interaction.response.send_message(
@@ -84,10 +133,13 @@ class UsernameRequest(nextcord.ui.View):
                     interaction.message.content
                     + "\n\nFailed. User has too high permissions for bot to change nickname."
                 )
-                await interaction.followup.edit_message(interaction.message.id, content=content, view=None)
+                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.", view=None
+                content="An error occured while changing the user's nickname.",
+                view=None,
             )
 
     @nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red)
@@ -101,3 +153,50 @@ class UsernameRequest(nextcord.ui.View):
         """
         content = interaction.message.content + f"\nDenied by <@{interaction.user.id}>."
         await interaction.response.edit_message(content=content, view=None)
+
+
+class PresenceChange(nextcord.ui.View):
+    """
+    View provides approve and deny buttons and action for a username change request.
+    """
+
+    def __init__(
+        self,
+        presence: str,
+    ):
+        super().__init__(timeout=None, auto_defer=True)
+        self.presence = presence
+
+    @nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green)
+    async def approve(
+        self, button: nextcord.ui.Button, interaction: nextcord.Interaction
+    ):
+        """
+        Approve button for a presence add request. Adds the presence to the database.
+        Removes the view from the interaction message.
+
+        Args:
+            button (nextcord.ui.Button): Unused.
+            interaction (nextcord.Interaction): The interaction of the user clicking the button.
+        """
+
+        with Session(engine) as session:
+            session.add(Presences(Presence=self.presence))
+            session.commit()
+
+        content = (
+            interaction.message.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):
+        """
+        Deny button for a presence add request. 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 = interaction.message.content + f"\nDenied by <@{interaction.user.id}>."
+        await interaction.response.edit_message(content=content, view=None)

cogs/commands/view.py

@@ -7,7 +7,12 @@ from nextcord.ext import commands
 from sqlalchemy import select
 from sqlalchemy.orm import Session
 
-from database_setup.sql_data_classes import ElectionInformation, Votes, engine
+from database_setup.sql_data_classes import (
+    ElectionInformation,
+    Presences,
+    Votes,
+    engine,
+)
 
 
 class ViewCog(commands.Cog, name="View Commands"):
@@ -26,6 +31,42 @@ class ViewCog(commands.Cog, name="View Commands"):
         Parent slash command for set. Never called.
         """
 
+    @view.subcommand(description="Show all possible presence choices.")
+    async def presences(
+        self,
+        interaction: nextcord.Interaction,
+        search: str = nextcord.SlashOption(
+            description="A word or string to search for in the presences.",
+            required=False,
+        ),
+    ):
+        """
+        Gathers all presences from the database and responds with a message showing them.
+
+        Args:
+            interaction (nextcord.Integration):  User's interaction with the command.
+        """
+
+        # might take a while depending on number of presences
+        await interaction.response.defer(ephemeral=True)
+
+        with Session(engine) as session:
+            stmt = select(Presences.Presence)
+            presences = session.scalars(stmt)
+
+            if search:
+                message = "\n".join(
+                    [
+                        presence
+                        for presence in presences
+                        if search.lower() in presence.lower()
+                    ]
+                )
+            else:
+                message = "\n".join(list(presences))
+
+        await interaction.followup.send(content=message, ephemeral=True)
+
     @view.subcommand(
         description="Shows all voters and who they voted for in a given election."
     )
@@ -85,7 +126,7 @@ class ViewCog(commands.Cog, name="View Commands"):
 
             # if empty compare string
             if not election_name:
-                await interaction.response.send_autocomplete(elections)
+                await interaction.response.send_autocomplete(list(elections)[:25])
                 return
 
             autofilled_elections: "list[str]" = [

cogs/loops/__init__.py

@@ -4,7 +4,8 @@ Initializing code for all loops.
 
 from nextcord.ext import commands
 
-from .daily_loop import DailyLoop
+from cogs.loops.bot_presence import BotPresence
+from cogs.loops.daily_loop import DailyLoop
 
 
 def setup(bot: commands.Bot):
@@ -12,4 +13,5 @@ def setup(bot: commands.Bot):
     Adds functions to bot.
     """
 
+    bot.add_cog(BotPresence(bot))
     bot.add_cog(DailyLoop(bot))

cogs/loops/bot_presence.py

@@ -0,0 +1,48 @@
+"""
+Functions for controlling the bot's presence. Also contains the loop.
+"""
+
+import nextcord
+from nextcord.ext import commands, tasks
+from sqlalchemy import func, select
+from sqlalchemy.orm import Session
+
+from database_setup.sql_data_classes import Presences, engine
+
+
+class BotPresence(commands.Cog, name="Bot Presence"):
+    """Class for bot presence functions."""
+
+    def __init__(self, bot: commands.Bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_guild_join(
+        self, guild: nextcord.Guild
+    ):  # pylint: disable=unused-argument
+        """Listener for Guild Join. Updated presence on guild join."""
+        await self.change_presence()
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        """Starts the loop when bot is ready."""
+        await self.bot.wait_until_ready()
+        # pylint doesn't recognize that periodic_change_presense is subclassed from tasks.loop.
+        self.periodic_change_presence.start()  # pylint: disable=no-member
+
+    @tasks.loop(minutes=5)
+    async def periodic_change_presence(self):
+        """Loops every 5 minutes and changes presence."""
+        await self.change_presence()
+
+    async def change_presence(self):
+        """Randomly chooses a presence and updates bot's presence."""
+
+        with Session(engine) as session:
+            presence = session.scalar(
+                select(Presences.Presence).order_by(func.random())
+            )
+
+        await self.bot.change_presence(
+            activity=nextcord.CustomActivity(name="Custom Status", state=presence)
+        )

cogs/loops/daily_loop.py

@@ -79,6 +79,10 @@ class DailyLoop(commands.Cog, name="Daily Loop"):
         config: DakinyConfig = self.bot.config
         cycle = get_current_cycle(config)
 
+        # prevent exception from using cycle as an Int in an array
+        if cycle is None:
+            return None
+
         return ElectionCycle(cycle, config, self.bot.get_guild(config.params.guild_id))
 
     def update_birthdays(self) -> None:
@@ -107,10 +111,14 @@ class DailyLoop(commands.Cog, name="Daily Loop"):
 
         today = datetime.today()
         guild: nextcord.Guild = self.bot.get_guild(self.bot.config.params.guild_id)
-        announce_channel: nextcord.TextChannel = guild.get_channel(self.bot.config.params.general_channel_id)
+        announce_channel: nextcord.TextChannel = guild.get_channel(
+            self.bot.config.params.general_channel_id
+        )
 
         cakedays: list[nextcord.Member] = [
-            human for human in guild.humans if human.joined_at.month == today.month and human.joined_at.day == today.day
+            human
+            for human in guild.humans
+            if human.joined_at.month == today.month and human.joined_at.day == today.day
         ]
 
         for member in cakedays:

database_setup/database.sql

@@ -34,3 +34,8 @@ CREATE TABLE UserBirthday (
     Birthday varchar(5) not null,
     PRIMARY KEY (UserId)
 );
+
+CREATE TABLE Presences (
+    Id integer PRIMARY KEY,
+    Presence varchar(100) not null
+);

database_setup/sql_data_classes.py

@@ -15,3 +15,4 @@ ElectionInformation = Base.classes.ElectionInformation
 CouncilMembers = Base.classes.CouncilMembers
 Votes = Base.classes.Votes
 UserBirthday = Base.classes.UserBirthday
+Presences = Base.classes.Presences

utils.py

@@ -4,6 +4,7 @@ File contains util functions.
 
 from datetime import datetime
 
+import nextcord
 from sqlalchemy import select
 from sqlalchemy.orm import Session
 
@@ -28,9 +29,12 @@ def get_datetime(day: str) -> datetime:
     day = int(day.split("/")[1])
 
     # ensure that year rolls over if current month is December and the next month is less than 12.
-    if datetime.today().month == 12 & month < 12:
+    if datetime.today().month == 12 and month < 12:
         year += 1
 
+    if datetime.today().month == 1 and month > 1:
+        year -= 1
+
     return datetime(year, month, day)
 
 
@@ -88,7 +92,7 @@ def get_current_cycle(config: DakinyConfig) -> int:
         config (DakinyConfig): Config object to use
 
     Returns:
-        int: cycle index for active election. -1 for no active cycle
+        int: cycle index for active election. None for no active cycle
     """
 
     today = datetime.today()
@@ -100,15 +104,16 @@ def get_current_cycle(config: DakinyConfig) -> int:
         ):
             return cycle
 
-    return -1
+    return None
 
 
-def build_votes_str(config: DakinyConfig) -> str:
+def build_votes_str(config: DakinyConfig, guild: nextcord.Guild) -> str:
     """
     Creates a string that contains all nominees and their votes to be sent as a discord message.
 
     Args:
         config (DakinyConfig): Daking config object
+        guild (nextcord.Guild): The guild object. Used to get display names for sorting.
 
     Returns:
         str: String that contains all nominees and their votes.
@@ -121,7 +126,10 @@ def build_votes_str(config: DakinyConfig) -> str:
             CouncilMembers.ElectionCycle == get_election_cycle_name(config)
         )
 
-        for nominee in session.scalars(stmt):
+        for nominee in sorted(
+            session.scalars(stmt),
+            key=lambda nominee: guild.get_member(nominee.MemberId).display_name,
+        ):
             votes[nominee.MemberId] = 0
 
         stmt = select(Votes).where(
@@ -138,7 +146,7 @@ def build_votes_str(config: DakinyConfig) -> str:
     return votes_str
 
 
-def build_highcouncil_votes_str(config: DakinyConfig) -> str:
+def build_highcouncil_votes_str(config: DakinyConfig, guild: nextcord.Guild) -> str:
     """
     Creates a string that contains all high council nominees and their votes to be sent as a discord message.
 
@@ -147,6 +155,7 @@ def build_highcouncil_votes_str(config: DakinyConfig) -> str:
 
     Returns:
         str: String that contains all nominees and their votes.
+        guild (nextcord.Guild): The guild object. Used to get display names for sorting.
     """
 
     cl_votes: dict[int, int] = {}
@@ -159,7 +168,10 @@ def build_highcouncil_votes_str(config: DakinyConfig) -> str:
             .filter(CouncilMembers.ClanLeaderSpeechId.is_not(None))
         )
 
-        for nominee in session.scalars(stmt):
+        for nominee in sorted(
+            session.scalars(stmt),
+            key=lambda nominee: guild.get_member(nominee.MemberId).display_name,
+        ):
             cl_votes[nominee.MemberId] = 0
 
         stmt = select(Votes).where(Votes.ElectionCycle == get_cl_election_name(config))
@@ -174,7 +186,10 @@ def build_highcouncil_votes_str(config: DakinyConfig) -> str:
             .filter(CouncilMembers.DiscordManagerSpeechId.is_not(None))
         )
 
-        for nominee in session.scalars(stmt):
+        for nominee in sorted(
+            session.scalars(stmt),
+            key=lambda nominee: guild.get_member(nominee.MemberId).display_name,
+        ):
             dm_votes[nominee.MemberId] = 0
 
         stmt = select(Votes).where(Votes.ElectionCycle == get_dm_election_name(config))