Save: adding all files to save progress.

I don't exactly remember where I was on this, but I need to move on
and work on other things. Adding all files just to save my work.

dakiny_bot/__init__.py

@@ -1 +1,7 @@
 """Empty init file for dakiny_bot module."""
+
+from dakiny_bot.dakiny_settings import CONFIG_LOCATION, DakinySettings, settings
+
+if settings is None:
+    tmp = DakinySettings.from_yaml_file(CONFIG_LOCATION)
+    settings = tmp[0] if isinstance(tmp, list) else tmp

dakiny_bot/classes/election.py

@@ -16,13 +16,13 @@ from dakiny_bot.database.sql_data_classes import (
     Votes,
     engine,
 )
+from dakiny_bot.election_utils import get_datetime
 from dakiny_bot.utils import (
     TEMPLATES_DIR,
     VoteType,
     build_highcouncil_votes_str,
     build_votes_str,
     edit_clan_council_info,
-    get_datetime,
     get_election_name,
 )
 from sqlalchemy import select, true, update

dakiny_bot/dakiny_settings.py

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

dakiny_bot/election_utils.py

@@ -0,0 +1,51 @@
+"""Broken out util functions to avoid importing sql during testing."""
+
+import calendar
+from datetime import UTC, datetime
+
+from dakiny_bot.dakiny_settings import settings
+
+
+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:
+        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(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:
+        year += 1
+
+    if today.month == calendar.JANUARY and month > calendar.MARCH:
+        year -= 1
+
+    return datetime(year, month, day, tzinfo=UTC)
+
+
+def get_quarter_cycle() -> int | 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.
+    """
+    today = datetime.now(tz=UTC)
+    for cycle, election in enumerate(settings.election_cycles):
+        if (
+            today.date() >= get_datetime(election.term_start).date()
+            and today.date() <= get_datetime(election.term_end).date()
+        ):
+            return cycle
+
+    return None

dakiny_bot/tests/utils/test_get_datetime.py

@@ -4,10 +4,38 @@ import datetime
 
 from freezegun import freeze_time
 
-from dakiny_bot.utils import get_datetime
+from dakiny_bot.election_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)
+    Test a regular get_datetime.
+
+    Expect the returned datetime to be the frozen date.
+    Have two different days to ensure that the date is being returned correctly.
+    """
+    date_time = get_datetime("6/15")
+    assert date_time == datetime.datetime(2025, 6, 15, tzinfo=datetime.UTC)
+
+
+@freeze_time("2025-1-16")
+def test_jan_get_datetime() -> None:
+    """
+    Test previous year get_datetime.
+
+    Frozen day is in January 2025, datetime string is in December. Expect datetime to be from 2024.
+    """
+    date_time = get_datetime("12/15")
+    assert date_time == datetime.datetime(2024, 12, 15, tzinfo=datetime.UTC)
+
+
+@freeze_time("2025-12-16")
+def test_dec_get_datetime() -> None:
+    """
+    Test next year get_datetime.
+
+    Frozen day is in December 2025, datetime string is in January. Expect datetime to be from 2026.
+    """
+    date_time = get_datetime("1/15")
+    assert date_time == datetime.datetime(2026, 1, 15, tzinfo=datetime.UTC)

dakiny_bot/tests/utils/test_get_quarter_cycle.py

@@ -0,0 +1,31 @@
+"""Test functions for get_quarter_cycle."""
+
+from unittest.mock import mock_open, patch
+
+from freezegun import freeze_time
+
+from dakiny_bot.dakiny_settings import ChannelIds, DakinySettings, Election, Params, PointSettings, RoleIds
+from dakiny_bot.election_utils import get_quarter_cycle
+
+# I only care about term start and term end for this test
+q1 = Election(True, "", "", "", "", "q1", "4/30", "2/1", "", "")  # noqa: FBT003
+q2 = Election(True, "", "", "", "", "q2", "7/31", "5/1", "", "")  # noqa: FBT003
+q3 = Election(True, "", "", "", "", "q3", "10/31", "8/1", "", "")  # noqa: FBT003
+q4 = Election(True, "", "", "", "", "q4", "1/31", "11/1", "", "")  # noqa: FBT003
+
+# Dummy all the values I don't care about.
+settings = DakinySettings(
+    ChannelIds(1, 1, 1, 1, 1, 1),
+    [q1, q2, q3, q4],
+    Params("", "", 1),
+    PointSettings(1, 1, 1, 1, 1, True, True),  # noqa: FBT003
+    RoleIds(1, 1, 1, 1, 1),
+)
+
+
+@patch("election_utils.get_quarter_cycle.settings", settings)
+@patch("builtins.open", new_callable=mock_open)
+class TestGetQuarterCycle:
+    @freeze_time("2025-2-25")
+    def test_regular_q1(self) -> None:
+        assert get_quarter_cycle() == 0

dakiny_bot/utils.py

@@ -1,6 +1,5 @@
 """File contains util functions."""
 
-import calendar
 import os
 from collections.abc import Sequence
 from datetime import UTC, datetime
@@ -22,6 +21,7 @@ from dakiny_bot.database.sql_data_classes import (
 )
 
 from .dakiny_settings import settings
+from .election_utils import get_datetime, get_quarter_cycle
 
 NOMINEE_SPLITTER = "========================================\n\n"
 REPO_DIR = "./dakiny-messages"
@@ -34,31 +34,6 @@ VoteType = StrEnum("VoteType", ["COUNCIL", "DISCORDMANAGER", "CLANLEADER"])
 PointType = StrEnum("PointType", ["CLAN", "EVENT"])
 
 
-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:
-        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(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:
-        year += 1
-
-    if today.month == calendar.JANUARY and month > calendar.MARCH:
-        year -= 1
-
-    return datetime(year, month, day, tzinfo=UTC)
-
-
 def get_election_name() -> str:
     """
     Builds the unique name of the current election cycle.
@@ -110,26 +85,6 @@ def get_active_election_cycle() -> int | None:
     return get_quarter_cycle()
 
 
-def get_quarter_cycle() -> int | 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.
-    """
-    today = datetime.now(tz=UTC)
-    for cycle, election in enumerate(settings.election_cycles):
-        if (
-            today.date() >= get_datetime(election.term_start).date()
-            and today.date() <= get_datetime(election.term_end).date()
-        ):
-            return cycle
-
-    return None
-
-
 def build_votes_str(guild: nextcord.Guild) -> str:
     """
     Creates a string that contains all nominees and their votes to be sent as a discord message.