Move parse_time function to main.py and remove parser.py; update tests accordingly

discord_reminder_bot/main.py

@@ -10,6 +10,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING, Any
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
+import dateparser
 import discord
 import pytz
 import sentry_sdk
@@ -26,8 +27,6 @@ from discord_webhook import DiscordWebhook
 from dotenv import load_dotenv
 from loguru import logger
 
-from discord_reminder_bot.parser import parse_time
-
 if TYPE_CHECKING:
     from apscheduler.job import Job
     from discord.guild import GuildChannel
@@ -46,6 +45,45 @@ sentry_sdk.init(
 )
 
 
+def parse_time(date_to_parse: str | None, timezone: str | None = os.getenv("TIMEZONE")) -> datetime.datetime | None:
+    """Parse a date string into a datetime object.
+
+    Args:
+        date_to_parse(str): The date string to parse.
+        timezone(str, optional): The timezone to use. Defaults timezone from settings.
+
+    Returns:
+        datetime.datetime: The parsed datetime object.
+    """
+    if not date_to_parse:
+        logger.error("No date provided to parse.")
+        return None
+
+    if not timezone:
+        logger.error("No timezone provided to parse date.")
+        return None
+
+    logger.info(f"Parsing date: '{date_to_parse}' with timezone: '{timezone}'")
+
+    try:
+        parsed_date: datetime.datetime | None = dateparser.parse(
+            date_string=date_to_parse,
+            settings={
+                "PREFER_DATES_FROM": "future",
+                "TIMEZONE": f"{timezone}",
+                "RETURN_AS_TIMEZONE_AWARE": True,
+                "RELATIVE_BASE": datetime.datetime.now(tz=ZoneInfo(str(timezone))),
+            },
+        )
+    except (ValueError, TypeError) as e:
+        logger.error(f"Failed to parse date: '{date_to_parse}' with timezone: '{timezone}'. Error: {e}")
+        return None
+
+    logger.debug(f"Parsed date: {parsed_date} from '{date_to_parse}'")
+
+    return parsed_date
+
+
 def calculate(job: Job) -> str:
     """Calculate the time left for a job.
 

discord_reminder_bot/parser.py

@@ -1,47 +0,0 @@
-from __future__ import annotations
-
-import datetime
-import os
-from zoneinfo import ZoneInfo
-
-import dateparser
-from loguru import logger
-
-
-def parse_time(date_to_parse: str | None, timezone: str | None = os.getenv("TIMEZONE")) -> datetime.datetime | None:
-    """Parse a date string into a datetime object.
-
-    Args:
-        date_to_parse(str): The date string to parse.
-        timezone(str, optional): The timezone to use. Defaults timezone from settings.
-
-    Returns:
-        datetime.datetime: The parsed datetime object.
-    """
-    if not date_to_parse:
-        logger.error("No date provided to parse.")
-        return None
-
-    if not timezone:
-        logger.error("No timezone provided to parse date.")
-        return None
-
-    logger.info(f"Parsing date: '{date_to_parse}' with timezone: '{timezone}'")
-
-    try:
-        parsed_date: datetime.datetime | None = dateparser.parse(
-            date_string=date_to_parse,
-            settings={
-                "PREFER_DATES_FROM": "future",
-                "TIMEZONE": f"{timezone}",
-                "RETURN_AS_TIMEZONE_AWARE": True,
-                "RELATIVE_BASE": datetime.datetime.now(tz=ZoneInfo(str(timezone))),
-            },
-        )
-    except (ValueError, TypeError) as e:
-        logger.error(f"Failed to parse date: '{date_to_parse}' with timezone: '{timezone}'. Error: {e}")
-        return None
-
-    logger.debug(f"Parsed date: {parsed_date} from '{date_to_parse}'")
-
-    return parsed_date

tests/conftest.py

@@ -4,5 +4,5 @@ import os
 
 
 def pytest_configure() -> None:
-    """Ignore Sentry when running tests."""
+    """Disable Sentry in tests."""
     os.environ["SENTRY_DSN"] = ""

tests/test_main.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
+import zoneinfo
 from datetime import datetime, timezone
 from typing import TYPE_CHECKING
 
+import pytest
 from apscheduler.job import Job
 from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.triggers.cron import CronTrigger
@@ -10,7 +12,7 @@ from apscheduler.triggers.date import DateTrigger
 from apscheduler.triggers.interval import IntervalTrigger
 
 from discord_reminder_bot import main
-from discord_reminder_bot.main import calculate
+from discord_reminder_bot.main import calculate, parse_time
 
 if TYPE_CHECKING:
     from apscheduler.job import Job
@@ -104,3 +106,60 @@ def test_if_send_to_user_is_in_main() -> None:
     """send_to_user needs to be in main for this program to work."""
     assert_msg: str = f"send_to_user is not in main. Current functions in main: {dir(main)}"
     assert hasattr(main, "send_to_user"), assert_msg
+
+
+def test_parse_time_valid_date_and_timezone() -> None:
+    """Test the `parse_time` function to ensure it correctly parses a date string into a datetime object."""
+    date_to_parse = "2023-10-10 10:00:00"
+    timezone = "UTC"
+    result: datetime | None = parse_time(date_to_parse, timezone)
+    assert result is not None
+    assert result.tzinfo is not None
+    assert result.strftime("%Y-%m-%d %H:%M:%S") == "2023-10-10 10:00:00"
+
+
+def test_parse_time_no_date() -> None:
+    """Test the `parse_time` function to ensure it correctly handles no date provided."""
+    date_to_parse = None
+    timezone = "UTC"
+    result: datetime | None = parse_time(date_to_parse, timezone)
+    assert result is None
+
+
+def test_parse_time_no_timezone() -> None:
+    """Test the `parse_time` function to ensure it correctly handles no timezone provided."""
+    date_to_parse = "2023-10-10 10:00:00"
+    timezone = None
+    result: datetime | None = parse_time(date_to_parse, timezone)
+    assert result is None
+
+
+def test_parse_time_invalid_date() -> None:
+    """Test the `parse_time` function to ensure it correctly handles an invalid date string."""
+    date_to_parse = "invalid date"
+    timezone = "UTC"
+    result: datetime | None = parse_time(date_to_parse, timezone)
+    assert result is None
+
+
+def test_parse_time_invalid_timezone() -> None:
+    """Test the `parse_time` function to ensure it correctly handles an invalid timezone."""
+    date_to_parse = "2023-10-10 10:00:00"
+    timezone = "Invalid/Timezone"
+    with pytest.raises(zoneinfo.ZoneInfoNotFoundError):
+        parse_time(date_to_parse, timezone)
+
+
+def test_parse_time_with_env_timezone(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Test the `parse_time` function to ensure it correctly parses a date string into a datetime object using the timezone from the environment."""
+    date_to_parse = "2023-10-10 10:00:00"
+    result: datetime | None = parse_time(date_to_parse, "UTC")
+
+    assert_msg: str = "Expected datetime object, got None"
+    assert result is not None, assert_msg
+
+    assert_msg = "Expected timezone-aware datetime object, got naive datetime object"
+    assert result.tzinfo is not None, assert_msg
+
+    assert_msg = f"Expected 2023-10-10 10:00:00, got {result.strftime('%Y-%m-%d %H:%M:%S')}"
+    assert result.strftime("%Y-%m-%d %H:%M:%S") == "2023-10-10 10:00:00", assert_msg

tests/test_parser.py

@@ -1,68 +0,0 @@
-from __future__ import annotations
-
-import zoneinfo
-from typing import TYPE_CHECKING
-
-import pytest
-
-from discord_reminder_bot.parser import parse_time
-
-if TYPE_CHECKING:
-    from datetime import datetime
-
-
-def test_parse_time_valid_date_and_timezone() -> None:
-    """Test the `parse_time` function to ensure it correctly parses a date string into a datetime object."""
-    date_to_parse = "2023-10-10 10:00:00"
-    timezone = "UTC"
-    result: datetime | None = parse_time(date_to_parse, timezone)
-    assert result is not None
-    assert result.tzinfo is not None
-    assert result.strftime("%Y-%m-%d %H:%M:%S") == "2023-10-10 10:00:00"
-
-
-def test_parse_time_no_date() -> None:
-    """Test the `parse_time` function to ensure it correctly handles no date provided."""
-    date_to_parse = None
-    timezone = "UTC"
-    result: datetime | None = parse_time(date_to_parse, timezone)
-    assert result is None
-
-
-def test_parse_time_no_timezone() -> None:
-    """Test the `parse_time` function to ensure it correctly handles no timezone provided."""
-    date_to_parse = "2023-10-10 10:00:00"
-    timezone = None
-    result: datetime | None = parse_time(date_to_parse, timezone)
-    assert result is None
-
-
-def test_parse_time_invalid_date() -> None:
-    """Test the `parse_time` function to ensure it correctly handles an invalid date string."""
-    date_to_parse = "invalid date"
-    timezone = "UTC"
-    result: datetime | None = parse_time(date_to_parse, timezone)
-    assert result is None
-
-
-def test_parse_time_invalid_timezone() -> None:
-    """Test the `parse_time` function to ensure it correctly handles an invalid timezone."""
-    date_to_parse = "2023-10-10 10:00:00"
-    timezone = "Invalid/Timezone"
-    with pytest.raises(zoneinfo.ZoneInfoNotFoundError):
-        parse_time(date_to_parse, timezone)
-
-
-def test_parse_time_with_env_timezone(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test the `parse_time` function to ensure it correctly parses a date string into a datetime object using the timezone from the environment."""
-    date_to_parse = "2023-10-10 10:00:00"
-    result: datetime | None = parse_time(date_to_parse, "UTC")
-
-    assert_msg: str = "Expected datetime object, got None"
-    assert result is not None, assert_msg
-
-    assert_msg = "Expected timezone-aware datetime object, got naive datetime object"
-    assert result.tzinfo is not None, assert_msg
-
-    assert_msg = f"Expected 2023-10-10 10:00:00, got {result.strftime('%Y-%m-%d %H:%M:%S')}"
-    assert result.strftime("%Y-%m-%d %H:%M:%S") == "2023-10-10 10:00:00", assert_msg