yandex-music-api/yandex_music/shot/shot_data.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, JSONType, ShotType


@model
class ShotData(YandexMusicModel):
    """Класс, представляющий основную информацию о шоте.

    Attributes:
        cover_uri (:obj:`str`): Ссылка на обложку шота (иконка Алисы).
        mds_url (:obj:`str`): Ссылка на аудиоверсию шота в озвучке от Алисы.
        shot_text (:obj:`str`): Текстовая версия шота.
        shot_type (:obj:`yandex_music.ShotType`): Тип шота.
        client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
    """

    cover_uri: str
    mds_url: str
    shot_text: str
    shot_type: 'ShotType'
    client: Optional['ClientType'] = None

    def __post_init__(self) -> None:
        self._id_attrs = (self.cover_uri, self.mds_url, self.shot_text, self.shot_type)

    def get_cover_url(self, size: str = '200x200') -> str:
        """Возвращает URL обложки.

        Args:
            size (:obj:`str`, optional): Размер обложки.

        Returns:
            :obj:`str`: URL обложки.
        """
        return f'https://{self.cover_uri.replace("%%", size)}'

    def download_cover(self, filename: str, size: str = '200x200') -> None:
        """Загрузка обложки.

        Args:
            filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
            size (:obj:`str`, optional): Размер обложки.
        """
        assert self.valid_client(self.client)
        self.client.request.download(self.get_cover_url(size), filename)

    async def download_cover_async(self, filename: str, size: str = '200x200') -> None:
        """Загрузка обложки.

        Args:
            filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
            size (:obj:`str`, optional): Размер обложки.
        """
        assert self.valid_async_client(self.client)
        await self.client.request.download(self.get_cover_url(size), filename)

    def download_mds(self, filename: str) -> None:
        """Загрузка аудиоверсии шота.

        Args:
            filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
        """
        assert self.valid_client(self.client)
        self.client.request.download(self.mds_url, filename)

    async def download_mds_async(self, filename: str) -> None:
        """Загрузка аудиоверсии шота.

        Args:
            filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
        """
        assert self.valid_async_client(self.client)
        await self.client.request.download(self.mds_url, filename)

    def download_cover_bytes(self, size: str = '200x200') -> bytes:
        """Загрузка обложки и возврат в виде байтов.

        Args:
            size (:obj:`str`, optional): Размер обложки.

        Returns:
            :obj:`bytes`: Обложка в виде байтов
        """
        assert self.valid_client(self.client)
        return self.client.request.retrieve(self.get_cover_url(size))

    async def download_cover_bytes_async(self, size: str = '200x200') -> bytes:
        """Загрузка обложки и возврат в виде байтов.

        Args:
            size (:obj:`str`, optional): Размер обложки.

        Returns:
            :obj:`bytes`: Обложка в виде байтов
        """
        assert self.valid_async_client(self.client)
        return await self.client.request.retrieve(self.get_cover_url(size))

    def download_mds_bytes(self) -> bytes:
        """Загрузка аудиоверсии шота и возврат в виде байтов.

        Returns:
            :obj:`bytes`: Аудиоверсия шота в виде байтов
        """
        assert self.valid_client(self.client)
        return self.client.request.retrieve(self.mds_url)

    async def download_mds_bytes_async(self) -> bytes:
        """Загрузка аудиоверсии шота и возврат в виде байтов.

        Returns:
            :obj:`bytes`: Аудиоверсия шота в виде байтов
        """
        assert self.valid_async_client(self.client)
        return await self.client.request.retrieve(self.mds_url)

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

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

        Returns:
            :obj:`yandex_music.ShotData`: Основная информация о шоте.
        """
        if not cls.is_dict_model_data(data):
            return None

        cls_data = cls.cleanup_data(data, client)
        from yandex_music import ShotType

        cls_data['shot_type'] = ShotType.de_json(data.get('shot_type'), client)

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

    # camelCase псевдонимы

    #: Псевдоним для :attr:`get_cover_url`
    getCoverUrl = get_cover_url
    #: Псевдоним для :attr:`download_cover`
    downloadCover = download_cover
    #: Псевдоним для :attr:`download_cover_async`
    downloadCoverAsync = download_cover_async
    #: Псевдоним для :attr:`download_mds`
    downloadMds = download_mds
    #: Псевдоним для :attr:`download_mds_async`
    downloadMdsAsync = download_mds_async
    #: Псевдоним для :attr:`download_cover_bytes`
    downloadCoverBytes = download_cover_bytes
    #: Псевдоним для :attr:`download_cover_bytes_async`
    downloadCoverBytesAsync = download_cover_bytes_async
    #: Псевдоним для :attr:`download_mds_bytes`
    downloadMdsBytes = download_mds_bytes
    #: Псевдоним для :attr:`download_mds_bytes_async`
    downloadMdsBytesAsync = download_mds_bytes_async