feat: changed exam schedule return type

Author: Udhay-Adithya

src/exam_schedule.py

@@ -1,14 +1,15 @@
+from typing import List, Dict
 from .constants import *
 import time
 from .parsers import exam_schedule_parser
 
-def get_exam_schedule(session, username: str, semesterSubId: str, csrf_token) -> dict:
+def get_exam_schedule(session, username: str, semesterSubId: str, csrf_token) -> List[Dict]:
     """
     Retrieves the exam schedule for a specific user and semester.
 
     This function sends two HTTP POST requests to the VTOP system. The first request verifies the user's session,
     and the second request retrieves the exam schedule for the specified semester. The HTML content is parsed using
-    a custom parser to extract and organize the exam schedule details into a dictionary.
+    a custom parser to extract and organize the exam schedule details into a list of dictionaries.
 
     Parameters:
         session (requests.Session): 
@@ -21,8 +22,8 @@ def get_exam_schedule(session, username: str, semesterSubId: str, csrf_token) ->
             The CSRF token required to authenticate the request.
 
     Returns:
-        dict: 
-            A dictionary containing the parsed exam schedule details, including course codes, exam dates, and timings.
+        list[dict]:
+            A list containing the parsed exam schedule details, including course codes, exam dates, and timings.
     """
     data = {
         "verifyMenu": "true",

src/parsers/exam_schedule_parser.py

@@ -1,15 +1,17 @@
+from typing import List, Dict
 from bs4 import BeautifulSoup
+from collections import defaultdict
 
 
-def parse_exam_schedule(html: str) -> dict:
+def parse_exam_schedule(html: str) -> List[Dict]:
     soup = BeautifulSoup(html, "html.parser")
     schedule_table = soup.find("table")
 
     if not schedule_table:
-        return {"error ": "No timetable found"}
+        return [{"error": "No timetable found"}]
 
     rows = schedule_table.find_all("tr")
-    exam_schedule = {}
+    exam_schedule = defaultdict(list)
     current_exam_type = None
 
     for row in rows:
@@ -19,13 +21,13 @@ def parse_exam_schedule(html: str) -> dict:
         # Skip rows that don't contain enough values or are headers
         if len(values) == 1:
             current_exam_type = values[0]
-            exam_schedule[current_exam_type] = {}
             continue
         elif len(values) < 13 or "S.No." in values:
             continue
 
         # Construct the data dictionary
         exam_entry = {
+            "serial_number": values[0],
             "course_code": values[1],
             "course_title": values[2],
             "type": values[3],
@@ -40,7 +42,17 @@ def parse_exam_schedule(html: str) -> dict:
             "seat_number": values[12],
         }
 
-        # Add the entry to the dictionary under the current exam type
-        exam_schedule[current_exam_type][values[0]] = exam_entry
+        # Add the entry to the list under the current exam type
+        if current_exam_type:
+            exam_schedule[current_exam_type].append(exam_entry)
 
-    return exam_schedule
+    # Convert defaultdict to a list of dictionaries
+    result = [
+        {
+            "exam_type": exam_type,
+            "subjects": subjects
+        }
+        for exam_type, subjects in exam_schedule.items()
+    ]
+
+    return result