pyceo/ceo_common/model/Term.py

import datetime

import ceo_common.utils as utils


class Term:
    """A representation of a term in the CSC LDAP, e.g. 's2021'."""

    seasons = ['w', 's', 'f']

    def __init__(self, s_term: str):
        assert len(s_term) == 5 and s_term[0] in self.seasons and \
            s_term[1:].isdigit()
        self.s_term = s_term

    def __repr__(self):
        return self.s_term

    @staticmethod
    def from_datetime(dt: datetime.datetime):
        """Get a Term object for the given date."""
        idx = (dt.month - 1) // 4
        c = Term.seasons[idx]
        s_term = c + str(dt.year)
        return Term(s_term)

    @staticmethod
    def current():
        """Get a Term object for the current date."""
        dt = utils.get_current_datetime()
        return Term.from_datetime(dt)

    def start_month(self):
        return self.seasons.index(self.s_term[0]) * 4 + 1

    def __add__(self, other):
        assert type(other) is int
        c = self.s_term[0]
        season_idx = self.seasons.index(c)
        year = int(self.s_term[1:])
        season_idx += other
        year += season_idx // 3
        season_idx %= 3
        s_term = self.seasons[season_idx] + str(year)
        return Term(s_term)

    def __sub__(self, other):
        assert type(other) is int
        return self.__add__(-other)

    def __eq__(self, other):
        return isinstance(other, Term) and self.s_term == other.s_term

    def __lt__(self, other):
        if not isinstance(other, Term):
            return NotImplemented
        c1, c2 = self.s_term[0], other.s_term[0]
        year1, year2 = int(self.s_term[1:]), int(other.s_term[1:])
        return year1 < year2 or (
            year1 == year2 and self.seasons.index(c1) < self.seasons.index(c2)
        )

    def __gt__(self, other):
        if not isinstance(other, Term):
            return NotImplemented
        c1, c2 = self.s_term[0], other.s_term[0]
        year1, year2 = int(self.s_term[1:]), int(other.s_term[1:])
        return year1 > year2 or (
            year1 == year2 and self.seasons.index(c1) > self.seasons.index(c2)
        )

    def __ge__(self, other):
        return self > other or self == other

    def __le__(self, other):
        return self < other or self == other

    def to_datetime(self) -> datetime.datetime:
        c = self.s_term[0]
        year = int(self.s_term[1:])
        month = self.seasons.index(c) * 4 + 1
        day = 1
        return datetime.datetime(year, month, day)