Fix the scripts (#13)

Author: svaningelgem

pyproject.toml

@@ -69,6 +69,7 @@ requests_mock_case_sensitive = true
 line-length = 160
 fix = true
 unsafe-fixes = true
+include = ["*.py", "*.pyi", "scripts/*"]
 
 [tool.ruff.lint]
 select = [

scripts/list_all_courses

@@ -1,8 +1,8 @@
 #!/usr/bin/env python
 from logprise import logger
 
-from smartschool import Smartschool, PathCredentials, Courses
+from smartschool import Courses, PathCredentials, Smartschool
 
-Smartschool.start(PathCredentials())
-for course in Courses():
+session = Smartschool(PathCredentials())
+for course in Courses(session):
     logger.info(course.name)

scripts/smartschool_report_on_future_tasks

@@ -1,71 +1,52 @@
 #!/usr/bin/env python
+from __future__ import annotations
+
 from collections import defaultdict
-from datetime import date, datetime, timedelta
+from typing import TYPE_CHECKING
+
+from _common_tasks_stuff import _next_weekday
 
-from smartschool import Courses, FutureTasks, PathCredentials, Periods, Smartschool, SmartschoolHours, SmartschoolLessons, SmartschoolMomentInfos
+from smartschool import FutureTasks, PathCredentials, Smartschool, SmartschoolHours
 from smartschool.common import IsSaved, save, send_email
-from smartschool.objects import AgendaHour, FutureTaskOneTask
-from smartschool.session import session
+
+if TYPE_CHECKING:
+    from datetime import date
+
+    from smartschool.objects import AgendaHour, FutureTaskOneTask
 
 
 def _is_equal_task(a: FutureTaskOneTask, b: FutureTaskOneTask) -> bool:
-    return (a.course, a.hourID, a.label, a.description, a.date) ==(b.course, b.hourID, b.label, b.description, b.date)
+    return (a.course, a.hourID, a.label, a.description, a.date) == (b.course, b.hourID, b.label, b.description, b.date)
 
 
-def _email_text(task: FutureTaskOneTask) -> str:
-    hour: AgendaHour = SmartschoolHours().search_by_hourId(task.hourID)
+def _email_text(session: Smartschool, task: FutureTaskOneTask) -> str:
+    hour: AgendaHour = SmartschoolHours(session).search_by_hourId(task.hourID)
 
-    return (
-        f"date: {task.date}\n"
-        f"lesuur: {hour.title}e lesuur\n"
-        f"time: {hour.start} -> {hour.end}\n"
-        f"les: {task.course}\n"
-        "\n"
-        f"{task.label}:\n"
-        f"  {task.description}\n"
-    )
+    return f"date: {task.date}\nlesuur: {hour.title}e lesuur\ntime: {hour.start} -> {hour.end}\nles: {task.course}\n\n{task.label}:\n  {task.description}\n"
 
 
-def process_task(task: FutureTaskOneTask, all_tasks: dict) -> None:
+def process_task(session: Smartschool, task: FutureTaskOneTask, all_tasks: dict) -> None:
     """Stores in an array + report if it's a new/updated task."""
-
     course_name = task.course
-    hour: AgendaHour = SmartschoolHours().search_by_hourId(task.hourID)
+    hour: AgendaHour = SmartschoolHours(session).search_by_hourId(task.hourID)
     when = task.date
 
     all_tasks[when][hour.title].append(task)
 
-    status = save(type_="todo", course_name=course_name, id_=task.assignmentID, data=task, is_eq=_is_equal_task)
+    status = save(session, type_="todo", course_name=course_name, id_=task.assignmentID, data=task, is_eq=_is_equal_task)
     if status == IsSaved.SAME:
         return
 
     subject = f"📑 [{when} {hour.title}e lesuur] {course_name} ({task.label})"
     if status != IsSaved.NEW:
         subject = f"⚠⚠ {subject}"  # There is an update...
 
-    text = _email_text(task)
-
-    send_email(subject=subject, text=text, email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
+    text = _email_text(session, task)
 
+    send_email(subject=subject, text=text, email_from=session.creds.other_info["email_from"], email_to=session.creds.other_info["email_to"])
 
-def _next_weekday() -> date | None:
-    now = datetime.now()
 
-    if now.hour in [12, 20] and now.isoweekday() == 3:  # Wednesday
-        ...  # Ok
-    elif now.hour in [17, 20] and now.isoweekday() != 3:  # !Wednesday
-        ...  # Ok
-    else:
-        return None
-
-    next_weekday = now + timedelta(days=1)
-    while next_weekday.isoweekday() in [6, 7]:  # Saturday, Sunday
-        next_weekday += timedelta(days=1)
-
-    return next_weekday.date()
-
-
-def report_tasks_for_next_day(all_tasks: dict):
+def report_tasks_for_next_day(session: Smartschool, all_tasks: dict):
     next_weekday = _next_weekday()
     if not next_weekday:
         return
@@ -76,40 +57,38 @@ def report_tasks_for_next_day(all_tasks: dict):
     tasks = all_tasks[next_weekday]
 
     text = []
-    for uur, tasks in sorted(tasks.items(), key=lambda x: x[0]):  # type: str, list[FutureTaskOneTask]
-        for task in tasks:
-            text.append(_email_text(task))
+    for _uur, subtasks in sorted(tasks.items(), key=lambda x: x[0]):  # type: str, list[FutureTaskOneTask]
+        for task in subtasks:
+            text.append(_email_text(session, task))
 
     text = "\n---------------------------------------\n\n".join(text)
 
-    status = save('todo', '.email', str(next_weekday), data=text, extension='txt')
+    status = save(session, "todo", ".email", str(next_weekday), data=text, extension="txt")
     if status == IsSaved.SAME:
         return  # Don't re-send if nothing changed
 
-    subject=f"🍕 Todo list {next_weekday}"
+    subject = f"🍕 Todo list {next_weekday}"
     if status != IsSaved.NEW:
         subject = f"⚠⚠ {subject}"  # There is an update...
-    send_email(
-        subject=subject,
-        text=text, email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
+    send_email(subject=subject, text=text, email_from=session.creds.other_info["email_from"], email_to=session.creds.other_info["email_to"])
 
 
 def main():
     all_tasks: dict[date, dict[str, list]] = defaultdict(lambda: defaultdict(list))
 
-    Smartschool.start(PathCredentials())
-    assert 'email_from' in session.creds.other_info
-    assert 'email_to' in session.creds.other_info
+    session = Smartschool(PathCredentials())
+    assert "email_from" in session.creds.other_info
+    assert "email_to" in session.creds.other_info
 
-    for day in FutureTasks().days:
+    for day in FutureTasks(session):
         for course in day.courses:
             assert not course.items.materials, "Please correct the model to include this information."
 
             for task in course.items.tasks:
-                process_task(task, all_tasks)
-    
-    report_tasks_for_next_day(all_tasks)
+                process_task(session, task, all_tasks)
+
+    report_tasks_for_next_day(session, all_tasks)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

scripts/smartschool_report_on_planned_tasks

@@ -1,32 +1,29 @@
 #!/usr/bin/env python
 from collections import defaultdict
-from datetime import date
+from typing import TYPE_CHECKING
+
+from _common_tasks_stuff import _email_text, _next_weekday
 
-from _common_tasks_stuff import _next_weekday, _email_text
 from smartschool import PathCredentials, Smartschool
 from smartschool.common import IsSaved, save, send_email
-from smartschool.objects import FutureTaskOneTask, PlannedElement
+from smartschool.objects import PlannedElement
 from smartschool.planner import PlannedElements
-from smartschool.session import session
+
+if TYPE_CHECKING:
+    from datetime import date
 
 
 def _is_equal_task(a: PlannedElement, b: PlannedElement) -> bool:
-    return (
-        [c.name for c in a.courses],
-        a.period.dateTimeFrom,
-        a.period.dateTimeTo,
-        a.assignmentType.name,
-        a.name
-    ) == (
+    return ([c.name for c in a.courses], a.period.dateTimeFrom, a.period.dateTimeTo, a.assignmentType.name, a.name) == (
         [c.name for c in b.courses],
         b.period.dateTimeFrom,
         b.period.dateTimeTo,
         b.assignmentType.name,
-        b.name
+        b.name,
     )
 
 
-def process_task(task: PlannedElement, all_tasks: dict) -> None:
+def process_task(session: Smartschool, task: PlannedElement, all_tasks: dict) -> None:
     """Stores in an array + report if it's a new/updated task."""
     next_weekday = _next_weekday()
     is_for_next_day = next_weekday < task.period.dateTimeFrom.date() or next_weekday > task.period.dateTimeTo.date()
@@ -46,19 +43,18 @@ def process_task(task: PlannedElement, all_tasks: dict) -> None:
     if is_for_next_day:
         all_tasks[when][hour].append(text)
 
-    status = save(type_="todo", course_name=course_name, id_=task.assignmentType.id, data=task, is_eq=_is_equal_task)
+    status = save(session, type_="todo", course_name=course_name, id_=task.assignmentType.id, data=task, is_eq=_is_equal_task)
     if status == IsSaved.SAME:
         return
 
     subject = f"📑 [{when} {hour}] {course_name} ({task.name})"
     if status != IsSaved.NEW:
         subject = f"⚠⚠ {subject}"  # There is an update...
 
-    send_email(subject=subject, text=text, email_from=session.creds.other_info['email_from'],
-               email_to=session.creds.other_info['email_to'])
+    send_email(subject=subject, text=text, email_from=session.creds.other_info["email_from"], email_to=session.creds.other_info["email_to"])
 
 
-def report_tasks_for_next_day(all_tasks: dict):
+def report_tasks_for_next_day(session: Smartschool, all_tasks: dict):
     for dag, rest in all_tasks.items():
         text = []
 
@@ -68,31 +64,29 @@ def report_tasks_for_next_day(all_tasks: dict):
 
         text = "\n---------------------------------------\n\n".join(text)
 
-        status = save('todo', '.email', dag, data=text, extension='txt')
+        status = save(session, "todo", ".email", dag, data=text, extension="txt")
         if status == IsSaved.SAME:
             continue  # Don't re-send if nothing changed
 
         subject = f"🍕 Todo list {dag}"
         if status != IsSaved.NEW:
             subject = f"⚠⚠ {subject}"  # There is an update...
 
-        send_email(
-            subject=subject,
-            text=text, email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
+        send_email(subject=subject, text=text, email_from=session.creds.other_info["email_from"], email_to=session.creds.other_info["email_to"])
 
 
 def main():
     all_tasks: dict[date, dict[str, list]] = defaultdict(lambda: defaultdict(list))
 
-    Smartschool.start(PathCredentials())
-    assert 'email_from' in session.creds.other_info
-    assert 'email_to' in session.creds.other_info
+    session = Smartschool(PathCredentials())
+    assert "email_from" in session.creds.other_info
+    assert "email_to" in session.creds.other_info
 
-    for element in PlannedElements():
-        process_task(element, all_tasks)
+    for element in PlannedElements(session):
+        process_task(session, element, all_tasks)
 
-    report_tasks_for_next_day(all_tasks)
+    report_tasks_for_next_day(session, all_tasks)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

scripts/smartschool_report_on_results

@@ -1,10 +1,15 @@
 #!/usr/bin/env python
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 
 from logprise import logger
-from smartschool import PathCredentials, Results, Smartschool, DownloadError
+
+from smartschool import PathCredentials, Results, Smartschool, SmartSchoolDownloadError
 from smartschool.common import IsSaved, save, send_email
-from smartschool.objects import ResultWithoutDetails
-from smartschool.session import session
+
+if TYPE_CHECKING:
+    from smartschool.objects import ResultWithoutDetails
 
 
 def is_punten_json_the_same(previous: ResultWithoutDetails, current: ResultWithoutDetails) -> bool:
@@ -67,26 +72,20 @@ def is_punten_json_the_same(previous: ResultWithoutDetails, current: ResultWitho
 
 
 def build_text(
-    is_update: bool,
+    is_update: bool,  # noqa: FBT001
     result: ResultWithoutDetails,
 ) -> tuple[str, str]:
     course_name = result.courses[0].name
     teacher_names = [teacher.name.startingWithFirstName for teacher in result.courses[0].teachers]
     test_name = result.name
 
-    achieved = f"{result.graphic.achieved_points:.2f}".rstrip('0').rstrip('.')
-    total = f"{result.graphic.total_points:.2f}".rstrip('0').rstrip('.')
-    pct = f"{100 * result.graphic.percentage:.2f}".rstrip('0').rstrip('.')
+    achieved = f"{result.graphic.achieved_points:.2f}".rstrip("0").rstrip(".")
+    total = f"{result.graphic.total_points:.2f}".rstrip("0").rstrip(".")
+    pct = f"{100 * result.graphic.percentage:.2f}".rstrip("0").rstrip(".")
 
     my_points = f"{achieved}/{total} ({pct}%)"
 
-    text = (
-        f"Course: {course_name}\n"
-        f"Test: {test_name}\n"
-        "\n"
-        f"Points: {my_points}\n"
-        "\n"
-    )
+    text = f"Course: {course_name}\nTest: {test_name}\n\nPoints: {my_points}\n\n"
     for teacher_name in teacher_names:
         text += f"Teacher: {teacher_name}\n"
     text += "\n"
@@ -121,35 +120,35 @@ def build_text(
     return text, email_subject
 
 
-def process_result(result: ResultWithoutDetails) -> None:
+def process_result(session: Smartschool, result: ResultWithoutDetails) -> None:
     assert len(result.courses) == 1, f"Multiple courses? {result.courses}"
 
     logger.info("[{}] Processing '{}'", result.courses[0].name, result.name)
 
     course_name = result.courses[0].name  # FE: 'Frans'
     id_ = result.identifier
 
-    status = save("punten", course_name, id_, result, is_punten_json_the_same)
+    status = save(session, "punten", course_name, id_, result, is_punten_json_the_same)
 
     if status == IsSaved.SAME:
         logger.debug(" => Already processed")
         return
 
     text, subject = build_text(result=result, is_update=status != IsSaved.NEW)
-    send_email(subject=subject, text=text, email_from=session.creds.other_info['email_from'], email_to=session.creds.other_info['email_to'])
+    send_email(subject=subject, text=text, email_from=session.creds.other_info["email_from"], email_to=session.creds.other_info["email_to"])
 
 
 def main():
     try:
-        Smartschool.start(PathCredentials())
-        assert 'email_from' in session.creds.other_info
-        assert 'email_to' in session.creds.other_info
+        session = Smartschool(PathCredentials())
+        assert "email_from" in session.creds.other_info
+        assert "email_to" in session.creds.other_info
 
-        for result in Results():
-            process_result(result)
-    except DownloadError:
+        for result in Results(session):
+            process_result(session, result)
+    except SmartSchoolDownloadError:
         ...
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

src/smartschool/__init__.py

@@ -1,7 +1,7 @@
 from .agenda import SmartschoolHours, SmartschoolLessons, SmartschoolMomentInfos
 from .courses import Courses, TopNavCourses
 from .credentials import EnvCredentials, PathCredentials
-from .exceptions import DownloadError, SmartSchoolAuthenticationError, SmartSchoolException
+from .exceptions import SmartSchoolAuthenticationError, SmartSchoolDownloadError, SmartSchoolException
 from .future_tasks import FutureTasks
 from .messages import (
     AdjustMessageLabel,
@@ -26,7 +26,6 @@
     "Attachments",
     "BoxType",
     "Courses",
-    "DownloadError",
     "EnvCredentials",
     "FutureTasks",
     "MarkMessageUnread",
@@ -40,6 +39,7 @@
     "ResultDetail",
     "Results",
     "SmartSchoolAuthenticationError",
+    "SmartSchoolDownloadError",
     "SmartSchoolException",
     "Smartschool",
     "SmartschoolHours",