Repository navigation
Add help output for a single option group - #15270
Open
Thibault-dlr wants to merge 1 commit into
Open
Thibault-dlr wants to merge 1 commit into
Thibault-dlr wants to merge 1 commit into
Conversation
pyba-chronographer
Bot
added
the
bot:chronographer:provided
This branch has not been deployed
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.
Summary
--help-section=NAMEto display help for a single command-line option group.customfor options registered without an explicit group.Parser.getgroup()name.pytest --help.Testing
testing/test_helpconfig.py testing/test_parseopt.py testing/test_config.py— 376 passed, 4 skipped, 1 xfailed.git diff --check— passed.Ruff, pre-commit, and Towncrier were unavailable in the local environment and were not run.
Implementation notes
The
customidentifier is reserved for options registered without an explicit group. To avoid ambiguity, a named group literally calledcustom, or one whose name starts withgroup:, can be selected by prefixing its name withgroup:. For example:--help-section=group:custom.Help formatting reuses argparse's formatter and option actions. The use of argparse's internal formatter API is localized in pytest's
Parser, but may require adjustments if argparse internals change.