print preferred pronouns in the call list

[coldcallbot-discord.git] / coldcall.py

diff --git a/coldcall.py b/coldcall.py
index 1ba96a582b24104b2c35b4a225eab89c553a8fef..3fb79d663c7c694b751710e48ad0f64a8bbaaf13 100644 (file)
--- a/coldcall.py
+++ b/coldcall.py
@@ -8,20 +8,29 @@ from csv import DictReader
 
 import os.path
 import re
+import json
 
 class ColdCall():
     def __init__ (self, record_attendance=True):
+        with open("configuration.json") as config_file:
+            config = json.loads(config_file.read())
+
         self.today = str(datetime.date(datetime.now()))
+
         # how much less likely should it be that a student is called upon?
         self.weight = 2
         self.record_attendance = record_attendance
 
         # filenames
-        self.__fn_studentinfo = "data/student_information.tsv"
-        self.__fn_daily_calllist = f"data/call_list-{self.today}.tsv"
-        self.__fn_daily_attendance = f"data/attendance-{self.today}.tsv"
+        self.__fn_studentinfo = config["student_info_file"]
+        self.__fn_daily_calllist = config["daily_calllist_file"].format(date=self.today)
+        self.__fn_daily_attendance = config["daily_attendance"].format(date=self.today)
 
-        self.preferred_names = self.__get_preferred_names()
+        self.unique_row = config["unique_name_rowname"]
+        if "preferred_name_rowname" in config:
+            self.preferred_row = config["preferred_name_rowname"]
+        else:
+            self.preferred_row = None
         
     def __load_prev_questions(self):
         previous_questions = defaultdict(int)
@@ -31,28 +40,29 @@ class ColdCall():
                 with open(f"./data/{fn}", 'r') as f:
                     for row in DictReader(f, delimiter="\t"):
                         if not row["answered"] == "FALSE":
-                            previous_questions[row["unique_name"]] += 1
+                            previous_questions[row[self.unique_row]] += 1
 
         return previous_questions
 
-    def __get_preferred_names(self):
+    def get_preferred_names(self):
         # translate the unique name into the preferred students name,
         # if possible, otherwise return the unique name
 
         preferred_names = {}
         with open(self.__fn_studentinfo, 'r') as f:
             for row in DictReader(f, delimiter="\t"):
-                preferred_names[row["Your username on the class Teams server"]] = row["Name you'd like to go by in class"]
+                preferred_names[row[self.unique_row]] = row[self.preferred_row]
 
         return(preferred_names)
         
     def __get_preferred_name(self, selected_student):
-        if selected_student in self.preferred_names:
-            return self.preferred_names[selected_student]
+        preferred_names = self.get_preferred_names()
+        if selected_student in preferred_names:
+            return preferred_names[selected_student]
         else:
             return None
 
-    def __select_student_from_list (self, students_present):
+    def select_student_from_list(self, students_present):
         prev_questions = self.__load_prev_questions()
         
         # created a weighted list by starting out with everybody 1
@@ -67,7 +77,7 @@ class ColdCall():
         # print(weights) # DEBUG LINE
         return choices(list(weights.keys()), weights=list(weights.values()), k=1)[0]
 
-    def __record_attendance(self, students_present):
+    def record_attendance(self, students_present):
         # if it's the first one of the day, write it out
         if not os.path.exists(self.__fn_daily_attendance):
             with open(self.__fn_daily_attendance, "w") as f:
@@ -79,24 +89,28 @@ class ColdCall():
                              ",".join(students_present)]),
                   file=f)
 
-    def __record_coldcall(self, selected_student):
+    def record_coldcall(self, selected_student):
         # if it's the first one of the day, write it out
         if not os.path.exists(self.__fn_daily_calllist):
             with open(self.__fn_daily_calllist, "w") as f:
-                print("\t".join(["unique_name", "timestamp", "answered", "assessment"]), file=f)
+                print("\t".join([self.unique_row, self.preferred_row, "answered", "assessment", "timestamp"]), file=f)
+
+        preferred_name = self.__get_preferred_name(selected_student)
+        if preferred_name == None:
+            preferred_name = ""
 
         # open for appending the student
         with open(self.__fn_daily_calllist, "a") as f:
-            print("\t".join([selected_student, str(datetime.now()),
-                             "MISSING", "MISSING"]), file=f)
+            print("\t".join([selected_student, preferred_name,
+                             "MISSING", "MISSING", str(datetime.now())]), file=f)
 
     def coldcall(self, students_present):
-        selected_student = self.__select_student_from_list(students_present)
+        selected_student = self.select_student_from_list(students_present)
 
         # record the called-upon student in the right place
         if self.record_attendance:
-            self.__record_attendance(students_present)
-        self.__record_coldcall(selected_student)
+            self.record_attendance(students_present)
+        self.record_coldcall(selected_student)
 
         preferred_name = self.__get_preferred_name(selected_student)
         if preferred_name:
@@ -105,13 +119,3 @@ class ColdCall():
             coldcall_message = f"@{selected_student}, you're up!"
         return coldcall_message
 
-# cc = ColdCall()
-
-# test_student_list = ["jordan", "Kristen Larrick", "Madison Heisterman", "Maria.Au20", "Laura (Alia) Levi", "Leona Aklipi", "anne", "emmaaitelli", "ashleylee", "allie_partridge", "Tiana_Cole", "Hamin", "Ella Qu", "Shizuka", "Ben Baird", "Kim Do", "Isaacm24", "Sam Bell", "Courtneylg"]
-# print(cc.coldcall(test_student_list))
-
-# test_student_list = ["jordan", "Kristen Larrick", "Mako"]
-# print(cc.coldcall(test_student_list))
-
-# test_student_list = ["jordan", "Kristen Larrick"]
-# print(cc.coldcall(test_student_list))