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
|
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 Promotion(YandexMusicObject):
|
2020-03-22 12:09:27 +09:00
|
|
|
|
"""Класс, представляющий продвижение (рекламу).
|
|
|
|
|
|
|
|
|
|
Note:
|
|
|
|
|
В цвете может как оказаться HEX (`#6c65a9`), так и какой-нибудь `transparent`.
|
|
|
|
|
|
|
|
|
|
Ссылка со схемой отличается от просто ссылки наличием `yandexmusic://` в начале.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
|
|
|
|
|
Attributes:
|
2020-03-22 12:09:27 +09:00
|
|
|
|
promo_id (:obj:`str`): Уникальный идентификатор рекламы.
|
|
|
|
|
title (:obj:`str`): Заголовок.
|
|
|
|
|
subtitle (:obj:`str`): Подзаголовок.
|
|
|
|
|
heading (:obj:`str`): Верхний заголовок.
|
|
|
|
|
url (:obj:`str`): Ссылка.
|
|
|
|
|
url_scheme (:obj:`str`): Ссылка с схемой.
|
|
|
|
|
text_color (:obj:`str`): Цвет текста.
|
|
|
|
|
gradient (:obj:`str`): Градиент TODO.
|
|
|
|
|
image (:obj:`str`): Ссылка на рекламное изображение.
|
Удаление избыточной информации (#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
|
|
|
|
promo_id: str
|
|
|
|
|
title: str
|
|
|
|
|
subtitle: str
|
|
|
|
|
heading: str
|
|
|
|
|
url: str
|
|
|
|
|
url_scheme: str
|
|
|
|
|
text_color: str
|
|
|
|
|
gradient: str
|
|
|
|
|
image: str
|
|
|
|
|
client: Optional['Client'] = None
|
|
|
|
|
|
|
|
|
|
def __post_init__(self):
|
2021-02-03 21:28:10 +09:00
|
|
|
|
self._id_attrs = (
|
|
|
|
|
self.promo_id,
|
|
|
|
|
self.title,
|
|
|
|
|
self.subtitle,
|
|
|
|
|
self.heading,
|
|
|
|
|
self.url,
|
|
|
|
|
self.url_scheme,
|
|
|
|
|
self.text_color,
|
|
|
|
|
self.gradient,
|
|
|
|
|
self.image,
|
|
|
|
|
)
|
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_image_url(self, size: str = '300x300') -> str:
|
|
|
|
|
"""Возвращает URL изображения.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер изображения.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`str`: URL изображения.
|
|
|
|
|
"""
|
|
|
|
|
return f'https://{self.image.replace("%%", size)}'
|
|
|
|
|
|
2021-02-06 20:51:33 +09:00
|
|
|
|
def download_image(self, filename: str, size: str = '300x300') -> None:
|
|
|
|
|
"""Загрузка рекламного изображения.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер изображения.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
self.client.request.download(self.get_image_url(size), filename)
|
2021-02-06 20:51:33 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_image_async(self, filename: str, size: str = '300x300') -> None:
|
|
|
|
|
"""Загрузка рекламного изображения.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер изображения.
|
|
|
|
|
"""
|
2022-10-16 21:58:46 +09:00
|
|
|
|
await self.client.request.download(self.get_image_url(size), filename)
|
|
|
|
|
|
|
|
|
|
def download_image_bytes(self, size: str = '300x300') -> bytes:
|
|
|
|
|
"""Загрузка рекламного изображения и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер изображения.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Рекламное изображение в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return self.client.request.retrieve(self.get_image_url(size))
|
|
|
|
|
|
|
|
|
|
async def download_image_bytes_async(self, size: str = '300x300') -> bytes:
|
|
|
|
|
"""Загрузка рекламного изображения и возврат в виде байтов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
size (:obj:`str`, optional): Размер изображения.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bytes`: Рекламное изображение в виде байтов.
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.request.retrieve(self.get_image_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['Promotion']:
|
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 12:09:27 +09:00
|
|
|
|
:obj:`yandex_music.Promotion`: Продвижение (реклама).
|
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(Promotion, 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['Promotion']:
|
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 12:09:27 +09:00
|
|
|
|
:obj:`list` из :obj:`yandex_music.Promotion`: Продвижения (реклама).
|
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 []
|
|
|
|
|
|
|
|
|
|
promotions = list()
|
|
|
|
|
for promotion in data:
|
|
|
|
|
promotions.append(cls.de_json(promotion, client))
|
|
|
|
|
|
|
|
|
|
return promotions
|
2021-02-06 20:51:33 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
# camelCase псевдонимы
|
|
|
|
|
|
2022-10-16 23:53:46 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_image_url`
|
|
|
|
|
getImageUrl = get_image_url
|
2021-02-06 20:51:33 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_image`
|
|
|
|
|
downloadImage = download_image
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_image_async`
|
|
|
|
|
downloadImageAsync = download_image_async
|
2022-10-16 23:53:46 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_image_bytes`
|
|
|
|
|
downloadImageBytes = download_image_bytes
|
|
|
|
|
#: Псевдоним для :attr:`download_image_bytes_async`
|
|
|
|
|
downloadImageBytesAsync = download_image_bytes_async
|