Merge pull request #275 from MarshalX/issue-48

Документация класса PlayContext
このコミットが含まれているのは:
Il'ya 2020-03-22 06:03:08 +03:00 committed by GitHub
コミット ce419c932f
この署名に対応する既知のキーがデータベースに存在しません
GPGキーID: 4AEE18F83AFDEB23
2個のファイルの変更19行の追加4行の削除

ファイルの表示

@ -7,12 +7,27 @@ if TYPE_CHECKING:
class PlayContext(YandexMusicObject):
"""Класс, представляющий .
"""Класс, представляющий проигрываемый контекст.
Note:
Известные значения поля `client_`: `android`.
Поле `context` хранит в себе место воспроизведения, например, `playlist`.
Поле `context_item` хранит в себе уникальный идентификатор context'a, т.е. в нашем случае playlist'a.
Attributes:
client_ (:obj:`str`): Клиент.
context (:obj:`str`): Тип контекста.
context_item (:obj:`str`): Предмет контекста.
tracks (:obj:`list` из :obj:`yandex_music.TrackShortOld`): Треки.
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
Args:
client_ (:obj:`str`): Клиент.
context (:obj:`str`): Тип контекста.
context_item (:obj:`str`): Предмет контекста.
tracks (:obj:`list` из :obj:`yandex_music.TrackShortOld`): Треки.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
**kwargs: Произвольные ключевые аргументы полученные от API.
"""
@ -41,7 +56,7 @@ class PlayContext(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.PlayContext`: TODO.
:obj:`yandex_music.PlayContext`: Проигрываемый контекст.
"""
if not data:
return None

ファイルの表示

@ -7,7 +7,7 @@ if TYPE_CHECKING:
class PlayContextsData(YandexMusicObject):
"""Класс, представляющий проигрываемый контекст.
"""Класс, представляющий данные проигрываемого контекста.
Attributes:
other_tracks (:obj:`list` из :obj:`yandex_music.TrackShortOld`): Другие треки.
@ -37,7 +37,7 @@ class PlayContextsData(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.PlayContextsData`: Проигрываемый контекст.
:obj:`yandex_music.PlayContextsData`: Данные проигрываемого контекста.
"""
if not data:
return None