From 1857bdefe97709f02ce496d2155e2b2c138af139 Mon Sep 17 00:00:00 2001 From: Stijn De Clercq Date: Fri, 6 Aug 2021 23:47:50 +0200 Subject: [PATCH] Rework schedule a bit to make it more maintainable & easier to code --- data/schedule.py | 88 ++++++++++++---- enums/{platforms.py => platform.py} | 17 +++- files/schedules/31.json | 149 ++++++++++++++-------------- functions/les_rework.py | 1 + 4 files changed, 161 insertions(+), 94 deletions(-) rename enums/{platforms.py => platform.py} (52%) diff --git a/data/schedule.py b/data/schedule.py index d489539..b661ff3 100644 --- a/data/schedule.py +++ b/data/schedule.py @@ -1,9 +1,10 @@ +import dacite from dacite import from_dict from dataclasses import dataclass, field from datetime import datetime, timedelta -from enums.platforms import Platforms +from enums.platform import Platform, get_platform from functions.config import get -from functions.timeFormatters import fromArray, forward_to_weekday +from functions.timeFormatters import fromArray, forward_to_weekday, intToWeekday import json from typing import Dict, Optional, List @@ -30,9 +31,7 @@ class Holiday: @dataclass class Course: - day: str - week: int - course_dict: Dict + name: str @dataclass @@ -51,8 +50,37 @@ class Timeslot: is_special: bool = False location: Optional[Location] = None online_link: Optional[str] = None - online_platform: Optional[Platforms] = None + online_platform: Optional[Platform] = None + @staticmethod + def from_slot_dict(slot_dict: Dict, course_dict: Dict, current_week: int): + """ + Construct a Timeslot from a dict of data + """ + if "weeks" in slot_dict and str(current_week) in slot_dict["weeks"]: + return Timeslot.special_from_dict(slot_dict, course_dict, str(current_week)) + + course = Course(course_dict["course"]) + start_time = slot_dict["time"]["start"] + end_time = slot_dict["time"]["end"] + + # Location can be none if a class is online-only + location = dacite.from_dict(Location, slot_dict["location"]) if "location" in slot_dict else None + + # Find platform & link if this class is online + online_platform: Platform = get_platform(slot_dict.get("online", None)) + online_link = course_dict["online_links"][Platform.value["rep"]] if online_platform is not None else None + + return Timeslot(course=course, start_time=start_time, end_time=end_time, canceled=False, is_special=False, + location=location, online_platform=online_platform, online_link=online_link) + + @staticmethod + def special_from_dict(slot_dict: Dict, course_dict: Dict, current_week: str): + """ + Create a SPECIAL Timeslot from a dict and data + """ + course = Course(course_dict["course"]) + # TODO @dataclass class Schedule: @@ -78,18 +106,21 @@ class Schedule: self.check_holidays() - # Store the target weekday (in case it exists) so we can ask for the next - # friday after the holiday, for example - target_weekday = -1 if not self.targetted_weekday else self.day.weekday() + # TODO show a custom embed when no class instead of fast-forwarding + # # Store the target weekday (in case it exists) so we can ask for the next + # # friday after the holiday, for example + # target_weekday = -1 if not self.targetted_weekday else self.day.weekday() + # + # # Show schedule for after holidays + # if self.current_holiday is not None: + # # Set day to day after holiday + # self.day = self.current_holiday.end_date_parsed + timedelta(days=1) + # + # # Find the next [DAY] after the holidays + # if target_weekday != -1: + # self.day = forward_to_weekday(self.day, target_weekday) - # Show schedule for after holidays - if self.current_holiday is not None: - # Set day to day after holiday - self.day = self.current_holiday.end_date_parsed + timedelta(days=1) - - # Find the next [DAY] after the holidays - if target_weekday != -1: - self.day = forward_to_weekday(self.day, target_weekday) + self._weekday_str = intToWeekday(self.day.weekday()) print(self.day) @@ -114,8 +145,8 @@ class Schedule: """ Load the schedule from the JSON file """ - semester = get("semester") - year = get("year") + semester = get_platform("semester") + year = get_platform("year") with open(f"files/schedules/{year}{semester}.json", "r") as fp: return json.load(fp) @@ -133,14 +164,29 @@ class Schedule: # Add +1 at the end because week 1 would be 0 as it's not over yet return (diff.days // 7) + self.holiday_offset + 1 - def find_slot_for_course(self, course_dict: Dict) -> List[Timeslot]: + def find_slots_for_course(self, course_dict: Dict, current_week: int) -> List[Timeslot]: """ Create time timeslots for a course """ - pass + slots_today = [] + + # First create a list of all slots of today + for slot in course_dict["slots"]: + # This slot is for a different day + if slot["time"]["day"] != self._weekday_str.lower(): + continue + + slots_today.append(slot) + + # Create Timeslots + slots_today = list(map(lambda x: Timeslot.from_slot_dict(x, course_dict, current_week), slots_today)) + + return slots_today def create_schedule(self): """ Create the schedule for the current week """ week: int = self.get_week() + slots: List[List[Timeslot]] = [self.find_slots_for_course(course, week) for course in self.schedule_dict["schedule"]] + slots_flattened = [item for sublist in slots for item in sublist] diff --git a/enums/platforms.py b/enums/platform.py similarity index 52% rename from enums/platforms.py rename to enums/platform.py index 7de21c1..b9a9520 100644 --- a/enums/platforms.py +++ b/enums/platform.py @@ -1,7 +1,8 @@ from enum import Enum +from typing import Optional -class Platforms(Enum): +class Platform(Enum): """ An Enum to represent online class platforms Name: The name of the platform @@ -11,3 +12,17 @@ class Platforms(Enum): MSTeams = {"name": "MS Teams", "rep": "msteams"} Ufora = {"name": "Ufora", "rep": "ufora"} Zoom = {"name": "Zoom", "rep": "zoom"} + + +def get_platform(rep: Optional[str]) -> Optional[Platform]: + """ + Find the platform that corresponds to the given name + """ + if rep is None: + return None + + for platform in Platform: + if platform.value["rep"] == rep: + return platform + + return None diff --git a/files/schedules/31.json b/files/schedules/31.json index 105e311..605459c 100644 --- a/files/schedules/31.json +++ b/files/schedules/31.json @@ -10,123 +10,128 @@ "schedule": [ { "course": "Computerarchitectuur", - "zoom": "https://ufora.ugent.be/d2l/ext/rp/228912/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826", - "msteams": "https://teams.microsoft.com/l/team/19%3ad7295f0bc4634a61b461504d4a7134b3%40thread.tacv2/conversations?groupId=8755cb96-1ef5-4ea3-b806-eeebf8a85ae8&tenantId=d7811cde-ecef-496c-8f91-a1786241b99c", + "online_links": { + "zoom": "https://ufora.ugent.be/d2l/ext/rp/228912/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826", + "msteams": "https://teams.microsoft.com/l/team/19%3ad7295f0bc4634a61b461504d4a7134b3%40thread.tacv2/conversations?groupId=8755cb96-1ef5-4ea3-b806-eeebf8a85ae8&tenantId=d7811cde-ecef-496c-8f91-a1786241b99c" + }, "slots": [ ] }, { "course": "Multimedia", - "zoom": "https://ugent-be.zoom.us/j/94248831947?pwd=ZCt4UnBLSzViZnFEQmkzWE5SYnF2QT09", + "online_links": { + "zoom": "https://ugent-be.zoom.us/j/94248831947?pwd=ZCt4UnBLSzViZnFEQmkzWE5SYnF2QT09" + }, "slots": [ { - "campus": "Sterre", - "building": "S9", - "room": "A3", - "time": [ - "woensdag", - 1130, - 1330 - ] + "location": { + "campus": "Sterre", + "building": "S9", + "room": "A3" + }, + "time": { + "day": "woensdag", + "start": 1130, + "end": 1330 + } }, { "online": "ZOOM", - "time": [ - "vrijdag", - 1300, - 1530 - ] + "time": { + "day": "vrijdag", + "start": 1300, + "end": 1530 + } } ] }, { "course": "Wetenschappelijk Rekenen", - "zoom": "https://ufora.ugent.be/d2l/ext/rp/236404/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826", + "online_links": { + "zoom": "https://ufora.ugent.be/d2l/ext/rp/236404/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826" + }, "slots": [ { "online": "ZOOM", - "time": [ - "dinsdag", - 1130, - 1300 - ] + "time": { + "day": "dinsdag", + "start": 1130, + "end": 1300 + } }, { "online": "ZOOM", - "time": [ - "woensdag", - 1500, - 1800 - ] + "time": { + "day": "woensdag", + "start": 1500, + "end": 1800 + } }, { "online": "ZOOM", - "time": [ - "donderdag", - 830, - 1000 - ] + "time": { + "day": "donderdag", + "start": 830, + "end": 1000 + } } ] }, { "course": "Software Engineering Lab 1", - "zoom": "https://ufora.ugent.be/d2l/ext/rp/235800/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826", - "msteams": "https://teams.microsoft.com/l/team/19%3a4dfd5b2fb1ae4aa9b72706aa3a0d6867%40thread.tacv2/conversations?groupId=256d5c58-5d53-43f5-9436-497b0c852c75&tenantId=d7811cde-ecef-496c-8f91-a1786241b99c", + "online_links": { + "zoom": "https://ufora.ugent.be/d2l/ext/rp/235800/lti/framedlaunch/556e197e-e87b-4c27-be5d-53adc7a41826", + "msteams": "https://teams.microsoft.com/l/team/19%3a4dfd5b2fb1ae4aa9b72706aa3a0d6867%40thread.tacv2/conversations?groupId=256d5c58-5d53-43f5-9436-497b0c852c75&tenantId=d7811cde-ecef-496c-8f91-a1786241b99c" + }, "slots": [ { "online": "MS Teams", - "time": [ - "dinsdag", - 1430, - 1700 - ] + "time": { + "day": "dinsdag", + "start": 1430, + "end": 1700 + } }, { "online": "MS Teams", - "time": [ - "vrijdag", - 830, - 1130 - ] + "time": { + "day": "vrijdag", + "start": 830, + "end": 1130 + } } ] }, { "course": "Webdevelopment", - "zoom": "https://ugent-be.zoom.us/j/93166767783?pwd=MWdvb1BnNnlPSnAyNk52QmRzdjcwdz09", + "online_links": { + "zoom": "https://ugent-be.zoom.us/j/93166767783?pwd=MWdvb1BnNnlPSnAyNk52QmRzdjcwdz09" + }, "slots": [ { - "campus": "Sterre", - "building": "S9", - "room": "A3", - "time": [ - "woensdag", - 900, - 1100 - ] - }, - { - "weeks": [ - 1 - ], - "canceled": true, - "campus": "Sterre", - "building": "S9", - "room": "A3", - "time": [ - "woensdag", - 900, - 1100 - ] + "weeks": { + "1": { + "canceled": true + } + }, + "location": { + "campus": "Sterre", + "building": "S9", + "room": "A3" + }, + "time": { + "day": "woensdag", + "start": 900, + "end": 1100 + } }, { "online": "ZOOM", - "time": [ - "donderdag", - 1000, - 1300 - ] + "time": { + "day": "donderdag", + "start": 1000, + "end": 1300 + } } ] } diff --git a/functions/les_rework.py b/functions/les_rework.py index 1682150..3c96154 100644 --- a/functions/les_rework.py +++ b/functions/les_rework.py @@ -24,6 +24,7 @@ def find_target_date(arg: Optional[str]) -> datetime: elif arg.lower() == "overmorgen": # Day after tomorrow's schedule day += timedelta(days=2) + # TODO show a different embed when "(over)morgen" is requested & it lands on a weekend # Don't land on a weekend day = skip_weekends(day)