deskflow/scripts/lib/env.py

import os, sys, subprocess
import lib.cmd_utils as cmd_utils

venv_path = "build/python"
version_file = "VERSION"
version_env_var = "SYNERGY_VERSION"


def check_module(module):
    try:
        __import__(module)
        return True
    except ImportError:
        print(f"Python is missing {module} module", file=sys.stderr)
        return False


def get_os():
    """Detects the operating system."""
    if sys.platform == "win32":
        return "windows"
    elif sys.platform == "darwin":
        return "mac"
    elif sys.platform.startswith("linux"):
        return "linux"
    else:
        raise RuntimeError(f"Unsupported platform: {sys.platform}")


def is_windows():
    return get_os() == "windows"


def is_mac():
    return get_os() == "mac"


def is_linux():
    return get_os() == "linux"


def is_running_in_ci():
    """Returns True if running in a CI environment."""
    return os.environ.get("CI")


def get_linux_distro():
    """Detects the Linux distro."""
    os_file = "/etc/os-release"
    if os.path.isfile(os_file):
        with open(os_file) as f:
            for line in f:
                if line.startswith("ID="):
                    return line.strip().split("=")[1].strip('"')
    return None


def get_env_var(name):
    """Returns an env var or raises an error if it is not set."""
    value = os.getenv(name)
    if not value:
        raise ValueError(f"Environment variable not set: {name}")
    return value


def get_python_executable(binary="python"):
    if sys.platform == "win32":
        return os.path.join(venv_path, "Scripts", binary)
    else:
        return os.path.join(venv_path, "bin", binary)


def in_venv():
    """Returns True if the script is running in a Python virtual environment."""
    return sys.prefix != sys.base_prefix


def ensure_in_venv(script_file):
    """
    Ensures the script is running in a Python virtual environment (venv).
    If the script is not running in a venv, it will create one and re-run the script in the venv.
    """

    assert_dependencies()
    import venv

    if not in_venv():
        if not os.path.exists(venv_path):
            print(f"Creating virtual environment at {venv_path}")
            venv.create(venv_path, with_pip=True)

        print(f"Using virtual environment for {script_file}", flush=True)
        python_executable = get_python_executable()
        result = subprocess.run([python_executable, script_file] + sys.argv[1:])
        sys.exit(result.returncode)


# TODO: Use requirements.txt or pyproject.toml to specify dependencies
def ensure_module(module, package):
    """
    Ensures that a Python module is available, and installs the package if it is not.
    """

    assert_dependencies()

    try:
        __import__(module)
    except ImportError:
        print(f"Python missing {module}, installing {package}...", file=sys.stderr)
        cmd_utils.run(
            [sys.executable, "-m", "pip", "install", package],
            shell=False,
            print_cmd=True,
        )


def assert_dependencies(raise_error=True):
    """
    Returns True if pip and venv are available.
    """

    has_pip = check_module("pip")
    has_venv = check_module("venv")

    if raise_error:
        if not has_pip:
            raise RuntimeError("Python is missing pip")
        if not has_venv:
            raise RuntimeError("Python is missing venv")
    else:
        return has_pip and has_venv


def ensure_dependencies():
    """
    Ensures that pip and venv are available, and installs them if they are not.
    This is normally only installs on Linux, as Windows and Mac usually come with pip and venv.
    """

    if assert_dependencies(raise_error=False):
        return

    print("Installing Python dependencies...")

    os = get_os()
    if os != "linux":
        # should not be a problem, since windows and mac come with pip and venv
        raise RuntimeError(f"Unable to install Python dependencies on {os}")

    has_sudo = cmd_utils.has_command("sudo")
    sudo = "sudo" if has_sudo else ""

    distro = get_linux_distro()
    if distro == "ubuntu" or distro == "debian":
        cmd_utils.run(
            f"{sudo} apt update".strip(), check=False, shell=True, print_cmd=True
        )
        cmd_utils.run(
            f"{sudo} apt install -y python3-pip python3-venv".strip(),
            shell=True,
            print_cmd=True,
        )
    elif distro == "fedora" or distro == "centos":
        cmd_utils.run(
            f"{sudo} dnf check-update".strip(), check=False, shell=True, print_cmd=True
        )
        cmd_utils.run(
            f"{sudo} dnf install -y python3-pip python3-virtualenv".strip(),
            shell=True,
            print_cmd=True,
        )
    else:
        # arch, opensuse, etc, patches welcome! :)
        raise RuntimeError(f"Unable to install Python dependencies on {distro}")


def get_app_version():
    """
    Returns the version either from the env var, or from the version file.
    """
    if version_env_var in os.environ:
        version = os.environ[version_env_var].strip()
        if version:
            return version

    with open(version_file, "r") as f:
        return f.read().strip()