lpip.pipwrap

src/lpip/pipwrap.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
"""Translate catalog entries to pip and run ``python -m pip`` (ADR-0001)."""

from __future__ import annotations

import subprocess
from collections.abc import Mapping
from dataclasses import replace

from lpip.errors import InstallRevisionEqualsConflictError
from lpip.models import PackageSource, RenderedRequirement
from lpip.reqfile import parse_catalog_request
from lpip.validation import normalize_git_file_url
from lpip.versions import tag_for_version


def render_requirement(package: PackageSource) -> RenderedRequirement:
    """Build ``name @ url[@revision][#subdirectory=…]`` (AC-0006, ADR-0010)."""
    vcs = normalize_git_file_url(package.url)
    if package.revision:
        vcs = f"{vcs}@{package.revision}"
    if package.subdirectory:
        vcs = f"{vcs}#subdirectory={package.subdirectory}"
    return RenderedRequirement(package=package.name, text=f"{package.name} @ {vcs}")


def render_catalog_install(
    package: PackageSource,
    line: str,
    *,
    environ: Mapping[str, str] | None = None,
    revision: str | None = None,
) -> str:
    """Catalog URL; ``==`` tag (ADR-0018) or ``--revision`` override (ADR-0023)."""
    _name, version = parse_catalog_request(line)
    if revision is not None:
        if version is not None:
            raise InstallRevisionEqualsConflictError()
        return render_requirement(replace(package, revision=revision)).text
    if version is None:
        return render_requirement(package).text
    tag = tag_for_version(package, version, environ=environ)
    return render_requirement(replace(package, revision=tag)).text


def format_pip_install_command(
    python: str,
    requirement: str,
    *,
    upgrade: bool = False,
) -> str:
    """Shell-style dry-run line. Does not start pip (AC-0001)."""
    flag = " --upgrade" if upgrade else ""
    return f'{python} -m pip install{flag} "{requirement}"'


def pip_install_argv(
    python: str,
    requirement: str,
    *,
    upgrade: bool = False,
) -> list[str]:
    argv = [python, "-m", "pip", "install"]
    if upgrade:
        argv.append("--upgrade")
    argv.append(requirement)
    return argv


def run_pip_install(
    python: str,
    requirement: str,
    *,
    environ: Mapping[str, str] | None = None,
    upgrade: bool = False,
) -> int:
    """Run pip and forward stdout/stderr. Returns pip's exit code (AC-0015)."""
    completed = subprocess.run(  # nosec B603
        pip_install_argv(python, requirement, upgrade=upgrade),
        env=dict(environ) if environ is not None else None,
    )
    return completed.returncode