97 行
3.9 KiB
Python
97 行
3.9 KiB
Python
from typing import TYPE_CHECKING, Optional, List
|
||
|
||
from yandex_music import YandexMusicObject
|
||
from yandex_music.utils import model
|
||
|
||
if TYPE_CHECKING:
|
||
from yandex_music import Client, Track, AlbumEvent, ArtistEvent
|
||
|
||
|
||
@model
|
||
class Event(YandexMusicObject):
|
||
"""Класс, представляющий событие фида.
|
||
|
||
Note:
|
||
Известные значения поля `type`: `tracks`, `artists`, `albums`, `notification`.
|
||
|
||
Поле `message` заполнено только когда `type` равен `notification`.
|
||
|
||
Примером значения поля `type_for_from` может служить `recommended-similar-artists`.
|
||
|
||
Наличие данных в `tracks`, `albums`, `artists` напрямую зависит от `type`.
|
||
|
||
Attributes:
|
||
id (:obj:`str`): Уникальный идентификатор события.
|
||
type (:obj:`str`): Тип события.
|
||
type_for_from (:obj:`str`, optional): Откуда пришло событие.
|
||
title (:obj:`str`, optional): Заголовок.
|
||
tracks (:obj:`list` из :obj:`yandex_music.Track`, optional): Список треков.
|
||
artists (:obj:`list` из :obj:`yandex_music.ArtistEvent`, optional): Список артистов с похожими и популярными
|
||
треками.
|
||
albums (:obj:`list` из :obj:`yandex_music.AlbumEvent`, optional): Список альбомов с треками.
|
||
message (:obj:`str`, optional): Сообщение уведомления.
|
||
device (:obj:`str`, optional): Устройство, с которого пришло уведомление.
|
||
tracks_count (:obj:`int`, optional): Количество треков (возможно, уже не используется).
|
||
genre (:obj:`str`, optional): Жанр треков.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
"""
|
||
|
||
id: str
|
||
type: str
|
||
type_for_from: Optional[str] = None
|
||
title: Optional[str] = None
|
||
tracks: List['Track'] = None
|
||
artists: List['ArtistEvent'] = None
|
||
albums: List['AlbumEvent'] = None
|
||
message: Optional[str] = None
|
||
device: Optional[str] = None
|
||
tracks_count: Optional[int] = None
|
||
genre: Optional[str] = None
|
||
client: Optional['Client'] = None
|
||
|
||
def __post_init__(self):
|
||
self._id_attrs = (self.id, self.type)
|
||
|
||
@classmethod
|
||
def de_json(cls, data: dict, client: 'Client') -> Optional['Event']:
|
||
"""Десериализация объекта.
|
||
|
||
Args:
|
||
data (:obj:`dict`): Поля и значения десериализуемого объекта.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
|
||
Returns:
|
||
:obj:`yandex_music.Event`: Событие фида.
|
||
"""
|
||
if not data:
|
||
return None
|
||
|
||
data = super(Event, cls).de_json(data, client)
|
||
from yandex_music import Track, AlbumEvent, ArtistEvent
|
||
|
||
data['tracks'] = Track.de_list(data.get('tracks'), client)
|
||
data['albums'] = AlbumEvent.de_list(data.get('albums'), client)
|
||
data['artists'] = ArtistEvent.de_list(data.get('artists'), client)
|
||
|
||
return cls(client=client, **data)
|
||
|
||
@classmethod
|
||
def de_list(cls, data: dict, client: 'Client') -> List['Event']:
|
||
"""Десериализация списка объектов.
|
||
|
||
Args:
|
||
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
|
||
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
|
||
|
||
Returns:
|
||
:obj:`list` из :obj:`yandex_music.Event`: События фида.
|
||
"""
|
||
if not data:
|
||
return []
|
||
|
||
events = list()
|
||
for event in data:
|
||
events.append(cls.de_json(event, client))
|
||
|
||
return events
|