coldcall.py

   1 #!/usr/bin/env python3
   2
   3 from collections import defaultdict
   4 from datetime import datetime
   5 from random import choices
   6 from os import listdir
   7 from csv import DictReader
   8
   9 import os.path
  10 import re
  11 import json
  12
  13 class ColdCall():
  14     def __init__ (self, record_attendance=True):
  15         with open("configuration.json") as config_file:
  16             config = json.loads(config_file.read())
  17
  18         self.today = str(datetime.date(datetime.now()))
  19         # how much less likely should it be that a student is called upon?
  20         self.weight = 2
  21         self.record_attendance = record_attendance
  22
  23         # filenames
  24         self.__fn_studentinfo = config["student_info_file"]
  25         self.__fn_daily_calllist = config["daily_calllist_file"].format(date=self.today)
  26         self.__fn_daily_attendance = config["daily_attendance"].format(date=self.today)
  27
  28         self.unique_row = config["unique_name_rowname"]
  29         if "preferred_name_rowname" in config:
  30             self.preferred_row = config["preferred_name_rowname"]
  31         else:
  32             self.preferred_row = None
  33
  34     def __load_prev_questions(self):
  35         previous_questions = defaultdict(int)
  36
  37         for fn in listdir("./data/"):
  38             if re.match("call_list-\d{4}-\d{2}-\d{2}.tsv", fn):
  39                 with open(f"./data/{fn}", 'r') as f:
  40                     for row in DictReader(f, delimiter="\t"):
  41                         if not row["answered"] == "FALSE":
  42                             previous_questions[row[self.unique_row]] += 1
  43
  44         return previous_questions
  45
  46     def __get_preferred_names(self):
  47         # translate the unique name into the preferred students name,
  48         # if possible, otherwise return the unique name
  49
  50         preferred_names = {}
  51         with open(self.__fn_studentinfo, 'r') as f:
  52             for row in DictReader(f, delimiter="\t"):
  53                 preferred_names[row[self.unique_row]] = row[self.preferred_row]
  54
  55         return(preferred_names)
  56
  57     def __get_preferred_name(self, selected_student):
  58         if selected_student in self.preferred_names:
  59             return self.preferred_names[selected_student]
  60         else:
  61             return None
  62
  63     def select_student_from_list(self, students_present):
  64         prev_questions = self.__load_prev_questions()
  65
  66         # created a weighted list by starting out with everybody 1
  67         weights = {s : 1 for s in students_present}
  68
  69         for s in students_present:
  70             for i in range(0, prev_questions[s]):
  71                 # reduce the weight by a factor of 1/weight each time the student has been called upon
  72                 weights[s] = weights[s] / self.weight
  73
  74         # choose one student from the weighted list
  75         # print(weights) # DEBUG LINE
  76         return choices(list(weights.keys()), weights=list(weights.values()), k=1)[0]
  77
  78     def record_attendance(self, students_present):
  79         # if it's the first one of the day, write it out
  80         if not os.path.exists(self.__fn_daily_attendance):
  81             with open(self.__fn_daily_attendance, "w") as f:
  82                 print("\t".join(["timestamp", "attendance_list"]), file=f)
  83
  84         # open for appending the student
  85         with open(self.__fn_daily_attendance, "a") as f:
  86             print("\t".join([str(datetime.now()),
  87                              ",".join(students_present)]),
  88                   file=f)
  89
  90     def record_coldcall(self, selected_student):
  91         # if it's the first one of the day, write it out
  92         if not os.path.exists(self.__fn_daily_calllist):
  93             with open(self.__fn_daily_calllist, "w") as f:
  94                 print("\t".join([self.unique_row, self.preferred_row, "answered", "assessment", "timestamp"]), file=f)
  95
  96         preferred_name = self.__get_preferred_name(selected_student)
  97
  98         # open for appending the student
  99         with open(self.__fn_daily_calllist, "a") as f:
 100             print("\t".join([selected_student, preferred_name,
 101                              "MISSING", "MISSING", str(datetime.now())]), file=f)
 102
 103     def coldcall(self, students_present):
 104         selected_student = self.select_student_from_list(students_present)
 105
 106         # record the called-upon student in the right place
 107         if self.record_attendance:
 108             self.record_attendance(students_present)
 109         self.record_coldcall(selected_student)
 110
 111         preferred_name = self.__get_preferred_name(selected_student)
 112         if preferred_name:
 113             coldcall_message = f"{preferred_name} (@{selected_student}), you're up!"
 114         else:
 115             coldcall_message = f"@{selected_student}, you're up!"
 116         return coldcall_message
 117