Files
schedule-generator/scheduleGenerator/generator.py
T
2022-06-20 22:32:15 -07:00

618 lines
22 KiB
Python

#!/usr/bin/env python3
import json
import math
import random
from inspect import currentframe
# Import from custom utilities
from util.mockStudents import getSampleStudents
from util.generateCourses import getSampleCourses
'''
Block 1-5 is first semester while
block 6-10 is second semester
schedule example:
schedule: {
"block1": "className",
"block2": "className",
"block3": "className",
...
}
running example:
running: {
"block1": {
classCode: {
"className": name,
"students": [student Name]
},
classCode: {
"className": name,
"students": [student Name]
}
},
...
}
'''
def getLineNumber(): return currentframe().f_back.f_lineno
# Takes in information to create or add a new conflict
# Returns if the particular student has a previous error
def newConflict(pupilNum: str, email: str, conflictType: str, code: str, description: str, logs: dict) -> bool:
exists = True if pupilNum in logs else False
if exists: logs[pupilNum].append({
"Pupil #": pupilNum,
"Email": email,
"Type": conflictType,
"Code": code,
"Conflict": description
})
else:
logs[pupilNum] = [{
"Pupil #": pupilNum,
"Email": email,
"Type": conflictType,
"Code": code,
"Conflict": description
}]
return exists
minReq, median, classCap = 18, 24, 30
activeCourses = {}
running = {
"block1": {},
"block2": {},
"block3": {},
"block4": {},
"block5": {},
"block6": {},
"block7": {},
"block8": {},
"block9": {},
"block10": {}
}
# These are the codes for Flex (spare) blocks
# Semester 1 and 2
flex = ["XAT--12A-S", "XAT--12B-S"]
# V3 differs a lot by V1/2 as it does not focus on fitting the classes
# into the time table first.
# It starts by trying to get all classes full and give all students a full class list.
# Then it starts to attempt to fit all classes into a timetable, making corretions along
# the way. Corrections being moving a students class
def generateScheduleV3(
students: list,
courses: dict,
blockClassLimit: int=40,
studentsDir: str="../output/students.json",
conflictsDir: str="../output/conflicts.json"
) -> dict[str, dict]:
def equal(l: list) -> list: # Used to equalize list of numbers
q,r = divmod(sum(l),len(l))
return [q+1]*r + [q]*(len(l)-r)
# Step 1 - Calculate which classes can run
for student in students:
# Tally class request
for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
code = request["CrsNo"]
courses[code]["Requests"] += 1
# Add course to active list if enough requests
if courses[code]["Requests"] > minReq and courses[code]["CrsNo"] not in activeCourses:
activeCourses[code] = courses[code]
# Step 2 - Generate empty classes
allClassRunCounts = []
courseRunInfo = {} # Generated now, used in step 4
emptyClasses = {} # List of all classes with how many students should be entered during step 3
# calculate # of times to run class
for i in range(len(activeCourses)):
index = list(activeCourses)[i]
if index not in emptyClasses: emptyClasses[index] = {}
classRunCount = math.floor(activeCourses[index]["Requests"] / median)
remaining = activeCourses[index]["Requests"] % median
# Put # of classRunCount classes in emptyClasses
for j in range(classRunCount):
emptyClasses[index][f"{index}-{j}"] = {
"CrsNo": index,
"Description": activeCourses[index]["Description"],
"expectedLen": median # Number of students expected in this class / may be altered
}
# If remaining fit in open slots in existing classes
if remaining <= classRunCount * (classCap - median):
# Equally disperse remaining into existing classes
while remaining > 0:
for j in range(classRunCount):
if remaining == 0: break
emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
remaining -= 1
# If we can create a class using remaining, but no other classes
# exists, create class, and do not equalize
elif remaining >= minReq:
# Create a class using remaining
emptyClasses[index][f"{index}-{classRunCount}"] = {
"CrsNo": index,
"Description": activeCourses[index]["Description"],
"expectedLen": remaining
}
classRunCount += 1
if classRunCount >= 2:
# Equalize (level) class expectedLen's
expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
newExpectedLens = equal(expectedLengths)
for j in range(len(newExpectedLens)):
emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
# Else if we can't fit remaining in open slots in existing classes
# and it is unable to create its own class,
# and requiered number to make a class is less than the max number we can provide from existing classes
elif minReq - remaining < classRunCount * (median - minReq):
# Take 1 from each class till min requirment met
for j in range(classRunCount):
emptyClasses[index][f"{index}-{j}"]["expectedLen"] -= 1
remaining += 1
if remaining == minReq: break
# Create a class using remaining
emptyClasses[index][f"{index}-{classRunCount}"] = {
"CrsNo": index,
"Description": activeCourses[index]["Description"],
"expectedLen": remaining
}
classRunCount += 1
# Equalize (level) class expectedLen's
expectedLengths = [emptyClasses[index][f"{index}-{j}"]["expectedLen"] for j in range(classRunCount)]
newExpectedLens = equal(expectedLengths)
for j in range(len(newExpectedLens)):
emptyClasses[index][f"{index}-{j}"]["expectedLen"] = newExpectedLens[j]
else:
# In the case that the remaining requests are unable to be resolved
# Fill as many requests into class as possible, any left that can't fit,
# Will need to be ignored so later we can fold them into their alternative
# choices
for j in range(classRunCount):
if emptyClasses[index][f"{index}-{j}"]["expectedLen"] < classCap and remaining > 0:
emptyClasses[index][f"{index}-{j}"]["expectedLen"] += 1
remaining -= 1
courseRunInfo[index] = {
"Total": classRunCount,
"CrsNo": index
}
allClassRunCounts.append(classRunCount)
# Step 3 Fill emptyClasses with Students
selectedCourses = {}
tempStudents = list(students)
while len(tempStudents) > 0:
student = tempStudents[random.randint(0, len(tempStudents)-1)]
alternates = [request for request in student["requests"] if request["alt"]]
for request in (request for request in student["requests"] if not request["alt"] and request["CrsNo"] not in flex):
course = request["CrsNo"]
getAvailableCourse = True
isAlt = False
while getAvailableCourse:
if course in emptyClasses:
# if course exists, get first available class
for cname in emptyClasses[course]:
if cname in selectedCourses:
if isAlt and emptyClasses[course][cname]["expectedLen"] < classCap:
emptyClasses[course][cname]["expectedLen"] += 1
if len(selectedCourses[cname]["students"]) < emptyClasses[course][cname]["expectedLen"]:
# Class exists with room for student
selectedCourses[cname]["students"].append({
"Pupil #": student["Pupil #"],
"index": student["studentIndex"]
})
getAvailableCourse = False
break
elif len(selectedCourses[cname]["students"]) == emptyClasses[course][cname]["expectedLen"]:
# If class is full, and is last class of that course
if cname[len(cname)-1] == f"{len(emptyClasses[course])-1}":
if len(alternates) > 0:
# Use alternate
course = alternates[0]["CrsNo"]
alternates.remove(alternates[0])
isAlt = True
break
else:
# Force break loop, ignore and let an admin
# handle options to solve for missing class
getAvailableCourse = False
break
elif cname not in selectedCourses:
selectedCourses[cname] = {
"students": [{
"Pupil #": student["Pupil #"],
"index": student["studentIndex"]
}],
"CrsNo": course,
"Description": courses[course]["Description"]
}
getAvailableCourse = False
break
elif course not in emptyClasses:
if len(alternates) > 0:
# Use alternate
course = alternates[0]["CrsNo"]
alternates.remove(alternates[0])
isAlt = True
else:
# Force break loop, ignore and let an admin
# handle options to solve for missing class
getAvailableCourse = False
students[student["studentIndex"]]["remainingAlts"] = alternates
tempStudents.remove(student)
# Step 4 - Attempt to fit classes into timetable
def stepIndex(offset: int, stepType: int) -> int:
# stepType 0 is for stepping between first and second semester
if stepType == 0:
if offset == 0 or offset == -4: return 5
else: return -4
# stepType 1 is for stepping between second and first semester
elif stepType == 1:
if offset == 0 or offset == 6: return -5
else: return 6
# Return Error if code is altered to cause error
else: raise SystemExit(f"Invalid 'stepType' in func 'stepIndex' line {getLineNumber()}")
while len(allClassRunCounts) > 0:
# Get highest resource class (most times run)
index = allClassRunCounts.index(min(allClassRunCounts))
course = list(courseRunInfo)[index]
# Tally first and second semester
sem1, sem2 = 0, 0
sem1List, sem2List = {}, {}
for i in range(1, 11):
if i <= 5:
sem1 += len(running[f"block{i}"])
sem1List[f"block{i}"] = running[f"block{i}"]
elif i > 5:
sem2 += len(running[f"block{i}"])
sem2List[f"block{i}"] = running[f"block{i}"]
# If there is more than one class Running
if allClassRunCounts[index] > 1:
blockIndex = 0 if sem1 <= sem2 else 5
stepType = 0 if sem1 <= sem2 else 1
offset = 0
# Spread classes throughout both semesters
for i in range(courseRunInfo[course]["Total"]):
cname = f"{course}-{i}"
classInserted = False
while not classInserted:
blockIndex += offset
if len(running[list(running)[blockIndex]]) < blockClassLimit:
running[list(running)[blockIndex]][cname] = {
"CrsNo": course,
"Description": emptyClasses[course][cname]["Description"],
"students": selectedCourses[cname]["students"]
}
allClassRunCounts[index] -= 1
classInserted = True
offset = stepIndex(offset, stepType)
if blockIndex >= 9:
blockIndex = 0 if sem1 <= sem2 else 5
offset = 0
# If the class only runs once, place in semester with least classes
elif allClassRunCounts[index] == 1:
# Equally disperse into semesters classes
semBlocks = []
offset = 1
if sem1 <= sem2:
for block in sem1List:
semBlocks.append(len(block))
# If sem1 is less than or equal to sem2, add to sem1
if sem1 <= sem2: [semBlocks.append(len(block)) for block in sem1List]
# If sem2 is less than sem1, add to sem2
elif sem1 > sem2: [semBlocks.append(len(block)) for block in sem2List]
# Get block with least classes
leastBlock = semBlocks.index(min(semBlocks))
cname = f"{course}-0"
running[f"block{leastBlock+offset}"][course] = {
"CrsNo": course,
"Description": emptyClasses[course][cname]["Description"],
"students": selectedCourses[cname]["students"],
}
allClassRunCounts[index] -= 1
# Remove course when fully inserted
if allClassRunCounts[index] == 0:
allClassRunCounts.remove(allClassRunCounts[index])
courseRunInfo.pop(list(courseRunInfo)[index])
# Step 5 - Fill student schedule
for block in running:
for cname in running[block]:
for student in running[block][cname]["students"]:
students[student["index"]]["schedule"][block].append(cname)
students[student["index"]]["classes"] += 1
# Step 6 - Evaluate, move students to fix conflicts
conflictLogs = {}
criticalCount, acceptableCount = 0, 0
c_mc_count, c_cr_count, a_mc_count = 0, 0, 0
studentsCritical, studentsAcceptable = 0, 0
for student in students:
initialBlocks = [student["schedule"][block] for block in student["schedule"]]
conflicts = sum(1 for b in initialBlocks if len(b)>1)
hasConflicts = True if conflicts > 0 else False
# If there is no conflicts
# and classes inserted to is equal to expectedClasses
# or classes the student is inserted to is missing
# no more than two classes:
# continue to next student
if not hasConflicts and student["classes"] == student["expectedClasses"]: continue
elif not hasConflicts and (student["expectedClasses"]-2) <= student["classes"] < student["expectedClasses"]:
a_mc_count += 1
acceptableCount += 1
if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
continue
studentData = {
"Pupil #": student["Pupil #"],
"index": student["studentIndex"]
}
# If we are unable to solve, we add to exceptions
# and keep trying to resolve the rest of the schedule
exceptions = []
while hasConflicts:
# Check if conflicts have been resolved
blocks = [student["schedule"][block] for block in student["schedule"]]
# If there is exceptions, make them look normal in blocks
# list to ginore them when looking for clashes, and not to
# accidently overwrite while evaluating other classes
if len(exceptions) > 0:
for i in range(len(blocks)):
if i in exceptions: blocks[i] = ['EXPT']
conflicts = sum(1 for b in blocks if len(b)>1)
if conflicts == 0: hasConflicts = False
elif conflicts > 0:
blockLens = [len(block) for block in blocks]
freeBlocks = [index for index in range(len(blocks)) if len(blocks[index]) == 0]
clashIndex = blockLens.index(max(blockLens))
blockOut = f"block{clashIndex+1}"
classIndex = 0
done, advancedConflict = False, False
while not done:
classOut = blocks[clashIndex][classIndex]
found = False
for index in freeBlocks:
if found: break
if index != clashIndex:
blockIn = list(running)[index]
for cname in running[blockIn]:
if cname[:-2] == classOut[:-2] and len(running[blockIn][cname]["students"]) < classCap:
# Update records
student["schedule"][blockOut].remove(classOut)
student["schedule"][blockIn].append(cname)
running[blockOut][classOut]["students"].remove(studentData)
running[blockIn][cname]["students"].append(studentData)
found = True
break
if not found:
if classIndex < len(blocks[clashIndex])-1: classIndex += 1
elif classIndex == len(blocks[clashIndex])-1:
classIndex = 0
advancedConflict = True
done = True
else:
print(f"Fatal error ({getLineNumber()}): Impossible error")
continue
elif found: done = True
if advancedConflict:
attemptResolve = True
classOutIndex = 0
while attemptResolve:
foundSolution = False
newClassOut = blocks[clashIndex][classOutIndex]
for blockIndex in range(len(running)):
if foundSolution: break
if blockIndex != clashIndex and blockIndex not in exceptions:
for cname in running[list(running)[blockIndex]]:
if cname[:-2] == newClassOut[:-2]:
blockIn = f"block{blockIndex+1}"
if blockIndex in freeBlocks:
if len(running[blockIn][cname]["students"]) < classCap:
# In the rare or impossible case a student was not inserted to a class
# And it weren't full, insert them into the class
student["schedule"][blockOut].remove(newClassOut)
student["schedule"][blockIn].append(cname)
running[blockOut][newClassOut]["students"].remove(studentData)
running[blockIn][cname]["students"].append(studentData)
foundSolution = True
break
elif len(blocks[blockIndex]) == 1:
oClassOut = blocks[blockIndex][0]
found_oBlockSolution = False
for oBlockIndex in range(len(running)):
if found_oBlockSolution: break
if oBlockIndex != clashIndex and oBlockIndex not in exceptions and oBlockIndex in freeBlocks:
for ocname in running[list(running)[oBlockIndex]]:
if ocname[:-2] == oClassOut[:-2]:
oBlockIn = f"block{oBlockIndex+1}"
if len(running[oBlockIn][ocname]["students"]) < classCap:
student["schedule"][blockOut].remove(newClassOut)
student["schedule"][blockIn].append(cname)
student["schedule"][blockIn].remove(oClassOut)
student["schedule"][oBlockIn].append(ocname)
running[blockOut][newClassOut]["students"].remove(studentData)
running[blockIn][cname]["students"].append(studentData)
running[blockIn][oClassOut]["students"].remove(studentData)
running[oBlockIn][ocname]["students"].append(studentData)
found_oBlockSolution = True
break
if not found_oBlockSolution:
exceptions.append(clashIndex)
criticalCount += 1
c_cr_count += 1
if not newConflict(student["Pupil #"], "", "Critial", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
foundSolution = True
break
if not foundSolution:
if classOutIndex < len(blocks[clashIndex]) - 1: classOutIndex += 1
elif classOutIndex == len(blocks[clashIndex]) - 1:
if len(student["remainingAlts"]) > 0:
exceptions.append(clashIndex)
criticalCount += 1
c_cr_count += 1
if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
attemptResolve = False
# Attempt to use alt
elif len(student["remainingAlts"]) == 0:
exceptions.append(clashIndex)
criticalCount += 1
c_cr_count += 1
if not newConflict(student["Pupil #"], "", "Critical", "C-CR", "Couldn't Resolve", conflictLogs): studentsCritical += 1
attemptResolve = False
else: print("Impossible - Thanos")
elif foundSolution:
attemptResolve = False
else:
print(f"Fatal error ({getLineNumber()}): Impossible error")
continue
metSelfRequirements = True if student["classes"] == student["expectedClasses"] else False
while not metSelfRequirements:
if (student["expectedClasses"] - 2) <= student["classes"] < student["expectedClasses"]:
a_mc_count += 1
acceptableCount += 1
if not newConflict(student["Pupil #"], "", "Acceptable", "A-MC", "Missing 1-2 Classses", conflictLogs): studentsAcceptable += 1
break
elif student["classes"] < (student["expectedClasses"] - 2):
# Difference between classes inserted to and
# expected classes is too great, attempt to fix
if student["Pupil #"] in conflictLogs:
c_mc_count += 1
criticalCount += 1
if not newConflict(student["Pupil #"], "", "Critical", "C-MC", "Missing too many Classses", conflictLogs): studentsCritical += 1
break
else:
print(f"Fatal error ({getLineNumber()}): Impossible error")
continue
finalConflictLogs = {
"Conflicts": conflictLogs,
"Critical": {
"Total": criticalCount,
"Students": studentsCritical,
"Errors": [{
"Total": c_mc_count,
"Description": "Missing too many Classes",
"Code": "C-MC"
}, {
"Total": c_cr_count,
"Description": "Couldn't Resolve",
"Code": "C-CR"
}]
},
"Acceptable": {
"Total": acceptableCount,
"Students": studentsAcceptable,
"Errors": [{
"Total": a_mc_count,
"Description": "Missing 1-2 Classes",
"Code": "A-MC"
}]
}
}
# Log Conflict to records
with open(conflictsDir, "w") as outfile:
json.dump(finalConflictLogs, outfile, indent=2)
for student in students:
for block in student["schedule"]:
if len(student["schedule"][block]) == 0:
if int(block[len(block)-1]) <= 5: student["schedule"][block].append(flex[0])
elif int(block[len(block)-1]) > 5: student["schedule"][block].append(flex[1])
# Update Student records
with open(studentsDir, "w") as outfile:
json.dump(students, outfile, indent=2)
return running
if __name__ == '__main__':
print("Processing...")
sampleStudents = getSampleStudents(True)
samplemockCourses = getSampleCourses(True)
timetable = {}
timetable["Version"] = 3
timetable["timetable"] = generateScheduleV3(sampleStudents, samplemockCourses)
with open("../output/timetable.json", "w") as outfile:
json.dump(timetable, outfile, indent=2)
print("Done")