Skip to content

timetable.py

This script handles going through the timetables.

Packages Used

Timetable.calendars

A cache dictionary with user ID as keys and user's calendar as value.

Timetable.cal_url

The link to .ics calendar that requires authentication.

Timetable.tmzn

The timezone used to localise datetimes; it should be same to what the .ics is based on. Default: UTC

Timetable.fuzz_threshold

A threshold for string-matching when finding a specific class. Default: 36

Timetable.message_char_limit

Number of characters allowed by messaging service / platform in a single message. Default: 2000

Timetable.classes_per_msg

Number of classes in a single message if number of characters is exceeded and message is split. Default: 10

Timetable.login(uid, uni_id, uni_pw)

Logins in user with the provided credentials.
A request fetches content from a URL with authentication, and icalendar.Calendar creates a calendar from that content. If the operation was successful, the user was successfully logged in. If not, icalendar.Calendar throws an exception since the content was not suitable to create a calendar which means the credentials were unable to fetch content through the request; therefore the login was unsuccessful.

>>> login("1234567890", "123456Z", "password123")
False
APP: 1234567890 undergoing registration. Result: False
Parameters Returns
uid: the unique sender ID of the user
uni_id: the university ID of the user
uni_pw: the university password of the user		 bool: the login result

Timetable.format_event(event)

Formats calendar event in a presentable string.
The events in icalendar.Calendar are in the form of a dictionary. This function creates a string containing all necessary details about the event in a readable manner (example: datetime is not readable) and returns it.
Note: The formatting is according to how event conventions are for the University of Glasgow. For example, usually events are titled something like "OOSE2 (Laboratory) OOSE2 LB01" or "Computing Science - 1S (Lecture) CS1S Lecture.", therefore the unnecessary / repetitive words after "(Laboratory)" or "(Lecture)" are removed.

>>> format_event({"summary": "Python Tutorial", "dtstart": <20050404T080000Z>, 
                  "dtend": <20050404T090000Z>, "location": "Boyd Orr Building"})
📝 Python Tutorial
🕘 08:00AM - 09:00AM
📅 04 April 2005 (Monday)
📌 Boyd Orr Building
Parameters Returns
event: the icalendar.Calendar.event to format str: a string representation of the event

Timetable.parse_desc(event)

Breaks down essential information from the description of the event.
Note: The formatting is according to how event conventions are for the University of Glasgow. For example, usually events have description like

Course: Random Course Name
Class Type: Lecture
Lecturer: Orr, Dr Boyd
Details: Lecture.

>>> parse_desc(event)
{"Course": "Random Course Name", "Class Type": "Lecture", "Lecturer": "Orr, Dr Boyd", "Details": "Lecture."}
Parameters Returns
event: the icalendar.Calendar.event to format dict: information from the desc of the event

Timetable.read(uid, start_date=None, end_date=None, class_name=None)

Main function to be called from timetable and returns a message accordingly.

>>> read("123456Z", start_date="20060404T080000+01:00")
["There seem to be no classes. :D"]
Parameters Returns
uid: the unique sender ID of the user
start_date: date-time start parameter if found
end_date: date-time end parameter if found
class_name: class-name parameter if found		 list: list of events

Timetable.iterate(uid, start_date=None, end_date=None, class_name=None)

Iterates through all events in the calendar and returns events that start and end between the beginning of that date (00:00) and end of that date (23:59).

>>> iterate("123456Z", start_date="20050404T080000+01:00")
["📝 Python Tutorial\n🕘 08:00AM - 09:00AM\n📅 04 April 2005 (Monday)\n📌 Boyd Orr Building"]
Parameters Returns
uid: the unique sender ID of the user
start_date: date-time start parameter if found
end_date: date-time end parameter if found
class_name: class-name parameter if found		 list: list of events

Timetable.check_loggedIn(uid)

Checks that calendar exists for the user. This function enables integrity and checks if a icalendar.Calendar exists for a specific user. It not, the user is logged in again the background.

>>> check_loggedIn("123456Z")
True
Parameters Returns
uid: the unique sender ID of the user bool: if user's calendar is found