bpo-42572: Improve argparse docs for the type parameter. #23849
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also see bpo-37572 and bpo-35005.
rhettinger
added
docs
rhettinger
changed the title
ericvsmith
reviewed
Dec 19, 2020
Doc/library/argparse.rst
Outdated
| Even :class:`~argparse.FileType` has its limitations for use with the ``type`` | ||
| keyword. If two arguments use *FileType* and the second one fails, an error is | ||
| reported but the first file is not automatically closed. In this case, it would | ||
| be better to wait until after the parser has run and then use the |
There was a problem hiding this comment.
Isn't this true of any type errors, not just with FileType? If I have a FileType and then a float, and the type conversion for the float fails, I'd still leave the file open. I'm worried that the readers might think this is solely related to the second argument type also being FileType.
There was a problem hiding this comment.
Yes. That makes sense.
ericvsmith
reviewed
Dec 19, 2020
Doc/library/argparse.rst
Outdated
| >>> parser.add_argument('bar', type=open) | ||
| >>> parser.parse_args('2 temp.txt'.split()) | ||
| Namespace(bar=<_io.TextIOWrapper name='temp.txt' encoding='UTF-8'>, foo=2) | ||
| If the type_ keyword is used with default_ keyword, the type converter is |
There was a problem hiding this comment.
I think this should be "... is used with the default keyword ..." (adding "the").
|
Thanks @rhettinger for the PR 🌮🎉.. I'm working now to backport this PR to: 3.9. |
bedevere-bot
removed
awaiting core review
needs backport to 3.9
|
GH-23869 is a backport of this pull request to the 3.9 branch. |
hectorese1
added a commit
to hectorese1/cpython
that referenced
this pull request
Dec 20, 2020
bpo-42572: Improve argparse docs for the type parameter. (pythonGH-23849)
rhettinger
pushed a commit
that referenced
this pull request
Dec 20, 2020
adorilson
pushed a commit
to adorilson/cpython
that referenced
this pull request
Mar 13, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See https://bugs.python.org/issue42572 and bpo-37572 and bpo-35005.
https://bugs.python.org/issue42572