yandex_music#

class yandex_music.Account(now: str, service_available: bool, region: int | None = None, uid: int | None = None, login: str | None = None, full_name: str | None = None, second_name: str | None = None, first_name: str | None = None, display_name: str | None = None, hosted_user: bool | None = None, birthday: str | None = None, passport_phones: List[PassportPhone] = None, registered_at: str | None = None, has_info_for_app_metrica: bool = None, child: bool = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий основную информацию об аккаунте пользователя.

now#

Текущая дата и время.

Type:: str

uid#

Уникальный идентификатор.

Type:: int, optional

login#

Виртуальное имя (обычно e-mail).

Type:: str, optional

full_name#

Полное имя (имя и фамилия).

Type:: str, optional

second_name#

Фамилия.

Type:: str, optional

first_name#

Имя.

Type:: str, optional

display_name#

Отображаемое имя.

Type:: str, optional

service_available#

Доступен ли сервис.

Type:: bool

hosted_user#

Является ли пользователем чьим-то другим.

Type:: bool, optional

birthday#

Дата рождения.

Type:: str, optional

region#

Регион.

Type:: int, optional

passport_phones#

Мобильные номера.

Type:: list из yandex_music.PassportPhone

registered_at#

Дата создания учётной записи.

Type:: str, optional

has_info_for_app_metrica#

Наличие информации для App Metrica.

Type:: bool, optional

child#

Дочерний / детский аккаунт (скорее детский, позволяет ограничить доступный контент ребенку на Кинопоиске).

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

\*\*kwargs: Произвольные ключевые аргументы полученные от API.

birthday: str | None = None#

child: bool = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Account | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Основная информация об аккаунте пользователя.

Return type:

yandex_music.Account

display_name: str | None = None#

first_name: str | None = None#

full_name: str | None = None#

has_info_for_app_metrica: bool = None#

hosted_user: bool | None = None#

login: str | None = None#

now: str#

passport_phones: List[PassportPhone] = None#

region: int | None = None#

registered_at: str | None = None#

second_name: str | None = None#

service_available: bool#

uid: int | None = None#

Bases: YandexMusicObject

Класс, представляющий параметры рекламного объявления.

Note

Известные дополнительные параметры(other_params): user:{ID}.

partner_id#

Уникальный идентификатор заказчика рекламы.

Type:: str | int

category_id#

Уникальный идентификатор категории рекламы.

Type:: str | int

page_ref#

Ссылка на ссылающуюся страницу.

Type:: str

target_ref#

Ссылка на целевую страницу.

Type:: str

other_params#

Другие параметры.

Type:: str

ad_volume#

Громкость воспроизводимой рекламы.

Type:: int

genre_id#

Уникальный идентификатор жанра.

Type:: str, optional

genre_name#

Название жанра.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

ad_volume: int#

category_id: str | int#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → AdParams | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Параметры рекламного объявления.

Return type:

yandex_music.AdParams

genre_id: str | None = None#

genre_name: str | None = None#

other_params: str#

page_ref: str#

partner_id: str | int#

target_ref: str#

Bases: YandexMusicObject

Класс, представляющий альбом.

Note

Известные типы альбома: single - сингл, compilation - сборник.

Известные предупреждения о содержимом: explicit - ненормативная лексика.

Известные ошибки: not-found - альбом с таким ID не существует.

Известные значения поля meta_type: music.

Известные значения поля available_for_options: bookmate.

id#

Идентификатор альбома.

Type:: int, optional

error#

Ошибка получения альбома.

Type:: str, optional

title#

Название альбома.

Type:: str, optional

track_count#

Количество треков.

Type:: int, optional

artists#

Артисты.

Type:: list из yandex_music.Artist, optional

labels#

Лейблы.

Type:: list из yandex_music.Label или str, optional

available#

Доступен ли альбом.

Type:: bool, optional

available_for_premium_users#

Доступен ли альбом для пользователей с подпиской.

Type:: bool, optional

version#

Дополнительная информация об альбоме.

Type:: str, optional

cover_uri#

Ссылка на обложку.

Type:: str, optional

content_warning#

Предупреждение о содержимом альбома.

Type:: str, optional

original_release_year#

TODO.

Type:: Any

genre#

Жанр музыки.

Type:: str, optional

text_color#

Цвет текста описания.

Type:: str, optional

short_description#

Короткое описание.

Type:: str, optional

description#

Описание.

Type:: str, optional

is_premiere#

Премьера ли.

Type:: bool, optional

is_banner#

Является ли баннером.

Type:: bool, optional

meta_type#

Мета тип TODO.

Type:: str, optional

storage_dir#

В какой папке на сервере хранится файл TODO.

Type:: str, optional

og_image#

Ссылка на превью Open Graph.

Type:: str, optional

recent#

Является ли альбом новым.

Type:: bool, optional

very_important#

Популярен ли альбом у слушателей.

Type:: bool, optional

available_for_mobile#

Доступен ли альбом из приложения для телефона.

Type:: bool, optional

available_partially#

Доступен ли альбом частично для пользователей без подписки.

Type:: bool, optional

bests#

ID лучших треков альбома.

Type:: list из int, optional

duplicates#

Альбомы-дубликаты.

Type:: list из yandex_music.Album, optional

prerolls#

Прероллы TODO.

Type:: list, optional

volumes#

Треки альбома, разделённые по дискам.

Type:: list из list из Track, optional

year#

Год релиза.

Type:: int, optional

release_date#

Дата релиза в формате ISO 8601.

Type:: str, optional

type#

Тип альбома.

Type:: str, optional

track_position#

Позиция трека в альбоме. Возвращается при получении альбома в составе трека.

Type:: yandex_music.TrackPosition, optional

regions#

Список регионов в которых доступен альбом.

Type:: list из str, optional

available_as_rbt#

TODO.

Type:: bool, optional

lyrics_available#

Доступны ли слова TODO.

Type:: bool, optional

remember_position#

Запоминание позиции TODO.

Type:: bool, optional

albums#

Альбомы TODO.

Type:: list из yandex_music.Album, optional

duration_ms#

Длительность в миллисекундах.

Type:: int, optional

explicit#

Есть ли в треке ненормативная лексика.

Type:: bool, optional

start_date#

Дата начала в формате ISO 8601 TODO.

Type:: str, optional

likes_count#

Количество лайков TODO.

Type:: int, optional

deprecation#

TODO.

Type:: yandex_music.Deprecation, optional

available_regions#

Регионы, где доступен альбом.

Type:: list из str, optional

available_for_options#

Возможные опции для альбома.

Type:: list из str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

albums: List[Album] | None = None#

artists: List[Artist] = None#

artistsName() → List[str]#: Псевдоним для artists_name

artists_name() → List[str]#

Получает имена всех исполнителей.

Returns:: Имена исполнителей.
Return type:: list из str

available: bool | None = None#

available_as_rbt: bool | None = None#

available_for_mobile: bool | None = None#

available_for_options: List[str] | None = None#

available_for_premium_users: bool | None = None#

available_partially: bool | None = None#

available_regions: List[str] | None = None#

bests: List[int] | None = None#

buy: list | None = None#

client: Client | None = None#

content_warning: str | None = None#

cover_uri: str | None = None#

classmethod de_json(data: dict, client: Client) → Album | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Альбом.

Return type:

yandex_music.Album

classmethod de_list(data: list, client: Client) → List[Album]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Альбомы.

Return type:

list из yandex_music.Album

deprecation: Deprecation | None = None#

description: str | None = None#

dislike(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_albums_remove(album.id, user.id *args, **kwargs)

async dislikeAsync(*args, **kwargs) → bool#: Псевдоним для dislike_async

async dislike_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_albums_remove(album.id, user.id *args, **kwargs)

downloadCover(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover

async downloadCoverAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_async

downloadCoverBytes(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes

async downloadCoverBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes_async

downloadOgImage(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image

async downloadOgImageAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image_async

downloadOgImageBytes(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes

async downloadOgImageBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes_async

download_cover(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_cover_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_cover_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_cover_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

download_og_image(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Предпочтительнее использовать self.download_cover().

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_og_image_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Предпочтительнее использовать self.download_cover_async().

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_og_image_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Предпочтительнее использовать self.download_cover().

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_og_image_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Предпочтительнее использовать self.download_cover_async().

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

duplicates: List[Album] = None#

duration_ms: int | None = None#

error: str | None = None#

explicit: bool | None = None#

genre: str | None = None#

getCoverUrl(size: str = '200x200') → str#: Псевдоним для get_cover_url

getOgImageUrl(size: str = '200x200') → str#: Псевдоним для get_og_image_url

get_cover_url(size: str = '200x200') → str#

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

get_og_image_url(size: str = '200x200') → str#

Возвращает URL OG обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

id: int | None = None#

is_banner: bool | None = None#

is_premiere: bool | None = None#

labels: List[Label | str] = None#

like(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_albums_add(album.id, user.id *args, **kwargs)

async likeAsync(*args, **kwargs) → bool#: Псевдоним для like_async

async like_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_albums_add(album.id, user.id *args, **kwargs)

likes_count: int | None = None#

lyrics_available: bool | None = None#

meta_type: str | None = None#

og_image: str | None = None#

original_release_year: Any = None#

prerolls: list | None = None#

recent: bool | None = None#

regions: List[str] | None = None#

release_date: str | None = None#

remember_position: bool | None = None#

short_description: str | None = None#

start_date: str | None = None#

storage_dir: str | None = None#

text_color: str | None = None#

title: str | None = None#

track_count: int | None = None#

track_position: TrackPosition | None = None#

type: str | None = None#

version: str | None = None#

very_important: bool | None = None#

volumes: List[List[Track]] | None = None#

withTracks(*args, **kwargs) → Album | None#: Псевдоним для with_tracks

async withTracksAsync(*args, **kwargs) → Album | None#: Псевдоним для with_tracks_async

with_tracks(*args, **kwargs) → Album | None#

Сокращение для:

client.albums_with_tracks(album.id, *args, **kwargs)

async with_tracks_async(*args, **kwargs) → Album | None#

Сокращение для:

await client.albums_with_tracks(album.id, *args, **kwargs)

year: int | None = None#

class yandex_music.AlbumEvent(album: Album | None, tracks: List[Track], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий альбом в событии фида.

album#

Альбом.

Type:: yandex_music.Album, optional

tracks#

Треки.

Type:: list из yandex_music.Track

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

album: Album | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → AlbumEvent | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Альбом в событии фида.

Return type:

yandex_music.AlbumEvent

classmethod de_list(data: list, client: Client) → List[AlbumEvent]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Альбомы в событии фида.

Return type:

list из yandex_music.AlbumEvent

tracks: List[Track]#

class yandex_music.Alert(alert_id: str, text: str, bg_color: str, text_color: str, alert_type: str, button: AlertButton, close_button: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий блок с предупреждением.

Note

Данные предупреждения, скорее всего, только обкатываются. У них нет ID, вместо этого xxx, а еще присутствуют слова “тест” в тексте.

Используют как предупреждение о конце подписки, так и о раздаче подарков.

alert_id#

Уникальный идентификатор.

Type:: str

text#

Текст предупреждения.

Type:: str

bg_color#

Цвет заднего фона.

Type:: str

text_color#

Цвет текста.

Type:: str

alert_type#

Тип предупреждения.

Type:: str

button#

Кнопка с ссылкой.

Type:: yandex_music.AlertButton

close_button#

Наличие кнопки “Закрыть”.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

alert_id: str#

alert_type: str#

bg_color: str#

button: AlertButton#

client: Client | None = None#

close_button: bool#

classmethod de_json(data: dict, client: Client) → Alert | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Сообщение о статусе подписки.

Return type:

yandex_music.Alert

text: str#

text_color: str#

class yandex_music.AlertButton(text: str, bg_color: str, text_color: str, uri: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий кнопку в предупреждении.

text#

Текст кнопки.

Type:: str

bg_color#

Цвет заднего фона.

Type:: str

text_color#

Цвет текста.

Type:: str

uri#

Ссылка куда ведёт кнопка.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

bg_color: str#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → AlertButton | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Кнопка в статусе о подписки.

Return type:

yandex_music.AlertButton

text: str#

text_color: str#

uri: str#

Bases: YandexMusicObject

Класс, представляющий исполнителя.

id#

Уникальный идентификатор.

Type:: int

error#

Сообщение об ошибке с объяснением почему не вернуло исполнителя.

Type:: str, optional

reason#

Причина отсутствия исполнителя (сообщение об ошибке).

Type:: str, optional

name#

Название.

Type:: str, optional

cover#

Обложка.

Type:: yandex_music.Cover, optional

various#

TODO.

Type:: bool, optional

composer#

TODO.

Type:: bool, optional

genres#

Жанры.

Type:: list из str, optional

og_image#

Ссылка на изображение для Open Graph.

Type:: str, optional

op_image#

Ссылка на изображение обложки. Используется когда не указано поле cover.

Type:: str, optional

no_pictures_from_search#

TODO.

Type:: Any

counts#

Счётчики.

Type:: yandex_music.Counts, optional

available#

Доступен ли для прослушивания.

Type:: bool, optional

ratings#

Рейтинги.

Type:: yandex_music.Ratings, optional

links#

Ссылки на ресурсы исполнителя.

Type:: list из yandex_music.Link, optional

tickets_available#

Имеются ли в продаже билеты на концерт.

Type:: bool, optional

likes_count#

Количество лайков.

Type:: int, optional

popular_tracks#

Популярные треки.

Type:: list из yandex_music.Track

similar_artists#

Похожие артисты.

Type:: list из yandex_music.Artist

all_covers#

Все обложки.

Type:: list из yandex_music.Cover

concerts#

Концерты (тест-кейс с ними потерялся, мало у кого есть).

Type:: str

videos#

Видео.

Type:: list из yandex_music.Video

vinyls#

Пластинки.

Type:: list из yandex_music.Vinyl

has_promotions#

Рекламируется ли TODO.

Type:: bool

playlist_ids#

Уникальные идентификаторы плейлистов.

Type:: list из yandex_music.PlaylistId

tracks_in_chart#

Треки в чарте.

Type:: list из yandex_music.Chart, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

albums: List[Album]#

all_covers: List[Cover]#

also_albums: List[Album]#

artist: Artist | None#

client: Client | None = None#

concerts: Any#

classmethod de_json(data: dict, client: Client) → BriefInfo | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация об артисте.

Return type:

yandex_music.BriefInfo

has_promotions: bool#

last_release_ids: List[int]#

last_releases: List[Album]#

playlist_ids: List[PlaylistId]#

playlists: List[Playlist]#

popular_tracks: List[Track]#

similar_artists: List[Artist]#

tracks_in_chart: List[Chart] = None#

videos: List[Video]#

vinyls: List[Vinyl]#

class yandex_music.CaseForms(nominative: str, genitive: str, dative: str, accusative: str, instrumental: str, prepositional: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий склонение имени.

nominative#

Именительный.

Type:: str

genitive#

Родительный.

Type:: str

dative#

Дательный.

Type:: str

accusative#

Винительный.

Type:: str

instrumental#

Творительный.

Type:: str

prepositional#

Предложный.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

accusative: str#

client: Client | None = None#

dative: str#

classmethod de_json(data: dict, client: Client) → CaseForms | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Склонение имени.

Return type:

yandex_music.CaseForms

genitive: str#

instrumental: str#

nominative: str#

prepositional: str#

class yandex_music.Chart(position: int, progress: str, listeners: int, shift: int, bg_color: str | None = None, track_id: TrackId | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий элемент чарта.

Note

Смещение - это количество позиций, на которые трек поднялся или опустился в чарте.

position#

Позиция.

Type:: int

progress#

TODO.

Type:: str

listeners#

Количество слушателей.

Type:: int

shift#

Смещение.

Type:: int

bg_color#

Цвет заднего фона.

Type:: str, optional

track_id#

Уникальный идентификатор трека.

Type:: yandex_music.TrackId, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

bg_color: str | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Chart | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Элемент чарта.

Return type:

yandex_music.Chart

classmethod de_list(data: list, client: Client) → List[Chart]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Чарт.

Return type:

list из yandex_music.Chart

listeners: int#

position: int#

progress: str#

shift: int#

track_id: TrackId | None = None#

class yandex_music.ChartInfo(id: str, type: str, type_for_from: str, title: str, menu: ChartInfoMenu | None, chart: Playlist | None, chart_description: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий чарт.

id#

Уникальный идентификатор блока.

Type:: str

type#

Тип блока.

Type:: str

type_for_from#

Откуда получен блок (как к нему пришли).

Type:: str

title#

Заголовок.

Type:: str

menu#

Меню TODO.

Type:: yandex_music.ChartInfoMenu, optional

chart#

Плейлист.

Type:: yandex_music.Playlist, optional

chart_description#

Описание.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

chart: Playlist | None#

chart_description: str | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ChartInfo | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Чарт.

Return type:

yandex_music.ChartInfo

id: str#

menu: ChartInfoMenu | None#

title: str#

type: str#

type_for_from: str#

class yandex_music.ChartInfoMenu(items: List[ChartInfoMenuItem], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий меню чарта.

items#

Список элементов меню.

Type:: list из yandex_music.ChartInfoMenuItem

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ChartInfoMenu | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Меню чарта.

Return type:

yandex_music.ChartInfoMenu

items: List[ChartInfoMenuItem]#

class yandex_music.ChartInfoMenuItem(title: str, url: str, selected: bool | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий элемент меню чарта.

title#

Заголовок.

Type:: str

url#

Постфикс для запроса чарта.

Type:: str

selected#

Текущий ли элемент.

Type:: bool, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ChartInfoMenuItem | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Элемент меню.

Return type:

yandex_music.ChartInfoMenuItem

classmethod de_list(data: list, client: Client) → List[ChartInfoMenuItem]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список элементов меню чарта.

Return type:

list из yandex_music.ChartInfoMenuItem

selected: bool | None = None#

title: str#

url: str#

class yandex_music.ChartItem(track: Track | None, chart: Chart | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий трек в чарте.

track#

Трек.

Type:: yandex_music.Track | None

chart#

Элемент чарт.

Type:: yandex_music.Chart | None

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

chart: Chart | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ChartItem | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Трек в чарте.

Return type:

yandex_music.ChartItem

classmethod de_list(data: list, client: Client) → List[ChartItem]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Треки в чартах.

Return type:

list из yandex_music.ChartItem

track: Track | None#

class yandex_music.Client(token: str = None, base_url: str = None, request: Request = None, language: str = 'ru', report_unknown_fields: bool = 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(*args, **kwargs) → Experiments | None#: Псевдоним для account_experiments

accountSettings(*args, **kwargs) → UserSettings | None#: Псевдоним для account_settings

accountSettingsSet(param: str = None, value: str | int | bool = None, data: Dict[str, str | int | bool] = None, *args, **kwargs) → UserSettings | None#: Псевдоним для account_settings_set

accountStatus(*args, **kwargs) → Status | None#: Псевдоним для account_status

account_experiments(*args, **kwargs) → Experiments | None#

Получение значений экспериментальных функций аккаунта.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Состояние экспериментальных функций или None.

Return type:

yandex_music.Experiments | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

account_settings(*args, **kwargs) → UserSettings | None#

Получение настроек текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя если аккаунт валиден,: иначе None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Изменение настроек текущего пользователя.

Note

Доступные названия параметров есть поля в классе yandex_music.UserSettings, только в CamelCase.

Parameters:

param (str) – Название параметра для изменения.
value (str | int | bool) – Значение параметра.
data (dict) – Словарь параметров и значений для множественного изменения.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

account_status(*args, **kwargs) → Status | None#

Получение статуса аккаунта. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об аккаунте если он валиден, иначе None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

afterTrack(next_track_id: str | int, context_item: str, prev_track_id: str | int = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args, **kwargs) → ShotEvent | None#: Псевдоним для after_track

after_track(next_track_id: str | int, context_item: str, prev_track_id: str | int = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args, **kwargs) → ShotEvent | None#

Получение рекламы или шота от Алисы после трека.

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) – Место, с которого попали в контекст.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Шот от Алисы или None.

Return type:

yandex_music.ShotEvent

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

albums(album_ids: List[str | int] | int | str, *args, **kwargs) → List[Album]#

Получение альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор альбома или альбомов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или альбомы.

Return type:

list из yandex_music.Album

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

albumsWithTracks(album_id: str | int, *args, **kwargs) → Album | None#: Псевдоним для albums_with_tracks

albums_with_tracks(album_id: str | int, *args, **kwargs) → Album | None#

Получение альбома по его уникальному идентификатору вместе с треками.

Parameters:

album_id (str | int) – Уникальный идентификатор альбома.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или None.

Return type:

list из yandex_music.Album | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists(artist_ids: List[str | int] | int | str, *args, **kwargs) → List[Artist]#

Получение исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор исполнителя или исполнителей.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Исполнитель или исполнители.

Return type:

list из yandex_music.Artist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artistsBriefInfo(artist_id: str | int, *args, **kwargs) → BriefInfo | None#: Псевдоним для artists_brief_info

artistsDirectAlbums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args, **kwargs) → ArtistAlbums | None#: Псевдоним для artists_direct_albums

artistsTracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args, **kwargs) → ArtistTracks | None#: Псевдоним для artists_tracks

artists_brief_info(artist_id: str | int, *args, **kwargs) → BriefInfo | None#

Получение информации об артисте.

Parameters:

artist_id (str | int) – Уникальный идентификатор исполнителя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об артисте или None.

Return type:

yandex_music.BriefInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists_direct_albums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args, **kwargs) → ArtistAlbums | None#

Получение альбомов артиста.

Note

Известные значения для sort_by: year, rating.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество альбомов на странице.
sort_by (str, optional) – Параметр для сортировки.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка альбомов артиста или None.

Return type:

yandex_music.ArtistAlbums | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

artists_tracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args, **kwargs) → ArtistTracks | None#

Получение треков артиста.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество треков на странице.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка треков артиста или None.

Return type:

yandex_music.ArtistsTracks | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

chart(chart_option: str = '', *args, **kwargs) → ChartInfo | None#

Получение чарта.

Note

chart_option - это постфикс к запросу из поля menu чарта. Например, на сайте можно выбрать глобальный (world) чарт или российский (russia).

Parameters:

chart_option (str optional) – Параметры чарта.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Чарт.

Return type:

yandex_music.ChartInfo

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

consumePromoCode(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None#: Псевдоним для consume_promo_code

consume_promo_code(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None#

Активация промо-кода.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Parameters:

code (str) – Промо-код.
language (str, optional) – Язык ответа API в ISO 639-1. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об активации промо-кода или None.

Return type:

yandex_music.PromoCodeStatus | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

feed(*args, **kwargs) → Feed | None#

Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Умные плейлисты пользователя или None.

Return type:

yandex_music.Feed | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

feedWizardIsPassed(*args, **kwargs) → bool#: Псевдоним для feed_wizard_is_passed

feed_wizard_is_passed(*args, **kwargs) → bool#

Получение информации о прохождении визарда.

Note

Временное событие на хэллоуин.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Прошел ли пользователь визард или нет.

Return type:

bool

genres(*args, **kwargs) → List[Genre]#

Получение жанров музыки.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Жанры музыки или None.

Return type:

list из yandex_music.Genre | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

init() → Client#: Получение информацию об аккаунте использующихся в других запросах.

landing(blocks: str | List[str], *args, **kwargs) → Landing | None#

Получение лендинг-страницы содержащий блоки с новыми релизами, чартами, плейлистами с новинками и т.д.

Note

Поддерживаемые типы блоков: personalplaylists, promotions, new-releases, new-playlists, mixes, chart, artists, albums, playlists, play_contexts.

Parameters:

blocks (str | list из str) – Блок или список блоков необходимых для выдачи.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Лендинг-страница или None.

Return type:

yandex_music.Landing | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

newPlaylists(*args, **kwargs) → LandingList | None#: Псевдоним для new_playlists

newReleases(*args, **kwargs) → LandingList | None#: Псевдоним для new_releases

new_playlists(*args, **kwargs) → LandingList | None#

Получение полного списка всех новых плейлистов.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых плейлистов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

new_releases(*args, **kwargs) → LandingList | None#

Получение полного списка всех новых релизов (альбомов).

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых альбомов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

permissionAlerts(*args, **kwargs) → PermissionAlerts | None#: Псевдоним для permission_alerts

permission_alerts(*args, **kwargs) → PermissionAlerts | None#

Получение оповещений. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Оповещения если аккаунт валиден или None.

Return type:

yandex_music.PermissionAlerts | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playAudio(track_id: str | int, from_: str, album_id: 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, *args, **kwargs) → bool#: Псевдоним для play_audio

play_audio(track_id: str | int, from_: str, album_id: 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, *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.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playlistsCollectiveJoin(user_id: int, token: str, **kwargs) → bool#: Псевдоним для playlists_collective_join

playlistsList(playlist_ids: List[str | int] | int | str, *args, **kwargs) → List[Playlist]#: Псевдоним для playlists_list

playlists_collective_join(user_id: int, token: str, **kwargs) → bool#

Присоединение к плейлисту как соавтор.

Note

В качестве user_id принимается исключительно числовой уникальный идентификатор пользователя, не username.

Токен можно получить в Web-версии. Для этого, на странице плейлиста нужно нажать на “Добавить соавтора”. В полученной ссылке GET параметр token и будет токеном для присоединения.

Parameters:

user_id (int) – Владелец плейлиста.
token (str) – Токен для присоединения.
**kwargs – Произвольные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

playlists_list(playlist_ids: List[str | int] | int | str, *args, **kwargs) → List[Playlist]#

Получение плейлиста/плейлистов.

Note

Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.

Данный метод возвращает сокращенную модель плейлиста для отображения больших список.

Warning

Данный метод не возвращает список треков у плейлиста! Для получения объекта yandex_music.Playlist c заполненным полем tracks используйте метод yandex_music.Client.users_playlists() или метод yandex_music.Playlist.fetch_tracks().

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлист или плейлисты.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

podcasts(*args, **kwargs) → LandingList | None#

Получение подкастов с лендинга.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список подкастов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue(queue_id: str, *args, **kwargs) → Queue | None#

Получение информации об очереди треков и самих треков в ней.

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Очередь или None.

Return type:

yandex_music.Queue

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queueCreate(queue: Queue | str, device: str = None, *args, **kwargs) → str | None#: Псевдоним для queue_create

queueUpdatePosition(queue_id: str, current_index: int, device: str = None, **kwargs) → bool#: Псевдоним для queue_update_position

queue_create(queue: Queue | str, device: str = None, *args, **kwargs) → str | None#

Создание новой очереди треков.

Parameters:

queue (yandex_music.Queue | str) – Объект очереди или JSON строка с этим объектом.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Вернёт уникальный идентификатор созданной очереди, иначе None.

Return type:

str

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queue_update_position(queue_id: str, current_index: int, device: str = None, **kwargs) → bool#

Установка текущего индекса проигрываемого трека в очереди треков.

Note

Изменить можно только у той очереди, которая была создана с переданного device!

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
current_index (int) – Текущий индекс.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

queuesList(device: str = None, *args, **kwargs) → List[QueueItem]#: Псевдоним для queues_list

queues_list(device: str = None, *args, **kwargs) → List[QueueItem]#

Получение всех очередей треков с разных устройств для синхронизации между ними.

Note

Именно к device привязывается очередь. На одном устройстве может быть создана одна очередь.

Аргумент device имеет следующий формат: ключ=значение; ключ2=значение2. Обязательные паля указы в значении по умолчанию.

Parameters:

device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Элементы очереди всех устройств.

Return type:

list из yandex_music.QueueItem

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

property request: Request#

Объект вспомогательного класса для отправки запросов.

Type:: yandex_music.utils.request.Request

rotorAccountStatus(*args, **kwargs) → Status | None#: Псевдоним для rotor_account_status

rotorStationFeedback(station: str, type_: str, timestamp: str | float | int = None, from_: str = None, batch_id: str = None, total_played_seconds: int | float = None, track_id: str | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback

rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_radio_started

rotorStationFeedbackSkip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_skip

rotorStationFeedbackTrackFinished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_track_finished

rotorStationFeedbackTrackStarted(station: str, track_id: str | int, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_track_started

rotorStationInfo(station: str, *args, **kwargs) → List[StationResult]#: Псевдоним для rotor_station_info

rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **kwargs) → bool#: Псевдоним для rotor_station_settings2

rotorStationTracks(station: str, settings2: bool = True, queue: str | int = None, *args, **kwargs) → StationTracksResult | None#: Псевдоним для rotor_station_tracks

rotorStationsDashboard(*args, **kwargs) → Dashboard | None#: Псевдоним для rotor_stations_dashboard

rotorStationsList(language: str | None = None, *args, **kwargs) → List[StationResult]#: Псевдоним для rotor_stations_list

rotor_account_status(*args, **kwargs) → Status | None#

Получение статуса пользователя с дополнительными полями.

Note

Данный статус отличается от обычного наличием дополнительных полей, например, skips_per_hour.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Статус пользователя с дополнительными полями от радио или: None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_feedback(station: str, type_: str, timestamp: str | float | int = None, from_: str = None, batch_id: str = None, total_played_seconds: int | float = None, track_id: str | int = None, **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) – Уникальной идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

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: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'radioStarted', timestamp, from, batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_feedback_skip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'skip', timestamp, track_id=track_id,
total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_feedback_track_finished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'trackFinished', timestamp,
track_id=track_id, total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_feedback_track_started(station: str, track_id: str | int, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'trackStarted', timestamp, track_id=track_id,
batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_info(station: str, *args, **kwargs) → List[StationResult]#

Получение информации о станции и пользовательских настроек на неё.

Parameters:

station (str) – Станция.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

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', **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) – Тип.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_station_tracks(station: str, settings2: bool = True, queue: str | int = None, *args, **kwargs) → StationTracksResult | None#

Получение цепочки треков определённой станции.

Note

Запуск потока по сущности сервиса осуществляется через станцию <type>:<id>. Например, станцией для запуска потока по треку будет track:1234.

Для продолжения цепочки треков необходимо:

Передавать ID трека, что был до этого (первый в цепочки).
Отправить фидбек о конце или скипе трека, что был передан в queue.
Отправить фидбек о начале следующего трека (второй в цепочки).
Выполнить запрос получения треков. В ответе придёт новые треки или произойдёт сдвиг цепочки на 1 элемент.

Проход по цепочке до конца не изучен. Часто встречаются дубликаты.

Все официальные клиенты выполняют запросы с settings2 = True.

Parameters:

station (str) – Станция.
settings2 (bool, optional) – Использовать ли второй набор настроек.
queue (str | int, optional) – Уникальной идентификатор трека, который только что был.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Последовательность треков станции или None.

Return type:

yandex_music.StationTracksResult | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_stations_dashboard(*args, **kwargs) → Dashboard | None#

Получение рекомендованных станций текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендованные станции или None.

Return type:

yandex_music.Dashboard | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

rotor_stations_list(language: str | None = None, *args, **kwargs) → List[StationResult]#

Получение всех радиостанций с настройками пользователя.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Чтобы определить что за тип станции (жанры, настроения, занятие и т.д.) необходимо смотреть в поле id_for_from.

Parameters:

language (str, optional) – Язык, на котором будет информация о станциях. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список станций.

Return type:

list из yandex_music.StationResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

search(text: str, nocorrect: bool = False, type_: str = 'all', page: int = 0, playlist_in_best: bool = True, *args, **kwargs) → Search | None#

Осуществление поиска по запросу и типу, получение результатов.

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) – Выдавать ли плейлисты лучшим вариантом поиска.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Результаты поиска или None.

Return type:

yandex_music.Search | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

searchSuggest(part: str, *args, **kwargs) → Suggestions | None#: Псевдоним для search_suggest

search_suggest(part: str, *args, **kwargs) → Suggestions | None#

Получение подсказок по введенной части поискового запроса.

Parameters:

part (str) – Часть поискового запроса.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Подсказки для запроса или None.

Return type:

yandex_music.Suggestions | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

settings(*args, **kwargs) → Settings | None#

Получение предложений по покупке. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информацию о предлагаемых продуктах если аккаунт валиден: или None.

Return type:

yandex_music.Settings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tags(tag_id: str, *args, **kwargs) → TagResult | None#

Получение тега (подборки).

Note

Теги есть в MixLink у Landing, а также плейлистов в .tags.

У MixLink есть URL, но tag_id только его последняя часть. Например, /tag/belarus/. Tag - belarus.

Parameters:

tag_id (str) – Уникальный идентификатор тега.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Тег с плейлистами.

Return type:

yandex_music.TagResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

trackSupplement(track_id: str | int, *args, **kwargs) → Supplement | None#: Псевдоним для track_supplement

track_supplement(track_id: str | int, *args, **kwargs) → Supplement | None#

Получение дополнительной информации о треке.

Warning

Получение текста из дополнительной информации устарело. Используйте yandex_music.Client.tracks_lyrics().

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Дополнительная информация о треке.

Return type:

yandex_music.Supplement

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracks(track_ids: List[str | int] | int | str, with_positions: bool = True, *args, **kwargs) → List[Track]#

Получение трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
with_positions (bool, optional) – С позициями TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Трек или Треки.

Return type:

list из yandex_music.Track

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracksDownloadInfo(track_id: str | int, get_direct_links: bool = False, *args, **kwargs) → List[DownloadInfo]#: Псевдоним для tracks_download_info

tracksLyrics(track_id: str | int, format: str = 'TEXT', **kwargs) → TrackLyrics | None#: Псевдоним для tracks_lyrics

tracksSimilar(track_id: str | int, *args, **kwargs) → SimilarTracks | None#: Псевдоним для tracks_similar

tracks_download_info(track_id: str | int, get_direct_links: bool = False, *args, **kwargs) → List[DownloadInfo]#

Получение информации о доступных вариантах загрузки трека.

Parameters:

track_id (str | list из str) – Уникальный идентификатор трека или треков.
get_direct_links (bool, optional) – Получить ли при вызове метода прямую ссылку на загрузку.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Варианты загрузки трека или None.

Return type:

list из yandex_music.DownloadInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracks_lyrics(track_id: str | int, format: str = 'TEXT', **kwargs) → TrackLyrics | None#

Получение текста трека.

Note

Для работы с методом необходима авторизация.

Известные значения для аргумента format:

LRC - формат с временными метками.
TEXT - простой текст.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
format (str) – Формат текста.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация о тексте трека.

Return type:

yandex_music.TrackLyrics | None

Raises:

yandex_music.exceptions.UnauthorizedError – Метод вызван без авторизации.
yandex_music.exceptions.NotFoundError – Текст у трека отсутствует.
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

tracks_similar(track_id: str | int, *args, **kwargs) → SimilarTracks | None#

Получение похожих треков.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Похожие треки на другой трек.

Return type:

yandex_music.SimilarTracks

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

usersDislikesTracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#: Псевдоним для users_dislikes_tracks

usersDislikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_dislikes_tracks_add

usersDislikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_dislikes_tracks_remove

usersLikesAlbums(user_id: str | int = None, rich: bool = True, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_albums

usersLikesAlbumsAdd(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_albums_add

usersLikesAlbumsRemove(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_albums_remove

usersLikesArtists(user_id: str | int = None, with_timestamps: bool = True, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_artists

usersLikesArtistsAdd(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_artists_add

usersLikesArtistsRemove(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_artists_remove

usersLikesPlaylists(user_id: str | int = None, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_playlists

usersLikesPlaylistsAdd(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_playlists_add

usersLikesPlaylistsRemove(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_playlists_remove

usersLikesTracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#: Псевдоним для users_likes_tracks

usersLikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_tracks_add

usersLikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_tracks_remove

usersPlaylists(kind: List[str | int] | str | int, user_id: str | int = None, *args, **kwargs) → Playlist | List[Playlist]#: Псевдоним для users_playlists

usersPlaylistsChange(kind: str | int, diff: str, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_change

usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_create

usersPlaylistsDelete(kind: str | int, user_id: str | int = None, *args, **kwargs) → bool#: Псевдоним для users_playlists_delete

usersPlaylistsDeleteTrack(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_delete_track

usersPlaylistsInsertTrack(kind: str | int, track_id: str | int, album_id: str | int, at: int = 0, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_insert_track

usersPlaylistsList(user_id: str | int = None, *args, **kwargs) → List[Playlist]#: Псевдоним для users_playlists_list

usersPlaylistsName(kind: str | int, name: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_name

usersPlaylistsRecommendations(kind: str | int, user_id: str | int = None, *args, **kwargs) → PlaylistRecommendations | None#: Псевдоним для users_playlists_recommendations

usersPlaylistsVisibility(kind: str | int, visibility: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_visibility

usersSettings(user_id: str | int = None, *args, **kwargs) → UserSettings | None#: Псевдоним для users_settings

users_dislikes_tracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#

Получение треков с отметкой “Не рекомендовать”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (bool, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Не рекомендовать”.

Return type:

list из yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_dislikes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Не рекомендовать” треку/трекам.

Note

Так же снимает отметку “Мне нравится” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_dislikes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Не рекомендовать” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums(user_id: str | int = None, rich: bool = True, *args, **kwargs) → List[Like]#

Получение альбомов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
rich (bool, optional) – Если False, то приходит укороченная версия.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбомы с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums_add(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” альбому/альбомам.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_albums_remove(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists(user_id: str | int = None, with_timestamps: bool = True, *args, **kwargs) → List[Like]#

Получение артистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
with_timestamps (bool, optional) – С временными метками TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Артисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists_add(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” исполнителю/исполнителям.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_artists_remove(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists(user_id: str | int = None, *args, **kwargs) → List[Like]#

Получение плейлистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists_add(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” плейлисту/плейлистам.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_playlists_remove(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у плейлиста/плейлистов.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#

Получение треков с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (int, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Мне нравится”.

Return type:

yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” треку/трекам.

Note

Так же снимает отметку “Не рекомендовать” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_likes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Получение плейлиста или списка плейлистов по уникальным идентификаторам.

Note

Если передан один kind, то вернётся не список плейлистов, а один плейлист.

Parameters:

kind (str | int | list из str | int) – Уникальный идентификатор плейлиста или их список.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список плейлистов или плейлист, иначе None.

Return type:

list из yandex_music.Playlist | yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_change(kind: str | int, diff: str, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение плейлиста.

Note

Для получения отличий есть вспомогательный класс yandex_music.utils.difference.Difference.

Так же существуют уже готовые методы-обёртки над операциями.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
revision (int) – TODO.
diff (str) – JSON представления отличий старого и нового плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_create(title: str, visibility: str = 'public', user_id: str | int = None, *args, **kwargs) → Playlist | None#

Создание плейлиста.

Parameters:

title (str) – Название.
visibility (str, optional) – Модификатор доступа.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Созданный плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_delete(kind: str | int, user_id: str | int = None, *args, **kwargs) → bool#

Удаление плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_delete_track(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Удаление треков из плейлиста.

Note

Для удаление необходимо указать границы с какого по какой элемент (трек) удалить.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
from (int) – С какого индекса.
to (int) – По какой индекс.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Добавление трека в плейлист.

Note

Трек можно вставить с любое место плейлиста задав индекс вставки (аргумент at).

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
track_id (str | int) – Уникальный идентификатор трека.
album_id (str | int) – Уникальный идентификатор альбома.
at (int) – Индекс для вставки.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_list(user_id: str | int = None, *args, **kwargs) → List[Playlist]#

Получение списка плейлистов пользователя.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты пользователя.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_name(kind: str | int, name: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение названия плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
name (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_recommendations(kind: str | int, user_id: str | int = None, *args, **kwargs) → PlaylistRecommendations | None#

Получение рекомендаций для плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендации для плейлиста или None.

Return type:

yandex_music.PlaylistRecommendations | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_playlists_visibility(kind: str | int, visibility: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение видимости плейлиста.

Note

Видимость (visibility) может быть задана только одним из двух значений: private, public.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
visibility (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

users_settings(user_id: str | int = None, *args, **kwargs) → UserSettings | None#

Получение настроек пользователя.

Note

Для получения настроек пользователя нужно быть авторизованным или владеть user_id.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя чьи настройки хотим получить.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

class yandex_music.ClientAsync(token: str = None, base_url: str = None, request: Request = None, language: str = 'ru', report_unknown_fields: bool = 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, которых нет в библиотеке.

async accountExperiments(*args, **kwargs) → Experiments | None#: Псевдоним для account_experiments

async accountSettings(*args, **kwargs) → UserSettings | None#: Псевдоним для account_settings

async accountSettingsSet(param: str = None, value: str | int | bool = None, data: Dict[str, str | int | bool] = None, *args, **kwargs) → UserSettings | None#: Псевдоним для account_settings_set

async accountStatus(*args, **kwargs) → Status | None#: Псевдоним для account_status

async account_experiments(*args, **kwargs) → Experiments | None#

Получение значений экспериментальных функций аккаунта.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Состояние экспериментальных функций или None.

Return type:

yandex_music.Experiments | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async account_settings(*args, **kwargs) → UserSettings | None#

Получение настроек текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя если аккаунт валиден,: иначе None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Изменение настроек текущего пользователя.

Note

Доступные названия параметров есть поля в классе yandex_music.UserSettings, только в CamelCase.

Parameters:

param (str) – Название параметра для изменения.
value (str | int | bool) – Значение параметра.
data (dict) – Словарь параметров и значений для множественного изменения.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async account_status(*args, **kwargs) → Status | None#

Получение статуса аккаунта. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об аккаунте если он валиден, иначе None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async afterTrack(next_track_id: str | int, context_item: str, prev_track_id: str | int = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args, **kwargs) → ShotEvent | None#: Псевдоним для after_track

async after_track(next_track_id: str | int, context_item: str, prev_track_id: str | int = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args, **kwargs) → ShotEvent | None#

Получение рекламы или шота от Алисы после трека.

Note

При получения шота от Алисы prev_track_id можно не указывать.

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) – Место, с которого попали в контекст.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Шот от Алисы или None.

Return type:

yandex_music.ShotEvent

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async albums(album_ids: List[str | int] | int | str, *args, **kwargs) → List[Album]#

Получение альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор альбома или альбомов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или альбомы.

Return type:

list из yandex_music.Album

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async albumsWithTracks(album_id: str | int, *args, **kwargs) → Album | None#: Псевдоним для albums_with_tracks

async albums_with_tracks(album_id: str | int, *args, **kwargs) → Album | None#

Получение альбома по его уникальному идентификатору вместе с треками.

Parameters:

album_id (str | int) – Уникальный идентификатор альбома.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбом или None.

Return type:

list из yandex_music.Album | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async artists(artist_ids: List[str | int] | int | str, *args, **kwargs) → List[Artist]#

Получение исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор исполнителя или исполнителей.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Исполнитель или исполнители.

Return type:

list из yandex_music.Artist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async artistsBriefInfo(artist_id: str | int, *args, **kwargs) → BriefInfo | None#: Псевдоним для artists_brief_info

async artistsDirectAlbums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args, **kwargs) → ArtistAlbums | None#: Псевдоним для artists_direct_albums

async artistsTracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args, **kwargs) → ArtistTracks | None#: Псевдоним для artists_tracks

async artists_brief_info(artist_id: str | int, *args, **kwargs) → BriefInfo | None#

Получение информации об артисте.

Parameters:

artist_id (str | int) – Уникальный идентификатор исполнителя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об артисте или None.

Return type:

yandex_music.BriefInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async artists_direct_albums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args, **kwargs) → ArtistAlbums | None#

Получение альбомов артиста.

Note

Известные значения для sort_by: year, rating.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество альбомов на странице.
sort_by (str, optional) – Параметр для сортировки.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка альбомов артиста или None.

Return type:

yandex_music.ArtistAlbums | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async artists_tracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args, **kwargs) → ArtistTracks | None#

Получение треков артиста.

Parameters:

artist_id (str | int) – Уникальный идентификатор артиста.
page (int, optional) – Номер страницы.
page_size (int, optional) – Количество треков на странице.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница списка треков артиста или None.

Return type:

yandex_music.ArtistsTracks | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async chart(chart_option: str = '', *args, **kwargs) → ChartInfo | None#

Получение чарта.

Note

Parameters:

chart_option (str optional) – Параметры чарта.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Чарт.

Return type:

yandex_music.ChartInfo

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async consumePromoCode(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None#: Псевдоним для consume_promo_code

async consume_promo_code(code: str, language: str | None = None, *args, **kwargs) → PromoCodeStatus | None#

Активация промо-кода.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Parameters:

code (str) – Промо-код.
language (str, optional) – Язык ответа API в ISO 639-1. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация об активации промо-кода или None.

Return type:

yandex_music.PromoCodeStatus | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async feed(*args, **kwargs) → Feed | None#

Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Умные плейлисты пользователя или None.

Return type:

yandex_music.Feed | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async feedWizardIsPassed(*args, **kwargs) → bool#: Псевдоним для feed_wizard_is_passed

async feed_wizard_is_passed(*args, **kwargs) → bool#

Получение информации о прохождении визарда.

Note

Временное событие на хэллоуин.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Прошел ли пользователь визард или нет.

Return type:

bool

async genres(*args, **kwargs) → List[Genre]#

Получение жанров музыки.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Жанры музыки или None.

Return type:

list из yandex_music.Genre | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async init() → ClientAsync#: Получение информацию об аккаунте использующихся в других запросах.

async landing(blocks: str | List[str], *args, **kwargs) → Landing | None#

Получение лендинг-страницы содержащий блоки с новыми релизами, чартами, плейлистами с новинками и т.д.

Note

Поддерживаемые типы блоков: personalplaylists, promotions, new-releases, new-playlists, mixes, chart, artists, albums, playlists, play_contexts.

Parameters:

blocks (str | list из str) – Блок или список блоков необходимых для выдачи.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Лендинг-страница или None.

Return type:

yandex_music.Landing | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async newPlaylists(*args, **kwargs) → LandingList | None#: Псевдоним для new_playlists

async newReleases(*args, **kwargs) → LandingList | None#: Псевдоним для new_releases

async new_playlists(*args, **kwargs) → LandingList | None#

Получение полного списка всех новых плейлистов.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых плейлистов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async new_releases(*args, **kwargs) → LandingList | None#

Получение полного списка всех новых релизов (альбомов).

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список новых альбомов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async permissionAlerts(*args, **kwargs) → PermissionAlerts | None#: Псевдоним для permission_alerts

async permission_alerts(*args, **kwargs) → PermissionAlerts | None#

Получение оповещений. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Оповещения если аккаунт валиден или None.

Return type:

yandex_music.PermissionAlerts | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async playAudio(track_id: str | int, from_: str, album_id: 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, *args, **kwargs) → bool#: Псевдоним для play_audio

async play_audio(track_id: str | int, from_: str, album_id: 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, *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.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async playlistsCollectiveJoin(user_id: int, token: str, **kwargs) → bool#: Псевдоним для playlists_collective_join

async playlistsList(playlist_ids: List[str | int] | int | str, *args, **kwargs) → List[Playlist]#: Псевдоним для playlists_list

async playlists_collective_join(user_id: int, token: str, **kwargs) → bool#

Присоединение к плейлисту как соавтор.

Note

В качестве user_id принимается исключительно числовой уникальный идентификатор пользователя, не username.

Parameters:

user_id (int) – Владелец плейлиста.
token (str) – Токен для присоединения.
**kwargs – Произвольные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async playlists_list(playlist_ids: List[str | int] | int | str, *args, **kwargs) → List[Playlist]#

Получение плейлиста/плейлистов.

Note

Данный метод возвращает сокращенную модель плейлиста для отображения больших список.

Warning

Данный метод не возвращает список треков у плейлиста! Для получения объекта yandex_music.Playlist c заполненным полем tracks используйте метод yandex_music.ClientAsync.users_playlists() или метод yandex_music.Playlist.fetch_tracks().

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлист или плейлисты.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async podcasts(*args, **kwargs) → LandingList | None#

Получение подкастов с лендинга.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список подкастов.

Return type:

yandex_music.LandingList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async queue(queue_id: str, *args, **kwargs) → Queue | None#

Получение информации об очереди треков и самих треков в ней.

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Очередь или None.

Return type:

yandex_music.Queue

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async queueCreate(queue: Queue | str, device: str = None, *args, **kwargs) → str | None#: Псевдоним для queue_create

async queueUpdatePosition(queue_id: str, current_index: int, device: str = None, **kwargs) → bool#: Псевдоним для queue_update_position

async queue_create(queue: Queue | str, device: str = None, *args, **kwargs) → str | None#

Создание новой очереди треков.

Parameters:

queue (yandex_music.Queue | str) – Объект очереди или JSON строка с этим объектом.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Вернёт уникальный идентификатор созданной очереди, иначе None.

Return type:

str

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async queue_update_position(queue_id: str, current_index: int, device: str = None, **kwargs) → bool#

Установка текущего индекса проигрываемого трека в очереди треков.

Note

Изменить можно только у той очереди, которая была создана с переданного device!

Parameters:

queue_id (str) – Уникальный идентификатор очереди.
current_index (int) – Текущий индекс.
device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async queuesList(device: str = None, *args, **kwargs) → List[QueueItem]#: Псевдоним для queues_list

async queues_list(device: str = None, *args, **kwargs) → List[QueueItem]#

Получение всех очередей треков с разных устройств для синхронизации между ними.

Note

Именно к device привязывается очередь. На одном устройстве может быть создана одна очередь.

Parameters:

device (str, optional) – Содержит информацию об устройстве с которого выполняется запрос.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Элементы очереди всех устройств.

Return type:

list из yandex_music.QueueItem

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

property request: Request#

Объект вспомогательного класса для отправки запросов.

Type:: yandex_music.utils.request.Request

async rotorAccountStatus(*args, **kwargs) → Status | None#: Псевдоним для rotor_account_status

async rotorStationFeedback(station: str, type_: str, timestamp: str | float | int = None, from_: str = None, batch_id: str = None, total_played_seconds: int | float = None, track_id: str | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback

async rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_radio_started

async rotorStationFeedbackSkip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_skip

async rotorStationFeedbackTrackFinished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_track_finished

async rotorStationFeedbackTrackStarted(station: str, track_id: str | int, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#: Псевдоним для rotor_station_feedback_track_started

async rotorStationInfo(station: str, *args, **kwargs) → List[StationResult]#: Псевдоним для rotor_station_info

async rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **kwargs) → bool#: Псевдоним для rotor_station_settings2

async rotorStationTracks(station: str, settings2: bool = True, queue: str | int = None, *args, **kwargs) → StationTracksResult | None#: Псевдоним для rotor_station_tracks

async rotorStationsDashboard(*args, **kwargs) → Dashboard | None#: Псевдоним для rotor_stations_dashboard

async rotorStationsList(language: str | None = None, *args, **kwargs) → List[StationResult]#: Псевдоним для rotor_stations_list

async rotor_account_status(*args, **kwargs) → Status | None#

Получение статуса пользователя с дополнительными полями.

Note

Данный статус отличается от обычного наличием дополнительных полей, например, skips_per_hour.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Статус пользователя с дополнительными полями от радио или: None.

Return type:

yandex_music.Status | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_feedback(station: str, type_: str, timestamp: str | float | int = None, from_: str = None, batch_id: str = None, total_played_seconds: int | float = None, track_id: str | int = None, **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) – Уникальной идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_feedback_radio_started(station: str, from_: str, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'radioStarted', timestamp, from, batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_feedback_skip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'skip', timestamp, track_id=track_id,
total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_feedback_track_finished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'trackFinished', timestamp,
track_id=track_id, total_played_seconds=total_played_seconds, batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_feedback_track_started(station: str, track_id: str | int, batch_id: str = None, timestamp: str | float | int = None, **kwargs) → bool#

Сокращение для:

client.rotor_station_feedback(station, 'trackStarted', timestamp, track_id=track_id,
batch_id=batch_id, **kwargs)

Returns:: True при успешном выполнении запроса, иначе False.
Return type:: bool
Raises:: yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_info(station: str, *args, **kwargs) → List[StationResult]#

Получение информации о станции и пользовательских настроек на неё.

Parameters:

station (str) – Станция.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация о станции или None.

Return type:

list из yandex_music.StationResult | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_settings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **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) – Тип.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_station_tracks(station: str, settings2: bool = True, queue: str | int = None, *args, **kwargs) → StationTracksResult | None#

Получение цепочки треков определённой станции.

Note

Для продолжения цепочки треков необходимо:

Передавать ID трека, что был до этого (первый в цепочки).
Отправить фидбек о конце или скипе трека, что был передан в queue.
Отправить фидбек о начале следующего трека (второй в цепочки).
Выполнить запрос получения треков. В ответе придёт новые треки или произойдёт сдвиг цепочки на 1 элемент.

Проход по цепочке до конца не изучен. Часто встречаются дубликаты.

Все официальные клиенты выполняют запросы с settings2 = True.

Parameters:

station (str) – Станция.
settings2 (bool, optional) – Использовать ли второй набор настроек.
queue (str | int, optional) – Уникальной идентификатор трека, который только что был.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Последовательность треков станции или None.

Return type:

yandex_music.StationTracksResult | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_stations_dashboard(*args, **kwargs) → Dashboard | None#

Получение рекомендованных станций текущего пользователя.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендованные станции или None.

Return type:

yandex_music.Dashboard | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async rotor_stations_list(language: str | None = None, *args, **kwargs) → List[StationResult]#

Получение всех радиостанций с настройками пользователя.

Note

Доступные языки: en, uz, uk, us, ru, kk, hy.

Чтобы определить что за тип станции (жанры, настроения, занятие и т.д.) необходимо смотреть в поле id_for_from.

Parameters:

language (str, optional) – Язык, на котором будет информация о станциях. По умолчанию язык клиента.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список станций.

Return type:

list из yandex_music.StationResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async search(text: str, nocorrect: bool = False, type_: str = 'all', page: int = 0, playlist_in_best: bool = True, *args, **kwargs) → Search | None#

Осуществление поиска по запросу и типу, получение результатов.

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) – Выдавать ли плейлисты лучшим вариантом поиска.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Результаты поиска или None.

Return type:

yandex_music.Search | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async searchSuggest(part: str, *args, **kwargs) → Suggestions | None#: Псевдоним для search_suggest

async search_suggest(part: str, *args, **kwargs) → Suggestions | None#

Получение подсказок по введенной части поискового запроса.

Parameters:

part (str) – Часть поискового запроса.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Подсказки для запроса или None.

Return type:

yandex_music.Suggestions | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async settings(*args, **kwargs) → Settings | None#

Получение предложений по покупке. Нет обязательных параметров.

Parameters:

*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информацию о предлагаемых продуктах если аккаунт валиден: или None.

Return type:

yandex_music.Settings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async tags(tag_id: str, *args, **kwargs) → TagResult | None#

Получение тега (подборки).

Note

Теги есть в MixLink у Landing, а также плейлистов в .tags.

У MixLink есть URL, но tag_id только его последняя часть. Например, /tag/belarus/. Tag - belarus.

Parameters:

tag_id (str) – Уникальный идентификатор тега.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Тег с плейлистами.

Return type:

yandex_music.TagResult

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async trackSupplement(track_id: str | int, *args, **kwargs) → Supplement | None#: Псевдоним для track_supplement

async track_supplement(track_id: str | int, *args, **kwargs) → Supplement | None#

Получение дополнительной информации о треке.

Warning

Получение текста из дополнительной информации устарело. Используйте yandex_music.ClientAsync.tracks_lyrics().

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Дополнительная информация о треке.

Return type:

yandex_music.Supplement

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async tracks(track_ids: List[str | int] | int | str, with_positions: bool = True, *args, **kwargs) → List[Track]#

Получение трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
with_positions (bool, optional) – С позициями TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Трек или Треки.

Return type:

list из yandex_music.Track

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async tracksDownloadInfo(track_id: str | int, get_direct_links: bool = False, *args, **kwargs) → List[DownloadInfo]#: Псевдоним для tracks_download_info

async tracksLyrics(track_id: str | int, format: str = 'TEXT', **kwargs) → TrackLyrics | None#: Псевдоним для tracks_lyrics

async tracksSimilar(track_id: str | int, *args, **kwargs) → SimilarTracks | None#: Псевдоним для tracks_similar

async tracks_download_info(track_id: str | int, get_direct_links: bool = False, *args, **kwargs) → List[DownloadInfo]#

Получение информации о доступных вариантах загрузки трека.

Parameters:

track_id (str | list из str) – Уникальный идентификатор трека или треков.
get_direct_links (bool, optional) – Получить ли при вызове метода прямую ссылку на загрузку.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Варианты загрузки трека или None.

Return type:

list из yandex_music.DownloadInfo | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async tracks_lyrics(track_id: str | int, format: str = 'TEXT', **kwargs) → TrackLyrics | None#

Получение текста трека.

Note

Для работы с методом необходима авторизация.

Известные значения для аргумента format:

LRC - формат с временными метками.
TEXT - простой текст.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
format (str) – Формат текста.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Информация о тексте трека.

Return type:

yandex_music.TrackLyrics | None

Raises:

yandex_music.exceptions.UnauthorizedError – Метод вызван без авторизации.
yandex_music.exceptions.NotFoundError – Текст у трека отсутствует.
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async tracks_similar(track_id: str | int, *args, **kwargs) → SimilarTracks | None#

Получение похожих треков.

Parameters:

track_id (str | int) – Уникальный идентификатор трека.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Похожие треки на другой трек.

Return type:

yandex_music.SimilarTracks

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async usersDislikesTracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#: Псевдоним для users_dislikes_tracks

async usersDislikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_dislikes_tracks_add

async usersDislikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_dislikes_tracks_remove

async usersLikesAlbums(user_id: str | int = None, rich: bool = True, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_albums

async usersLikesAlbumsAdd(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_albums_add

async usersLikesAlbumsRemove(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_albums_remove

async usersLikesArtists(user_id: str | int = None, with_timestamps: bool = True, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_artists

async usersLikesArtistsAdd(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_artists_add

async usersLikesArtistsRemove(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_artists_remove

async usersLikesPlaylists(user_id: str | int = None, *args, **kwargs) → List[Like]#: Псевдоним для users_likes_playlists

async usersLikesPlaylistsAdd(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_playlists_add

async usersLikesPlaylistsRemove(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_playlists_remove

async usersLikesTracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#: Псевдоним для users_likes_tracks

async usersLikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_tracks_add

async usersLikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#: Псевдоним для users_likes_tracks_remove

async usersPlaylists(kind: List[str | int] | str | int, user_id: str | int = None, *args, **kwargs) → Playlist | List[Playlist]#: Псевдоним для users_playlists

async usersPlaylistsChange(kind: str | int, diff: str, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_change

async usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_create

async usersPlaylistsDelete(kind: str | int, user_id: str | int = None, *args, **kwargs) → bool#: Псевдоним для users_playlists_delete

async usersPlaylistsDeleteTrack(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_delete_track

async usersPlaylistsInsertTrack(kind: str | int, track_id: str | int, album_id: str | int, at: int = 0, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_insert_track

async usersPlaylistsList(user_id: str | int = None, *args, **kwargs) → List[Playlist]#: Псевдоним для users_playlists_list

async usersPlaylistsName(kind: str | int, name: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_name

async usersPlaylistsRecommendations(kind: str | int, user_id: str | int = None, *args, **kwargs) → PlaylistRecommendations | None#: Псевдоним для users_playlists_recommendations

async usersPlaylistsVisibility(kind: str | int, visibility: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#: Псевдоним для users_playlists_visibility

async usersSettings(user_id: str | int = None, *args, **kwargs) → UserSettings | None#: Псевдоним для users_settings

async users_dislikes_tracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#

Получение треков с отметкой “Не рекомендовать”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (bool, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Не рекомендовать”.

Return type:

list из yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_dislikes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Не рекомендовать” треку/трекам.

Note

Так же снимает отметку “Мне нравится” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_dislikes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Не рекомендовать” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_albums(user_id: str | int = None, rich: bool = True, *args, **kwargs) → List[Like]#

Получение альбомов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
rich (bool, optional) – Если False, то приходит укороченная версия.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Альбомы с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_albums_add(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” альбому/альбомам.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_albums_remove(album_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у альбома/альбомов.

Parameters:

album_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_artists(user_id: str | int = None, with_timestamps: bool = True, *args, **kwargs) → List[Like]#

Получение артистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
with_timestamps (bool, optional) – С временными метками TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Артисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_artists_add(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” исполнителю/исполнителям.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_artists_remove(artist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у исполнителя/исполнителей.

Parameters:

artist_ids (str | int | list из str | list из int) – Уникальный идентификатор артиста или артистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_playlists(user_id: str | int = None, *args, **kwargs) → List[Like]#

Получение плейлистов с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты с отметкой “Мне нравится”.

Return type:

list из yandex_music.Like

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_playlists_add(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” плейлисту/плейлистам.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_playlists_remove(playlist_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у плейлиста/плейлистов.

Note

Parameters:

playlist_ids (str | int | list из str | list из int) – Уникальный идентификатор плейлиста или плейлистов.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_tracks(user_id: str | int = None, if_modified_since_revision: int = 0, *args, **kwargs) → TracksList | None#

Получение треков с отметкой “Мне нравится”.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
if_modified_since_revision (int, optional) – TODO.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Треки с отметкой “Мне нравится”.

Return type:

yandex_music.TracksList

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Поставить отметку “Мне нравится” треку/трекам.

Note

Так же снимает отметку “Не рекомендовать” если она есть.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_likes_tracks_remove(track_ids: List[str | int] | str | int, user_id: str | int = None, **kwargs) → bool#

Снять отметку “Мне нравится” у трека/треков.

Parameters:

track_ids (str | int | list из str | list из int) – Уникальный идентификатор трека или треков.
user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Получение плейлиста или списка плейлистов по уникальным идентификаторам.

Note

Если передан один kind, то вернётся не список плейлистов, а один плейлист.

Parameters:

kind (str | int | list из str | int) – Уникальный идентификатор плейлиста или их список.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Список плейлистов или плейлист, иначе None.

Return type:

list из yandex_music.Playlist | yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_change(kind: str | int, diff: str, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение плейлиста.

Note

Для получения отличий есть вспомогательный класс yandex_music.utils.difference.Difference.

Так же существуют уже готовые методы-обёртки над операциями.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
revision (int) – TODO.
diff (str) – JSON представления отличий старого и нового плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_create(title: str, visibility: str = 'public', user_id: str | int = None, *args, **kwargs) → Playlist | None#

Создание плейлиста.

Parameters:

title (str) – Название.
visibility (str, optional) – Модификатор доступа.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Созданный плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_delete(kind: str | int, user_id: str | int = None, *args, **kwargs) → bool#

Удаление плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

True при успешном выполнении запроса, иначе False.

Return type:

bool

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_delete_track(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Удаление треков из плейлиста.

Note

Для удаление необходимо указать границы с какого по какой элемент (трек) удалить.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
from (int) – С какого индекса.
to (int) – По какой индекс.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

Добавление трека в плейлист.

Note

Трек можно вставить с любое место плейлиста задав индекс вставки (аргумент at).

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
track_id (str | int) – Уникальный идентификатор трека.
album_id (str | int) – Уникальный идентификатор альбома.
at (int) – Индекс для вставки.
revision (int) – TODO.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_list(user_id: str | int = None, *args, **kwargs) → List[Playlist]#

Получение списка плейлистов пользователя.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Плейлисты пользователя.

Return type:

list из yandex_music.Playlist

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_name(kind: str | int, name: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение названия плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
name (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_recommendations(kind: str | int, user_id: str | int = None, *args, **kwargs) → PlaylistRecommendations | None#

Получение рекомендаций для плейлиста.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
user_id (str | int) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Рекомендации для плейлиста или None.

Return type:

yandex_music.PlaylistRecommendations | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_playlists_visibility(kind: str | int, visibility: str, user_id: str | int = None, *args, **kwargs) → Playlist | None#

Изменение видимости плейлиста.

Note

Видимость (visibility) может быть задана только одним из двух значений: private, public.

Parameters:

kind (str | int) – Уникальный идентификатор плейлиста.
visibility (str) – Новое название.
user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Изменённый плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

async users_settings(user_id: str | int = None, *args, **kwargs) → UserSettings | None#

Получение настроек пользователя.

Note

Для получения настроек пользователя нужно быть авторизованным или владеть user_id.

Parameters:

user_id (str | int, optional) – Уникальный идентификатор пользователя чьи настройки хотим получить.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Настройки пользователя или None.

Return type:

yandex_music.UserSettings | None

Raises:

yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.

class yandex_music.Contest(contest_id: str, status: str, can_edit: bool, sent: str | None = None, withdrawn: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий контест TODO.

Note

Известные значения поля status: editing, withdrew-moderator.

contest_id#

Уникальный идентификатор.

Type:: str

status#

Статус.

Type:: str

can_edit#

Разрешено ли редактирование.

Type:: bool

sent#

Дата отправки.

Type:: str, optional

withdrawn#

Дата вывода (окончания).

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

can_edit: bool#

client: Client | None = None#

contest_id: str#

classmethod de_json(data: dict, client: Client) → Contest | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Контест.

Return type:

yandex_music.Contest

sent: str | None = None#

status: str#

withdrawn: str | None = None#

class yandex_music.Context(type: str, id: str | None = None, description: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий содержимое очереди.

Note

Известные значения поля type: various, my_music, radio, playlist, artist.

Тип various используется при прослушивании из раздела “Моя музыка” с сайта, а my_music с мобильных клиентов.

Поле description зачастую есть только когда type имеет значение my_music или various.

При type равным my_music или various поле id отсутствует.

type#

Тип содержимого (по чём построена очередь).

Type:: str

id#

Уникальный идентификатор типа содержимого (плейлиста, альбома и т.д.).

Type:: str, optional

description#

Описание содержимого (например, название плейлиста, радиостанции).

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Context | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Содержимое очереди.

Return type:

yandex_music.Context

description: str | None = None#

id: str | None = None#

type: str#

class yandex_music.Counts(tracks: int, direct_albums: int, also_albums: int, also_tracks: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий счётчик некоторых значений исполнителя.

Note

Под дополнительными подразумеваются треки и альбомы, в которых артист задействован, но не является его автором. Так же в дополнительные альбомы входят сборники.

tracks#

Количество треков.

Type:: int

direct_albums#

Количество альбомов.

Type:: int

also_albums#

Количество дополнительных треков.

Type:: int

also_tracks#

Количество дополнительных альбомов.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

also_albums: int#

also_tracks: int#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Counts | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Cчётчик некоторых значений исполнителя.

Return type:

yandex_music.Counts

direct_albums: int#

tracks: int#

Bases: YandexMusicObject

Класс, представляющий обложку.

type#

Тип обложки.

Type:: str, optional

uri#

Ссылка на изображение.

Type:: str, optional

items_uri#

Список ссылок на изображения.

Type:: list из str, optional

dir#

Директория хранения изображения на сервере.

Type:: str, optional

version#

Версия.

Type:: str, optional

is_custom#

Является ли обложка пользовательской.

Type:: bool, optional

custom#

Является ли обложка пользовательской.

Type:: bool, optional

prefix#

Уникальный идентификатор.

Type:: str, optional

copyright_name#

Название владельца авторским правом.

Type:: str, optional

copyright_cline#

Владелец прав на музыку (автор текста и т.д.), а не её записи.

Type:: str, optional

error#

Сообщение об ошибке.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

copyright_cline: str | None = None#

copyright_name: str | None = None#

custom: bool | None = None#

classmethod de_json(data: dict, client: Client) → Cover | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Обложка.

Return type:

yandex_music.Cover

classmethod de_list(data: list, client: Client) → List[Cover]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Обложки.

Return type:

list из yandex_music.Cover

dir: str | None = None#

download(filename: str, index: int = 0, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
index (int, optional) – Индекс элемента в списке ссылок на обложки если нет self.uri.
size (str, optional) – Размер изображения.

async downloadAsync(filename: str, index: int = 0, size: str = '200x200') → None#: Псевдоним для download_async

downloadBytes(index: int = 0, size: str = '200x200') → bytes#: Псевдоним для download_bytes

async downloadBytesAsync(index: int = 0, size: str = '200x200') → bytes#: Псевдоним для download_bytes_async

async download_async(filename: str, index: int = 0, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
index (int, optional) – Индекс элемента в списке ссылок на обложки если нет self.uri.
size (str, optional) – Размер изображения.

download_bytes(index: int = 0, size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:

index (int, optional) – Индекс элемента в списке ссылок на обложки если нет self.uri.
size (str, optional) – Размер изображения.

Returns:

Обложка в виде байтов.

Return type:

bytes

async download_bytes_async(index: int = 0, size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:

index (int, optional) – Индекс элемента в списке ссылок на обложки если нет self.uri.
size (str, optional) – Размер изображения.

Returns:

Обложка в виде байтов.

Return type:

bytes

error: str | None = None#

getUrl(index: int = 0, size: str = '200x200') → str#: Псевдоним для get_url

get_url(index: int = 0, size: str = '200x200') → str#

Возвращает URL обложки.

Parameters:

index (int, optional) – Индекс элемента в списке ссылок на обложки если нет self.uri.
size (str, optional) – Размер изображения.

Returns:

URL адрес.

Return type:

str

is_custom: bool | None = None#

items_uri: List[str] | None = None#

prefix: str | None = None#

type: str | None = None#

uri: str | None = None#

version: str | None = None#

class yandex_music.CustomWave(title: str, animation_url: str, position: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий дополнительное описание плейлиста.

Note

Известные значения position: default.

title#

Название плейлиста.

Type:: str

animation_url#

JSON анимация Lottie.

Type:: str

position#

Позиция TODO.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

animation_url: str#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → CustomWave | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Описание плейлиста.

Return type:

yandex_music.CustomWave

position: str#

title: str#

class yandex_music.Dashboard(dashboard_id: str, stations: List[StationResult], pumpkin: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий рекомендованные станций пользователя.

dashboard_id#

Уникальный идентификатор панели.

Type:: str

stations#

Станции со всеми возможными настройками и параметрами.

Type:: list из yandex_music.StationResult

pumpkin#

Хэллоуин.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

dashboard_id: str#

classmethod de_json(data: dict, client: Client) → Dashboard | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Рекомендованные станций пользователя.

Return type:

yandex_music.Dashboard

pumpkin: bool#

stations: List[StationResult]#

class yandex_music.Day(day: str, events: List[Event], tracks_to_play_with_ads: List[TrackWithAds], tracks_to_play: List[Track], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий день в фиде.

day#

Дата в формате YYYY-MM-DD.

Type:: str

events#

События TODO.

Type:: list из yandex_music.Event

tracks_to_play_with_ads#

Треки для проигрывания с рекламой.

Type:: list из yandex_music.TrackWithAds

tracks_to_play#

Треки для проигрывания.

Type:: list из yandex_music.Track

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

day: str#

classmethod de_json(data: dict, client: Client) → Day | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

День в фиде.

Return type:

yandex_music.Day

classmethod de_list(data: list, client: Client) → List[Day]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Дни в фиде.

Return type:

list из yandex_music.Day

events: List[Event]#

tracks_to_play: List[Track]#

tracks_to_play_with_ads: List[TrackWithAds]#

class yandex_music.Deactivation(method: str, instructions: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий способы деактивации мобильной услуги.

Note

Известные значения поля method: ussd.

method#

Метод отключения.

Type:: str

instructions#

Инструкция.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Deactivation | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Способ отключения услуги.

Return type:

yandex_music.Deactivation

classmethod de_list(data: list, client: Client) → List[Deactivation]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Способы отключения услуги.

Return type:

list из yandex_music.Deactivation

instructions: str | None = None#

method: str#

class yandex_music.Deprecation(target_album_id: int | None, status: str | None, done: bool | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий TODO.

target_album_id#

Идентификатор альбома TODO.

Type:: int

status#

Состояние TODO.

Type:: str

done#

Выполнен ли TODO.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Deprecation | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

TODO.

Return type:

yandex_music.Deprecation

done: bool | None#

status: str | None#

target_album_id: int | None#

class yandex_music.Description(text: str, uri: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий описание исполнителя из другого источника.

Note

Очень редкий объект, у минимального количества исполнителей. Обычно берётся информация из википедии.

text#

Описание исполнителя.

Type:: str

uri#

Ссылка на источник.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Description | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Описание исполнителя из другого источника.

Return type:

yandex_music.Description

text: str#

uri: str#

class yandex_music.DiscreteScale(type: str, name: str, min: Value | None, max: Value | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий дискретное значение.

Note

Известные значения поля type: discrete-scale.

type#

Тип.

Type:: str

name#

Название.

Type:: str

min#

Минимальное значение.

Type:: yandex_music.Value

max#

Максимальное значение.

Type:: yandex_music.Value

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → DiscreteScale | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Дискретное значение.

Return type:

yandex_music.DiscreteScale

max: Value | None#

min: Value | None#

name: str#

type: str#

class yandex_music.DownloadInfo(codec: str, bitrate_in_kbps: int, gain: bool, preview: bool, download_info_url: str, direct: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий информацию о вариантах загрузки трека.

codec#

Кодек аудиофайла.

Type:: str

bitrate_in_kbps#

Битрейт аудиофайла в кбит/с.

Type:: int

gain#

Усиление TODO.

Type:: bool

preview#

Предварительный просмотр TODO.

Type:: bool

download_info_url#

Ссылка на XML документ содержащий данные для загрузки трека.

Type:: str

direct#

Прямая ли ссылка.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

bitrate_in_kbps: int#

client: Client | None = None#

codec: str#

classmethod de_json(data: dict, client: Client) → DownloadInfo | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Варианты загрузки треков.

Return type:

yandex_music.DownloadInfo

classmethod de_list(data: list, client: Client, get_direct_links: bool = False) → List[DownloadInfo]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
get_direct_links (bool) – Получать ли сразу прямые ссылки на загрузку.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Варианты загрузки треков.

Return type:

list из yandex_music.DownloadInfo

async classmethod de_list_async(data: dict, client: Client, get_direct_links: bool = False) → List[DownloadInfo]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
get_direct_links (bool) – Получать ли сразу прямые ссылки на загрузку.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Варианты загрузки треков.

Return type:

list из yandex_music.DownloadInfo

direct: bool#

download(filename: str) → None#

Загрузка трека.

Parameters:: filename (str) – Путь и(или) название файла вместе с расширением.

async downloadAsync(filename: str) → None#: Псевдоним для download_async

downloadBytes() → bytes#: Псевдоним для download_bytes

async downloadBytesAsync() → bytes#: Псевдоним для download_bytes_async

async download_async(filename: str) → None#

Загрузка трека.

Parameters:: filename (str) – Путь и(или) название файла вместе с расширением.

download_bytes() → bytes#

Загрузка трека и возврат в виде байтов.

Returns:: Трек в виде байтов.
Return type:: bytes

async download_bytes_async() → bytes#

Загрузка трека и возврат в виде байтов.

Returns:: Трек в виде байтов.
Return type:: bytes

download_info_url: str#

gain: bool#

getDirectLink() → str#: Псевдоним для get_direct_link

async getDirectLinkAsync() → str#: Псевдоним для get_direct_link_async

get_direct_link() → str#

Получение прямой ссылки на загрузку из XML ответа.

Метод доступен только одну минуту с момента получения информации о загрузке, иначе 410 ошибка!

Returns:: Прямая ссылка на загрузку трека.
Return type:: str

async get_direct_link_async() → str#

Получение прямой ссылки на загрузку из XML ответа.

Метод доступен только одну минуту с момента получения информации о загрузке, иначе 410 ошибка!

Returns:: Прямая ссылка на загрузку трека.
Return type:: str

preview: bool#

class yandex_music.Enum(type: str, name: str, possible_values: List[Value], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий перечисления.

type#

Тип перечисления.

Type:: str

name#

Название перечисления.

Type:: str

possible_values#

Доступные значения.

Type:: list из yandex_music.Value

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

\*\*kwargs: Произвольные ключевые аргументы полученные от API.

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Enum | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Перечисление.

Return type:

yandex_music.Enum

name: str#

possible_values: List[Value]#

type: str#

class yandex_music.Event(id: str, type: str, type_for_from: str | None = None, title: str | None = None, tracks: List[Track] = None, artists: List[ArtistEvent] = None, albums: List[AlbumEvent] = None, message: str | None = None, device: str | None = None, tracks_count: int | None = None, genre: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий событие фида.

Note

Известные значения поля type: tracks, artists, albums, notification.

Поле message заполнено только когда type равен notification.

Примером значения поля type_for_from может служить recommended-similar-artists.

Наличие данных в tracks, albums, artists напрямую зависит от type.

id#

Уникальный идентификатор события.

Type:: str

type#

Тип события.

Type:: str

type_for_from#

Откуда пришло событие.

Type:: str, optional

title#

Заголовок.

Type:: str, optional

tracks#

Список треков.

Type:: list из yandex_music.Track, optional

artists#

Список артистов с похожими и популярными треками.

Type:: list из yandex_music.ArtistEvent, optional

albums#

Список альбомов с треками.

Type:: list из yandex_music.AlbumEvent, optional

message#

Сообщение уведомления.

Type:: str, optional

device#

Устройство, с которого пришло уведомление.

Type:: str, optional

tracks_count#

Количество треков (возможно, уже не используется).

Type:: int, optional

genre#

Жанр треков.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

albums: List[AlbumEvent] = None#

artists: List[ArtistEvent] = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Event | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Событие фида.

Return type:

yandex_music.Event

classmethod de_list(data: list, client: Client) → List[Event]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

События фида.

Return type:

list из yandex_music.Event

device: str | None = None#

genre: str | None = None#

id: str#

message: str | None = None#

title: str | None = None#

tracks: List[Track] = None#

tracks_count: int | None = None#

type: str#

type_for_from: str | None = None#

class yandex_music.Experiments(client: Client | None = None, **kwargs)#

Bases: YandexMusicObject

Класс, представляющий какие-то свистелки и перделки, флажки, режимы экспериментальных функций.

client#

Клиент Yandex Music.

Type:: yandex_music.Client

название_эксперимента#

Содержит режим или состояние, или функцию, или ещё что угодно.

Type:: str

Parameters:

client (yandex_music.Client, optional) – Клиент Yandex Music.
**kwargs – Собственно тут и передаются все эти свистелки.

classmethod de_json(data: dict, client: Client) → Experiments | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Какие-то свистелки и перделки, флажки, режимы экспериментальных функций.

Return type:

yandex_music.Experiments

class yandex_music.Feed(can_get_more_events: bool, pumpkin: bool, is_wizard_passed: bool, generated_playlists: List[GeneratedPlaylist], headlines: list, today: str, days: List[Day], next_revision: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий фид.

Note

Несмотря на то, что days это list, обычно возвращается только один день - текущий.

can_get_more_events#

Можно ли получить больше событий.

Type:: bool

pumpkin#

Хэллоуин.

Type:: bool

is_wizard_passed#

TODO.

Type:: bool

generated_playlists#

Сгенерированные плейлисты.

Type:: list из yandex_music.GeneratedPlaylist

headlines#

Заголовки.

Type:: list из str

today#

Сегодняшняя дата в формате YYYY-MM-DD.

Type:: str

days#

Дни.

Type:: list из yandex_music.Day

next_revision#

Дата следующих изменений в формате YYYY-MM-DD.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

can_get_more_events: bool#

client: Client | None = None#

days: List[Day]#

classmethod de_json(data: dict, client: Client) → Feed | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Фид.

Return type:

yandex_music.Feed

generated_playlists: List[GeneratedPlaylist]#

headlines: list#

is_wizard_passed: bool#

next_revision: str | None = None#

pumpkin: bool#

today: str#

class yandex_music.GeneratedPlaylist(type: str, ready: bool, notify: bool, data: Playlist | None, description: list | None = None, preview_description: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий автоматически сгенерированный плейлист.

Note

Известные значения type: playlistOfTheDay, origin, recentTracks, neverHeard, podcasts, missedLikes.

type#

Тип сгенерированного плейлиста.

Type:: str

ready#

Готовность плейлиста.

Type:: bool

notify#

Уведомлён ли пользователь об обновлении содержания.

Type:: bool

data#

Сгенерированный плейлист.

Type:: yandex_music.Playlist, optional

description#

Описание TODO.

Type:: list, optional

preview_description#

Короткое описание под блоком лендинга.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

data: Playlist | None#

classmethod de_json(data: dict, client: Client) → GeneratedPlaylist | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Автоматически сгенерированный плейлист.

Return type:

yandex_music.GeneratedPlaylist

classmethod de_list(data: list, client: Client) → List[GeneratedPlaylist]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Автоматически сгенерированные плейлисты.

Return type:

list из yandex_music.GeneratedPlaylist

description: list | None = None#

notify: bool#

preview_description: str | None = None#

ready: bool#

type: str#

class yandex_music.Genre(id: str, weight: int, composer_top: bool, title: str, titles: Dict[str, Title | None], images: Images | None, show_in_menu: bool, show_in_regions: list | None = None, full_title: str | None = None, url_part: str | None = None, color: str | None = None, radio_icon: Icon | None = None, sub_genres: List[Genre] = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий жанр музыки.

id#

Уникальный идентификатор жанра.

Type:: str

weight#

Вес TODO (возможно, чем выше показатель, тем больше нравится пользователю).

Type:: int

composer_top#

TODO.

Type:: bool

title#

Заголовок жанра.

Type:: str

titles#

Словарь заголовков на разных языках, где ключ - язык.

Type:: dict

images#

Изображение жанра.

Type:: yandex_music.Images

show_in_menu#

Показывать в меню.

Type:: bool

show_in_regions#

Список регионов в которых отображается жанр в списках.

Type:: list из int, optional

full_title#

Полный заголовок.

Type:: str, optional

url_part#

Часть ссылки на жанр для открытия в браузере.

Type:: str, optional

color#

Цвет фона изображения.

Type:: str, optional

radio_icon#

Иконка радио жанра.

Type:: yandex_music.Icon, optional

sub_genres#

Поджанры текущего жанра музыки.

Type:: list из yandex_music.Genre, optional

hide_in_regions#

В каких регионах скрывать жанр.

Type:: list, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

color: str | None = None#

composer_top: bool#

classmethod de_json(data: dict, client: Client) → Genre | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Жанр музыки.

Return type:

yandex_music.Genre

classmethod de_list(data: list, client: Client) → List[Genre]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Жанры музыки.

Return type:

list из yandex_music.Genre

full_title: str | None = None#

hide_in_regions = None#

id: str#

images: Images | None#

radio_icon: Icon | None = None#

show_in_menu: bool#

show_in_regions: list | None = None#

sub_genres: List[Genre] = None#

title: str#

titles: Dict[str, Title | None]#

url_part: str | None = None#

weight: int#

class yandex_music.Icon(background_color: str, image_url: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий иконку.

background_color#

Цвет заднего фона в HEX.

Type:: str

image_url#

Ссылка на изображение.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

background_color: str#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Icon | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Иконка.

Return type:

yandex_music.Icon

download(filename: str, size: str = '200x200') → None#

Загрузка иконки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер иконки.

async downloadAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_async

downloadBytes(size: str = '200x200') → bytes#: Псевдоним для download_bytes

async downloadBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_bytes_async

async download_async(filename: str, size: str = '200x200') → None#

Загрузка иконки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер иконки.

download_bytes(size: str = '200x200') → bytes#

Загрузка иконки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер иконки.
Returns:: Иконка в виде байтов.
Return type:: bytes

async download_bytes_async(size: str = '200x200') → bytes#

Загрузка иконки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер иконки.
Returns:: Иконка в виде байтов.
Return type:: bytes

getUrl(size: str = '200x200') → str#: Псевдоним для get_url

get_url(size: str = '200x200') → str#

Получение URL иконки.

Parameters:: size (str, optional) – Размер иконки.

image_url: str#

class yandex_music.Id(type: str, tag: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий уникальный идентификатор станции.

Note

Известные типы станций: user, genre.

type#

Тип станции.

Type:: str

tag#

Тег станции.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

\*\*kwargs: Произвольные ключевые аргументы полученные от API.

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Id | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Уникальный идентификатор станции.

Return type:

yandex_music.Id

tag: str#

type: str#

class yandex_music.Images(_208x208: str | None = None, _300x300: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий изображение жанра.

_208x208#

Ссылка на изображение размером 208 на 208.

Type:: str, optional

_300x300#

Ссылка на изображение размером 300 на 300.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Images | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Изображение жанра.

Return type:

yandex_music.Images

download208X208(filename: str) → None#: Псевдоним для download_208x208

download208X208Bytes() → bytes#: Псевдоним для download_208x208_bytes

download300X300(filename: str) → None#: Псевдоним для download_300x300

download300X300Bytes() → bytes#: Псевдоним для download_300x300_bytes

download_208x208(filename: str) → None#

Загрузка изображения 208x208.

Parameters:: filename (str) – Путь для сохранения файла с названием и расширением.

download_208x208_bytes() → bytes#

Загрузка изображения 208x208 и возврат в виде байтов.

Returns:: Изображение в виде байтов.
Return type:: bytes

download_300x300(filename: str) → None#

Загрузка изображения 300x300.

Parameters:: filename (str) – Путь для сохранения файла с названием и расширением.

download_300x300_bytes() → bytes#

Загрузка изображения 300x300 и возврат в виде байтов.

Returns:: Изображение в виде байтов.
Return type:: bytes

class yandex_music.InvocationInfo(hostname: str, req_id: str, exec_duration_millis: int | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий информацию о запросе.

hostname#

Имя удалённого сервера.

Type:: str

req_id#

Номер запроса.

Type:: str

exec_duration_millis#

Время выполнения в миллисекундах.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → InvocationInfo | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация о запросе.

Return type:

yandex_music.InvocationInfo

exec_duration_millis: int | None = None#

hostname: str#

req_id: str#

class yandex_music.Label(id: int, name: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий лейбл альбома.

id#

Идентификатор альбома.

Type:: int

name#

Название альбома.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Label | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Лейбл.

Return type:

yandex_music.Label

classmethod de_list(data: list, client: Client) → List[Label | str]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Note

Лейблы строками возвращаются, как минимум, в результатах поиска. В остальных местах это объекты.

Returns:: Лейблы.
Return type:: list из yandex_music.Label или str

id: int#

name: str#

class yandex_music.Landing(pumpkin: bool, content_id: str | int, blocks: List[Block], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий лендинг.

pumpkin#

Хэллоуин.

Type:: bool

content_id#

Уникальный идентификатор контента.

Type:: str | int

blocks#

Блоки лендинга.

Type:: list из yandex_music.Block

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

blocks: List[Block]#

client: Client | None = None#

content_id: str | int#

classmethod de_json(data: dict, client: Client) → Landing | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Лендинг.

Return type:

yandex_music.Landing

pumpkin: bool#

class yandex_music.LandingList(type: str, type_for_from: str, title: str, id: str | None = None, new_releases: List[int] = None, new_playlists: List[int] = None, podcasts: List[int] = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий список объектов лендинга.

Note

Известные значения поля type: new-playlists, new-releases, podcasts.

В зависимости от типа будет заполнено то, или иное поле.

type#

Тип результата.

Type:: str

type_for_from#

Откуда пришло событие.

Type:: str

title#

Заголовок страницы.

Type:: str

id#

Уникальный идентификатор списка.

Type:: str, optional

new_releases#

Новые альбомы.

Type:: list из int, optional

new_playlists#

Новые плейлисты.

Type:: list из int, optional

podcasts#

Подкасты.

Type:: list из int, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → LandingList | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список объектов лендинга.

Return type:

yandex_music.LandingList

id: str | None = None#

new_playlists: List[int] = None#

new_releases: List[int] = None#

podcasts: List[int] = None#

title: str#

type: str#

type_for_from: str#

class yandex_music.LicenceTextPart(text: str, url: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий часть текста с ссылкой на лицензионное соглашение.

text#

Часть текста (строка).

Type:: str

url#

Ссылка на лицензионное соглашение.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → LicenceTextPart | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Строка лицензионного соглашения.

Return type:

yandex_music.LicenceTextPart

classmethod de_list(data: list, client: Client) → List[LicenceTextPart]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Строки текста с ссылкой на лицензионное соглашение.

Return type:

list из yandex_music.LicenceTextPart

text: str#

url: str | None = None#

Bases: YandexMusicObject

Класс, представляющий объект с отметкой “мне нравится”.

None:: В поле type содержится одно из трёх значений: artist, playlist, album. Обозначает поле, в котором содержится информация.

type#

Тип объекта с отметкой.

Type:: str

id#

Уникальный идентификатор отметки.

Type:: str, optional

timestamp#

Дата и время добавления отметки.

Type:: str, optional

album#

Понравившейся альбом.

Type:: yandex_music.Album, optional

artist#

Понравившейся артист.

Type:: yandex_music.Artist, optional

playlist#

Понравившейся плейлист.

Type:: yandex_music.Playlist, optional

short_description#

Короткое описание.

Type:: str, optional

description#

Описание.

Type:: str, optional

is_premiere#

Премьера ли.

Type:: bool, optional

is_banner#

Является ли баннером.

Type:: bool, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

album: Album | None = None#

artist: Artist | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client, type_: str = None) → Like | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
type (str, optional) – Тип объекта с отметкой “мне нравится”.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Объект с отметкой “мне нравится”.

Return type:

yandex_music.Like

classmethod de_list(data: list, client: Client, type_: str = None) → List[Like]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
type (str, optional) – Тип объекта с отметкой “мне нравится”.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Объекты с отметкой “мне нравится”.

Return type:

list из yandex_music.Like

description: str | None = None#

id: str | None = None#

is_banner: bool | None = None#

is_premiere: bool | None = None#

playlist: Playlist | None = None#

short_description: str | None = None#

timestamp: str | None = None#

type: str#

class yandex_music.Link(title: str, href: str, type: str, social_network: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий ссылку на официальную страницу исполнителя.

Note

Известные типы страниц: official - официальный сайт и social - социальная сеть.

title#

Название страницы.

Type:: str

href#

URL страницы.

Type:: str

type#

Тип страницы.

Type:: str

social_network#

Название социальной сети.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Link | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Ссылка на официальную страницу исполнителя.

Return type:

yandex_music.Link

classmethod de_list(data: list, client: Client) → List[Link]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Ссылки на официальные страницы исполнителя.

Return type:

list из yandex_music.Link

href: str#

social_network: str | None = None#

title: str#

type: str#

class yandex_music.Lyrics(id: int, lyrics: str, full_lyrics: str, has_rights: bool, show_translation: bool, text_language: str | None = None, url: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий текст трека.

Warning

Получение текста из дополнительной информации устарело. Используйте yandex_music.Client.tracks_lyrics().

id#

Уникальный идентификатор текста трека.

Type:: int

lyrics#

Первые строки текст песни.

Type:: str

has_rights#

Есть ли права.

Type:: bool

full_lyrics#

Текст песни.

Type:: str

show_translation#

Доступен ли перевод.

Type:: bool

text_language#

Язык песни.

Type:: str, optional

url#

Ссылка на источник перевода. Обычно genius.com.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

\*\*kwargs: Произвольные ключевые аргументы полученные от API.

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Lyrics | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Текст трека.

Return type:

yandex_music.Lyrics

full_lyrics: str#

has_rights: bool#

id: int#

lyrics: str#

show_translation: bool#

text_language: str | None = None#

url: str | None = None#

class yandex_music.LyricsInfo(has_available_sync_lyrics: bool, has_available_text_lyrics: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, описывающий доступные тексты трека.

has_available_sync_lyrics#

Наличие синхронизированного текста.

Type:: bool

has_available_text_lyrics#

Наличие текста трека.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → LyricsInfo | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Типы доступных текстов трека.

Return type:

yandex_music.LyricsInfo

has_available_sync_lyrics: bool#

has_available_text_lyrics: bool#

class yandex_music.LyricsMajor(id: int, name: str, pretty_name: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий сервис-источник текстов к трекам.

Parameters:

id (int) – Уникальный идентификатор сервиса.
name (str) – Имя сервиса.
pretty_name (str) – Человекочитаемое имя сервиса.
client (yandex_music.Client, optional) – Клиент Yandex Music.

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → LyricsMajor | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Сервис-источник текстов к трекам.

Return type:

yandex_music.LyricsMajor

id: int#

name: str#

pretty_name: str#

class yandex_music.MadeFor(user_info: User | None, case_forms: CaseForms | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий пользователя, для которого был сделан плейлист.

user_info#

Пользователь, для которого был сделан плейлист.

Type:: yandex_music.User

case_forms#

Склонение имени пользователя, для которого был сделан плейлист.

Type:: yandex_music.CaseForms

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

case_forms: CaseForms | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → MadeFor | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Пользователь, для которого был сделан плейлист.

Return type:

yandex_music.MadeFor

user_info: User | None#

class yandex_music.Major(id: int, name: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий мейджор-лейбл звукозаписи.

id#

Уникальный идентификатор.

Type:: int

name#

Название.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Major | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Мейджор-лейбл звукозаписи.

Return type:

yandex_music.Major

id: int#

name: str#

Bases: YandexMusicObject

Класс, представляющий метаданные трека.

album#

Название альбома.

Type:: str, optional

volume#

Диск (раздел).

Type:: int, optional

year#

Год выхода.

Type:: int, optional

number#

Позиция в альбоме.

Type:: int, optional

genre#

Жанр.

Type:: str, optional

lyricist#

Текст песни. Есть только у пользовательских треков.

Type:: str, optional

version#

Версия TODO.

Type:: str, optional

composer#

Композитор TODO.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

album: str | None = None#

client: Client | None = None#

composer: str | None = None#

classmethod de_json(data: dict, client: Client) → MetaData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Метаданные трека

Return type:

yandex_music.MetaData

genre: str | None = None#

lyricist: str | None = None#

number: int | None = None#

version: str | None = None#

volume: int | None = None#

year: int | None = None#

class yandex_music.MixLink(title: str, url: str, url_scheme: str, text_color: str, background_color: str, background_image_uri: str, cover_white: str | None = None, cover_uri: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий ссылку (кликабельный блок) на подборку.

Note

В цветах может как оказаться HEX (#6c65a9), так и какой-нибудь transparent.

Ссылка со схемой отличается от просто ссылки наличием yandexmusic:// в начале.

title#

Заголовок ссылки.

Type:: str

url#

Ссылка на подборку.

Type:: str

url_scheme#

Ссылка со схемой на подборку.

Type:: str

text_color#

Цвет текста (HEX).

Type:: str

background_color#

Цвет заднего фона.

Type:: str

background_image_uri#

Ссылка на изображение заднего фона.

Type:: str

cover_white#

Ссылка на изображение с обложкой TODO.

Type:: str, optional

cover_uri#

Ссылка на изображение с обложкой.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

background_color: str#

background_image_uri: str#

client: Client | None = None#

cover_uri: str | None = None#

cover_white: str | None = None#

classmethod de_json(data: dict, client: Client) → MixLink | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Блок-ссылка на подборку.

Return type:

yandex_music.MixLink

classmethod de_list(data: list, client: Client) → List[MixLink]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Блоки-ссылки на подборки.

Return type:

list из yandex_music.MixLink

downloadBackgroundImage(filename: str, size: str = '200x200') → None#: Псевдоним для download_background_image

async downloadBackgroundImageAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_background_image_async

downloadBackgroundImageBytes(size: str = '200x200') → bytes#: Псевдоним для download_background_image_bytes

async downloadBackgroundImageBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_background_image_bytes_async

downloadCoverUri(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_uri

async downloadCoverUriAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_uri_async

downloadCoverUriBytes(size: str = '200x200') → bytes#: Псевдоним для download_cover_uri_bytes

async downloadCoverUriBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_cover_uri_bytes_async

downloadCoverWhite(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_white

async downloadCoverWhiteAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_white_async

downloadCoverWhiteBytes(size: str = '200x200') → bytes#: Псевдоним для download_cover_white_bytes

async downloadCoverWhiteBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_cover_white_bytes_async

download_background_image(filename: str, size: str = '200x200') → None#

Загрузка заднего фона.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер заднего фона.

async download_background_image_async(filename: str, size: str = '200x200') → None#

Загрузка заднего фона.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер заднего фона.

download_background_image_bytes(size: str = '200x200') → bytes#

Загрузка заднего фона и возврат в виде байтов.

Parameters:: size (str, optional) – Размер заднего фона.
Returns:: Задний фон в виде байтов.
Return type:: bytes

async download_background_image_bytes_async(size: str = '200x200') → bytes#

Загрузка заднего фона и возврат в виде байтов.

Parameters:: size (str, optional) – Размер заднего фона.
Returns:: Задний фон в виде байтов.
Return type:: bytes

download_cover_uri(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_cover_uri_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_cover_uri_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_cover_uri_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

download_cover_white(filename: str, size: str = '200x200') → None#

Загрузка обложки TODO.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_cover_white_async(filename: str, size: str = '200x200') → None#

Загрузка обложки TODO.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_cover_white_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов TODO.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_cover_white_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов TODO.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

getBackgroundUrl(size: str = '200x200') → str#: Псевдоним для get_background_url

getCoverUrl(size: str = '200x200') → str#: Псевдоним для get_cover_url

getCoverWhiteUrl(size: str = '200x200') → str#: Псевдоним для get_cover_white_url

get_background_url(size: str = '200x200') → str#

Возвращает URL заднего фона.

Parameters:: size (str, optional) – Размер заднего фона.
Returns:: URL заднего фона.
Return type:: str

get_cover_url(size: str = '200x200') → str#

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

get_cover_white_url(size: str = '200x200') → str#

Возвращает URL обложки white.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

text_color: str#

title: str#

url: str#

url_scheme: str#

class yandex_music.NonAutoRenewable(start: str, end: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий отключённое автопродление.

start#

Дата начала подписки.

Type:: str

end#

Дата окончания подписки.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → NonAutoRenewable | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Отключённое автопродление.

Return type:

yandex_music.NonAutoRenewable

end: str#

start: str#

class yandex_music.Normalization(gain: float, peak: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий значения для нормализации трека.

gain#

Значение гейна, которое нужно применить к аудиосигналу.

Type:: str

peak#

Пиковая точка волны аудиосигнала.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Normalization | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Значения для нормализации трека.

Return type:

yandex_music.Normalization

gain: float#

peak: int#

class yandex_music.OpenGraphData(title: str, description: str, image: Cover, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий данные для Open Graph.

title#

Заголовок.

Type:: str

description#

Описание.

Type:: str

image#

Изображение.

Type:: yandex_music.Cover

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → OpenGraphData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Данные для Open Graph.

Return type:

yandex_music.OpenGraphData

description: str#

image: Cover#

title: str#

class yandex_music.Operator(product_id: str, phone: str, payment_regularity: str, deactivation: List[Deactivation], title: str, suspended: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий услугу сотового оператора.

product_id#

Уникальный идентификатор продукта сервиса Яндекс.Музыка.

Type:: str

phone#

Мобильный номер, на который подключена услуга.

Type:: str

payment_regularity#

Регулярность оплаты.

Type:: str

deactivation#

Способы деактивации.

Type:: list из yandex_music.Deactivation

title#

Название услуги.

Type:: str

suspended#

Приостановлено.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Operator | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Услуга сотового оператора.

Return type:

yandex_music.Operator

classmethod de_list(data: list, client: Client) → List[Operator]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Услуги сотового оператора.

Return type:

list из yandex_music.Operator

deactivation: List[Deactivation]#

payment_regularity: str#

phone: str#

product_id: str#

suspended: bool#

title: str#

class yandex_music.Pager(total: int, page: int, per_page: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий пагинацию.

total#

Всего треков.

Type:: int

page#

Номер страницы.

Type:: int

per_page#

Количество треков на странице.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Pager | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Пагинация.

Return type:

yandex_music.Pager

page: int#

per_page: int#

total: int#

class yandex_music.PassportPhone(phone: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий номер телефона пользователя.

phone#

Номер телефона.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PassportPhone | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Номер телефона пользователя.

Return type:

yandex_music.PassportPhone

classmethod de_list(data: list, client: Client) → List[PassportPhone]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Номера телефонов пользователя.

Return type:

list из yandex_music.PassportPhone

phone: str#

class yandex_music.PermissionAlerts(alerts: List[str], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий оповещения.

alerts#

Список оповещений.

Type:: list из str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

alerts: List[str]#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PermissionAlerts | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Оповещение.

Return type:

yandex_music.PermissionAlerts

class yandex_music.Permissions(until: str, values: List[str], default: List[str], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий информацию о правах пользователя, их изначальных значениях и даты окончания.

until#

Дата окончания прав.

Type:: str

values#

Список прав.

Type:: list из str

default#

Список изначальных прав.

Type:: list из str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Permissions | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация о правах пользователя, их изначальных значениях и даты: окончания.

Return type:

yandex_music.Permissions

default: List[str]#

until: str#

values: List[str]#

class yandex_music.PersonalPlaylistsData(is_wizard_passed: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий дополнительную информацию о персональном плейлисте.

is_wizard_passed#

TODO.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PersonalPlaylistsData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Дополнительная информация о персональном плейлисте.

Return type:

yandex_music.PersonalPlaylistsData

is_wizard_passed: bool#

class yandex_music.PlayContext(client_: str, context: str, context_item: str, tracks: List[TrackShortOld], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий проигрываемый контекст.

Note

Известные значения поля client_: android.

Поле context хранит в себе место воспроизведения, например, playlist.

Поле context_item хранит в себе уникальный идентификатор context’a, т.е. в нашем случае playlist’a.

client_#

Клиент.

Type:: str

context#

Тип контекста.

Type:: str

context_item#

Предмет контекста.

Type:: str

tracks#

Треки.

Type:: list из yandex_music.TrackShortOld

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

client_: str#

context: str#

context_item: str#

classmethod de_json(data: dict, client: Client) → PlayContext | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Проигрываемый контекст.

Return type:

yandex_music.PlayContext

tracks: List[TrackShortOld]#

class yandex_music.PlayContextsData(other_tracks: List[TrackShortOld], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий данные проигрываемого контекста.

other_tracks#

Другие треки.

Type:: list из yandex_music.TrackShortOld

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PlayContextsData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Данные проигрываемого контекста.

Return type:

yandex_music.PlayContextsData

other_tracks: List[TrackShortOld]#

class yandex_music.PlayCounter(value: int, description: str, updated: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий счётчик дней.

Note

Присутствует только у плейлиста дня. Счётчик считает количество дней подряд, на протяжении которых был прослушан плейлист.

value#

Значение (количество дней).

Type:: int

description#

Описание счётчика.

Type:: str

updated#

Обновлён ли сегодня (в этих сутках).

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PlayCounter | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Счетчик дней.

Return type:

yandex_music.PlayCounter

description: str#

updated: bool#

value: int#

Bases: YandexMusicObject

Класс, представляющий плейлист.

Note

Под полями с заглушками понимаются поля, которые доступны у умных плейлистов тогда, когда у сервиса мало данных для генерации плейлиста.

Известные значения visibility: public - публичный плейлист, private - приватный плейлист.

Известные значения generated_playlist_type: playlistOfTheDay - Плейлист дня, recentTracks - Премьера, neverHeard - Дежавю, podcasts - Подкасты недели, missedLikes - Тайник, origin - Плейлист с Алисой.

Известные значения type: missedLikes, recentTracks.

owner#

Владелец плейлиста.

Type:: yandex_music.User, optional

cover#

Обложка альбома.

Type:: yandex_music.Cover, optional

made_for#

Пользователь для которого был создан плейлист. Присутствует только у персональных плейлистов.

Type:: yandex_music.MadeFor, optional

play_counter#

Счётчик дней. Присутствует только у плейлиста дня.

Type:: yandex_music.PlayCounter, optional

playlist_absence#

Причина отсутствия плейлиста.

Type:: yandex_music.PlaylistAbsence, optional

uid#

Идентификатор владельца плейлиста.

Type:: int, optional

kind#

Идентификатор плейлиста.

Type:: int, optional

title#

Название плейлиста.

Type:: str, optional

track_count#

Количество треков.

Type:: int, optional

tags#

Список тегов плейлиста.

Type:: list, optional

revision#

Актуальность данных TODO.

Type:: int, optional

snapshot#

Версия плейлиста. Увеличивается на 1 при каждом изменении.

Type:: int, optional

visibility#

Видимость плейлиста.

Type:: str, optional

collective#

Есть ли у плейлиста соавторы.

Type:: bool, optional

url_part#

Часть ссылки на плейлист (‘daily`).

Type:: str, optional

created#

Дата создания в формате ISO 8601.

Type:: str, optional

modified#

Дата последнего изменения в формате ISO 8601.

Type:: str, optional

available#

Доступен TODO.

Type:: bool, optional

is_banner#

Является ли банером TODO.

Type:: bool, optional

is_premiere#

Является ли премьерой TODO.

Type:: bool, optional

duration_ms#

Длительность в миллисекундах.

Type:: int, optional

og_image#

Ссылка на превью Open Graph.

Type:: str, optional

og_title#

Заголовок Open Graph.

Type:: str, optional

og_description#

Описание Open Graph.

Type:: str, optional

image#

Изображение TODO.

Type:: str, optional

cover_without_text#

Обложка без текста.

Type:: yandex_music.Cover, optional

contest#

Контест TODO.

Type:: yandex_music.Contest, optional

background_color#

Цвет заднего фона TODO.

Type:: str, optional

text_color#

Цвет текста TODO.

Type:: str, optional

id_for_from#

Откуда пришло событие (уникальный идентификатор объекта) TODO.

Type:: str, optional

dummy_description#

Описание-заглушка плейлиста.

Type:: str, optional

dummy_page_description#

Описание-заглушка страницы.

Type:: str, optional

dummy_cover#

Обложка-заглушка.

Type:: str, optional

dummy_rollover_cover#

Обложка-заглушка TODO.

Type:: str, optional

og_data#

Данные для OpenGraph.

Type:: yandex_music.OpenGraphData, optional

branding#

Бренд.

Type:: yandex_music.Brand

metrika_id#

Уникальный идентификатор счётчика на Яндекс.Метрика.

Type:: int, optional

coauthors#

Перечень ID аккаунтов соавторов плейлиста.

Type:: list из int, optional

top_artist#

Топ артистов TODO.

Type:: list из yandex_music.Artist, optional

recent_tracks#

Список ID недавних треков.

Type:: list из yandex_music.TrackId, optional

tracks#

Список треков.

Type:: list из yandex_music.TrackShort, optional

prerolls#

Прерол, проигрываемый перед плейлистом. Присутствует только у персональных плейлистов.

Type:: list, optional

likes_count#

Количество лайков.

Type:: int, optional

similar_playlists#

Похожие плейлисты.

Type:: list из yandex_music.Playlist, optional

last_owner_playlists#

Последние плейлисты владельца.

Type:: list из yandex_music.Playlist, optional

generated_playlist_type#

Тип генерируемого плейлиста.

Type:: str, optional

animated_cover_uri#

Ссылка на анимированную обложку.

Type:: str, optional

ever_played#

Играл ли этот плейлист. Присутствует только у персональных плейлистов. TODO

Type:: str, optional

description#

Описание плейлиста с разметкой Markdown.

Type:: str, optional

description_formatted#

Описание плейлиста. Только текст, без разметки.

Type:: str, optional

playlist_uuid#

TODO.

Type:: str, optional

type#

TODO.

Type:: str, optional

ready#

Готовность TODO.

Type:: bool, optional

is_for_from#

TODO.

Type:: Any

regions#

Регион TODO.

Type:: Any

custom_wave (: obj:’yandex_music.CustomWave`, optional): Описание плейлиста. TODO.

pager#

Пагинатор.

Type:: yandex_music.Pager, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

animated_cover_uri: str | None = None#

available: bool | None = None#

background_color: str | None = None#

branding: Brand | None = None#

client: Client | None = None#

coauthors: List[int] = None#

collective: bool | None = None#

contest: Contest | None = None#

cover: Cover | None#

cover_without_text: Cover | None = None#

created: str | None = None#

custom_wave: CustomWave | None = None#

classmethod de_json(data: dict, client: Client) → Playlist | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Плейлист.

Return type:

yandex_music.Playlist

classmethod de_list(data: list, client: Client) → List[Playlist]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Плейлисты.

Return type:

list из yandex_music.Playlist

delete(*args, **kwargs) → bool#

Сокращение для:

client.users_playlists_delete(self.kind, self.owner.uid)

async deleteAsync(*args, **kwargs) → bool#: Псевдоним для delete_async

deleteTracks(from_: int, to: int, *args, **kwargs) → Playlist | None#: Псевдоним для delete_tracks

async deleteTracksAsync(from_: int, to: int, *args, **kwargs) → Playlist | None#: Псевдоним для delete_tracks_async

async delete_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_playlists_delete(self.kind, self.owner.uid)

delete_tracks(from_: int, to: int, *args, **kwargs) → Playlist | None#

Сокращение для:

client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)

async delete_tracks_async(from_: int, to: int, *args, **kwargs) → Playlist | None#

Сокращение для:

await client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)

description: str | None = None#

description_formatted: str | None = None#

dislike(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_playlists_remove(playlist.playlist_id, user.id, *args, **kwargs)

async dislikeAsync(*args, **kwargs) → bool#: Псевдоним для dislike_async

async dislike_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_playlists_remove(playlist.playlist_id, user.id, *args, **kwargs)

downloadAnimatedCover(filename: str, size: str = '200x200') → None#: Псевдоним для download_animated_cover

async downloadAnimatedCoverAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_animated_cover_async

downloadAnimatedCoverBytes(size: str = '200x200') → bytes#: Псевдоним для download_animated_cover_bytes

async downloadAnimatedCoverBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_animated_cover_bytes_async

downloadOgImage(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image

async downloadOgImageAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image_async

downloadOgImageBytes(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes

async downloadOgImageBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes_async

download_animated_cover(filename: str, size: str = '200x200') → None#

Загрузка анимированной обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением (GIF).
size (str, optional) – Размер анимированной обложки.

async download_animated_cover_async(filename: str, size: str = '200x200') → None#

Загрузка анимированной обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением (GIF).
size (str, optional) – Размер анимированной обложки.

download_animated_cover_bytes(size: str = '200x200') → bytes#

Загрузка анимированной обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: Анимированная обложка в виде байтов.
Return type:: bytes

async download_animated_cover_bytes_async(size: str = '200x200') → bytes#

Загрузка анимированной обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: Анимированная обложка в виде байтов.
Return type:: bytes

download_og_image(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Используйте это только когда нет self.cover!

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_og_image_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Используйте это только когда нет self.cover!

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_og_image_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Используйте это только когда нет self.cover!

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_og_image_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Используйте это только когда нет self.cover!

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

dummy_cover: Cover | None = None#

dummy_description: str | None = None#

dummy_page_description: str | None = None#

dummy_rollover_cover: Cover | None = None#

duration_ms: int | None = None#

ever_played: bool | None = None#

fetchTracks(*args, **kwargs) → List[TrackShort]#: Псевдоним для fetch_tracks

async fetchTracksAsync(*args, **kwargs) → List[TrackShort]#: Псевдоним для fetch_tracks_async

fetch_tracks(*args, **kwargs) → List[TrackShort]#

Сокращение для:

client.users_playlists(playlist.kind, playlist.owner.id, *args, **kwargs).tracks

async fetch_tracks_async(*args, **kwargs) → List[TrackShort]#

Сокращение для:

await client.users_playlists(playlist.kind, playlist.owner.id, *args, **kwargs).tracks

generated_playlist_type: str | None = None#

getAnimatedCoverUrl(size: str = '300x300') → str#: Псевдоним для get_animated_cover_url

getOgImageUrl(size: str = '300x300') → str#: Псевдоним для get_og_image_url

getRecommendations(*args, **kwargs) → PlaylistRecommendations | None#: Псевдоним для get_recommendations

async getRecommendationsAsync(*args, **kwargs) → PlaylistRecommendations | None#: Псевдоним для get_recommendations_async

get_animated_cover_url(size: str = '300x300') → str#

Возвращает URL анимированной обложки.

Parameters:: size (str, optional) – Размер анимированной обложки.
Returns:: URL анимированной обложки.
Return type:: str

get_og_image_url(size: str = '300x300') → str#

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

get_recommendations(*args, **kwargs) → PlaylistRecommendations | None#

Сокращение для:

client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)

async get_recommendations_async(*args, **kwargs) → PlaylistRecommendations | None#

Сокращение для:

await client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)

id_for_from: str | None = None#

image: str | None = None#

insertTrack(track_id: int, album_id: int, **kwargs) → Playlist | None#: Псевдоним для insert_track

async insertTrackAsync(track_id: int, album_id: int, **kwargs) → Playlist | None#: Псевдоним для insert_track_async

insert_track(track_id: int, album_id: int, **kwargs) → Playlist | None#

Сокращение для:

client.users_playlists_insert_track(self.kind, track_id, album_id, user_id=self.owner.uid, revision=self.revision, *args, **kwargs)

async insert_track_async(track_id: int, album_id: int, **kwargs) → Playlist | None#

Сокращение для:

await client.users_playlists_insert_track(self.kind, track_id, album_id, user_id=self.owner.uid, revision=self.revision, *args, **kwargs)

property isMine: bool#: Псевдоним для is_mine

is_banner: bool | None = None#

is_for_from: Any = None#

property is_mine: bool#: Является ли плейлист моим.

is_premiere: bool | None = None#

kind: int | None = None#

last_owner_playlists: List[Playlist] = None#

like(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_playlists_add(playlist.playlist_id, user.id, *args, **kwargs)

async likeAsync(*args, **kwargs) → bool#: Псевдоним для like_async

async like_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_playlists_add(playlist.playlist_id, user.id, *args, **kwargs)

likes_count: int | None = None#

made_for: MadeFor | None#

metrika_id: int | None = None#

modified: str | None = None#

og_data: OpenGraphData | None = None#

og_description: str | None = None#

og_image: str | None = None#

og_title: str | None = None#

owner: User | None#

pager: Pager | None = None#

play_counter: PlayCounter | None#

property playlistId: str#: Псевдоним для playlist_id

playlist_absence: PlaylistAbsence | None#

property playlist_id: str#: Полный ID плейлиста.

playlist_uuid: str | None = None#

prerolls: list | None = None#

ready: bool | None = None#

recent_tracks: List[TrackId] = None#

regions: Any = None#

rename(name: str, *args, **kwargs) → None#

Сокращение для:

client.users_playlists_name(playlist.kind, name, *args, **kwargs)

async renameAsync(name: str, *args, **kwargs) → None#: Псевдоним для rename_async

async rename_async(name: str, *args, **kwargs) → None#

Сокращение для:

client.users_playlists_name(playlist.kind, name, *args, **kwargs)

revision: int | None = None#

similar_playlists: List[Playlist] = None#

snapshot: int | None = None#

tags: list | None = None#

text_color: str | None = None#

title: str | None = None#

top_artist: List[Artist] = None#

track_count: int | None = None#

tracks: List[TrackShort] = None#

type: str | None = None#

uid: int | None = None#

url_part: str | None = None#

visibility: str | None = None#

class yandex_music.PlaylistAbsence(kind: int, reason: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий причину отсутствия плейлиста.

kind#

Уникальный идентификатор плейлиста.

Type:: int

reason#

Причина отсутствия.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PlaylistAbsence | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Причина отсутствия плейлиста.

Return type:

yandex_music.PlaylistAbsence

kind: int#

reason: str#

class yandex_music.PlaylistId(uid: int, kind: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий уникальный идентификатор плейлиста.

uid#

Уникальный идентификатор пользователя владеющим плейлистом.

Type:: int

kind#

Уникальный идентификатор плейлиста.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PlaylistId | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Уникальный идентификатор плейлиста.

Return type:

yandex_music.PlaylistId

classmethod de_list(data: list, client: Client) → List[PlaylistId]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Уникальные идентификаторы плейлистов.

Return type:

list из yandex_music.PlaylistId

fetchPlaylist(*args, **kwargs) → Playlist | List[Playlist]#: Псевдоним для fetch_playlist

async fetchPlaylistAsync(*args, **kwargs) → Playlist | List[Playlist]#: Псевдоним для fetch_playlist_async

fetch_playlist(*args, **kwargs) → Playlist | List[Playlist]#

Сокращение для:

client.users_playlists(kind, uid, *args, **kwargs)

async fetch_playlist_async(*args, **kwargs) → Playlist | List[Playlist]#

Сокращение для:

await client.users_playlists(kind, uid, *args, **kwargs)

kind: int#

property playlistId: str#: Псевдоним для playlist_id

property playlist_id: str#: Полный ID плейлиста.

uid: int#

class yandex_music.PlaylistRecommendations(tracks: List[Track], batch_id: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий рекомендации для плейлиста.

tracks#

Список рекомендованных треков.

Type:: list из yandex_music.Track

batch_id#

Уникальный идентификатор партии треков.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

batch_id: str | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PlaylistRecommendations | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Рекомендации для плейлиста.

Return type:

yandex_music.PlaylistRecommendations

tracks: List[Track]#

class yandex_music.Plus(has_plus: bool, is_tutorial_completed: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий Plus подписку.

has_plus#

Наличие.

Type:: bool

is_tutorial_completed#

Закончено ли руководство.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Plus | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Plus подписка.

Return type:

yandex_music.Plus

has_plus: bool#

is_tutorial_completed: bool#

class yandex_music.PoetryLoverMatch(begin: int, end: int, line: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий слова в тексте TODO.

Note

Некая разметка для обучения чего-нибудь для написания романтических стихотворений.

begin#

Индекс начала.

Type:: int

end#

Индекс конца.

Type:: int

line#

Индекс строки.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

begin: int#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PoetryLoverMatch | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Позиция слова.

Return type:

yandex_music.PoetryLoverMatch

classmethod de_list(data: list, client: Client) → List[PoetryLoverMatch]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список с позициями слов.

Return type:

list из yandex_music.PoetryLoverMatch

end: int#

line: int#

class yandex_music.Price(amount: int, currency: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий цену.

amount#

Количество единиц.

Type:: int

currency#

Валюта.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

amount: int#

client: Client | None = None#

currency: str#

classmethod de_json(data: dict, client: Client) → Price | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Цена.

Return type:

yandex_music.Price

class yandex_music.Product(product_id: str, type: str, duration: int, trial_duration: int, feature: str, debug: bool, plus: bool, price: Price | None = None, common_period_duration: str | None = None, cheapest: bool | None = None, title: str | None = None, family_sub: bool | None = None, fb_image: str | None = None, fb_name: str | None = None, family: bool | None = None, features: List[str] = None, description: str | None = None, available: bool | None = None, trial_available: bool | None = None, trial_period_duration: str | None = None, intro_period_duration: str | None = None, intro_price: Price | None = None, start_period_duration: str | None = None, start_price: Price | None = None, licence_text_parts: List[Price] = None, vendor_trial_available: bool | None = None, button_text: str | None = None, button_additional_text: str | None = None, payment_method_types: List[str] = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий продаваемый продукт.

product_id#

Уникальный идентификатор.

Type:: str

type#

Тип продаваемого.

Type:: str

duration#

Длительность.

Type:: int

trial_duration#

Длительность испытательного срока.

Type:: int

feature#

Предоставляемая возможность.

Type:: str

debug#

Отладочный продукт.

Type:: bool

plus#

Даёт ли подписку “Плюс”.

Type:: bool

price#

Цена.

Type:: yandex_music.Price, optional

common_period_duration#

Длительность общего периода.

Type:: str, optional

cheapest#

Самый дешёвый (лучшее предложение).

Type:: bool, optional

title#

Заголовок продукта.

Type:: str, optional

family_sub#

Семейная ли подписка.

Type:: bool, optional

fb_image#

Картинка для превью на facebook.

Type:: str, optional

fb_name#

Заголовок превью на facebook.

Type:: str, optional

family#

Доступно ли для семьи.

Type:: bool, optional

features#

Список предоставляемых возможностей.

Type:: list из str, optional

description#

Описание.

Type:: str, optional

available#

Доступна ли покупка.

Type:: bool, optional

trial_available#

Доступен ли пробный период.

Type:: bool, optional

trial_period_duration#

Длительность пробного периода.

Type:: str, optional

intro_period_duration#

Длительность вступительного периода TODO.

Type:: str, optional

intro_price#

Цена вступительного периода.

Type:: yandex_music.Price, optional

start_period_duration#

Длительность первого срока (за меньшую цену).

Type:: str, optional

start_price#

Цена за первый срок.

Type:: yandex_music.Price, optional

licence_text_parts#

Длительность пробного периода.

Type:: list из yandex_music.LicenceTextPart, optional

vendor_trial_available#

Доступен испытательный срок продавца TODO.

Type:: bool, optional

button_text#

Текст кнопки.

Type:: str, optional

button_additional_text#

Дополнительный текст кнопки.

Type:: str, optional

payment_method_types#

Способы оплаты.

Type:: list из str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

available: bool | None = None#

button_additional_text: str | None = None#

button_text: str | None = None#

cheapest: bool | None = None#

client: Client | None = None#

common_period_duration: str | None = None#

classmethod de_json(data: dict, client: Client) → Product | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Продаваемый продукт.

Return type:

yandex_music.Product

classmethod de_list(data: list, client: Client) → List[Product]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Продаваемые продукты.

Return type:

list из yandex_music.Product

debug: bool#

description: str | None = None#

duration: int#

family: bool | None = None#

family_sub: bool | None = None#

fb_image: str | None = None#

fb_name: str | None = None#

feature: str#

features: List[str] = None#

intro_period_duration: str | None = None#

intro_price: Price | None = None#

licence_text_parts: List[Price] = None#

payment_method_types: List[str] = None#

plus: bool#

price: Price | None = None#

product_id: str#

start_period_duration: str | None = None#

start_price: Price | None = None#

title: str | None = None#

trial_available: bool | None = None#

trial_duration: int#

trial_period_duration: str | None = None#

type: str#

vendor_trial_available: bool | None = None#

class yandex_music.PromoCodeStatus(status: str, status_desc: str, account_status: Status | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий статус активации промо-кода.

status#

Статус операции.

Type:: str

status_desc#

Описание статуса.

Type:: str

account_status#

Информация об аккаунте пользователя.

Type:: yandex_music.Status

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

account_status: Status | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → PromoCodeStatus | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Статус активации промо-кода.

Return type:

yandex_music.PromoCodeStatus

status: str#

status_desc: str#

class yandex_music.Promotion(promo_id: str, title: str, subtitle: str, heading: str, url: str, url_scheme: str, text_color: str, gradient: str, image: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий продвижение (рекламу).

Note

В цвете может как оказаться HEX (#6c65a9), так и какой-нибудь transparent.

Ссылка со схемой отличается от просто ссылки наличием yandexmusic:// в начале.

promo_id#

Уникальный идентификатор рекламы.

Type:: str

title#

Заголовок.

Type:: str

subtitle#

Подзаголовок.

Type:: str

heading#

Верхний заголовок.

Type:: str

url#

Ссылка.

Type:: str

url_scheme#

Ссылка с схемой.

Type:: str

text_color#

Цвет текста.

Type:: str

gradient#

Градиент TODO.

Type:: str

image#

Ссылка на рекламное изображение.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Promotion | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Продвижение (реклама).

Return type:

yandex_music.Promotion

classmethod de_list(data: list, client: Client) → List[Promotion]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Продвижения (реклама).

Return type:

list из yandex_music.Promotion

downloadImage(filename: str, size: str = '300x300') → None#: Псевдоним для download_image

async downloadImageAsync(filename: str, size: str = '300x300') → None#: Псевдоним для download_image_async

downloadImageBytes(size: str = '300x300') → bytes#: Псевдоним для download_image_bytes

async downloadImageBytesAsync(size: str = '300x300') → bytes#: Псевдоним для download_image_bytes_async

download_image(filename: str, size: str = '300x300') → None#

Загрузка рекламного изображения.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер изображения.

async download_image_async(filename: str, size: str = '300x300') → None#

Загрузка рекламного изображения.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер изображения.

download_image_bytes(size: str = '300x300') → bytes#

Загрузка рекламного изображения и возврат в виде байтов.

Parameters:: size (str, optional) – Размер изображения.
Returns:: Рекламное изображение в виде байтов.
Return type:: bytes

async download_image_bytes_async(size: str = '300x300') → bytes#

Загрузка рекламного изображения и возврат в виде байтов.

Parameters:: size (str, optional) – Размер изображения.
Returns:: Рекламное изображение в виде байтов.
Return type:: bytes

getImageUrl(size: str = '300x300') → str#: Псевдоним для get_image_url

get_image_url(size: str = '300x300') → str#

Возвращает URL изображения.

Parameters:: size (str, optional) – Размер изображения.
Returns:: URL изображения.
Return type:: str

gradient: str#

heading: str#

image: str#

promo_id: str#

subtitle: str#

text_color: str#

title: str#

url: str#

url_scheme: str#

class yandex_music.Queue(context: Context | None, tracks: List[TrackId], current_index: int, modified: str, id: str | None = None, from_: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий очередь треков.

context#

Объект по которому построена очередь.

Type:: yandex_music.Context | None

tracks#

Список треков.

Type:: list из yandex_music.TrackId

current_index#

Текущий проигрываемый трек.

Type:: int

modified#

Дата последнего изменения.

Type:: str

id#

Уникальный идентификатор очереди.

Type:: str, optional

from_#

Откуда был получен этот объект.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

context: Context | None#

current_index: int#

classmethod de_json(data: dict, client: Client) → Queue | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Очередь.

Return type:

yandex_music.Queue

from_: str | None = None#

getCurrentTrack() → TrackId#: Псевдоним для get_current_track

get_current_track() → TrackId#: Получение текущего трека очереди.

id: str | None = None#

modified: str#

tracks: List[TrackId]#

class yandex_music.QueueItem(id: str, context: Context | None, modified: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий очередь треков в списке очередей устройств.

id#

Уникальный идентификатор очереди.

Type:: str

context#

Объект по которому построена очередь.

Type:: yandex_music.Context | None

modified#

Дата последнего изменения.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

context: Context | None#

classmethod de_json(data: dict, client: Client) → QueueItem | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Очередь в списке.

Return type:

yandex_music.QueueItem

classmethod de_list(data: list, client: Client) → List[QueueItem]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список очередей всех устройств.

Return type:

list из yandex_music.QueueItem

fetchQueue(*args, **kwargs) → Queue | None#: Псевдоним для fetch_queue

async fetchQueueAsync(*args, **kwargs) → Queue | None#: Псевдоним для fetch_queue_async

fetch_queue(*args, **kwargs) → Queue | None#

Сокращение для:

client.queue(id, *args, **kwargs)

async fetch_queue_async(*args, **kwargs) → Queue | None#

Сокращение для:

await client.queue(id, *args, **kwargs)

id: str#

modified: str#

class yandex_music.R128(i: float, tp: float, client: Client | None = None)#

Bases: YandexMusicObject

Класс, описывающий параметры нормализации громкости трека в соответствии с рекомендацией EBU R 128.

i#

Интегрированная громкость. Совокупная громкость от начала до конца.

Type:: float

tp#

True Peak. Реконструкция пикового уровня сигнала между выборками (пикового уровня, генерируемого между двумя выборками ), рассчитанного с помощью передискретизации.

Type:: float

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → R128 | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Параметры нормализации громкости трека в соответствии с рекомендацией EBU R 128.

Return type:

yandex_music.R128

i: float#

tp: float#

class yandex_music.Ratings(month: int, week: int | None = None, day: int | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий рейтинг исполнителя.

month#

Значение ежемесячного рейтинга.

Type:: int

week#

Значение еженедельного рейтинга.

Type:: int, optional

day#

Значение дневного рейтинга.

Type:: int, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

day: int | None = None#

classmethod de_json(data: dict, client: Client) → Ratings | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Рейтинг исполнителя.

Return type:

yandex_music.Ratings

month: int#

week: int | None = None#

class yandex_music.RenewableRemainder(days: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий напоминания о продлении подписки.

Note

Присутствует только тогда, когда автопродление отключено.

days#

Количество дней (до окончания подписки, по всей видимости).

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

days: int#

classmethod de_json(data: dict, client: Client) → RenewableRemainder | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Напоминание о продлении подписки.

Return type:

yandex_music.PassportPhone

Bases: YandexMusicObject

Класс, представляющий ограничения для настроек станции.

language#

Перечисление значений для языков.

Type:: yandex_music.Enum

diversity#

Перечисление значений для разнообразия (треков).

Type:: yandex_music.Enum

mood#

Ограничение для значений настроения.

Type:: yandex_music.DiscreteScale, optional

energy#

Ограничение для значений энергичности.

Type:: yandex_music.DiscreteScale, optional

mood_energy#

Значения для настроения.

Type:: yandex_music.Enum, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Restrictions | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Ограничения для настроек станции.

Return type:

yandex_music.Restrictions

diversity: Enum | None#

energy: DiscreteScale | None = None#

language: Enum | None#

mood: DiscreteScale | None = None#

mood_energy: Enum | None = None#

class yandex_music.RotorSettings(language: str, diversity: str, mood: int | None = None, energy: int | None = None, mood_energy: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий настройки станции.

Note

Поля energy, mood используются в старых настройках (settings1).

Значения mood_energy: fun, active, calm, sad, all.

Значения diversity: favorite, popular, discover, default.

Значения language: not-russian, russian, any.

language#

Язык.

Type:: str

diversity#

Разнообразие (треки).

Type:: str

mood#

Настроение (старое).

Type:: int, optional

energy#

Энергичное.

Type:: int, optional

mood_energy#

Настроение.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → RotorSettings | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Настройки станции.

Return type:

yandex_music.RotorSettings

diversity: str#

energy: int | None = None#

language: str#

mood: int | None = None#

mood_energy: str | None = None#

Bases: YandexMusicObject

Класс, представляющий результаты поиска.

search_request_id#

ID запроса.

Type:: str

text#

Текст запроса.

Type:: str

best#

Лучший результат.

Type:: yandex_music.Best, optional

albums#

Найденные альбомы.

Type:: yandex_music.SearchResult, optional

artists#

Найденные исполнители.

Type:: yandex_music.SearchResult, optional

playlists#

Найденные плейлисты.

Type:: yandex_music.SearchResult, optional

tracks#

Найденные треки.

Type:: yandex_music.SearchResult, optional

videos#

Найденные видео.

Type:: yandex_music.SearchResult, optional

users#

Найденные пользователи.

Type:: yandex_music.SearchResult, optional

podcasts#

Найденные подкасты.

Type:: yandex_music.SearchResult, optional

podcast_episodes#

Найденные выпуски подкастов.

Type:: yandex_music.SearchResult, optional

type#

Тип результата по которому искали (аргумент в Client.search).

Type:: str

page#

Текущая страница.

Type:: int, optional

per_page#

Результатов на странице.

Type:: int, optional

misspell_result#

Запрос с автоматическим исправлением.

Type:: str, optional

misspell_original#

Оригинальный запрос.

Type:: str, optional

misspell_corrected#

Был ли исправлен запрос.

Type:: bool, optional

nocorrect#

Было ли отключено исправление результата.

Type:: bool, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

albums: SearchResult[Album] | None#

artists: SearchResult[Artist] | None#

best: Best | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Search | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Результаты поиска.

Return type:

yandex_music.Search

getPage(page: int, *args, **kwargs) → Search | None#: Псевдоним для get_page

async getPageAsync(page: int, *args, **kwargs) → Search | None#: Псевдоним для get_page_async

get_page(page: int, *args, **kwargs) → Search | None#

Получение определённой страницы поиска.

Parameters:

page (int) – Номер страницы.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница результата поиска или None.

Return type:

yandex_music.Search | None

async get_page_async(page: int, *args, **kwargs) → Search | None#

Получение определённой страницы поиска.

Parameters:

page (int) – Номер страницы.
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).

Returns:

Страница результата поиска или None.

Return type:

yandex_music.Search | None

misspell_corrected: bool | None = None#

misspell_original: str | None = None#

misspell_result: str | None = None#

nextPage(*args, **kwargs) → Search | None#: Псевдоним для next_page

async nextPageAsync(*args, **kwargs) → Search | None#: Псевдоним для next_page_async

next_page(*args, **kwargs) → Search | None#

Получение следующей страницы поиска.

Returns:: Следующая страница результата поиска или None.
Return type:: yandex_music.Search | None

async next_page_async(*args, **kwargs) → Search | None#

Получение следующей страницы поиска.

Returns:: Следующая страница результата поиска или None.
Return type:: yandex_music.Search | None

nocorrect: bool | None = None#

page: int | None = None#

per_page: int | None = None#

playlists: SearchResult[Playlist] | None#

podcast_episodes: SearchResult[Track] | None#

podcasts: SearchResult[Album] | None#

prevPage(*args, **kwargs) → Search | None#: Псевдоним для prev_page

async prevPageAsync(*args, **kwargs) → Search | None#: Псевдоним для prev_page_async

prev_page(*args, **kwargs) → Search | None#

Получение предыдущей страницы поиска.

Returns:: Предыдущая страница результата поиска или None.
Return type:: yandex_music.Search | None

async prev_page_async(*args, **kwargs) → Search | None#

Получение предыдущей страницы поиска.

Returns:: Предыдущая страница результата поиска или None.
Return type:: yandex_music.Search | None

search_request_id: str#

text: str#

tracks: SearchResult[Track] | None#

type: str | None = None#

users: SearchResult[User] | None#

videos: SearchResult[Video] | None#

class yandex_music.SearchResult(type: str, total: int, per_page: int, order: int, results: List[T], client: Client | None = None)#

Bases: YandexMusicObject, Generic[T]

Класс, представляющий результаты поиска.

Note

Значения поля type: track, artist, playlist, album, video.

type#

Тип результата.

Type:: str

total#

Количество результатов.

Type:: int

per_page#

Максимальное количество результатов на странице.

Type:: int

order#

Позиция блока.

Type:: int

results#

Результаты поиска.

Type:: list из yandex_music.Track | yandex_music.Artist | yandex_music.Album | yandex_music.Playlist | yandex_music.Video

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: Dict[str, Dict], client: Client, type_: str = None) → SearchResult | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
type (str, optional) – Тип результата.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Результаты поиска.

Return type:

yandex_music.SearchResult

order: int#

per_page: int#

results: List[T]#

total: int#

type: str#

class yandex_music.Sequence(type: str, track: Track | None, liked: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий звено последовательности.

Note

Известные значения поля type_: track. Возможно есть ad.

type#

Тип звена.

Type:: str

track#

Трек.

Type:: yandex_music.Track | None

liked#

Связанное ли.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Sequence | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Звено последовательности.

Return type:

yandex_music.Sequence

classmethod de_list(data: list, client: Client) → List[Sequence]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Последовательность треков.

Return type:

list из yandex_music.Sequence

liked: bool#

track: Track | None#

type: str#

class yandex_music.Settings(in_app_products: List[Product], native_products: List[Product], web_payment_url: str, promo_codes_enabled: bool, web_payment_month_product_price: Price | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий предложения по покупке.

in_app_products#

Продаваемые продукты внутри приложения.

Type:: list из yandex_music.Product

native_products#

Продаваемые продукты всплывающими окнами.

Type:: list

web_payment_url#

Ссылка для осуществления платежа.

Type:: str

web_payment_month_product_price#

Цена продукта за месяц.

Type:: yandex_music.Price, optional

promo_codes_enabled#

Доступно ли использование промо-кодов.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Settings | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Предложение по покупке.

Return type:

yandex_music.Settings

in_app_products: List[Product]#

native_products: List[Product]#

promo_codes_enabled: bool#

web_payment_month_product_price: Price | None = None#

web_payment_url: str#

class yandex_music.Shot(order: int, played: bool, shot_data: ShotData, shot_id: str, status: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий шот от Алисы.

Note

Известные значения поля status: ready.

order#

Порядковый номер при воспроизведении.

Type:: int

played#

Был ли проигран шот.

Type:: bool

shot_data#

Основная информация о шоте.

Type:: yandex_music.ShotData

shot_id#

Уникальный идентификатор шота.

Type:: str

status#

Статус шота.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Shot | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Шот от Алисы.

Return type:

yandex_music.Shot

classmethod de_list(data: list, client: Client) → List[Shot]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Шоты от Алисы.

Return type:

list из yandex_music.Shot

order: int#

played: bool#

shot_data: ShotData#

shot_id: str#

status: str#

class yandex_music.ShotData(cover_uri: str, mds_url: str, shot_text: str, shot_type: ShotType, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий основную информацию о шоте.

cover_uri#

Ссылка на обложку шота (иконка Алисы).

Type:: str

mds_url#

Ссылка на аудиоверсию шота в озвучке от Алисы.

Type:: str

shot_text#

Текстовая версия шота.

Type:: str

shot_type#

Тип шота.

Type:: yandex_music.ShotType

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

cover_uri: str#

classmethod de_json(data: dict, client: Client) → ShotData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Основная информация о шоте.

Return type:

yandex_music.ShotData

downloadCover(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover

async downloadCoverAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_async

downloadCoverBytes(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes

async downloadCoverBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes_async

downloadMds(filename: str) → None#: Псевдоним для download_mds

async downloadMdsAsync(filename: str) → None#: Псевдоним для download_mds_async

downloadMdsBytes() → bytes#: Псевдоним для download_mds_bytes

async downloadMdsBytesAsync() → bytes#: Псевдоним для download_mds_bytes_async

download_cover(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_cover_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_cover_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов
Return type:: bytes

async download_cover_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов
Return type:: bytes

download_mds(filename: str) → None#

Загрузка аудиоверсии шота.

Parameters:: filename (str) – Путь для сохранения файла с названием и расширением.

async download_mds_async(filename: str) → None#

Загрузка аудиоверсии шота.

Parameters:: filename (str) – Путь для сохранения файла с названием и расширением.

download_mds_bytes() → bytes#

Загрузка аудиоверсии шота и возврат в виде байтов.

Returns:: Аудиоверсия шота в виде байтов
Return type:: bytes

async download_mds_bytes_async() → bytes#

Загрузка аудиоверсии шота и возврат в виде байтов.

Returns:: Аудиоверсия шота в виде байтов
Return type:: bytes

getCoverUrl(size: str = '200x200') → str#: Псевдоним для get_cover_url

get_cover_url(size: str = '200x200') → str#

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

mds_url: str#

shot_text: str#

shot_type: ShotType#

class yandex_music.ShotEvent(event_id: str, shots: List[Shot], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий событие-шот перед началом следующего трека.

event_id#

Уникальный идентификатор события.

Type:: str

shots#

Шоты от Алисы.

Type:: list из yandex_music.Shot

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ShotEvent | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Событие-шот перед началом следующего трека.

Return type:

yandex_music.ShotEvent

event_id: str#

shots: List[Shot]#

class yandex_music.ShotType(id: str, title: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий тип шота от Алисы.

id#

Уникальный идентификатор типа.

Type:: str

title#

Заголовок шота.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → ShotType | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Тип шота от Алисы.

Return type:

yandex_music.ShotType

id: str#

title: str#

class yandex_music.SimilarTracks(track: Track | None, similar_tracks: List[Track], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий список похожих треков на другой трек.

track#

Трек.

Type:: yandex_music.Track

similar_tracks#

Похожие треки на track.

Type:: list из yandex_music.Track

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → SimilarTracks | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список похожих треков на другой трек.

Return type:

yandex_music.SimilarTracks

similar_tracks: List[Track]#

track: Track | None#

class yandex_music.Station(id: Id | None, name: str, icon: Icon, mts_icon: Icon, geocell_icon: Icon, id_for_from: str, restrictions: Restrictions, restrictions2: Restrictions, full_image_url: str | None = None, mts_full_image_url: str | None = None, parent_id: Id | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий станцию.

Note

id_for_from обозначает предка станции, например, жанр, настроение или занятие. Неизвестно когда используется id_for_from, а когда parent_id.

id#

Уникальный идентификатор станции.

Type:: yandex_music.Id

name#

Название станции.

Type:: str

icon#

Иконка станции.

Type:: yandex_music.Icon

mts_icon#

Иконка TODO.

Type:: yandex_music.Icon

geocell_icon#

Иконка TODO.

Type:: yandex_music.Icon

id_for_from#

Категория (тип) станции.

Type:: str

restrictions#

Ограничения для настроек станции старого формата.

Type:: yandex_music.Restrictions

restrictions2#

Ограничения для настроек станции.

Type:: yandex_music.Restrictions

full_image_url#

Ссылка на полное изображение.

Type:: str, optional

mts_full_image_url#

Ссылка на полную иконку.

Type:: str, optional

parent_id#

Уникальный идентификатор станции, являющейся предком текущей.

Type:: yandex_music.Id, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Station | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Станция.

Return type:

yandex_music.Station

full_image_url: str | None = None#

geocell_icon: Icon#

icon: Icon#

id: Id | None#

id_for_from: str#

mts_full_image_url: str | None = None#

mts_icon: Icon#

name: str#

parent_id: Id | None = None#

restrictions: Restrictions#

restrictions2: Restrictions#

class yandex_music.StationData(name: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий информацию о личной станции.

name#

Название станции.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → StationData | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация о личной станции.

Return type:

yandex_music.StationData

name: str#

Bases: YandexMusicObject

Класс, представляющий радиостанцию с настройками.

Note

Известные значения custom_name: Танцую, R’n’B, Отдыхаю, Просыпаюсь, Тренируюсь, В дороге, Работаю, Засыпаю.

station#

Станция.

Type:: yandex_music.Station | None

settings#

Первый набор настроек.

Type:: yandex_music.RotorSettings | None

settings2#

Второй набор настроек.

Type:: yandex_music.RotorSettings | None

ad_params#

Настройки рекламы.

Type:: yandex_music.AdParams | None

explanation#

TODO.

Type:: str, optional

prerolls#

Прероллы TODO.

Type:: list из str, optional

rup_title#

Название станции / Моя волна TODO.

Type:: str

rup_description#

Описание станции.

Type:: str

custom_name#

Название станции TODO.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

ad_params: AdParams | None#

client: Client | None = None#

custom_name: str | None = None#

classmethod de_json(data: dict, client: Client) → StationResult | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Радиостанция с настройками.

Return type:

yandex_music.StationResult

classmethod de_list(data: list, client: Client) → List[StationResult]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Радиостанции с настройками.

Return type:

list из yandex_music.StationResult

explanation: str | None = None#

prerolls: list | None = None#

rup_description: str = None#

rup_title: str = None#

settings: RotorSettings | None#

settings2: RotorSettings | None#

station: Station | None#

class yandex_music.StationTracksResult(id: Id | None, sequence: List[Sequence], batch_id: str, pumpkin: bool, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий последовательность треков станции.

id#

Уникальный идентификатор станции.

Type:: yandex_music.Id

sequence#

Последовательность треков.

Type:: list из yandex_music.Sequence

batch_id#

Уникальный идентификатор партии (последовательности).

Type:: str

pumpkin#

Хэллоуин.

Type:: bool

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

batch_id: str#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → StationTracksResult | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Последовательность треков станции.

Return type:

yandex_music.StationTracksResult

id: Id | None#

pumpkin: bool#

sequence: List[Sequence]#

Bases: YandexMusicObject

Класс, представляющий подробную информацию об аккаунте пользователя.

account#

Основная информация об аккаунте

Type:: yandex_music.Account

permissions#

Информация о правах пользователя.

Type:: yandex_music.Permissions

advertisement#

Рекламное объявление.

Type:: str, optional

subscription#

Информация о подписках.

Type:: yandex_music.Subscription, optional

cache_limit#

Максимальное количество загруженных треков.

Type:: int, optional

subeditor#

Наличие статуса модератора проверки корректности информации.

Type:: bool, optional

subeditor_level#

Уровень статуса модератора.

Type:: int, optional

plus#

Информация о Plus подписке.

Type:: yandex_music.Plus, optional

default_email#

Основной e-mail адрес аккаунта.

Type:: str, optional

skips_per_hour#

Количество переключение треков на радио в час.

Type:: int, optional

station_exists#

Наличие личной станции.

Type:: bool, optional

station_data#

Информация о личной станции.

Type:: yandex_music.StationData, optional

bar_below#

Блок с предупреждениями о конце подписке и подарках.

Type:: yandex_music.Alert, optional

premium_region#

Регион TODO.

Type:: int, optional

experiment#

Включенная новая фича на аккаунте (её ID) TODO.

Type:: int, optional

pretrial_active#

TODO.

Type:: bool, optional

userhash#

Хэш-код идентификатора пользователя.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

account: Account | None#

advertisement: str | None = None#

bar_below: Alert | None = None#

cache_limit: int | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Status | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация об аккаунте пользователя.

Return type:

yandex_music.Status

default_email: str | None = None#

experiment: int | None = None#

permissions: Permissions | None#

plus: Plus | None = None#

premium_region: int | None = None#

pretrial_active: bool | None = None#

skips_per_hour: int | None = None#

station_data: StationData | None = None#

station_exists: bool | None = None#

subeditor: bool | None = None#

subeditor_level: int | None = None#

subscription: Subscription | None = None#

userhash: str | None = None#

class yandex_music.Subscription(non_auto_renewable_remainder: RenewableRemainder, auto_renewable: List[AutoRenewable], family_auto_renewable: List[AutoRenewable], had_any_subscription: bool, operator: List[Operator] = None, non_auto_renewable: NonAutoRenewable | None = None, can_start_trial: bool | None = None, mcdonalds: bool | None = None, end: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий информацию о подписках пользователя.

non_auto_renewable_remainder#

Напоминание о продлении.

Type:: yandex_music.RenewableRemainder

auto_renewable#

Автопродление.

Type:: list из yandex_music.AutoRenewable, optional

family_auto_renewable#

Автопродление семейной подписки.

Type:: list из yandex_music.AutoRenewable

operator#

Услуги сотового оператора.

Type:: list из yandex_music.Operator, optional

non_auto_renewable#

Отключённое автопродление.

Type:: yandex_music.NonAutoRenewable, optional

can_start_trial#

Есть ли возможность начать пробный период.

Type:: bool, optional

mcdonalds#

mcdonalds TODO.

Type:: bool, optional

end#

Дата окончания.

Type:: str, optional

had_any_subscription (: obj:’bool’): Наличие какой-либо подписки в прошлом.

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

auto_renewable: List[AutoRenewable]#

can_start_trial: bool | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Subscription | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Информация о подписках пользователя.

Return type:

yandex_music.Subscription

end: str | None = None#

family_auto_renewable: List[AutoRenewable]#

had_any_subscription: bool#

mcdonalds: bool | None = None#

non_auto_renewable: NonAutoRenewable | None = None#

non_auto_renewable_remainder: RenewableRemainder#

operator: List[Operator] = None#

class yandex_music.Suggestions(best: Best | None, suggestions: List[str], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий подсказки при поиске.

best#

Лучший результат.

Type:: yandex_music.Best

suggestions#

Список подсказок-дополнений для поискового запроса.

Type:: list из str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

best: Best | None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Suggestions | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Подсказки при поиске.

Return type:

yandex_music.Suggestions

suggestions: List[str]#

class yandex_music.Supplement(id: int, lyrics: Lyrics | None, videos: List[VideoSupplement], radio_is_available: bool = None, description: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий дополнительную информацию о треке.

Warning

Получение текста из дополнительной информации устарело. Используйте yandex_music.Client.tracks_lyrics().

id#

Уникальный идентификатор дополнительной информации.

Type:: int

lyrics#

Текст песни.

Type:: yandex_music.Lyrics

videos#

Видео.

Type:: yandex_music.VideoSupplement

radio_is_available#

Доступно ли радио.

Type:: bool, optional

description#

Полное описание эпизода подкаста.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Supplement | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Дополнительная информация о треке.

Return type:

yandex_music.Supplement

description: str | None = None#

id: int#

lyrics: Lyrics | None#

radio_is_available: bool = None#

videos: List[VideoSupplement]#

class yandex_music.Tag(id: str, value: str, name: str, og_description: str, og_image: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий тег (подборку).

id#

Уникальный идентификатор тега.

Type:: str

value#

Значение тега (название в lower case).

Type:: str

name#

Название тега (отображаемое).

Type:: str

og_description#

Описание тега для OpenGraph.

Type:: str

og_image#

Ссылка на изображение для OpenGraph.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Tag | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Тег.

Return type:

yandex_music.Tag

id: str#

name: str#

og_description: str#

og_image: str | None = None#

value: str#

class yandex_music.TagResult(tag: str, ids: List[PlaylistId], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий тег и его плейлисты.

tag#

Тег.

Type:: yandex_music.Tag

ids#

Уникальные идентификаторы плейлистов тега.

Type:: list из yandex_music.PlaylistId

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TagResult | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Тег и его плейлисты.

Return type:

yandex_music.TagResult

ids: List[PlaylistId]#

tag: str#

class yandex_music.Title(title: str, full_title: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий заголовок жанра.

title#

Заголовок.

Type:: str

full_title#

Полный заголовок.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_dict(data: dict, client: Client) → Dict[str, Title | None]#

Десериализация списка объектов.

Parameters:

data (dict) – Словарь с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Заголовки жанров.

Return type:

dict где ключ это язык str, а значение yandex_music.Title

classmethod de_json(data: dict, client: Client) → Title | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Заголовок жанра.

Return type:

yandex_music.Title

full_title: str | None = None#

title: str#

Bases: YandexMusicObject

Класс, представляющий трек.

Note

Известные значения поля content_warning: explicit.

Известные значения поля type: music.

Известные значения поля track_sharing_flag: VIDEO_ALLOWED, COVER_ONLY.

Известные значения поля track_source: OWN, OWN_REPLACED_TO_UGC.

Известные значения поля available_for_options: bookmate.

Поля can_publish, state, desired_visibility, filename, user_info доступны только у треков что были загружены пользователем.

Обычно у подкастов поле remember_position == True, а у треков remember_position == False.

Полное описание можно получить используя Track.get_supplement().

id#

Уникальный идентификатор.

Type:: int | str

title#

Название.

Type:: str, optional

available#

Доступен ли для прослушивания.

Type:: bool, optional

artists#

Исполнители.

Type:: list из yandex_music.Artist, optional

albums#

Альбомы.

Type:: list из yandex_music.Album, optional

available_for_premium_users#

Доступен ли для пользователей с подпиской.

Type:: bool, optional

lyrics_available#

Доступен ли текст песни.

Type:: bool, optional

poetry_lover_matches#

Список слов TODO.

Type:: list из yandex_music.PoetryLoverMatch, optional

best#

Лучшей ли трек TODO.

Type:: bool, optional

real_id#

TODO.

Type:: int | str, optional

og_image#

Ссылка на превью Open Graph.

Type:: str, optional

type#

Тип.

Type:: str, optional

cover_uri#

Ссылка на изображение с обложкой.

Type:: str, optional

major#

Мейджор-лейбл.

Type:: yandex_music.Major, optional

duration_ms#

Длительность трека в миллисекундах.

Type:: int, optional

storage_dir#

В какой папке на сервере хранится файл TODO.

Type:: str, optional

file_size#

Размер файла. TODO добавить единицу измерения.

Type:: int, optional

substituted#

Замещённый трек.

Type:: yandex_music.Track, optional

matched_track#

Соответствующий трек TODO.

Type:: yandex_music.Track, optional

normalization#

Значения для нормализации трека.

Type:: list из yandex_music.Normalization, optional

error#

Сообщение об ошибке.

Type:: str, optional

can_publish#

Может ли быть опубликован.

Type:: bool, optional

state#

Состояние, например, playable.

Type:: str, optional

desired_visibility#

Видимость трека.

Type:: str, optional

filename#

Название файла.

Type:: str, optional

user_info#

Информация о пользователе, который загрузил трек.

Type:: yandex_music.User, optional

meta_data#

Информация о метаданных трека.

Type:: yandex_music.MetaData, optional

regions#

Регион TODO.

Type:: list из str, optional

available_as_rbt#

TODO.

Type:: bool, optional

content_warning#

Тип откровенного контента.

Type:: str, optional

explicit#

Содержит ли откровенный контент.

Type:: bool, optional

preview_duration_ms#

TODO.

Type:: int, optional

available_full_without_permission#

Доступен ли без подписки.

Type:: bool, optional

version#

Версия.

Type:: str, optional

remember_position#

Если True, то запоминается последняя позиция прослушивания, иначе позиция не запоминается.

Type:: bool, optional

background_video_uri#

Ссылка на видеошот.

Type:: str, optional

short_description#

Краткое описание эпизода подкаста.

Type:: str, optional

is_suitable_for_children#

Подходит ли для детей TODO.

Type:: bool, optional

track_source#

Источник трека.

Type:: str, optional

available_for_options#

Возможные опции для трека.

Type:: list из str, optional

r128#

Параметры нормализации громкости трека в соответствии с рекомендацией EBU R 128.

Type:: yandex_music.R128, optional

lyrics_info#

Данные о наличии текстов трека.

Type:: yandex_music.LyricsInfo, optional

track_sharing_flag#

TODO.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client

albums: List[Album] = None#

artists: List[Artist] = None#

artistsName() → List[str]#: Псевдоним для artists_name

artists_name() → List[str]#

Получает имена всех исполнителей.

Returns:: Имена исполнителей.
Return type:: list из str

available: bool | None = None#

available_as_rbt: bool | None = None#

available_for_options: List[str] | None = None#

available_for_premium_users: bool | None = None#

available_full_without_permission: bool | None = None#

background_video_uri: str | None = None#

best: bool | None = None#

can_publish: bool | None = None#

client: Client | None = None#

content_warning: str | None = None#

cover_uri: str | None = None#

classmethod de_json(data: dict, client: Client) → Track | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Трек.

Return type:

yandex_music.Track

classmethod de_list(data: list, client: Client) → List[Track]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Треки.

Return type:

list из yandex_music.Track

desired_visibility: str | None = None#

dislike(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_tracks_remove(track.id, user.id *args, **kwargs)

async dislikeAsync(*args, **kwargs) → bool#: Псевдоним для dislike_async

async dislike_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_tracks_remove(track.id, user.id *args, **kwargs)

download(filename: str, codec: str = 'mp3', bitrate_in_kbps: int = 192) → None#

Загрузка трека.

Note

Известные значения codec: mp3, aac.

Известные значения bitrate_in_kbps: 64, 128, 192, 320.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Raises:

yandex_music.exceptions.InvalidBitrateError – Если в self.download_info не найден подходящий трек.

async downloadAsync(filename: str, codec: str = 'mp3', bitrate_in_kbps: int = 192) → None#: Псевдоним для download_async

downloadBytes(codec: str = 'mp3', bitrate_in_kbps: int = 192) → bytes#: Псевдоним для download_bytes

async downloadBytesAsync(codec: str = 'mp3', bitrate_in_kbps: int = 192) → bytes#: Псевдоним для download_bytes_async

downloadCover(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover

async downloadCoverAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_cover_async

downloadCoverBytes(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes

async downloadCoverBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_cover_bytes_async

downloadOgImage(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image

async downloadOgImageAsync(filename: str, size: str = '200x200') → None#: Псевдоним для download_og_image_async

downloadOgImageBytes(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes

async downloadOgImageBytesAsync(size: str = '200x200') → bytes#: Псевдоним для download_og_image_bytes_async

async download_async(filename: str, codec: str = 'mp3', bitrate_in_kbps: int = 192) → None#

Загрузка трека.

Note

Известные значения codec: mp3, aac.

Известные значения bitrate_in_kbps: 64, 128, 192, 320.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Raises:

yandex_music.exceptions.InvalidBitrateError – Если в self.download_info не найден подходящий трек.

download_bytes(codec: str = 'mp3', bitrate_in_kbps: int = 192) → bytes#

Загрузка трека и возврат в виде байтов.

Note

Известные значения codec: mp3, aac.

Известные значения bitrate_in_kbps: 64, 128, 192, 320.

Parameters:

codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Raises:

yandex_music.exceptions.InvalidBitrateError – Если в self.download_info не найден подходящий трек.

Returns:

Трек в виде байтов.

Return type:

bytes

async download_bytes_async(codec: str = 'mp3', bitrate_in_kbps: int = 192) → bytes#

Загрузка трека и возврат в виде байтов.

Note

Известные значения codec: mp3, aac.

Известные значения bitrate_in_kbps: 64, 128, 192, 320.

Parameters:

codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Raises:

yandex_music.exceptions.InvalidBitrateError – Если в self.download_info не найден подходящий трек.

Returns:

Трек в виде байтов.

Return type:

bytes

download_cover(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_cover_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_cover_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_cover_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

download_og_image(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Предпочтительнее использовать self.download_cover().

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

async download_og_image_async(filename: str, size: str = '200x200') → None#

Загрузка обложки.

Предпочтительнее использовать self.download_cover_async().

Parameters:

filename (str) – Путь для сохранения файла с названием и расширением.
size (str, optional) – Размер обложки.

download_og_image_bytes(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Предпочтительнее использовать self.download_cover().

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

async download_og_image_bytes_async(size: str = '200x200') → bytes#

Загрузка обложки и возврат в виде байтов.

Предпочтительнее использовать self.download_cover_async().

Parameters:: size (str, optional) – Размер обложки.
Returns:: Обложка в виде байтов.
Return type:: bytes

duration_ms: int | None = None#

error: str | None = None#

explicit: bool | None = None#

file_size: int | None = None#

filename: str | None = None#

getCoverUrl(size: str = '200x200') → str#: Псевдоним для get_cover_url

getDownloadInfo(get_direct_links: bool = False) → List[DownloadInfo]#: Псевдоним для get_download_info

async getDownloadInfoAsync(get_direct_links: bool = False) → List[DownloadInfo]#: Псевдоним для get_download_info_async

getLyrics(*args, **kwargs) → TrackLyrics | None#: Псевдоним для get_lyrics

async getLyricsAsync(*args, **kwargs) → TrackLyrics | None#: Псевдоним для get_lyrics_async

getOgImageUrl(size: str = '200x200') → str#: Псевдоним для get_og_image_url

getSpecificDownloadInfo(codec: str, bitrate_in_kbps: int) → DownloadInfo | None#: Псевдоним для get_specific_download_info

async getSpecificDownloadInfoAsync(codec: str, bitrate_in_kbps: int) → DownloadInfo | None#: Псевдоним для get_specific_download_info_async

getSupplement(*args, **kwargs) → Supplement | None#: Псевдоним для get_supplement

async getSupplementAsync(*args, **kwargs) → Supplement | None#: Псевдоним для get_supplement_async

get_cover_url(size: str = '200x200') → str#

Возвращает URL обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

get_download_info(get_direct_links: bool = False) → List[DownloadInfo]#

Сокращение для:

client.tracks_download_info(self.track_id, get_direct_links)

async get_download_info_async(get_direct_links: bool = False) → List[DownloadInfo]#

Сокращение для:

await client.tracks_download_info(self.track_id, get_direct_links)

get_lyrics(*args, **kwargs) → TrackLyrics | None#

Сокращение для:

client.tracks_lyrics(track.id, *args, **kwargs)

async get_lyrics_async(*args, **kwargs) → TrackLyrics | None#

Сокращение для:

client.tracks_lyrics(track.id, *args, **kwargs)

get_og_image_url(size: str = '200x200') → str#

Возвращает URL OG обложки.

Parameters:: size (str, optional) – Размер обложки.
Returns:: URL обложки.
Return type:: str

get_specific_download_info(codec: str, bitrate_in_kbps: int) → DownloadInfo | None#

Возвращает вариант загрузки по критериям.

Parameters:

codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Returns:

Вариант загрузки трека или None.

Return type:

yandex_music.DownloadInfo | None

async get_specific_download_info_async(codec: str, bitrate_in_kbps: int) → DownloadInfo | None#

Возвращает вариант загрузки по критериям.

Parameters:

codec (str, optional) – Кодек из доступных в self.download_info.
bitrate_in_kbps (int, optional) – Битрейт из доступных в self.download_info для данного кодека.

Returns:

Вариант загрузки трека или None.

Return type:

yandex_music.DownloadInfo | None

get_supplement(*args, **kwargs) → Supplement | None#

Сокращение для:

client.track_supplement(track.id, *args, **kwargs)

async get_supplement_async(*args, **kwargs) → Supplement | None#

Сокращение для:

await client.track_supplement(track.id, *args, **kwargs)

id: str | int#

is_suitable_for_children: bool | None = None#

like(*args, **kwargs) → bool#

Сокращение для:

client.users_likes_tracks_add(track.id, user.id, *args, **kwargs)

async likeAsync(*args, **kwargs) → bool#: Псевдоним для like_async

async like_async(*args, **kwargs) → bool#

Сокращение для:

await client.users_likes_tracks_add(track.id, user.id, *args, **kwargs)

lyrics_available: bool | None = None#

lyrics_info: LyricsInfo | None = None#

major: Major | None = None#

matched_track: Track | None = None#

meta_data: MetaData | None = None#

normalization: Normalization | None = None#

og_image: str | None = None#

poetry_lover_matches: List[PoetryLoverMatch] = None#

preview_duration_ms: int | None = None#

r128: R128 | None = None#

real_id: str | int | None = None#

regions: List[str] | None = None#

remember_position: bool | None = None#

short_description: str | None = None#

state: str | None = None#

storage_dir: str | None = None#

substituted: Track | None = None#

title: str | None = None#

property trackId: str#: Псевдоним для track_id

property track_id: str#

Уникальный идентификатор трека состоящий из его номера и номера альбома или просто из номера.

Type:: str

track_sharing_flag: str | None = None#

track_source: str | None = None#

type: str | None = None#

user_info: User | None = None#

version: str | None = None#

Bases: YandexMusicObject

Класс, представляющий уникальный идентификатор трека.

Note

Поле track_id используется только у объектах полученных через очередь треков. В остальные случаях id.

Поле from_ есть только у объект, которые используются в очереди треков.

id#

Уникальный идентификатор трека.

Type:: int

track_id#

Уникальный идентификатор трека.

Type:: int

album_id#

Уникальный идентификатор альбома.

Type:: int, optional

from_#

Откуда был получен этот объект.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

album_id: int | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackId | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Уникальный идентификатор трека.

Return type:

yandex_music.TrackId

classmethod de_list(data: list, client: Client) → List[TrackId]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Уникальные идентификаторы треков.

Return type:

list из yandex_music.TrackId

fetchTrack(*args, **kwargs) → Track#: Псевдоним для fetch_track

async fetchTrackAsync(*args, **kwargs) → Track#: Псевдоним для fetch_track_async

fetch_track(*args, **kwargs) → Track#

Получение полной версии трека.

Returns:: Полная версия.
Return type:: yandex_music.Track

async fetch_track_async(*args, **kwargs) → Track#

Получение полной версии трека.

Returns:: Полная версия.
Return type:: yandex_music.Track

from_: str | None = None#

id: int | None = None#

property trackFullId: str#: Псевдоним для track_full_id

property track_full_id: str#

ID трека состоящий из его номера и номера альбома.

Type:: str

track_id: int | None = None#

class yandex_music.TrackLyrics(download_url: str, lyric_id: int, external_lyric_id: str, writers: List[str], major: LyricsMajor, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий текст трека.

download_url#

Ссылка на скачивание текста.

Type:: str

lyric_id#

Уникальный идентификатор текста.

Type:: int

external_lyric_id#

Уникальный идентификатор текста на сервисе предоставляющий текст.

Type:: str

writers#

Авторы текста.

Type:: list из str

major#

Сервис, откуда был получен текст.

Type:: yandex_music.LyricsMajor

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackLyrics | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Текст трека.

Return type:

yandex_music.TrackLyrics

download_url: str#

external_lyric_id: str#

fetchLyrics() → str#: Псевдоним для fetch_lyrics

async fetchLyricsAsync() → str#: Псевдоним для fetch_lyrics_async

fetch_lyrics() → str#

Получает текст песни по ссылке yandex_music.TrackLyrics.download_url.

Returns:: Текст песни.
Return type:: str

async fetch_lyrics_async() → str#

Получает текст песни по ссылке yandex_music.TrackLyrics.download_url.

Returns:: Текст песни.
Return type:: str

lyric_id: int#

major: LyricsMajor#

writers: List[str]#

class yandex_music.TrackPosition(volume: int, index: int, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий позицию трека.

Note

Позиция трека в альбоме, который возвращается при получении самого трека.

Volume на фронте именуется как “Диск”.

volume#

Номер альбома.

Type:: int

index#

Порядковый номер трека.

Type:: int

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackPosition | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Позиция трека.

Return type:

yandex_music.TrackPosition

index: int#

volume: int#

Bases: YandexMusicObject

Класс, представляющий укороченную версию трека с неполными данными.

Note

Поля chart и track только у треков, полученных через метод chart().

id#

Уникальный идентификатор трека.

Type:: str

timestamp#

Дата TODO.

Type:: str

album_id#

Уникальный идентификатор альбома.

Type:: str, optional

play_count#

Количество проигрываний.

Type:: int, optional

recent#

Недавний.

Type:: bool, optional

chart#

Позиция в чарте.

Type:: yandex_music.Chart, optional

track#

Полная версия трека.

Type:: yandex_music.Track, optional

original_index#

Индекс в плейлисте или альбоме. TODO уточнить про альбом.

Type:: int, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

album_id: str | None = None#

chart: Chart | None = None#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackShort | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Укороченная версия трека с неполными данными.

Return type:

yandex_music.TrackShort

classmethod de_list(data: list, client: Client) → List[TrackShort]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Укороченные версии треков с неполными данными.

Return type:

list из yandex_music.TrackShort

fetchTrack() → Track#: Псевдоним для fetch_track

async fetchTrackAsync() → Track#: Псевдоним для fetch_track_async

fetch_track() → Track#

Получение полной версии трека.

Returns:: Полная версия трека.
Return type:: yandex_music.Track

async fetch_track_async() → Track#

Получение полной версии трека.

Returns:: Полная версия трека.
Return type:: yandex_music.Track

id: str | int#

original_index: int | None = None#

play_count: int | None = None#

recent: bool | None = None#

timestamp: str#

track: Track | None = None#

property trackId: str#: Псевдоним для track_id

property track_id: str#

Уникальный идентификатор трека состоящий из его номера и номера альбома или просто из номера.

Type:: str

class yandex_music.TrackShortOld(track_id: TrackId | None, timestamp: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий сокращённую версию трека.

Note

Данная версия менее богата полями и найдена позже первой, поэтому была принята как за старую версию.

Другая версия сокращённого трека: yandex_music.TrackShort.

track_id#

Уникальный идентификатор трека.

Type:: yandex_music.TrackId

timestamp#

Дата TODO.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackShortOld | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Сокращённая версия трека или None.

Return type:

yandex_music.TrackShortOld

classmethod de_list(data: list, client: Client) → List[TrackShortOld]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Сокращённые версии треков.

Return type:

list из yandex_music.TrackShortOld

timestamp: str#

track_id: TrackId | None#

class yandex_music.TrackWithAds(type: str, track: Track | None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий трек с рекламой.

Note

Поле type встречалось только с значением track.

type#

Тип TODO.

Type:: str

track#

Трек.

Type:: yandex_music.Track

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TrackWithAds | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Трек с рекламой.

Return type:

yandex_music.TrackWithAds

classmethod de_list(data: list, client: Client) → List[TrackWithAds]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Треки с рекламой.

Return type:

list из yandex_music.TrackWithAds

track: Track | None#

type: str#

class yandex_music.TracksList(uid: int, revision: int, tracks: List[TrackShort], client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий список треков.

uid#

Уникальный идентификатор пользователя.

Type:: int

revision#

Актуальность данных TODO.

Type:: int

tracks#

Список треков в укороченной версии.

Type:: list из yandex_music.TrackShort

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → TracksList | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Список треков.

Return type:

yandex_music.TracksList

fetchTracks() → List[Track]#: Псевдоним для fetch_tracks

async fetchTracksAsync() → List[Track]#: Псевдоним для fetch_tracks_async

fetch_tracks() → List[Track]#

Получение полных версии треков.

Returns:: Полная версия трека.
Return type:: list из yandex_music.Track

async fetch_tracks_async() → List[Track]#

Получение полных версии треков.

Returns:: Полная версия трека.
Return type:: list из yandex_music.Track

revision: int#

tracks: List[TrackShort]#

property tracksIds: List[str]#: Псевдоним для tracks_ids

property tracks_ids: List[str]#

Список уникальных идентификаторов треков.

Type:: list из str

uid: int#

Bases: YandexMusicObject

Класс, представляющий пользователя.

Note

Когда данный класс используется в MadeFor и Playlist, то доступны все поля кроме `display_name и full_name.

При наличии экземпляра класса в user_info у Track (у самозагруженных треков) доступны только uid, ‘login, ‘display_name` и full_name.

Поле regions есть только при возвращении пользователей в результатах поисках.

uid#

Идентификатор пользователя.

Type:: int

login#

Логин пользователя.

Type:: str

name#

Имя пользователя.

Type:: str, optional

display_name#

Отображаемое пользователя.

Type:: str, optional

full_name#

Полное имя пользователя.

Type:: str, optional

sex#

Пол пользователя.

Type:: str, optional

verified#

Участвует ли пользователь в генерации плейлистов дня и т.д., и т.п.

Type:: bool, optional

regions#

Список регионов TODO.

Type:: list из int, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → User | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Пользователь.

Return type:

yandex_music.User

classmethod de_list(data: list, client: Client) → List[User]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Пользователи.

Return type:

list из yandex_music.User

display_name: str | None = None#

full_name: str | None = None#

login: str#

name: str | None = None#

regions: List[int] = None#

sex: str | None = None#

uid: int#

verified: bool | None = None#

class yandex_music.UserSettings(uid: int, last_fm_scrobbling_enabled: bool, shuffle_enabled: bool, volume_percents: int, modified: str, facebook_scrobbling_enabled: bool, add_new_track_on_playlist_top: bool, user_music_visibility: str, user_social_visibility: str, rbt_disabled: bool, theme: str, promos_disabled: bool, auto_play_radio: bool, sync_queue_enabled: bool, ads_disabled: bool | None = None, disk_enabled: bool | None = None, show_disk_tracks_in_library: bool | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий настройки пользователя.

Note

Доступные значения для поля theme: white, black.

Доступные значения для полей user_music_visibility и user_social_visibility: private, public.

Note

promos_disabled, ads_disabled, rbt_disabled устарели и не работают.

last_fm_scrobbling_enabled, facebook_scrobbling_enabled выглядят устаревшими.

uid#

Уникальный идентификатор пользователя.

Type:: int

last_fm_scrobbling_enabled#

Скробблинг lastfm.

Type:: bool

shuffle_enabled#

Переключать треки в случайном порядке.

Type:: bool

volume_percents#

Громкость звука в процентах.

Type:: int

modified#

Дата изменения настроек.

Type:: str

facebook_scrobbling_enabled#

Скробблинг facebook.

Type:: bool

add_new_track_on_playlist_top#

Добавлять новые треки в начало плейлиста.

Type:: bool

user_music_visibility#

Публичный доступ к моей фонотеке.

Type:: str

user_social_visibility#

Показывать соцсети на странице.

Type:: str

rbt_disabled#

TODO (неиспользуемая фича).

Type:: bool

theme#

Тема оформления.

Type:: str

promos_disabled#

Не показывать рекламируемый контент).

Type:: bool

auto_play_radio#

Бесконечный поток музыки.

Type:: bool

sync_queue_enabled#

Синхронизация очередей между устройствами.

Type:: bool

ads_disabled#

Не показывать рекламу.

Type:: bool, optional

disk_enabled#

TODO.

Type:: bool, optional

show_disk_tracks_in_library#

Показывать локальные треки в библиотеке.

Type:: bool, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

add_new_track_on_playlist_top: bool#

ads_disabled: bool | None = None#

auto_play_radio: bool#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → UserSettings | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Настройки пользователя.

Return type:

yandex_music.UserSettings

disk_enabled: bool | None = None#

facebook_scrobbling_enabled: bool#

last_fm_scrobbling_enabled: bool#

modified: str#

promos_disabled: bool#

rbt_disabled: bool#

show_disk_tracks_in_library: bool | None = None#

shuffle_enabled: bool#

sync_queue_enabled: bool#

theme: str#

uid: int#

user_music_visibility: str#

user_social_visibility: str#

volume_percents: int#

class yandex_music.Value(value: str, name: str, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий значение(переменную).

value#

Значение.

Type:: str

name#

Название.

Type:: str

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Value | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Значение.

Return type:

yandex_music.Value

classmethod de_list(data: list, client: Client) → List[Value]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Значения.

Return type:

list из yandex_music.Value

name: str#

value: str#

Bases: YandexMusicObject

Класс, представляющий видео.

title#

Название видео.

Type:: str

cover#

Ссылка на изображение.

Type:: str, optional

embed_url#

Ссылка на видео.

Type:: str, optional

provider#

Провайдер видео.

Type:: str, optional

provider_video_id#

Идентификатор видео.

Type:: int | str, optional

youtube_url#

Ссылка на видео Youtube.

Type:: str, optional

thumbnail_url#

Ссылка на изображение.

Type:: str, optional

duration#

Длительность видео в секундах.

Type:: int, optional

text#

Текст.

Type:: str, optional

html_auto_play_video_player#

HTML тег для встраивания в разметку страницы.

Type:: str, optional

regions#

Регион TODO.

Type:: list из str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

cover: str | None = None#

classmethod de_json(data: dict, client: Client) → Video | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client) – Клиент Yandex Music.

Returns:

Видео.

Return type:

yandex_music.Video

classmethod de_list(data: list, client: Client) → List[Video]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client) – Клиент Yandex Music.

Returns:

Видео.

Return type:

list из yandex_music.Video

duration: int | None = None#

embed_url: str | None = None#

html_auto_play_video_player: str | None = None#

provider: str | None = None#

provider_video_id: str | int | None = None#

regions: List[str] | None = None#

text: str | None = None#

thumbnail_url: str | None = None#

title: str#

youtube_url: str | None = None#

Bases: YandexMusicObject

Класс, представляющий видеоклипы.

cover#

URL на обложку видео.

Type:: str

provider#

Сервис поставляющий видео.

Type:: str

title#

Название видео.

Type:: str, optional

provider_video_id#

Уникальный идентификатор видео на сервисе.

Type:: str, optional

url#

URL на видео.

Type:: str, optional

embed_url#

URL на видео, находящегося на серверах Яндекса.

Type:: str, optional

embed#

HTML тег для встраивания видео.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

client: Client | None = None#

cover: str#

classmethod de_json(data: dict, client: Client) → VideoSupplement | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Видеоклип.

Return type:

yandex_music.VideoSupplement

classmethod de_list(data: list, client: Client) → List[VideoSupplement]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Видеоклипы.

Return type:

list из yandex_music.VideoSupplement

embed: str | None = None#

embed_url: str | None = None#

provider: str#

provider_video_id: str | None = None#

title: str | None = None#

url: str | None = None#

class yandex_music.Vinyl(url: str, title: str, year: int, price: int, media: str, offer_id: int, artist_ids: List[int], picture: str | None = None, client: Client | None = None)#

Bases: YandexMusicObject

Класс, представляющий виниловую пластинку.

url#

Ссылка на пластинку в магазине.

Type:: str

title#

Заголовок.

Type:: str

year#

Год выпуска.

Type:: int

price#

Цена.

Type:: int

media#

Средство распространения.

Type:: str

offer_id#

Уникальный идентификатор предложения.

Type:: int

artist_ids#

Перечень уникальный идентификаторов исполнителей.

Type:: list из int

picture#

Ссылка на обложку.

Type:: str, optional

client#

Клиент Yandex Music.

Type:: yandex_music.Client, optional

\*\*kwargs: Произвольные ключевые аргументы полученные от API.

artist_ids: List[int]#

client: Client | None = None#

classmethod de_json(data: dict, client: Client) → Vinyl | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Ваниловая пластинка.

Return type:

yandex_music.Vinyl

classmethod de_list(data: list, client: Client) → List[Vinyl]#

Десериализация списка объектов.

Parameters:

data (list) – Список словарей с полями и значениями десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

Ваниловые пластинки.

Return type:

list из yandex_music.Vinyl

media: str#

offer_id: int#

picture: str | None = None#

price: int#

title: str#

url: str#

year: int#

class yandex_music.YandexMusicObject#

Bases: object

Базовый класс для всех объектов библиотеки.

classmethod de_json(data: dict, client: Client | None) → dict | None#

Десериализация объекта.

Parameters:

data (dict) – Поля и значения десериализуемого объекта.
client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns:

yandex_music.YandexMusicObject или None.

Return type:

yandex_music.YandexMusicObject | None

static is_valid_model_data(data: Any, *, array: bool = False) → bool#

Проверка на валидность данных.

Parameters:

data (Any) – Данные для проверки.
array (bool, optional) – Является ли объект массивом.

Returns:

Валидны ли данные.

Return type:

bool

static report_unknown_fields_callback(cls: type, unknown_fields: dict) → None#: Обратный вызов для обработки неизвестных полей.

to_dict(for_request: bool = False) → dict#

Рекурсивная сериализация объекта.

Parameters:: for_request (bool) – Перевести ли обратно все поля в camelCase и игнорировать зарезервированные слова.

Note

Исключает из сериализации client и _id_attrs необходимые в __eq__.

К зарезервированным словам добавляет “_” в конец.

Returns:: Сериализованный в dict объект.
Return type:: dict

to_json(for_request: bool = False) → str#

Сериализация объекта.

Parameters:: for_request (bool) – Подготовить ли объект для отправки в теле запроса.
Returns:: Сериализованный в JSON объект.
Return type:: str

yandex_music#

Subpackages#

Submodules#