2021-09-19 22:47:19 +09:00
|
|
|
|
import dataclasses
|
2020-03-24 17:42:47 +09:00
|
|
|
|
import logging
|
2020-06-20 22:54:46 +09:00
|
|
|
|
import keyword
|
2019-05-07 06:02:21 +09:00
|
|
|
|
from abc import ABCMeta
|
2020-01-26 22:17:09 +09:00
|
|
|
|
from typing import TYPE_CHECKING, Optional
|
2019-05-07 06:02:21 +09:00
|
|
|
|
|
2020-01-26 22:17:09 +09:00
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
|
from yandex_music import Client
|
2019-12-27 05:27:58 +09:00
|
|
|
|
|
Добавлены тайп хинты в соответствии с документацией для следуюшщих классов: YandexMusicObject, Cover, Captcha, DownloadInfo, Experiments, Icon, InvocationInfo, Pager, PermissionAlerts, PromoCodeStatus, Settings, TrackShort, TracksList, Video #120
2019-12-24 16:17:04 +09:00
|
|
|
|
ujson: bool = False
|
2019-12-23 18:07:11 +09:00
|
|
|
|
try:
|
|
|
|
|
import ujson as json
|
2020-01-26 22:17:09 +09:00
|
|
|
|
|
2019-12-23 18:07:11 +09:00
|
|
|
|
ujson = True
|
|
|
|
|
except ImportError:
|
|
|
|
|
import json
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
reserved_names = keyword.kwlist
|
2019-12-27 05:27:58 +09:00
|
|
|
|
|
2020-03-24 17:42:47 +09:00
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
new_issue_by_template_url = 'https://bit.ly/3dsFxyH'
|
|
|
|
|
|
2019-05-07 06:02:21 +09:00
|
|
|
|
|
2019-08-18 18:54:13 +09:00
|
|
|
|
class YandexMusicObject:
|
2019-05-07 06:02:21 +09:00
|
|
|
|
__metaclass__ = ABCMeta
|
Добавлены тайп хинты в соответствии с документацией для следуюшщих классов: YandexMusicObject, Cover, Captcha, DownloadInfo, Experiments, Icon, InvocationInfo, Pager, PermissionAlerts, PromoCodeStatus, Settings, TrackShort, TracksList, Video #120
2019-12-24 16:17:04 +09:00
|
|
|
|
_id_attrs: tuple = ()
|
2020-03-23 01:09:45 +09:00
|
|
|
|
|
Добавлены тайп хинты в соответствии с документацией для следуюшщих классов: YandexMusicObject, Cover, Captcha, DownloadInfo, Experiments, Icon, InvocationInfo, Pager, PermissionAlerts, PromoCodeStatus, Settings, TrackShort, TracksList, Video #120
2019-12-24 16:17:04 +09:00
|
|
|
|
def __str__(self) -> str:
|
2019-05-07 06:02:21 +09:00
|
|
|
|
return str(self.to_dict())
|
|
|
|
|
|
Добавлены тайп хинты в соответствии с документацией для следуюшщих классов: YandexMusicObject, Cover, Captcha, DownloadInfo, Experiments, Icon, InvocationInfo, Pager, PermissionAlerts, PromoCodeStatus, Settings, TrackShort, TracksList, Video #120
2019-12-24 16:17:04 +09:00
|
|
|
|
def __repr__(self) -> str:
|
2019-05-15 05:38:15 +09:00
|
|
|
|
return str(self)
|
|
|
|
|
|
2019-05-07 06:02:21 +09:00
|
|
|
|
def __getitem__(self, item):
|
|
|
|
|
return self.__dict__[item]
|
|
|
|
|
|
2020-06-07 21:56:37 +09:00
|
|
|
|
@staticmethod
|
2022-11-01 20:09:13 +09:00
|
|
|
|
def report_unknown_fields_callback(cls, unknown_fields):
|
2021-02-03 21:28:10 +09:00
|
|
|
|
logger.warning(
|
|
|
|
|
f'Found unknown fields received from API! Please copy warn message '
|
|
|
|
|
f'and send to {new_issue_by_template_url} (github issue), thank you!'
|
|
|
|
|
)
|
2022-11-11 07:34:01 +09:00
|
|
|
|
logger.warning(f'Type: {cls.__module__}.{cls.__name__}; fields: {unknown_fields}')
|
2020-03-24 17:42:47 +09:00
|
|
|
|
|
2019-05-07 06:02:21 +09:00
|
|
|
|
@classmethod
|
2020-01-26 22:17:09 +09:00
|
|
|
|
def de_json(cls, data: dict, client: Optional['Client']) -> Optional[dict]:
|
|
|
|
|
"""Десериализация объекта.
|
|
|
|
|
|
|
|
|
|
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 06:29:34 +09:00
|
|
|
|
:obj:`yandex_music.YandexMusicObject` | :obj:`None`: :obj:`yandex_music.YandexMusicObject` или :obj:`None`.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
2019-05-07 06:02:21 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
data = data.copy()
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
fields = {f.name for f in dataclasses.fields(cls)}
|
|
|
|
|
|
|
|
|
|
cleaned_data = dict()
|
|
|
|
|
unknown_data = dict()
|
|
|
|
|
|
|
|
|
|
for k, v in data.items():
|
|
|
|
|
if k in fields:
|
|
|
|
|
cleaned_data[k] = v
|
|
|
|
|
else:
|
|
|
|
|
unknown_data[k] = v
|
|
|
|
|
|
2022-02-21 08:18:29 +09:00
|
|
|
|
if client.report_unknown_fields and unknown_data:
|
2022-11-01 20:09:13 +09:00
|
|
|
|
cls.report_unknown_fields_callback(cls, unknown_data)
|
2021-09-19 22:47:19 +09:00
|
|
|
|
|
|
|
|
|
return cleaned_data
|
2019-05-07 06:02:21 +09:00
|
|
|
|
|
2020-06-20 22:54:46 +09:00
|
|
|
|
def to_json(self, for_request=False) -> str:
|
2020-03-23 01:09:45 +09:00
|
|
|
|
"""Сериализация объекта.
|
|
|
|
|
|
2020-06-20 22:54:46 +09:00
|
|
|
|
Args:
|
|
|
|
|
for_request (:obj:`bool`): Подготовить ли объект для отправки в теле запроса.
|
|
|
|
|
|
2020-03-23 01:09:45 +09:00
|
|
|
|
Returns:
|
|
|
|
|
:obj:`str`: Сериализованный в JSON объект.
|
|
|
|
|
"""
|
2020-06-20 22:54:46 +09:00
|
|
|
|
return json.dumps(self.to_dict(for_request), ensure_ascii=not ujson)
|
2019-05-07 06:02:21 +09:00
|
|
|
|
|
2020-06-20 22:54:46 +09:00
|
|
|
|
def to_dict(self, for_request=False) -> dict:
|
2020-03-23 01:09:45 +09:00
|
|
|
|
"""Рекурсивная сериализация объекта.
|
|
|
|
|
|
2020-06-20 22:54:46 +09:00
|
|
|
|
Args:
|
|
|
|
|
for_request (:obj:`bool`): Перевести ли обратно все поля в camelCase и игнорировать зарезервированные слова.
|
|
|
|
|
|
2020-03-23 01:09:45 +09:00
|
|
|
|
Note:
|
|
|
|
|
Исключает из сериализации `client` и `_id_attrs` необходимые в `__eq__`.
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
К зарезервированным словам добавляет "_" в конец.
|
2020-03-23 01:09:45 +09:00
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`dict`: Сериализованный в dict объект.
|
|
|
|
|
"""
|
2021-02-03 21:28:10 +09:00
|
|
|
|
|
Добавлены основные тесты для следующих классов: 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
|
|
|
|
def parse(val):
|
|
|
|
|
if hasattr(val, 'to_dict'):
|
2020-06-20 22:54:46 +09:00
|
|
|
|
return val.to_dict(for_request)
|
Добавлены основные тесты для следующих классов: 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
|
|
|
|
elif isinstance(val, list):
|
|
|
|
|
return [parse(it) for it in val]
|
|
|
|
|
elif isinstance(val, dict):
|
2020-01-26 21:19:22 +09:00
|
|
|
|
return {key: parse(value) for key, value in val.items()}
|
Добавлены основные тесты для следующих классов: 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
|
|
|
|
else:
|
|
|
|
|
return val
|
|
|
|
|
|
|
|
|
|
data = self.__dict__.copy()
|
|
|
|
|
data.pop('client', None)
|
|
|
|
|
data.pop('_id_attrs', None)
|
|
|
|
|
|
2020-06-20 22:54:46 +09:00
|
|
|
|
if for_request:
|
|
|
|
|
for k, v in data.copy().items():
|
|
|
|
|
camel_case = ''.join(word.title() for word in k.split('_'))
|
|
|
|
|
camel_case = camel_case[0].lower() + camel_case[1:]
|
|
|
|
|
|
2019-12-27 05:27:58 +09:00
|
|
|
|
data.pop(k)
|
2020-06-20 22:54:46 +09:00
|
|
|
|
data.update({camel_case: v})
|
|
|
|
|
else:
|
|
|
|
|
for k, v in data.copy().items():
|
|
|
|
|
if k.lower() in reserved_names:
|
|
|
|
|
data.pop(k)
|
|
|
|
|
data.update({f'{k}_': v})
|
2019-12-27 05:27:58 +09:00
|
|
|
|
|
Добавлены основные тесты для следующих классов: 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
|
|
|
|
return parse(data)
|
2019-05-07 06:02:21 +09:00
|
|
|
|
|
Добавлены тайп хинты в соответствии с документацией для следуюшщих классов: YandexMusicObject, Cover, Captcha, DownloadInfo, Experiments, Icon, InvocationInfo, Pager, PermissionAlerts, PromoCodeStatus, Settings, TrackShort, TracksList, Video #120
2019-12-24 16:17:04 +09:00
|
|
|
|
def __eq__(self, other) -> bool:
|
2020-03-23 01:09:45 +09:00
|
|
|
|
"""Проверка на равенство двух объектов.
|
|
|
|
|
|
|
|
|
|
Note:
|
|
|
|
|
Проверка осуществляется по определённым атрибутам классов, перечисленных в множестве `_id_attrs`.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`bool`: Одинаковые ли объекты (по содержимому).
|
|
|
|
|
"""
|
2019-05-07 06:02:21 +09:00
|
|
|
|
if isinstance(other, self.__class__):
|
|
|
|
|
return self._id_attrs == other._id_attrs
|
|
|
|
|
return super(YandexMusicObject, self).__eq__(other)
|
|
|
|
|
|
2020-03-23 01:09:45 +09:00
|
|
|
|
def __hash__(self) -> int:
|
|
|
|
|
"""Реализация хеш-функции на основе ключевых атрибутов.
|
|
|
|
|
|
|
|
|
|
Note:
|
|
|
|
|
Так как перечень ключевых атрибутов хранится в виде множества, для вычисления хеша он замораживается.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
|
:obj:`int`: Хеш объекта.
|
|
|
|
|
"""
|
2019-05-07 06:02:21 +09:00
|
|
|
|
if self._id_attrs:
|
2019-11-10 03:11:43 +09:00
|
|
|
|
frozen_attrs = tuple(frozenset(attr) if isinstance(attr, list) else attr for attr in self._id_attrs)
|
|
|
|
|
return hash((self.__class__, frozen_attrs))
|
2019-05-07 06:02:21 +09:00
|
|
|
|
return super(YandexMusicObject, self).__hash__()
|