lab3.py

# Var 9
# %%
# =============================================================================
from logging import debug, basicConfig, DEBUG
# basicConfig(level=DEBUG)
ID_KEY = "id"


# %%
# =============================================================================
class Meta(type):
    """Мета-класс
    Предназначен для получения экземпляра класса, обращаясь по ID.
    Если в поле ID передаётся сам экземпляр, то возвращяется этот экземпляр.
    Если экземпляра с таким ID нет, то возвращается `None`

    Например:
    >>> Subject[1]
    >>> Subject[Subject[1]] == Subject[1]
    """
    def __getitem__(cls, id):
        if isinstance(id, int):
            return cls._entity_dict.get(id, None)
        if isinstance(id, type(id)):
            return id
        return None

    def __delitem__(cls, item):
        """Удаление экземпляра класса по его ID

        >>> Subject("Some name", 1, 1, "")
        ... Subject[1]
        >>> del Subject[1]
        >>> Subject[1]
        ... None
        """
        return cls[item].__del__()


# =============================================================================
class Entity(dict, metaclass=Meta):
    """Класс Entity
    Предназначен для более простого создания новых классов
    для учёта в базе данных
    """
    _last_id = 0  # Последний ID в "таблице" БД
    _entity_dict = None  # type: dict
    # Используется для хранения значений в БД "таблицы"

    _watchers = []  # Список экземпляров для рекурсивного удаления
    __slots__ = (ID_KEY,)  # Список возможных аргументов и "ключей"

    def __init__(self):
        dict.__init__(self)
        self._setting_id()
        cls = self.__class__
        if cls._entity_dict is None:
            cls._entity_dict = {}
        self.__class__._entity_dict[self.id] = self

    # def __hash__(self):
    #     return str(self.id)

    def _setting_id(self):
        self.__class__._last_id += 1
        dict.__setitem__(self, ID_KEY, self.__class__._last_id)

    def __del__(self):
        """Удаление экземпляра класса

        >>> subject = Subject("Some name", 1, 1, "")
        ... Subject[1]
        >>> del subject
        >>> Subject[1]
        ... None
        """
        w = self._watchers.copy()
        self._watchers.clear()
        for e in w:
            e.__del__()

        ed = self.__class__._entity_dict
        debug("Delete: %s, %s", self.id, ed)

        if self.id in ed:
            del ed[self.id]
    
    # Для пользовательского вызова `entity.delete()`
    delete = __del__

    def __repr__(self) -> str:
        """Технический вывод
        >>> repr(Subject[1]) == "Subject[1]"

        Returns:
            str: Результат для "технического вывода"
        """
        self.is_exist(True)
        return "%s[%r]" % (
            self.__class__.__name__,
            self.id,
        )

    def __setitem__(self, item: str, value):
        """Сеттер

        >>> subject = Subject("Some name", 1, 1, "")
        >>> subject['name'] = "Some new name"
        >>> subject['name']
        ... "Some new name"

        Args:
            item (str): Ключ
            value (Any[str, int]): Значение
        """
        if item in self.__slots__ and item != ID_KEY:
            debug("Setting value: %r[%r] = %r", self, item, value)
            return dict.__setitem__(self, item, value)

        if item in dir(Entity):
            return super().__setattr__(item, value)

    # Связывание утсановки значений через . и []
    __setattr__ = __setitem__

    def __getitem__(self, item: str):
        """Геттер

        >>> subject = Subject("Some name", 1, 1, "")
        >>> subject['name'] == "Some name"
        >>> subject.name == "Some name"

        Args:
            item (str): Ключ

        Returns:
            Any: Значение по ключу
        """

        if item in dir(Entity) and item != "id":
            return super().__getattribute__(item)

        if item in super().__getattribute__("__slots__"):
            if item not in ("is_exist", ID_KEY, "__class__"):
                self.is_exist(True)
                debug("Getting value: %r.%s", self, item)

            res = dict.__getitem__(self, item)

            if isinstance(res, Entity) and not res.is_exist():
                self[item] = None
                return None
            return res

    # Связывание получения значений через . и []
    __getattribute__ = __getitem__

    def recursive_delete(self, entity: "Entity"):
        """Рекурсивное удаление
        Позволяет удалить объект `entity`, когда удаляется объект

        >>> subject = Subject("name", 1, 1, "form")
        ... Subject[1]
        >>> departament = Departament("name", 1, subject)
        ... Departament[1]
        >>> del departament
        >>> Subject[1]
        ... None

        Args:
            entity (Entity): Экземпляр класса, которого стоит удалить вместе с
            данным экземпляром

        Returns:
            Entity: Возвращяает `self`
        """
        entity._watchers.append(self)
        return self

    def is_exist(self, raise_error=False) -> bool:
        """Проверка на наличие объекта в БД

        >>> s = Subject("name", 1, 1, "form")
        ... Subject[1]
        >>> s.is_exist() == True
        >>> del Subject[1]
        >>> s.is_exist() == False

        Args:
            raise_error (bool, optional): Выбрасывать ошибку?
            Defaults to False.

        Raises:
            ValueError: Если объект не существует

        Returns:
            bool: Существует или нет
        """
        if self.id not in self.__class__._entity_dict:
            if raise_error:
                raise ValueError("object '%s[%r]' was been deleted" % (
                    self.__class__.__name__,
                    self.id
                ))
            return False
        return True


# =============================================================================
# Дисциплина
class Subject(Entity):
    __slots__ = (ID_KEY, "name", "lectures_count", "practices_count",
                 "control_form")

    def __init__(self, name: str, lectures_count: int, practices_count: int,
                 control_form: str):
        super().__init__()
        self["name"] = name
        self["lectures_count"] = lectures_count
        self["practices_count"] = practices_count
        self["control_form"] = control_form


# =============================================================================
# Кафедра
class Departament(Entity):
    __slots__ = (ID_KEY, "name", "teacher_count", "subject")

    def __init__(self, name: str, teacher_count: int, subject: Subject or int):
        super().__init__()
        self.name = name
        self.teacher_count = teacher_count

        self.subject = Subject[subject].recursive_delete(self)


# %%
# =============================================================================
# Тестирование

print("Проверка на создание объектов:")
s1 = Subject("Название дисциплины", 1, 1, "форма контроля")
d1 = Departament("Название Кафедры", 1, s1)
print(s1, d1)
print(" ======== ")

print("Вывод через атрибут:", s1.name, sep='\t')
print("Вывод через ключ:", s1['name'], sep='\t')
s1.name += " 2"
print("Вывод изменённого имени:", s1.name, sep='\t')
print(" ======== ")

# %%
# =============================================================================
print("Проверка на удаление дисциплины:")
print(Subject[1])
del Subject[1]
print("Удалено")
print(Subject[1] is None)
print(" ======== ")

try:
    print("Проверка на отсутствие данных в переменной:")
    print(s1)
except ValueError:
    print("Проверка прошла успешно!")

print(" ======== ")
print("Проверка на отсутствие данных дисциплины на кафедре:")
print(d1["subject"])
print(" ======== ")

# %%
# =============================================================================
print("Проверка на каскадное удаление объектов:")

s2 = Subject("Название новой дисциплины", 1, 1, "форма контроля")
d2 = Departament("Название Кафедры 2", 1, s2)
print(s2, d1)
print(" ======== ")
print("Удаление кафедры")
del Departament[2]
print("Проверка на отсутсвие дисциплины и направления:")
print(Departament[2] is None)
print(s2.is_exist() is False)
print(" ======== ")

# TODO: Сделать создание самой бд в CSV