Assignments

  1from icalevents.icalevents import events
  2from datetime import datetime, timedelta, date
  3from pytz import utc, timezone
  4import html
  5
  6
  7class Assignments:
  8    """
  9    Assignments are retrieved from the myPARISH calendar webcal feed. The assumption is made that the calendar is
 10    first limited to only assignments, without other kinds of events. A list is created containing `Assignment` objects.
 11    """
 12    def __init__(self, start, end, url):
 13        """
 14        Constructor for `Assignments` class.
 15        :param start: datetime object -> start date for assignments list
 16        :param end: datetime object -> end date for assignments list
 17        :param url: str -> webcal url to myPARISH calendar
 18        """
 19        self.URL = url
 20        self.start_date = self.normalize_date(start)
 21        self.end_date = self.normalize_date(end)
 22        self.assignments = self.get_assignments()
 23
 24    def __str__(self):
 25        """
 26        String representation for `Assignments` objects
 27        :return: str
 28        """
 29        output = ''
 30
 31        for assignment in self.assignments:
 32            output += str(assignment) + '\n'
 33
 34        return output
 35
 36    def get_assignments(self):
 37        """
 38        Extract assignments from webcal feed and populate a list.
 39        :return: list -> list of `Assignment` objects [`Assignment`, `Assignment`, ...]
 40        """
 41        es = events(self.URL, start=self.start_date, end=self.end_date, fix_apple=True)
 42        es.sort()
 43        ret_list = []
 44        for event in es:
 45            start_time = self.normalize_date(event.start)
 46            ret_list.append(Assignment(start_time,
 47                                       html.unescape(self.get_course(event.summary)),
 48                                       html.unescape(self.get_name(event.summary))
 49                                       ))
 50        return ret_list
 51
 52    @staticmethod
 53    def normalize_date(dt):
 54        """
 55        Convert `date` or `datetime` to `datetime` with timezone.
 56        :param dt: date to normalize
 57        :return: date as `datetime` with timezone
 58        """
 59        if type(dt) is date:
 60            dt = datetime(dt.year, dt.month, dt.day, 0, 0)
 61        elif type(dt) is datetime:
 62            dt = dt
 63        else:
 64            raise ValueError("unknown type %s" % type(dt))
 65
 66        if not dt.tzinfo:
 67            dt = utc.localize(dt)
 68
 69        return dt
 70
 71    @staticmethod
 72    def get_course(summary):
 73        """
 74        Extract course name from `event.summary` property
 75        :param summary: `event.summary`
 76        :return: str -> name of course or `None`
 77        """
 78        if ':' in summary:
 79            course = summary[:summary.find(':')]
 80            return course.strip()
 81        return None
 82
 83    @staticmethod
 84    def get_name(summary):
 85        """
 86        Extract assignment name from `event.summary` property
 87        :param summary: `event.summary`
 88        :return: str -> name of assignment or `None`
 89        """
 90        if ':' in summary:
 91            name = summary[summary.find(':') + 1:]
 92            return name.strip()
 93        return None
 94
 95
 96class Assignment:
 97    """
 98    Class for each individual assignment.
 99    """
100    def __init__(self, d, c, n):
101        """
102        Constructor for `Assignment` class
103        :param d: datetime -> due date of assignment
104        :param c: str -> course name
105        :param n: str -> assignment name
106        """
107        self.date = d
108        self.course = c
109        self.name = n
110
111    def __str__(self):
112        """
113        String representation for `Assignment` objects
114        :return: str
115        """
116        return f'{datetime.date(self.date)} | {self.course} | {self.name}'
117
118
119def main():
120    """
121    This function executes only if this file is run directly. It is only present to show example usage.
122    Code that utilizes `Assignments` should be located in other files, not this one.
123    :return:
124    """
125    # Get URL from user. Possibly store in text file.
126    url = 'webcal://parish.myschoolapp.com/podium/feed/iCal.aspx?z=PBfWPW%2b7Bf8znQAnWIawKSUMruwMfYfE8DOy5Pq3KcqL5EEpKZ3SaFZKWyirslzw8uqEHM2%2bpImt5ve%2b8ykwEg%3d%3d'
127
128    # Also get these from user
129    start_yr = 2023
130    start_mth = 3
131    start_day = 6
132
133    end_yr = 2023
134    end_mth = 3
135    end_day = 15
136
137    # create Assignments object
138    my_assignments = Assignments(datetime(start_yr, start_mth, start_day), datetime(end_yr, end_mth, end_day), url)
139
140    # print assignments in a loop
141    # selection can be done on assignment properties
142    print('\nAssignments for Coding for OOP...')
143    for assignment in my_assignments.assignments:
144        if 'Coding for OOP' in assignment.course:
145            print(f'Date: {datetime.date(assignment.date)} | Course: {assignment.course} | Name: {assignment.name}')
146
147    # print all assignments
148    print('\nAll assignments...')
149    print(my_assignments)
150
151    print('Both printouts are limited to the date range given.')
152
153
154if __name__ == '__main__':
155    main()