Задокументировал класс User #53

このコミットが含まれているのは:
Alexander Tyuryuchkin 2019-11-10 21:43:04 +03:00
コミット c39b2f600b
1個のファイルの変更30行の追加1行の削除

ファイルの表示

@ -2,6 +2,25 @@ from yandex_music import YandexMusicObject
class User(YandexMusicObject):
"""Класс представляющий пользователя.
Attributes:
uid (:obj:'int'): Идентификатор пользователя.
login (:obj:'str'): Логин пользователя.
name (:obj:'str'): Имя пользователя.
sex (:obj:'str'): Пол пользователя.
verified (:obj:'bool'): Является ли пользователь подтвержденным.
client (:obj:'yandex_music.Client'): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex Music.
Args:
uid (:obj:'int'): Идентификатор пользователя.
login (:obj:'str'): Логин пользователя.
name (:obj:'str'): Имя пользователя.
sex (:obj:'str'): Пол пользователя.
verified (:obj:'bool'): Является ли пользователь подтвержденным.
client (:obj:'yandex_music.Client', optional): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex Music.
**kwargs: Произвольные ключевые аргументы полученные от API.
"""
def __init__(self,
uid,
login,
@ -24,13 +43,23 @@ class User(YandexMusicObject):
Args:
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
format (:obj:`str`): Формат желаемого изображения (normal, orig, small, big).
format (:obj:`str`, optional): Формат желаемого изображения (normal, orig, small, big).
"""
self.client.request.download(f'https://upics.yandex.net/{self.uid}/{format}', filename)
@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.User`: Объект класса :class:`yandex_music.User`.
"""
if not data:
return None