yandex-music-api/yandex_music/rotor/station.py

from typing import TYPE_CHECKING, Optional

from yandex_music import YandexMusicModel
from yandex_music.utils import model

if TYPE_CHECKING:
    from yandex_music import ClientType, Icon, Id, JSONType, Restrictions


@model
class Station(YandexMusicModel):
    """Класс, представляющий станцию.

    Note:
        `id_for_from` обозначает предка станции, например, жанр, настроение или занятие.
        Неизвестно когда используется `id_for_from`, а когда `parent_id`.

    Attributes:
        id (:obj:`yandex_music.Id`): Уникальный идентификатор станции.
        name (:obj:`str`): Название станции.
        icon (:obj:`yandex_music.Icon`): Иконка станции.
        mts_icon (:obj:`yandex_music.Icon`): Иконка TODO.
        geocell_icon (:obj:`yandex_music.Icon`): Иконка TODO.
        id_for_from (:obj:`str`): Категория (тип) станции.
        restrictions (:obj:`yandex_music.Restrictions`): Ограничения для настроек станции старого формата.
        restrictions2 (:obj:`yandex_music.Restrictions`): Ограничения для настроек станции.
        full_image_url (:obj:`str`, optional): Ссылка на полное изображение.
        mts_full_image_url (:obj:`str`, optional): Ссылка на полную иконку.
        parent_id (:obj:`yandex_music.Id`, optional): Уникальный идентификатор станции, являющейся предком текущей.
        client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
    """

    id: Optional['Id']
    name: str
    icon: 'Icon'
    mts_icon: 'Icon'
    geocell_icon: 'Icon'
    id_for_from: str
    restrictions: 'Restrictions'
    restrictions2: 'Restrictions'
    full_image_url: Optional[str] = None
    mts_full_image_url: Optional[str] = None
    parent_id: Optional['Id'] = None
    client: Optional['ClientType'] = None

    def __post_init__(self) -> None:
        self._id_attrs = (
            self.id,
            self.name,
            self.icon,
            self.mts_icon,
            self.geocell_icon,
            self.id_for_from,
            self.restrictions,
            self.restrictions2,
        )

    @classmethod
    def de_json(cls, data: 'JSONType', client: 'ClientType') -> Optional['Station']:
        """Десериализация объекта.

        Args:
            data (:obj:`dict`): Поля и значения десериализуемого объекта.
            client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.

        Returns:
            :obj:`yandex_music.Station`: Станция.
        """
        if not cls.is_dict_model_data(data):
            return None

        cls_data = cls.cleanup_data(data, client)
        from yandex_music import Icon, Id, Restrictions

        cls_data['id'] = Id.de_json(data.get('id'), client)
        cls_data['parent_id'] = Id.de_json(data.get('parent_id'), client)
        cls_data['icon'] = Icon.de_json(data.get('icon'), client)
        cls_data['mts_icon'] = Icon.de_json(data.get('mts_icon'), client)
        cls_data['geocell_icon'] = Icon.de_json(data.get('geocell_icon'), client)
        cls_data['restrictions'] = Restrictions.de_json(data.get('restrictions'), client)
        cls_data['restrictions2'] = Restrictions.de_json(data.get('restrictions2'), client)

        return cls(client=client, **cls_data)  # type: ignore