From c03c9fd5cb47ca58cd37d459e6f7815375406fbf Mon Sep 17 00:00:00 2001 From: Gleb Liutsko Date: Wed, 22 Jan 2020 17:07:27 +0400 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B0=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?= =?UTF-8?q?=D0=B0=D1=86=D0=B8=D1=8F=20SearchResult?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- yandex_music/search/search_result.py | 33 +++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/yandex_music/search/search_result.py b/yandex_music/search/search_result.py index f31da0d..e8792c4 100644 --- a/yandex_music/search/search_result.py +++ b/yandex_music/search/search_result.py @@ -16,6 +16,27 @@ de_json_result = { class SearchResult(YandexMusicObject): + """Класс, представляющий результат поиска. + + Attributes: + total (:obj:`int`): Количество результатов. + per_page (:obj:`int`): Максимальное количество результатов на странице. + order (:obj:`int`): Номер страницы. + results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ + | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + + Args: + total (:obj:`int`): Количество результатов. + per_page (:obj:`int`): Максимальное количество результатов на странице. + order (:obj:`int`): Номер страницы. + results (:obj:`list` из :obj:`yandex_music.Track` | :obj:`yandex_music.Artist` | :obj:`yandex_music.Album` \ + | :obj:`yandex_music.Playlist` | :obj:`yandex_music.Video`): Результаты поиска. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ def __init__(self, total: int, per_page: int, @@ -23,7 +44,7 @@ class SearchResult(YandexMusicObject): results: List[Union[Track, Artist, Album, Playlist, Video]], client: Optional['Client'] = None, **kwargs) -> None: - self.total = total + self.totalbra = total self.per_page = per_page self.order = order self.results = results @@ -33,6 +54,16 @@ class SearchResult(YandexMusicObject): @classmethod def de_json(cls, data: dict, client: 'Client', type_: str = None) -> Optional['SearchResult']: + """Десериализация объекта. + + Args: + data (:obj:`dict`): Поля и значения десериализуемого объекта. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + + Returns: + :obj:`yandex_music.SearchResult`: Объект класса :class:`yandex_music.SearchResult`. + """ if not data: return None