Skip to content

Commit 91e7c29

Browse files
joshuaswansonsavannahostrowski
authored andcommitted
gh-126676: Expand argparse docs for type=bool with warning and alternatives (GH-146435)
(cherry picked from commit 80d0a85) Co-authored-by: Joshua Swanson <22283299+joshuaswanson@users.noreply.github.com> Co-authored-by: joshuaswanson <joshuaswanson@users.noreply.github.com> Co-authored-by: Savannah Ostrowski <savannah@python.org>
1 parent 89bfb8e commit 91e7c29

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

Doc/library/argparse.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1017,7 +1017,15 @@ User defined functions can be used as well:
10171017

10181018
The :func:`bool` function is not recommended as a type converter. All it does
10191019
is convert empty strings to ``False`` and non-empty strings to ``True``.
1020-
This is usually not what is desired.
1020+
This is usually not what is desired::
1021+
1022+
>>> parser = argparse.ArgumentParser()
1023+
>>> _ = parser.add_argument('--verbose', type=bool)
1024+
>>> parser.parse_args(['--verbose', 'False'])
1025+
Namespace(verbose=True)
1026+
1027+
See :class:`BooleanOptionalAction` or ``action='store_true'`` for common
1028+
alternatives.
10211029

10221030
In general, the ``type`` keyword is a convenience that should only be used for
10231031
simple conversions that can only raise one of the three supported exceptions.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Expand :mod:`argparse` documentation for ``type=bool`` with a demonstration
2+
of the surprising behavior and pointers to common alternatives.

0 commit comments

Comments
 (0)