2019-12-28 22:25:09 +09:00
|
|
|
|
from typing import TYPE_CHECKING, Optional, List, Union
|
2019-12-27 18:14:51 +09:00
|
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
2019-12-28 22:25:09 +09:00
|
|
|
|
from yandex_music import Client, Normalization, Major, Album, Artist, Supplement, DownloadInfo
|
2019-12-27 18:14:51 +09:00
|
|
|
|
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
from yandex_music import YandexMusicObject
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class Track(YandexMusicObject):
|
|
|
|
|
def __init__(self,
|
2019-12-28 22:25:09 +09:00
|
|
|
|
id_: Union[str, int],
|
|
|
|
|
title: str,
|
|
|
|
|
available: bool,
|
|
|
|
|
artists: List['Artist'],
|
|
|
|
|
albums: List['Album'],
|
|
|
|
|
available_for_premium_users: Optional[bool] = None,
|
|
|
|
|
lyrics_available: Optional[bool] = None,
|
|
|
|
|
real_id: Optional[Union[str, int]] = None,
|
|
|
|
|
og_image: Optional[str] = None,
|
|
|
|
|
type_: Optional[str] = None,
|
|
|
|
|
cover_uri: Optional[str] = None,
|
|
|
|
|
major: Optional['Major'] = None,
|
|
|
|
|
duration_ms: Optional[int] = None,
|
|
|
|
|
storage_dir: Optional[str] = None,
|
|
|
|
|
file_size: Optional[int] = None,
|
|
|
|
|
normalization: Optional['Normalization'] = None,
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
error=None,
|
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
|
|
|
|
regions=None,
|
|
|
|
|
available_as_rbt=None,
|
|
|
|
|
content_warning=None,
|
|
|
|
|
explicit=None,
|
2019-12-28 22:25:09 +09:00
|
|
|
|
preview_duration_ms: Optional[int] = None,
|
|
|
|
|
available_full_without_permission: Optional[bool] = None,
|
2019-12-27 18:14:51 +09:00
|
|
|
|
client: Optional['Client'] = None,
|
|
|
|
|
**kwargs) -> None:
|
2019-12-27 04:51:29 +09:00
|
|
|
|
self.id = id_
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
self.title = title
|
|
|
|
|
self.available = available
|
|
|
|
|
self.artists = artists
|
|
|
|
|
self.albums = albums
|
|
|
|
|
|
2019-12-01 20:25:09 +09:00
|
|
|
|
self.available_for_premium_users = available_for_premium_users
|
|
|
|
|
self.lyrics_available = lyrics_available
|
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
|
|
|
|
self.real_id = real_id
|
|
|
|
|
self.og_image = og_image
|
2019-12-27 04:51:29 +09:00
|
|
|
|
self.type = type_
|
2019-08-18 23:44:46 +09:00
|
|
|
|
self.cover_uri = cover_uri
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
self.major = major
|
|
|
|
|
self.duration_ms = duration_ms
|
|
|
|
|
self.storage_dir = storage_dir
|
|
|
|
|
self.file_size = file_size
|
|
|
|
|
self.normalization = normalization
|
|
|
|
|
self.error = error
|
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
|
|
|
|
self.regions = regions
|
|
|
|
|
self.available_as_rbt = available_as_rbt
|
|
|
|
|
self.content_warning = content_warning
|
|
|
|
|
self.explicit = explicit
|
New supported objects: Station, StationResult, StationTrackResult, Value, Sequence, RotorSettings, Restrictions, Id, Enum, DiscreteScale, DashBoard, AdParams
The following methods are wrapped:
- /rotor/account/status
- /rotor/stations/dashboard
- /rotor/stations/list
- /rotor/station/genre:{genre}/feedback
- /rotor/station/genre:{genre}/info
- /rotor/station/genre:{genre}/tracks
The following fields are now optional: Account[region, passport_phones], Status[cache_limit, subeditor, subeditor_level, plus], Subscription[auto_renewable, can_start_trial, mcdonalds]
Added new fields: Subscription.end, Status[skips_per_hour, station_exists, premium_region], Track..preview_duration_ms
Fixed downloading the cover of the track
2019-06-03 22:16:24 +09:00
|
|
|
|
self.preview_duration_ms = preview_duration_ms
|
Добавлен метод получения информации об артисте (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
|
|
|
|
self.available_full_without_permission = available_full_without_permission
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
|
2019-05-23 18:10:14 +09:00
|
|
|
|
self.download_info = None
|
|
|
|
|
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
self.client = client
|
2019-12-01 20:35:02 +09:00
|
|
|
|
self._id_attrs = (self.id, self.title, self.available, self.artists, self.albums)
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def get_download_info(self, get_direct_links=False) -> List['DownloadInfo']:
|
2019-05-23 18:10:14 +09:00
|
|
|
|
self.download_info = self.client.tracks_download_info(self.track_id, get_direct_links)
|
|
|
|
|
|
|
|
|
|
return self.download_info
|
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def get_supplement(self, *args, **kwargs) -> Optional['Supplement']:
|
2019-10-17 12:35:24 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
2019-10-19 05:44:17 +09:00
|
|
|
|
client.track_supplement(track.id, *args, **kwargs)
|
2019-10-17 12:35:24 +09:00
|
|
|
|
"""
|
2019-10-19 05:44:17 +09:00
|
|
|
|
return self.client.track_supplement(self.id, *args, **kwargs)
|
2019-10-17 05:10:52 +09:00
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def download_cover(self, filename: str, size: str = '200x200') -> None:
|
2019-08-18 23:44:46 +09:00
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
self.client.request.download(f'https://{self.cover_uri.replace("%%", size)}', filename)
|
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def download_og_image(self, filename: str, size: str = '200x200') -> None:
|
2019-08-18 23:44:46 +09:00
|
|
|
|
"""Загрузка обложки.
|
|
|
|
|
|
|
|
|
|
Предпочтительнее использовать self.download_cover().
|
|
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
filename (:obj:`str`): Путь для сохранения файла с названием и расширением.
|
|
|
|
|
size (:obj:`str`, optional): Размер обложки.
|
|
|
|
|
"""
|
|
|
|
|
|
2019-11-08 04:52:26 +09:00
|
|
|
|
self.client.request.download(f'https://{self.og_image.replace("%%", size)}', filename)
|
New supported objects: Landing, Block, BlockEntity, Chart, ChartItem, MixLink, PersonalPlaylistsData, PlayContext, PlayContextsData, Promotion, TrackId, TrackShorOld (YEAH!)
The following method are wrapped:
- /landing3
Added the ability to download covers
The following field are optional: Playlist.tags
Now, when parsing json, the "client" key is replaced with "client_"
2019-05-25 02:10:39 +09:00
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def download(self, filename: str, codec: str = 'mp3', bitrate_in_kbps: int = 192) -> None:
|
2019-05-23 18:10:14 +09:00
|
|
|
|
if self.download_info is None:
|
|
|
|
|
self.get_download_info()
|
|
|
|
|
|
|
|
|
|
for info in self.download_info:
|
|
|
|
|
if info.codec == codec and info.bitrate_in_kbps == bitrate_in_kbps:
|
|
|
|
|
info.download(filename)
|
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def like(self, *args, **kwargs) -> bool:
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
2019-10-19 05:44:17 +09:00
|
|
|
|
client.users_likes_tracks_add(track.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_tracks_add(self.track_id, self.client.me.account.uid, *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def dislike(self, *args, **kwargs) -> bool:
|
2019-10-07 02:06:28 +09:00
|
|
|
|
"""Сокращение для::
|
|
|
|
|
|
|
|
|
|
client.users_likes_tracks_remove(track.id, user.id *args, **kwargs)
|
|
|
|
|
"""
|
2019-12-24 06:20:07 +09:00
|
|
|
|
return self.client.users_likes_tracks_remove(self.track_id, self.client.me.account.uid, *args, **kwargs)
|
2019-10-07 02:06:28 +09:00
|
|
|
|
|
2019-05-19 05:59:14 +09:00
|
|
|
|
@property
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def track_id(self) -> str:
|
2020-01-23 00:08:08 +09:00
|
|
|
|
if self.albums:
|
|
|
|
|
return f'{self.id}:{self.albums[0].id}'
|
2019-05-19 05:59:14 +09:00
|
|
|
|
return f'{self.id}'
|
|
|
|
|
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
@classmethod
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def de_json(cls, data: dict, client: 'Client') -> Optional['Track']:
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
data = super(Track, cls).de_json(data, client)
|
2019-10-27 23:14:11 +09:00
|
|
|
|
from yandex_music import Normalization, Major, Album, Artist
|
|
|
|
|
data['albums'] = Album.de_list(data.get('albums'), client)
|
|
|
|
|
data['artists'] = Artist.de_list(data.get('artists'), client)
|
2019-06-03 01:23:29 +09:00
|
|
|
|
data['normalization'] = Normalization.de_json(data.get('normalization'), client)
|
|
|
|
|
data['major'] = Major.de_json(data.get('major'), client)
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
|
|
|
|
|
return cls(client=client, **data)
|
|
|
|
|
|
|
|
|
|
@classmethod
|
2019-12-28 22:25:09 +09:00
|
|
|
|
def de_list(cls, data: dict, client: 'Client') -> List['Track']:
|
New supported objects: Album, CaseForms, Label, Library, MadeFor, Major, Normalization, PlayCounter, Playlist, Track, TrackPosition, TrackShort, User
The following methods are wrapped:
- albums;
- playlists/list;
- users/{user_id}/playlists/list;
- tracks;
- users/{user_id}/likes/tracks.
Added property to get full track ID
Cover received more optional fields
Ability to pass arguments to the request
Removed unnecessary type conversions
2019-05-13 02:39:12 +09:00
|
|
|
|
if not data:
|
|
|
|
|
return []
|
|
|
|
|
|
|
|
|
|
tracks = list()
|
|
|
|
|
for track in data:
|
|
|
|
|
tracks.append(cls.de_json(track, client))
|
|
|
|
|
|
|
|
|
|
return tracks
|
2019-08-18 18:54:13 +09:00
|
|
|
|
|
|
|
|
|
# camelCase псевдонимы
|
|
|
|
|
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_download_info`
|
2019-08-18 18:54:13 +09:00
|
|
|
|
getDownloadInfo = get_download_info
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`get_supplement`
|
2019-10-19 05:44:17 +09:00
|
|
|
|
getSupplement = get_supplement
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_cover`
|
2019-08-18 18:54:13 +09:00
|
|
|
|
downloadCover = download_cover
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`download_og_image`
|
2019-08-18 23:44:46 +09:00
|
|
|
|
downloadOgImage = download_og_image
|
2019-10-19 17:55:45 +09:00
|
|
|
|
#: Псевдоним для :attr:`track_id`
|
2019-08-18 18:54:13 +09:00
|
|
|
|
trackId = track_id
|