yandex_music.playlist.playlist¶
- class yandex_music.playlist.playlist.Playlist(owner: User | None, cover: Cover | None, made_for: MadeFor | None, play_counter: PlayCounter | None, playlist_absence: PlaylistAbsence | None, uid: int | None = None, kind: int | None = None, title: str | None = None, track_count: int | None = None, tags: list | None = None, revision: int | None = None, snapshot: int | None = None, visibility: str | None = None, collective: bool | None = None, url_part: str | None = None, created: str | None = None, modified: str | None = None, available: bool | None = None, is_banner: bool | None = None, is_premiere: bool | None = None, duration_ms: int | None = None, og_image: str | None = None, og_title: str | None = None, og_description: str | None = None, image: str | None = None, cover_without_text: Cover | None = None, contest: Contest | None = None, background_color: str | None = None, text_color: str | None = None, id_for_from: str | None = None, dummy_description: str | None = None, dummy_page_description: str | None = None, dummy_cover: Cover | None = None, dummy_rollover_cover: Cover | None = None, og_data: OpenGraphData | None = None, branding: Brand | None = None, metrika_id: int | None = None, coauthors: List[int] = None, top_artist: List[Artist] = None, recent_tracks: List[TrackId] = None, tracks: List[TrackShort] = None, prerolls: list | None = None, likes_count: int | None = None, similar_playlists: List[Playlist] = None, last_owner_playlists: List[Playlist] = None, generated_playlist_type: str | None = None, animated_cover_uri: str | None = None, ever_played: bool | None = None, description: str | None = None, description_formatted: str | None = None, playlist_uuid: str | None = None, type: str | None = None, ready: bool | None = None, is_for_from: Any = None, regions: Any = None, custom_wave: CustomWave | None = None, pager: Pager | None = None, client: Client | None = 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:
- 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
- custom_wave (
obj:’yandex_music.CustomWave`, optional): Описание плейлиста. TODO.
- pager¶
Пагинатор.
- Type:
yandex_music.Pager
, optional
- client¶
Клиент Yandex Music.
- Type:
yandex_music.Client
, optional
- animated_cover_uri: str | None = None¶
- available: bool | None = None¶
- background_color: str | None = None¶
- coauthors: List[int] = None¶
- collective: bool | None = None¶
- created: str | None = None¶
- custom_wave: CustomWave | None = None¶
- classmethod de_json(data: dict, client: Client) Playlist | None ¶
Десериализация объекта.
- Parameters:
data (
dict
) – Поля и значения десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Плейлист.
- Return type:
- classmethod de_list(data: list, client: Client) List[Playlist] ¶
Десериализация списка объектов.
- Parameters:
data (
list
) – Список словарей с полями и значениями десериализуемого объекта.client (
yandex_music.Client
, optional) – Клиент Yandex Music.
- Returns:
Плейлисты.
- Return type:
list
изyandex_music.Playlist
- delete(*args, **kwargs) bool ¶
Сокращение для:
client.users_playlists_delete(self.kind, self.owner.uid)
- async deleteAsync(*args, **kwargs) bool ¶
Псевдоним для
delete_async
- deleteTracks(from_: int, to: int, *args, **kwargs) Playlist | None ¶
Псевдоним для
delete_tracks
- async deleteTracksAsync(from_: int, to: int, *args, **kwargs) Playlist | None ¶
Псевдоним для
delete_tracks_async
- async delete_async(*args, **kwargs) bool ¶
Сокращение для:
await client.users_playlists_delete(self.kind, self.owner.uid)
- delete_tracks(from_: int, to: int, *args, **kwargs) Playlist | None ¶
Сокращение для:
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) Playlist | None ¶
Сокращение для:
await client.users_playlists_delete_track(self.kind, from_, to, self.revision, self.owner.uid, *args, **kwargs)
- description: str | None = None¶
- description_formatted: str | None = 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
- downloadAnimatedCoverBytes(size: str = '200x200') bytes ¶
Псевдоним для
download_animated_cover_bytes
- async downloadAnimatedCoverBytesAsync(size: str = '200x200') bytes ¶
Псевдоним для
download_animated_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_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_animated_cover_bytes(size: str = '200x200') bytes ¶
Загрузка анимированной обложки и возврат в виде байтов.
- Parameters:
size (
str
, optional) – Размер анимированной обложки.- Returns:
Анимированная обложка в виде байтов.
- Return type:
bytes
- async download_animated_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.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) – Размер обложки.
- download_og_image_bytes(size: str = '200x200') bytes ¶
Загрузка обложки и возврат в виде байтов.
Используйте это только когда нет self.cover!
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Обложка в виде байтов.
- Return type:
bytes
- async download_og_image_bytes_async(size: str = '200x200') bytes ¶
Загрузка обложки и возврат в виде байтов.
Используйте это только когда нет self.cover!
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
Обложка в виде байтов.
- Return type:
bytes
- dummy_description: str | None = None¶
- dummy_page_description: str | None = None¶
- duration_ms: int | None = None¶
- ever_played: bool | None = 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: str | None = None¶
- getAnimatedCoverUrl(size: str = '300x300') str ¶
Псевдоним для
get_animated_cover_url
- getOgImageUrl(size: str = '300x300') str ¶
Псевдоним для
get_og_image_url
- getRecommendations(*args, **kwargs) PlaylistRecommendations | None ¶
Псевдоним для
get_recommendations
- async getRecommendationsAsync(*args, **kwargs) PlaylistRecommendations | None ¶
Псевдоним для
get_recommendations_async
- get_animated_cover_url(size: str = '300x300') str ¶
Возвращает URL анимированной обложки.
- Parameters:
size (
str
, optional) – Размер анимированной обложки.- Returns:
URL анимированной обложки.
- Return type:
str
- get_og_image_url(size: str = '300x300') str ¶
Возвращает URL обложки.
- Parameters:
size (
str
, optional) – Размер обложки.- Returns:
URL обложки.
- Return type:
str
- get_recommendations(*args, **kwargs) PlaylistRecommendations | None ¶
Сокращение для:
client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)
- async get_recommendations_async(*args, **kwargs) PlaylistRecommendations | None ¶
Сокращение для:
await client.users_playlists_recommendations(playlist.kind, playlist.owner.uid, *args, **kwargs)
- id_for_from: str | None = None¶
- image: str | None = None¶
- insertTrack(track_id: int, album_id: int, **kwargs) Playlist | None ¶
Псевдоним для
insert_track
- async insertTrackAsync(track_id: int, album_id: int, **kwargs) Playlist | None ¶
Псевдоним для
insert_track_async
- insert_track(track_id: int, album_id: int, **kwargs) Playlist | None ¶
Сокращение для:
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, **kwargs) Playlist | None ¶
Сокращение для:
await client.users_playlists_insert_track(self.kind, track_id, album_id, user_id=self.owner.uid, revision=self.revision, *args, **kwargs)
- is_banner: bool | None = None¶
- is_for_from: Any = None¶
- property is_mine: bool¶
Является ли плейлист моим.
- is_premiere: bool | None = None¶
- kind: int | None = 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: int | None = None¶
- metrika_id: int | None = None¶
- modified: str | None = None¶
- og_data: OpenGraphData | None = None¶
- og_description: str | None = None¶
- og_image: str | None = None¶
- og_title: str | None = None¶
- play_counter: PlayCounter | None¶
- property playlistId: str¶
Псевдоним для
playlist_id
- playlist_absence: PlaylistAbsence | None¶
- property playlist_id: str¶
Полный ID плейлиста.
- playlist_uuid: str | None = None¶
- prerolls: list | None = None¶
- ready: bool | None = None¶
- regions: Any = None¶
- rename(name: str, *args, **kwargs) None ¶
Сокращение для:
client.users_playlists_name(playlist.kind, name, *args, **kwargs)
- async renameAsync(name: str, *args, **kwargs) None ¶
Псевдоним для
rename_async
- async rename_async(name: str, *args, **kwargs) None ¶
Сокращение для:
client.users_playlists_name(playlist.kind, name, *args, **kwargs)
- revision: int | None = None¶
- snapshot: int | None = None¶
- tags: list | None = None¶
- text_color: str | None = None¶
- title: str | None = None¶
- track_count: int | None = None¶
- tracks: List[TrackShort] = None¶
- type: str | None = None¶
- uid: int | None = None¶
- url_part: str | None = None¶
- visibility: str | None = None¶