lms.model.courses

 1import typing
 2
 3import lms.model.base
 4import lms.model.query
 5
 6class CourseQuery(lms.model.query.BaseQuery):
 7    """
 8    A class for the different ways one can attempt to reference an LMS course.
 9    In general, a course can be queried by:
10     - LMS Course ID (`id`)
11     - Full Name (`name`)
12     - f"{name} ({id})"
13    """
14
15    _include_email = False
16
17class ResolvedCourseQuery(lms.model.query.ResolvedBaseQuery, CourseQuery):
18    """
19    A CourseQuery that has been resolved (verified) from a real course instance.
20    """
21
22    _include_email = False
23
24    def __init__(self,
25            course: 'Course',
26            **kwargs: typing.Any) -> None:
27        super().__init__(id = course.id, name = course.name, **kwargs)
28
29class Course(lms.model.base.BaseType):
30    """
31    A course.
32    """
33
34    CORE_FIELDS = [
35        'id', 'name',
36    ]
37
38    def __init__(self,
39            id: typing.Union[str, int, None] = None,
40            name: typing.Union[str, None] = None,
41            **kwargs: typing.Any) -> None:
42        super().__init__(**kwargs)
43
44        if (id is None):
45            raise ValueError("Course must have an id.")
46
47        self.id: str = str(id)
48        """ The LMS's identifier for this course. """
49
50        self.name: typing.Union[str, None] = name
51        """ The display name of this course. """
52
53    def to_query(self) -> ResolvedCourseQuery:
54        """ Get a query representation of this course. """
55
56        return ResolvedCourseQuery(self)