Skip to content

Commit e01a178

Browse files
[3.12] gh-85935: Explicitly document the case nargs=0 in argparse (GH-125302) (GH-125358)
(cherry picked from commit 07c2d15) Co-authored-by: Serhiy Storchaka <[email protected]>
1 parent aa0cdeb commit e01a178

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

Doc/library/argparse.rst

+5
Original file line numberDiff line numberDiff line change
@@ -726,6 +726,9 @@ how the command-line arguments should be handled. The supplied actions are:
726726

727727
.. versionadded:: 3.8
728728

729+
Only actions that consume command-line arguments (e.g. ``'store'``,
730+
``'append'`` or ``'extend'``) can be used with positional arguments.
731+
729732
You may also specify an arbitrary action by passing an Action subclass or
730733
other object that implements the same interface. The ``BooleanOptionalAction``
731734
is available in ``argparse`` and adds support for boolean actions such as
@@ -853,6 +856,8 @@ See also :ref:`specifying-ambiguous-arguments`. The supported values are:
853856
If the ``nargs`` keyword argument is not provided, the number of arguments consumed
854857
is determined by the action_. Generally this means a single command-line argument
855858
will be consumed and a single item (not a list) will be produced.
859+
Actions that do not consume command-line arguments (e.g.
860+
``'store_const'``) set ``nargs=0``.
856861

857862

858863
.. _const:

0 commit comments

Comments
 (0)