Models¶

All returned data is wrapped in typed, frozen dataclasses generated with marshmallow-dataclass. Each model has a .Schema attribute for serialisation/deserialisation.

Base¶

tju.models.base.Result ¶

Base class for a single typed result item. Each subclass carries a marshmallow Schema class attribute generated by marshmallow-dataclass.

Source code in src/tju/models/base.py

class Result:
    """Base class for a single typed result item.  Each subclass carries a
    marshmallow ``Schema`` class attribute generated by ``marshmallow-dataclass``."""

    Schema: ClassVar[Type["Schema"]] = Schema

tju.models.base.Results ¶

Bases: List[T_Result]

Typed list of :class:Result items. Subclasses set _item to the concrete dataclass and call :meth:load to deserialise a list of dicts.

Source code in src/tju/models/base.py

class Results(List[T_Result]):
    """Typed list of :class:`Result` items.  Subclasses set ``_item`` to the
    concrete dataclass and call :meth:`load` to deserialise a list of dicts."""

    _item: Type[T_Result]

    def __init__(self):
        super().__init__()

    def load(self, data: list):
        """Deserialise *data* (list of dicts) into typed items and extend this list."""
        schema = self._item.Schema(many=True)
        results = schema.load(data)
        if results is None:
            raise DataError("Failed to load data")
        self.extend(results)

load ¶

load(data: list)

Deserialise data (list of dicts) into typed items and extend this list.

Source code in src/tju/models/base.py

def load(self, data: list):
    """Deserialise *data* (list of dicts) into typed items and extend this list."""
    schema = self._item.Schema(many=True)
    results = schema.load(data)
    if results is None:
        raise DataError("Failed to load data")
    self.extend(results)

Common¶

tju.models.common.StuType ¶

Bases: Enum

Student Type

Source code in src/tju/models/common.py

class StuType(Enum):
    """Student Type"""

    UNDERGRADUATE = "本科生"
    GRADUATE = "研究生"

    def __str__(self):
        return self.value

    def __repr__(self):
        return self.value

tju.models.common.Gender ¶

Bases: Enum

Gender

Source code in src/tju/models/common.py

class Gender(Enum):
    """Gender"""

    MALE = "男"
    FEMALE = "女"

    def __str__(self):
        return self.value

    def __repr__(self):
        return self.value

Schedule¶

tju.models.schedule.Course ¶

Bases: Result

A course entry on a personal timetable. arrange holds the list of :class:CourseArrange slots; weeks is the raw week-range string.

Source code in src/tju/models/schedule.py

@dataclass(frozen=True)
class Course(Result):
    """A course entry on a personal timetable.  ``arrange`` holds the list of
    :class:`CourseArrange` slots; ``weeks`` is the raw week-range string."""

    class_id: Optional[str] = mfield(default=None)
    course_id: Optional[str] = mfield(default=None)
    name: Optional[str] = mfield(default=None)
    credit: Optional[float] = mfield(default=None)
    campus: Optional[str] = mfield(default=None)
    weeks: Optional[str] = mfield(default=None)
    arrange: Optional[list[CourseArrange]] = mfield(default=None)
    teacher: Optional[list] = mfield(default=None)

    class Meta:
        unknown = EXCLUDE

tju.models.schedule.CourseArrange ¶

Bases: Result

A single scheduled slot (day / period / location) for a course.

Source code in src/tju/models/schedule.py

@dataclass(frozen=True)
class CourseArrange(Result):
    """A single scheduled slot (day / period / location) for a course."""

    teacher: Optional[list] = mfield(default=None)
    week: Optional[list] = mfield(default=None)
    unit: Optional[list] = mfield(default=None)
    weekday: Optional[int] = mfield(default=None)
    location: Optional[str] = mfield(default=None)

tju.models.schedule.Schedule ¶

Bases: Results[Course]

List of :class:Course items representing a personal timetable.

Source code in src/tju/models/schedule.py

class Schedule(Results[Course]):
    """List of :class:`Course` items representing a personal timetable."""

    _item = Course

Course library¶

tju.models.course.LibCourse ¶

Bases: Course

A course entry from the public course library. Extends :class:~tju.models.schedule.Course with library-specific fields such as lession_id, course_type, enrollment limits, and has_syllabus. The selected/limit fields are populated for UG courses (16-column format) but are None for GS courses (12-column format).

Source code in src/tju/models/course.py

@dataclass(frozen=True, base_schema=LoadDumpSchema)
class LibCourse(Course):
    """A course entry from the public course library.  Extends :class:`~tju.models.schedule.Course`
    with library-specific fields such as ``lession_id``, ``course_type``, enrollment limits,
    and ``has_syllabus``.  The ``selected``/``limit`` fields are populated for UG courses
    (16-column format) but are ``None`` for GS courses (12-column format)."""
    # key in Course
    class_id: Optional[str] = mfield(default=None, data_key="课程序号")
    course_id: Optional[str] = mfield(default=None, data_key="课程代码")
    name: Optional[str] = mfield(default=None, data_key="课程名称")
    credit: Optional[float] = mfield(default=None, data_key="学分")
    campus: Optional[str] = mfield(default=None, data_key="开课校区")
    weeks: Optional[str] = mfield(default=None, data_key="起止周")
    arrange: Optional[list[CourseArrange]] = mfield(default=None)
    teacher: Optional[list] = mfield(default=None, data_key="教师")
    # key in LibCourse
    semester: Optional[str] = mfield(default=None)
    lession_id: Optional[str] = mfield(default=None)
    course_type: Optional[list] = mfield(default=None, data_key="课程类别")
    teaching_class: Optional[list] = mfield(default=None, data_key="教学班")
    selected: Optional[int] = mfield(default=None, data_key="实际")
    limit: Optional[int] = mfield(default=None, data_key="总上限")
    extra_limit: Optional[int] = mfield(default=None, data_key="计划外人数上限")
    is_extra_open: Annotated[Optional[bool], ChineseBool] = mfield(default=None, data_key="是否开放计划外")
    hours: Optional[float] = mfield(default=None, data_key="总学时")
    week_hours: Optional[float] = mfield(default=None, data_key="周学时")
    has_syllabus: Annotated[Optional[bool], ChineseHasBool] = mfield(default=None, data_key="课程大纲")

    class Meta:
        unknown = EXCLUDE

tju.models.course.CourseLib ¶

Bases: Results[LibCourse]

List of :class:LibCourse items from the public course library.

Source code in src/tju/models/course.py

class CourseLib(Results[LibCourse]):
    """List of :class:`LibCourse` items from the public course library."""

    _item = LibCourse

Exam¶

tju.models.exam.Exam ¶

Bases: Result

A single exam entry. exam_time is a list of two datetime.time objects (start, end); exam_date is a datetime.date.

Source code in src/tju/models/exam.py

@dataclass(frozen=True, base_schema=LoadDumpSchema)
class Exam(Result):
    """A single exam entry.  ``exam_time`` is a list of two ``datetime.time`` objects
    (start, end); ``exam_date`` is a ``datetime.date``."""

    class_id: Optional[str] = mfield(default=None, data_key="课程序号")
    name: Optional[str] = mfield(default=None, data_key="课程名称")
    exam_type: Optional[str] = mfield(default=None, data_key="考试类别")
    exam_date: Annotated[Optional[date], DatetimeField] = mfield(default=None, data_key="考试日期")
    exam_category: Optional[str] = mfield(default=None, data_key="批次")
    exam_time: Annotated[Optional[list], ExamTimeField] = mfield(default=None, data_key="考试安排")
    location: Optional[str] = mfield(default=None, data_key="考试地点")
    seat: Optional[str] = mfield(default=None, data_key="考场座位号")
    status: Optional[str] = mfield(default=None, data_key="考试情况")
    notice: Optional[str] = mfield(default=None, data_key="其它说明")

    class Meta:
        unknown = EXCLUDE

tju.models.exam.Exams ¶

Bases: Results[Exam]

List of :class:Exam items from the exam schedule page.

Source code in src/tju/models/exam.py

class Exams(Results[Exam]):
    """List of :class:`Exam` items from the exam schedule page."""

    _item = Exam