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: ~typing.List[PassportPhone] = <factory>, registered_at: str | None = None, has_info_for_app_metrica: bool | None = None, child: bool | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий основную информацию об аккаунте пользователя.
- 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 = None¶
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Account | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Основная информация об аккаунте пользователя.
- Return type:
- display_name: str | None = None¶
- first_name: str | None = None¶
- full_name: str | None = None¶
- has_info_for_app_metrica: bool | None = None¶
- hosted_user: bool | None = None¶
- login: str | None = None¶
- now: str¶
- passport_phones: List[PassportPhone]¶
- region: int | None = None¶
- registered_at: str | None = None¶
- second_name: str | None = None¶
- service_available: bool¶
- uid: int | None = None¶
- class yandex_music.AdParams(partner_id: str | int, category_id: str | int, page_ref: str, target_ref: str, other_params: str, ad_volume: int, genre_id: str | None = None, genre_name: str | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий параметры рекламного объявления.
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: ClientType | None = None¶
- genre_id: str | None = None¶
- genre_name: str | None = None¶
- other_params: str¶
- page_ref: str¶
- partner_id: str | int¶
- target_ref: str¶
- class yandex_music.Album(id: int | None = None, error: str | None = None, title: str | None = None, track_count: int | None = None, artists: ~typing.List[Artist] = <factory>, labels: ~typing.List[Label] | ~typing.List[str] = <factory>, available: bool | None = None, available_for_premium_users: bool | None = None, version: str | None = None, cover_uri: str | None = None, content_warning: str | None = None, original_release_year: ~typing.Any = None, genre: str | None = None, text_color: str | None = None, short_description: str | None = None, description: str | None = None, is_premiere: bool | None = None, is_banner: bool | None = None, meta_type: str | None = None, storage_dir: str | None = None, og_image: str | None = None, buy: list | None = None, recent: bool | None = None, very_important: bool | None = None, available_for_mobile: bool | None = None, available_partially: bool | None = None, bests: ~typing.List[int] | None = None, duplicates: ~typing.List[Album] = <factory>, prerolls: list | None = None, volumes: ~typing.List[~typing.List[Track]] | None = None, year: int | None = None, release_date: str | None = None, type: str | None = None, track_position: TrackPosition | None = None, regions: ~typing.List[str] | None = None, available_as_rbt: bool | None = None, lyrics_available: bool | None = None, remember_position: bool | None = None, albums: ~typing.List[Album] | None = None, duration_ms: int | None = None, explicit: bool | None = None, start_date: str | None = None, likes_count: int | None = None, deprecation: Deprecation | None = None, available_regions: ~typing.List[str] | None = None, available_for_options: ~typing.List[str] | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий альбом.
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
Доступен ли альбом для пользователей с подпиской.
- 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
- 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
- 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: ClientType | None = None¶
- content_warning: str | None = None¶
- cover_uri: str | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Album | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Альбом.
- Return type:
- deprecation: Deprecation | None = None¶
- description: str | None = None¶
- dislike(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
client.users_likes_albums_remove(album.id, user.id *args, **kwargs)
- async dislikeAsync(*args: Any, **kwargs: Any) bool ¶
Псевдоним для
dislike_async
- async dislike_async(*args: Any, **kwargs: Any) 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
- 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¶
- like(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
client.users_likes_albums_add(album.id, user.id *args, **kwargs)
- async likeAsync(*args: Any, **kwargs: Any) bool ¶
Псевдоним для
like_async
- async like_async(*args: Any, **kwargs: Any) 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¶
- withTracks(*args: Any, **kwargs: Any) Album | None ¶
Псевдоним для
with_tracks
- async withTracksAsync(*args: Any, **kwargs: Any) Album | None ¶
Псевдоним для
with_tracks_async
- year: int | None = None¶
- class yandex_music.AlbumEvent(album: Album | None, tracks: List[Track], client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий альбом в событии фида.
- album¶
Альбом.
- Type:
yandex_music.Album
, optional
- tracks¶
Треки.
- Type:
list
изyandex_music.Track
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) AlbumEvent | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Альбом в событии фида.
- Return type:
- class yandex_music.Alert(alert_id: str, text: str, bg_color: str, text_color: str, alert_type: str, button: AlertButton, close_button: bool, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий блок с предупреждением.
Note
Данные предупреждения, скорее всего, только обкатываются. У них нет ID, вместо этого xxx, а еще присутствуют слова “тест” в тексте.
Используют как предупреждение о конце подписки, так и о раздаче подарков.
- alert_id¶
Уникальный идентификатор.
- Type:
str
- text¶
Текст предупреждения.
- Type:
str
- bg_color¶
Цвет заднего фона.
- Type:
str
- text_color¶
Цвет текста.
- Type:
str
- alert_type¶
Тип предупреждения.
- Type:
str
- button¶
Кнопка с ссылкой.
- Type:
- close_button¶
Наличие кнопки “Закрыть”.
- Type:
bool
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- alert_id: str¶
- alert_type: str¶
- bg_color: str¶
- button: AlertButton¶
- client: ClientType | None = None¶
- close_button: bool¶
- classmethod de_json(data: JSONType, client: ClientType) Alert | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Сообщение о статусе подписки.
- Return type:
- text: str¶
- text_color: str¶
- class yandex_music.AlertButton(text: str, bg_color: str, text_color: str, uri: str, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий кнопку в предупреждении.
- 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: ClientType | None = None¶
- text: str¶
- text_color: str¶
- uri: str¶
- class yandex_music.Artist(id: int, error: str | None = None, reason: str | None = None, name: str | None = None, cover: Cover | None = None, various: bool | None = None, composer: bool | None = None, genres: List[str] | None = None, og_image: str | None = None, op_image: str | None = None, no_pictures_from_search: Any = None, counts: Counts | None = None, available: bool | None = None, ratings: Ratings | None = None, links: List[Link] | None = None, tickets_available: bool | None = None, likes_count: int | None = None, popular_tracks: List[Track] | None = None, regions: List[str] | None = None, decomposed: List[str | Artist] | None = None, full_names: Any = None, hand_made_description: str | None = None, description: Description | None = None, countries: List[str] | None = None, en_wikipedia_link: str | None = None, db_aliases: List[str] | None = None, aliases: Any = None, init_date: str | None = None, end_date: str | None = None, ya_money_id: str | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий исполнителя.
- 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
, optional
- regions¶
Регион TODO.
- Type:
list
изstr
, optional
- decomposed¶
Декомпозиция всех исполнителей. Лист, где чередуется разделитель и артист. Фиты и прочее.
- Type:
list
изstr
иyandex_music.Artist
, optional
- full_names¶
TODO.
- Type:
Any
- hand_made_description¶
Описание от Яндекс TODO.
- Type:
str
, optional
- description¶
Описание.
- Type:
yandex_music.Description
, optional
- countries¶
Страны.
- Type:
list
изstr
, optional
- en_wikipedia_link¶
Адрес страницы на wikipedia.org.
- Type:
str
, optional
- db_aliases¶
Другие названия. Как правило названия на разных языках.
- Type:
list
изstr
, optional
- aliases¶
TODO.
- Type:
Any
- init_date¶
Дата начала в формате YYYY-MM-DD или YYYY.
- Type:
str
, optional
- end_date¶
Дата окончания в формате YYYY-MM-DD или YYYY.
- Type:
str
, optional
- ya_money_id¶
Номер кошеляка Яндекс.Деньги TODO.
- Type:
str
- client¶
Клиент Yandex Music.
- Type:
- aliases: Any = None¶
- available: bool | None = None¶
- client: ClientType | None = None¶
- composer: bool | None = None¶
- countries: List[str] | None = None¶
- db_aliases: List[str] | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Artist | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
) – Клиент Yandex Music.
- Returns:
Исполнитель.
- Return type:
- description: Description | None = None¶
- dislike(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
client.users_likes_artists_remove(artist.id, user.id *args, **kwargs)
- async dislikeAsync(*args: Any, **kwargs: Any) bool ¶
Псевдоним для
dislike_async
- async dislike_async(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
await client.users_likes_artists_remove(artist.id, user.id *args, **kwargs)
- 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
- downloadOpImage(filename: str, size: str = '200x200') None ¶
Псевдоним для
download_op_image
- async downloadOpImageAsync(filename: str, size: str = '200x200') None ¶
Псевдоним для
download_op_image_async
- downloadOpImageBytes(size: str = '200x200') bytes ¶
Псевдоним для
download_op_image_bytes
- async downloadOpImageBytesAsync(size: str = '200x200') bytes ¶
Псевдоним для
download_op_image_bytes_async
- download_og_image(filename: str, size: str = '200x200') None ¶
Загрузка изображения для Open Graph.
- Parameters:
filename (
str
) – Путь для сохранения файла с названием и расширением.size (
str
, optional) – Размер обложки.
- async download_og_image_async(filename: str, size: str = '200x200') None ¶
Загрузка изображения для Open Graph.
- Parameters:
filename (
str
) – Путь для сохранения файла с названием и расширением.size (
str
, optional) – Размер обложки.
- download_og_image_bytes(size: str = '200x200') bytes ¶
Загрузка изображения для Open Graph и возврат в виде байтов.
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Изображение в виде байтов.
- Return type:
bytes
- async download_og_image_bytes_async(size: str = '200x200') bytes ¶
Загрузка изображения для Open Graph и возврат в виде байтов.
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Изображение в виде байтов.
- Return type:
bytes
- download_op_image(filename: str, size: str = '200x200') None ¶
Загрузка обложки.
Notes
Используйте это только когда нет self.cover!
- Parameters:
filename (
str
) – Путь для сохранения файла с названием и расширением.size (
str
, optional) – Размер обложки.
- async download_op_image_async(filename: str, size: str = '200x200') None ¶
Загрузка обложки.
Notes
Используйте это только когда нет self.cover!
- Parameters:
filename (
str
) – Путь для сохранения файла с названием и расширением.size (
str
, optional) – Размер обложки.
- download_op_image_bytes(size: str = '200x200') bytes ¶
Загрузка обложки и возврат в виде байтов.
Notes
Используйте это только когда нет self.cover!
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Обложка в виде байтов.
- Return type:
bytes
- async download_op_image_bytes_async(size: str = '200x200') bytes ¶
Загрузка обложки и возврат в виде байтов.
Notes
Используйте это только когда нет self.cover!
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Обложка в виде байтов.
- Return type:
bytes
- en_wikipedia_link: str | None = None¶
- end_date: str | None = None¶
- error: str | None = None¶
- full_names: Any = None¶
- genres: List[str] | None = None¶
- getAlbums(page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) ArtistAlbums | None ¶
Псевдоним для
get_albums
- async getAlbumsAsync(page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) ArtistAlbums | None ¶
Псевдоним для
get_albums_async
- getOgImageUrl(size: str = '200x200') str ¶
Псевдоним для
get_og_image_url
- getOpImageUrl(size: str = '200x200') str ¶
Псевдоним для
get_op_image_url
- getTracks(page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) ArtistTracks | None ¶
Псевдоним для
get_tracks
- async getTracksAsync(page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) ArtistTracks | None ¶
Псевдоним для
get_tracks_async
- get_albums(page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) ArtistAlbums | None ¶
Сокращение для:
client.artists_direct_albums(artist.id, page, page_size, sort_by, *args, **kwargs)
- async get_albums_async(page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) ArtistAlbums | None ¶
Сокращение для:
await client.artists_direct_albums(artist.id, page, page_size, sort_by, *args, **kwargs)
- get_og_image_url(size: str = '200x200') str ¶
Возвращает URL OG обложки.
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
URL обложки.
- Return type:
str
- get_op_image_url(size: str = '200x200') str ¶
Возвращает URL OP обложки.
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
URL обложки.
- Return type:
str
- get_tracks(page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) ArtistTracks | None ¶
Сокращение для:
client.artists_tracks(artist.id, page, page_size, *args, **kwargs)
- async get_tracks_async(page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) ArtistTracks | None ¶
Сокращение для:
await client.artists_tracks(artist.id, page, page_size, *args, **kwargs)
- hand_made_description: str | None = None¶
- id: int¶
- init_date: str | None = None¶
- like(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
client.users_likes_artists_add(artist.id, user.id *args, **kwargs)
- async likeAsync(*args: Any, **kwargs: Any) bool ¶
Псевдоним для
like_async
- async like_async(*args: Any, **kwargs: Any) bool ¶
Сокращение для:
await client.users_likes_artists_add(artist.id, user.id *args, **kwargs)
- likes_count: int | None = None¶
- name: str | None = None¶
- no_pictures_from_search: Any = None¶
- og_image: str | None = None¶
- op_image: str | None = None¶
- reason: str | None = None¶
- regions: List[str] | None = None¶
- tickets_available: bool | None = None¶
- various: bool | None = None¶
- ya_money_id: str | None = None¶
- class yandex_music.ArtistAlbums(albums: List[Album], pager: Pager | None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий страницу списка альбомов артиста.
- albums¶
Список альбомов артиста.
- Type:
list
изyandex_music.Album
- pager¶
Пагинатор.
- Type:
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ArtistAlbums | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Список альбомов артиста.
- Return type:
- class yandex_music.ArtistEvent(artist: Artist | None, tracks: List[Track], similar_to_artists_from_history: List[Artist], subscribed: bool | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий артиста в событии фида.
- artist¶
Артист.
- Type:
yandex_music.Artist
, optional
- tracks¶
Треки.
- Type:
list
изyandex_music.Track
- similar_to_artists_from_history¶
Похожие артисты из истории.
- Type:
list
изyandex_music.Artist
- subscribed¶
Подписан ли на событие.
- Type:
bool
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ArtistEvent | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Артист из события фида.
- Return type:
- subscribed: bool | None = None¶
- class yandex_music.ArtistTracks(tracks: List[Track], pager: Pager | None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий страницу списка треков артиста.
- tracks¶
Список треков артиста.
- Type:
list
изyandex_music.Track
- pager¶
Пагинатор.
- Type:
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ArtistTracks | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Страница списка треков артиста.
- Return type:
yandex_music.ArtistsTracks
- class yandex_music.AutoRenewable(expires: str, vendor: str, vendor_help_url: str, product: Product | None, finished: bool, master_info: User | None = None, product_id: str | None = None, order_id: int | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий информацию об автопродлении подписки.
- expires¶
Дата истечения подписки.
- Type:
str
- vendor¶
Продавец.
- Type:
str
- vendor_help_url¶
Ссылка на страницу помощи продавца.
- Type:
str
- product_id¶
Уникальный идентификатор продукта.
- Type:
str
- finished¶
Завершенность автопродления.
- Type:
bool
- master_info¶
Главный в семейной подписке.
- Type:
yandex_music.User
, optional
- product¶
Продукт.
- Type:
yandex_music.Product
, optional
- order_id¶
Уникальный идентификатор заказа.
- Type:
int
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) AutoRenewable | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
) – Клиент Yandex Music.
- Returns:
Информация об автопродлении подписки.
- Return type:
- expires: str¶
- finished: bool¶
- order_id: int | None = None¶
- product_id: str | None = None¶
- vendor: str¶
- vendor_help_url: str¶
- class yandex_music.Best(type: str, result: Track | Artist | Album | Playlist | Video | None, text: str | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий лучший результат поиска.
- type¶
Тип лучшего результата.
- Type:
str
- result¶
Лучший результат.
- text¶
TODO.
- Type:
str
, optional
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Best | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Лучший результат.
- Return type:
- text: str | None = None¶
- type: str¶
- class yandex_music.Block(id: str, type: str, type_for_from: str, title: str, entities: List[BlockEntity], description: str | None = None, data: PersonalPlaylistsData | PlayContextsData | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий блок лендинга.
Note
Известные значения поля type_: personal-playlists, play-contexts.
- id¶
Уникальный идентификатор блока.
- Type:
str
- type¶
Тип блока.
- Type:
str
- type_for_from¶
Откуда получен блок (как к нему пришли).
- Type:
str
- title¶
Заголовок.
- Type:
str
- entities¶
Содержимое блока (сущности, объекты).
- Type:
list
изyandex_music.BlockEntity
- description¶
Описание.
- Type:
str
, optional
- data¶
Дополнительные данные.
- Type:
yandex_music.PersonalPlaylistsData
|yandex_music.PlayContextsData
, optional
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- data: PersonalPlaylistsData | PlayContextsData | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Block | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Блок лендинга.
- Return type:
- description: str | None = None¶
- entities: List[BlockEntity]¶
- id: str¶
- title: str¶
- type: str¶
- type_for_from: str¶
- class yandex_music.BlockEntity(id: str, type: str, data: GeneratedPlaylist | Promotion | Album | Playlist | ChartItem | PlayContext | MixLink, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий содержимое блока.
Note
В зависимости от поля type_, в поле data будет объект соответствующего типа.
Известные значения поля type_: personal-playlist, promotion, album, playlist, chart-item, play-context, mix-link.
- id¶
Уникальный идентификатор содержимого.
- Type:
str
- type¶
Тип содержимого.
- Type:
str
- data (:obj:`yandex_music.GeneratedPlaylist` | :obj:`yandex_music.Promotion` | :obj:`yandex_music.Album` |
yandex_music.Playlist
|yandex_music.ChartItem
|yandex_music.PlayContext
|yandex_music.MixLink
): Содержимое.
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- data: GeneratedPlaylist | Promotion | Album | Playlist | ChartItem | PlayContext | MixLink¶
- classmethod de_json(data: JSONType, client: ClientType) BlockEntity | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Сущность (объект) блока.
- Return type:
- id: str¶
- type: str¶
- class yandex_music.Brand(image: str, background: str, reference: str, pixels: List[str], theme: str, playlist_theme: str, button: str, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий бренд плейлиста.
Note
Отслеживание просмотров на сторонник сервисах бренда, рекомендация следующего контента.
- image¶
Ссылка на изображение.
- Type:
str
- background¶
Цвет заднего фона.
- Type:
str
- reference¶
URI ссылка на содержимое.
- Type:
str
- pixels¶
Ссылки на gif изображения для отслеживания просмотров (web beacon).
- Type:
list
изstr
- theme¶
Тема оформления.
- Type:
str
- playlist_theme¶
Тема плейлиста TODO.
- Type:
str
- button¶
Текст кнопки.
- Type:
str
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- background: str¶
- button: str¶
- client: ClientType | None = None¶
- image: str¶
- pixels: List[str]¶
- playlist_theme: str¶
- reference: str¶
- theme: str¶
- class yandex_music.BriefInfo(artist: Artist | None, albums: ~typing.List[Album], playlists: ~typing.List[Playlist], also_albums: ~typing.List[Album], last_release_ids: ~typing.List[int], last_releases: ~typing.List[Album], popular_tracks: ~typing.List[Track], similar_artists: ~typing.List[Artist], all_covers: ~typing.List[Cover], concerts: ~typing.Any, videos: ~typing.List[Video], vinyls: ~typing.List[Vinyl], has_promotions: bool, playlist_ids: ~typing.List[PlaylistId], stats: Stats | None = None, tracks_in_chart: ~typing.List[Chart] = <factory>, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий информацию об артисте.
- artist¶
Артист.
- Type:
yandex_music.Artist
|None
- albums¶
Альбомы.
- Type:
list
изyandex_music.Album
- playlists¶
Плейлисты.
- Type:
list
изyandex_music.Playlist
- also_albums¶
Сборники.
- Type:
list
изyandex_music.Album
- last_release_ids¶
Уникальные идентификаторы последних выпущенных альбомов.
- Type:
list
изint
- last_releases¶
Последние выпущенные альбомы.
- Type:
list
изyandex_music.Album
, 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
- stats¶
Статистика прослушиваний за месяц.
- Type:
yandex_music.Stats
, optional
- tracks_in_chart¶
Треки в чарте.
- Type:
list
изyandex_music.Chart
, optional
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- concerts: Any¶
- classmethod de_json(data: JSONType, client: ClientType) BriefInfo | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Информация об артисте.
- Return type:
- has_promotions: bool¶
- last_release_ids: List[int]¶
- playlist_ids: List[PlaylistId]¶
- class yandex_music.CaseForms(nominative: str, genitive: str, dative: str, accusative: str, instrumental: str, prepositional: str, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий склонение имени.
- 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: ClientType | None = None¶
- dative: str¶
- 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: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий элемент чарта.
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: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) Chart | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Элемент чарта.
- Return type:
- listeners: int¶
- position: int¶
- progress: str¶
- shift: int¶
- 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: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий чарт.
- id¶
Уникальный идентификатор блока.
- Type:
str
- type¶
Тип блока.
- Type:
str
- type_for_from¶
Откуда получен блок (как к нему пришли).
- Type:
str
- title¶
Заголовок.
- Type:
str
Меню 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_description: str | None = None¶
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ChartInfo | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Чарт.
- Return type:
- id: str¶
- menu: ChartInfoMenu | None¶
- title: str¶
- type: str¶
- type_for_from: str¶
- class yandex_music.ChartInfoMenu(items: List[ChartInfoMenuItem], client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий меню чарта.
- items¶
Список элементов меню.
- Type:
list
изyandex_music.ChartInfoMenuItem
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ChartInfoMenu | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Меню чарта.
- Return type:
- items: List[ChartInfoMenuItem]¶
- class yandex_music.ChartInfoMenuItem(title: str, url: str, selected: bool | None = None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий элемент меню чарта.
- title¶
Заголовок.
- Type:
str
- url¶
Постфикс для запроса чарта.
- Type:
str
- selected¶
Текущий ли элемент.
- Type:
bool
, optional
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- selected: bool | None = None¶
- title: str¶
- url: str¶
- class yandex_music.ChartItem(track: Track | None, chart: Chart | None, client: ClientType | None = None)¶
Bases:
YandexMusicModel
Класс, представляющий трек в чарте.
- track¶
Трек.
- Type:
yandex_music.Track
|None
- chart¶
Элемент чарт.
- Type:
yandex_music.Chart
|None
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- client: ClientType | None = None¶
- classmethod de_json(data: JSONType, client: ClientType) ChartItem | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Трек в чарте.
- Return type:
- class yandex_music.Client(token: str | None = None, base_url: str | None = None, request: Request | None = 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:
- 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: Any, **kwargs: Any) Experiments | None ¶
Псевдоним для
account_experiments
- accountSettings(*args: Any, **kwargs: Any) UserSettings | None ¶
Псевдоним для
account_settings
- accountSettingsSet(param: str | None = None, value: str | int | bool | None = None, data: JSONType | None = None, *args: Any, **kwargs: Any) UserSettings | None ¶
Псевдоним для
account_settings_set
- accountStatus(*args: Any, **kwargs: Any) Status | None ¶
Псевдоним для
account_status
- account_experiments(*args: Any, **kwargs: Any) Experiments | None ¶
Получение значений экспериментальных функций аккаунта.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Состояние экспериментальных функций или
None
.- Return type:
yandex_music.Experiments
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- account_settings(*args: Any, **kwargs: Any) UserSettings | None ¶
Получение настроек текущего пользователя.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
- Настройки пользователя если аккаунт валиден,
иначе
None
.
- Return type:
yandex_music.UserSettings
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- account_settings_set(param: str | None = None, value: str | int | bool | None = None, data: JSONType | None = None, *args: Any, **kwargs: Any) UserSettings | None ¶
Изменение настроек текущего пользователя.
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: Any, **kwargs: Any) 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 = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args: Any, **kwargs: Any) ShotEvent | None ¶
Псевдоним для
after_track
- after_track(next_track_id: str | int, context_item: str, prev_track_id: str | int | None = None, context: str = 'playlist', types: str = 'shot', from_: str = 'mobile-landing-origin-default', *args: Any, **kwargs: Any) 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:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- albums(album_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) 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: Any, **kwargs: Any) Album | None ¶
Псевдоним для
albums_with_tracks
- albums_with_tracks(album_id: str | int, *args: Any, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) BriefInfo | None ¶
Псевдоним для
artists_brief_info
- artistsDirectAlbums(artist_id: str | int, page: int = 0, page_size: int = 20, sort_by: str = 'year', *args: Any, **kwargs: Any) ArtistAlbums | None ¶
Псевдоним для
artists_direct_albums
- artistsTracks(artist_id: str | int, page: int = 0, page_size: int = 20, *args: Any, **kwargs: Any) ArtistTracks | None ¶
Псевдоним для
artists_tracks
- artists_brief_info(artist_id: str | int, *args: Any, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) ChartInfo | None ¶
Получение чарта.
Note
chart_option - это постфикс к запросу из поля menu чарта. Например, на сайте можно выбрать глобальный (world) чарт или российский (russia).
- Parameters:
chart_option (
str
optional) – Параметры чарта.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Чарт.
- Return type:
- 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: Any, **kwargs: Any) Feed | None ¶
Получение потока информации (фида) подобранного под пользователя. Содержит умные плейлисты.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Умные плейлисты пользователя или
None
.- Return type:
yandex_music.Feed
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- feedWizardIsPassed(*args: Any, **kwargs: Any) bool ¶
Псевдоним для
feed_wizard_is_passed
- feed_wizard_is_passed(*args: Any, **kwargs: Any) bool ¶
Получение информации о прохождении визарда.
Note
Временное событие на хэллоуин.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Прошел ли пользователь визард или нет.
- Return type:
bool
- genres(*args: Any, **kwargs: Any) List[Genre] ¶
Получение жанров музыки.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Жанры музыки или
None
.- Return type:
list
изyandex_music.Genre
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- landing(blocks: str | List[str], *args: Any, **kwargs: Any) 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: Any, **kwargs: Any) LandingList | None ¶
Псевдоним для
new_playlists
- newReleases(*args: Any, **kwargs: Any) LandingList | None ¶
Псевдоним для
new_releases
- new_playlists(*args: Any, **kwargs: Any) LandingList | None ¶
Получение полного списка всех новых плейлистов.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Список новых плейлистов.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- new_releases(*args: Any, **kwargs: Any) LandingList | None ¶
Получение полного списка всех новых релизов (альбомов).
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Список новых альбомов.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- permissionAlerts(*args: Any, **kwargs: Any) PermissionAlerts | None ¶
Псевдоним для
permission_alerts
- permission_alerts(*args: Any, **kwargs: Any) PermissionAlerts | None ¶
Получение оповещений. Нет обязательных параметров.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Оповещения если аккаунт валиден или
None
.- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- playAudio(track_id: str | int, from_: str, album_id: str | int, playlist_id: str | None = None, from_cache: bool = False, play_id: str | None = None, uid: int | None = None, timestamp: str | None = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str | None = None, *args: Any, **kwargs: Any) bool ¶
Псевдоним для
play_audio
- play_audio(track_id: str | int, from_: str, album_id: str | int, playlist_id: str | None = None, from_cache: bool = False, play_id: str | None = None, uid: int | None = None, timestamp: str | None = None, track_length_seconds: int = 0, total_played_seconds: int = 0, end_position_seconds: int = 0, client_now: str | None = None, *args: Any, **kwargs: Any) 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: Any) bool ¶
Псевдоним для
playlists_collective_join
- playlistsList(playlist_ids: List[str | int] | int | str, *args: Any, **kwargs: Any) List[Playlist] ¶
Псевдоним для
playlists_list
- playlists_collective_join(user_id: int, token: str, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) LandingList | None ¶
Получение подкастов с лендинга.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Список подкастов.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queue(queue_id: str, *args: Any, **kwargs: Any) Queue | None ¶
Получение информации об очереди треков и самих треков в ней.
- Parameters:
queue_id (
str
) – Уникальный идентификатор очереди.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Очередь или
None
.- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- queueCreate(queue: Queue | str, device: str | None = None, *args: Any, **kwargs: Any) str | None ¶
Псевдоним для
queue_create
- queueUpdatePosition(queue_id: str, current_index: int, device: str | None = None, **kwargs) bool ¶
Псевдоним для
queue_update_position
- queue_create(queue: Queue | str, device: str | None = None, *args: Any, **kwargs: Any) 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 = 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 = None, *args: Any, **kwargs: Any) List[QueueItem] ¶
Псевдоним для
queues_list
- queues_list(device: str | None = None, *args: Any, **kwargs: Any) 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 – Базовое исключение библиотеки.
- rotorAccountStatus(*args: Any, **kwargs: Any) Status | None ¶
Псевдоним для
rotor_account_status
- rotorStationFeedback(station: str, type_: str, timestamp: str | float | int | None = None, from_: str | None = None, batch_id: str | None = None, total_played_seconds: int | float | None = None, track_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
rotor_station_feedback
- rotorStationFeedbackRadioStarted(station: str, from_: str, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
rotor_station_feedback_radio_started
- rotorStationFeedbackSkip(station: str, track_id: str | int, total_played_seconds: float, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
rotor_station_feedback_skip
- rotorStationFeedbackTrackFinished(station: str, track_id: str | int, total_played_seconds: float, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
rotor_station_feedback_track_finished
- rotorStationFeedbackTrackStarted(station: str, track_id: str | int, batch_id: str | None = None, timestamp: str | float | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
rotor_station_feedback_track_started
- rotorStationInfo(station: str, *args: Any, **kwargs: Any) List[StationResult] ¶
Псевдоним для
rotor_station_info
- rotorStationSettings2(station: str, mood_energy: str, diversity: str, language: str = 'not-russian', type_: str = 'rotor', **kwargs: Any) bool ¶
Псевдоним для
rotor_station_settings2
- rotorStationTracks(station: str, settings2: bool = True, queue: str | int | None = None, *args: Any, **kwargs: Any) StationTracksResult | None ¶
Псевдоним для
rotor_station_tracks
- rotorStationsDashboard(*args: Any, **kwargs: Any) Dashboard | None ¶
Псевдоним для
rotor_stations_dashboard
- rotorStationsList(language: str | None = None, *args: Any, **kwargs: Any) List[StationResult] ¶
Псевдоним для
rotor_stations_list
- rotor_account_status(*args: Any, **kwargs: Any) 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 = None, from_: str | None = None, batch_id: str | None = None, total_played_seconds: int | float | None = None, track_id: str | int | None = None, **kwargs: Any) 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 = None, timestamp: str | float | int | None = None, **kwargs: Any) 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 = None, timestamp: str | float | int | None = None, **kwargs: Any) 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 = None, timestamp: str | float | int | None = None, **kwargs: Any) 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 = None, timestamp: str | float | int | None = None, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any) 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 = None, *args: Any, **kwargs: Any) 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:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- rotor_stations_dashboard(*args: Any, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) 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: Any, **kwargs: Any) Suggestions | None ¶
Псевдоним для
search_suggest
- search_suggest(part: str, *args: Any, **kwargs: Any) Suggestions | None ¶
Получение подсказок по введенной части поискового запроса.
- Parameters:
part (
str
) – Часть поискового запроса.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Подсказки для запроса или
None
.- Return type:
yandex_music.Suggestions
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- settings(*args: Any, **kwargs: Any) Settings | None ¶
Получение предложений по покупке. Нет обязательных параметров.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
- Информацию о предлагаемых продуктах если аккаунт валиден
или
None
.
- Return type:
yandex_music.Settings
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tags(tag_id: str, *args: Any, **kwargs: Any) TagResult | None ¶
Получение тега (подборки).
Note
Теги есть в MixLink у Landing, а также плейлистов в .tags.
У MixLink есть URL, но tag_id только его последняя часть. Например, /tag/belarus/. Tag - belarus.
- Parameters:
tag_id (
str
) – Уникальный идентификатор тега.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Тег с плейлистами.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- trackSupplement(track_id: str | int, *args: Any, **kwargs: Any) Supplement | None ¶
Псевдоним для
track_supplement
- track_supplement(track_id: str | int, *args: Any, **kwargs: Any) Supplement | None ¶
Получение дополнительной информации о треке.
Warning
Получение текста из дополнительной информации устарело. Используйте
yandex_music.Client.tracks_lyrics()
.- Parameters:
track_id (
str
|int
) – Уникальный идентификатор трека.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Дополнительная информация о треке.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- tracks(track_ids: List[str] | List[int] | List[str | int] | int | str, with_positions: bool = True, *args: Any, **kwargs: Any) 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: Any, **kwargs: Any) List[DownloadInfo] ¶
Псевдоним для
tracks_download_info
- tracksLyrics(track_id: str | int, format_: str = 'TEXT', **kwargs: Any) TrackLyrics | None ¶
Псевдоним для
tracks_lyrics
- tracksSimilar(track_id: str | int, *args: Any, **kwargs: Any) SimilarTracks | None ¶
Псевдоним для
tracks_similar
- tracks_download_info(track_id: str | int, get_direct_links: bool = False, *args: Any, **kwargs: Any) 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: Any) TrackLyrics | None ¶
Получение текста трека.
Note
Для работы с методом необходима авторизация.
- Известные значения для аргумента format:
LRC - формат с временными метками.
TEXT - простой текст.
- Parameters:
track_id (
str
|int
) – Уникальный идентификатор трека.format (
str
) – Формат текста.**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: Any, **kwargs: Any) SimilarTracks | None ¶
Получение похожих треков.
- Parameters:
track_id (
str
|int
) – Уникальный идентификатор трека.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Похожие треки на другой трек.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- usersDislikesTracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) TracksList | None ¶
Псевдоним для
users_dislikes_tracks
- usersDislikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_dislikes_tracks_add
- usersDislikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_dislikes_tracks_remove
- usersLikesAlbums(user_id: str | int | None = None, rich: bool = True, *args: Any, **kwargs: Any) List[Like] ¶
Псевдоним для
users_likes_albums
- usersLikesAlbumsAdd(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_albums_add
- usersLikesAlbumsRemove(album_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_albums_remove
- usersLikesArtists(user_id: str | int | None = None, with_timestamps: bool = True, *args: Any, **kwargs: Any) List[Like] ¶
Псевдоним для
users_likes_artists
- usersLikesArtistsAdd(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_artists_add
- usersLikesArtistsRemove(artist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_artists_remove
- usersLikesPlaylists(user_id: str | int | None = None, *args: Any, **kwargs: Any) List[Like] ¶
Псевдоним для
users_likes_playlists
- usersLikesPlaylistsAdd(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_playlists_add
- usersLikesPlaylistsRemove(playlist_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_playlists_remove
- usersLikesTracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) TracksList | None ¶
Псевдоним для
users_likes_tracks
- usersLikesTracksAdd(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_tracks_add
- usersLikesTracksRemove(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) bool ¶
Псевдоним для
users_likes_tracks_remove
- usersPlaylists(kind: List[str | int] | str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | List[Playlist] | None ¶
Псевдоним для
users_playlists
- usersPlaylistsChange(kind: str | int, diff: str, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | None ¶
Псевдоним для
users_playlists_change
- usersPlaylistsCreate(title: str, visibility: str = 'public', user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | None ¶
Псевдоним для
users_playlists_create
- usersPlaylistsDelete(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) bool ¶
Псевдоним для
users_playlists_delete
- usersPlaylistsDeleteTrack(kind: str | int, from_: int, to: int, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) Playlist | None ¶
Псевдоним для
users_playlists_insert_track
- usersPlaylistsList(user_id: str | int | None = None, *args: Any, **kwargs: Any) List[Playlist] ¶
Псевдоним для
users_playlists_list
- usersPlaylistsName(kind: str | int, name: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | None ¶
Псевдоним для
users_playlists_name
- usersPlaylistsRecommendations(kind: str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) PlaylistRecommendations | None ¶
Псевдоним для
users_playlists_recommendations
- usersPlaylistsVisibility(kind: str | int, visibility: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | None ¶
Псевдоним для
users_playlists_visibility
- usersSettings(user_id: str | int | None = None, *args: Any, **kwargs: Any) UserSettings | None ¶
Псевдоним для
users_settings
- users_dislikes_tracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, rich: bool = True, *args: Any, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, with_timestamps: bool = True, *args: Any, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) 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 = None, **kwargs: Any) bool ¶
Поставить отметку “Мне нравится” плейлисту/плейлистам.
Note
Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.
- Parameters:
playlist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор плейлиста или плейлистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.*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 = None, **kwargs: Any) bool ¶
Снять отметку “Мне нравится” у плейлиста/плейлистов.
Note
Идентификатор плейлиста указывается в формате owner_id:playlist_id. Где playlist_id - идентификатор плейлиста, owner_id - уникальный идентификатор владельца плейлиста.
- Parameters:
playlist_ids (
str
|int
|list
изstr
|list
изint
) – Уникальный идентификатор плейлиста или плейлистов.user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
True
при успешном выполнении запроса, иначеFalse
.- Return type:
bool
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_tracks(user_id: str | int | None = None, if_modified_since_revision: int = 0, *args: Any, **kwargs: Any) TracksList | None ¶
Получение треков с отметкой “Мне нравится”.
- Parameters:
user_id (
str
|int
, optional) – Уникальный идентификатор пользователя. Если не указан используется ID текущего пользователя.if_modified_since_revision (
int
, optional) – TODO.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Треки с отметкой “Мне нравится”.
- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_likes_tracks_add(track_ids: List[str | int] | str | int, user_id: str | int | None = None, **kwargs: Any) 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 = None, **kwargs: Any) 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_playlists(kind: List[str | int] | str | int, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | List[Playlist] | None ¶
Получение плейлиста или списка плейлистов по уникальным идентификаторам.
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 = None, *args: Any, **kwargs: Any) 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:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_create(title: str, visibility: str = 'public', user_id: str | int | None = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) 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 – Базовое исключение библиотеки.
- users_playlists_insert_track(kind: str | int, track_id: str | int, album_id: str | int, at: int = 0, revision: int = 1, user_id: str | int | None = None, *args: Any, **kwargs: Any) Playlist | None ¶
Добавление трека в плейлист.
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:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_list(user_id: str | int | None = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) PlaylistRecommendations | None ¶
Получение рекомендаций для плейлиста.
- Parameters:
kind (
str
|int
) – Уникальный идентификатор плейлиста.user_id (
str
|int
) – Уникальный идентификатор пользователя владеющим плейлистом.*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Рекомендации для плейлиста или
None
.- Return type:
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- users_playlists_visibility(kind: str | int, visibility: str, user_id: str | int | None = None, *args: Any, **kwargs: Any) 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 = None, *args: Any, **kwargs: Any) 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 = None, base_url: str | None = None, request: Request | None = 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:
- 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: Any, **kwargs: Any) Experiments | None ¶
Псевдоним для
account_experiments
- async accountSettings(*args: Any, **kwargs: Any) UserSettings | None ¶
Псевдоним для
account_settings
- async accountSettingsSet(param: str | None = None, value: str | int | bool | None = None, data: JSONType | None = None, *args: Any, **kwargs: Any) UserSettings | None ¶
Псевдоним для
account_settings_set
- async accountStatus(*args: Any, **kwargs: Any) Status | None ¶
Псевдоним для
account_status
- async account_experiments(*args: Any, **kwargs: Any) Experiments | None ¶
Получение значений экспериментальных функций аккаунта.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
Состояние экспериментальных функций или
None
.- Return type:
yandex_music.Experiments
|None
- Raises:
yandex_music.exceptions.YandexMusicError – Базовое исключение библиотеки.
- async account_settings(*args: Any, **kwargs: Any) UserSettings | None ¶
Получение настроек текущего пользователя.
- Parameters:
*args – Произвольные аргументы (будут переданы в запрос).
**kwargs – Произвольные именованные аргументы (будут переданы в запрос).
- Returns:
- Настройки пользователя если аккаунт валиден,