Video doc (#251)

Документация к классу video.py

yandex_music/video.py

@@ -7,28 +7,50 @@ if TYPE_CHECKING:
 
 
 class Video(YandexMusicObject):
-    """Класс, представляющий .
+    """Класс, представляющий видео.
 
-    Attributes:
+       Attributes:
-        client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
+            title (:obj:`str`): Название видео.
+            cover (:obj:`str`): Ссылка на изображение.
+            embed_url (:obj:`str`): Ссылка на видео.
+            provider (:obj:`str`): Провайдер видео.
+            provider_video_id (:obj:`int` | :obj:`str`): Идентификатор видео.
+            youtube_url (:obj:`str`): Ссылка на видео Youtube.
+            thumbnail_url (:obj:`str`): Ссылка на изображение.
+            duration (:obj:`int`): Длительность видео в секундах.
+            text (:obj:`str`): Текст.
+            html_auto_play_video_player (:obj:`str`): HTML тег для встраивания в разметку страницы.
+            regions (:obj:`list` из :obj:`str`): Регион TODO.
+            client (:obj:`yandex_music.Client`): Клиент Yandex Music.
 
-    Args:
+       Args:
-        client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
+            title (:obj:`str`): Название видео.
-        **kwargs: Произвольные ключевые аргументы полученные от API.
+            cover (:obj:`str`, optional): Ссылка на изображение.
-    """
+            embed_url (:obj:`str`, optional): Ссылка на видео.
+            provider (:obj:`str`, optional): Провайдер видео.
+            provider_video_id (:obj:`int` | :obj:`str`, optional): Идентификатор видео.
+            youtube_url (:obj:`str`, optional): Ссылка на видео Youtube.
+            thumbnail_url (:obj:`str`, optional): Ссылка на изображение.
+            duration (:obj:`int`, optional): Длительность видео в секундах.
+            text (:obj:`str`, optional): Текст.
+            html_auto_play_video_player (:obj:`str`, optional): HTML тег для встраивания в разметку страницы.
+            regions (:obj:`list` из :obj:`str`, optional): Регион TODO.
+            client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
+            **kwargs: Произвольные ключевые аргументы полученные от API.
+       """
 
     def __init__(self,
                  title: str,
                  cover: Optional[str] = None,
                  embed_url: Optional[str] = None,
-                 provider: Optional['str'] = None,
+                 provider: Optional[str] = None,
                  provider_video_id: Optional[Union[int, str]] = None,
                  youtube_url: Optional[str] = None,
                  thumbnail_url: Optional[str] = None,
-                 duration=None,
+                 duration: Optional[int] = None,
-                 text=None,
+                 text: Optional[str] = None,
-                 html_auto_play_video_player=None,
+                 html_auto_play_video_player: Optional[str] = None,
-                 regions=None,
+                 regions: Optional[List[str]] = None,
                  client: Optional['Client'] = None,
                  **kwargs):
         self.title = title
@@ -56,10 +78,10 @@ class Video(YandexMusicObject):
 
         Args:
             data (:obj:`dict`): Поля и значения десериализуемого объекта.
-            client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
+            client (:obj:`yandex_music.Client`): Клиент Yandex Music.
 
         Returns:
-            :obj:`yandex_music.Video`: TODO.
+            :obj:`yandex_music.Video`: Видео.
         """
         if not data:
             return None
@@ -74,10 +96,10 @@ class Video(YandexMusicObject):
 
         Args:
             data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
-            client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
+            client (:obj:`yandex_music.Client`): Клиент Yandex Music.
 
         Returns:
-            :obj:`list` из :obj:`yandex_music.Video`: TODOqq.
+            :obj:`list` из :obj:`yandex_music.Video`: Видео.
         """
         if not data:
             return []