diff --git a/docs/source/yandex_music.artist.rst b/docs/source/yandex_music.artist.rst index 63446e8..b9afbaa 100644 --- a/docs/source/yandex_music.artist.rst +++ b/docs/source/yandex_music.artist.rst @@ -12,4 +12,3 @@ yandex_music.artist.brief_info yandex_music.artist.artist_tracks yandex_music.artist.artist_albums - yandex_music.artist.pager diff --git a/docs/source/yandex_music.artist.pager.rst b/docs/source/yandex_music.pager.rst similarity index 84% rename from docs/source/yandex_music.artist.pager.rst rename to docs/source/yandex_music.pager.rst index b5107ca..78ae730 100644 --- a/docs/source/yandex_music.artist.pager.rst +++ b/docs/source/yandex_music.pager.rst @@ -3,5 +3,4 @@ yandex_music.Pager .. autoclass:: yandex_music.Pager :members: - :undoc-members: :show-inheritance: diff --git a/docs/source/yandex_music.rst b/docs/source/yandex_music.rst index 2805572..8b400c5 100644 --- a/docs/source/yandex_music.rst +++ b/docs/source/yandex_music.rst @@ -3,30 +3,32 @@ .. toctree:: - yandex_music.artist - yandex_music.playlist - yandex_music.utils - yandex_music.genre - yandex_music.track - yandex_music.account - yandex_music.likes - yandex_music.album - yandex_music.search - yandex_music.landing - yandex_music.feed - yandex_music.rotor - yandex_music.supplement - - yandex_music.base yandex_music.client - yandex_music.settings - yandex_music.permission_alerts - yandex_music.experiments - yandex_music.track_short - yandex_music.promo_code_status - yandex_music.invocation_info - yandex_music.icon + yandex_music.base yandex_music.cover yandex_music.download_info + yandex_music.experiments + yandex_music.icon + yandex_music.invocation_info + yandex_music.pager + yandex_music.permission_alerts + yandex_music.promo_code_status + yandex_music.settings + yandex_music.track_short yandex_music.tracks_list yandex_music.video + + yandex_music.account + yandex_music.album + yandex_music.artist + yandex_music.feed + yandex_music.genre + yandex_music.landing + yandex_music.likes + yandex_music.playlist + yandex_music.rotor + yandex_music.search + yandex_music.shot + yandex_music.supplement + yandex_music.track + yandex_music.utils diff --git a/docs/source/yandex_music.shot.rst b/docs/source/yandex_music.shot.rst new file mode 100644 index 0000000..998b482 --- /dev/null +++ b/docs/source/yandex_music.shot.rst @@ -0,0 +1,9 @@ +Пакет yandex_music.shot +======================= + +.. toctree:: + + yandex_music.shot.shot + yandex_music.shot.shot_data + yandex_music.shot.shot_event + yandex_music.shot.shot_type diff --git a/docs/source/yandex_music.shot.shot.rst b/docs/source/yandex_music.shot.shot.rst new file mode 100644 index 0000000..99a769c --- /dev/null +++ b/docs/source/yandex_music.shot.shot.rst @@ -0,0 +1,7 @@ +yandex_music.Shot +================= + +.. autoclass:: yandex_music.Shot + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/yandex_music.shot.shot_data.rst b/docs/source/yandex_music.shot.shot_data.rst new file mode 100644 index 0000000..7f6b8f9 --- /dev/null +++ b/docs/source/yandex_music.shot.shot_data.rst @@ -0,0 +1,7 @@ +yandex_music.ShotData +===================== + +.. autoclass:: yandex_music.ShotData + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/yandex_music.shot.shot_event.rst b/docs/source/yandex_music.shot.shot_event.rst new file mode 100644 index 0000000..c5139b2 --- /dev/null +++ b/docs/source/yandex_music.shot.shot_event.rst @@ -0,0 +1,7 @@ +yandex_music.ShotEvent +====================== + +.. autoclass:: yandex_music.ShotEvent + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/yandex_music.shot.shot_type.rst b/docs/source/yandex_music.shot.shot_type.rst new file mode 100644 index 0000000..24f5e5b --- /dev/null +++ b/docs/source/yandex_music.shot.shot_type.rst @@ -0,0 +1,7 @@ +yandex_music.ShotType +===================== + +.. autoclass:: yandex_music.ShotType + :members: + :undoc-members: + :show-inheritance: diff --git a/yandex_music/account/account.py b/yandex_music/account/account.py index d42dce2..d764593 100644 --- a/yandex_music/account/account.py +++ b/yandex_music/account/account.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, PassportPhone -from yandex_music import YandexMusicObject - class Account(YandexMusicObject): """Класс, представляющий основную информацию об аккаунте пользователя. @@ -92,9 +92,8 @@ class Account(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. - format_ (:obj:`str`): Формат желаемого изображения (normal, orig, small, big). + format_ (:obj:`str`): Формат желаемого изображения (`normal`, `orig`, `small`, `big`). """ - self.client.request.download(f'https://upics.yandex.net/{self.uid}/{format_}', filename) @classmethod diff --git a/yandex_music/account/auto_renewable.py b/yandex_music/account/auto_renewable.py index 1ebe44a..135d9af 100644 --- a/yandex_music/account/auto_renewable.py +++ b/yandex_music/account/auto_renewable.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Product -from yandex_music import YandexMusicObject - class AutoRenewable(YandexMusicObject): """Класс, представляющий автопродление подписки. @@ -87,7 +87,8 @@ class AutoRenewable(YandexMusicObject): Music. Returns: - :obj:`list` из :obj:`yandex_music.AutoRenewable`: Список объектов класса :class:`yandex_music.AutoRenewable`. + :obj:`list` из :obj:`yandex_music.AutoRenewable`: Список объектов класса + :class:`yandex_music.AutoRenewable`. """ if not data: return [] diff --git a/yandex_music/account/passport_phone.py b/yandex_music/account/passport_phone.py index 082d746..427534c 100644 --- a/yandex_music/account/passport_phone.py +++ b/yandex_music/account/passport_phone.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PassportPhone(YandexMusicObject): """Класс, представляющий номер телефона пользователя. @@ -59,7 +59,8 @@ class PassportPhone(YandexMusicObject): Music. Returns: - :obj:`list` из :obj:`yandex_music.PassportPhone`: Список объектов класса :class:`yandex_music.PassportPhone`. + :obj:`list` из :obj:`yandex_music.PassportPhone`: Список объектов класса + :class:`yandex_music.PassportPhone`. """ if not data: return [] diff --git a/yandex_music/account/permissions.py b/yandex_music/account/permissions.py index 97988a6..feff58b 100644 --- a/yandex_music/account/permissions.py +++ b/yandex_music/account/permissions.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Permissions(YandexMusicObject): """Класс, представляющий информацию о правах пользователя, их изначальных значениях и даты окончания. diff --git a/yandex_music/account/plus.py b/yandex_music/account/plus.py index b432c29..e3bc226 100644 --- a/yandex_music/account/plus.py +++ b/yandex_music/account/plus.py @@ -1,13 +1,13 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Plus(YandexMusicObject): - """Класс, представляющий Plus подписку. + """Класс, представляющий `Plus` подписку. Attributes: has_plus (:obj:`bool`): Наличие. diff --git a/yandex_music/account/price.py b/yandex_music/account/price.py index c7f0851..c488ec5 100644 --- a/yandex_music/account/price.py +++ b/yandex_music/account/price.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Price(YandexMusicObject): """Класс, представляющий цену. diff --git a/yandex_music/account/product.py b/yandex_music/account/product.py index 3540159..f1b080e 100644 --- a/yandex_music/account/product.py +++ b/yandex_music/account/product.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Price -from yandex_music import YandexMusicObject - class Product(YandexMusicObject): """Класс, представляющий продаваемый продукт. diff --git a/yandex_music/account/status.py b/yandex_music/account/status.py index 4275584..a24cb5d 100644 --- a/yandex_music/account/status.py +++ b/yandex_music/account/status.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Account, Permissions, Subscription, Plus -from yandex_music import YandexMusicObject - class Status(YandexMusicObject): """Класс, представляющий подробную информацию об аккаунте пользователя. diff --git a/yandex_music/account/subscription.py b/yandex_music/account/subscription.py index bead53b..bbe1097 100644 --- a/yandex_music/account/subscription.py +++ b/yandex_music/account/subscription.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, AutoRenewable -from yandex_music import YandexMusicObject - class Subscription(YandexMusicObject): """Класс, представляющий информацию о подписках пользователя. diff --git a/yandex_music/account/user_settings.py b/yandex_music/account/user_settings.py index e4f6f14..d091214 100644 --- a/yandex_music/account/user_settings.py +++ b/yandex_music/account/user_settings.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class UserSettings(YandexMusicObject): """Класс, представляющий настройки пользователя. diff --git a/yandex_music/album/album.py b/yandex_music/album/album.py index 1281644..e3170a8 100644 --- a/yandex_music/album/album.py +++ b/yandex_music/album/album.py @@ -1,19 +1,20 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Artist, Label, TrackPosition, Track -from yandex_music import YandexMusicObject - class Album(YandexMusicObject): """Класс, представляющий альбом. - Известные типы альбома: `single` - сингл, `compilation` - сборник. + Note: + Известные типы альбома: `single` - сингл, `compilation` - сборник. - Известные предупреждения о содержимом: `explicit` - ненормативная лексика. + Известные предупреждения о содержимом: `explicit` - ненормативная лексика. - Известные ошибки: `not-found` - альбом с таким ID не существует. + Известные ошибки: `not-found` - альбом с таким ID не существует. Attributes: id (:obj:`int`): Идентификатор альбома. @@ -144,7 +145,6 @@ class Album(YandexMusicObject): client.albums_with_tracks(album.id, *args, **kwargs) """ - return self.client.albums_with_tracks(self.id, *args, **kwargs) def download_cover(self, filename: str, size: str = '200x200') -> None: @@ -154,19 +154,17 @@ class Album(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.cover_uri.replace("%%", size)}', filename) def download_og_image(self, filename: str, size: str = '200x200') -> None: """Загрузка обложки. - Предпочтительнее использовать self.download_cover(). + Предпочтительнее использовать `self.download_cover()`. Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename) def like(self, *args, **kwargs) -> bool: diff --git a/yandex_music/album/label.py b/yandex_music/album/label.py index 936a2fc..4ce110e 100644 --- a/yandex_music/album/label.py +++ b/yandex_music/album/label.py @@ -1,26 +1,27 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Label(YandexMusicObject): """Класс, представляющий лейбл альбома. - Attributes: - id (:obj:`int`): Идентификатор альбома. - name (:obj:`str`): Название альбома. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. - Args: - id_ (:obj:`int`): Идентификатор альбома. - name (:obj:`str`): Название альбома. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий - клиент Yandex Music. - **kwargs: Произвольные ключевые аргументы полученные от API. - """ + Attributes: + id (:obj:`int`): Идентификатор альбома. + name (:obj:`str`): Название альбома. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + Args: + id_ (:obj:`int`): Идентификатор альбома. + name (:obj:`str`): Название альбома. + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий + клиент Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: int, name: str, @@ -36,12 +37,12 @@ class Label(YandexMusicObject): def de_json(cls, data: dict, client: 'Client') -> Optional['Label']: """Десериализация объекта. - Args: - data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент - Yandex Music. - Returns: - :obj:`yandex_music.Label`: Объект класса :class:`yandex_music.Label`. + Args: + data (:obj:`dict`): Поля и значения десериализуемого объекта. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + Yandex Music. + Returns: + :obj:`yandex_music.Label`: Объект класса :class:`yandex_music.Label`. """ if not data: return None @@ -54,12 +55,12 @@ class Label(YandexMusicObject): def de_list(cls, data: dict, client: 'Client') -> List['Label']: """Десериализация списка объектов. - Args: - data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент - Yandex Music. - Returns: - :obj:`list` из :obj:`yandex_music.Label`: Список объектов класса :class:`yandex_music.Label`. + Args: + data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + Yandex Music. + Returns: + :obj:`list` из :obj:`yandex_music.Label`: Список объектов класса :class:`yandex_music.Label`. """ if not data: return [] diff --git a/yandex_music/album/track_position.py b/yandex_music/album/track_position.py index 32b082b..f818b67 100644 --- a/yandex_music/album/track_position.py +++ b/yandex_music/album/track_position.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class TrackPosition(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/artist.py b/yandex_music/artist/artist.py index b2a7a50..f17794d 100644 --- a/yandex_music/artist/artist.py +++ b/yandex_music/artist/artist.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Cover, Ratings, Counts, Link, Track, Description, ArtistTracks, ArtistAlbums -from yandex_music import YandexMusicObject - class Artist(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/artist_albums.py b/yandex_music/artist/artist_albums.py index 1e24aba..6c13947 100644 --- a/yandex_music/artist/artist_albums.py +++ b/yandex_music/artist/artist_albums.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Album, Pager -from yandex_music import YandexMusicObject - class ArtistAlbums(YandexMusicObject): """Класс, представляющий страницу списка альбомов артиста. diff --git a/yandex_music/artist/artist_tracks.py b/yandex_music/artist/artist_tracks.py index ffac16a..3d8b170 100644 --- a/yandex_music/artist/artist_tracks.py +++ b/yandex_music/artist/artist_tracks.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track, Pager -from yandex_music import YandexMusicObject - class ArtistTracks(YandexMusicObject): """Класс, представляющий страницу списка треков артиста. @@ -18,8 +18,8 @@ class ArtistTracks(YandexMusicObject): Args: tracks (:obj:`list` из :obj:`yandex_music.Track`): Список треков артиста. pager (:obj:`yandex_music.Pager`): Объект класса :class:`yandex_music.Pager` представляющий пагинатор. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ diff --git a/yandex_music/artist/brief_info.py b/yandex_music/artist/brief_info.py index e615b42..6f26d47 100644 --- a/yandex_music/artist/brief_info.py +++ b/yandex_music/artist/brief_info.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Artist, Track, Album, Cover, PlaylistId, Video, Chart, Vinyl -from yandex_music import YandexMusicObject - class BriefInfo(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/counts.py b/yandex_music/artist/counts.py index 167af90..c5cbaf5 100644 --- a/yandex_music/artist/counts.py +++ b/yandex_music/artist/counts.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Counts(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/description.py b/yandex_music/artist/description.py index ebe4e15..f1c8695 100644 --- a/yandex_music/artist/description.py +++ b/yandex_music/artist/description.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Description(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/link.py b/yandex_music/artist/link.py index 585ca22..627a249 100644 --- a/yandex_music/artist/link.py +++ b/yandex_music/artist/link.py @@ -1,15 +1,16 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Link(YandexMusicObject): """Класс, представляющий ссылку на официальную страницу исполнителя. - Известные типы страниц: `official` - официальный сайт и `social` - социальная сеть. + Note: + Известные типы страниц: `official` - официальный сайт и `social` - социальная сеть. Attributes: title (:obj:`str`): Название страницы. diff --git a/yandex_music/artist/ratings.py b/yandex_music/artist/ratings.py index e946e6e..616cadf 100644 --- a/yandex_music/artist/ratings.py +++ b/yandex_music/artist/ratings.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Ratings(YandexMusicObject): def __init__(self, diff --git a/yandex_music/artist/vinyl.py b/yandex_music/artist/vinyl.py index 9685b72..dce447e 100644 --- a/yandex_music/artist/vinyl.py +++ b/yandex_music/artist/vinyl.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Vinyl(YandexMusicObject): def __init__(self, @@ -38,7 +38,6 @@ class Vinyl(YandexMusicObject): Returns: :obj:`yandex_music.Vinyl`: Объект класса :class:`yandex_music.Vinyl`. """ - if not data: return None diff --git a/yandex_music/base.py b/yandex_music/base.py index 760559b..5f9d7c7 100644 --- a/yandex_music/base.py +++ b/yandex_music/base.py @@ -45,7 +45,7 @@ class YandexMusicObject: elif isinstance(val, list): return [parse(it) for it in val] elif isinstance(val, dict): - return {k: parse(v) for k, v in val.items()} + return {key: parse(value) for key, value in val.items()} else: return val diff --git a/yandex_music/client.py b/yandex_music/client.py index 3d77b6d..2ef0792 100644 --- a/yandex_music/client.py +++ b/yandex_music/client.py @@ -243,7 +243,7 @@ class Client(YandexMusicObject): return Status.de_json(result, self) @log - def account_settings(self, timeout: Union[int, float] = None, *args, **kwargs) -> Optional[Settings]: + def account_settings(self, timeout: Union[int, float] = None, *args, **kwargs) -> Optional[UserSettings]: """Получение настроек текущего пользователя. Args: @@ -268,7 +268,7 @@ class Client(YandexMusicObject): @log def account_settings_set(self, param: str = None, value: Union[str, int, bool] = None, data: Dict[str, Union[str, int, bool]] = None, timeout: Union[int, float] = None, - *args, **kwargs) -> Optional[Settings]: + *args, **kwargs) -> Optional[UserSettings]: """Изменение настроек текущего пользователя. Note: @@ -530,7 +530,7 @@ class Client(YandexMusicObject): @log def tracks_similar(self, track_id: Union[str, int], timeout: Union[int, float] = None, - *args, **kwargs) -> Optional: + *args, **kwargs) -> Optional[SimilarTracks]: """Получение похожих треков. Args: @@ -713,7 +713,7 @@ class Client(YandexMusicObject): @log def users_settings(self, user_id: Union[str, int] = None, timeout: Union[int, float] = None, - *args, **kwargs) -> Optional[Settings]: + *args, **kwargs) -> Optional[UserSettings]: """Получение настроек пользователя. Note: diff --git a/yandex_music/cover.py b/yandex_music/cover.py index c40d307..cb16289 100644 --- a/yandex_music/cover.py +++ b/yandex_music/cover.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Cover(YandexMusicObject): """Класс, представляющий обложку. @@ -12,7 +12,7 @@ class Cover(YandexMusicObject): Attributes: type (:obj:`str`): Тип обложки. uri (:obj:`str`): Ссылка на изображение. - items_uri (:obj:`str`): ССписок ссылок на изображения. + items_uri (:obj:`str`): Список ссылок на изображения. dir (:obj:`str`): Директория хранения изображения на сервере. version (:obj:`str`): Версия. custom (:obj:`bool`): Является ли обложка пользовательской. @@ -63,7 +63,7 @@ class Cover(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. - index (:obj:`int`, optional): Индекс элемента в списке ссылок на обложки если нет self.uri. + index (:obj:`int`, optional): Индекс элемента в списке ссылок на обложки если нет `self.uri`. size (:obj:`str`, optional): Размер изображения. """ diff --git a/yandex_music/download_info.py b/yandex_music/download_info.py index b7faf2c..bf4d68f 100644 --- a/yandex_music/download_info.py +++ b/yandex_music/download_info.py @@ -1,14 +1,14 @@ from typing import TYPE_CHECKING, Optional, List -if TYPE_CHECKING: - from yandex_music import Client - from xml.dom.minicompat import NodeList - from hashlib import md5 import xml.dom.minidom as minidom from yandex_music import YandexMusicObject +if TYPE_CHECKING: + from yandex_music import Client + from xml.dom.minicompat import NodeList + class DownloadInfo(YandexMusicObject): """Класс, представляющий информацию о вариантах загрузки трека. diff --git a/yandex_music/experiments.py b/yandex_music/experiments.py index 3928217..eb45574 100644 --- a/yandex_music/experiments.py +++ b/yandex_music/experiments.py @@ -1,10 +1,11 @@ from typing import TYPE_CHECKING, Optional + +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Experiments(YandexMusicObject): """Класс представления каких-то свистелок-перделок, флажков, режимов экспериментальных функций. diff --git a/yandex_music/feed/album_event.py b/yandex_music/feed/album_event.py index caaca4d..dc03c3a 100644 --- a/yandex_music/feed/album_event.py +++ b/yandex_music/feed/album_event.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Album, Track -from yandex_music import YandexMusicObject - class AlbumEvent(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/artist_event.py b/yandex_music/feed/artist_event.py index cbe6652..baadd41 100644 --- a/yandex_music/feed/artist_event.py +++ b/yandex_music/feed/artist_event.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Artist, Track -from yandex_music import YandexMusicObject - class ArtistEvent(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/day.py b/yandex_music/feed/day.py index a79b3b1..8ad23e3 100644 --- a/yandex_music/feed/day.py +++ b/yandex_music/feed/day.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Event, Track, TrackWithAds -from yandex_music import YandexMusicObject - class Day(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/event.py b/yandex_music/feed/event.py index 42896a8..c44ab20 100644 --- a/yandex_music/feed/event.py +++ b/yandex_music/feed/event.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track, AlbumEvent, ArtistEvent -from yandex_music import YandexMusicObject - class Event(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/feed.py b/yandex_music/feed/feed.py index 9dd9df6..e46ecd9 100644 --- a/yandex_music/feed/feed.py +++ b/yandex_music/feed/feed.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, GeneratedPlaylist, Day -from yandex_music import YandexMusicObject - class Feed(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/generated_playlist.py b/yandex_music/feed/generated_playlist.py index 4833ad5..e42eb23 100644 --- a/yandex_music/feed/generated_playlist.py +++ b/yandex_music/feed/generated_playlist.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Playlist -from yandex_music import YandexMusicObject - class GeneratedPlaylist(YandexMusicObject): def __init__(self, diff --git a/yandex_music/feed/track_with_ads.py b/yandex_music/feed/track_with_ads.py index cd75412..fa4baf4 100644 --- a/yandex_music/feed/track_with_ads.py +++ b/yandex_music/feed/track_with_ads.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track -from yandex_music import YandexMusicObject - class TrackWithAds(YandexMusicObject): def __init__(self, diff --git a/yandex_music/genre/genre.py b/yandex_music/genre/genre.py index 5a15352..d637518 100644 --- a/yandex_music/genre/genre.py +++ b/yandex_music/genre/genre.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Dict +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Title, Icon, Images -from yandex_music import YandexMusicObject - class Genre(YandexMusicObject): def __init__(self, diff --git a/yandex_music/genre/images.py b/yandex_music/genre/images.py index e8c328c..7f30a81 100644 --- a/yandex_music/genre/images.py +++ b/yandex_music/genre/images.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Images(YandexMusicObject): def __init__(self, diff --git a/yandex_music/genre/title.py b/yandex_music/genre/title.py index 427d310..5d7d913 100644 --- a/yandex_music/genre/title.py +++ b/yandex_music/genre/title.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, Dict +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Title(YandexMusicObject): def __init__(self, diff --git a/yandex_music/icon.py b/yandex_music/icon.py index 319975d..444f475 100644 --- a/yandex_music/icon.py +++ b/yandex_music/icon.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Icon(YandexMusicObject): """Класс, представляющий иконку. diff --git a/yandex_music/invocation_info.py b/yandex_music/invocation_info.py index deb4ec6..802b206 100644 --- a/yandex_music/invocation_info.py +++ b/yandex_music/invocation_info.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class InvocationInfo(YandexMusicObject): """Класс, представляющий информацию о запросе. diff --git a/yandex_music/landing/block.py b/yandex_music/landing/block.py index 06a098e..7412e19 100644 --- a/yandex_music/landing/block.py +++ b/yandex_music/landing/block.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, BlockEntity, PersonalPlaylistsData, PlayContextsData -from yandex_music import YandexMusicObject - class Block(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/block_entity.py b/yandex_music/landing/block_entity.py index 9c17ad5..47f05ad 100644 --- a/yandex_music/landing/block_entity.py +++ b/yandex_music/landing/block_entity.py @@ -1,12 +1,11 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject, Promotion, Album, Playlist, MixLink, PlayContext, ChartItem, \ + GeneratedPlaylist + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject, Promotion, Album, Playlist, MixLink, PlayContext, ChartItem,\ - GeneratedPlaylist - - de_json = { 'personal-playlist': GeneratedPlaylist.de_json, 'promotion': Promotion.de_json, diff --git a/yandex_music/landing/chart.py b/yandex_music/landing/chart.py index 57c5c63..817af9d 100644 --- a/yandex_music/landing/chart.py +++ b/yandex_music/landing/chart.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, TrackId -from yandex_music import YandexMusicObject - class Chart(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/chart_item.py b/yandex_music/landing/chart_item.py index 926b983..b80a80e 100644 --- a/yandex_music/landing/chart_item.py +++ b/yandex_music/landing/chart_item.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track, Chart -from yandex_music import YandexMusicObject - class ChartItem(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/landing.py b/yandex_music/landing/landing.py index ff5aa66..b5e92c4 100644 --- a/yandex_music/landing/landing.py +++ b/yandex_music/landing/landing.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Block -from yandex_music import YandexMusicObject - class Landing(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/mix_link.py b/yandex_music/landing/mix_link.py index dfd2976..9552c17 100644 --- a/yandex_music/landing/mix_link.py +++ b/yandex_music/landing/mix_link.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class MixLink(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/personal_playlists_data.py b/yandex_music/landing/personal_playlists_data.py index 4d57775..6b86dc2 100644 --- a/yandex_music/landing/personal_playlists_data.py +++ b/yandex_music/landing/personal_playlists_data.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PersonalPlaylistsData(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/play_context.py b/yandex_music/landing/play_context.py index 9b3b12a..3c4065d 100644 --- a/yandex_music/landing/play_context.py +++ b/yandex_music/landing/play_context.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, TrackShortOld -from yandex_music import YandexMusicObject - class PlayContext(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/play_contexts_data.py b/yandex_music/landing/play_contexts_data.py index ce469d2..1df29c3 100644 --- a/yandex_music/landing/play_contexts_data.py +++ b/yandex_music/landing/play_contexts_data.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, TrackShortOld -from yandex_music import YandexMusicObject - class PlayContextsData(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/promotion.py b/yandex_music/landing/promotion.py index 8eca1a3..9612f64 100644 --- a/yandex_music/landing/promotion.py +++ b/yandex_music/landing/promotion.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Promotion(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/track_id.py b/yandex_music/landing/track_id.py index fff477d..a641b26 100644 --- a/yandex_music/landing/track_id.py +++ b/yandex_music/landing/track_id.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class TrackId(YandexMusicObject): def __init__(self, diff --git a/yandex_music/landing/track_short_old.py b/yandex_music/landing/track_short_old.py index 70d7dc0..9eb8b73 100644 --- a/yandex_music/landing/track_short_old.py +++ b/yandex_music/landing/track_short_old.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, TrackId -from yandex_music import YandexMusicObject - class TrackShortOld(YandexMusicObject): def __init__(self, diff --git a/yandex_music/likes/albums_likes.py b/yandex_music/likes/albums_likes.py index ef9af07..fbc927d 100644 --- a/yandex_music/likes/albums_likes.py +++ b/yandex_music/likes/albums_likes.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Album -from yandex_music import YandexMusicObject - class AlbumsLikes(YandexMusicObject): def __init__(self, diff --git a/yandex_music/likes/artists_likes.py b/yandex_music/likes/artists_likes.py index f36c51f..c596363 100644 --- a/yandex_music/likes/artists_likes.py +++ b/yandex_music/likes/artists_likes.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Artist -from yandex_music import YandexMusicObject - class ArtistsLikes(YandexMusicObject): def __init__(self, diff --git a/yandex_music/likes/playlists_likes.py b/yandex_music/likes/playlists_likes.py index f37e325..be235a8 100644 --- a/yandex_music/likes/playlists_likes.py +++ b/yandex_music/likes/playlists_likes.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Playlist -from yandex_music import YandexMusicObject - class PlaylistsLikes(YandexMusicObject): def __init__(self, diff --git a/yandex_music/pager.py b/yandex_music/pager.py index 8154bef..d8baf25 100644 --- a/yandex_music/pager.py +++ b/yandex_music/pager.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Pager(YandexMusicObject): """Класс, представляющий пагинатор. @@ -20,8 +20,8 @@ class Pager(YandexMusicObject): total (:obj:`int`): Всего треков. page (:obj:`int`): Номер страницы. per_page (:obj:`int`): Количество треков на странице. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ diff --git a/yandex_music/permission_alerts.py b/yandex_music/permission_alerts.py index 38b1bd9..814649d 100644 --- a/yandex_music/permission_alerts.py +++ b/yandex_music/permission_alerts.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PermissionAlerts(YandexMusicObject): """Класс, представляющий оповещения. diff --git a/yandex_music/playlist/case_forms.py b/yandex_music/playlist/case_forms.py index e693856..8d03bf3 100644 --- a/yandex_music/playlist/case_forms.py +++ b/yandex_music/playlist/case_forms.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class CaseForms(YandexMusicObject): def __init__(self, diff --git a/yandex_music/playlist/made_for.py b/yandex_music/playlist/made_for.py index b6d1cf9..baded42 100644 --- a/yandex_music/playlist/made_for.py +++ b/yandex_music/playlist/made_for.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, User, CaseForms -from yandex_music import YandexMusicObject - class MadeFor(YandexMusicObject): def __init__(self, diff --git a/yandex_music/playlist/play_counter.py b/yandex_music/playlist/play_counter.py index aa96631..75fba02 100644 --- a/yandex_music/playlist/play_counter.py +++ b/yandex_music/playlist/play_counter.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PlayCounter(YandexMusicObject): def __init__(self, diff --git a/yandex_music/playlist/playlist.py b/yandex_music/playlist/playlist.py index a18127e..3a72a2f 100644 --- a/yandex_music/playlist/playlist.py +++ b/yandex_music/playlist/playlist.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, User, Cover, MadeFor, TrackShort, PlaylistAbsence, PlayCounter -from yandex_music import YandexMusicObject - class Playlist(YandexMusicObject): def __init__(self, diff --git a/yandex_music/playlist/playlist_absence.py b/yandex_music/playlist/playlist_absence.py index 5b71b8c..40d4d44 100644 --- a/yandex_music/playlist/playlist_absence.py +++ b/yandex_music/playlist/playlist_absence.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PlaylistAbsence(YandexMusicObject): """Класс, представляющий причину отсутствия плейлиста. diff --git a/yandex_music/playlist/playlist_id.py b/yandex_music/playlist/playlist_id.py index 914a064..34f7058 100644 --- a/yandex_music/playlist/playlist_id.py +++ b/yandex_music/playlist/playlist_id.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class PlaylistId(YandexMusicObject): def __init__(self, diff --git a/yandex_music/playlist/user.py b/yandex_music/playlist/user.py index 8ab3fdf..08b2037 100644 --- a/yandex_music/playlist/user.py +++ b/yandex_music/playlist/user.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class User(YandexMusicObject): """Класс, представляющий пользователя. @@ -51,7 +51,7 @@ class User(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. - format_ (:obj:`str`, optional): Формат желаемого изображения (normal, orig, small, big). + format_ (:obj:`str`, optional): Формат желаемого изображения (`normal`, `orig`, `small`, `big`). """ self.client.request.download(f'https://upics.yandex.net/{self.uid}/{format_}', filename) diff --git a/yandex_music/promo_code_status.py b/yandex_music/promo_code_status.py index de2bb07..d168e8a 100644 --- a/yandex_music/promo_code_status.py +++ b/yandex_music/promo_code_status.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Status -from yandex_music import YandexMusicObject - class PromoCodeStatus(YandexMusicObject): """Класс, представляющий статус активации промо-кода. diff --git a/yandex_music/rotor/ad_params.py b/yandex_music/rotor/ad_params.py index 8820e50..dc2fcec 100644 --- a/yandex_music/rotor/ad_params.py +++ b/yandex_music/rotor/ad_params.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class AdParams(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/dashboard.py b/yandex_music/rotor/dashboard.py index 76a9bf0..eecf5b1 100644 --- a/yandex_music/rotor/dashboard.py +++ b/yandex_music/rotor/dashboard.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, StationResult -from yandex_music import YandexMusicObject - class Dashboard(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/discrete_scale.py b/yandex_music/rotor/discrete_scale.py index 76fe5b9..8e4caed 100644 --- a/yandex_music/rotor/discrete_scale.py +++ b/yandex_music/rotor/discrete_scale.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Value -from yandex_music import YandexMusicObject - class DiscreteScale(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/enum.py b/yandex_music/rotor/enum.py index abaef59..a54ee97 100644 --- a/yandex_music/rotor/enum.py +++ b/yandex_music/rotor/enum.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Value -from yandex_music import YandexMusicObject - class Enum(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/id.py b/yandex_music/rotor/id.py index cd35c33..4a67415 100644 --- a/yandex_music/rotor/id.py +++ b/yandex_music/rotor/id.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Id(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/restrictions.py b/yandex_music/rotor/restrictions.py index 8572a99..9c42c79 100644 --- a/yandex_music/rotor/restrictions.py +++ b/yandex_music/rotor/restrictions.py @@ -1,10 +1,9 @@ from typing import TYPE_CHECKING, Optional, Union -if TYPE_CHECKING: - from yandex_music import Client - from yandex_music import YandexMusicObject, Enum, DiscreteScale +if TYPE_CHECKING: + from yandex_music import Client de_json = { 'enum': Enum.de_json, diff --git a/yandex_music/rotor/rotor_settings.py b/yandex_music/rotor/rotor_settings.py index f177cfd..1d51ef1 100644 --- a/yandex_music/rotor/rotor_settings.py +++ b/yandex_music/rotor/rotor_settings.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class RotorSettings(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/sequence.py b/yandex_music/rotor/sequence.py index 21a2219..b73192c 100644 --- a/yandex_music/rotor/sequence.py +++ b/yandex_music/rotor/sequence.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track -from yandex_music import YandexMusicObject - class Sequence(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/station.py b/yandex_music/rotor/station.py index 519e555..8f0da0e 100644 --- a/yandex_music/rotor/station.py +++ b/yandex_music/rotor/station.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Id, Icon, Restrictions -from yandex_music import YandexMusicObject - class Station(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/station_result.py b/yandex_music/rotor/station_result.py index 3e94c22..edd3eab 100644 --- a/yandex_music/rotor/station_result.py +++ b/yandex_music/rotor/station_result.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Station, RotorSettings, AdParams -from yandex_music import YandexMusicObject - class StationResult(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/station_tracks_result.py b/yandex_music/rotor/station_tracks_result.py index 8e7d332..0f251e1 100644 --- a/yandex_music/rotor/station_tracks_result.py +++ b/yandex_music/rotor/station_tracks_result.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Id, Sequence -from yandex_music import YandexMusicObject - class StationTracksResult(YandexMusicObject): def __init__(self, diff --git a/yandex_music/rotor/value.py b/yandex_music/rotor/value.py index b7df47a..e8265bf 100644 --- a/yandex_music/rotor/value.py +++ b/yandex_music/rotor/value.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Value(YandexMusicObject): def __init__(self, diff --git a/yandex_music/search/best.py b/yandex_music/search/best.py index 02e7436..4a93db8 100644 --- a/yandex_music/search/best.py +++ b/yandex_music/search/best.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, Union +from yandex_music import YandexMusicObject, Artist, Album, Track, Playlist, Video + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject, Artist, Album, Track, Playlist, Video - de_json_result = { 'track': Track.de_json, diff --git a/yandex_music/search/search.py b/yandex_music/search/search.py index 4ac089b..8f800c7 100644 --- a/yandex_music/search/search.py +++ b/yandex_music/search/search.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Best, SearchResult -from yandex_music import YandexMusicObject - class Search(YandexMusicObject): """Класс, представляющий результаты поиска. diff --git a/yandex_music/search/search_result.py b/yandex_music/search/search_result.py index a65a92f..94e129d 100644 --- a/yandex_music/search/search_result.py +++ b/yandex_music/search/search_result.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject, Artist, Album, Track, Playlist, Video + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject, Artist, Album, Track, Playlist, Video - de_json_result = { 'track': Track.de_list, @@ -18,24 +18,24 @@ de_json_result = { class SearchResult(YandexMusicObject): """Класс, представляющий результаты поиска. - Attributes: - total (:obj:`int`): Количество результатов. - per_page (:obj:`int`): Максимальное количество результатов на странице. - order (:obj:`int`): Позиция блока. - results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ - | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + Attributes: + total (:obj:`int`): Количество результатов. + per_page (:obj:`int`): Максимальное количество результатов на странице. + order (:obj:`int`): Позиция блока. + results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ + | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. - Args: - total (:obj:`int`): Количество результатов. - per_page (:obj:`int`): Максимальное количество результатов на странице. - order (:obj:`int`): Позиция блока. - results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ - | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. - **kwargs: Произвольные ключевые аргументы полученные от API. + Args: + total (:obj:`int`): Количество результатов. + per_page (:obj:`int`): Максимальное количество результатов на странице. + order (:obj:`int`): Позиция блока. + results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ + | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. """ def __init__(self, diff --git a/yandex_music/search/suggestions.py b/yandex_music/search/suggestions.py index 29b6c60..ee724a8 100644 --- a/yandex_music/search/suggestions.py +++ b/yandex_music/search/suggestions.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Best -from yandex_music import YandexMusicObject - class Suggestions(YandexMusicObject): def __init__(self, diff --git a/yandex_music/settings.py b/yandex_music/settings.py index 530a622..cc6ca72 100644 --- a/yandex_music/settings.py +++ b/yandex_music/settings.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Product, Price -from yandex_music import YandexMusicObject - class Settings(YandexMusicObject): """Класс, представляющий предложения по покупке. diff --git a/yandex_music/shot/shot.py b/yandex_music/shot/shot.py index db79d00..397dfec 100644 --- a/yandex_music/shot/shot.py +++ b/yandex_music/shot/shot.py @@ -1,15 +1,16 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, ShotData -from yandex_music import YandexMusicObject - class Shot(YandexMusicObject): """Класс, представляющий шот от Алисы. - Известные значения поля `status`: `ready`. + Note: + Известные значения поля `status`: `ready`. Attributes: order (:obj:`int`): Порядковый номер при воспроизведении. diff --git a/yandex_music/shot/shot_data.py b/yandex_music/shot/shot_data.py index 8123736..a28b2e5 100644 --- a/yandex_music/shot/shot_data.py +++ b/yandex_music/shot/shot_data.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, ShotType -from yandex_music import YandexMusicObject - class ShotData(YandexMusicObject): """Класс, представляющий основную информацию о шоте. diff --git a/yandex_music/shot/shot_event.py b/yandex_music/shot/shot_event.py index 1087d3b..11865bd 100644 --- a/yandex_music/shot/shot_event.py +++ b/yandex_music/shot/shot_event.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Shot -from yandex_music import YandexMusicObject - class ShotEvent(YandexMusicObject): """Класс, представляющий событие-шот перед началом следующего трека. diff --git a/yandex_music/shot/shot_type.py b/yandex_music/shot/shot_type.py index 516b89c..87d0857 100644 --- a/yandex_music/shot/shot_type.py +++ b/yandex_music/shot/shot_type.py @@ -1,16 +1,16 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class ShotType(YandexMusicObject): """Класс, представляющий тип шота от Алисы. Attributes: - id_ (:obj:`str`): Уникальный идентификатор типа. + id (:obj:`str`): Уникальный идентификатор типа. title (:obj:`str`): Заголовок шота. client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex Music. @@ -28,11 +28,11 @@ class ShotType(YandexMusicObject): title: str, client: Optional['Client'] = None, **kwargs): - self.id_ = id_ + self.id = id_ self.title = title self.client = client - self._id_attrs = (self.id_, self.title) + self._id_attrs = (self.id, self.title) @classmethod def de_json(cls, data: dict, client: 'Client') -> Optional['ShotType']: diff --git a/yandex_music/supplement/lyrics.py b/yandex_music/supplement/lyrics.py index a8f8d58..0c18bcf 100644 --- a/yandex_music/supplement/lyrics.py +++ b/yandex_music/supplement/lyrics.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Lyrics(YandexMusicObject): """Класс, представляющий текст трека. diff --git a/yandex_music/supplement/supplement.py b/yandex_music/supplement/supplement.py index d47bd48..9d8ba24 100644 --- a/yandex_music/supplement/supplement.py +++ b/yandex_music/supplement/supplement.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Lyrics, VideoSupplement -from yandex_music import YandexMusicObject - class Supplement(YandexMusicObject): """Класс, представляющий дополнительную информацию о треке. diff --git a/yandex_music/supplement/video_supplement.py b/yandex_music/supplement/video_supplement.py index 9354b12..be99597 100644 --- a/yandex_music/supplement/video_supplement.py +++ b/yandex_music/supplement/video_supplement.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class VideoSupplement(YandexMusicObject): """Класс, представляющий видеоклипы. diff --git a/yandex_music/track/major.py b/yandex_music/track/major.py index e2badef..23bbb06 100644 --- a/yandex_music/track/major.py +++ b/yandex_music/track/major.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Major(YandexMusicObject): def __init__(self, diff --git a/yandex_music/track/normalization.py b/yandex_music/track/normalization.py index a7fe85d..8a707ec 100644 --- a/yandex_music/track/normalization.py +++ b/yandex_music/track/normalization.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Normalization(YandexMusicObject): def __init__(self, diff --git a/yandex_music/track/track.py b/yandex_music/track/track.py index 48d0306..ca0057c 100644 --- a/yandex_music/track/track.py +++ b/yandex_music/track/track.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Normalization, Major, Album, Artist, Supplement, DownloadInfo -from yandex_music import YandexMusicObject - class Track(YandexMusicObject): def __init__(self, @@ -88,7 +88,7 @@ class Track(YandexMusicObject): def download_og_image(self, filename: str, size: str = '200x200') -> None: """Загрузка обложки. - Предпочтительнее использовать self.download_cover(). + Предпочтительнее использовать `self.download_cover()`. Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. diff --git a/yandex_music/track/tracks_similar.py b/yandex_music/track/tracks_similar.py index 0ac2ef4..eeb973d 100644 --- a/yandex_music/track/tracks_similar.py +++ b/yandex_music/track/tracks_similar.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track -from yandex_music import YandexMusicObject - class SimilarTracks(YandexMusicObject): """Класс, представляющий список похожих треков на другой трек. diff --git a/yandex_music/track_short.py b/yandex_music/track_short.py index 747c222..9f35f49 100644 --- a/yandex_music/track_short.py +++ b/yandex_music/track_short.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, Track -from yandex_music import YandexMusicObject - class TrackShort(YandexMusicObject): """Класс, представляющий укороченную версию трека с неполными данными. diff --git a/yandex_music/tracks_list.py b/yandex_music/tracks_list.py index e56eb77..c4d5490 100644 --- a/yandex_music/tracks_list.py +++ b/yandex_music/tracks_list.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Iterator +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client, TrackShort -from yandex_music import YandexMusicObject - class TracksList(YandexMusicObject): """Класс, представляющий список треков. diff --git a/yandex_music/utils/captcha_response.py b/yandex_music/utils/captcha_response.py index 8a1d70a..df15c9e 100644 --- a/yandex_music/utils/captcha_response.py +++ b/yandex_music/utils/captcha_response.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class CaptchaResponse(YandexMusicObject): """Класс, представляющий ответ сервера с запросом на ввод капчи. diff --git a/yandex_music/utils/response.py b/yandex_music/utils/response.py index c037a93..9a19b28 100644 --- a/yandex_music/utils/response.py +++ b/yandex_music/utils/response.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Response(YandexMusicObject): def __init__(self, diff --git a/yandex_music/video.py b/yandex_music/video.py index a89293b..9541d36 100644 --- a/yandex_music/video.py +++ b/yandex_music/video.py @@ -1,10 +1,10 @@ from typing import TYPE_CHECKING, Optional, List, Union +from yandex_music import YandexMusicObject + if TYPE_CHECKING: from yandex_music import Client -from yandex_music import YandexMusicObject - class Video(YandexMusicObject): def __init__(self,