yandex-music-api/yandex_music/landing/block_entity.py

94 行
3.2 KiB
Python
Raw Blame 履歴

このファイルには曖昧(ambiguous)なUnicode文字が含まれています

このファイルには、他の文字と見間違える可能性があるUnicode文字が含まれています。 それが意図的なものと考えられる場合は、この警告を無視して構いません。 それらの文字を表示するにはエスケープボタンを使用します。

from typing import TYPE_CHECKING, Optional, List, Union
from yandex_music import (
YandexMusicObject,
Promotion,
Album,
Playlist,
MixLink,
PlayContext,
ChartItem,
GeneratedPlaylist,
)
from yandex_music.utils import model
if TYPE_CHECKING:
from yandex_music import Client
de_json = {
'personal-playlist': GeneratedPlaylist.de_json,
'promotion': Promotion.de_json,
'album': Album.de_json,
'playlist': Playlist.de_json,
'chart-item': ChartItem.de_json,
'play-context': PlayContext.de_json,
'mix-link': MixLink.de_json,
}
@model
class BlockEntity(YandexMusicObject):
"""Класс, представляющий содержимое блока.
Note:
В зависимости от поля `type_`, в поле `data` будет объект соответствующего типа.
Известные значения поля `type_`: `personal-playlist`, `promotion`, `album`, `playlist`, `chart-item`,
`play-context`, `mix-link`.
Attributes:
id (:obj:`str`): Уникальный идентификатор содержимого.
type (:obj:`str`): Тип содержимого.
data (:obj:`yandex_music.GeneratedPlaylist` | :obj:`yandex_music.Promotion` | :obj:`yandex_music.Album` |
:obj:`yandex_music.Playlist` | :obj:`yandex_music.ChartItem` | :obj:`yandex_music.PlayContext` |
:obj:`yandex_music.MixLink`): Содержимое.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
"""
id: str
type: str
data: Union['GeneratedPlaylist', 'Promotion', 'Album', 'Playlist', 'ChartItem', 'PlayContext', 'MixLink']
client: Optional['Client'] = None
def __post_init__(self):
self._id_attrs = (self.id, self.type, self.data)
@classmethod
def de_json(cls, data: dict, client: 'Client') -> Optional['BlockEntity']:
"""Десериализация объекта.
Args:
data (:obj:`dict`): Поля и значения десериализуемого объекта.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.BlockEntity`: Сущность (объект) блока.
"""
if not data:
return None
data = super(BlockEntity, cls).de_json(data, client)
data['data'] = de_json.get(data.get('type'))(data.get('data'), client)
return cls(client=client, **data)
@classmethod
def de_list(cls, data: dict, client: 'Client') -> List['BlockEntity']:
"""Десериализация списка объектов.
Args:
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`list` из :obj:`yandex_music.BlockEntity`: Содержимое блока.
"""
if not data:
return []
entities = list()
for entity in data:
entities.append(cls.de_json(entity, client))
return entities