bpo-42966: argparse: customizable help formatter #24377
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
Added public class CustomHelpFormat and private _CustomizableHelpFormatter to provide accessible API for basic help format customizations.
Fixed minor mistakes in documentation
Fixed doc indentation
monkeyman79
changed the title
|
Tests failed on macOS due to problems with ssl :( What now? |
gst
reviewed
Feb 8, 2021
Lib/argparse.py
Outdated
| class CustomHelpFormat: | ||
| """Customizable help formatter factory.""" | ||
|
|
||
| def __init__(self): |
There was a problem hiding this comment.
why not allow to pass the attributes by arguments ?
def __init__(self, *,
indent_increment: int = 2,
max_help_position: int = 24,
...
):
...There was a problem hiding this comment.
I wanted to avoid backward incompatiblity when list of attributes change. On the other hand, this can be solved by adding **kwargs at the end, so I think I'll try it this way.
Passing attributes to CustomHelpFormat constructor as keyword arguments
Fixed CustomHelpFormat constructor prototype in documentation
Fixed whitespace in docs
|
This PR is stale because it has been open for 30 days with no activity. |
MaxwellDupre
approved these changes
Apr 2, 2022
github-actions
bot
removed
the
stale
This was referenced Mar 28, 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.
Added public CustomHelpFormat class and private _CustomizableHelpFormatter to provide accessible API for basic help format customizations.
This PR doesn't introduce any new formatting customization, just adds more accessible API for existing alternative help formatter classes and for changing basic HelpFormatter parameters (indentation), with possibility to extend it for future formatter classes.
https://bugs.python.org/issue42966