Thanks to visit codestin.com
Credit goes to github.com

Skip to content

GH-127133: Remove ability to nest argument groups & mutually exclusive groups #127186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iritkatriel merged 12 commits into from
Nov 24, 2024
Merged

GH-127133: Remove ability to nest argument groups & mutually exclusive groups #127186

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e9bf875
Remove functionality and update docs
savannahostrowski Nov 23, 2024
41464a5
Change error type
savannahostrowski Nov 23, 2024
b9f3e4d
📜🤖 Added by blurb_it.
blurb-it[bot] Nov 23, 2024
76aadc6
Add PR number
savannahostrowski Nov 23, 2024
17556c0
Merge branch 'main' into gh-127133
savannahostrowski Nov 23, 2024
1673277
Fix sphinx
savannahostrowski Nov 23, 2024
baed27b
Fix refs in whatsnew
savannahostrowski Nov 23, 2024
813a2f5
Fix references in news entry
savannahostrowski Nov 23, 2024
6c837ab
precommit
savannahostrowski Nov 23, 2024
d835745
Apply suggestions from code review
savannahostrowski Nov 24, 2024
9708536
Reframe docs to focus on exception
savannahostrowski Nov 24, 2024
c55dbee
Fix test exception messages
savannahostrowski Nov 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Reframe docs to focus on exception
  • Loading branch information
@savannahostrowski
savannahostrowski committed Nov 24, 2024
commit 9708536290b2ce472f631f5b85663cbf0d1f427a
12 changes: 6 additions & 6 deletions Doc/library/argparse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1927,9 +1927,9 @@ Argument groups
in the usual "positional arguments" and "optional arguments" sections.

.. deprecated-removed:: 3.11 3.14
Calling :meth:`add_argument_group` on an argument group has been removed.
This feature was never supported and did not always work correctly.
The function existed on the API by accident through inheritance.
Calling :meth:`add_argument_group` on an argument group now raises an
exception. This nesting was never supported, often failed to work
correctly, and was unintentionally exposed through inheritance.

.. deprecated:: 3.14
Passing prefix_chars_ to :meth:`add_argument_group`
Expand Down Expand Up @@ -1994,9 +1994,9 @@ Mutual exclusion

.. deprecated-removed:: 3.11 3.14
Calling :meth:`add_argument_group` or :meth:`add_mutually_exclusive_group`
on a mutually exclusive group has been removed. These features were never
supported and did not always work correctly. The functions existed on the
API by accident through inheritance.
on a mutually exclusive group now raises an exception. This nesting was
never supported, often failed to work correctly, and was unintentionally
exposed through inheritance.


Parser defaults
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/3.14.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,8 +644,8 @@ argparse
* Calling :meth:`~argparse.ArgumentParser.add_argument_group` on an argument
group, and calling :meth:`~argparse.ArgumentParser.add_argument_group` or
:meth:`~argparse.ArgumentParser.add_mutually_exclusive_group` on a mutually
exclusive group have been removed. This nesting was never supported, did
not always work correctly, and existed in the API by accident through
exclusive group now raise exceptions. This nesting was never supported,
often failed to work correctly, and was unintentionally exposed through
inheritance. This functionality has been deprecated since Python 3.11.
(Contributed by Savannah Ostrowski in :gh:`127186`.)

Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/next/Core_and_Builtins/2024-11-23-04-54-42.gh-issue-127133.WMoJjF.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Calling :meth:`argparse.ArgumentParser.add_argument_group` on an argument group,
and calling :meth:`argparse.ArgumentParser.add_argument_group` or
:meth:`argparse.ArgumentParser.add_mutually_exclusive_group` on a mutually
exclusive group have been removed. This nesting was never supported, did not
always work correctly, and existed in the API by accident through inheritance.
exclusive group now raise exceptions. This nesting was never supported, often
failed to work correctly, and was unintentionally exposed through inheritance.
This functionality has been deprecated since Python 3.11.