yandex_music.Playlist

class yandex_music.Playlist(owner: Optional[User], cover: Optional[Cover], made_for: Optional[MadeFor], play_counter: Optional[PlayCounter], playlist_absence: Optional[PlaylistAbsence], uid: Optional[int] = None, kind: Optional[int] = None, title: Optional[str] = None, track_count: Optional[int] = None, tags: Optional[list] = None, revision: Optional[int] = None, snapshot: Optional[int] = None, visibility: Optional[str] = None, collective: Optional[bool] = None, url_part: Optional[str] = None, created: Optional[str] = None, modified: Optional[str] = None, available: Optional[bool] = None, is_banner: Optional[bool] = None, is_premiere: Optional[bool] = None, duration_ms: Optional[int] = None, og_image: Optional[str] = None, og_title: Optional[str] = None, og_description: Optional[str] = None, image: Optional[str] = None, cover_without_text: Optional[Cover] = None, contest: Optional[Contest] = None, background_color: Optional[str] = None, text_color: Optional[str] = None, id_for_from: Optional[str] = None, dummy_description: Optional[str] = None, dummy_page_description: Optional[str] = None, dummy_cover: Optional[Cover] = None, dummy_rollover_cover: Optional[Cover] = None, og_data: Optional[OpenGraphData] = None, branding: Optional[Brand] = None, metrika_id: Optional[int] = None, coauthors: List[int] = None, top_artist: List[Artist] = None, recent_tracks: List[TrackId] = None, tracks: List[TrackShort] = None, prerolls: Optional[list] = None, likes_count: Optional[int] = None, similar_playlists: List[Playlist] = None, last_owner_playlists: List[Playlist] = None, generated_playlist_type: Optional[str] = None, animated_cover_uri: Optional[str] = None, ever_played: Optional[bool] = None, description: Optional[str] = None, description_formatted: Optional[str] = None, is_for_from=None, regions=None, client: Optional[Client] = None, **kwargs)
Базовые классы: yandex_music.base.YandexMusicObject

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

Примечание

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

Известные значения visibility: public - публичный плейлист, private - приватный плейлист.

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

owner

Владелец плейлиста.

Type:yandex_music.User
cover

Обложка альбома.

Type:yandex_music.Cover
made_for

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

Type:yandex_music.MadeFor
play_counter

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

Type:yandex_music.PlayCounter
playlist_absence

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

Type:yandex_music.PlaylistAbsence
uid

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

Type:int
kind

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

Type:int
title

Название плейлиста.

Type:str
track_count

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

Type:int
tags

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

Type:list
revision

Актуальность данных TODO.

Type:int
snapshot

Версия плейлиста. Увеличивается на 1 при каждом изменении.

Type:int
visibility

Видимость плейлиста.

Type:str
collective

Есть ли у плейлиста соавторы.

Type:bool
url_part

Часть ссылки на плейлист („daily`).

Type:str
created

Дата создания в формате ISO 8601.

Type:str
modified

Дата последнего изменения в формате ISO 8601.

Type:str
available

Доступен TODO.

Type:bool
is_banner

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

Type:bool
is_premiere

Является ли премьерой TODO.

Type:bool
duration_ms

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

Type:int
og_image

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

Type:str
og_title

Заголовок Open Graph.

Type:str
og_description

Описание Open Graph.

Type:str, optional
image

Изображение TODO.

Type:str
cover_without_text

Обложка без текста.

Type:yandex_music.Cover
contest

Контест TODO.

Type:yandex_music.Contest
background_color

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

Type:str
text_color

Цвет текста TODO.

Type:str
id_for_from

Откуда пришло событие (уникальный идентификатор объекта) TODO.

Type:str
dummy_description

Описание-заглушка плейлиста.

Type:str
dummy_page_description

Описание-заглушка страницы.

Type:str
dummy_cover

Обложка-заглушка.

Type:str
dummy_rollover_cover

Обложка-заглушка TODO.

Type:str
og_data

Данные для OpenGraph.

Type:yandex_music.OpenGraphData
branding

Бренд.

Type:yandex_music.Brand
metrika_id

Уникальный идентификатор счётчика на Яндекс.Метрика.

Type:int
coauthors

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

Type:list из int
top_artist

Топ артистов TODO.

Type:list из yandex_music.Artist
recent_tracks

Список ID недавних треков.

Type:list из yandex_music.TrackId
tracks

Список треков.

Type:list из yandex_music.TrackShort
prerolls

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

Type:list
likes_count

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

Type:int
similar_playlists

Похожие плейлисты.

Type:list из yandex_music.Playlist
last_owner_playlists

Последние плейлисты владельца.

Type:list из yandex_music.Playlist
generated_playlist_type

Тип генерируемого плейлиста.

Type:str
animated_cover_uri

Ссылка на анимированную обложку.

Type:str
ever_played

Играл ли этот плейлист. Присутствует только у персональных плейлистов. TODO

Type:str
description

Описание плейлиста с разметкой Markdown.

Type:str
description_formatted

Описание плейлиста. Только текст, без разметки.

Type:str
is_for_from

TODO.

regions

Регион TODO.

client

Клиент Yandex Music.

Type:yandex_music.Client
Параметры:
  • owner (yandex_music.User, optional) – Владелец плейлиста.
  • cover (yandex_music.Cover, optional) – Обложка альбома.
  • made_for (yandex_music.MadeFor, optional) – Пользователь для которого был создан плейлист. Присутствует только у персональных плейлистов.
  • play_counter (yandex_music.PlayCounter, optional) – Счётчик дней. Присутствует только у плейлиста дня.
  • playlist_absence (yandex_music.PlaylistAbsence, optional) – Причина отсутствия плейлиста.
  • uid (int, optional) – Идентификатор владельца плейлиста.
  • kind (int, optional) – Идентификатор плейлиста.
  • title (str, optional) – Название плейлиста.
  • track_count (int, optional) – Количество треков.
  • tags (list, optional) – Список тегов плейлиста.
  • revision (int, optional) – Актуальность данных TODO.
  • snapshot (int, optional) – Версия плейлиста. Увеличивается на 1 при каждом изменении.
  • visibility (str, optional) – Видимость плейлиста.
  • collective (bool, optional) – Есть ли у плейлиста соавторы.
  • url_part (str, optional) – Часть ссылки на плейлист („daily`).
  • created (str, optional) – Дата создания в формате ISO 8601.
  • modified (str, optional) – Дата последнего изменения в формате ISO 8601.
  • available (bool, optional) – Доступен TODO.
  • is_banner (bool, optional) – Является ли банером TODO.
  • is_premiere (bool, optional) – Является ли премьерой TODO.
  • duration_ms (int, optional) – Длительность в миллисекундах.
  • og_image (str, optional) – Ссылка на превью Open Graph.
  • og_title (str, optional) – Заголовок Open Graph.
  • og_description (str, optional) – Описание Open Graph.
  • image (str, optional) – Изображение TODO.
  • cover_without_text (yandex_music.Cover, optional) – Обложка без текста.
  • contest (yandex_music.Contest, optional) – Контест TODO.
  • background_color (str, optional) – Цвет заднего фона TODO.
  • text_color (str, optional) – Цвет текста TODO.
  • id_for_from (str, optional) – Откуда пришло событие (уникальный идентификатор объекта) TODO.
  • dummy_description (str, optional) – Описание-заглушка плейлиста.
  • dummy_page_description (str, optional) – Описание-заглушка страницы.
  • dummy_cover (str, optional) – Обложка-заглушка.
  • dummy_rollover_cover (str, optional) – Обложка-заглушка TODO.
  • og_data (yandex_music.OpenGraphData, optional) – Данные для OpenGraph.
  • branding (yandex_music.Brand) – Бренд.
  • metrika_id (int, optional) – Уникальный идентификатор счётчика на Яндекс.Метрика.
  • coauthors (list из int, optional) – Перечень ID аккаунтов соавторов плейлиста.
  • top_artist (list из yandex_music.Artist, optional) – Топ артистов TODO.
  • recent_tracks (list из yandex_music.TrackId, optional) – Список ID недавних треков.
  • tracks (list из yandex_music.TrackShort, optional) – Список треков.
  • prerolls (list, optional) – Прерол, проигрываемый перед плейлистом. Присутствует только у персональных плейлистов.
  • likes_count (int, optional) – Количество лайков.
  • similar_playlists (list из yandex_music.Playlist, optional) – Похожие плейлисты.
  • last_owner_playlists (list из yandex_music.Playlist, optional) – Последние плейлисты владельца.
  • generated_playlist_type (str, optional) – Тип генерируемого плейлиста.
  • animated_cover_uri (str, optional) – Ссылка на анимированную обложку.
  • ever_played (str, optional) – Играл ли этот плейлист. Присутствует только у персональных плейлистов. TODO
  • description (str, optional) – Описание плейлиста с разметкой Markdown.
  • description_formatted (str, optional) – Описание плейлиста. Только текст, без разметки.
  • is_for_from – TODO.
  • regions – Регион TODO.
  • client (yandex_music.Client, optional) – Клиент Yandex Music.
  • **kwargs – Произвольные ключевые аргументы полученные от API.
classmethod de_json(data: dict, client: Client) → Optional[Playlist]

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

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

Плейлист.

Тип результата:

yandex_music.Playlist

classmethod de_list(data: dict, client: Client) → List[Playlist]

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

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

Плейлисты.

Тип результата:

list из yandex_music.Playlist

dislike(*args, **kwargs) → bool

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

client.users_likes_playlists_remove(playlist.uid, user.id *args, **kwargs)

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

Псевдоним для download_animated_cover

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

Псевдоним для download_og_image

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

Загрузка анимированной обложки.

Параметры:
  • filename (str) – Путь для сохранения файла с названием и расширением (GIF).
  • size (str, optional) – Размер анимированной обложки.
download_og_image(filename: str, size: str = '200x200') → None

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

Используйте это только когда нет self.cover!

Параметры:
  • filename (str) – Путь для сохранения файла с названием и расширением.
  • size (str, optional) – Размер обложки.
fetchTracks(*args, **kwargs) → List[TrackShort]

Псевдоним для fetch_tracks

fetch_tracks(*args, **kwargs) → List[TrackShort]

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

client.users_playlists(playlist.kind, playlist.owner.id, *args, **kwargs).tracks

getRecommendations(*args, **kwargs) → Optional[PlaylistRecommendations]

Псевдоним для get_recommendations

get_recommendations(*args, **kwargs) → Optional[PlaylistRecommendations]

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

client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)

isMine

Псевдоним для is_mine

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

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

client.users_likes_playlists_add(playlist.uid, user.id *args, **kwargs)

playlistId

Псевдоним для playlist_id

playlist_id
rename(name: str) → None