Add --dry-run flag to pipx ensurepath#1842
Open
somaz94 wants to merge 2 commits into
Open
Conversation
This file contains hidden or 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
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.
Adds a
--dry-runflag topipx ensurepaththat reports which directorieswould be added to
PATHwithout modifyingPATHor any shell configurationfile, so users can preview the change before running it for real (closes #1014).
The flag threads a
dry_runparameter throughensure_pipx_paths→ensure_path; in dry-run modeuserpath.append/prependare never called anda "Would append/prepend ..." line plus a "no changes were made" footer are
printed instead.
pre-commit run --all-files)changelog.d/folder (feature)Validation
tests/test_ensurepath.py(4 tests — first test file for this command):asserts dry-run never calls
userpath.append/prepend, never mutates config,and checks the footer +
EXIT_CODE_OK.ruff check+ruff format --checkclean on all changed files.pipx ensurepath --dry-run --forceprintsWould append ...andthe no-changes footer without touching PATH.