diff --git a/yandex_music/account/account.py b/yandex_music/account/account.py index d764593..39338e8 100644 --- a/yandex_music/account/account.py +++ b/yandex_music/account/account.py @@ -25,8 +25,8 @@ class Account(YandexMusicObject): :class:`yandex_music.PassportPhone` представляющие мобильные номера. registered_at (:obj:`str`): Дата создания аккаунта. has_info_for_app_metrica (:obj:`bool`): Наличие информации для App Metrica. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: now (:obj:`str`): Текущая дата и время. @@ -44,7 +44,7 @@ class Account(YandexMusicObject): :class:`yandex_music.PassportPhone` представляющие мобильные номера. registered_at (:obj:`str`, optional): Дата создания учётной записи. has_info_for_app_metrica (:obj:`bool`, optional): Наличие информации для App Metrica. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -102,8 +102,8 @@ class Account(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Account`: Объект класса :class:`yandex_music.Account`. diff --git a/yandex_music/account/auto_renewable.py b/yandex_music/account/auto_renewable.py index 135d9af..6b4b950 100644 --- a/yandex_music/account/auto_renewable.py +++ b/yandex_music/account/auto_renewable.py @@ -17,8 +17,8 @@ class AutoRenewable(YandexMusicObject): product (:obj:`yandex_music.Product`): Объект класса :class:`yandex_music.Product` представляющий продукт. order_id (:obj:`int`): Уникальный идентификатор заказа. finished (:obj:`bool`): Завершенность автопродления. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: expires (:obj:`str`): Дата истечения подписки. @@ -29,7 +29,7 @@ class AutoRenewable(YandexMusicObject): product (:obj:`yandex_music.Product`, optional): Объект класса :class:`yandex_music.Product` представляющий продукт. order_id (:obj:`int`): Уникальный идентификатор заказа. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -62,8 +62,8 @@ class AutoRenewable(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.AutoRenewable`: Объект класса :class:`yandex_music.AutoRenewable`. @@ -83,8 +83,8 @@ class AutoRenewable(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.AutoRenewable`: Список объектов класса diff --git a/yandex_music/account/passport_phone.py b/yandex_music/account/passport_phone.py index 427534c..98a941d 100644 --- a/yandex_music/account/passport_phone.py +++ b/yandex_music/account/passport_phone.py @@ -11,12 +11,12 @@ class PassportPhone(YandexMusicObject): Attributes: phone (:obj:`str`): Номер телефона. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: phone (:obj:`str`): Номер телефона. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -36,8 +36,8 @@ class PassportPhone(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PassportPhone`: Объект класса :class:`yandex_music.PassportPhone`. @@ -55,8 +55,8 @@ class PassportPhone(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.PassportPhone`: Список объектов класса diff --git a/yandex_music/account/permissions.py b/yandex_music/account/permissions.py index feff58b..f37ba15 100644 --- a/yandex_music/account/permissions.py +++ b/yandex_music/account/permissions.py @@ -13,14 +13,14 @@ class Permissions(YandexMusicObject): until (:obj:`str`): Дата окончания прав. values (:obj:`list` из :obj:`str`): Список прав. default (:obj:`list` из :obj:`str`): Список изначальных прав. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. Args: until (:obj:`str`): Дата окончания прав. values (:obj:`list` из :obj:`str`): Список прав. default (:obj:`list` из :obj:`str`): Список изначальных прав. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -44,8 +44,8 @@ class Permissions(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Permissions`: Объект класса :class:`yandex_music.Permissions`. diff --git a/yandex_music/account/plus.py b/yandex_music/account/plus.py index e3bc226..93c4d3a 100644 --- a/yandex_music/account/plus.py +++ b/yandex_music/account/plus.py @@ -12,13 +12,13 @@ class Plus(YandexMusicObject): Attributes: has_plus (:obj:`bool`): Наличие. is_tutorial_completed (:obj:`bool`): Закончено ли руководство. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: has_plus (:obj:`bool`): Наличие. is_tutorial_completed (:obj:`bool`): Закончено ли руководство. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class Plus(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Plus`: Объект класса :class:`yandex_music.Plus`. diff --git a/yandex_music/account/price.py b/yandex_music/account/price.py index c488ec5..b05b973 100644 --- a/yandex_music/account/price.py +++ b/yandex_music/account/price.py @@ -12,13 +12,13 @@ class Price(YandexMusicObject): Attributes: amount (:obj:`int`): Количество единиц. currency (:obj:`str`): Валюта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: amount (:obj:`int`): Количество единиц. currency (:obj:`str`): Валюта. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class Price(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Price`: Объект класса :class:`yandex_music.Price`. diff --git a/yandex_music/account/product.py b/yandex_music/account/product.py index f1b080e..3a60f8d 100644 --- a/yandex_music/account/product.py +++ b/yandex_music/account/product.py @@ -26,8 +26,8 @@ class Product(YandexMusicObject): button_text (:obj:`str`): Текст кнопки. button_additional_text (:obj:`str`): Дополнительный текст кнопки. payment_method_types (:obj:`list` из :obj:`str`): Способы оплаты. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: product_id (:obj:`str`): Уникальный идентификатор. @@ -46,7 +46,7 @@ class Product(YandexMusicObject): button_text (:obj:`str`, optional): Текст кнопки. button_additional_text (:obj:`str`, optional): Дополнительный текст кнопки. payment_method_types (:obj:`list` из :obj:`str`, optional): Способы оплаты. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -98,8 +98,8 @@ class Product(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Product`: Объект класса :class:`yandex_music.Product`. @@ -119,8 +119,8 @@ class Product(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Product`: Список объектов класса :class:`yandex_music.Product`. diff --git a/yandex_music/account/status.py b/yandex_music/account/status.py index a24cb5d..6b421c3 100644 --- a/yandex_music/account/status.py +++ b/yandex_music/account/status.py @@ -25,8 +25,8 @@ class Status(YandexMusicObject): skips_per_hour (:obj:`int`): Количество переключение треков на радио в час. station_exists (:obj:`bool`): Наличие станции TODO. premium_region (:obj:`int`): Регион TODO. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: account (:obj:`yandex_music.Account`): Объект класса :class:`yandex_music.Account` представляющий основную @@ -44,7 +44,7 @@ class Status(YandexMusicObject): skips_per_hour (:obj:`int`, optional): Количество переключение треков на радио в час. station_exists (:obj:`bool`, optional): Наличие станции TODO. premium_region (:obj:`int`, optional): Регион TODO. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -85,8 +85,8 @@ class Status(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Status`: Объект класса :class:`yandex_music.Status`. diff --git a/yandex_music/account/subscription.py b/yandex_music/account/subscription.py index bbe1097..7c2ca1a 100644 --- a/yandex_music/account/subscription.py +++ b/yandex_music/account/subscription.py @@ -15,8 +15,8 @@ class Subscription(YandexMusicObject): can_start_trial (:obj:`bool`): Есть ли возможность начать пробный период. mcdonalds (:obj:`bool`): mcdonalds TODO. end (:obj:`str`): Дата окончания. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: auto_renewable (:obj:`list` из :obj:`yandex_music.AutoRenewable`, optional): Список объектов класса @@ -24,7 +24,7 @@ class Subscription(YandexMusicObject): can_start_trial (:obj:`bool`, optional): Есть ли возможность начать пробный период. mcdonalds (:obj:`bool`, optional): mcdonalds TODO. end (:obj:`str`, optional): Дата окончания. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -50,8 +50,8 @@ class Subscription(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Subscription`: Объект класса :class:`yandex_music.Subscription`. diff --git a/yandex_music/account/user_settings.py b/yandex_music/account/user_settings.py index d091214..2e870d3 100644 --- a/yandex_music/account/user_settings.py +++ b/yandex_music/account/user_settings.py @@ -36,8 +36,8 @@ class UserSettings(YandexMusicObject): ads_disabled (:obj:`bool`): Не показывать рекламу. disk_enabled (:obj:`bool`): TODO. show_disk_tracks_in_library (:obj:`bool`): Показывать локальные треки в библиотеке. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: uid (:obj:`int`): Уникальный идентификатор пользователя. @@ -56,7 +56,7 @@ class UserSettings(YandexMusicObject): ads_disabled (:obj:`bool`, optional): Не показывать рекламу. disk_enabled (:obj:`bool`, optional): TODO. show_disk_tracks_in_library (:obj:`bool`, optional): Показывать локальные треки в библиотеке. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -111,8 +111,8 @@ class UserSettings(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.UserSettings`: Объект класса :class:`yandex_music.UserSettings`. diff --git a/yandex_music/album/album.py b/yandex_music/album/album.py index e3170a8..a890af9 100644 --- a/yandex_music/album/album.py +++ b/yandex_music/album/album.py @@ -43,7 +43,7 @@ class Album(YandexMusicObject): type (:obj:`str`): Тип альбома. track_position (:obj:`yandex_music.TrackPosition`): Объект класса :class:`yandex_music.TrackPosition` представляющий позицию трека. Возвращается при получении альбома в составе трека. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. Args: @@ -73,7 +73,7 @@ class Album(YandexMusicObject): type_ (:obj:`str`, optional): Тип альбома. track_position (:obj:`yandex_music.TrackPosition`, optional): Объект класса :class:`yandex_music.TrackPosition` представляющий позицию трека. Возвращается при получении альбома в составе трека. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -187,8 +187,8 @@ class Album(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Album`: Объект класса :class:`yandex_music.Album`. @@ -212,8 +212,8 @@ class Album(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Album`: Список объектов класса :class:`yandex_music.Album`. diff --git a/yandex_music/album/label.py b/yandex_music/album/label.py index 508e96b..b0d9478 100644 --- a/yandex_music/album/label.py +++ b/yandex_music/album/label.py @@ -12,12 +12,12 @@ class Label(YandexMusicObject): Attributes: id (:obj:`int`): Идентификатор альбома. name (:obj:`str`): Название альбома. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + 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` представляющий + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -39,7 +39,7 @@ class Label(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. Returns: :obj:`yandex_music.Label`: Объект класса :class:`yandex_music.Label`. @@ -57,7 +57,7 @@ class Label(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. Returns: diff --git a/yandex_music/album/track_position.py b/yandex_music/album/track_position.py index adbc8e4..7f5fd0a 100644 --- a/yandex_music/album/track_position.py +++ b/yandex_music/album/track_position.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class TrackPosition(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, volume: int, index: int, @@ -24,8 +36,8 @@ class TrackPosition(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TrackPosition`: Объект класса :class:`yandex_music.TrackPosition`. diff --git a/yandex_music/artist/artist.py b/yandex_music/artist/artist.py index 1792352..b5faccc 100644 --- a/yandex_music/artist/artist.py +++ b/yandex_music/artist/artist.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Artist(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: int, name: str, @@ -76,7 +88,6 @@ class Artist(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.op_image.replace("%%", size)}', filename) def like(self, *args, **kwargs) -> bool: @@ -113,8 +124,8 @@ class Artist(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Artist`: Объект класса :class:`yandex_music.Artist`. @@ -140,8 +151,8 @@ class Artist(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Artist`: Список объектов класса :class:`yandex_music.Artist`. diff --git a/yandex_music/artist/artist_albums.py b/yandex_music/artist/artist_albums.py index 6c13947..2825791 100644 --- a/yandex_music/artist/artist_albums.py +++ b/yandex_music/artist/artist_albums.py @@ -12,13 +12,13 @@ class ArtistAlbums(YandexMusicObject): Attributes: albums (:obj:`list` из :obj:`yandex_music.Album`): Список альбомов артиста. pager (:obj:`yandex_music.Pager`): Объект класса :class:`yandex_music.Pager` представляющий пагинатор. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: albums (:obj:`list` из :obj:`yandex_music.Album`): Список альбомов артиста. pager (:obj:`yandex_music.Pager`): Объект класса :class:`yandex_music.Pager` представляющий пагинатор. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class ArtistAlbums(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ArtistAlbums`: Объект класса :class:`yandex_music.ArtistAlbums`. diff --git a/yandex_music/artist/artist_tracks.py b/yandex_music/artist/artist_tracks.py index 3d8b170..bba83d6 100644 --- a/yandex_music/artist/artist_tracks.py +++ b/yandex_music/artist/artist_tracks.py @@ -12,13 +12,13 @@ class ArtistTracks(YandexMusicObject): Attributes: tracks (:obj:`list` из :obj:`yandex_music.Track`): Список треков артиста. pager (:obj:`yandex_music.Pager`): Объект класса :class:`yandex_music.Pager` представляющий пагинатор. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. 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` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class ArtistTracks(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ArtistsTracks`: Объект класса :class:`yandex_music.ArtistsTracks`. diff --git a/yandex_music/artist/brief_info.py b/yandex_music/artist/brief_info.py index 6f26d47..5396521 100644 --- a/yandex_music/artist/brief_info.py +++ b/yandex_music/artist/brief_info.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class BriefInfo(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, artist: Optional['Artist'], albums: List['Album'], @@ -49,13 +61,12 @@ class BriefInfo(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.BriefInfo`: Объект класса :class:`yandex_music.BriefInfo`. """ - if not data: return None diff --git a/yandex_music/artist/counts.py b/yandex_music/artist/counts.py index 80338f3..820975c 100644 --- a/yandex_music/artist/counts.py +++ b/yandex_music/artist/counts.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Counts(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, tracks: int, direct_albums: int, @@ -28,8 +40,8 @@ class Counts(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Counts`: Объект класса :class:`yandex_music.Counts`. diff --git a/yandex_music/artist/description.py b/yandex_music/artist/description.py index f1c8695..0753994 100644 --- a/yandex_music/artist/description.py +++ b/yandex_music/artist/description.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Description(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, text: str, url: str, @@ -24,13 +36,12 @@ class Description(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Description`: Объект класса :class:`yandex_music.Descriptions`. """ - if not data: return None diff --git a/yandex_music/artist/link.py b/yandex_music/artist/link.py index 627a249..ad3fec0 100644 --- a/yandex_music/artist/link.py +++ b/yandex_music/artist/link.py @@ -17,15 +17,15 @@ class Link(YandexMusicObject): href (:obj:`str`): URL страницы. type_ (:obj:`str`): Тип страницы. social_network (:obj:`str`): Название социальной сети. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: title (:obj:`str`): Название страницы. href (:obj:`str`): URL страницы. type_ (:obj:`str`): Тип страницы. social_network (:obj:`str`, optional): Название социальной сети. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. """ @@ -51,8 +51,8 @@ class Link(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Link`: Объект класса :class:`yandex_music.Link`. @@ -70,8 +70,8 @@ class Link(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Link`: Список объектов класса :class:`yandex_music.Link`. diff --git a/yandex_music/artist/ratings.py b/yandex_music/artist/ratings.py index 8513a7f..86f12b3 100644 --- a/yandex_music/artist/ratings.py +++ b/yandex_music/artist/ratings.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Ratings(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, week: int, month: int, @@ -27,8 +39,8 @@ class Ratings(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Ratings`: Объект класса :class:`yandex_music.Ratings`. diff --git a/yandex_music/artist/vinyl.py b/yandex_music/artist/vinyl.py index dce447e..fced3d8 100644 --- a/yandex_music/artist/vinyl.py +++ b/yandex_music/artist/vinyl.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Vinyl(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, url: str, title: str, @@ -32,8 +44,8 @@ class Vinyl(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Vinyl`: Объект класса :class:`yandex_music.Vinyl`. @@ -51,8 +63,8 @@ class Vinyl(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Vinyl`: Список объектов класса :class:`yandex_music.Vinyl`. diff --git a/yandex_music/base.py b/yandex_music/base.py index 84f5226..6ae23b0 100644 --- a/yandex_music/base.py +++ b/yandex_music/base.py @@ -35,8 +35,8 @@ class YandexMusicObject: Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.YandexMusicObject`: Объект класса :class:`yandex_music.YandexMusicObject`. diff --git a/yandex_music/cover.py b/yandex_music/cover.py index cb16289..925b5dc 100644 --- a/yandex_music/cover.py +++ b/yandex_music/cover.py @@ -18,8 +18,8 @@ class Cover(YandexMusicObject): custom (:obj:`bool`): Является ли обложка пользовательской. prefix (:obj:`str`): Уникальный идентификатор. error (:obj:`str`): Сообщение об ошибке. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: type_ (:obj:`str`, optional): Тип обложки. @@ -30,7 +30,7 @@ class Cover(YandexMusicObject): custom (:obj:`bool`, optional): Является ли обложка пользовательской. prefix (:obj:`str`, optional): Уникальный идентификатор. error (:obj:`str`, optional): Сообщение об ошибке. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -66,7 +66,6 @@ class Cover(YandexMusicObject): index (:obj:`int`, optional): Индекс элемента в списке ссылок на обложки если нет `self.uri`. size (:obj:`str`, optional): Размер изображения. """ - uri = self.uri or self.items_uri[index] self.client.request.download(f'https://{uri.replace("%%", size)}', filename) @@ -77,8 +76,8 @@ class Cover(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Cover`: Объект класса :class:`yandex_music.Cover`. @@ -96,8 +95,8 @@ class Cover(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Cover`: Список объектов класса :class:`yandex_music.Cover`. diff --git a/yandex_music/download_info.py b/yandex_music/download_info.py index bf4d68f..582f899 100644 --- a/yandex_music/download_info.py +++ b/yandex_music/download_info.py @@ -20,8 +20,8 @@ class DownloadInfo(YandexMusicObject): preview (:obj:`bool`): Предварительный просмотр TODO. download_info_url (:obj:`str`): Ссылка на XML документ содержащий данные для загрузки трека. direct_link (:obj:`str`): Прямая ссылка на загрузку. Доступна после получения ссылки. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: codec (:obj:`str`): Кодек аудиофайла. @@ -29,7 +29,7 @@ class DownloadInfo(YandexMusicObject): gain (:obj:`bool`): Усиление TODO. preview (:obj:`bool`): Предварительный просмотр TODO. download_info_url (:obj:`str`): Ссылка на XML документ содержащий данные для загрузки трека. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -71,7 +71,6 @@ class DownloadInfo(YandexMusicObject): :obj:`str`: Прямая ссылка на загрузку трека. """ - result = self.client.request.retrieve(self.download_info_url) doc = minidom.parseString(result.text) @@ -92,7 +91,6 @@ class DownloadInfo(YandexMusicObject): Args: filename (:obj:`str`): Путь и(или) название файла вместе с расширением. """ - if self.direct_link is None: self.get_direct_link() @@ -104,8 +102,8 @@ class DownloadInfo(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.DownloadInfo`: Объект класса :class:`yandex_music.DownloadInfo`. @@ -124,8 +122,8 @@ class DownloadInfo(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. get_direct_links (:obj:`bool`): Получать ли сразу прямые ссылки на загрузку. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.DownloadInfo`: Список объектов класса :class:`yandex_music.DownloadInfo`. diff --git a/yandex_music/experiments.py b/yandex_music/experiments.py index eb45574..b119a83 100644 --- a/yandex_music/experiments.py +++ b/yandex_music/experiments.py @@ -11,12 +11,12 @@ class Experiments(YandexMusicObject): """Класс представления каких-то свистелок-перделок, флажков, режимов экспериментальных функций. Attributes: - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. название_эксперимента (:obj:`str`, optional): Содержит режим или состояние, или функцию, или ещё что угодно. Args: - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Собственно тут и передаются все эти свистелки. """ @@ -34,8 +34,8 @@ class Experiments(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Experiments`: Объект класса :class:`yandex_music.Experiments`. diff --git a/yandex_music/feed/album_event.py b/yandex_music/feed/album_event.py index 7734678..11bc5e0 100644 --- a/yandex_music/feed/album_event.py +++ b/yandex_music/feed/album_event.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class AlbumEvent(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, album: Optional['Album'], tracks: List['Track'], @@ -24,8 +36,8 @@ class AlbumEvent(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.AlbumEvent`: Объект класса :class:`yandex_music.AlbumEvent`. @@ -46,8 +58,8 @@ class AlbumEvent(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.AlbumEvent`: Список объектов класса :class:`yandex_music.AlbumEvent`. diff --git a/yandex_music/feed/artist_event.py b/yandex_music/feed/artist_event.py index c2251a7..9ecf203 100644 --- a/yandex_music/feed/artist_event.py +++ b/yandex_music/feed/artist_event.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class ArtistEvent(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, artist: Optional['Artist'], tracks: List['Track'], @@ -26,8 +38,8 @@ class ArtistEvent(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ArtistEvent`: Объект класса :class:`yandex_music.ArtistEvent`. @@ -49,8 +61,8 @@ class ArtistEvent(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.ArtistEvent`: Список объектов класса :class:`yandex_music.ArtistEvent`. diff --git a/yandex_music/feed/day.py b/yandex_music/feed/day.py index 863965a..657a64a 100644 --- a/yandex_music/feed/day.py +++ b/yandex_music/feed/day.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Day(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, day: str, events: List['Event'], @@ -28,8 +40,8 @@ class Day(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Day`: Объект класса :class:`yandex_music.Day`. @@ -51,8 +63,8 @@ class Day(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Day`: Список объектов класса :class:`yandex_music.Day`. diff --git a/yandex_music/feed/event.py b/yandex_music/feed/event.py index c32288d..cbeb4d4 100644 --- a/yandex_music/feed/event.py +++ b/yandex_music/feed/event.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Event(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: str, type_: str, @@ -41,8 +53,8 @@ class Event(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Event`: Объект класса :class:`yandex_music.Event`. @@ -64,8 +76,8 @@ class Event(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Event`: Список объектов класса :class:`yandex_music.Event`. diff --git a/yandex_music/feed/feed.py b/yandex_music/feed/feed.py index 0798b36..253a372 100644 --- a/yandex_music/feed/feed.py +++ b/yandex_music/feed/feed.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Feed(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, can_get_more_events: bool, pumpkin: bool, @@ -37,8 +49,8 @@ class Feed(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Feed`: Объект класса :class:`yandex_music.Feed`. diff --git a/yandex_music/feed/generated_playlist.py b/yandex_music/feed/generated_playlist.py index f71d1a5..0e7939a 100644 --- a/yandex_music/feed/generated_playlist.py +++ b/yandex_music/feed/generated_playlist.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class GeneratedPlaylist(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, ready: bool, @@ -28,8 +40,8 @@ class GeneratedPlaylist(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.GeneratedPlaylist`: Объект класса :class:`yandex_music.GeneratedPlaylist`. @@ -49,8 +61,8 @@ class GeneratedPlaylist(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.GeneratedPlaylist`: Список объектов класса diff --git a/yandex_music/feed/track_with_ads.py b/yandex_music/feed/track_with_ads.py index 785553e..bf3cd9f 100644 --- a/yandex_music/feed/track_with_ads.py +++ b/yandex_music/feed/track_with_ads.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class TrackWithAds(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, track: Optional['Track'], @@ -24,8 +36,8 @@ class TrackWithAds(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TrackWithAds`: Объект класса :class:`yandex_music.TrackWithAds`. @@ -45,8 +57,8 @@ class TrackWithAds(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.TrackWithAds`: Список объектов класса :class:`yandex_music.TrackWithAds`. diff --git a/yandex_music/genre/genre.py b/yandex_music/genre/genre.py index 089e23d..6218e24 100644 --- a/yandex_music/genre/genre.py +++ b/yandex_music/genre/genre.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Genre(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: str, weight: int, @@ -47,8 +59,8 @@ class Genre(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Genre`: Объект класса :class:`yandex_music.Genre`. @@ -71,8 +83,8 @@ class Genre(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Genre`: Список объектов класса :class:`yandex_music.Genre`. diff --git a/yandex_music/genre/images.py b/yandex_music/genre/images.py index f6d788e..fc6055c 100644 --- a/yandex_music/genre/images.py +++ b/yandex_music/genre/images.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Images(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, _208x208: Optional[str] = None, _300x300: Optional[str] = None, @@ -23,7 +35,6 @@ class Images(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. """ - self.client.request.download(self._208x208, filename) def download_300x300(self, filename: str) -> None: @@ -32,7 +43,6 @@ class Images(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. """ - self.client.request.download(self._300x300, filename) @classmethod @@ -41,8 +51,8 @@ class Images(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Images`: Объект класса :class:`yandex_music.Images`. diff --git a/yandex_music/genre/title.py b/yandex_music/genre/title.py index 54d63e6..1dd91ea 100644 --- a/yandex_music/genre/title.py +++ b/yandex_music/genre/title.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Title(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, title: str, full_title: Optional[str] = None, @@ -24,8 +36,8 @@ class Title(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Title`: Объект класса :class:`yandex_music.Title`. @@ -43,8 +55,8 @@ class Title(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Title`: Список объектов класса :class:`yandex_music.Title`. diff --git a/yandex_music/icon.py b/yandex_music/icon.py index 444f475..fa9cf1d 100644 --- a/yandex_music/icon.py +++ b/yandex_music/icon.py @@ -12,13 +12,13 @@ class Icon(YandexMusicObject): Attributes: background_color (:obj:`str`): Цвет заднего фона в HEX. image_url (:obj:`str`): Ссылка на изображение. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: background_color (:obj:`str`): Цвет заднего фона в HEX. image_url (:obj:`str`): Ссылка на изображение. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -41,7 +41,6 @@ class Icon(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер иконки. """ - self.client.request.download(f'https://{self.image_url.replace("%%", size)}', filename) @classmethod @@ -50,8 +49,8 @@ class Icon(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Icon`: Объект класса :class:`yandex_music.Icon`. diff --git a/yandex_music/invocation_info.py b/yandex_music/invocation_info.py index 802b206..3d4e0df 100644 --- a/yandex_music/invocation_info.py +++ b/yandex_music/invocation_info.py @@ -13,14 +13,14 @@ class InvocationInfo(YandexMusicObject): hostname (:obj:`str`): Имя удалённого сервера. req_id (:obj:`str`): Номер запроса. exec_duration_millis (:obj:`str`): Время выполнения в миллисекундах. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: hostname (:obj:`str`): Имя удалённого сервера. req_id (:obj:`str`): Номер запроса. exec_duration_millis (:obj:`str`, optional): Время выполнения в миллисекундах. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -45,8 +45,8 @@ class InvocationInfo(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.InvocationInfo`: Объект класса :class:`yandex_music.InvocationInfo`. diff --git a/yandex_music/landing/block.py b/yandex_music/landing/block.py index 894a64b..84cc803 100644 --- a/yandex_music/landing/block.py +++ b/yandex_music/landing/block.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Block(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: str, type_: str, @@ -39,8 +51,8 @@ class Block(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Block`: Объект класса :class:`yandex_music.Block`. @@ -66,8 +78,8 @@ class Block(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Block`: Список объектов класса :class:`yandex_music.Block`. diff --git a/yandex_music/landing/block_entity.py b/yandex_music/landing/block_entity.py index ce1028a..0a66717 100644 --- a/yandex_music/landing/block_entity.py +++ b/yandex_music/landing/block_entity.py @@ -18,6 +18,18 @@ de_json = { class BlockEntity(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: str, type_: str, @@ -39,8 +51,8 @@ class BlockEntity(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.BlockEntity`: Объект класса :class:`yandex_music.BlockEntity`. @@ -59,8 +71,8 @@ class BlockEntity(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.BlockEntity`: Список объектов класса :class:`yandex_music.BlockEntity`. diff --git a/yandex_music/landing/chart.py b/yandex_music/landing/chart.py index 817af9d..1645c8e 100644 --- a/yandex_music/landing/chart.py +++ b/yandex_music/landing/chart.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Chart(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, position: int, progress: str, @@ -31,13 +43,12 @@ class Chart(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Chart`: Объект класса :class:`yandex_music.Chart`. """ - if not data: return None @@ -53,8 +64,8 @@ class Chart(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Chart`: Список объектов класса :class:`yandex_music.Chart`. diff --git a/yandex_music/landing/chart_item.py b/yandex_music/landing/chart_item.py index 02bc4bb..6875560 100644 --- a/yandex_music/landing/chart_item.py +++ b/yandex_music/landing/chart_item.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class ChartItem(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, track: Optional['Track'], chart: Optional['Chart'], @@ -24,8 +36,8 @@ class ChartItem(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ChartItem`: Объект класса :class:`yandex_music.ChartItem`. @@ -46,8 +58,8 @@ class ChartItem(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.ChartItem`: Список объектов класса :class:`yandex_music.ChartItem`. diff --git a/yandex_music/landing/landing.py b/yandex_music/landing/landing.py index dfe5920..a956cbd 100644 --- a/yandex_music/landing/landing.py +++ b/yandex_music/landing/landing.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Landing(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, pumpkin: bool, content_id: Union[str, int], @@ -30,8 +42,8 @@ class Landing(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Landing`: Объект класса :class:`yandex_music.Landing`. diff --git a/yandex_music/landing/mix_link.py b/yandex_music/landing/mix_link.py index 8a54f8a..fd0f18b 100644 --- a/yandex_music/landing/mix_link.py +++ b/yandex_music/landing/mix_link.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class MixLink(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, title: str, url: str, @@ -36,7 +48,6 @@ class MixLink(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер заднего фона. """ - self.client.request.download(f'https://{self.background_image_uri.replace("%%", size)}', filename) @classmethod @@ -45,8 +56,8 @@ class MixLink(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.MixLink`: Объект класса :class:`yandex_music.MixLink`. @@ -64,8 +75,8 @@ class MixLink(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.MixLink`: Список объектов класса :class:`yandex_music.MixLink`. diff --git a/yandex_music/landing/personal_playlists_data.py b/yandex_music/landing/personal_playlists_data.py index b286f7c..dc4b70f 100644 --- a/yandex_music/landing/personal_playlists_data.py +++ b/yandex_music/landing/personal_playlists_data.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PersonalPlaylistsData(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, is_wizard_passed: bool, client: Optional['Client'] = None, @@ -22,8 +34,8 @@ class PersonalPlaylistsData(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PersonalPlaylistsData`: Объект класса :class:`yandex_music.PersonalPlaylistsData`. diff --git a/yandex_music/landing/play_context.py b/yandex_music/landing/play_context.py index af93406..6d847e8 100644 --- a/yandex_music/landing/play_context.py +++ b/yandex_music/landing/play_context.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PlayContext(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, client_: str, context: str, @@ -28,8 +40,8 @@ class PlayContext(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlayContext`: Объект класса :class:`yandex_music.PlayContext`. diff --git a/yandex_music/landing/play_contexts_data.py b/yandex_music/landing/play_contexts_data.py index 0296384..f243f16 100644 --- a/yandex_music/landing/play_contexts_data.py +++ b/yandex_music/landing/play_contexts_data.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PlayContextsData(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, other_tracks: List['TrackShortOld'], client: Optional['Client'] = None, @@ -22,8 +34,8 @@ class PlayContextsData(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlayContextsData`: Объект класса :class:`yandex_music.PlayContextsData`. diff --git a/yandex_music/landing/promotion.py b/yandex_music/landing/promotion.py index 6aca4a5..41a7bd5 100644 --- a/yandex_music/landing/promotion.py +++ b/yandex_music/landing/promotion.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Promotion(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, promo_id: str, title: str, @@ -39,8 +51,8 @@ class Promotion(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Promotion`: Объект класса :class:`yandex_music.Promotion`. @@ -58,8 +70,8 @@ class Promotion(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Promotion`: Список объектов класса :class:`yandex_music.Promotion`. diff --git a/yandex_music/landing/track_id.py b/yandex_music/landing/track_id.py index f38c7a0..efb5957 100644 --- a/yandex_music/landing/track_id.py +++ b/yandex_music/landing/track_id.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class TrackId(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: int, album_id: Optional[int] = None, @@ -24,8 +36,8 @@ class TrackId(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TrackId`: Объект класса :class:`yandex_music.TrackId`. diff --git a/yandex_music/landing/track_short_old.py b/yandex_music/landing/track_short_old.py index 8b83331..9d52285 100644 --- a/yandex_music/landing/track_short_old.py +++ b/yandex_music/landing/track_short_old.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class TrackShortOld(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, track_id: Optional['TrackId'], timestamp: str, @@ -24,8 +36,8 @@ class TrackShortOld(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TrackShortOld`: Объект класса :class:`yandex_music.TrackShortOld`. @@ -45,8 +57,8 @@ class TrackShortOld(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.TrackShortOld`: Список объектов класса diff --git a/yandex_music/likes/albums_likes.py b/yandex_music/likes/albums_likes.py index 28fd47b..fb267b2 100644 --- a/yandex_music/likes/albums_likes.py +++ b/yandex_music/likes/albums_likes.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class AlbumsLikes(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, timestamp: str, id_: Optional[int] = None, @@ -26,8 +38,8 @@ class AlbumsLikes(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.AlbumsLikes`: Объект класса :class:`yandex_music.AlbumsLikes`. @@ -47,8 +59,8 @@ class AlbumsLikes(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.AlbumsLikes`: Список объектов класса :class:`yandex_music.AlbumsLikes`. diff --git a/yandex_music/likes/artists_likes.py b/yandex_music/likes/artists_likes.py index 6745064..7450532 100644 --- a/yandex_music/likes/artists_likes.py +++ b/yandex_music/likes/artists_likes.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class ArtistsLikes(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_=None, artist: Optional['Artist'] = None, @@ -26,8 +38,8 @@ class ArtistsLikes(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ArtistsLikes`: Объект класса :class:`yandex_music.ArtistsLikes`. @@ -52,8 +64,8 @@ class ArtistsLikes(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.ArtistsLikes`: Список объектов класса :class:`yandex_music.ArtistsLikes`. diff --git a/yandex_music/likes/playlists_likes.py b/yandex_music/likes/playlists_likes.py index 2da83c0..713ac31 100644 --- a/yandex_music/likes/playlists_likes.py +++ b/yandex_music/likes/playlists_likes.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PlaylistsLikes(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, timestamp: str, id_=None, @@ -26,8 +38,8 @@ class PlaylistsLikes(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlaylistsLikes`: Объект класса :class:`yandex_music.PlaylistsLikes`. @@ -47,8 +59,8 @@ class PlaylistsLikes(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.PlaylistsLikes`: Список объектов класса diff --git a/yandex_music/pager.py b/yandex_music/pager.py index d8baf25..05beb7b 100644 --- a/yandex_music/pager.py +++ b/yandex_music/pager.py @@ -13,14 +13,14 @@ class Pager(YandexMusicObject): total (:obj:`int`): Всего треков. page (:obj:`int`): Номер страницы. per_page (:obj:`int`): Количество треков на странице. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: total (:obj:`int`): Всего треков. page (:obj:`int`): Номер страницы. per_page (:obj:`int`): Количество треков на странице. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -44,8 +44,8 @@ class Pager(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Pager`: Объект класса :class:`yandex_music.Pager`. diff --git a/yandex_music/permission_alerts.py b/yandex_music/permission_alerts.py index 814649d..9e80608 100644 --- a/yandex_music/permission_alerts.py +++ b/yandex_music/permission_alerts.py @@ -11,12 +11,12 @@ class PermissionAlerts(YandexMusicObject): Attributes: alerts (:obj:`list` из :obj:`str`): Список оповещений. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: alerts (:obj:`list` из :obj:`str`): Список оповещений. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -35,8 +35,8 @@ class PermissionAlerts(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PermissionAlerts`: Объект класса :class:`yandex_music.PermissionAlerts`. diff --git a/yandex_music/playlist/case_forms.py b/yandex_music/playlist/case_forms.py index 794bd68..4bd0736 100644 --- a/yandex_music/playlist/case_forms.py +++ b/yandex_music/playlist/case_forms.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class CaseForms(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, nominative: str, genitive: str, @@ -33,8 +45,8 @@ class CaseForms(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.CaseForms`: Объект класса :class:`yandex_music.CaseForms`. diff --git a/yandex_music/playlist/made_for.py b/yandex_music/playlist/made_for.py index 186669a..002ac30 100644 --- a/yandex_music/playlist/made_for.py +++ b/yandex_music/playlist/made_for.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class MadeFor(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, user_info: Optional['User'], case_forms: Optional['CaseForms'], @@ -24,8 +36,8 @@ class MadeFor(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.MadeFor`: Объект класса :class:`yandex_music.MadeFor`. diff --git a/yandex_music/playlist/play_counter.py b/yandex_music/playlist/play_counter.py index 1f620d1..c1312e9 100644 --- a/yandex_music/playlist/play_counter.py +++ b/yandex_music/playlist/play_counter.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PlayCounter(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, value: int, description: str, @@ -26,8 +38,8 @@ class PlayCounter(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlayCounter`: Объект класса :class:`yandex_music.PlayCounter`. diff --git a/yandex_music/playlist/playlist.py b/yandex_music/playlist/playlist.py index d8ab9be..acc3034 100644 --- a/yandex_music/playlist/playlist.py +++ b/yandex_music/playlist/playlist.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Playlist(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, owner: Optional['User'], cover: Optional['Cover'], @@ -92,7 +104,6 @@ class Playlist(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением (GIF). size (:obj:`str`, optional): Размер анимированной обложки. """ - self.client.request.download(f'https://{self.animated_cover_uri.replace("%%", size)}', filename) def download_og_image(self, filename: str, size: str = '200x200') -> None: @@ -104,7 +115,6 @@ class Playlist(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename) def rename(self, name: str) -> None: @@ -133,8 +143,8 @@ class Playlist(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Playlist`: Объект класса :class:`yandex_music.Playlist`. @@ -163,8 +173,8 @@ class Playlist(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Playlist`: Список объектов класса :class:`yandex_music.Playlist`. diff --git a/yandex_music/playlist/playlist_absence.py b/yandex_music/playlist/playlist_absence.py index 40d4d44..496efc7 100644 --- a/yandex_music/playlist/playlist_absence.py +++ b/yandex_music/playlist/playlist_absence.py @@ -12,13 +12,13 @@ class PlaylistAbsence(YandexMusicObject): Attributes: kind (:obj:`int`): Уникальный идентификатор плейлиста. reason (:obj:`str`): Причина отсутствия. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: kind (:obj:`int`): Уникальный идентификатор плейлиста. reason (:obj:`str`): Причина отсутствия. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class PlaylistAbsence(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlaylistAbsence`: Объект класса :class:`yandex_music.PlaylistAbsence`. diff --git a/yandex_music/playlist/playlist_id.py b/yandex_music/playlist/playlist_id.py index 34f7058..f154823 100644 --- a/yandex_music/playlist/playlist_id.py +++ b/yandex_music/playlist/playlist_id.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class PlaylistId(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, uid: int, kind: int, @@ -24,13 +36,12 @@ class PlaylistId(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PlaylistId`: Объект класса :class:`yandex_music.PlaylistId`. """ - if not data: return None @@ -44,8 +55,8 @@ class PlaylistId(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.PlaylistId`: Список объектов класса :class:`yandex_music.PlaylistId`. diff --git a/yandex_music/playlist/user.py b/yandex_music/playlist/user.py index 08b2037..9b9478d 100644 --- a/yandex_music/playlist/user.py +++ b/yandex_music/playlist/user.py @@ -15,8 +15,8 @@ class User(YandexMusicObject): name (:obj:`str`): Имя пользователя. sex (:obj:`str`): Пол пользователя. verified (:obj:`bool`): Участвует ли пользователь в генерации плейлистов дня и т.д., и т.п. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: uid (:obj:`int`): Идентификатор пользователя. @@ -24,7 +24,7 @@ class User(YandexMusicObject): name (:obj:`str`): Имя пользователя. sex (:obj:`str`): Пол пользователя. verified (:obj:`bool`): Участвует ли пользователь в генерации плейлистов дня и т.д., и т.п. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -53,7 +53,6 @@ class User(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. format_ (:obj:`str`, optional): Формат желаемого изображения (`normal`, `orig`, `small`, `big`). """ - self.client.request.download(f'https://upics.yandex.net/{self.uid}/{format_}', filename) @classmethod @@ -62,8 +61,8 @@ class User(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.User`: Объект класса :class:`yandex_music.User`. diff --git a/yandex_music/promo_code_status.py b/yandex_music/promo_code_status.py index d168e8a..a160e74 100644 --- a/yandex_music/promo_code_status.py +++ b/yandex_music/promo_code_status.py @@ -14,15 +14,15 @@ class PromoCodeStatus(YandexMusicObject): status_desc (:obj:`str`): Описание статуса. account_status (:obj:`yandex_music.Status`): Объект класса :class:`yandex_music.Status` представляющий подробную информацию об аккаунте пользователя. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: status (:obj:`str`): Статус операции. status_desc (:obj:`str`): Описание статуса. account_status (:obj:`yandex_music.Status`): Объект класса :class:`yandex_music.Status` представляющий подробную информацию об аккаунте пользователя. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -46,8 +46,8 @@ class PromoCodeStatus(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.PromoCodeStatus`: Объект класса :class:`yandex_music.PromoCodeStatus`. diff --git a/yandex_music/rotor/ad_params.py b/yandex_music/rotor/ad_params.py index 38c6795..6dedc82 100644 --- a/yandex_music/rotor/ad_params.py +++ b/yandex_music/rotor/ad_params.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class AdParams(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, partner_id: Union[str, int], category_id: Union[str, int], @@ -38,8 +50,8 @@ class AdParams(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.AdParams`: Объект класса :class:`yandex_music.AdParams`. diff --git a/yandex_music/rotor/dashboard.py b/yandex_music/rotor/dashboard.py index f348f16..9a683fa 100644 --- a/yandex_music/rotor/dashboard.py +++ b/yandex_music/rotor/dashboard.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Dashboard(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, dashboard_id: str, stations: List['StationResult'], @@ -26,8 +38,8 @@ class Dashboard(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Dashboard`: Объект класса :class:`yandex_music.Dashboard`. diff --git a/yandex_music/rotor/discrete_scale.py b/yandex_music/rotor/discrete_scale.py index 17bd107..ae69ebe 100644 --- a/yandex_music/rotor/discrete_scale.py +++ b/yandex_music/rotor/discrete_scale.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class DiscreteScale(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, name: str, @@ -28,8 +40,8 @@ class DiscreteScale(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.DiscreteScale`: Объект класса :class:`yandex_music.DiscreteScale`. diff --git a/yandex_music/rotor/enum.py b/yandex_music/rotor/enum.py index 1e08552..af5e506 100644 --- a/yandex_music/rotor/enum.py +++ b/yandex_music/rotor/enum.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Enum(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, name: str, @@ -26,8 +38,8 @@ class Enum(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Enum`: Объект класса :class:`yandex_music.Enum`. diff --git a/yandex_music/rotor/id.py b/yandex_music/rotor/id.py index 4ceb866..0515659 100644 --- a/yandex_music/rotor/id.py +++ b/yandex_music/rotor/id.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Id(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, tag: str, @@ -24,8 +36,8 @@ class Id(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Id`: Объект класса :class:`yandex_music.Id`. diff --git a/yandex_music/rotor/restrictions.py b/yandex_music/rotor/restrictions.py index be2d545..0c114b8 100644 --- a/yandex_music/rotor/restrictions.py +++ b/yandex_music/rotor/restrictions.py @@ -12,6 +12,18 @@ de_json = { class Restrictions(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, language: Optional[Union['Enum', 'DiscreteScale']], diversity: Optional[Union['Enum', 'DiscreteScale']], @@ -35,8 +47,8 @@ class Restrictions(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Restrictions`: Объект класса :class:`yandex_music.Restrictions`. diff --git a/yandex_music/rotor/rotor_settings.py b/yandex_music/rotor/rotor_settings.py index 188df6a..f499cb8 100644 --- a/yandex_music/rotor/rotor_settings.py +++ b/yandex_music/rotor/rotor_settings.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class RotorSettings(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, language: str, diversity: str, @@ -31,8 +43,8 @@ class RotorSettings(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.RotorSettings`: Объект класса :class:`yandex_music.RotorSettings`. diff --git a/yandex_music/rotor/sequence.py b/yandex_music/rotor/sequence.py index c553cd7..a28179c 100644 --- a/yandex_music/rotor/sequence.py +++ b/yandex_music/rotor/sequence.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Sequence(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, track: Optional['Track'], @@ -26,8 +38,8 @@ class Sequence(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Sequence`: Объект класса :class:`yandex_music.Sequence`. @@ -47,8 +59,8 @@ class Sequence(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Sequence`: Список объектов класса :class:`yandex_music.Sequence`. diff --git a/yandex_music/rotor/station.py b/yandex_music/rotor/station.py index 6ed0ce5..2ed4e66 100644 --- a/yandex_music/rotor/station.py +++ b/yandex_music/rotor/station.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Station(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: Optional['Id'], name: str, @@ -40,8 +52,8 @@ class Station(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Station`: Объект класса :class:`yandex_music.Station`. diff --git a/yandex_music/rotor/station_result.py b/yandex_music/rotor/station_result.py index bde51ee..bd5d487 100644 --- a/yandex_music/rotor/station_result.py +++ b/yandex_music/rotor/station_result.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class StationResult(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, station: Optional['Station'], settings: Optional['RotorSettings'], @@ -32,8 +44,8 @@ class StationResult(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.StationResult`: Объект класса :class:`yandex_music.StationResult`. @@ -56,8 +68,8 @@ class StationResult(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.StationResult`: Список объектов класса :class:`yandex_music.StationResult`. diff --git a/yandex_music/rotor/station_tracks_result.py b/yandex_music/rotor/station_tracks_result.py index b21e734..308846c 100644 --- a/yandex_music/rotor/station_tracks_result.py +++ b/yandex_music/rotor/station_tracks_result.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class StationTracksResult(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: Optional['Id'], sequence: List['Sequence'], @@ -28,8 +40,8 @@ class StationTracksResult(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.StationTracksResult`: Объект класса :class:`yandex_music.StationTracksResult`. diff --git a/yandex_music/rotor/value.py b/yandex_music/rotor/value.py index cc86ef3..9ab03db 100644 --- a/yandex_music/rotor/value.py +++ b/yandex_music/rotor/value.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Value(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, value: str, name: str, @@ -24,8 +36,8 @@ class Value(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Value`: Объект класса :class:`yandex_music.Value`. @@ -43,8 +55,8 @@ class Value(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Value`: Список объектов класса :class:`yandex_music.Value`. diff --git a/yandex_music/search/best.py b/yandex_music/search/best.py index 68e53de..96f9e75 100644 --- a/yandex_music/search/best.py +++ b/yandex_music/search/best.py @@ -16,6 +16,18 @@ de_json_result = { class Best(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, type_: str, result: Optional[Union[Track, Artist, Album, Playlist, Video]], @@ -36,8 +48,8 @@ class Best(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Best`: Объект класса :class:`yandex_music.Best`. diff --git a/yandex_music/search/search.py b/yandex_music/search/search.py index 8f800c7..78d78b0 100644 --- a/yandex_music/search/search.py +++ b/yandex_music/search/search.py @@ -25,8 +25,8 @@ class Search(YandexMusicObject): найденные видео. misspell_corrected (:obj:`bool`): Был ли исправлен запрос. nocorrect (:obj:`bool`): Было ли отключено исправление результата. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: search_request_id (:obj:`str`): ID запроса. @@ -44,7 +44,7 @@ class Search(YandexMusicObject): найденные видео. misspell_corrected (:obj:`bool`, optional): Был ли исправлен запрос. nocorrect (:obj:`bool`, optional): Было ли отключено исправление результата. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -84,8 +84,8 @@ class Search(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Search`: Объект класса :class:`yandex_music.Search`. diff --git a/yandex_music/search/search_result.py b/yandex_music/search/search_result.py index 94e129d..27200b6 100644 --- a/yandex_music/search/search_result.py +++ b/yandex_music/search/search_result.py @@ -24,8 +24,8 @@ class SearchResult(YandexMusicObject): 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. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: total (:obj:`int`): Количество результатов. @@ -33,7 +33,7 @@ class SearchResult(YandexMusicObject): 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` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -60,8 +60,8 @@ class SearchResult(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. type_ (:obj:`str`, optional): Тип результата. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.SearchResult`: Объект класса :class:`yandex_music.SearchResult`. diff --git a/yandex_music/search/suggestions.py b/yandex_music/search/suggestions.py index 32fe649..1f73857 100644 --- a/yandex_music/search/suggestions.py +++ b/yandex_music/search/suggestions.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Suggestions(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, best: Optional['Best'], suggestions: List[str], @@ -30,8 +42,8 @@ class Suggestions(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Suggestions`: Объект класса :class:`yandex_music.Suggestions`. diff --git a/yandex_music/settings.py b/yandex_music/settings.py index cc6ca72..dab1bec 100644 --- a/yandex_music/settings.py +++ b/yandex_music/settings.py @@ -18,8 +18,8 @@ class Settings(YandexMusicObject): web_payment_month_product_price (:obj:`yandex_music.Price`): Объект класса :class:`yandex_music.Price` представляющий цену продукта за месяц. promo_codes_enabled (:obj:`bool`): Доступно ли использование промо-кодов. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: in_app_products (:obj:`list` из :obj:`yandex_music.Product`): Список объектов класса @@ -30,7 +30,7 @@ class Settings(YandexMusicObject): web_payment_month_product_price (:obj:`yandex_music.Price`, optional): Объект класса :class:`yandex_music.Price` представляющий цену продукта за месяц. promo_codes_enabled (:obj:`bool`): Доступно ли использование промо-кодов. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -58,8 +58,8 @@ class Settings(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Settings`: Объект класса :class:`yandex_music.Settings`. diff --git a/yandex_music/shot/shot.py b/yandex_music/shot/shot.py index 397dfec..aef7bab 100644 --- a/yandex_music/shot/shot.py +++ b/yandex_music/shot/shot.py @@ -19,8 +19,8 @@ class Shot(YandexMusicObject): основную информацию о шоте. shot_id (:obj:`str`): Уникальный идентификатор шота. status (:obj:`str`): Статус шота. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: order (:obj:`int`): Порядковый номер при воспроизведении. @@ -29,7 +29,7 @@ class Shot(YandexMusicObject): основную информацию о шоте. shot_id (:obj:`str`): Уникальный идентификатор шота. status (:obj:`str`): Статус шота. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -57,8 +57,8 @@ class Shot(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Shot`: Объект класса :class:`yandex_music.Shot`. @@ -78,8 +78,8 @@ class Shot(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Shot`: Список объектов класса :class:`yandex_music.Shot`. diff --git a/yandex_music/shot/shot_data.py b/yandex_music/shot/shot_data.py index a28b2e5..c4d1cfa 100644 --- a/yandex_music/shot/shot_data.py +++ b/yandex_music/shot/shot_data.py @@ -15,8 +15,8 @@ class ShotData(YandexMusicObject): shot_text (:obj:`str`): Текстовая версия шота. shot_type (:obj:`yandex_music.ShotType`): Объект класса :class:`yandex_music.ShotType` представляющий тип шота. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: cover_uri (:obj:`str`): Ссылка на обложку шота (иконка Алисы). @@ -24,7 +24,7 @@ class ShotData(YandexMusicObject): shot_text (:obj:`str`): Текстовая версия шота. shot_type (:obj:`yandex_music.ShotType`): Объект класса :class:`yandex_music.ShotType` представляющий тип шота. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -51,7 +51,6 @@ class ShotData(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.cover_uri.replace("%%", size)}', filename) def download_mds(self, filename: str) -> None: @@ -60,7 +59,6 @@ class ShotData(YandexMusicObject): Args: filename (:obj:`str`): Путь для сохранения файла с названием и расширением. """ - self.client.request.download(self.mds_url, filename) @classmethod @@ -69,8 +67,8 @@ class ShotData(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ShotData`: Объект класса :class:`yandex_music.ShotData`. diff --git a/yandex_music/shot/shot_event.py b/yandex_music/shot/shot_event.py index 11865bd..49c8e98 100644 --- a/yandex_music/shot/shot_event.py +++ b/yandex_music/shot/shot_event.py @@ -13,14 +13,14 @@ class ShotEvent(YandexMusicObject): event_id (:obj:`str`): Уникальный идентификатор события. shots (:obj:`list` из :obj:`yandex_music.Shot`): Список объектов класса :class:`yandex_music.Shot` представляющие шоты от Алисы. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: event_id (:obj:`str`): Уникальный идентификатор события. shots (:obj:`list` из :obj:`yandex_music.Shot`): Список объектов класса :class:`yandex_music.Shot` представляющие шоты от Алисы. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -42,8 +42,8 @@ class ShotEvent(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ShotEvent`: Объект класса :class:`yandex_music.ShotEvent`. diff --git a/yandex_music/shot/shot_type.py b/yandex_music/shot/shot_type.py index 87d0857..7a4bc3f 100644 --- a/yandex_music/shot/shot_type.py +++ b/yandex_music/shot/shot_type.py @@ -12,13 +12,13 @@ class ShotType(YandexMusicObject): Attributes: id (:obj:`str`): Уникальный идентификатор типа. title (:obj:`str`): Заголовок шота. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: id_ (:obj:`str`): Уникальный идентификатор типа. title (:obj:`str`): Заголовок шота. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -40,8 +40,8 @@ class ShotType(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.ShotType`: Объект класса :class:`yandex_music.ShotType`. diff --git a/yandex_music/supplement/lyrics.py b/yandex_music/supplement/lyrics.py index 0c18bcf..ad3d994 100644 --- a/yandex_music/supplement/lyrics.py +++ b/yandex_music/supplement/lyrics.py @@ -16,8 +16,8 @@ class Lyrics(YandexMusicObject): full_lyrics (:obj:`str`): Текст песни. text_language (:obj:`str`): Язык текста. show_translation (:obj:`bool`): Показывать ли перевод. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: id_ (:obj:`int`): Уникальный идентификатор текста трека. @@ -26,7 +26,7 @@ class Lyrics(YandexMusicObject): full_lyrics (:obj:`str`): Текст песни. text_language (:obj:`str`): Язык песни. show_translation (:obj:`bool`): Показывать ли перевод. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -57,8 +57,8 @@ class Lyrics(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Lyrics`: Объект класса :class:`yandex_music.Lyrics`. diff --git a/yandex_music/supplement/supplement.py b/yandex_music/supplement/supplement.py index 9d8ba24..c67bf99 100644 --- a/yandex_music/supplement/supplement.py +++ b/yandex_music/supplement/supplement.py @@ -15,8 +15,8 @@ class Supplement(YandexMusicObject): videos (:obj:`yandex_music.VideoSupplement`): Объект класса :class:`yandex_music.VideoSupplement` представляющий видео. radio_is_available (:obj:`bool`): Доступно ли радио. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: id_ (:obj:`int`): Уникальный идентификатор дополнительной информации. @@ -24,7 +24,7 @@ class Supplement(YandexMusicObject): videos (:obj:`yandex_music.VideoSupplement`): Объект класса :class:`yandex_music.VideoSupplement` представляющий видео. radio_is_available (:obj:`bool`): Доступно ли радио. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -50,8 +50,8 @@ class Supplement(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Supplement`: Объект класса :class:`yandex_music.Supplement`. diff --git a/yandex_music/supplement/video_supplement.py b/yandex_music/supplement/video_supplement.py index 53552c0..5404a10 100644 --- a/yandex_music/supplement/video_supplement.py +++ b/yandex_music/supplement/video_supplement.py @@ -17,8 +17,8 @@ class VideoSupplement(YandexMusicObject): url (:obj:`str`): URL на видео. embed_url (:obj:`str`): URL на видео, находящегося на серверах Яндекса. embed (:obj:`str`): HTML тег для встраивания видео. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: cover (:obj:`str`): URL на обложку видео. @@ -28,8 +28,8 @@ class VideoSupplement(YandexMusicObject): url (:obj:`str`): URL на видео. embed_url (:obj:`str`): URL на видео, находящегося на серверах Яндекса. embed (:obj:`str`): HTML тег для встраивания видео. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -61,8 +61,8 @@ class VideoSupplement(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.VideoSupplement`: Объект класса :class:`yandex_music.VideoSupplement`. @@ -80,8 +80,8 @@ class VideoSupplement(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.VideoSupplement`: Список объектов класса diff --git a/yandex_music/track/major.py b/yandex_music/track/major.py index 952ff6a..07672fd 100644 --- a/yandex_music/track/major.py +++ b/yandex_music/track/major.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Major(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: int, name: str, @@ -24,8 +36,8 @@ class Major(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Major`: Объект класса :class:`yandex_music.Major`. diff --git a/yandex_music/track/normalization.py b/yandex_music/track/normalization.py index de438a8..187721b 100644 --- a/yandex_music/track/normalization.py +++ b/yandex_music/track/normalization.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Normalization(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, gain: float, peak: int, @@ -24,8 +36,8 @@ class Normalization(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Normalization`: Объект класса :class:`yandex_music.Normalization`. diff --git a/yandex_music/track/track.py b/yandex_music/track/track.py index bd94fbf..0408d22 100644 --- a/yandex_music/track/track.py +++ b/yandex_music/track/track.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Track(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, id_: Union[str, int], title: str, @@ -82,7 +94,6 @@ class Track(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: @@ -94,7 +105,6 @@ class Track(YandexMusicObject): filename (:obj:`str`): Путь для сохранения файла с названием и расширением. size (:obj:`str`, optional): Размер обложки. """ - self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename) def download(self, filename: str, codec: str = 'mp3', bitrate_in_kbps: int = 192) -> None: @@ -131,8 +141,8 @@ class Track(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Track`: Объект класса :class:`yandex_music.Track`. @@ -155,8 +165,8 @@ class Track(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Track`: Список объектов класса :class:`yandex_music.Track`. diff --git a/yandex_music/track/tracks_similar.py b/yandex_music/track/tracks_similar.py index 37276af..9b4af7a 100644 --- a/yandex_music/track/tracks_similar.py +++ b/yandex_music/track/tracks_similar.py @@ -13,14 +13,14 @@ class SimilarTracks(YandexMusicObject): track (:obj:`yandex_music.Track`): Объект класса :class:`yandex_music.Track` представляющий трек. similar_tracks (:obj:`list` из :obj:`yandex_music.Track`): Список объектов класса :class:`yandex_music.Track` представляющие похожие треки на `track`. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: track (:obj:`yandex_music.Track`): Объект класса :class:`yandex_music.Track` представляющий трек. similar_tracks (:obj:`list` из :obj:`yandex_music.Track`): Список объектов класса :class:`yandex_music.Track` представляющие похожие треки на `track`. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -42,8 +42,8 @@ class SimilarTracks(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.SimilarTracks`: Объект класса :class:`yandex_music.SimilarTracks`. diff --git a/yandex_music/track_short.py b/yandex_music/track_short.py index 9f35f49..362dd3d 100644 --- a/yandex_music/track_short.py +++ b/yandex_music/track_short.py @@ -13,14 +13,14 @@ class TrackShort(YandexMusicObject): id (:obj:`str`): Уникальный идентификатор трека. timestamp (:obj:`str`): Дата TODO. album_id (:obj:`str`): Уникальный идентификатор альбома. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: id_ (:obj:`str`): Уникальный идентификатор трека. timestamp (:obj:`str`): Дата TODO. album_id (:obj:`str`, optional): Уникальный идентификатор альбома. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -54,7 +54,6 @@ class TrackShort(YandexMusicObject): @property def track_id(self) -> str: """:obj:`str`: Уникальный идентификатор трека состоящий из его номера и номера альбома или просто из номера.""" - if self.album_id: return f'{self.id}:{self.album_id}' @@ -66,8 +65,8 @@ class TrackShort(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TrackShort`: Объект класса :class:`yandex_music.TrackShort`. @@ -85,8 +84,8 @@ class TrackShort(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.TrackShort`: Список объектов класса :class:`yandex_music.TrackShort`. diff --git a/yandex_music/tracks_list.py b/yandex_music/tracks_list.py index c4d5490..3cc8f89 100644 --- a/yandex_music/tracks_list.py +++ b/yandex_music/tracks_list.py @@ -13,14 +13,14 @@ class TracksList(YandexMusicObject): uid (:obj:`int`): Уникальный идентификатор пользователя. revision (:obj:`int`): Актуальность данных TODO. tracks (:obj:`list` из :obj:`yandex_music.TrackShort`): Список треков. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: uid (:obj:`int`): Уникальный идентификатор пользователя. revision (:obj:`int`): Актуальность данных TODO. tracks (:obj:`list` из :obj:`yandex_music.TrackShort`): Список треков. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -55,8 +55,8 @@ class TracksList(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.TracksList`: Объект класса :class:`yandex_music.TracksList`. diff --git a/yandex_music/utils/captcha_response.py b/yandex_music/utils/captcha_response.py index df15c9e..394499b 100644 --- a/yandex_music/utils/captcha_response.py +++ b/yandex_music/utils/captcha_response.py @@ -14,15 +14,15 @@ class CaptchaResponse(YandexMusicObject): x_captcha_key (:obj:`str`): Уникальный ключ капчи. error_description (:obj:`str`): Описание ошибки. error (:obj:`str`): Код ошибки. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Args: x_captcha_url (:obj:`str`): Ссылка на изображение с капчей. x_captcha_key (:obj:`str`): Уникальный ключ капчи. error_description (:obj:`str`): Описание ошибки. error (:obj:`str`): Код ошибки. - client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент Yandex Music. **kwargs: Произвольные ключевые аргументы полученные от API. """ @@ -49,7 +49,6 @@ class CaptchaResponse(YandexMusicObject): filename (:obj:`str`, optional): Путь и(или) название файла вместе с расширением. По умолчанию ключ капчи и расширение `.gif`. """ - if not filename: filename = f'{self.x_captcha_key}.gif' @@ -61,8 +60,8 @@ class CaptchaResponse(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.utils.captcha_response.CaptchaResponse`: Объект класса diff --git a/yandex_music/utils/request.py b/yandex_music/utils/request.py index 0462df8..5d05b3e 100644 --- a/yandex_music/utils/request.py +++ b/yandex_music/utils/request.py @@ -30,8 +30,8 @@ class Request: файлов. Args: - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. headers (:obj:`dict`, optional): Заголовки передаваемые с каждым запросом. proxy_url (:obj:`str`, optional): Прокси. """ diff --git a/yandex_music/utils/response.py b/yandex_music/utils/response.py index 828a2c7..9f35337 100644 --- a/yandex_music/utils/response.py +++ b/yandex_music/utils/response.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Response(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, data, invocation_info=None, @@ -37,8 +49,8 @@ class Response(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.utils.response.Response`: Объект класса :class:`yandex_music.utils.response.Response`. diff --git a/yandex_music/video.py b/yandex_music/video.py index 3d54d61..d331725 100644 --- a/yandex_music/video.py +++ b/yandex_music/video.py @@ -7,6 +7,18 @@ if TYPE_CHECKING: class Video(YandexMusicObject): + """Класс, представляющий . + + Attributes: + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + + Args: + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, title: str, cover: Optional[str] = None, @@ -46,8 +58,8 @@ class Video(YandexMusicObject): Args: data (:obj:`dict`): Поля и значения десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`yandex_music.Video`: Объект класса :class:`yandex_music.Video`. @@ -65,8 +77,8 @@ class Video(YandexMusicObject): Args: data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта. - client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex - Music. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client`, представляющий клиент + Yandex Music. Returns: :obj:`list` из :obj:`yandex_music.Video`: Список объектов класса :class:`yandex_music.Video`.