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

feat: allow upgrade command to accept multiple packages as arguments #1339

Merged
merged 4 commits into from
Apr 12, 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
1 change: 1 addition & 0 deletions changelog.d/1336.feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Allow `upgrade` command to accept multiple packages as arguments.
27 changes: 14 additions & 13 deletions src/pipx/commands/upgrade.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import logging
import os
from pathlib import Path
from typing import List, Optional, Sequence
from typing import Dict, List, Optional, Sequence

from pipx import commands, paths
from pipx.colors import bold, red
Expand Down Expand Up @@ -180,7 +180,7 @@ def _upgrade_venv(


def upgrade(
venv_dir: Path,
venv_dirs: Dict[str, Path],
python: Optional[str],
pip_args: List[str],
verbose: bool,
Expand All @@ -192,17 +192,18 @@ def upgrade(
) -> ExitCode:
"""Return pipx exit code."""

_ = _upgrade_venv(
venv_dir,
pip_args,
verbose,
include_injected=include_injected,
upgrading_all=False,
force=force,
install=install,
python=python,
python_flag_passed=python_flag_passed,
)
for venv_dir in venv_dirs.values():
_ = _upgrade_venv(
venv_dir,
pip_args,
verbose,
include_injected=include_injected,
upgrading_all=False,
force=force,
install=install,
python=python,
python_flag_passed=python_flag_passed,
)

# Any error in upgrade will raise PipxError (e.g. from venv.upgrade_package())
return EXIT_CODE_OK
Expand Down
14 changes: 11 additions & 3 deletions src/pipx/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,14 @@ def run_pipx_command(args: argparse.Namespace, subparsers: Dict[str, argparse.Ar

venv_dir = venv_container.get_venv_dir(package)
logger.info(f"Virtual Environment location is {venv_dir}")

if "packages" in args:
if any(urllib.parse.urlparse(package).scheme for package in args.packages):
raise PipxError("Package cannot be a url. Package name should be passed instead.")
venv_dirs = {package: venv_container.get_venv_dir(package) for package in args.packages}
venv_dirs_msg = "\n".join(f"- {key} : {value}" for key, value in venv_dirs.items())
logger.info(f"Virtual Environment locations are:\n{venv_dirs_msg}")

if "skip" in args:
skip_list = [canonicalize_name(x) for x in args.skip]

Expand Down Expand Up @@ -285,7 +293,7 @@ def run_pipx_command(args: argparse.Namespace, subparsers: Dict[str, argparse.Ar
)
elif args.command == "upgrade":
return commands.upgrade(
venv_dir,
venv_dirs,
args.python,
pip_args,
verbose,
Expand Down Expand Up @@ -531,10 +539,10 @@ def _add_upgrade(subparsers, venv_completer: VenvCompleter, shared_parser: argpa
p = subparsers.add_parser(
"upgrade",
help="Upgrade a package",
description="Upgrade a package in a pipx-managed Virtual Environment by running 'pip install --upgrade PACKAGE'",
description="Upgrade package(s) in pipx-managed Virtual Environment(s) by running 'pip install --upgrade PACKAGE'",
parents=[shared_parser],
)
p.add_argument("package").completer = venv_completer
p.add_argument("packages", help="package names(s) to upgrade", nargs="+").completer = venv_completer
p.add_argument(
"--include-injected",
action="store_true",
Expand Down
14 changes: 14 additions & 0 deletions tests/test_upgrade.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,17 @@ def test_upgrade_install_missing(pipx_temp_env, capsys):
assert not run_pipx_cli(["upgrade", "pycowsay", "--install"])
captured = capsys.readouterr()
assert "installed package pycowsay" in captured.out


def test_upgrade_multiple(pipx_temp_env, capsys):
name = "pylint"
pkg_spec = PKG[name]["spec"]
initial_version = pkg_spec.split("==")[-1]
assert not run_pipx_cli(["install", pkg_spec])

assert not run_pipx_cli(["install", "pycowsay"])

assert not run_pipx_cli(["upgrade", name, "pycowsay"])
captured = capsys.readouterr()
assert f"upgraded package {name} from {initial_version} to" in captured.out
assert "pycowsay is already at latest version" in captured.out