Плейлисты

class yandex_music._client.playlists.PlaylistsMixin

Плейлисты.

Миксин для методов, связанных с плейлистами.

users_settings(user_id=None, *args, **kwargs)

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

Note

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

Parameters:

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

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

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

Returns:

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

Return type:

yandex_music.UserSettings | None

Raises:

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

users_playlists(kind, user_id=None, *args, **kwargs)

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

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_recommendations(kind, user_id=None, *args, **kwargs)

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • user_id (str | int) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

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

Return type:

yandex_music.PlaylistRecommendations | None

Raises:

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

users_playlists_create(title, visibility='public', user_id=None, *args, **kwargs)

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

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, user_id=None, *args, **kwargs)

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

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

Return type:

bool

Raises:

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

users_playlists_name(kind, name, user_id=None, *args, **kwargs)

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

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_visibility(kind, visibility, user_id=None, *args, **kwargs)

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

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_playlists_change(kind, diff, revision=1, user_id=None, *args, **kwargs)

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

Note

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

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • revision (int) – TODO.

  • diff (str) – JSON представления отличий старого и нового плейлиста.

  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

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

Return type:

yandex_music.Playlist

Raises:

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

users_playlists_insert_track(kind, track_id, album_id, at=0, revision=1, user_id=None, *args, **kwargs)

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

Note

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • track_id (str | int) – Уникальный идентификатор трека.

  • album_id (str | int) – Уникальный идентификатор альбома.

  • at (int) – Индекс для вставки.

  • revision (int) – TODO.

  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

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

Return type:

yandex_music.Playlist

Raises:

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

users_playlists_delete_track(kind, from_, to, revision=1, user_id=None, *args, **kwargs)

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

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 – Базовое исключение библиотеки.

playlists_collective_join(user_id, token, **kwargs)

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

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 – Базовое исключение библиотеки.

users_playlists_list(user_id=None, *args, **kwargs)

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

Parameters:

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

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

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

Returns:

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

Return type:

list из yandex_music.Playlist

Raises:

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

playlist(playlist_uuid, *args, **kwargs)

Получение плейлиста по его UUID.

Parameters:

  • playlist_uuid (str) – UUID плейлиста.

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

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

Returns:

Плейлист или None.

Return type:

yandex_music.Playlist | None

Raises:

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

playlist_similar_entities(playlist_uuid, *args, **kwargs)

Получение похожих сущностей для плейлиста.

Parameters:

  • playlist_uuid (str) – UUID плейлиста.

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

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

Returns:

Похожие сущности или None.

Return type:

yandex_music.PlaylistSimilarEntities | None

Raises:

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

playlists(playlist_ids, *args, **kwargs)

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

Note

Идентификаторы плейлистов имеют формат uid:kind (например, 503646255:161344908).

Parameters:

  • playlist_ids (str | list из str) – Идентификатор плейлиста или список идентификаторов в формате uid:kind.

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

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

Returns:

Список плейлистов или None.

Return type:

yandex_music.PlaylistsList | None

Raises:

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

playlists_list(playlist_ids, *args, **kwargs)

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

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 – Базовое исключение библиотеки.

playlists_personal(playlist_id, *args, **kwargs)

Получение персонального плейлиста.

Note

Известные значения playlist_id: daily (Плейлист дня), missedLikes (Тайник), recentTracks (Премьера), neverHeard (Дежавю), podcasts (Подкасты недели), origin (Плейлист с Алисой).

Parameters:

  • playlist_id (str) – Идентификатор персонального плейлиста.

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

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

Returns:

Персональный плейлист или None.

Return type:

yandex_music.GeneratedPlaylist | None

Raises:

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

users_playlists_description(kind, description, user_id=None, *args, **kwargs)

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • description (str) – Новое описание.

  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

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

Return type:

yandex_music.Playlist | None

Raises:

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

users_playlists_trailer(kind, user_id=None, *args, **kwargs)

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

Parameters:

  • kind (str | int) – Уникальный идентификатор плейлиста.

  • user_id (str | int, optional) – Уникальный идентификатор пользователя владеющим плейлистом.

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

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

Returns:

Трейлер плейлиста или None.

Return type:

yandex_music.PlaylistTrailer | None

Raises:

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

users_playlists_kinds(user_id=None, *args, **kwargs)

Получение списка идентификаторов (kind) плейлистов пользователя.

Parameters:

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

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

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

Returns:

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

Return type:

list из int

Raises:

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