deno

Module for checking for a Deno binary, finding a local one, and downloading it.

DenoError

Bases: Exception

Base class for all exceptions related to Deno.

download_deno()

Download Deno binary to spotdl directory.

Returns

• Path to Deno binary.

Notes

• Deno is downloaded from dl.deno.land for the current platform and architecture.
• executable permission is set for Deno binary on linux and mac.

Source code in spotdl/utils/deno.py

def download_deno() -> Path:
    """
    Download Deno binary to spotdl directory.

    ### Returns
    - Path to Deno binary.

    ### Notes
    - Deno is downloaded from dl.deno.land for the current platform and architecture.
    - executable permission is set for Deno binary on linux and mac.
    """

    os_name = platform.system().lower()
    os_arch = platform.machine().lower()
    deno_target = DENO_TARGETS.get(os_name, {}).get(os_arch)

    if deno_target is None:
        raise DenoError("Deno binary is not available for your system.")

    try:
        latest_response = requests.get(
            DENO_RELEASE_LATEST_URL, allow_redirects=True, timeout=10
        )
        latest_response.raise_for_status()
    except requests.RequestException as error:
        response = getattr(error, "response", None)
        status_code = getattr(response, "status_code", "unknown")
        raise DenoError(
            f"Failed to fetch latest Deno version from {DENO_RELEASE_LATEST_URL} "
            f"(status: {status_code})."
        ) from error

    latest_version = latest_response.content.decode("utf-8").strip()
    deno_url = DENO_RELEASE_URL.format(version=latest_version, target=deno_target)

    try:
        archive_response = requests.get(deno_url, allow_redirects=True, timeout=10)
        archive_response.raise_for_status()
    except requests.RequestException as error:
        response = getattr(error, "response", None)
        status_code = getattr(response, "status_code", "unknown")
        raise DenoError(
            f"Failed to download Deno archive from {deno_url} "
            f"(status: {status_code})."
        ) from error

    deno_archive = archive_response.content
    deno_filename = "deno" + (".exe" if os_name == "windows" else "")
    deno_path = Path(get_spotdl_path()) / deno_filename

    try:
        archive = zipfile.ZipFile(BytesIO(deno_archive))
    except zipfile.BadZipFile as error:
        raise DenoError("Downloaded Deno archive is not a valid zip file.") from error

    with archive:
        binary_name = next(
            (name for name in archive.namelist() if Path(name).name == deno_filename),
            None,
        )

        if binary_name is None:
            raise DenoError("Deno binary was not found in the downloaded archive.")

        with archive.open(binary_name) as deno_binary:
            deno_path.write_bytes(deno_binary.read())

    if os_name in ["linux", "darwin"]:
        deno_path.chmod(deno_path.stat().st_mode | stat.S_IEXEC)

    return deno_path

get_deno_path()

Get path to global Deno binary or a local Deno binary.

Returns

• Path to Deno binary or None if not found.

Source code in spotdl/utils/deno.py

def get_deno_path() -> Optional[Path]:
    """
    Get path to global Deno binary or a local Deno binary.

    ### Returns
    - Path to Deno binary or None if not found.
    """

    global_deno = shutil.which("deno")
    if global_deno:
        return Path(global_deno)

    return get_local_deno()

get_local_deno()

Get local Deno binary path.

Returns

• Path to Deno binary or None if not found.

Source code in spotdl/utils/deno.py

def get_local_deno() -> Optional[Path]:
    """
    Get local Deno binary path.

    ### Returns
    - Path to Deno binary or None if not found.
    """

    deno_path = Path(get_spotdl_path()) / (
        "deno" + (".exe" if platform.system() == "Windows" else "")
    )

    if deno_path.is_file():
        return deno_path

    return None

get_local_deno_yt_dlp_options()

Get yt-dlp options that point to spotDL's local Deno binary.

Returns

• yt-dlp js_runtimes options or an empty dict if local Deno is unavailable.

Source code in spotdl/utils/deno.py

def get_local_deno_yt_dlp_options() -> Dict[str, Dict[str, Dict[str, str]]]:
    """
    Get yt-dlp options that point to spotDL's local Deno binary.

    ### Returns
    - yt-dlp js_runtimes options or an empty dict if local Deno is unavailable.
    """

    local_deno = get_local_deno()
    if local_deno is None or not os.access(local_deno, os.X_OK):
        return {}

    return {"js_runtimes": {"deno": {"path": str(local_deno.absolute())}}}

is_deno_installed(deno='deno')

Check if Deno is installed.

Arguments

• deno: Deno executable to check.

Returns

• True if Deno is installed, False otherwise.

Source code in spotdl/utils/deno.py

def is_deno_installed(deno: str = "deno") -> bool:
    """
    Check if Deno is installed.

    ### Arguments
    - deno: Deno executable to check.

    ### Returns
    - True if Deno is installed, False otherwise.
    """

    if deno == "deno":
        deno_path = get_deno_path()
    else:
        deno_path = Path(deno)

    if deno_path is None:
        return False

    return deno_path.exists() and os.access(deno_path, os.X_OK)

warn_if_deno_missing()

Warn if Deno is unavailable for yt-dlp downloads.

Source code in spotdl/utils/deno.py

def warn_if_deno_missing() -> None:
    """
    Warn if Deno is unavailable for yt-dlp downloads.
    """

    if is_deno_installed():
        return

    logger.warning(
        "Some YouTube downloads require Deno. Run spotdl --download-deno "
        "or install Deno system-wide."
    )