bpo-37880: for argparse add_argument with action='store_const', const defaults to None. #26707
Conversation
* Related to bpo's 25299, 24754, and 25314
* In the const section of argparse.rst
Misc/NEWS.d/next/Library/2021-06-13-00-16-56.bpo-37880.5bTrkw.rst
Outdated
Show resolved
Hide resolved
|
@jacobtylerwalls thank you! I fixed it. That freaking word gets me every time. |
Doc/library/argparse.rst
Outdated
| If ``const`` is not provided to :meth:`~ArgumentParser.add_argument`, it | ||
| will receive a default value of ``None``. | ||
|
|
||
| .. versionchanged:: 3.10 | ||
| ``const=None`` by default. |
There was a problem hiding this comment.
Should this be one level higher to clarify it doesn't just apply to store_const and append_const? The part being removed below made that more clear.
If so, then the versionchanged could be more specific about what was changed in 3.11. (BTW 3.11 is under dev now)
There was a problem hiding this comment.
I will take another pass at the documentation, because I'm seeing a few rough edges. However, to be clear, the default assignment of None to the const kwarg is only new behavior when the action type is append_const or store_const. All other action types always assigned the default value of None to const. This PR just makes the behavior consistent when the action type is append_const or store_const, so the change in behavior is limited in scope.
At the same time, I think that sticking the :versionchanged: note under the bullet point like I did initially just plain looks wrong, so I will bring the note back to its original position.
As far as "other rough edges":
- In the
actionsection:- Grammatical change: exchanging parenthesis for a semicolon where there were two separate clauses in the
action='append_const'section. - Add a brief note about the default assignment of
const=Nonein theaction='store_const'section.
- Grammatical change: exchanging parenthesis for a semicolon where there were two separate clauses in the
- Add a paragraph break in the
name or flagssection. This makes it much easier for the reader to draw contrast between these two examples at a glance.
|
Closing and reopening to run checks again. |
|
Closing and reopening to run checks yet again ... |
This PR implements changes to argparse as per bpo-37880. Updates to documentation, tests, and news are also included. I'm unable to run all regrtests on my system right now due to bpo-44411, but
test_argparseis passing, of course.https://bugs.python.org/issue37880