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:
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
from yandex_music import Client, Track, AlbumEvent, ArtistEvent
|
2019-12-27 18:14:51 +09:00
|
|
|
|
|
2019-05-16 04:38:39 +09:00
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
@model
|
2019-05-16 04:38:39 +09:00
|
|
|
|
class Event(YandexMusicObject):
|
2020-03-22 08:32:51 +09:00
|
|
|
|
"""Класс, представляющий событие фида.
|
|
|
|
|
|
|
|
|
|
Note:
|
2021-09-19 22:47:19 +09:00
|
|
|
|
Известные значения поля `type`: `tracks`, `artists`, `albums`, `notification`.
|
2020-03-22 08:32:51 +09:00
|
|
|
|
|
|
|
|
|
Поле `message` заполнено только когда `type` равен `notification`.
|
|
|
|
|
|
|
|
|
|
Примером значения поля `type_for_from` может служить `recommended-similar-artists`.
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
Наличие данных в `tracks`, `albums`, `artists` напрямую зависит от `type`.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
|
|
|
|
|
Attributes:
|
2021-09-19 22:47:19 +09:00
|
|
|
|
id (:obj:`str`): Уникальный идентификатор события.
|
|
|
|
|
type (:obj:`str`): Тип события.
|
2020-03-22 08:32:51 +09:00
|
|
|
|
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): Количество треков (возможно, уже не используется).
|
Добавлен новый класс 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
|
|
|
|
genre (: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
|
|
|
|
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):
|
Добавлены основные тесты для следующих классов: AlbumEvent, AlbumsLikes, ArtistEvent, ArtistsLikes, ChartItem, Dashboard, Day, Event, Sequence, StationTracksResult, Supplement, TrackWithAds.
Исправлены фикстуры и сравнения для вышеперечисленных классов.
Отрефакторен conftest.py.
Исправлен баг в .to_dict() методе, связанный с не рекурсивной десериализацией объектов списков и словарей.
Исправлен баг с десериализацией artist в классе ArtistEvent
2019-11-09 22:43:02 +09:00
|
|
|
|
self._id_attrs = (self.id, self.type)
|
2019-05-16 04:38:39 +09:00
|
|
|
|
|
|
|
|
|
@classmethod
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def de_json(cls, data: dict, client: 'Client') -> Optional['Event']:
|
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:32:51 +09:00
|
|
|
|
:obj:`yandex_music.Event`: Событие фида.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
2019-05-16 04:38:39 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
data = super(Event, cls).de_json(data, client)
|
New supported objects: Search, Suggestions, Video, Best, AlbumSearchResult, ArtistSearchResult, PlaylistSearchResult, TrackSearchResult, VideoSearchResult,
The following methods are wrapped:
- /search
- /search/suggest
The following classes received optional fields instead of required ones: Album, Artist, Playlist, Track
Added "params" arg to the GET request
Code refactoring
2019-05-18 01:20:34 +09:00
|
|
|
|
from yandex_music import Track, AlbumEvent, ArtistEvent
|
2021-02-03 21:28:10 +09:00
|
|
|
|
|
2019-05-16 04:38:39 +09:00
|
|
|
|
data['tracks'] = Track.de_list(data.get('tracks'), client)
|
New supported objects: Search, Suggestions, Video, Best, AlbumSearchResult, ArtistSearchResult, PlaylistSearchResult, TrackSearchResult, VideoSearchResult,
The following methods are wrapped:
- /search
- /search/suggest
The following classes received optional fields instead of required ones: Album, Artist, Playlist, Track
Added "params" arg to the GET request
Code refactoring
2019-05-18 01:20:34 +09:00
|
|
|
|
data['albums'] = AlbumEvent.de_list(data.get('albums'), client)
|
|
|
|
|
data['artists'] = ArtistEvent.de_list(data.get('artists'), client)
|
2019-05-16 04:38:39 +09:00
|
|
|
|
|
|
|
|
|
return cls(client=client, **data)
|
|
|
|
|
|
|
|
|
|
@classmethod
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def de_list(cls, data: dict, client: 'Client') -> List['Event']:
|
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:32:51 +09:00
|
|
|
|
:obj:`list` из :obj:`yandex_music.Event`: События фида.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
2019-05-16 04:38:39 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
events = list()
|
|
|
|
|
for event in data:
|
|
|
|
|
events.append(cls.de_json(event, client))
|
|
|
|
|
|
|
|
|
|
return events
|