Асинхронный клиент

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

Инициализация асинхронного клиента:

from yandex_music import ClientAsync

client = ClientAsync()
await client.init()

# или

client = await Client().init()

После успешного создания клиента вы вольны в выборе необходимого метода из API. Все они доступны у объекта класса ClientAsync и описаны ниже. Используйте навигацию из меню справа для быстрого доступа.

Особенности использования асинхронного клиента

При работе с асинхронной версией библиотеке стоит всегда помнить следующие особенности:

  • Клиент следует импортировать с названием ClientAsync, а не просто Client.

  • При использовании методов-сокращений нужно выбирать метод с суффиксом _async.

Пояснение ко второму пункту:

from yandex_music import ClientAsync

client = await ClientAsync('token').init()
liked_short_track = (await client.users_likes_tracks())[0]

# правильно
full_track = await liked_short_track.fetch_track_async()
await full_track.download_async()

# НЕПРАВИЛЬНО
full_track = await liked_short_track.fetch_track()
await full_track.download()
class yandex_music.ClientAsync

Bases: AccountMixin, AlbumsMixin, ClipsMixin, ConcertsMixin, CreditsMixin, DeviceAuthMixin, DisclaimersMixin, LabelsMixin, LandingMixin, TracksMixin, SearchMixin, PlaylistsMixin, RadioMixin, ArtistsMixin, LikesMixin, MetatagsMixin, MusicHistoryMixin, PinsMixin, PresavesMixin, QueueMixin, YandexMusicObject

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

Note

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

Поле device используется только при работе с очередью прослушивания.

logger

Объект логгера.

Type:

logging.Logger

token

Уникальный ключ для аутентификации.

Type:

str

base_url

Ссылка на API Yandex Music.

Type:

str

me

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

Type:

yandex_music.Status

device

Строка, содержащая сведения об устройстве, с которого выполняются запросы.

Type:

str

report_unknown_fields

Включены ли предупреждения о неизвестных полях от API, которых нет в библиотеке.

Type:

bool

Parameters:
  • token (str, optional) – Уникальный ключ для аутентификации.

  • base_url (str, optional) – Ссылка на API Yandex Music.

  • request (yandex_music.utils.request.Request, optional) – Пре-инициализация yandex_music.utils.request.Request.

  • language (str, optional) – Язык, на котором будут приходить ответы от API. По умолчанию русский.

  • report_unknown_fields (bool, optional) – Включить предупреждения о неизвестных полях от API, которых нет в библиотеке.

property request

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

Type:

yandex_music.utils.request.Request

Методы

Аккаунт

account_experiments, account_experiments_details, account_settings, account_settings_set, account_status, consume_promo_code, init, permission_alerts, settings

Аккаунт
Альбомы

albums, albums_similar_entities, albums_trailer, albums_with_tracks

Альбомы
Артисты

artists, artists_about, artists_also_albums, artists_brief_info, artists_clips, artists_direct_albums, artists_discography_albums, artists_donation, artists_info, artists_links, artists_safe_direct_albums, artists_similar, artists_skeleton, artists_track_ids, artists_tracks, artists_trailer

Артисты
Видеоклипы

clips, clips_will_like

Видеоклипы
Концерты

artists_concerts, concert_info, concert_skeleton, concerts_feed, concerts_locations, concerts_tab_config

Концерты
Авторы контента

clips_credits, tracks_credits

Авторы контента
OAuth Device Flow

device_auth, poll_device_token, request_device_code

OAuth Device Flow
Дисклеймеры

albums_disclaimer, artists_disclaimer, clips_disclaimer, tracks_disclaimer

Дисклеймеры
Лейблы

label, label_albums, label_artists

Лейблы
Лендинг и фид

chart, feed, feed_wizard_is_passed, genres, landing, new_playlists, new_releases, podcasts, tags

Лендинг и фид
Лайки и дизлайки

users_dislikes_artists, users_dislikes_artists_add, users_dislikes_artists_remove, users_dislikes_tracks, users_dislikes_tracks_add, users_dislikes_tracks_remove, users_likes_albums, users_likes_albums_add, users_likes_albums_remove, users_likes_artists, users_likes_artists_add, users_likes_artists_remove, users_likes_clips, users_likes_clips_add, users_likes_clips_remove, users_likes_playlists, users_likes_playlists_add, users_likes_playlists_remove, users_likes_tracks, users_likes_tracks_add, users_likes_tracks_remove

Лайки и дизлайки
Метатеги

metatag, metatag_albums, metatag_artists, metatag_playlists, metatags

Метатеги
История прослушивания

music_history, music_history_items

История прослушивания
Закреплённые

pin_album, pin_artist, pin_playlist, pin_wave, pins, unpin_album, unpin_artist, unpin_playlist, unpin_wave

Закреплённые
Плейлисты

playlist, playlist_similar_entities, playlists, playlists_collective_join, playlists_list, playlists_personal, users_playlists, users_playlists_change, users_playlists_create, users_playlists_delete, users_playlists_delete_track, users_playlists_description, users_playlists_insert_track, users_playlists_kinds, users_playlists_list, users_playlists_name, users_playlists_recommendations, users_playlists_trailer, users_playlists_visibility, users_settings

Плейлисты
Предсохранения

users_presaves, users_presaves_add, users_presaves_remove

Предсохранения
Очередь

queue, queue_create, queue_update_position, queues_list

Очередь
Радио

rotor_account_status, rotor_station_feedback, rotor_station_feedback_radio_started, rotor_station_feedback_skip, rotor_station_feedback_track_finished, rotor_station_feedback_track_started, rotor_station_info, rotor_station_settings2, rotor_station_tracks, rotor_stations_dashboard, rotor_stations_list

Радио
Поиск

search, search_suggest

Поиск
Треки

after_track, play_audio, track_supplement, tracks, tracks_download_info, tracks_full_info, tracks_lyrics, tracks_similar, tracks_trailer

Треки