[3.12] GH-79714: Add mention of stderr for clarity to ArgumentParser.… #124356
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
…arser.exit() (pythonGH-123932) (cherry picked from commit 5f5c0b9) Co-authored-by: Savannah Ostrowski <[email protected]>
Doc/library/argparse.rst
Outdated
Comment on lines
1442
to
1469
|
|
||
| .. _deprecated: | ||
|
|
||
| deprecated | ||
| ^^^^^^^^^^ | ||
|
|
||
| During a project's lifetime, some arguments may need to be removed from the | ||
| command line. Before removing them, you should inform | ||
| your users that the arguments are deprecated and will be removed. | ||
| The ``deprecated`` keyword argument of | ||
| :meth:`~ArgumentParser.add_argument`, which defaults to ``False``, | ||
| specifies if the argument is deprecated and will be removed | ||
| in the future. | ||
| For arguments, if ``deprecated`` is ``True``, then a warning will be | ||
| printed to :data:`sys.stderr` when the argument is used:: | ||
|
|
||
| >>> import argparse | ||
| >>> parser = argparse.ArgumentParser(prog='snake.py') | ||
| >>> parser.add_argument('--legs', default=0, type=int, deprecated=True) | ||
| >>> parser.parse_args([]) | ||
| Namespace(legs=0) | ||
| >>> parser.parse_args(['--legs', '4']) # doctest: +SKIP | ||
| snake.py: warning: option '--legs' is deprecated | ||
| Namespace(legs=4) | ||
|
|
||
| .. versionadded:: 3.13 | ||
|
|
||
|
|
There was a problem hiding this comment.
This should not be here.
serhiy-storchaka
approved these changes
Sep 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
…exit() (GH-123932)
(cherry picked from commit 5f5c0b9)
📚 Documentation preview 📚: https://cpython-previews--124356.org.readthedocs.build/