Note argparse exit code in documentation #119568
Merged
Conversation
This file contains hidden or 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
It is currently stated that calling `ArgumentParser.error()` exits with a code of 2. However, it is not explicitly stated that this method is used in `ArgumentParser.parse_args()` when the arguments are invalid. Adding a note about the exit code to the `exit_on_error` argument of the `ArgumentParser` constructor makes this relationship explicit, and also makes this piece of information easier to notice.
bedevere-app
bot
added
docs
|
@savannahostrowski, this may be related to one of your recent changes. I am not sure that it is worth to repeat "print sys.stderr" here, but we should not create a new ambiguity. |
|
For consistency's sake, it's probably worth having the same phrasing here as well. |
Co-authored-by: Savannah Ostrowski <[email protected]>
serhiy-storchaka
added
skip issue
needs backport to 3.12
serhiy-storchaka
approved these changes
Oct 10, 2024
|
Thanks @jkunimune for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 10, 2024
(cherry picked from commit 3b87fb7) Co-authored-by: Justin Kunimune <[email protected]> Co-authored-by: Savannah Ostrowski <[email protected]>
|
GH-125274 is a backport of this pull request to the 3.13 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 10, 2024
(cherry picked from commit 3b87fb7) Co-authored-by: Justin Kunimune <[email protected]> Co-authored-by: Savannah Ostrowski <[email protected]>
|
GH-125275 is a backport of this pull request to the 3.12 branch. |
serhiy-storchaka
pushed a commit
that referenced
this pull request
Oct 10, 2024
(cherry picked from commit 3b87fb7) Co-authored-by: Justin Kunimune <[email protected]> Co-authored-by: Savannah Ostrowski <[email protected]>
serhiy-storchaka
pushed a commit
that referenced
this pull request
Oct 10, 2024
(cherry picked from commit 3b87fb7) Co-authored-by: Justin Kunimune <[email protected]> Co-authored-by: Savannah Ostrowski <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
It is currently stated that calling
ArgumentParser.error()exits with a code of 2. However, it is not explicitly stated that this method is used inArgumentParser.parse_args()when the arguments are invalid. Adding a note about the exit code to theexit_on_errorargument of theArgumentParserconstructor makes this relationship explicit, and also makes this piece of information easier to notice.📚 Documentation preview 📚: https://cpython-previews--119568.org.readthedocs.build/