add course dataclass

app/util/convertRawData.py

@@ -4,8 +4,11 @@ from app.util.globals import flex
 import xlsxwriter
 import docx
 
+from app.util.courses import Course
+from app.util.students import Student
+
 def putMasterTimetable(
-	table:		  dict, 
+	table:		  dict[str: dict], 
 	output_dir: str = './output/final'
 ) -> None:
 
@@ -36,8 +39,8 @@ def putMasterTimetable(
 	workbook.close()
 
 def putScheduleToWord(
-	courses: 		dict, 
-	student: 		dict, 
+	courses: 		dict[str: Course], 
+	student: 		Student, 
 	output_dir: str = './output/final/student_schedules'
 ) -> None:
 
@@ -64,7 +67,7 @@ def putScheduleToWord(
 	for block in student['schedule']:
 		courseCode = student.Schedule[block][0]
 		if courseCode in flex: courseName = 'Study'
-		else: courseName = courses[courseCode[:-2]]["Description"]
+		else: courseName = courses[courseCode[:-2]].Description
 		blockNum = int(block.split('block')[1])
 		semester = 2 if blockNum > 5 else 1
 		if blockNum > (len(student.Schedule)/2): blockNum -= (len(student.Schedule)/2)

app/util/courses.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3.11
 import json
 import csv
-from dataclasses import dataclass
+from dataclasses import dataclass, asdict
 from app.util.estimateGrade import getGrade
 
 @dataclass
@@ -10,45 +10,54 @@ class Request:
   Description: str
   Alt:         bool
 
+@dataclass
+class Course:
+  CrsNo:       str
+  Description: str
+  Grade:       int
+  Requests:    int = 0 # number of requests for this
+  Sem1:        int = 0 # number of classes running in sem1
+  Sem2:        int = 0 # number of classes running in sem2
+  Total:       int = 0 # total number of classes running
+  Seats:       int = 0 # total number of seats
+  Occupied:    int = 0 # number of occupied seats
+
+def coursesToDict(courses: dict[str: Course]) -> dict[str: dict]:
+  return [asdict(courses[c]) for c in courses]
+
 # Get all requested courses from data
 def getCourses(
   data_dir: str,
   log:      int = False,
   log_dir:  str = './output/raw/courses.json',
-) -> dict[dict[str: any]]:
+) -> dict[str: Course]:
 
-  courses = {}
+  courses: dict[str: Course] = {}
 
   with open(data_dir, newline='') as csvfile:
     reader = csv.DictReader(csvfile)
     for row in reader:
       exists = False
       for course in courses:
-        exists = True if courses[course]["CrsNo"] == row["CrsNo"] else False
+        exists = True if courses[course].CrsNo == row["CrsNo"] else False
         if exists: break
       if not exists:
         grade = getGrade(row["CrsNo"], row["Description"])
-        courses[row["CrsNo"]] = {
-          "CrsNo":       row["CrsNo"],
-          "Description": row["Description"],
-          "Grade":       grade,
-          "Requests":    0,
-          "Sem1":        0, # number of classes running in sem1
-          "Sem2":        0, # number of classes running in sem2
-          "Total":       0, # total number of classes running
-          "Seats":       0, # total number of seats
-          "Occupied":    0, # number of occupied seats
-        }
+        courses[row["CrsNo"]] = Course(
+          row["CrsNo"],
+          row["Description"],
+          grade
+        )
 
   if log:
     with open(log_dir, "w") as outfile:
-      json.dump(courses, outfile, indent=2)
+      json.dump(coursesToDict(courses), outfile, indent=2)
         
   return courses
 
 # Writes all course data to csv file
 def writeCoursesToCSV(
-  courses:    dict, 
+  courses:    dict[str: Course], 
   output_dir: str = './output/raw/csv/courses.csv'
 ) -> None:
   with open(output_dir, 'w') as file:
@@ -69,14 +78,14 @@ def writeCoursesToCSV(
 
     for course in courses:
       courseData = (
-        courses[course]["CrsNo"],
-        courses[course]["Description"],
-        courses[course]["Grade"],
-        courses[course]["Requests"],
-        courses[course]["Sem1"],
-        courses[course]["Sem2"],
-        courses[course]["Total"],
-        courses[course]["Seats"],
-        courses[course]["Occupied"]
+        courses[course].CrsNo,
+        courses[course].Description,
+        courses[course].Grade,
+        courses[course].Requests,
+        courses[course].Sem1,
+        courses[course].Sem2,
+        courses[course].Total,
+        courses[course].Seats,
+        courses[course].Occupied
       )
       writer.writerow(courseData)