79 lines
2.8 KiB
Python
79 lines
2.8 KiB
Python
from collections import namedtuple
|
|
import logging
|
|
import os
|
|
|
|
from path import path
|
|
import yaml
|
|
|
|
log = logging.getLogger('mitx.courseware.courses')
|
|
|
|
_FIELDS = ['number', # 6.002x
|
|
'title', # Circuits and Electronics
|
|
'short_title', # Circuits
|
|
'run_id', # Spring 2012
|
|
'path', # /some/absolute/filepath/6.002x --> course.xml is in here.
|
|
'instructors', # ['Anant Agarwal']
|
|
'institution', # "MIT"
|
|
'grader', # a courseware.graders.CourseGrader object
|
|
|
|
#'start', # These should be datetime fields
|
|
#'end'
|
|
]
|
|
|
|
class CourseInfoLoadError(Exception):
|
|
pass
|
|
|
|
class Course(namedtuple('Course', _FIELDS)):
|
|
"""Course objects encapsulate general information about a given run of a
|
|
course. This includes things like name, grading policy, etc.
|
|
"""
|
|
@property
|
|
def id(self):
|
|
return "{0.institution},{0.number},{0.run_id}".format(self).replace(" ", "_")
|
|
|
|
@classmethod
|
|
def load_from_path(cls, course_path):
|
|
course_path = path(course_path) # convert it from string if necessary
|
|
try:
|
|
with open(course_path / "course_info.yaml") as course_info_file:
|
|
course_info = yaml.load(course_info_file)
|
|
summary = course_info['course']
|
|
summary.update(path=course_path, grader=None)
|
|
return cls(**summary)
|
|
except Exception as ex:
|
|
log.exception(ex)
|
|
raise CourseInfoLoadError("Could not read course info: {0}:{1}"
|
|
.format(type(ex).__name__, ex))
|
|
|
|
def load_courses(courses_path):
|
|
"""Given a directory of courses, returns a list of Course objects. For the
|
|
sake of backwards compatibility, if you point it at the top level of a
|
|
specific course, it will return a list with one Course object in it.
|
|
"""
|
|
courses_path = path(courses_path)
|
|
def _is_course_path(p):
|
|
return os.path.exists(p / "course_info.yaml")
|
|
|
|
log.info("Loading courses from {0}".format(courses_path))
|
|
|
|
# Compatibility: courses_path is the path for a single course
|
|
if _is_course_path(courses_path):
|
|
log.warning("course_info.yaml found in top-level ({0})"
|
|
.format(courses_path) +
|
|
" -- assuming there is only a single course.")
|
|
return [Course.load_from_path(courses_path)]
|
|
|
|
# Default: Each dir in courses_path is a separate course
|
|
courses = []
|
|
log.info("Reading courses from {0}".format(courses_path))
|
|
for course_dir_name in os.listdir(courses_path):
|
|
course_path = courses_path / course_dir_name
|
|
if _is_course_path(course_path):
|
|
log.info("Initializing course {0}".format(course_path))
|
|
courses.append(Course.load_from_path(course_path))
|
|
|
|
return courses
|
|
|
|
def create_lookup_table(courses):
|
|
return dict((c.id, c) for c in courses)
|