2019-12-27 18:14:51 +09:00
|
|
|
|
from typing import TYPE_CHECKING, Optional, List
|
|
|
|
|
|
2020-01-26 21:19:22 +09:00
|
|
|
|
from yandex_music import YandexMusicObject
|
2023-01-11 18:50:33 +09:00
|
|
|
|
from yandex_music.exceptions import YandexMusicError
|
2021-09-19 22:47:19 +09:00
|
|
|
|
from yandex_music.utils import model
|
2020-01-26 21:19:22 +09:00
|
|
|
|
|
2019-12-27 18:14:51 +09:00
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
|
from yandex_music import Client
|
|
|
|
|
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
@model
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
class MixLink(YandexMusicObject):
|
2020-03-22 08:59:18 +09:00
|
|
|
|
"""Класс, представляющий ссылку (кликабельный блок) на подборку.
|
|
|
|
|
|
|
|
|
|
Note:
|
|
|
|
|
В цветах может как оказаться HEX (`#6c65a9`), так и какой-нибудь `transparent`.
|
|
|
|
|
|
|
|
|
|
Ссылка со схемой отличается от просто ссылки наличием `yandexmusic://` в начале.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
|
|
|
|
|
Attributes:
|
2020-03-22 08:59:18 +09:00
|
|
|
|
title (:obj:`str`): Заголовок ссылки.
|
|
|
|
|
url (:obj:`str`): Ссылка на подборку.
|
|
|
|
|
url_scheme (:obj:`str`): Ссылка со схемой на подборку.
|
|
|
|
|
text_color (:obj:`str`): Цвет текста (HEX).
|
|
|
|
|
background_color (:obj:`str`): Цвет заднего фона.
|
|
|
|
|
background_image_uri (:obj:`str`): Ссылка на изображение заднего фона.
|
2023-01-11 18:50:33 +09:00
|
|
|
|
cover_white (:obj:`str`, optional): Ссылка на изображение с обложкой TODO.
|
Добавлен новый класс LicenceTextPart.
Поля cheapest, title, family_sub, fb_image, fb_name, family, intro_period_duration, intro_price, start_period_duration, start_price, licence_text_parts для Product.
Поля storage_dir, duplicates для Album.
Поле subscribed для ArtistEvent.
Поле description для GeneratedPlaylist.
Поле genre для Event.
Поле show_in_regions для Genre.
Поле cover_uri для MixLink.
Поля og_description, top_artist для Playlist.
Поля full_image_url, mts_full_image_url для Station.
Документация и тесты к новым поля. #339
2020-06-07 05:48:32 +09:00
|
|
|
|
cover_uri (:obj:`str`, optional): Ссылка на изображение с обложкой.
|
Удаление избыточной информации (#247)
Классы: Account, AutoRenewable, PassportPhone, Permissions, Plus, Price,
Product, Status, Subscription, UserSettings, Album, Label,
TrackPosition, Playlist
У всех классов изменено описание атрибута client
2020-03-22 04:49:20 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
"""
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
title: str
|
|
|
|
|
url: str
|
|
|
|
|
url_scheme: str
|
|
|
|
|
text_color: str
|
|
|
|
|
background_color: str
|
|
|
|
|
background_image_uri: str
|
2023-01-11 18:50:33 +09:00
|
|
|
|
cover_white: Optional[str] = None
|
2021-09-19 22:47:19 +09:00
|
|
|
|
cover_uri: Optional[str] = None
|
|
|
|
|
client: Optional['Client'] = None
|
|
|
|
|
|
|
|
|
|
def __post_init__(self):
|
2021-02-03 21:28:10 +09:00
|
|
|
|
self._id_attrs = (
|
|
|
|
|
self.url,
|
|
|
|
|
self.title,
|
|
|
|
|
self.url_scheme,
|
|
|
|
|
self.text_color,
|
|
|
|
|
self.background_color,
|
|
|
|
|
self.background_image_uri,
|
|
|
|
|
)
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
|
2022-10-16 21:58:46 +09:00
|
|
|
|
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 get_cover_white_url(self, size: str = '200x200') -> str:
|
|
|
|
|
"""Возвращает URL обложки white.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`str`: URL обложки.
|
|
|
|
|
"""
|
2023-01-11 18:50:33 +09:00
|
|
|
|
|
|
|
|
|
if not self.cover_white:
|
|
|
|
|
raise YandexMusicError('You can\'t get cover white because it\'s None.')
|
|
|
|
|
|
2022-10-16 21:58:46 +09:00
|
|
|
|
return f'https://{self.cover_white.replace("%%", size)}'
|
|
|
|
|
|
|
|
|
|
def get_background_url(self, size: str = '200x200') -> str:
|
|
|
|
|
"""Возвращает URL заднего фона.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер заднего фона.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`str`: URL заднего фона.
|
|
|
|
|
"""
|
|
|
|
|
return f'https://{self.background_image_uri.replace("%%", size)}'
|
|
|
|
|
|
Добавлены тайп хинты для Block, BlockEntity, Char, CharItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShortOld, AlbumsLikes, ArtistsLikes, PlaylistsLikes, CaseForms, MadeFor, PlayCounter, PlaylistAbsence, PlaylistId, User
2019-12-27 22:40:26 +09:00
|
|
|
|
def download_background_image(self, filename: str, size: str = '200x200') -> None:
|
2019-08-18 23:44:46 +09:00
|
|
|
|
"""Загрузка заднего фона.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер заднего фона.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
self.client.request.download(self.get_background_url(size), filename)
|
2019-08-18 23:44:46 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_background_image_async(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка заднего фона.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер заднего фона.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
await self.client.request.download(self.get_background_url(size), filename)
|
2022-02-20 02:59:53 +09:00
|
|
|
|
|
2021-02-06 20:51:33 +09:00
|
|
|
|
def download_cover_white(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка обложки TODO.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
self.client.request.download(self.get_cover_white_url(size), filename)
|
2021-02-06 20:51:33 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_cover_white_async(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка обложки TODO.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
await self.client.request.download(self.get_cover_white_url(size), filename)
|
2022-02-20 02:59:53 +09:00
|
|
|
|
|
2021-02-06 20:51:33 +09:00
|
|
|
|
def download_cover_uri(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
self.client.request.download(self.get_cover_url(size), filename)
|
2021-02-06 20:51:33 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_cover_uri_async(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
await self.client.request.download(self.get_cover_url(size), filename)
|
|
|
|
|
|
|
|
|
|
def download_background_image_bytes(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка заднего фона и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер заднего фона.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Задний фон в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return self.client.request.retrieve(self.get_background_url(size))
|
|
|
|
|
|
|
|
|
|
async def download_background_image_bytes_async(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка заднего фона и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер заднего фона.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Задний фон в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.request.retrieve(self.get_background_url(size))
|
|
|
|
|
|
|
|
|
|
def download_cover_white_bytes(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка обложки и возврат в виде байтов TODO.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Обложка в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return self.client.request.retrieve(self.get_cover_white_url(size))
|
|
|
|
|
|
|
|
|
|
async def download_cover_white_bytes_async(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка обложки и возврат в виде байтов TODO.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Обложка в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.request.retrieve(self.get_cover_white_url(size))
|
|
|
|
|
|
|
|
|
|
def download_cover_uri_bytes(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка обложки и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Обложка в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return self.client.request.retrieve(self.get_cover_url(size))
|
|
|
|
|
|
|
|
|
|
async def download_cover_uri_bytes_async(self, size: str = '200x200') -> bytes:
|
|
|
|
|
"""Загрузка обложки и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Обложка в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.request.retrieve(self.get_cover_url(size))
|
2022-02-20 02:59:53 +09:00
|
|
|
|
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
@classmethod
|
Добавлены тайп хинты для Block, BlockEntity, Char, CharItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShortOld, AlbumsLikes, ArtistsLikes, PlaylistsLikes, CaseForms, MadeFor, PlayCounter, PlaylistAbsence, PlaylistId, User
2019-12-27 22:40:26 +09:00
|
|
|
|
def de_json(cls, data: dict, client: 'Client') -> Optional['MixLink']:
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""Десериализация объекта.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
data (:obj:`dict`): Поля и значения десериализуемого объекта.
|
Удаление избыточной информации (#247)
Классы: Account, AutoRenewable, PassportPhone, Permissions, Plus, Price,
Product, Status, Subscription, UserSettings, Album, Label,
TrackPosition, Playlist
У всех классов изменено описание атрибута client
2020-03-22 04:49:20 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
|
|
|
|
|
Returns:
|
2020-03-22 08:59:18 +09:00
|
|
|
|
:obj:`yandex_music.MixLink`: Блок-ссылка на подборку.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
data = super(MixLink, cls).de_json(data, client)
|
|
|
|
|
|
|
|
|
|
return cls(client=client, **data)
|
|
|
|
|
|
|
|
|
|
@classmethod
|
Добавлены тайп хинты для Block, BlockEntity, Char, CharItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShortOld, AlbumsLikes, ArtistsLikes, PlaylistsLikes, CaseForms, MadeFor, PlayCounter, PlaylistAbsence, PlaylistId, User
2019-12-27 22:40:26 +09:00
|
|
|
|
def de_list(cls, data: dict, client: 'Client') -> List['MixLink']:
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""Десериализация списка объектов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
|
Удаление избыточной информации (#247)
Классы: Account, AutoRenewable, PassportPhone, Permissions, Plus, Price,
Product, Status, Subscription, UserSettings, Album, Label,
TrackPosition, Playlist
У всех классов изменено описание атрибута client
2020-03-22 04:49:20 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
|
|
|
|
|
Returns:
|
2020-03-22 08:59:18 +09:00
|
|
|
|
:obj:`list` из :obj:`yandex_music.MixLink`: Блоки-ссылки на подборки.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
mix_links = list()
|
|
|
|
|
for mix_link in data:
|
|
|
|
|
mix_links.append(cls.de_json(mix_link, client))
|
|
|
|
|
|
|
|
|
|
return mix_links
|
2019-08-18 23:44:46 +09:00
|
|
|
|
|
|
|
|
|
# camelCase псевдонимы
|
|
|
|
|
|
2022-10-16 23:53:46 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_cover_url`
|
|
|
|
|
getCoverUrl = get_cover_url
|
|
|
|
|
#: Псевдоним для :attr:`get_cover_white_url`
|
|
|
|
|
getCoverWhiteUrl = get_cover_white_url
|
|
|
|
|
#: Псевдоним для :attr:`get_background_url`
|
|
|
|
|
getBackgroundUrl = get_background_url
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_background_image`
|
2019-08-18 23:44:46 +09:00
|
|
|
|
downloadBackgroundImage = download_background_image
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_background_image_async`
|
|
|
|
|
downloadBackgroundImageAsync = download_background_image_async
|
2021-02-06 20:51:33 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_cover_white`
|
|
|
|
|
downloadCoverWhite = download_cover_white
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_cover_white_async`
|
|
|
|
|
downloadCoverWhiteAsync = download_cover_white_async
|
2021-02-06 20:51:33 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_cover_uri`
|
|
|
|
|
downloadCoverUri = download_cover_uri
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_cover_uri_async`
|
|
|
|
|
downloadCoverUriAsync = download_cover_uri_async
|
2022-10-16 23:53:46 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_background_image_bytes`
|
|
|
|
|
downloadBackgroundImageBytes = download_background_image_bytes
|
|
|
|
|
#: Псевдоним для :attr:`download_background_image_bytes_async`
|
|
|
|
|
downloadBackgroundImageBytesAsync = download_background_image_bytes_async
|
|
|
|
|
#: Псевдоним для :attr:`download_cover_white_bytes`
|
|
|
|
|
downloadCoverWhiteBytes = download_cover_white_bytes
|
|
|
|
|
#: Псевдоним для :attr:`download_cover_white_bytes_async`
|
|
|
|
|
downloadCoverWhiteBytesAsync = download_cover_white_bytes_async
|
|
|
|
|
#: Псевдоним для :attr:`download_cover_uri_bytes`
|
|
|
|
|
downloadCoverUriBytes = download_cover_uri_bytes
|
|
|
|
|
#: Псевдоним для :attr:`download_cover_uri_bytes_async`
|
|
|
|
|
downloadCoverUriBytesAsync = download_cover_uri_bytes_async
|