yandex_music.playlist.playlist

class yandex_music.playlist.playlist.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, playlist_uuid: Optional[str] = None, type: Optional[str] = None, ready: Optional[bool] = None, is_for_from: Any = None, regions: Any = None, client: Optional[Client] = None)

Bases: YandexMusicObject

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

Note

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

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

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

Известные значения type: missedLikes, recentTracks.

owner

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

Type

yandex_music.User, optional

cover

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

Type

yandex_music.Cover, optional

made_for

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

Type

yandex_music.MadeFor, optional

play_counter

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

Type

yandex_music.PlayCounter, optional

playlist_absence

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

Type

yandex_music.PlaylistAbsence, optional

uid

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

Type

int, optional

kind

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

Type

int, optional

title

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

Type

str, optional

track_count

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

Type

int, optional

tags

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

Type

list, optional

revision

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

Type

int, optional

snapshot

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

Type

int, optional

visibility

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

Type

str, optional

collective

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

Type

bool, optional

url_part

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

Type

str, optional

created

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

Type

str, optional

modified

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

Type

str, optional

available

Доступен TODO.

Type

bool, optional

is_banner

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

Type

bool, optional

is_premiere

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

Type

bool, optional

duration_ms

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

Type

int, optional

og_image

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

Type

str, optional

og_title

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

Type

str, optional

og_description

Описание Open Graph.

Type

str, optional

image

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

Type

str, optional

cover_without_text

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

Type

yandex_music.Cover, optional

contest

Контест TODO.

Type

yandex_music.Contest, optional

background_color

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

Type

str, optional

text_color

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

Type

str, optional

id_for_from

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

Type

str, optional

dummy_description

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

Type

str, optional

dummy_page_description

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

Type

str, optional

dummy_cover

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

Type

str, optional

dummy_rollover_cover

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

Type

str, optional

og_data

Данные для OpenGraph.

Type

yandex_music.OpenGraphData, optional

branding

Бренд.

Type

yandex_music.Brand

metrika_id

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

Type

int, optional

coauthors

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

Type

list из int, optional

top_artist

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

Type

list из yandex_music.Artist, optional

recent_tracks

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

Type

list из yandex_music.TrackId, optional

tracks

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

Type

list из yandex_music.TrackShort, optional

prerolls

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

Type

list, optional

likes_count

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

Type

int, optional

similar_playlists

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

Type

list из yandex_music.Playlist, optional

last_owner_playlists

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

Type

list из yandex_music.Playlist, optional

generated_playlist_type

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

Type

str, optional

animated_cover_uri

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

Type

str, optional

ever_played

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

Type

str, optional

description

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

Type

str, optional

description_formatted

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

Type

str, optional

playlist_uuid

TODO.

Type

str, optional

type

TODO.

Type

str, optional

ready

Готовность TODO.

Type

bool, optional

is_for_from

TODO.

Type

Any

regions

Регион TODO.

Type

Any

client

Клиент Yandex Music.

Type

yandex_music.Client, optional

animated_cover_uri: Optional[str] = None

available: Optional[bool] = None

background_color: Optional[str] = None

branding: Optional[Brand] = None

client: Optional[Client] = None

coauthors: List[int] = None

collective: Optional[bool] = None

contest: Optional[Contest] = None

cover: Optional[Cover]

cover_without_text: Optional[Cover] = None

created: Optional[str] = None

classmethod de_json(data: dict, client: Client) → Optional[Playlist]

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

Parameters

• data (dict) – Поля и значения десериализуемого объекта.

• client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns

Плейлист.

Return type

yandex_music.Playlist

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

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

Parameters

• data (list) – Список словарей с полями и значениями десериализуемого объекта.

• client (yandex_music.Client, optional) – Клиент Yandex Music.

Returns

Плейлисты.

Return type

list из yandex_music.Playlist

delete(*args, **kwargs)

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

client.users_playlists_delete(self.kind, self.owner.uid)

async deleteAsync(*args, **kwargs)

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

deleteTracks(from_: int, to: int, *args, **kwargs) → Optional[Playlist]

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

async deleteTracksAsync(from_: int, to: int, *args, **kwargs) → Optional[Playlist]

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

async delete_async(*args, **kwargs)

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

await client.users_playlists_delete(self.kind, self.owner.uid)

delete_tracks(from_: int, to: int, *args, **kwargs) → Optional[Playlist]

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

client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)

async delete_tracks_async(from_: int, to: int, *args, **kwargs) → Optional[Playlist]

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

await client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)

description: Optional[str] = None

description_formatted: Optional[str] = None

dislike(*args, **kwargs) → bool

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

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

async dislikeAsync(*args, **kwargs) → bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters

• filename (str) – Путь для сохранения файла с названием и расширением (GIF).

• size (str, optional) – Размер анимированной обложки.

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

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

Parameters

• filename (str) – Путь для сохранения файла с названием и расширением (GIF).

• size (str, optional) – Размер анимированной обложки.

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

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

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

Parameters

• filename (str) – Путь для сохранения файла с названием и расширением.

• size (str, optional) – Размер обложки.

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

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

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

Parameters

• filename (str) – Путь для сохранения файла с названием и расширением.

• size (str, optional) – Размер обложки.

dummy_cover: Optional[Cover] = None

dummy_description: Optional[str] = None

dummy_page_description: Optional[str] = None

dummy_rollover_cover: Optional[Cover] = None

duration_ms: Optional[int] = None

ever_played: Optional[bool] = None

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

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

async fetchTracksAsync(*args, **kwargs) → List[TrackShort]

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

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

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

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

async fetch_tracks_async(*args, **kwargs) → List[TrackShort]

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

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

generated_playlist_type: Optional[str] = None

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

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

async getRecommendationsAsync(*args, **kwargs) → Optional[PlaylistRecommendations]

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

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

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

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

async get_recommendations_async(*args, **kwargs) → Optional[PlaylistRecommendations]

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

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

id_for_from: Optional[str] = None

image: Optional[str] = None

insertTrack(track_id: int, album_id: int, *args, **kwargs) → Optional[Playlist]

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

async insertTrackAsync(track_id: int, album_id: int, *args, **kwargs) → Optional[Playlist]

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

insert_track(track_id: int, album_id: int, *args, **kwargs) → Optional[Playlist]

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

client.users_playlists_insert_track(self.kind, track_id, album_id, user_id=self.owner.uid, revision=self.revision, *args, **kwargs)

async insert_track_async(track_id: int, album_id: int, *args, **kwargs) → Optional[Playlist]

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

await client.users_playlists_insert_track(self.kind, track_id, album_id, user_id=self.owner.uid, revision=self.revision, *args, **kwargs)

property isMine: bool

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

is_banner: Optional[bool] = None

is_for_from: Any = None

property is_mine: bool

is_premiere: Optional[bool] = None

kind: Optional[int] = None

last_owner_playlists: List[Playlist] = None

like(*args, **kwargs) → bool

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

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

async likeAsync(*args, **kwargs) → bool

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

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

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

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

likes_count: Optional[int] = None

made_for: Optional[MadeFor]

metrika_id: Optional[int] = None

modified: Optional[str] = None

og_data: Optional[OpenGraphData] = None

og_description: Optional[str] = None

og_image: Optional[str] = None

og_title: Optional[str] = None

owner: Optional[User]

play_counter: Optional[PlayCounter]

property playlistId: str

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

playlist_absence: Optional[PlaylistAbsence]

property playlist_id: str

playlist_uuid: Optional[str] = None

prerolls: Optional[list] = None

ready: Optional[bool] = None

recent_tracks: List[TrackId] = None

regions: Any = None

rename(name: str) → None

async renameAsync(name: str) → None

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

async rename_async(name: str) → None

revision: Optional[int] = None

similar_playlists: List[Playlist] = None

snapshot: Optional[int] = None

tags: Optional[list] = None

text_color: Optional[str] = None

title: Optional[str] = None

top_artist: List[Artist] = None

track_count: Optional[int] = None

tracks: List[TrackShort] = None

type: Optional[str] = None

uid: Optional[int] = None

url_part: Optional[str] = None

visibility: Optional[str] = None