Skip to content

Add new Python 3.14 argparse.ArgumentParser constructor parameters #13947

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

Merged
JelleZijlstra merged 6 commits into from
May 12, 2025
Merged

Add new Python 3.14 argparse.ArgumentParser constructor parameters #13947

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6ffa4ab
Add new Python 3.14 `argparse.ArgumentParser` parameters
edgarrmondragon May 6, 2025
271997f
Annotate instance attributes
edgarrmondragon May 6, 2025
ffca419
Merge branch 'main' into 3.14-argparse-parameters
srittau May 10, 2025
98b2340
Add defaults to `add_parser`
edgarrmondragon May 12, 2025
0e7c6e1
Merge branch 'main' into 3.14-argparse-parameters
edgarrmondragon May 12, 2025
6b6659c
`if` -> `elif`
edgarrmondragon May 12, 2025
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
85 changes: 69 additions & 16 deletions stdlib/argparse.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,29 +123,56 @@ class ArgumentParser(_AttributeHolder, _ActionsContainer):
fromfile_prefix_chars: str | None
add_help: bool
allow_abbrev: bool
exit_on_error: bool

if sys.version_info >= (3, 14):
suggest_on_error: bool
color: bool

# undocumented
_positionals: _ArgumentGroup
_optionals: _ArgumentGroup
_subparsers: _ArgumentGroup | None

# Note: the constructor arguments are also used in _SubParsersAction.add_parser.
def __init__(
self,
prog: str | None = None,
usage: str | None = None,
description: str | None = None,
epilog: str | None = None,
parents: Sequence[ArgumentParser] = [],
formatter_class: _FormatterClass = ...,
prefix_chars: str = "-",
fromfile_prefix_chars: str | None = None,
argument_default: Any = None,
conflict_handler: str = "error",
add_help: bool = True,
allow_abbrev: bool = True,
exit_on_error: bool = True,
) -> None: ...
if sys.version_info >= (3, 14):
def __init__(
self,
prog: str | None = None,
usage: str | None = None,
description: str | None = None,
epilog: str | None = None,
parents: Sequence[ArgumentParser] = [],
formatter_class: _FormatterClass = ...,
prefix_chars: str = "-",
fromfile_prefix_chars: str | None = None,
argument_default: Any = None,
conflict_handler: str = "error",
add_help: bool = True,
allow_abbrev: bool = True,
exit_on_error: bool = True,
*,
suggest_on_error: bool = False,
color: bool = False,
) -> None: ...
else:
def __init__(
self,
prog: str | None = None,
usage: str | None = None,
description: str | None = None,
epilog: str | None = None,
parents: Sequence[ArgumentParser] = [],
formatter_class: _FormatterClass = ...,
prefix_chars: str = "-",
fromfile_prefix_chars: str | None = None,
argument_default: Any = None,
conflict_handler: str = "error",
add_help: bool = True,
allow_abbrev: bool = True,
exit_on_error: bool = True,
) -> None: ...

@overload
def parse_args(self, args: Sequence[str] | None = None, namespace: None = None) -> Namespace: ...
@overload
Expand Down Expand Up @@ -668,6 +695,32 @@ class _SubParsersAction(Action, Generic[_ArgumentParserT]):

# Note: `add_parser` accepts all kwargs of `ArgumentParser.__init__`. It also
# accepts its own `help` and `aliases` kwargs.
if sys.version_info >= (3, 14):
def add_parser(
self,
name: str,
*,
deprecated: bool = False,
help: str | None = ...,
aliases: Sequence[str] = ...,
# Kwargs from ArgumentParser constructor
prog: str | None = ...,
usage: str | None = ...,
description: str | None = ...,
epilog: str | None = ...,
parents: Sequence[_ArgumentParserT] = ...,
formatter_class: _FormatterClass = ...,
prefix_chars: str = ...,
fromfile_prefix_chars: str | None = ...,
argument_default: Any = ...,
conflict_handler: str = ...,
add_help: bool = ...,
allow_abbrev: bool = ...,
exit_on_error: bool = ...,
suggest_on_error: bool = ...,
color: bool = ...,
Copy link
Member

@JelleZijlstra JelleZijlstra May 10, 2025

Choose a reason for hiding this comment

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

Suggested change
suggest_on_error: bool = ...,
color: bool = ...,
suggest_on_error: bool = False,
color: bool = False,

I think we didn't fill in defaults here because at runtime they go through **kwargs. Let's add defaults for the new parameters at least, and if you like we can add defaults for the rest at some point too.

Copy link
Contributor Author

@edgarrmondragon edgarrmondragon May 12, 2025

Choose a reason for hiding this comment

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

Would you prefer if I add the missing defaults in this PR or in a separate one?

Copy link
Member

@JelleZijlstra JelleZijlstra May 12, 2025

Choose a reason for hiding this comment

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

Let's do it in another PR, I'll merge this one

**kwargs: Any, # Accepting any additional kwargs for custom parser classes
) -> _ArgumentParserT: ...
if sys.version_info >= (3, 13):
def add_parser(
self,
Expand Down
Loading