Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI support for installing multiple wheels #203

Merged
merged 4 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/cli/installer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# `python -m installer`

This interface allows you to install a specific wheel into a Python interpreter.
This interface allows you to install one or more wheels into a Python
interpreter.

```{argparse}
:module: installer.__main__
Expand Down
25 changes: 13 additions & 12 deletions src/installer/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
def _get_main_parser() -> argparse.ArgumentParser:
"""Construct the main parser."""
parser = argparse.ArgumentParser()
parser.add_argument("wheel", type=str, help="wheel file to install")
parser.add_argument("wheel", type=str, nargs="+", help="wheel file to install")
parser.add_argument(
"--destdir",
"-d",
Expand Down Expand Up @@ -91,17 +91,18 @@ def _main(cli_args: Sequence[str], program: Optional[str] = None) -> None:
elif not bytecode_levels:
bytecode_levels = [0, 1]

with WheelFile.open(args.wheel) as source:
if args.validate_record != "none":
source.validate_record(validate_contents=args.validate_record == "all")
destination = SchemeDictionaryDestination(
scheme_dict=_get_scheme_dict(source.distribution, prefix=args.prefix),
interpreter=sys.executable,
script_kind=get_launcher_kind(),
bytecode_optimization_levels=bytecode_levels,
destdir=args.destdir,
)
installer.install(source, destination, {})
for wheel in args.wheel:
with WheelFile.open(wheel) as source:
if args.validate_record != "none":
source.validate_record(validate_contents=args.validate_record == "all")
destination = SchemeDictionaryDestination(
scheme_dict=_get_scheme_dict(source.distribution, prefix=args.prefix),
interpreter=sys.executable,
script_kind=get_launcher_kind(),
bytecode_optimization_levels=bytecode_levels,
destdir=args.destdir,
)
installer.install(source, destination, {})


if __name__ == "__main__": # pragma: no cover
Expand Down
65 changes: 37 additions & 28 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,51 @@

@pytest.fixture
def fancy_wheel(tmp_path):
path = tmp_path / "fancy-1.0.0-py2.py3-none-any.whl"
return mock_wheel(tmp_path, "fancy")


@pytest.fixture
def another_fancy_wheel(tmp_path):
return mock_wheel(tmp_path, "another_fancy")


def mock_wheel(tmp_path, name):
path = tmp_path / f"{name}-1.0.0-py2.py3-none-any.whl"
files = {
"fancy/": b"""""",
"fancy/__init__.py": b"""\
f"{name}/": b"""""",
f"{name}/__init__.py": b"""\
def main():
print("I'm fancy.")
""",
"fancy/__main__.py": b"""\
f"{name}/__main__.py": b"""\
if __name__ == "__main__":
from . import main
main()
""",
"fancy-1.0.0.data/data/fancy/": b"""""",
"fancy-1.0.0.data/data/fancy/data.py": b"""\
f"{name}-1.0.0.data/data/{name}/": b"""""",
f"{name}-1.0.0.data/data/{name}/data.py": b"""\
# put me in data
""",
"fancy-1.0.0.dist-info/": b"""""",
"fancy-1.0.0.dist-info/top_level.txt": b"""\
fancy
""",
"fancy-1.0.0.dist-info/entry_points.txt": b"""\
f"{name}-1.0.0.dist-info/": b"""""",
f"{name}-1.0.0.dist-info/top_level.txt": f"""\
{name}
""".encode(),
f"{name}-1.0.0.dist-info/entry_points.txt": f"""\
[console_scripts]
fancy = fancy:main
{name} = {name}:main

[gui_scripts]
fancy-gui = fancy:main
""",
"fancy-1.0.0.dist-info/WHEEL": b"""\
{name}-gui = {name}:main
""".encode(),
f"{name}-1.0.0.dist-info/WHEEL": b"""\
Wheel-Version: 1.0
Generator: magic (1.0.0)
Root-Is-Purelib: true
Tag: py3-none-any
""",
"fancy-1.0.0.dist-info/METADATA": b"""\
f"{name}-1.0.0.dist-info/METADATA": f"""\
Metadata-Version: 2.1
Name: fancy
Name: {name}
Version: 1.0.0
Summary: A fancy package
Author: Agendaless Consulting
Expand All @@ -50,17 +59,17 @@ def main():
Keywords: fancy amazing
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
""",
"fancy-1.0.0.dist-info/RECORD": b"""\
fancy/__init__.py,sha256=qZ2qq7xVBAiUFQVv-QBHhdtCUF5p1NsWwSOiD7qdHN0,36
fancy/__main__.py,sha256=Wd4SyWJOIMsHf_5-0oN6aNFwen8ehJnRo-erk2_K-eY,61
fancy-1.0.0.data/data/fancy/data.py,sha256=nuFRUNQF5vP7FWE-v5ysyrrfpIaAvfzSiGOgfPpLOeI,17
fancy-1.0.0.dist-info/top_level.txt,sha256=SW-yrrF_c8KlserorMw54inhLjZ3_YIuLz7fYT4f8ao,6
fancy-1.0.0.dist-info/entry_points.txt,sha256=AxJl21_zgoNWjCfvSkC9u_rWSzGyCtCzhl84n979jCc,75
fancy-1.0.0.dist-info/WHEEL,sha256=1DrXMF1THfnBjsdS5sZn-e7BKcmUn7jnMbShGeZomgc,84
fancy-1.0.0.dist-info/METADATA,sha256=hRhZavK_Y6WqKurFFAABDnoVMjZFBH0NJRjwLOutnJI,236
fancy-1.0.0.dist-info/RECORD,,
""",
""".encode(),
f"{name}-1.0.0.dist-info/RECORD": f"""\
{name}/__init__.py,sha256=qZ2qq7xVBAiUFQVv-QBHhdtCUF5p1NsWwSOiD7qdHN0,36
{name}/__main__.py,sha256=Wd4SyWJOIMsHf_5-0oN6aNFwen8ehJnRo-erk2_K-eY,61
{name}-1.0.0.data/data/{name}/data.py,sha256=nuFRUNQF5vP7FWE-v5ysyrrfpIaAvfzSiGOgfPpLOeI,17
{name}-1.0.0.dist-info/top_level.txt,sha256=SW-yrrF_c8KlserorMw54inhLjZ3_YIuLz7fYT4f8ao,6
{name}-1.0.0.dist-info/entry_points.txt,sha256=AxJl21_zgoNWjCfvSkC9u_rWSzGyCtCzhl84n979jCc,75
{name}-1.0.0.dist-info/WHEEL,sha256=1DrXMF1THfnBjsdS5sZn-e7BKcmUn7jnMbShGeZomgc,84
{name}-1.0.0.dist-info/METADATA,sha256=hRhZavK_Y6WqKurFFAABDnoVMjZFBH0NJRjwLOutnJI,236
{name}-1.0.0.dist-info/RECORD,,
""".encode(),
}

with zipfile.ZipFile(path, "w") as archive:
Expand Down
19 changes: 19 additions & 0 deletions tests/test_main.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,25 @@ def test_main(fancy_wheel, tmp_path):
}


def test_main_multiple_wheels(fancy_wheel, another_fancy_wheel, tmp_path):
destdir = tmp_path / "dest"

main(
[str(fancy_wheel), str(another_fancy_wheel), "-d", str(destdir)],
"python -m installer",
)

for wheel_name in ("fancy", "another_fancy"):
installed_py_files = destdir.rglob(f"**/{wheel_name}/**/*.py")
assert {f.stem for f in installed_py_files} == {"__init__", "__main__", "data"}

installed_pyc_files = destdir.rglob(f"**/{wheel_name}/**/*.pyc")
assert {f.name.split(".")[0] for f in installed_pyc_files} == {
"__init__",
"__main__",
}


def test_main_prefix(fancy_wheel, tmp_path):
destdir = tmp_path / "dest"

Expand Down
Loading