119 行
5.0 KiB
Python
119 行
5.0 KiB
Python
from typing import TYPE_CHECKING, Optional, List
|
||
|
||
from yandex_music import YandexMusicObject
|
||
|
||
if TYPE_CHECKING:
|
||
from yandex_music import Client
|
||
|
||
|
||
class MixLink(YandexMusicObject):
|
||
"""Класс, представляющий ссылку (кликабельный блок) на подборку.
|
||
|
||
Note:
|
||
В цветах может как оказаться HEX (`#6c65a9`), так и какой-нибудь `transparent`.
|
||
|
||
Ссылка со схемой отличается от просто ссылки наличием `yandexmusic://` в начале.
|
||
|
||
Attributes:
|
||
title (:obj:`str`): Заголовок ссылки.
|
||
url (:obj:`str`): Ссылка на подборку.
|
||
url_scheme (:obj:`str`): Ссылка со схемой на подборку.
|
||
text_color (:obj:`str`): Цвет текста (HEX).
|
||
background_color (:obj:`str`): Цвет заднего фона.
|
||
background_image_uri (:obj:`str`): Ссылка на изображение заднего фона.
|
||
cover_white (:obj:`str`): Ссылка на изображение с обложкой TODO.
|
||
cover_uri (:obj:`str`): Ссылка на изображение с обложкой.
|
||
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
|
||
|
||
Args:
|
||
title (:obj:`str`): Заголовок ссылки.
|
||
url (:obj:`str`): Ссылка на подборку.
|
||
url_scheme (:obj:`str`): Ссылка со схемой на подборку.
|
||
text_color (:obj:`str`): Цвет текста (HEX).
|
||
background_color (:obj:`str`): Цвет заднего фона.
|
||
background_image_uri (:obj:`str`): Ссылка на изображение заднего фона.
|
||
cover_white (:obj:`str`): Ссылка на изображение с обложкой TODO.
|
||
cover_uri (:obj:`str`, optional): Ссылка на изображение с обложкой.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
**kwargs: Произвольные ключевые аргументы полученные от API.
|
||
"""
|
||
|
||
def __init__(self,
|
||
title: str,
|
||
url: str,
|
||
url_scheme: str,
|
||
text_color: str,
|
||
background_color: str,
|
||
background_image_uri: str,
|
||
cover_white: str,
|
||
cover_uri: Optional[str] = None,
|
||
client: Optional['Client'] = None,
|
||
**kwargs) -> None:
|
||
self.title = title
|
||
self.url = url
|
||
self.url_scheme = url_scheme
|
||
self.text_color = text_color
|
||
self.background_color = background_color
|
||
self.background_image_uri = background_image_uri
|
||
self.cover_white = cover_white
|
||
|
||
self.cover_uri = cover_uri
|
||
|
||
self.client = client
|
||
self._id_attrs = (self.url, self.title, self.url_scheme, self.text_color,
|
||
self.background_color, self.background_image_uri, self.cover_white)
|
||
|
||
super().handle_unknown_kwargs(self, **kwargs)
|
||
|
||
def download_background_image(self, filename: str, size: str = '200x200') -> None:
|
||
"""Загрузка заднего фона.
|
||
|
||
Args:
|
||
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
||
size (:obj:`str`, optional): Размер заднего фона.
|
||
"""
|
||
self.client.request.download(f'https://{self.background_image_uri.replace("%%", size)}', filename)
|
||
|
||
@classmethod
|
||
def de_json(cls, data: dict, client: 'Client') -> Optional['MixLink']:
|
||
"""Десериализация объекта.
|
||
|
||
Args:
|
||
data (:obj:`dict`): Поля и значения десериализуемого объекта.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
|
||
Returns:
|
||
:obj:`yandex_music.MixLink`: Блок-ссылка на подборку.
|
||
"""
|
||
if not data:
|
||
return None
|
||
|
||
data = super(MixLink, cls).de_json(data, client)
|
||
|
||
return cls(client=client, **data)
|
||
|
||
@classmethod
|
||
def de_list(cls, data: dict, client: 'Client') -> List['MixLink']:
|
||
"""Десериализация списка объектов.
|
||
|
||
Args:
|
||
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
|
||
Returns:
|
||
:obj:`list` из :obj:`yandex_music.MixLink`: Блоки-ссылки на подборки.
|
||
"""
|
||
if not data:
|
||
return []
|
||
|
||
mix_links = list()
|
||
for mix_link in data:
|
||
mix_links.append(cls.de_json(mix_link, client))
|
||
|
||
return mix_links
|
||
|
||
# camelCase псевдонимы
|
||
|
||
#: Псевдоним для :attr:`download_background_image`
|
||
downloadBackgroundImage = download_background_image
|