refactor: Continuing merge (#14)

* WIP

* Don't combine if-branches

* If passed in a date

* refactoring a little bit

* refactoring a little bit

* Should all be my timezone

* Correcting

* Just keep fixing

Author: svaningelgem

scripts/_common_tasks_stuff.py

@@ -16,7 +16,9 @@ def _email_text(hour_start: datetime | time, hour_end: datetime | time, course_n
 def _next_weekday() -> date | None:
     now = datetime.now()
 
-    if (now.hour in [12, 20] and now.isoweekday() == 3) or (now.hour in [17, 20] and now.isoweekday() != 3):  # Wednesday
+    if now.hour in [12, 20] and now.isoweekday() == 3:  # Wednesday  # noqa: SIM114
+        ...  # Ok
+    elif now.hour in [17, 20] and now.isoweekday() != 3:  # !Wednesday
         ...  # Ok
     else:
         return None

src/smartschool/agenda.py

@@ -3,11 +3,11 @@
 import time
 from abc import ABC
 from dataclasses import dataclass
-from datetime import datetime
 from typing import TYPE_CHECKING, ClassVar
 
 from . import objects
 from ._xml_interface import SmartschoolXML_WeeklyCache
+from .common import convert_to_datetime
 from .objects import AgendaHour, AgendaMomentInfo
 from .session import SessionMixin
 
@@ -83,7 +83,7 @@ def _action(self) -> str:
 
     @property
     def _params(self) -> dict:
-        now = (self.timestamp_to_use or datetime.now()).timestamp()
+        now = convert_to_datetime(self.timestamp_to_use).timestamp()
         in_5_days = now + 5 * 24 * 3600
 
         return {

src/smartschool/common.py

@@ -8,10 +8,11 @@
 import smtplib
 import warnings
 import xml.etree.ElementTree as ET
+from datetime import date, datetime
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from enum import Enum, auto
-from typing import Any, Callable, Literal
+from typing import TYPE_CHECKING, Any, Callable, Literal
 
 from bs4 import BeautifulSoup, FeatureNotFound, GuessedAtParserWarning
 from logprise import logger
@@ -29,6 +30,12 @@
     "send_email",
     "xml_to_dict",
 ]
+
+from smartschool.exceptions import SmartSchoolParsingError
+
+if TYPE_CHECKING:
+    from smartschool.objects import String
+
 _used_bs4_option = None
 
 
@@ -245,3 +252,45 @@ def xml_to_dict(element, *, depth: int = 0):
             result[tag] = child_data
 
     return result
+
+
+def convert_to_datetime(x: str | String | date | datetime | None) -> datetime:
+    if x is None:
+        return datetime.now().astimezone()
+
+    if isinstance(x, datetime):
+        if x.tzinfo is None:
+            raise ValueError("No timezone information found in this date")
+        return x
+
+    if isinstance(x, date):
+        return datetime.combine(x, datetime.min.time()).astimezone()
+
+    possible_formats = [
+        "%Y-%m-%dT%H:%M:%S%z",
+        "%Y-%m-%d %H:%M",
+        "%Y-%m-%d",
+    ]
+
+    for fmt in possible_formats:
+        with contextlib.suppress(ValueError):
+            x = datetime.strptime(x, fmt)
+            if x.tzinfo is None:
+                return x.astimezone()
+            return x
+
+    raise SmartSchoolParsingError(f"Cannot convert '{x}' to `datetime`")
+
+
+def convert_to_date(x: str | String | date | datetime | None) -> date:
+    if x is None:
+        return date.today()
+    if isinstance(x, datetime):
+        return x.date()
+    if isinstance(x, date):
+        return x
+
+    with contextlib.suppress(ValueError):
+        return datetime.strptime(x, "%Y-%m-%d").date()
+
+    raise SmartSchoolParsingError(f"Cannot convert '{x}' to `date`")

src/smartschool/exceptions.py

@@ -1,8 +1,14 @@
-class SmartSchoolException(Exception): ...
-
-
-class SmartSchoolDownloadError(SmartSchoolException): ...
+class SmartSchoolException(Exception):
+    """Base exception class for smartschool API errors."""
 
 
 class SmartSchoolAuthenticationError(SmartSchoolException):
     """Indicates an error during the authentication process."""
+
+
+class SmartSchoolParsingError(SmartSchoolException):
+    """Indicates an error occurred while parsing data from Smartschool."""
+
+
+class SmartSchoolDownloadError(SmartSchoolException):
+    """Indicates an error occurred during a file download operation."""

src/smartschool/objects.py

@@ -10,38 +10,11 @@
 from pydantic import AliasChoices, BeforeValidator, constr
 from pydantic.dataclasses import Field, dataclass
 
-from .common import as_float
+from .common import as_float, convert_to_date, convert_to_datetime
 
 String = constr(strip_whitespace=True)
 UUID = constr(pattern=re.compile(r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", flags=re.IGNORECASE))
 
-
-def convert_to_datetime(x: str | String | datetime | None) -> datetime:
-    if x is None:
-        return datetime.now().astimezone()
-
-    if isinstance(x, datetime):
-        if x.tzinfo is None:
-            raise ValueError("No timezone information found in this date")
-        return x
-
-    try:
-        return datetime.strptime(x, "%Y-%m-%dT%H:%M:%S%z")
-    except ValueError:  # 2023-11-16 08:24
-        return datetime.strptime(x, "%Y-%m-%d %H:%M")
-
-
-def convert_to_date(x: str | String | date | datetime | None) -> date:
-    if x is None:
-        return date.today()
-    if isinstance(x, datetime):
-        return x.date()
-    if isinstance(x, date):
-        return x
-
-    return datetime.strptime(x, "%Y-%m-%d").date()
-
-
 Url = String
 Date = Annotated[date, BeforeValidator(convert_to_date)]
 DateTime = Annotated[datetime, BeforeValidator(convert_to_datetime)]

tests/common_tests.py

@@ -1,14 +1,30 @@
 import warnings
 from copy import deepcopy
+from datetime import date, datetime, time, timedelta, timezone
 from pathlib import Path
 
+import pytest
 import pytest_mock
+import time_machine
 from bs4 import BeautifulSoup, FeatureNotFound, GuessedAtParserWarning
 from logprise import logger
 from requests import Response
 
 from smartschool import Smartschool
-from smartschool.common import IsSaved, as_float, bs4_html, fill_form, get_all_values_from_form, make_filesystem_safe, save, send_email, xml_to_dict
+from smartschool.common import (
+    IsSaved,
+    as_float,
+    bs4_html,
+    convert_to_date,
+    convert_to_datetime,
+    fill_form,
+    get_all_values_from_form,
+    make_filesystem_safe,
+    save,
+    send_email,
+    xml_to_dict,
+)
+from smartschool.exceptions import SmartSchoolParsingError
 from smartschool.objects import Student
 
 
@@ -160,12 +176,15 @@ def test_fill_form(mocker: pytest_mock.MockerFixture):
 
 
 def test_missing_name():
-    """Test missing name attribute."""
-    html = BeautifulSoup("""
+    """Test for missing name attribute."""
+    html = BeautifulSoup(
+        """
     <form>
         <input value="test" />
         <input value="test2" name="test2"/>
-    """)
+    """,
+        features="html.parser",
+    )
     result = get_all_values_from_form(html, "form")
     assert result == [{"name": "test2", "value": "test2"}]
 
@@ -391,3 +410,35 @@ def test_select_single_multiple_selected_last_wins():
     select_element = result[0]
 
     assert select_element["value"] == "high"  # Last selected wins
+
+
+@time_machine.travel("2023-09-01 10:02:03+02:00", tick=False)
+def test_convert_to_datetime() -> None:
+    expected = datetime(2023, 9, 1, 10, 2, 3, tzinfo=timezone(timedelta(hours=2)))
+    expected_no_time = datetime(2023, 9, 1, 0, 0, 0)
+
+    assert convert_to_datetime("2023-09-01T10:02:03+02:00") == expected.astimezone()
+    assert convert_to_datetime(expected) == expected.astimezone()
+    assert convert_to_datetime(None) == expected.astimezone()
+    assert convert_to_datetime("2023-09-01") == expected_no_time.astimezone()
+    assert convert_to_datetime(expected.date()) == expected_no_time.astimezone()
+    assert convert_to_datetime("2023-09-01 10:02") == expected.replace(second=0, tzinfo=None).astimezone()
+
+    with pytest.raises(ValueError, match="No timezone information found in this date"):
+        convert_to_datetime(expected.replace(tzinfo=None))
+
+    with pytest.raises(SmartSchoolParsingError, match="Cannot convert 'boom' to `datetime`"):
+        convert_to_datetime("boom")
+
+
+@time_machine.travel("2023-09-01 10:02:03+02:00", tick=False)
+def test_convert_to_date() -> None:
+    expected = date(2023, 9, 1)
+
+    assert convert_to_date("2023-09-01") == expected
+    assert convert_to_date(None) == expected
+    assert convert_to_date(expected) == expected
+    assert convert_to_date(datetime.combine(expected, time.min)) == expected
+
+    with pytest.raises(SmartSchoolParsingError, match="Cannot convert 'boom' to `date`"):
+        convert_to_date("boom")

tests/objects_tests.py

@@ -1,30 +0,0 @@
-from datetime import date, datetime, time, timedelta, timezone
-
-import pytest
-import time_machine
-
-from smartschool.objects import convert_to_date, convert_to_datetime
-
-
-@time_machine.travel("2023-09-01 10:02:03+02:00", tick=False)
-def test_convert_to_datetime() -> None:
-    expected = datetime(2023, 9, 1, 10, 2, 3, tzinfo=timezone(timedelta(hours=2)))
-
-    assert convert_to_datetime("2023-09-01T10:02:03+02:00") == expected
-    assert convert_to_datetime(expected) == expected
-    assert convert_to_datetime(None) == expected
-
-    with pytest.raises(ValueError, match="No timezone information found in this date"):
-        convert_to_datetime(expected.replace(tzinfo=None))
-
-    assert convert_to_datetime("2023-09-01 10:02") == expected.replace(second=0, tzinfo=None)
-
-
-@time_machine.travel("2023-09-01 10:02:03+02:00", tick=False)
-def test_convert_to_date() -> None:
-    expected = date(2023, 9, 1)
-
-    assert convert_to_date("2023-09-01") == expected
-    assert convert_to_date(None) == expected
-    assert convert_to_date(expected) == expected
-    assert convert_to_date(datetime.combine(expected, time.min)) == expected