Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time
123 lines (105 sloc) 3.9 KB
"""Helpers to install PyPi packages."""
from __future__ import annotations
import asyncio
from importlib.metadata import PackageNotFoundError, version
import logging
import os
from pathlib import Path
from subprocess import PIPE, Popen
import sys
from urllib.parse import urlparse
import pkg_resources
_LOGGER = logging.getLogger(__name__)
def is_virtual_env() -> bool:
"""Return if we run in a virtual environment."""
# Check supports venv && virtualenv
return getattr(sys, "base_prefix", sys.prefix) != sys.prefix or hasattr(
sys, "real_prefix"
def is_docker_env() -> bool:
"""Return True if we run in a docker env."""
return Path("/.dockerenv").exists()
def is_installed(package: str) -> bool:
"""Check if a package is installed and will be loaded when we import it.
Returns True when the requirement is met.
Returns False when the package is not installed or doesn't meet req.
return True
except (pkg_resources.ResolutionError, pkg_resources.ExtractionError):
req = pkg_resources.Requirement.parse(package)
except ValueError:
# This is a zip file. We no longer use this in Home Assistant,
# leaving it in for custom components.
req = pkg_resources.Requirement.parse(urlparse(package).fragment)
installed_version = version(req.project_name)
# This will happen when an install failed or
# was aborted while in progress see
if installed_version is None:
_LOGGER.error("Installed version for %s resolved to None", req.project_name) # type: ignore
return False
return installed_version in req
except PackageNotFoundError:
return False
def install_package(
package: str,
upgrade: bool = True,
target: str | None = None,
constraints: str | None = None,
find_links: str | None = None,
no_cache_dir: bool | None = False,
) -> bool:
"""Install a package on PyPi. Accepts pip compatible package strings.
Return boolean if install successful.
# Not using 'import pip; pip.main([])' because it breaks the logger"Attempting install of %s", package)
env = os.environ.copy()
args = [sys.executable, "-m", "pip", "install", "--quiet", package]
if no_cache_dir:
if upgrade:
if constraints is not None:
args += ["--constraint", constraints]
if find_links is not None:
args += ["--find-links", find_links, "--prefer-binary"]
if target:
assert not is_virtual_env()
# This only works if not running in venv
args += ["--user"]
env["PYTHONUSERBASE"] = os.path.abspath(target)
if sys.platform != "win32":
# Workaround for incompatible prefix setting
# See
args += ["--prefix="]
process = Popen(args, stdin=PIPE, stdout=PIPE, stderr=PIPE, env=env)
_, stderr = process.communicate()
if process.returncode != 0:
"Unable to install package %s: %s",
return False
return True
async def async_get_user_site(deps_dir: str) -> str:
"""Return user local library path.
This function is a coroutine.
env = os.environ.copy()
env["PYTHONUSERBASE"] = os.path.abspath(deps_dir)
args = [sys.executable, "-m", "site", "--user-site"]
process = await asyncio.create_subprocess_exec(
stdout, _ = await process.communicate()
lib_dir = stdout.decode().strip()
return lib_dir