def __init__(self,
path: Path,
*,
verbose: bool = False,
python: str = DEFAULT_PYTHON) -> None:
self.root = path
self.python = python
self.bin_path, self.python_path = get_venv_paths(self.root)
self.pipx_metadata = PipxMetadata(venv_dir=path)
self.verbose = verbose
self.do_animation = not verbose
try:
self._existing = self.root.exists() and next(self.root.iterdir())
except StopIteration:
self._existing = False
if self._existing and self.uses_shared_libs:
if shared_libs.is_valid:
if shared_libs.needs_upgrade:
shared_libs.upgrade(verbose=verbose)
else:
shared_libs.create(verbose)
if not shared_libs.is_valid:
raise PipxError(
pipx_wrap(f"""
Error: pipx's shared venv {shared_libs.root} is invalid
and needs re-installation. To fix this, install or
reinstall a package. For example:
""") + f"\n pipx install {self.root.name} --force",
wrap_message=False,
)
def __init__(self,
path: Path,
*,
verbose: bool = False,
python: str = DEFAULT_PYTHON) -> None:
self.root = path
self._python = python
self.bin_path, self.python_path = get_venv_paths(self.root)
self.pipx_metadata = PipxMetadata(venv_dir=path)
self.verbose = verbose
self.do_animation = not verbose
try:
self._existing = self.root.exists() and next(self.root.iterdir())
except StopIteration:
self._existing = False
if self._existing and self.uses_shared_libs and not shared_libs.is_valid:
logging.warning(
f"Shared libraries not found, but are required for package {self.root.name}. "
"Attempting to install now.")
shared_libs.create([])
if shared_libs.is_valid:
logging.info("Successfully created shared libraries")
else:
raise PipxError(
f"Error: pipx's shared venv is invalid and "
"needs re-installation. To fix this, install or reinstall a "
"package. For example,\n"
f" pipx install {self.root.name} --force")
def test_package_inject(monkeypatch, tmp_path, pipx_temp_env):
pipx_venvs_dir = pipx.constants.PIPX_HOME / "venvs"
run_pipx_cli(["install", "pycowsay"])
run_pipx_cli(["inject", "pycowsay", "black==19.10b0"])
assert (pipx_venvs_dir / "pycowsay" / "pipx_metadata.json").is_file()
pipx_metadata = PipxMetadata(pipx_venvs_dir / "pycowsay")
assert pipx_metadata.injected_packages.keys() == {"black"}
if pipx.constants.WINDOWS:
ref_replacement_fields = {
"apps": ["black.exe", "blackd.exe"],
"app_paths": [
pipx_venvs_dir / "pycowsay" / "Scripts" / "black.exe",
pipx_venvs_dir / "pycowsay" / "Scripts" / "blackd.exe",
],
}
else:
ref_replacement_fields = {
"apps": ["black", "blackd"],
"app_paths": [
pipx_venvs_dir / "pycowsay" / "bin" / "black",
pipx_venvs_dir / "pycowsay" / "bin" / "blackd",
],
}
assert_package_metadata(
pipx_metadata.injected_packages["black"],
BLACK_PACKAGE_REF._replace(include_apps=False, **ref_replacement_fields),
)
def get_venv_metadata_summary(venv_dir: Path) -> Tuple[PipxMetadata, VenvProblems, str]:
venv = Venv(venv_dir)
(venv_problems, warning_message) = venv_health_check(venv)
if venv_problems.any_():
return (PipxMetadata(venv_dir, read=False), venv_problems, warning_message)
return (venv.pipx_metadata, venv_problems, "")
def test_pipx_metadata_file_create(tmp_path):
pipx_metadata = PipxMetadata(tmp_path)
pipx_metadata.main_package = TEST_PACKAGE1
pipx_metadata.python_version = "3.4.5"
pipx_metadata.venv_args = ["--system-site-packages"]
pipx_metadata.injected_packages = {"injected": TEST_PACKAGE2}
pipx_metadata.write()
pipx_metadata2 = PipxMetadata(tmp_path)
for attribute in [
"venv_dir",
"main_package",
"python_version",
"venv_args",
"injected_packages",
]:
assert getattr(pipx_metadata,
attribute) == getattr(pipx_metadata2, attribute)
def test_package_install(monkeypatch, tmp_path, pipx_temp_env):
pipx_venvs_dir = pipx.constants.PIPX_HOME / "venvs"
run_pipx_cli(["install", PKG["pycowsay"]["spec"]])
assert (pipx_venvs_dir / "pycowsay" / "pipx_metadata.json").is_file()
pipx_metadata = PipxMetadata(pipx_venvs_dir / "pycowsay")
pycowsay_package_ref = create_package_info_ref("pycowsay", "pycowsay",
pipx_venvs_dir)
assert_package_metadata(pipx_metadata.main_package, pycowsay_package_ref)
assert pipx_metadata.injected_packages == {}
def test_pipx_metadata_file_validation(tmp_path, test_package):
venv_dir = tmp_path / "venv"
venv_dir.mkdir()
pipx_metadata = PipxMetadata(venv_dir)
pipx_metadata.main_package = test_package
pipx_metadata.python_version = "3.4.5"
pipx_metadata.venv_args = ["--system-site-packages"]
pipx_metadata.injected_packages = {}
with pytest.raises(PipxError):
pipx_metadata.write()
def test_package_inject(monkeypatch, tmp_path, pipx_temp_env):
pipx_venvs_dir = pipx.constants.PIPX_HOME / "venvs"
run_pipx_cli(["install", PKG["pycowsay"]["spec"]])
run_pipx_cli(["inject", "pycowsay", PKG["black"]["spec"]])
assert (pipx_venvs_dir / "pycowsay" / "pipx_metadata.json").is_file()
pipx_metadata = PipxMetadata(pipx_venvs_dir / "pycowsay")
assert pipx_metadata.injected_packages.keys() == {"black"}
black_package_ref = create_package_info_ref("pycowsay",
"black",
pipx_venvs_dir,
include_apps=False)
assert_package_metadata(pipx_metadata.injected_packages["black"],
black_package_ref)
def test_package_install(monkeypatch, tmp_path, pipx_temp_env):
pipx_venvs_dir = pipx.constants.PIPX_HOME / "venvs"
run_pipx_cli(["install", "pycowsay"])
assert (pipx_venvs_dir / "pycowsay" / "pipx_metadata.json").is_file()
pipx_metadata = PipxMetadata(pipx_venvs_dir / "pycowsay")
if pipx.constants.WINDOWS:
ref_replacement_fields = {
"app_paths": [pipx_venvs_dir / "pycowsay" / "Scripts" / "pycowsay.exe"],
"apps": ["pycowsay.exe"],
}
else:
ref_replacement_fields = {
"app_paths": [pipx_venvs_dir / "pycowsay" / "bin" / "pycowsay"]
}
assert_package_metadata(
pipx_metadata.main_package,
PYCOWSAY_PACKAGE_REF._replace(include_apps=True, **ref_replacement_fields),
)