Добавлена документация SearchResult
このコミットが含まれているのは:
コミット
c03c9fd5cb
|
@ -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
|
||||
|
||||
|
|
読み込み中…
新しいイシューから参照