Skip to content
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.

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

gh-99553: fix bug where an ExceptionGroup subclass can wrap a BaseException #99572

Merged
merged 1 commit into from
Nov 18, 2022

Conversation

iritkatriel
Copy link
Member

@iritkatriel iritkatriel commented Nov 18, 2022

@iritkatriel iritkatriel added type-bug An unexpected behavior, bug, or error interpreter-core (Objects, Python, Grammar, and Parser dirs) needs backport to 3.11 only security fixes labels Nov 18, 2022
Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that’s what I thought.

@miss-islington
Copy link
Contributor

Thanks @iritkatriel for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 18, 2022
…aseException (pythonGH-99572)

(cherry picked from commit c8c6113)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
@bedevere-bot
Copy link

GH-99580 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Nov 18, 2022
miss-islington added a commit that referenced this pull request Nov 18, 2022
…eption (GH-99572)

(cherry picked from commit c8c6113)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
Comment on lines +968 to +970
Like :exc:`ExceptionGroup`, any subclass of :exc:`BaseExceptionGroup` which
is also a subclass of :exc:`Exception` can only wrap instances of
:exc:`Exception`.
Copy link
Contributor

@Zac-HD Zac-HD Nov 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As written, consistency suggests that class MyEG(BaseExceptionGroup, ValueError): should be unable to wrap anything but ValueErrors!

That may in fact be the intention, and it wouldn't break the trio.MultiError-as-BaseExceptionGroup deprecation pathway, but it's not the implementation and the tests don't distinguish these cases.

Otherwise, I think we'd want to document the behavior which is that "any subclass of ExceptionGroup can only wrap instances of Exception, like ExceptionGroup itself.", and therefore class MyEG(BaseExceptionGroup, ValueError): would be able to contain BaseExceptions 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As written, this suggests that class MyEG(BaseExceptionGroup, ValueError): should be unable to wrap anything but ValueErrors!

Does it? In the doc the Exception becomes a hyperlink.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But feel free to make a PR with better wording.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect some users to read that as "if a subclass of BaseExceptionGroup is also a subclass of X, it can only wrap instances of X"; I'll open a PR to rephrase as "if it's also a subclass of Exception, it can't wrap BaseExceptions".

But then we're still treating Exception as particularly special for subclasses, which feels a bit strange.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zac, I'm confused why you think the sentence as written could be interpreted that way. It says Exception twice. In this context that is very clearly a reference to the specific built-in class named Exception (it even links there), not a "free variable" that must refer to the same class in both places.

Regardless, even if we clear that up, it feels like it would be expensive to inspect the class hierarchy to find other subclasses of BaseException and try to constrain the arguments to inherit from those. And that's definitely not what the PEP intended. We want the common case (where you're using one of the two built-in EG classes) to be foolproof, and other cases possible.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the confusion, that's on me 😞

I do think the behavior in this PR is good, and I'll open a PR with some additional tests and maybe docs to distinguish it from the case that I was wondering about. Thanks again to both of you for everything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
interpreter-core (Objects, Python, Grammar, and Parser dirs) type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Subclasses of ExceptionGroup can wrap BaseExceptions
5 participants