Документация

Задокументирован класс ArtistAlbums
Задокументирован метод get_albums класса Artist
Задокументирован метод artists_albums класса Client
このコミットが含まれているのは:
Gleb Liutsko 2019-11-19 21:52:17 +04:00
コミット be3152a7ee
3個のファイルの変更46行の追加0行の削除

ファイルの表示

@ -96,6 +96,10 @@ class Artist(YandexMusicObject):
return self.client.artists_tracks(self.id, page, page_size, *args, **kwargs)
def get_albums(self, page=0, page_size=20, sort_by='year', *args, **kwargs):
"""Сокращение для::
client.artists_albums(artist.id, page, page_size, sort_by, *args, **kwargs)
"""
return self.client.artists_albums(self.id, page, page_size, sort_by, *args, **kwargs)
@classmethod

ファイルの表示

@ -2,6 +2,22 @@ from yandex_music import YandexMusicObject
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.
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` представляющий клиент Yandex
Music.
**kwargs: Произвольные ключевые аргументы полученные от API.
"""
def __init__(self,
albums,
pager,
@ -15,6 +31,16 @@ class ArtistAlbums(YandexMusicObject):
@classmethod
def de_json(cls, data, client):
"""Десериализация объекта.
Args:
data (:obj:`dict`): Поля и значения десериализуемого объекта.
client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex
Music.
Returns:
:obj:`yandex_music.ArtistAlbums`: Объект класса :class:`yandex_music.ArtistAlbums`.
"""
if not data:
return None

ファイルの表示

@ -923,6 +923,22 @@ class Client(YandexMusicObject):
@log
def artists_albums(self, artist_id: str or int, page=0, page_size=20, sort_by='year', timeout=None, *args, **kwargs):
"""Получение треков артиста.
Args:
artist_id (:obj:`str` | :obj:`int`): Уникальный идентификатор артиста.
page (:obj:`int`, optional): Номер страницы.
page_size (:obj:`int`, optional): Количество треков на странице.
sort_by (:obj:`str`, optional): Параметр для сортирвки.
timeout (:obj:`int` | :obj:`float`, optional): Если это значение указано, используется как время ожидания
ответа от сервера вместо указанного при создании пула.
**kwargs (:obj:`dict`, optional): Произвольные аргументы (будут переданы в запрос).
Returns:
:obj:`yandex_music.ArtistAlbums`: Объекта класса :class:`yandex_music.ArtistsTracks`
представляющий страницу списка альбомов артиста
"""
url = f'{self.base_url}/artists/{artist_id}/direct-albums'
params = {