Proposal: Add --upgrade argument for install command
#1458
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When installing a package, both `pip install` and `pipx install` allow a new package to be installed. If a target package is already installed, no changes are made. Both pip and pipx also support a forced reinstall using `--force-reinstall` and `--force` respectively. Another popular installation more for pip is using the `--upgrade` option, which will only perform a package change if a new version is detected. Such a request is not possible in pipx. This commit adds support for an upgrade method by adding the `--upgrade` option and forwarding it to pip when a package has been detected as already installed. Signed-off-by: James Knight <[email protected]>
jdknight
force-pushed
the
add-install-upgrade-option
branch
from
d8c7a1e to
59cdf74
Compare
|
Thanks, but this has already been proposed once (#953) and we agreed elsewhere on an |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
changelog.d/(if the patch affects the end users)Proposal
The following is a proposal to support an upgrade option with pipx's install command. A practice I use for documenting various Python-based utilities is to have an installation section which has a single command to either install or upgrade a package:
Now trying to promote the use of
pipxoverpip, this does not seem to be possible in a single command unless using the--forceargument:Using the "force" argument does not feel right, and the intention is not to have packages be re-installed if they are already in a good/upgraded state. Alternatively, I could update documentation to have two paragraphs to identify a method to install and a method to upgrade, but I would rather promote a single command that could do both.
Summary of changes
When installing a package, both
pip installandpipx installallow a new package to be installed. If a target package is already installed, no changes are made. Both pip and pipx also support a forced reinstall using--force-reinstalland--forcerespectively. Another popular installation more for pip is using the--upgradeoption, which will only perform a package change if a new version is detected. Such a request is not possible in pipx.This commit adds support for an upgrade method by adding the
--upgradeoption and forwarding it to pip when a package has been detected as already installed.Test plan
Tested by provided unit tests and running:
Example output
(venv) [jdknight@devel venv]$ pipx install black==22.8.0 installed package black 22.8.0, installed using Python 3.12.4 These apps are now globally available - black - blackd done! (venv) [jdknight@devel venv]$ pipx install black 'black' already seems to be installed. Not modifying existing installation in '.../.local/share/pipx/venvs/black'. Pass '--force' to force installation. (venv) [jdknight@devel venv]$ pipx install --upgrade black installed package black 24.4.2, installed using Python 3.12.4 These apps are now globally available - black - blackd done!