Документация для Search (#143)

* Задокументирован класс Search

* Задокументировано свойство Search.nocorrect

* Исправлена документация класса Search
Указана опциональность полей
Добавлена пустая строчка

* Правки в документации класса Search

* Указана опциональность полей

* Испрвлена докуменация свойства Search.best

* Испрвлена докуменация Search
このコミットが含まれているのは:
Gleb Liutsko 2019-11-19 20:30:11 +04:00 committed by Il'ya
コミット 2b437350be
1個のファイルの変更42行の追加0行の削除

ファイルの表示

@ -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