feat: add --with option to "pipx run" command

Closes #1607

Author: pabloyoyoista

changelog.d/1607.feature.md

@@ -0,0 +1 @@
+Add `--with` flag to `pipx run` to allow injecting dependencies

src/pipx/commands/run.py

@@ -8,12 +8,13 @@
 import urllib.request
 from pathlib import Path
 from shutil import which
-from typing import List, NoReturn, Optional, Union
+from typing import List, NoReturn, Optional, Tuple, Union
 
 from packaging.requirements import InvalidRequirement, Requirement
 
 from pipx import paths
 from pipx.commands.common import package_name_from_spec
+from pipx.commands.inject import inject_dep
 from pipx.constants import TEMP_VENV_EXPIRATION_THRESHOLD_DAYS, WINDOWS
 from pipx.emojis import hazard
 from pipx.util import (
@@ -111,6 +112,7 @@ def run_script(
 def run_package(
     app: str,
     package_or_url: str,
+    dependencies: List[str],
     app_args: List[str],
     python: str,
     pip_args: List[str],
@@ -157,26 +159,38 @@ def run_package(
 
     if venv.has_app(app, app_filename):
         logger.info(f"Reusing cached venv {venv_dir}")
-        venv.run_app(app, app_filename, app_args)
     else:
         logger.info(f"venv location is {venv_dir}")
-        _download_and_run(
+        venv, app, app_filename = _prepare_venv(
             Path(venv_dir),
             package_or_url,
             app,
             app_filename,
-            app_args,
             python,
             pip_args,
             venv_args,
             use_cache,
             verbose,
         )
 
+    for dep in dependencies:
+        inject_dep(
+            venv_dir=venv_dir,
+            package_name=None,
+            package_spec=dep,
+            pip_args=pip_args,
+            verbose=verbose,
+            include_apps=False,
+            include_dependencies=False,
+            force=False,
+        )
+    venv.run_app(app, app_filename, app_args)
+
 
 def run(
     app: str,
     spec: str,
+    dependencies: List[str],
     is_path: bool,
     app_args: List[str],
     python: str,
@@ -206,6 +220,7 @@ def run(
         run_package(
             package_name,
             package_or_url,
+            dependencies,
             app_args,
             python,
             pip_args,
@@ -216,18 +231,17 @@ def run(
         )
 
 
-def _download_and_run(
+def _prepare_venv(
     venv_dir: Path,
     package_or_url: str,
     app: str,
     app_filename: str,
-    app_args: List[str],
     python: str,
     pip_args: List[str],
     venv_args: List[str],
     use_cache: bool,
     verbose: bool,
-) -> NoReturn:
+) -> Tuple[Venv, str, str]:
     venv = Venv(venv_dir, python=python, verbose=verbose)
     venv.check_upgrade_shared_libs(pip_args=pip_args, verbose=verbose)
 
@@ -275,7 +289,7 @@ def _download_and_run(
         # Let future _remove_all_expired_venvs know to remove this
         (venv_dir / VENV_EXPIRED_FILENAME).touch()
 
-    venv.run_app(app, app_filename, app_args)
+    return venv, app, app_filename
 
 
 def _get_temporary_venv_path(requirements: List[str], python: str, pip_args: List[str], venv_args: List[str]) -> Path:

src/pipx/main.py

@@ -267,6 +267,7 @@ def run_pipx_command(args: argparse.Namespace, subparsers: Dict[str, argparse.Ar
         commands.run(
             args.app_with_args[0],
             args.spec,
+            args.with_,
             args.path,
             args.app_with_args[1:],
             args.python,
@@ -845,6 +846,13 @@ def _add_run(subparsers: argparse._SubParsersAction, shared_parser: argparse.Arg
         action="store_true",
         help="Require app to be run from local __pypackages__ directory",
     )
+    p.add_argument(
+        "--with",
+        dest="with_",
+        action="append",
+        default=[],
+        help="Extra dependencies to add to the temporary environment",
+    )
     p.add_argument("--spec", help=SPEC_HELP)
     add_python_options(p)
     add_pip_venv_args(p)

tests/test_run.py

@@ -443,3 +443,26 @@ def test_run_local_path_entry_point(pipx_temp_env, caplog, root):
     run_pipx_cli_exit(["run", empty_project_path])
 
     assert "Using discovered entry point for 'pipx run'" in caplog.text
+
+
+@mock.patch("os.execvpe", new=execvpe_mock)
+def test_run_with(capsys):
+    run_pipx_cli_exit(["run", "--with", "black", "pycowsay", "--help"])
+    captured = capsys.readouterr()
+    assert "injected package black into venv pycowsay" in captured.out
+
+
+@mock.patch("os.execvpe", new=execvpe_mock)
+def test_run_with_cache(capsys, caplog):
+    # Maybe there's a better way to remove the previous venv cache?
+    run_pipx_cli_exit(["run", "--no-cache", "pycowsay", "cowsay", "args"])
+    run_pipx_cli_exit(["run", "pycowsay", "cowsay", "args"])
+    caplog.set_level(logging.DEBUG)
+    caplog.clear()
+    run_pipx_cli_exit(["run", "--verbose", "pycowsay", "cowsay", "args"], assert_exit=0)
+    assert "Reusing cached venv" in caplog.text
+
+    run_pipx_cli_exit(["run", "--verbose", "--with", "black", "pycowsay", "args"], assert_exit=0)
+    captured = capsys.readouterr()
+    assert "Reusing cached venv" in caplog.text
+    assert "injected package black into venv pycowsay" in captured.out