Merge pull request #138 from alextur89/documentation_for_user_class

Задокументирован класс User #53
MarshalX · Nov 11, 2019 · b596fe5 · b596fe5
2 parents ef4c8ae + 332dd5a
commit b596fe5
Showing 1 changed file with 31 additions and 1 deletion.
diff --git a/yandex_music/playlist/user.py b/yandex_music/playlist/user.py
@@ -2,6 +2,26 @@
 
 
 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 +44,23 @@ def download_avatar(self, filename, format='normal'):
 
         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