2021-09-19 22:47:19 +09:00
|
|
|
|
from typing import Any, TYPE_CHECKING, Optional, List, Union
|
2019-12-27 18:14:51 +09:00
|
|
|
|
|
2020-01-26 21:19:22 +09:00
|
|
|
|
from yandex_music import YandexMusicObject
|
2021-09-19 22:47:19 +09:00
|
|
|
|
from yandex_music.utils import model
|
2020-01-26 21:19:22 +09:00
|
|
|
|
|
2019-12-27 18:14:51 +09:00
|
|
|
|
if TYPE_CHECKING:
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
from yandex_music import Client, Cover, Ratings, Counts, Link, Track, Description, ArtistTracks, ArtistAlbums
|
2019-12-27 18:14:51 +09:00
|
|
|
|
|
2019-05-11 17:37:47 +09:00
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
@model
|
2019-05-11 17:37:47 +09:00
|
|
|
|
class Artist(YandexMusicObject):
|
2020-03-22 11:30:22 +09:00
|
|
|
|
"""Класс, представляющий исполнителя.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
|
|
|
|
|
Attributes:
|
2020-03-22 23:43:25 +09:00
|
|
|
|
id (:obj:`int`): Уникальный идентификатор.
|
2020-06-06 23:06:23 +09:00
|
|
|
|
error (:obj:`str`, optional): Сообщение об ошибке с объяснением почему не вернуло исполнителя.
|
2020-04-17 04:01:26 +09:00
|
|
|
|
reason (:obj:`str`, optional): Причина отсутствия исполнителя (сообщение об ошибке).
|
2020-03-22 11:30:22 +09:00
|
|
|
|
name (:obj:`str`, optional): Название.
|
|
|
|
|
cover (:obj:`yandex_music.Cover`, optional): Обложка.
|
|
|
|
|
various (:obj:`bool`, optional): TODO.
|
|
|
|
|
composer (:obj:`bool`, optional): TODO.
|
|
|
|
|
genres (:obj:`list` из :obj:`str`, optional): Жанры.
|
2020-04-17 04:06:13 +09:00
|
|
|
|
og_image (:obj:`str`, optional): Ссылка на изображение для Open Graph.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
op_image (:obj:`str`, optional): Ссылка на изображение обложки. Используется когда не указано поле cover.
|
|
|
|
|
no_pictures_from_search: TODO.
|
|
|
|
|
counts (:obj:`yandex_music.Counts`, optional): Счётчики.
|
2020-03-22 23:43:25 +09:00
|
|
|
|
available (:obj:`bool`, optional): Доступен ли для прослушивания.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
ratings (:obj:`yandex_music.Ratings`, optional): Рейтинги.
|
|
|
|
|
links (:obj:`list` из :obj:`yandex_music.Link`, optional): Ссылки на ресурсы исполнителя.
|
|
|
|
|
tickets_available (:obj:`bool`, optional): Имеются ли в продаже билеты на концерт.
|
|
|
|
|
likes_count (:obj:`int`, optional): Количество лайков.
|
|
|
|
|
popular_tracks (:obj:`list` :obj:`yandex_music.Track`, optional): Популярные треки.
|
|
|
|
|
regions (:obj:`list` из :obj:`str`, optional): Регион TODO.
|
2020-06-07 21:24:16 +09:00
|
|
|
|
decomposed (:obj:`list` из :obj:`str` и :obj:`yandex_music.Artist`, optional): Декомпозиция всех исполнителей.
|
|
|
|
|
Лист, где чередуется разделитель и артист. Фиты и прочее.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
full_names: TODO.
|
2020-06-14 21:09:50 +09:00
|
|
|
|
hand_made_description (:obj:`str`, optional): Описание от Яндекс TODO.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
description (:obj:`yandex_music.Description`, optional): Описание.
|
|
|
|
|
countries (:obj:`list` из :obj:`str`, optional): Страны.
|
|
|
|
|
en_wikipedia_link (:obj:`str`, optional): Адрес страницы на wikipedia.org.
|
|
|
|
|
db_aliases (:obj:`list` из :obj:`str`, optional): Другие названия. Как правило названия на разных языках.
|
|
|
|
|
aliases: TODO.
|
|
|
|
|
init_date (:obj:`str`, optional): Дата начала в формате YYYY-MM-DD или YYYY.
|
|
|
|
|
end_date (:obj:`str`, optional): Дата окончания в формате YYYY-MM-DD или YYYY.
|
2021-01-28 01:24:40 +09:00
|
|
|
|
ya_money_id (:obj:`str`): Номер кошеляка Яндекс.Деньги TODO.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
|
2020-01-26 23:50:54 +09:00
|
|
|
|
"""
|
|
|
|
|
|
2021-09-19 22:47:19 +09:00
|
|
|
|
id: int
|
|
|
|
|
error: Optional[str] = None
|
|
|
|
|
reason: Optional[str] = None
|
|
|
|
|
name: Optional[str] = None
|
|
|
|
|
cover: Optional['Cover'] = None
|
|
|
|
|
various: Optional[bool] = None
|
|
|
|
|
composer: Optional[bool] = None
|
|
|
|
|
genres: Optional[List[str]] = None
|
|
|
|
|
og_image: Optional[str] = None
|
|
|
|
|
op_image: Optional[str] = None
|
|
|
|
|
no_pictures_from_search: Any = None
|
|
|
|
|
counts: Optional['Counts'] = None
|
|
|
|
|
available: Optional[bool] = None
|
|
|
|
|
ratings: Optional['Ratings'] = None
|
|
|
|
|
links: Optional[List['Link']] = None
|
|
|
|
|
tickets_available: Optional[bool] = None
|
|
|
|
|
likes_count: Optional[int] = None
|
|
|
|
|
popular_tracks: Optional[List['Track']] = None
|
|
|
|
|
regions: Optional[List[str]] = None
|
|
|
|
|
decomposed: Optional[List[Union[str, 'Artist']]] = None
|
|
|
|
|
full_names: Any = None
|
|
|
|
|
hand_made_description: Optional[str] = None
|
|
|
|
|
description: Optional['Description'] = None
|
|
|
|
|
countries: Optional[List[str]] = None
|
|
|
|
|
en_wikipedia_link: Optional[str] = None
|
|
|
|
|
db_aliases: Optional[List[str]] = None
|
|
|
|
|
aliases: Any = None
|
|
|
|
|
init_date: Optional[str] = None
|
|
|
|
|
end_date: Optional[str] = None
|
|
|
|
|
ya_money_id: Optional[str] = None
|
|
|
|
|
client: 'Client' = None
|
|
|
|
|
|
|
|
|
|
def __post_init__(self):
|
2019-12-01 20:35:02 +09:00
|
|
|
|
self._id_attrs = (self.id, self.name, self.cover)
|
2019-05-11 17:37:47 +09:00
|
|
|
|
|
2020-04-17 04:06:13 +09:00
|
|
|
|
def download_og_image(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка изображения для Open Graph.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename)
|
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_og_image_async(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка изображения для Open Graph.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
await self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename)
|
|
|
|
|
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def download_op_image(self, filename: str, size: str = '200x200') -> None:
|
2019-08-18 23:44:46 +09:00
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
2020-04-17 04:06:13 +09:00
|
|
|
|
Notes:
|
|
|
|
|
Используйте это только когда нет self.cover!
|
2019-08-18 23:44:46 +09:00
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
self.client.request.download(f'https://{self.op_image.replace("%%", size)}', filename)
|
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def download_op_image_async(self, filename: str, size: str = '200x200') -> None:
|
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
Используйте это только когда нет self.cover!
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
await self.client.request.download(f'https://{self.op_image.replace("%%", size)}', filename)
|
|
|
|
|
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def like(self, *args, **kwargs) -> bool:
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
2021-02-03 21:28:10 +09:00
|
|
|
|
client.users_likes_artists_add(artist.id, user.id *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""
|
2019-12-24 06:20:07 +09:00
|
|
|
|
return self.client.users_likes_artists_add(self.id, self.client.me.account.uid, *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def like_async(self, *args, **kwargs) -> bool:
|
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
|
|
|
|
await client.users_likes_artists_add(artist.id, user.id *args, **kwargs)
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.users_likes_artists_add(self.id, self.client.me.account.uid, *args, **kwargs)
|
|
|
|
|
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def dislike(self, *args, **kwargs) -> bool:
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
2021-02-03 21:28:10 +09:00
|
|
|
|
client.users_likes_artists_remove(artist.id, user.id *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""
|
2019-12-24 06:20:07 +09:00
|
|
|
|
return self.client.users_likes_artists_remove(self.id, self.client.me.account.uid, *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def dislike_async(self, *args, **kwargs) -> bool:
|
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
|
|
|
|
await client.users_likes_artists_remove(artist.id, user.id *args, **kwargs)
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.users_likes_artists_remove(self.id, self.client.me.account.uid, *args, **kwargs)
|
|
|
|
|
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def get_tracks(self, page=0, page_size=20, *args, **kwargs) -> Optional['ArtistTracks']:
|
2019-10-27 23:14:11 +09:00
|
|
|
|
"""Сокращение для::
|
2019-10-22 00:08:24 +09:00
|
|
|
|
|
2021-02-03 21:28:10 +09:00
|
|
|
|
client.artists_tracks(artist.id, page, page_size, *args, **kwargs)
|
2019-10-22 00:08:24 +09:00
|
|
|
|
"""
|
2019-10-21 23:47:31 +09:00
|
|
|
|
return self.client.artists_tracks(self.id, page, page_size, *args, **kwargs)
|
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def get_tracks_async(self, page=0, page_size=20, *args, **kwargs) -> Optional['ArtistTracks']:
|
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
|
|
|
|
await client.artists_tracks(artist.id, page, page_size, *args, **kwargs)
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.artists_tracks(self.id, page, page_size, *args, **kwargs)
|
|
|
|
|
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def get_albums(self, page=0, page_size=20, sort_by='year', *args, **kwargs) -> Optional['ArtistAlbums']:
|
2019-11-20 02:52:17 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
2021-02-03 21:28:10 +09:00
|
|
|
|
client.artists_direct_albums(artist.id, page, page_size, sort_by, *args, **kwargs)
|
2019-11-20 02:52:17 +09:00
|
|
|
|
"""
|
2019-11-20 22:32:54 +09:00
|
|
|
|
return self.client.artists_direct_albums(self.id, page, page_size, sort_by, *args, **kwargs)
|
2019-11-20 02:30:07 +09:00
|
|
|
|
|
2022-02-20 02:59:53 +09:00
|
|
|
|
async def get_albums_async(self, page=0, page_size=20, sort_by='year', *args, **kwargs) -> Optional['ArtistAlbums']:
|
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
|
|
|
|
await client.artists_direct_albums(artist.id, page, page_size, sort_by, *args, **kwargs)
|
|
|
|
|
"""
|
|
|
|
|
return await self.client.artists_direct_albums(self.id, page, page_size, sort_by, *args, **kwargs)
|
|
|
|
|
|
2019-05-11 17:37:47 +09:00
|
|
|
|
@classmethod
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def de_json(cls, data: dict, client: 'Client') -> Optional['Artist']:
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""Десериализация объекта.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
data (:obj:`dict`): Поля и значения десериализуемого объекта.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
|
|
|
|
|
Returns:
|
2020-03-22 11:30:22 +09:00
|
|
|
|
:obj:`yandex_music.Artist`: Исполнитель.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
2019-05-11 17:37:47 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
data = super(Artist, cls).de_json(data, client)
|
Добавлен метод получения информации об артисте (Brief Info https://github.com/MarshalX/yandex-music-api/issues/9).
Добавлены следующие классы: BriefInfo, Description, Vinyl, PlaylistId.
Класс Video вынесен из пакета Search в корень.
Добавлен de_list в Cover.
Добавлены следующие поля в класс Artist: likes_count, full_names, description, countries, en_wikipedia_link, db_aliases, aliases, init_date, end_date.
Добавлено поле track_id в класс Chart.
Добавлено поле available_full_without_permission в класс Track.
Класс Video расширен для поддержки второго типа (используется в brief info, спасибо яндух) видео (добавлены необязательные поля cover, embed_url, provider, provider_video_id).
Обновлена документация.
2019-09-13 00:32:43 +09:00
|
|
|
|
from yandex_music import Cover, Ratings, Counts, Link, Track, Description
|
2021-02-03 21:28:10 +09:00
|
|
|
|
|
2019-05-11 17:37:47 +09:00
|
|
|
|
data['cover'] = Cover.de_json(data.get('cover'), client)
|
|
|
|
|
data['ratings'] = Ratings.de_json(data.get('ratings'), client)
|
|
|
|
|
data['counts'] = Counts.de_json(data.get('counts'), client)
|
|
|
|
|
data['links'] = Link.de_list(data.get('links'), client)
|
New supported objects: Search, Suggestions, Video, Best, AlbumSearchResult, ArtistSearchResult, PlaylistSearchResult, TrackSearchResult, VideoSearchResult,
The following methods are wrapped:
- /search
- /search/suggest
The following classes received optional fields instead of required ones: Album, Artist, Playlist, Track
Added "params" arg to the GET request
Code refactoring
2019-05-18 01:20:34 +09:00
|
|
|
|
data['popular_tracks'] = Track.de_list(data.get('popular_tracks'), client)
|
Добавлен метод получения информации об артисте (Brief Info https://github.com/MarshalX/yandex-music-api/issues/9).
Добавлены следующие классы: BriefInfo, Description, Vinyl, PlaylistId.
Класс Video вынесен из пакета Search в корень.
Добавлен de_list в Cover.
Добавлены следующие поля в класс Artist: likes_count, full_names, description, countries, en_wikipedia_link, db_aliases, aliases, init_date, end_date.
Добавлено поле track_id в класс Chart.
Добавлено поле available_full_without_permission в класс Track.
Класс Video расширен для поддержки второго типа (используется в brief info, спасибо яндух) видео (добавлены необязательные поля cover, embed_url, provider, provider_video_id).
Обновлена документация.
2019-09-13 00:32:43 +09:00
|
|
|
|
data['description'] = Description.de_json(data.get('description'), client)
|
2020-06-07 21:24:16 +09:00
|
|
|
|
|
|
|
|
|
# Мне очень интересно увидеть как в яндухе на клиентах солвят свой бэковский костыль, пригласите на экскурсию
|
|
|
|
|
if data.get('decomposed'):
|
2021-02-03 21:28:10 +09:00
|
|
|
|
data['decomposed'] = [
|
|
|
|
|
Artist.de_json(part, client) if isinstance(part, dict) else part for part in data['decomposed']
|
|
|
|
|
]
|
2019-05-11 17:37:47 +09:00
|
|
|
|
|
|
|
|
|
return cls(client=client, **data)
|
|
|
|
|
|
|
|
|
|
@classmethod
|
Тайп хинты для Label, TrackPosition, Artist, ArtistAlbums, ArtistTracks, BriefInfo, Counts, Description, Link, Ratings, Vinyl, AlbumEvent, ArtistEvent, Day, Event, GeneratedPlaylist, TrackWithAds, Genre, Images, Title
2019-12-28 20:38:59 +09:00
|
|
|
|
def de_list(cls, data: dict, client: 'Client') -> List['Artist']:
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""Десериализация списка объектов.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
|
2020-03-22 11:30:22 +09:00
|
|
|
|
client (:obj:`yandex_music.Client`): Клиент Yandex Music.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
|
|
|
|
|
Returns:
|
2020-03-22 11:30:22 +09:00
|
|
|
|
:obj:`list` из :obj:`yandex_music.Artist`: Исполнители.
|
2020-01-26 22:17:09 +09:00
|
|
|
|
"""
|
2019-05-11 17:37:47 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
artists = list()
|
|
|
|
|
for artist in data:
|
|
|
|
|
artists.append(cls.de_json(artist, client))
|
|
|
|
|
|
|
|
|
|
return artists
|
2019-08-18 23:44:46 +09:00
|
|
|
|
|
|
|
|
|
# camelCase псевдонимы
|
|
|
|
|
|
2020-04-17 04:06:13 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_og_image`
|
|
|
|
|
downloadOgImage = download_og_image
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_og_image_async`
|
|
|
|
|
downloadOgImageAsync = download_og_image_async
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_op_image`
|
2019-08-18 23:44:46 +09:00
|
|
|
|
downloadOpImage = download_op_image
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_op_image_async`
|
|
|
|
|
downloadOpImageAsync = download_op_image_async
|
2019-10-22 00:29:02 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_tracks`
|
|
|
|
|
getTracks = get_tracks
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_tracks_async`
|
|
|
|
|
getTracksAsync = get_tracks_async
|
2019-11-20 02:30:07 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_albums`
|
|
|
|
|
getAlbums = get_albums
|
2022-02-20 02:59:53 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_albums_async`
|
|
|
|
|
getAlbumsAsync = get_albums_async
|
|
|
|
|
#: Псевдоним для :attr:`like_async`
|
|
|
|
|
likeAsync = like_async
|
|
|
|
|
#: Псевдоним для :attr:`dislike_async`
|
|
|
|
|
dislikeAsync = dislike_async
|