Add lint ignores for tests.

lists won't ever happen, but pylance didn't like it.

dakiny_bot/app.py

@@ -12,7 +12,7 @@ from dakiny_bot.classes.voting_highcouncil_views import VoteHighcouncilView
 from dakiny_bot.classes.voting_views import VoteView
 from dakiny_bot.database import create_database
 
-from .DakinySettings import settings
+from .dakiny_settings import settings
 
 birthday_list: list[int] = []
 

dakiny_bot/classes/election.py

@@ -5,14 +5,11 @@ from datetime import UTC, datetime, timedelta
 from pathlib import Path
 
 import nextcord
-from sqlalchemy import select, true, update
-from sqlalchemy.orm import Session
-
 from dakiny_bot.classes.nominate_highcouncil_views import NominateHighCouncilView
 from dakiny_bot.classes.nominate_views import NominateView
 from dakiny_bot.classes.voting_highcouncil_views import VoteHighcouncilView
 from dakiny_bot.classes.voting_views import VoteView
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import (
     CouncilMembers,
     ElectionInformation,
@@ -28,6 +25,8 @@ from dakiny_bot.utils import (
     get_datetime,
     get_election_name,
 )
+from sqlalchemy import select, true, update
+from sqlalchemy.orm import Session
 
 REQUIRED_VOTES_TO_BE_ELECTED = 3
 
@@ -70,7 +69,7 @@ class Election:
             list[str]: A list of message contents in the correct order. Must be a string because the message is too
             long.
         """
-        with Path(f"{TEMPLATES_DIR}/election_announcement.txt", encoding="utf8").open() as file:
+        with Path(f"{TEMPLATES_DIR}/election_announcement.txt").open() as file:
             message = file.read()
 
             next_election = get_datetime(
@@ -98,7 +97,7 @@ class Election:
         Returns:
             str: Message to send.
         """
-        with Path(f"{TEMPLATES_DIR}/highcouncil_election.txt", encoding="utf8").open() as file:
+        with Path(f"{TEMPLATES_DIR}/highcouncil_election.txt").open() as file:
             message = file.read()
 
             return message.format(
@@ -116,7 +115,7 @@ class Election:
         Returns:
             str: Message to send.
         """
-        with Path(f"{TEMPLATES_DIR}/highcouncil_vote.txt", encoding="utf8").open() as file:
+        with Path(f"{TEMPLATES_DIR}/highcouncil_vote.txt").open() as file:
             message = file.read()
 
             return message.format(
@@ -131,7 +130,7 @@ class Election:
         Returns:
             str: Message to send
         """
-        with Path(f"{TEMPLATES_DIR}/vote_start.txt", encoding="utf8").open() as file:
+        with Path(f"{TEMPLATES_DIR}/vote_start.txt").open() as file:
             message = file.read()
             vote_end: datetime = get_datetime(settings.election_cycles[self.cycle].voting_end)
 

dakiny_bot/classes/nominate_highcouncil_views.py

@@ -1,11 +1,7 @@
 """Contains various views to be used in the high council nomination process."""
 
 import nextcord
-from nextcord.interactions import Interaction
-from sqlalchemy import select
-from sqlalchemy.orm import Session
-
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import CouncilMembers, engine
 from dakiny_bot.utils import (
     NOMINEE_SPLITTER,
@@ -13,6 +9,9 @@ from dakiny_bot.utils import (
     decorate_dm_nomination,
     get_election_name,
 )
+from nextcord.interactions import Interaction
+from sqlalchemy import select
+from sqlalchemy.orm import Session
 
 
 class NominateDMModal(nextcord.ui.Modal):

dakiny_bot/classes/nominate_views.py

@@ -1,14 +1,13 @@
 """Contains various views to be used in the nomination process."""
 
 import nextcord
+from dakiny_bot.dakiny_settings import settings
+from dakiny_bot.database.sql_data_classes import CouncilMembers, engine
+from dakiny_bot.utils import NOMINEE_SPLITTER, decorate_nomination, get_election_name
 from nextcord.interactions import Interaction
 from sqlalchemy import select
 from sqlalchemy.orm import Session
 
-from dakiny_bot.DakinySettings import settings
-from dakiny_bot.database.sql_data_classes import CouncilMembers, engine
-from dakiny_bot.utils import NOMINEE_SPLITTER, decorate_nomination, get_election_name
-
 
 class NominateModal(nextcord.ui.Modal):
     """

dakiny_bot/classes/voting_highcouncil_views.py

@@ -1,12 +1,7 @@
 """Contains various views to be used while voting for high council. Controls the logic when performing the vote."""
 
 import nextcord
-from nextcord import SelectOption
-from nextcord.interactions import Interaction
-from sqlalchemy import exc, select, update
-from sqlalchemy.orm import Session
-
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import (
     CouncilMembers,
     ElectionInformation,
@@ -14,6 +9,10 @@ from dakiny_bot.database.sql_data_classes import (
     engine,
 )
 from dakiny_bot.utils import VoteType, build_highcouncil_votes_str, get_election_name
+from nextcord import SelectOption
+from nextcord.interactions import Interaction
+from sqlalchemy import exc, select, update
+from sqlalchemy.orm import Session
 
 
 class VoteSelect(nextcord.ui.StringSelect):

dakiny_bot/classes/voting_views.py

@@ -1,12 +1,7 @@
 """Contains various views to be used while voting. Controls the logic when performing the vote."""
 
 import nextcord
-from nextcord import SelectOption
-from nextcord.interactions import Interaction
-from sqlalchemy import exc, select, update
-from sqlalchemy.orm import Session
-
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import (
     CouncilMembers,
     ElectionInformation,
@@ -14,6 +9,10 @@ from dakiny_bot.database.sql_data_classes import (
     engine,
 )
 from dakiny_bot.utils import VoteType, build_votes_str, get_election_name
+from nextcord import SelectOption
+from nextcord.interactions import Interaction
+from sqlalchemy import exc, select, update
+from sqlalchemy.orm import Session
 
 
 class VoteSelect(nextcord.ui.StringSelect):

dakiny_bot/cogs/clan_messages/__init__.py

@@ -9,7 +9,7 @@ from git import Repo
 from nextcord.ext import commands
 
 from dakiny_bot.classes.gitea_webhook import GiteaWebhook
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.utils import REPO_DIR, edit_clan_council_info, update_clan_messages
 
 if TYPE_CHECKING:

dakiny_bot/cogs/commands/record.py

@@ -4,7 +4,7 @@ import nextcord
 from discord import TextInputStyle
 from nextcord.ext import commands
 
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.utils import GUILDS, MAX_DISCORD_MESSAGE_LENGTH, PointType, record_points
 
 

dakiny_bot/cogs/commands/request.py

@@ -4,7 +4,7 @@ import nextcord
 from nextcord.ext import commands
 from sqlalchemy.orm import Session
 
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import Presences, engine
 
 

dakiny_bot/cogs/commands/settings.py

@@ -3,7 +3,7 @@
 import nextcord
 from nextcord.ext import commands
 
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.utils import GUILDS
 
 

dakiny_bot/cogs/commands/test.py

@@ -4,7 +4,7 @@ import nextcord
 from nextcord.ext import application_checks, commands
 
 from dakiny_bot.classes.election import Election
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.utils import GUILDS, get_active_election_cycle, get_quarter_name
 
 ME = 206602713511886849

dakiny_bot/cogs/loops/daily_loop.py

@@ -11,7 +11,7 @@ from sqlalchemy.orm import Session
 
 from dakiny_bot.app import birthday_list
 from dakiny_bot.classes.election import Election
-from dakiny_bot.DakinySettings import settings
+from dakiny_bot.dakiny_settings import settings
 from dakiny_bot.database.sql_data_classes import UserBirthday, engine
 from dakiny_bot.utils import get_active_election_cycle
 

dakiny_bot/dakiny_settings.py

@@ -83,4 +83,5 @@ class DakinySettings(YAMLWizard):
         self.to_yaml_file(CONFIG_LOCATION)
 
 
-settings = DakinySettings.from_yaml_file(CONFIG_LOCATION)
+tmp = DakinySettings.from_yaml_file(CONFIG_LOCATION)
+settings: DakinySettings = tmp[0] if isinstance(tmp, list) else tmp

dakiny_bot/tests/__init__.py

@@ -0,0 +1 @@
+"""Empty init for testing util functions."""

dakiny_bot/tests/utils/__init__.py

@@ -0,0 +1 @@
+"""Empty init for testing util functions."""

dakiny_bot/tests/utils/test_get_datetime.py

@@ -0,0 +1,13 @@
+"""Tests for get_datetime function."""
+
+import datetime
+
+from freezegun import freeze_time
+
+from dakiny_bot.utils import get_datetime
+
+
+@freeze_time("2025-6-16")
+def test_regular_get_datetime() -> None:
+    date_time = get_datetime("6/16")
+    assert date_time == datetime.datetime(2025, 6, 16)

dakiny_bot/utils.py

@@ -21,7 +21,7 @@ from dakiny_bot.database.sql_data_classes import (
     engine,
 )
 
-from .DakinySettings import settings
+from .dakiny_settings import settings
 
 NOMINEE_SPLITTER = "========================================\n\n"
 REPO_DIR = "./dakiny-messages"
@@ -34,20 +34,20 @@ VoteType = StrEnum("VoteType", ["COUNCIL", "DISCORDMANAGER", "CLANLEADER"])
 PointType = StrEnum("PointType", ["CLAN", "EVENT"])
 
 
-def get_datetime(day: str) -> datetime:
+def get_datetime(month_day: str) -> datetime:
     """
     Takes in a string month and day and returns a datetime object of that Month/Day this year.
 
     Args:
-        day (str): Month/Day in that format.
+        month_day (str): Month/Day in that format.
 
     Returns:
         datetime: Datetime representation of Month/Day.
     """
     today = datetime.now(tz=UTC).date()
     year = today.year
-    month = int(day.split("/")[0])
-    day = int(day.split("/")[1])
+    month = int(month_day.split("/")[0])
+    day = int(month_day.split("/")[1])
 
     # ensure that year rolls over if current month is December and the next month is less than 12.
     if today.month == calendar.DECEMBER and month < calendar.OCTOBER:
@@ -66,7 +66,10 @@ def get_election_name() -> str:
     Returns:
         str: the name of the election cycle
     """
-    cycle = get_active_election_cycle()
+    if cycle := get_active_election_cycle() is None:
+        # undefined behavior
+        print("Did not find an active election cycle. Undefined behavior with return string.")  # noqa: T201
+        return "No-active-election-cycle"
     current_cycle = settings.election_cycles[cycle]
     return f"vote-{get_datetime(current_cycle.term_start).year}-{current_cycle.name}"
 
@@ -78,13 +81,16 @@ def get_quarter_name() -> str:
     Returns:
         str: the name of the cycle.
     """
-    cycle = get_quarter_cycle()
+    if cycle := get_quarter_cycle() is None:
+        # undefined behavior
+        print("Did not find a quarter cycle. Undefined behavior with return string.")  # noqa: T201
+        return "no-quarter-cycle"
     current_cycle = settings.election_cycles[cycle]
 
     return f"{get_datetime(current_cycle.term_start).year}-{current_cycle.name}"
 
 
-def get_active_election_cycle() -> int:
+def get_active_election_cycle() -> int | None:
     """
     Returns index for active election. An election is considered active between the election start and the term start.
 
@@ -104,7 +110,7 @@ def get_active_election_cycle() -> int:
     return get_quarter_cycle()
 
 
-def get_quarter_cycle() -> int:
+def get_quarter_cycle() -> int | None:
     """
     Returns the index for the current cycle/quarter. Defined as between term start and end.
 

pyproject.toml

@@ -19,7 +19,12 @@ description = "Dakiny's Discord Bot."
 readme = "README.md"
 
 [dependency-groups]
-dev = ["ruff<1.0.0,>=0.6.9"]
+dev = [
+    "freezegun>=1.5.1",
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.1",
+    "ruff<1.0.0,>=0.6.9",
+]
 
 [tool.ruff]
 # Exclude a variety of commonly ignored directories.
@@ -126,3 +131,6 @@ docstring-code-format = true
 # This only has an effect when the `docstring-code-format` setting is
 # enabled.
 docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.per-file-ignores]
+"**/{tests}/*" = ["ANN001", "ANN201", "S101", "PLR2004"]