Merge pull request #187 from glebliutsko/docs-link

Добавлена документация Link
このコミットが含まれているのは:
Il'ya 2020-01-23 00:24:34 +03:00 committed by GitHub
コミット 429140fe18
この署名に対応する既知のキーがデータベースに存在しません
GPGキーID: 4AEE18F83AFDEB23
1個のファイルの変更41行の追加0行の削除

ファイルの表示

@ -7,6 +7,27 @@ from yandex_music import YandexMusicObject
class Link(YandexMusicObject):
"""Класс, представляющий ссылку на официальную страницу исполнителя.
Известные типы страниц: `official` - официальный сайт и `social` - социальная сеть.
Attributes:
title (:obj:`str`): Название страницы.
href (:obj:`str`): URL страницы.
type_ (:obj:`str`): Тип страницы.
social_network (:obj:`str`): Название социальной сети.
client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex
Music.
Args:
title (:obj:`str`): Название страницы.
href (:obj:`str`): URL страницы.
type_ (:obj:`str`): Тип страницы.
social_network (:obj:`str`, optional): Название социальной сети.
client (:obj:`yandex_music.Client`, optional): Объект класса :class:`yandex_music.Client` представляющий клиент
Yandex Music.
"""
def __init__(self,
title: str,
href: str,
@ -25,6 +46,16 @@ class Link(YandexMusicObject):
@classmethod
def de_json(cls, data: dict, client: 'Client') -> Optional['Link']:
"""Десериализация объекта.
Args:
data (:obj:`dict`): Поля и значения десериализуемого объекта.
client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex
Music.
Returns:
:obj:`yandex_music.Link`: Объект класса :class:`yandex_music.Link`.
"""
if not data:
return None
@ -34,6 +65,16 @@ class Link(YandexMusicObject):
@classmethod
def de_list(cls, data: dict, client: 'Client') -> List['Link']:
"""Десериализация списка объектов.
Args:
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
client (:obj:`yandex_music.Client`): Объект класса :class:`yandex_music.Client` представляющий клиент Yandex
Music.
Returns:
:obj:`list` из :obj:`yandex_music.Link`: Список объектов класса :class:`yandex_music.Link`.
"""
if not data:
return []