yandex-music-api/yandex_music/download_info.py

215 行
8.1 KiB
Python
Raw Blame 履歴

このファイルには曖昧(ambiguous)なUnicode文字が含まれています

このファイルには、他の文字と見間違える可能性があるUnicode文字が含まれています。 それが意図的なものと考えられる場合は、この警告を無視して構いません。 それらの文字を表示するにはエスケープボタンを使用します。

from typing import TYPE_CHECKING, Optional, List
from hashlib import md5
import xml.dom.minidom as minidom
from yandex_music import YandexMusicObject
from yandex_music.utils import model
if TYPE_CHECKING:
from yandex_music import Client
from xml.dom.minicompat import NodeList
SIGN_SALT = 'XGRlBW9FXlekgbPrRHuSiA'
@model
class DownloadInfo(YandexMusicObject):
"""Класс, представляющий информацию о вариантах загрузки трека.
Attributes:
codec (:obj:`str`): Кодек аудиофайла.
bitrate_in_kbps (:obj:`int`): Битрейт аудиофайла в кбит/с.
gain (:obj:`bool`): Усиление TODO.
preview (:obj:`bool`): Предварительный просмотр TODO.
download_info_url (:obj:`str`): Ссылка на XML документ содержащий данные для загрузки трека.
direct (:obj:`bool`): Прямая ли ссылка.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
"""
codec: str
bitrate_in_kbps: int
gain: bool
preview: bool
download_info_url: str
direct: bool
client: Optional['Client'] = None
def __post_init__(self):
self.direct_link = None
self._id_attrs = (self.codec, self.bitrate_in_kbps, self.gain, self.preview, self.download_info_url)
@staticmethod
def _get_text_node_data(elements: 'NodeList') -> str:
""":obj:`str`: Получение текстовой информации из узлов XML элемента."""
for element in elements:
nodes = element.childNodes
for node in nodes:
if node.nodeType == node.TEXT_NODE:
return node.data
def __build_direct_link(self, xml: str) -> str:
doc = minidom.parseString(xml)
host = self._get_text_node_data(doc.getElementsByTagName('host'))
path = self._get_text_node_data(doc.getElementsByTagName('path'))
ts = self._get_text_node_data(doc.getElementsByTagName('ts'))
s = self._get_text_node_data(doc.getElementsByTagName('s'))
sign = md5((SIGN_SALT + path[1::] + s).encode('utf-8')).hexdigest()
return f'https://{host}/get-mp3/{sign}/{ts}{path}'
def get_direct_link(self) -> str:
"""Получение прямой ссылки на загрузку из XML ответа.
Метод доступен только одну минуту с момента получения информации о загрузке, иначе 410 ошибка!
Returns:
:obj:`str`: Прямая ссылка на загрузку трека.
"""
result = self.client.request.retrieve(self.download_info_url)
self.direct_link = self.__build_direct_link(result)
return self.direct_link
async def get_direct_link_async(self) -> str:
"""Получение прямой ссылки на загрузку из XML ответа.
Метод доступен только одну минуту с момента получения информации о загрузке, иначе 410 ошибка!
Returns:
:obj:`str`: Прямая ссылка на загрузку трека.
"""
result = await self.client.request.retrieve(self.download_info_url)
self.direct_link = self.__build_direct_link(result)
return self.direct_link
def download(self, filename: str) -> None:
"""Загрузка трека.
Args:
filename (:obj:`str`): Путь и(или) название файла вместе с расширением.
"""
if self.direct_link is None:
self.get_direct_link()
self.client.request.download(self.direct_link, filename)
async def download_async(self, filename: str) -> None:
"""Загрузка трека.
Args:
filename (:obj:`str`): Путь и(или) название файла вместе с расширением.
"""
if self.direct_link is None:
await self.get_direct_link_async()
await self.client.request.download(self.direct_link, filename)
def download_bytes(self) -> bytes:
"""Загрузка трека и возврат в виде байтов.
Returns:
:obj:`bytes`: Трек в виде байтов.
"""
if self.direct_link is None:
self.get_direct_link()
return self.client.request.retrieve(self.direct_link)
async def download_bytes_async(self) -> bytes:
"""Загрузка трека и возврат в виде байтов.
Returns:
:obj:`bytes`: Трек в виде байтов.
"""
if self.direct_link is None:
await self.get_direct_link_async()
return await self.client.request.retrieve(self.direct_link)
@classmethod
def de_json(cls, data: dict, client: 'Client') -> Optional['DownloadInfo']:
"""Десериализация объекта.
Args:
data (:obj:`dict`): Поля и значения десериализуемого объекта.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`yandex_music.DownloadInfo`: Варианты загрузки треков.
"""
if not data:
return None
data = super(DownloadInfo, cls).de_json(data, client)
return cls(client=client, **data)
@classmethod
def de_list(cls, data: dict, client: 'Client', get_direct_links: bool = False) -> List['DownloadInfo']:
"""Десериализация списка объектов.
Args:
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
get_direct_links (:obj:`bool`): Получать ли сразу прямые ссылки на загрузку.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`list` из :obj:`yandex_music.DownloadInfo`: Варианты загрузки треков.
"""
if not data:
return []
downloads_info = list()
for download_info in data:
downloads_info.append(cls.de_json(download_info, client))
if get_direct_links:
for info in downloads_info:
info.get_direct_link()
return downloads_info
@classmethod
async def de_list_async(cls, data: dict, client: 'Client', get_direct_links: bool = False) -> List['DownloadInfo']:
"""Десериализация списка объектов.
Args:
data (:obj:`list`): Список словарей с полями и значениями десериализуемого объекта.
get_direct_links (:obj:`bool`): Получать ли сразу прямые ссылки на загрузку.
client (:obj:`yandex_music.Client`, optional): Клиент Yandex Music.
Returns:
:obj:`list` из :obj:`yandex_music.DownloadInfo`: Варианты загрузки треков.
"""
if not data:
return []
downloads_info = list()
for download_info in data:
downloads_info.append(cls.de_json(download_info, client))
if get_direct_links:
for info in downloads_info:
await info.get_direct_link_async()
return downloads_info
# camelCase псевдонимы
#: Псевдоним для :attr:`get_direct_link`
getDirectLink = get_direct_link
#: Псевдоним для :attr:`get_direct_link_async`
getDirectLinkAsync = get_direct_link_async
#: Псевдоним для :attr:`download_async`
downloadAsync = download_async
#: Псевдоним для :attr:`download_bytes`
downloadBytes = download_bytes
#: Псевдоним для :attr:`download_bytes_async`
downloadBytesAsync = download_bytes_async