Skip to content

bpo-44986: Fixed bug with date formats like %Y-%m-%d in help messages of argparse #27923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 13 commits into from
Closed

bpo-44986: Fixed bug with date formats like %Y-%m-%d in help messages of argparse #27923

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
04f909d
Updated the usage of the '%(par)s' string formatting to modern f'{par…
SengerM Aug 23, 2021
36001c7
bpo-44986: Reverted change in test to stick to the old format and rep…
SengerM Aug 25, 2021
d77b2b6
Merge branch 'main' into main
SengerM Aug 22, 2023
255fa92
bpo-44986: Added unit tests for new feature that eliminates the need …
SengerM Aug 22, 2023
cbdc58e
bpo-44986: Added one extra test case with multiple percentage symbols
SengerM Aug 22, 2023
f291df2
bpo-44986: Added blurb entry
SengerM Aug 22, 2023
8ed8045
bpo-44986: Removed trailing white spaces
SengerM Aug 22, 2023
cd7aebb
Merge branch 'main' into main
SengerM Aug 22, 2023
1728042
Fixed GitHub issue number
SengerM Aug 22, 2023
8697b09
Merge branch 'main' into main
SengerM Aug 22, 2023
a3be094
Merge branch 'main' into main
furkanonder Sep 28, 2023
02e3b73
Merge branch 'main' into main
SengerM Aug 27, 2024
60c3e50
Merge branch 'main' into main
savannahostrowski Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Lib/argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,11 @@ def _expand_help(self, action):
if params.get('choices') is not None:
choices_str = ', '.join([str(c) for c in params['choices']])
params['choices'] = choices_str
return self._get_help_string(action) % params
expanded_help = self._get_help_string(action)
for param, value in params.items():
if f'%({param})s' in expanded_help:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this conditional is redundant, right? Doesn't replace() handle validating that the string is contained by expanded_help?

expanded_help = expanded_help.replace(f'%({param})s', str(value))
return expanded_help

def _iter_indented_subactions(self, action):
try:
Expand Down
2 changes: 1 addition & 1 deletion Lib/test/test_argparse.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3901,7 +3901,7 @@ class TestHelpVariableExpansion(HelpTestCase):
parser_signature = Sig(prog='PROG')
argument_signatures = [
Sig('-x', type=int,
help='x %(prog)s %(default)s %(type)s %%'),
help='x %(prog)s %(default)s %(type)s %'),
Sig('-y', action='store_const', default=42, const='XXX',
help='y %(prog)s %(default)s %(const)s'),
Sig('--foo', choices='abc',
Expand Down