add a typed dict so that the set meta has the right types

Author: notionparallax

marking_and_admin/mark_functions.py

@@ -22,6 +22,7 @@
 from google.auth.transport.requests import Request
 from google_auth_oauthlib.flow import InstalledAppFlow
 from googleapiclient.discovery import build
+from marker import set_meta
 from pandas import DataFrame, Series
 
 
@@ -627,7 +628,7 @@ def get_last_commit(row: Series) -> str:
         # TODO: find out why I was returning a no commits error
 
 
-def mark_week(
+def mark_set(
     mark_sheet: DataFrame,
     set_number: int = 1,
     timeout: int = 10,
@@ -666,12 +667,12 @@ def do_the_marking(
     force_marking=False,
     marking_spreadsheet_id: str = "16tESt_4BUf-9-oD04suTprkd1O0oEl6WjzflF_avSKY",  # 2022
     marks_csv: str = "marks.csv",
-    w1: dict[str, int | bool] = {"timeout": 5, "active": False},
-    w2: dict[str, int | bool] = {"timeout": 5, "active": False},
-    w3: dict[str, int | bool] = {"timeout": 5, "active": False},
-    w4: dict[str, int | bool] = {"timeout": 5, "active": False},
-    w5: dict[str, int | bool] = {"timeout": 5, "active": False},
-    exam: dict[str, int | bool] = {"timeout": 5, "active": False},
+    set_1: set_meta = {"timeout": 5, "active": False},
+    set_2: set_meta = {"timeout": 5, "active": False},
+    set_3: set_meta = {"timeout": 5, "active": False},
+    set_4: set_meta = {"timeout": 5, "active": False},
+    set_5: set_meta = {"timeout": 5, "active": False},
+    exam: set_meta = {"timeout": 5, "active": False},
     test_number_of_students: int = 0,
     force_repos: list[str] = [],
 ) -> None:
@@ -728,22 +729,22 @@ def do_the_marking(
     mark_sheet["updated"] = mark_sheet.apply(update_repos, axis=1)
     mark_sheet["last_commit"] = mark_sheet.apply(get_last_commit, axis=1)
 
-    mark_sheet["set1"] = mark_week(
-        mark_sheet, set_number=1, timeout=w1["timeout"], active=w1["active"]
+    mark_sheet["set1"] = mark_set(
+        mark_sheet, set_number=1, timeout=set_1["timeout"], active=set_1["active"]
     )
-    mark_sheet["set2"] = mark_week(
-        mark_sheet, set_number=2, timeout=w2["timeout"], active=w2["active"]
+    mark_sheet["set2"] = mark_set(
+        mark_sheet, set_number=2, timeout=set_2["timeout"], active=set_2["active"]
     )
-    mark_sheet["set3"] = mark_week(
-        mark_sheet, set_number=3, timeout=w3["timeout"], active=w3["active"]
+    mark_sheet["set3"] = mark_set(
+        mark_sheet, set_number=3, timeout=set_3["timeout"], active=set_3["active"]
     )
-    mark_sheet["set4"] = mark_week(
-        mark_sheet, set_number=4, timeout=w4["timeout"], active=w4["active"]
+    mark_sheet["set4"] = mark_set(
+        mark_sheet, set_number=4, timeout=set_4["timeout"], active=set_4["active"]
     )
-    mark_sheet["set5"] = mark_week(
-        mark_sheet, set_number=5, timeout=w5["timeout"], active=w5["active"]
+    mark_sheet["set5"] = mark_set(
+        mark_sheet, set_number=5, timeout=set_5["timeout"], active=set_5["active"]
     )
-    mark_sheet["exam"] = mark_week(
+    mark_sheet["exam"] = mark_set(
         mark_sheet, set_number=8, timeout=exam["timeout"], active=exam["active"]
     )
     mark_sheet.drop(["name"], axis=1, errors="ignore", inplace=True)
@@ -797,6 +798,9 @@ def convert_one_results_dict_to_an_int(results_dict) -> int:
             convert_one_results_dict_to_an_int
         )
 
+    mark_sheet["exam_data"] = mark_sheet[f"exam"]
+    mark_sheet[f"exam"] = mark_sheet[f"exam"].apply(convert_one_results_dict_to_an_int)
+
 
 def get_student_data():
     students = None

marking_and_admin/marker.py

@@ -6,9 +6,18 @@
 """
 import os
 import sys
+from typing import TypedDict
 
 from mark_functions import do_the_marking
 
+
+class set_meta(TypedDict):
+    """week is just to keep the typechecker happy."""
+
+    timeout: int
+    active: bool
+
+
 MARKING_SPREADSHEET_ID = os.getenv("GOOGLE_SHEETS_KEY", "")
 
 
@@ -22,12 +31,12 @@
         force_marking=True,
         marking_spreadsheet_id=MARKING_SPREADSHEET_ID,
         marks_csv="marking_and_admin/marks.csv",
-        mark_w1={"timeout":15, "active":True},
-        mark_w2={"timeout":15, "active":True},
-        mark_w3={"timeout":30, "active":True},
-        mark_w4={"timeout":50, "active":True},
-        mark_w5={"timeout":50, "active":False},
-        mark_exam={"timeout":45, "active":True},
+        set_1={"timeout": 15, "active": True},
+        set_2={"timeout": 15, "active": True},
+        set_3={"timeout": 30, "active": True},
+        set_4={"timeout": 50, "active": True},
+        set_5={"timeout": 50, "active": False},
+        exam={"timeout": 45, "active": True},
         test_number_of_students=0,  # if more than 0, will only mark a sample of N repos
         force_repos=["lvl-lim", "JeWang"],
     )