yandex_music.client#
- class yandex_music.client.Client(token: Optional[str] = None, base_url: Optional[str] = None, request: Optional[Request] = None, language: str = 'ru', report_unknown_fields=False)#
Bases:
YandexMusicObject
Класс, представляющий клиент Yandex Music.
Note
Доступные языки: en, uz, uk, us, ru, kk, hy.
Поле device используется только при работе с очередью прослушивания.
- logger#
Объект логгера.
- Type
logging.Logger
- token#
Уникальный ключ для аутентификации.
- Type
str
- base_url#
Ссылка на API Yandex Music.
- Type
str
- me#
Информация об аккаунте.
- Type
yandex_music.Status
- device#
Строка, содержащая сведения об устройстве, с которого выполняются запросы.
- Type
str
- report_unknown_fields#
Включены ли предупреждения о неизвестных полях от API, которых нет в библиотеке.
- Type
bool
- Parameters
token (
str
, optional) – Уникальный ключ для аутентификации.base_url (
str
, optional) – Ссылка на API Yandex Music.request (
yandex_music.utils.request.Request
, optional) – Пре-инициализацияyandex_music.utils.request.Request
.language (
str
, optional) – Язык, на котором будут приходить ответы от API.report_unknown_fields (
bool
, optional) – Включить предупреждения о неизвестных полях от API, которых нет в библиотеке.
- accountExperiments(timeout: Union[int, float] = None, *args, **kwargs) Optional[Experiments] #
Псевдоним для
account_experiments
- accountSettings(timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Псевдоним для
account_settings
- accountSettingsSet(param: str = None, value: Union[str, int, bool] = None, data: Dict[str, Union[str, int, bool]] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Псевдоним для
account_settings_set
- accountStatus(timeout: Union[int, float] = None, *args, **kwargs) Optional[Status] #
Псевдоним для
account_status
- account_experiments(timeout: Union[int, float] = None, *args, **kwargs) Optional[Experiments] #
Получение значений экспериментальных функций аккаунта.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Состояние экспериментальных функций или
None
.- Return type
yandex_music.Experiments
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- account_settings(timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Получение настроек текущего пользователя.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
- Настройки пользователя если аккаунт валиден,
иначе
None
.
- Return type
yandex_music.UserSettings
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- account_settings_set(param: str = None, value: Union[str, int, bool] = None, data: Dict[str, Union[str, int, bool]] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Изменение настроек текущего пользователя.
Note
Доступные названия параметров есть поля в классе
yandex_music.UserSettings
, только в CamelCase.- Parameters
param (
str
) – Название параметра для изменения.value (
str
|int
|bool
) – Значение параметра.data (
dict
) – Словарь параметров и значений для множественного изменения.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Настройки пользователя или
None
.- Return type
yandex_music.UserSettings
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- account_status(timeout: Union[int, float] = None, *args, **kwargs) Optional[Status] #
Получение статуса аккаунта. Нет обязательных параметров.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Информация об аккаунте если он валиден, иначе
None
.- Return type
yandex_music.Status
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- afterTrack(next_track_id: Union[str, int], context_item: str, prev_track_id: Union[str, int] = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', timeout: Union[int, float] = None, *args, **kwargs) Optional[ShotEvent] #
Псевдоним для
after_track
- after_track(next_track_id: Union[str, int], context_item: str, prev_track_id: Union[str, int] = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', timeout: Union[int, float] = None, *args, **kwargs) Optional[ShotEvent] #
Получение рекламы или шота от Алисы после трека.
Note
При получения шота от Алисы prev_track_id можно не указывать.
Если context = ‘playlist’, то в context_item необходимо передать {OWNER_PLAYLIST}:{ID_PLAYLIST}. Плейлист с Алисой имеет владельца с id = 940441070.
ID плейлиста можно получить из блоков landing’a. Получить шот чужого плейлиста нельзя.
Известные значения context: playlist.
Известные значения types: shot, ad.
- Parameters
prev_track_id (
str
|int
) – Уникальный идентификатор предыдущего трека.next_track_id (
str
|int
) – Уникальный идентификатор следующего трека.context_item (
str
) – Уникальный идентификатор контекста.context (
str
, optional) – Место, откуда было вызвано получение.types (
str
, optional) – Тип того, что вернуть после трека.from (
str
, optional) – Место, с которого попали в контекст.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Шот от Алисы или
None
.- Return type
yandex_music.ShotEvent
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- albums(album_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) List[Album] #
Получение альбома/альбомов.
- Parameters
album_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор альбома или альбомов.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Альбом или альбомы.
- Return type
list
изyandex_music.Album
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- albumsWithTracks(album_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[Album] #
Псевдоним для
albums_with_tracks
- albums_with_tracks(album_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[Album] #
Получение альбома по его уникальному идентификатору вместе с треками.
- Parameters
album_id (
str
|int
) – Уникальный идентификатор альбома.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Альбом или
None
.- Return type
list
изyandex_music.Album
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- artists(artist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) List[Artist] #
Получение исполнителя/исполнителей.
- Parameters
artist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор исполнителя или исполнителей.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Исполнитель или исполнители.
- Return type
list
изyandex_music.Artist
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- artistsBriefInfo(artist_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[BriefInfo] #
Псевдоним для
artists_brief_info
- artistsDirectAlbums(artist_id: Union[str, int], page: int = 0, page_size: int = 20, sort_by: str = 'year', timeout: Union[int, float] = None, *args, **kwargs) Optional[ArtistAlbums] #
Псевдоним для
artists_direct_albums
- artistsTracks(artist_id: Union[str, int], page: int = 0, page_size: int = 20, timeout: Union[int, float] = None, *args, **kwargs) Optional[ArtistTracks] #
Псевдоним для
artists_tracks
- artists_brief_info(artist_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[BriefInfo] #
Получение информации об артисте.
- Parameters
artist_id (
str
|int
) – Уникальный идентификатор исполнителя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Информация об артисте или
None
.- Return type
yandex_music.BriefInfo
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- artists_direct_albums(artist_id: Union[str, int], page: int = 0, page_size: int = 20, sort_by: str = 'year', timeout: Union[int, float] = None, *args, **kwargs) Optional[ArtistAlbums] #
Получение альбомов артиста.
Note
Известные значения для sort_by: year, rating.
- Parameters
artist_id (
str
|int
) – Уникальный идентификатор артиста.page (
int
, optional) – Номер страницы.page_size (
int
, optional) – Количество альбомов на странице.sort_by (
str
, optional) – Параметр для сортировки.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Страница списка альбомов артиста или
None
.- Return type
yandex_music.ArtistAlbums
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- artists_tracks(artist_id: Union[str, int], page: int = 0, page_size: int = 20, timeout: Union[int, float] = None, *args, **kwargs) Optional[ArtistTracks] #
Получение треков артиста.
- Parameters
artist_id (
str
|int
) – Уникальный идентификатор артиста.page (
int
, optional) – Номер страницы.page_size (
int
, optional) – Количество треков на странице.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Страница списка треков артиста или
None
.- Return type
yandex_music.ArtistsTracks
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- chart(chart_option: str = '', timeout: Union[int, float] = None, *args, **kwargs) Optional[ChartInfo] #
Получение чарта.
Note
chart_option - это постфикс к запросу из поля menu чарта. Например, на сайте можно выбрать глобальный (world) чарт или российский (russia).
- Parameters
chart_option (
str
optional) – Параметры чарта.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Чарт.
- Return type
yandex_music.ChartInfo
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- consumePromoCode(code: str, language: str = 'en', timeout: Union[int, float] = None, *args, **kwargs) Optional[PromoCodeStatus] #
Псевдоним для
consume_promo_code
- consume_promo_code(code: str, language: str = 'en', timeout: Union[int, float] = None, *args, **kwargs) Optional[PromoCodeStatus] #
Активация промо-кода.
- Parameters
code (
str
) – Промо-код.language (
str
, optional) – Язык ответа API в ISO 639-1.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Информация об активации промо-кода или
None
.- Return type
yandex_music.PromoCodeStatus
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- feed(timeout: Union[int, float] = None, *args, **kwargs) Optional[Feed] #
Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Умные плейлисты пользователя или
None
.- Return type
yandex_music.Feed
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- feedWizardIsPassed(timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
feed_wizard_is_passed
- feed_wizard_is_passed(timeout: Union[int, float] = None, *args, **kwargs) bool #
- genres(timeout: Union[int, float] = None, *args, **kwargs) List[Genre] #
Получение жанров музыки.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Жанры музыки или
None
.- Return type
list
изyandex_music.Genre
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- init()#
Получение информацию об аккаунте использующихся в других запросах.
- landing(blocks: Union[str, List[str]], timeout: Union[int, float] = None, *args, **kwargs) Optional[Landing] #
Получение лендинг-страницы содержащий блоки с новыми релизами, чартами, плейлистами с новинками и т.д.
Note
Поддерживаемые типы блоков: personalplaylists, promotions, new-releases, new-playlists, mixes, chart, artists, albums, playlists, play_contexts.
- Parameters
blocks (
str
|list
изstr
) – Блок или список блоков необходимых для выдачи.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Лендинг-страница или
None
.- Return type
yandex_music.Landing
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- newPlaylists(timeout: Union[int, float] = None, *args, **kwargs) Optional[LandingList] #
Псевдоним для
new_playlists
- newReleases(timeout: Union[int, float] = None, *args, **kwargs) Optional[LandingList] #
Псевдоним для
new_releases
- new_playlists(timeout: Union[int, float] = None, *args, **kwargs) Optional[LandingList] #
Получение полного списка всех новых плейлистов.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Список новых плейлистов.
- Return type
yandex_music.LandingList
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- new_releases(timeout: Union[int, float] = None, *args, **kwargs) Optional[LandingList] #
Получение полного списка всех новых релизов (альбомов).
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Список новых альбомов.
- Return type
yandex_music.LandingList
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- notice_displayed = False#
- permissionAlerts(timeout: Union[int, float] = None, *args, **kwargs) Optional[PermissionAlerts] #
Псевдоним для
permission_alerts
- permission_alerts(timeout: Union[int, float] = None, *args, **kwargs) Optional[PermissionAlerts] #
Получение оповещений. Нет обязательных параметров.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Оповещения если аккаунт валиден или
None
.- Return type
yandex_music.PermissionAlerts
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- playAudio(track_id: Union[str, int], from_: str, album_id: Union[str, int], playlist_id: str = None, from_cache: bool = False, play_id: str = None, uid: int = None, timestamp: str = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
play_audio
- play_audio(track_id: Union[str, int], from_: str, album_id: Union[str, int], playlist_id: str = None, from_cache: bool = False, play_id: str = None, uid: int = None, timestamp: str = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Метод для отправки текущего состояния прослушиваемого трека.
- Parameters
track_id (
str
|int
) – Уникальный идентификатор трека.from (
str
) – Наименования клиента с которого происходит прослушивание.album_id (
str
|int
) – Уникальный идентификатор альбома.playlist_id (
str
, optional) – Уникальный идентификатор плейлиста, если таковой прослушивается.from_cache (
bool
, optional) – Проигрывается ли трек с кеша.play_id (
str
, optional) – Уникальный идентификатор проигрывания.uid (
int
, optional) – Уникальный идентификатор пользователя.timestamp (
str
, optional) – Текущая дата и время в ISO.track_length_seconds (
int
, optional) – Продолжительность трека в секундах.total_played_seconds (
int
, optional) – Сколько было всего воспроизведено трека в секундах.end_position_seconds (
int
, optional) – Окончательное значение воспроизведенных секунд.client_now (
str
, optional) – Текущая дата и время клиента в ISO.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- playlistsCollectiveJoin(user_id: int, token: str, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
playlists_collective_join
- playlistsList(playlist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) List[Playlist] #
Псевдоним для
playlists_list
- playlists_collective_join(user_id: int, token: str, timeout: Union[int, float] = None, *args, **kwargs) bool #
Присоединение к плейлисту как соавтор.
Note
В качестве user_id принимается исключительно числовой уникальный идентификатор пользователя, не username.
Токен можно получить в Web-версии. Для этого, на странице плейлиста нужно нажать на “Добавить соавтора”. В полученной ссылке GET параметр token и будет токеном для присоединения.
- Parameters
user_id (
int
) – Владелец плейлиста.token (
str
) – Токен для присоединения.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- playlists_list(playlist_ids: Union[List[Union[str, int]], int, str], timeout: Union[int, float] = None, *args, **kwargs) List[Playlist] #
Получение плейлиста/плейлистов.
Note
Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.
- Parameters
playlist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор плейлиста или плейлистов.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Плейлист или плейлисты.
- Return type
list
изyandex_music.Playlist
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- podcasts(timeout: Union[int, float] = None, *args, **kwargs) Optional[LandingList] #
Получение подкастов с лендинга.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Список подскастов.
- Return type
yandex_music.LandingList
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queue(queue_id: str, timeout: Union[int, float] = None, *args, **kwargs) Optional[Queue] #
Получение информации об очереди треков и самих треков в ней.
- Parameters
queue_id (
str
) – Уникальный идентификатор очереди.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Очередь или
None
.- Return type
yandex_music.Queue
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queueCreate(queue: Union[Queue, str], device: str = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[str] #
Псевдоним для
queue_create
- queueUpdatePosition(queue_id: str, current_index: int, device: str = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
queue_update_position
- queue_create(queue: Union[Queue, str], device: str = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[str] #
Создание новой очереди треков.
- Parameters
queue (
yandex_music.Queue
|str
) – Объект очереди или JSON строка с этим объектом.device (
str
, optional) – Содержит информацию об устройстве с которого выполняется запрос.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Вернёт уникальный идентификатор созданной очереди, иначе
None
.- Return type
str
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queue_update_position(queue_id: str, current_index: int, device: str = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Установка текущего индекса проигрываемого трека в очереди треков.
Note
Изменить можно только у той очереди, которая была создана с переданного device!
- Parameters
queue_id (
str
) – Уникальный идентификатор очереди.current_index (
int
) – Текущий индекс.device (
str
, optional) – Содержит информацию об устройстве с которого выполняется запрос.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queuesList(device: str = None, timeout: Union[int, float] = None, *args, **kwargs) List[QueueItem] #
Псевдоним для
queues_list
- queues_list(device: str = None, timeout: Union[int, float] = None, *args, **kwargs) List[QueueItem] #
Получение всех очередей треков с разных устройств для синхронизации между ними.
Note
Именно к device привязывается очередь. На одном устройстве может быть создана одна очередь.
Аргумент device имеет следующий формат: ключ=значение; ключ2=значение2. Обязательные паля указы в значении по умолчанию.
- Parameters
device (
str
, optional) – Содержит информацию об устройстве с которого выполняется запрос.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Элементы очереди всех устройств.
- Return type
list
изyandex_music.QueueItem
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotorAccountStatus(timeout: Union[int, float] = None, *args, **kwargs) Optional[Status] #
Псевдоним для
rotor_account_status
- rotorStationFeedback(station: str, type_: str, timestamp: Union[str, float, int] = None, from_: str = None, batch_id: str = None, total_played_seconds: Union[int, float] = None, track_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_feedback
- rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_feedback_radio_started
- rotorStationFeedbackSkip(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_feedback_skip
- rotorStationFeedbackTrackFinished(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_feedback_track_finished
- rotorStationFeedbackTrackStarted(station: str, track_id: Union[str, int], batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_feedback_track_started
- rotorStationInfo(station: str, timeout: Union[int, float] = None, *args, **kwargs) List[StationResult] #
Псевдоним для
rotor_station_info
- rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
rotor_station_settings2
- rotorStationTracks(station: str, settings2: bool = True, queue: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[StationTracksResult] #
Псевдоним для
rotor_station_tracks
- rotorStationsDashboard(timeout: Union[int, float] = None, *args, **kwargs) Optional[Dashboard] #
Псевдоним для
rotor_stations_dashboard
- rotorStationsList(language: str = 'ru', timeout: Union[int, float] = None, *args, **kwargs) List[StationResult] #
Псевдоним для
rotor_stations_list
- rotor_account_status(timeout: Union[int, float] = None, *args, **kwargs) Optional[Status] #
Получение статуса пользователя с дополнителньыми полями.
Note
Данный статус отличается от обычного наличием дополнительных полей, например, skips_per_hour.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
- Статус пользователя с дополнительными полями от радио или
None
.
- Return type
yandex_music.Status
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_feedback(station: str, type_: str, timestamp: Union[str, float, int] = None, from_: str = None, batch_id: str = None, total_played_seconds: Union[int, float] = None, track_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Отправка ответной реакции на происходящее при прослушивании радио.
Note
Сообщения о начале прослушивания радио, начале и конце трека, его пропуска.
Известные типы фидбека: radioStarted, trackStarted, trackFinished, skip.
Пример station: user:onyourwave, genre:allrock.
Пример from_: mobile-radio-user-123456789.
- Parameters
station (
str
) – Станция.type (
str
) – Тип отправляемого фидбека.timestamp (
str
|float
|int
, optional) – Текущее время и дата.from (
str
, optional) – Откуда начато воспроизведение радио.batch_id (
str
, optional) – Уникальный идентификатор партии треков. Возвращается при получении треков.total_played_seconds (
int
|float
, optional) – Сколько было проиграно секунд трека перед действием.track_id (
int
|str
, optional) – Уникальной идентификатор трека.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_feedback_radio_started(station: str, from_: str, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Сокращение для:
client.rotor_station_feedback(station, 'radioStarted', timestamp, from, *args, **kwargs)
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_feedback_skip(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Сокращение для:
client.rotor_station_feedback(station, 'skip', timestamp, track_id, total_played_seconds, *args, **kwargs)
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_feedback_track_finished(station: str, track_id: Union[str, int], total_played_seconds: float, batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Сокращение для:
client.rotor_station_feedback(station, 'trackFinished', timestamp, track_id, total_played_seconds, *args, **kwargs)
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_feedback_track_started(station: str, track_id: Union[str, int], batch_id: str = None, timestamp: Union[str, float, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Сокращение для:
client.rotor_station_feedback(station, 'trackStarted', timestamp, track_id, *args, **kwargs)
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_info(station: str, timeout: Union[int, float] = None, *args, **kwargs) List[StationResult] #
Получение информации о станции и пользовательских настроек на неё.
- Parameters
station (
str
) – Станция.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Информация о станции или
None
.- Return type
list
изyandex_music.StationResult
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_settings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', timeout: Union[int, float] = None, *args, **kwargs) bool #
Изменение настроек определённой станции.
Note
Доступные значения для mood_energy: fun, active, calm, sad, all.
Доступные значения для diversity: favorite, popular, discover, default.
Доступные значения для language: not-russian, russian, any.
Доступные значения для type_: rotor, generative.
У станций в restrictions есть Enum’ы, а в них possible_values - доступные значения для поля.
- Parameters
station (
str
) – Станция.mood_energy (
str
) – Настроение.diversity (
str
) – Треки.language (
str
) – Язык.type (
str
) – Тип.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_station_tracks(station: str, settings2: bool = True, queue: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[StationTracksResult] #
Получение цепочки треков определённой станции.
Note
Запуск потока по сущности сервиса осуществляется через станцию <type>:<id>. Например, станцией для запуска потока по треку будет track:1234.
Для продолжения цепочки треков необходимо:
Передавать ID трека, что был до этого (первый в цепочки).
Отправить фидбек о конче или скипе трека, что был передан в queue.
Отправить фидбек о начале следующего трека (второй в цепочки).
Выполнить запрос получения треков. В ответе придёт новые треки или произойдёт сдвиг цепочки на 1 элемент.
Проход по цепочке до коцна не изучен. Часто встречаются дубликаты.
Все официальные клиенты выполняют запросы с settings2 = True.
- Parameters
station (
str
) – Станция.settings2 (
bool
, optional) – Использовать ли второй набор настроек.queue (
str
|int
, optional) – Уникальной идентификатор трека, который только что был.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Последовательность треков станции или
None
.- Return type
yandex_music.StationTracksResult
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_stations_dashboard(timeout: Union[int, float] = None, *args, **kwargs) Optional[Dashboard] #
Получение рекомендованных станций текущего пользователя.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Рекомендованные станции или
None
.- Return type
yandex_music.Dashboard
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_stations_list(language: str = 'ru', timeout: Union[int, float] = None, *args, **kwargs) List[StationResult] #
Получение всех радиостанций с настройками пользователя.
Note
Чтобы определить что за тип станции (жанры, настроения, занятие и т.д.) необходимо смотреть в поле id_for_from.
- Parameters
language (
str
) – Язык, на котором будет информация о станциях.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Станции или
None
.- Return type
list
изyandex_music.StationResult
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- search(text: str, nocorrect: bool = False, type_: str = 'all', page: int = 0, playlist_in_best: bool = True, timeout: Union[int, float] = None, *args, **kwargs) Optional[Search] #
Осуществление поиска по запросу и типу, получение результатов.
Note
Известные значения для поля type_: all, artist, user, album, playlist, track, podcast, podcast_episode.
При поиске type=all не возвращаются подкасты и эпизоды. Указывайте конкретный тип для поиска.
- Parameters
text (
str
) – Текст запроса.nocorrect (
bool
) – ЕслиFalse
, то ошибочный запрос будет исправлен. Например, запрос “Гражданская абарона” будет исправлен на “Гражданская оборона”.type (
str
) – Среди какого типа искать (трек, плейлист, альбом, исполнитель, пользователь, подкаст).page (
int
) – Номер страницы.playlist_in_best (
bool
) – Выдавать ли плейлисты лучшим вариантом поиска.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Результаты поиска или
None
.- Return type
yandex_music.Search
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- searchSuggest(part: str, timeout: Union[int, float] = None, *args, **kwargs) Optional[Suggestions] #
Псевдоним для
search_suggest
- search_suggest(part: str, timeout: Union[int, float] = None, *args, **kwargs) Optional[Suggestions] #
Получение подсказок по введенной части поискового запроса.
- Parameters
part (
str
) – Часть поискового запроса.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Подсказки для запроса или
None
.- Return type
yandex_music.Suggestions
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- settings(timeout: Union[int, float] = None, *args, **kwargs) Optional[Settings] #
Получение предложений по покупке. Нет обязательных параметров.
- Parameters
timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
- Информацию о предлагаемых продуктах если аккаунт валиден
или
None
.
- Return type
yandex_music.Settings
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tags(tag_id: str, timeout: Union[int, float] = None, *args, **kwargs) Optional[TagResult] #
Получение тега (подборки).
Note
Теги есть в MixLink у Landing, а также плейлистов в .tags.
У MixLink есть URL, но tag_id только его последняя часть. Например, /tag/belarus/. Tag - belarus.
- Parameters
tag_id (
str
) – Уникальный идентификатор тега.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Тег с плейлистами.
- Return type
yandex_music.TagResult
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- trackSupplement(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[Supplement] #
Псевдоним для
track_supplement
- track_supplement(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[Supplement] #
Получение дополнительной информации о треке.
- Parameters
track_id (
str
) – Уникальный идентификатор трека.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Дополнительная информация о треке.
- Return type
yandex_music.Supplement
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tracks(track_ids: Union[List[Union[str, int]], int, str], with_positions: bool = True, timeout: Union[int, float] = None, *args, **kwargs) List[Track] #
Получение трека/треков.
- Parameters
track_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор трека или треков.with_positions (
bool
, optional) – С позициями TODO.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Трек или Треки.
- Return type
list
изyandex_music.Track
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tracksDownloadInfo(track_id: Union[str, int], get_direct_links: bool = False, timeout: Union[int, float] = None, *args, **kwargs) List[DownloadInfo] #
Псевдоним для
tracks_download_info
- tracksSimilar(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[SimilarTracks] #
Псевдоним для
tracks_similar
- tracks_download_info(track_id: Union[str, int], get_direct_links: bool = False, timeout: Union[int, float] = None, *args, **kwargs) List[DownloadInfo] #
Получение информации о доступных вариантах загрузки трека.
- Parameters
track_id (
str
|list
изstr
) – Уникальный идентификатор трека или треков.get_direct_links (
bool
, optional) – Получить ли при вызове метода прямую ссылку на загрузку.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Варианты загрузки трека или
None
.- Return type
list
изyandex_music.DownloadInfo
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tracks_similar(track_id: Union[str, int], timeout: Union[int, float] = None, *args, **kwargs) Optional[SimilarTracks] #
Получение похожих треков.
- Parameters
track_id (
str
) – Уникальный идентификатор трека.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Похожие треки на другой трек.
- Return type
yandex_music.SimilarTracks
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- usersDislikesTracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) Optional[TracksList] #
Псевдоним для
users_dislikes_tracks
- usersDislikesTracksAdd(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_dislikes_tracks_add
- usersDislikesTracksRemove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_dislikes_tracks_remove
- usersLikesAlbums(user_id: Union[str, int] = None, rich: bool = True, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Псевдоним для
users_likes_albums
- usersLikesAlbumsAdd(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_albums_add
- usersLikesAlbumsRemove(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_albums_remove
- usersLikesArtists(user_id: Union[str, int] = None, with_timestamps: bool = True, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Псевдоним для
users_likes_artists
- usersLikesArtistsAdd(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_artists_add
- usersLikesArtistsRemove(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_artists_remove
- usersLikesPlaylists(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Псевдоним для
users_likes_playlists
- usersLikesPlaylistsAdd(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_playlists_add
- usersLikesPlaylistsRemove(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_playlists_remove
- usersLikesTracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) Optional[TracksList] #
Псевдоним для
users_likes_tracks
- usersLikesTracksAdd(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_tracks_add
- usersLikesTracksRemove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_likes_tracks_remove
- usersPlaylists(kind: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Union[Playlist, List[Playlist]] #
Псевдоним для
users_playlists
- usersPlaylistsChange(kind: Union[str, int], diff: str, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_change
- usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_create
- usersPlaylistsDelete(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Псевдоним для
users_playlists_delete
- usersPlaylistsDeleteTrack(kind: Union[str, int], from_: int, to: int, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_delete_track
- usersPlaylistsInsertTrack(kind: Union[str, int], track_id: Union[str, int], album_id: Union[str, int], at: int = 0, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_insert_track
- usersPlaylistsList(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) List[Playlist] #
Псевдоним для
users_playlists_list
- usersPlaylistsName(kind: Union[str, int], name: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_name
- usersPlaylistsRecommendations(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs)#
Псевдоним для
users_playlists_recommendations
- usersPlaylistsVisibility(kind: Union[str, int], visibility: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Псевдоним для
users_playlists_visibility
- usersSettings(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Псевдоним для
users_settings
- users_dislikes_tracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) Optional[TracksList] #
Получение треков с отметкой “Не рекомендовать”.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.if_modified_since_revision (
bool
, optional) – TODO.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Треки с отметкой “Не рекомендовать”.
- Return type
list
изyandex_music.TracksList
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_dislikes_tracks_add(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Поставить отметку “Не рекомендовать” треку/трекам.
Note
Так же снимает отметку “Мне нравится” если она есть.
- Parameters
track_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор трека или треков.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_dislikes_tracks_remove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Снять отметку “Не рекомендовать” у трека/треков.
- Parameters
track_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор трека или треков.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_albums(user_id: Union[str, int] = None, rich: bool = True, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Получение альбомов с отметкой “Мне нравится”.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.rich (
bool
, optional) – Если False, то приходит укороченная версия.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Альбомы с отметкой “Мне нравится”.
- Return type
list
изyandex_music.Like
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_albums_add(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Поставить отметку “Мне нравится” альбому/альбомам.
- Parameters
album_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор артиста или артистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_albums_remove(album_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Снять отметку “Мне нравится” у альбома/альбомов.
- Parameters
album_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор артиста или артистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_artists(user_id: Union[str, int] = None, with_timestamps: bool = True, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Получение артистов с отметкой “Мне нравится”.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.with_timestamps (
bool
, optional) – С временными метками TODO.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Артисты с отметкой “Мне нравится”.
- Return type
list
изyandex_music.Like
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_artists_add(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Поставить отметку “Мне нравится” исполнителю/исполнителям.
- Parameters
artist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор артиста или артистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_artists_remove(artist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Снять отметку “Мне нравится” у исполнителя/исполнителей.
- Parameters
artist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор артиста или артистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_playlists(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) List[Like] #
Получение плейлистов с отметкой “Мне нравится”.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Плейлисты с отметкой “Мне нравится”.
- Return type
list
изyandex_music.Like
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_playlists_add(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Поставить отметку “Мне нравится” плейлисту/плейлистам.
Note
Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.
- Parameters
playlist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор плейлиста или плейлистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_playlists_remove(playlist_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Снять отметку “Мне нравится” у плейлиста/плейлистов.
Note
Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.
- Parameters
playlist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор плейлиста или плейлистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_tracks(user_id: Union[str, int] = None, if_modified_since_revision: int = 0, timeout: Union[int, float] = None, *args, **kwargs) Optional[TracksList] #
Получение треков с отметкой “Мне нравится”.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.if_modified_since_revision (
int
, optional) – TODO.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Треки с отметкой “Мне нравится”.
- Return type
yandex_music.TracksList
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_tracks_add(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Поставить отметку “Мне нравится” треку/трекам.
Note
Так же снимает отметку “Не рекомендовать” если она есть.
- Parameters
track_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор трека или треков.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_tracks_remove(track_ids: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Снять отметку “Мне нравится” у трека/треков.
- Parameters
track_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор трека или треков.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists(kind: Union[List[Union[str, int]], str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Union[Playlist, List[Playlist]] #
Получение плейлиста или списка плейлистов по уникальным идентификаторам.
Note
Если передан один kind, то вернётся не список плейлистов, а один плейлист.
- Parameters
kind (
str
|int
|list
изstr
|int
) – Уникальный идентификатор плейлиста или их список.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Список плейлистов или плейлист, иначе
None
.- Return type
list
изyandex_music.Playlist
|yandex_music.Playlist
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_change(kind: Union[str, int], diff: str, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Изменение плейлиста.
Note
Для получения отличий есть вспомогательный класс
yandex_music.utils.difference.Difference
.Так же существуют уже готовые методы-обёртки над операциями.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.revision (
int
) – TODO.diff (
str
) – JSON представления отличий старого и нового плейлиста.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Изменённый плейлист или
None
.- Return type
yandex_music.Playlist
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_create(title: str, visibility: str = 'public', user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Создание плейлиста.
- Parameters
title (
str
) – Название.visibility (
str
, optional) – Модификатор доступа.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Созданный плейлист или
None
.- Return type
yandex_music.Playlist
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_delete(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) bool #
Удаление плейлиста.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
True
при успешном выполнении запроса, иначеFalse
.- Return type
bool
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_delete_track(kind: Union[str, int], from_: int, to: int, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Удаление треков из плейлиста.
Note
Для удаление необходимо указать границы с какого по какой элемент (трек) удалить.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.from (
int
) – С какого индекса.to (
int
) – По какой индекс.revision (
int
) – TODO.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Изменённый плейлист или
None
.- Return type
yandex_music.Playlist
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_insert_track(kind: Union[str, int], track_id: Union[str, int], album_id: Union[str, int], at: int = 0, revision: int = 1, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Добавление трека в плейлист.
Note
Трек можно вставить с любое место плейлиста задав индекс вставки (аргумент at).
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.track_id (
str
|int
) – Уникальный идентификатор трека.album_id (
str
|int
) – Уникальный идентификатор альбома.at (
int
) – Индекс для вставки.revision (
int
) – TODO.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Изменённый плейлист или
None
.- Return type
yandex_music.Playlist
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_list(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) List[Playlist] #
Получение списка плейлистов пользователя.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Плейлисты пользователя.
- Return type
list
изyandex_music.Playlist
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_name(kind: Union[str, int], name: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Изменение названия плейлиста.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.name (
str
) – Новое название.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Изменённый плейлист или
None
.- Return type
yandex_music.Playlist
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_recommendations(kind: Union[str, int], user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs)#
Получение рекомендаций для плейлиста.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.user_id (
str
|int
) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Рекомендации для плейлиста или
None
.- Return type
yandex_music.PlaylistRecommendations
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_visibility(kind: Union[str, int], visibility: str, user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[Playlist] #
Изменение видимости плейлиста.
Note
Видимость (visibility) может быть задана только одним из двух значений: private, public.
- Parameters
kind (
str
|int
) – Уникальный идентификатор плейлиста.visibility (
str
) – Новое название.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя владеющим плейлистом.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Изменённый плейлист или
None
.- Return type
yandex_music.Playlist
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_settings(user_id: Union[str, int] = None, timeout: Union[int, float] = None, *args, **kwargs) Optional[UserSettings] #
Получение настроек пользователя.
Note
Для получения настроек пользователя нужно быть авторизованным или владеть user_id.
- Parameters
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя чьи настройки хотим получить.timeout (
int
|float
, optional) – Если это значение указано, используется как время ожидания ответа от сервера вместо указанного при создании пула.**kwargs (
dict
, optional) – Произвольные аргументы (будут переданы в запрос).
- Returns
Настройки пользователя или
None
.- Return type
yandex_music.UserSettings
|None
- Raises
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- yandex_music.client.log(method)#