Skip to content

Commit 80d0a85

Browse files
gh-126676: Expand argparse docs for type=bool with warning and alternatives (#146435)
Co-authored-by: joshuaswanson <joshuaswanson@users.noreply.github.com> Co-authored-by: Savannah Ostrowski <savannah@python.org>
1 parent cb76ab3 commit 80d0a85

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
@@ -1118,7 +1118,15 @@ User defined functions can be used as well:
11181118

11191119
The :func:`bool` function is not recommended as a type converter. All it does
11201120
is convert empty strings to ``False`` and non-empty strings to ``True``.
1121-
This is usually not what is desired.
1121+
This is usually not what is desired::
1122+
1123+
>>> parser = argparse.ArgumentParser()
1124+
>>> _ = parser.add_argument('--verbose', type=bool)
1125+
>>> parser.parse_args(['--verbose', 'False'])
1126+
Namespace(verbose=True)
1127+
1128+
See :class:`BooleanOptionalAction` or ``action='store_true'`` for common
1129+
alternatives.
11221130

11231131
In general, the ``type`` keyword is a convenience that should only be used for
11241132
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)