Документация класса Promotion

このコミットが含まれているのは:
Il`ya 2020-03-22 06:09:27 +03:00
コミット 649714d363
1個のファイルの変更26行の追加3行の削除

ファイルの表示

@ -7,12 +7,35 @@ if TYPE_CHECKING:
class Promotion(YandexMusicObject):
"""Класс, представляющий .
"""Класс, представляющий продвижение (рекламу).
Note:
В цвете может как оказаться HEX (`#6c65a9`), так и какой-нибудь `transparent`.
Ссылка со схемой отличается от просто ссылки наличием `yandexmusic://` в начале.
Attributes:
promo_id (:obj:`str`): Уникальный идентификатор рекламы.
title (:obj:`str`): Заголовок.
subtitle (:obj:`str`): Подзаголовок.
heading (:obj:`str`): Верхний заголовок.
url (:obj:`str`): Ссылка.
url_scheme (:obj:`str`): Ссылка с схемой.
text_color (:obj:`str`): Цвет текста.
gradient (:obj:`str`): Градиент TODO.
image (:obj:`str`): Ссылка на рекламное изображение.
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
Args:
promo_id (:obj:`str`): Уникальный идентификатор рекламы.
title (:obj:`str`): Заголовок.
subtitle (:obj:`str`): Подзаголовок.
heading (:obj:`str`): Верхний заголовок.
url (:obj:`str`): Ссылка.
url_scheme (:obj:`str`): Ссылка с схемой.
text_color (:obj:`str`): Цвет текста.
gradient (:obj:`str`): Градиент TODO.
image (:obj:`str`): Ссылка на рекламное изображение.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
**kwargs: Произвольные ключевые аргументы полученные от API.
"""
@ -52,7 +75,7 @@ class Promotion(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.Promotion`: TODO.
:obj:`yandex_music.Promotion`: Продвижение (реклама).
"""
if not data:
return None
@ -70,7 +93,7 @@ class Promotion(YandexMusicObject):
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`list` из :obj:`yandex_music.Promotion`: TODO.
:obj:`list` из :obj:`yandex_music.Promotion`: Продвижения (реклама).
"""
if not data:
return []