Issue #1535 - Add a help command (alias of --help)
#1544
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
Initial addition of a `commands/help.py` file Add "help" to `commands/__init__.py` to make pipx aware of a new command
Added an _add_help function which informs argparse of a "help" command, and an optional argument for it called "subcommand" Added a check for args.command == "help"
Reflects requirements set by the linter
Gitznik
requested changes
Sep 17, 2024
src/pipx/main.py
Outdated
| @@ -973,7 +997,9 @@ def get_command_parser() -> Tuple[argparse.ArgumentParser, Dict[str, argparse.Ar | |||
| ) | |||
| parser.man_short_description = PIPX_DESCRIPTION.splitlines()[1] # type: ignore[attr-defined] | |||
|
|
|||
| subparsers = parser.add_subparsers(dest="command", description="Get help for commands with pipx COMMAND --help") | |||
| subparsers = parser.add_subparsers( | |||
| dest="command", description="Get help for commands with pipx COMMAND --help\n\t\t\t or pipx help COMMAND" | |||
There was a problem hiding this comment.
Please stick to how the other commands wrap text in their description.
Example: `pipx help interpreter list` now has an identical output to `pipx interpreter list --help`
|
Thanks for your comment. I have added a fix for cases with multiple subcomamnds (e.g., |
The line `valid_commands = parser._subparsers._actions[4].choices.keys()` causes the linter to throw an error: ``` mypy.....................................................................Failed - hook id: mypy - exit code: 1 tests/test_help.py:23: error: Item "None" of "_ArgumentGroup | None" has no attribute "_actions" [union-attr] tests/test_help.py:23: error: Item "Iterable[Any]" of "Iterable[Any] | Any | None" has no attribute "keys" [union-attr] tests/test_help.py:23: error: Item "None" of "Iterable[Any] | Any | None" has no attribute "keys" [union-attr] Found 3 errors in 1 file (checked 76 source files) ``` All linter tests pass normally when that line is substituted with a hard-coded list of valid pipx commands.
Gitznik
requested changes
Oct 4, 2024
Rather than accessing a protected attribute of `parser._subparsers` Note: a commented out line with the protected access is still included in the event that the list of valid pipx commands changes
Gitznik
requested changes
Oct 9, 2024
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)Summary of changes
pipx --helpandpipx [command_name] --helpboth produce help info.helpsubcommand as an alias for--help#1535 requests a new pipx command that is an alias for--help.pipx helpandpipx help [command_name]can now be used to provide identical output to (1).Test plan
Tested by running
This is my first PR to a public repo. Please feel free to let me know if there are any guidelines or general tenets I've failed to follow. Thanks!