From 2b437350beea513fa13c0f47a3df6e8ccaa68263 Mon Sep 17 00:00:00 2001 From: Gleb Liutsko Date: Tue, 19 Nov 2019 20:30:11 +0400 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD?= =?UTF-8?q?=D1=82=D0=B0=D1=86=D0=B8=D1=8F=20=D0=B4=D0=BB=D1=8F=20Search=20?= =?UTF-8?q?(#143)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Задокументирован класс Search * Задокументировано свойство Search.nocorrect * Исправлена документация класса Search Указана опциональность полей Добавлена пустая строчка * Правки в документации класса Search * Указана опциональность полей * Испрвлена докуменация свойства Search.best * Испрвлена докуменация Search --- yandex_music/search/search.py | 42 +++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/yandex_music/search/search.py b/yandex_music/search/search.py index ad9dce1..09e1c89 100644 --- a/yandex_music/search/search.py +++ b/yandex_music/search/search.py @@ -2,6 +2,38 @@ from yandex_music import YandexMusicObject class Search(YandexMusicObject): + """Класс представляющий результаты поиска. + + Attributes: + search_request_id (:obj:`str`): ID запроса. + text (:obj:`str`): Текст запроса. + best (:obj:`yandex_music.Best`): Объект класса :class:`yandex_music.Best` представляющий лучший результат. + albums (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные альбомы. + artists (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденных исполнителей. + playlists (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные плейлисты. + tracks (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные треки. + videos (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные видео. + misspell_corrected (:obj:`bool`): Был ли исправлен запрос. + nocorrect (:obj:`bool`): Было ли отключено исправление результата. + client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + + Args: + search_request_id (:obj:`str`): ID запроса. + text (:obj:`str`): Текст запроса. + best (:obj:`yandex_music.Best`): Объект класса :class:`yandex_music.Best` представляющий лучший результат. + albums (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные альбомы. + artists (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденных исполнителей. + playlists (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные плейлисты. + tracks (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные треки. + videos (:obj:`yandex_music.SearchResult`): Объект класса :class:`yandex_music.SearchResult` представляющий найденные видео. + misspell_corrected (:obj:`bool`, optional): Был ли исправлен запрос. + nocorrect (:obj:`bool`, optional): Было ли отключено исправление результата. + client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex + Music. + **kwargs: Произвольные ключевые аргументы полученные от API. + """ + def __init__(self, search_request_id, text, @@ -33,6 +65,16 @@ class Search(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.Search`: Объект класса :class:`yandex_music.Search`. + """ if not data: return None