Skip to content

Fix exception causes in code.py #7820

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

Merged
merged 1 commit into from
Jun 13, 2020

Conversation

cool-RR
Copy link
Contributor

@cool-RR cool-RR commented Jun 11, 2020

I recently went over Matplotlib, Pandas and NumPy, fixing a small mistake in the way that Python 3's exception chaining is used. If you're interested, I can do it here too. I've done it on just one file right now.

The mistake is this: In some parts of the code, an exception is being caught and replaced with a more user-friendly error. In these cases the syntax raise new_error from old_error needs to be used.

Python 3's exception chaining means it shows not only the traceback of the current exception, but that of the original exception (and possibly more.) This is regardless of raise from. The usage of raise from tells Python to put a more accurate message between the tracebacks. Instead of this:

During handling of the above exception, another exception occurred:

You'll get this:

The above exception was the direct cause of the following exception:

The first is inaccurate, because it signifies a bug in the exception-handling code itself, which is a separate situation than wrapping an exception.

Let me know what you think!

@cool-RR cool-RR force-pushed the 2020-06-11-raise-from branch from bb38b42 to 30646dd Compare June 11, 2020 21:21
@tk0miya tk0miya added this to the 3.2.0 milestone Jun 12, 2020
Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

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

+1: Reasonable.

@cool-RR
Copy link
Contributor Author

cool-RR commented Jun 12, 2020

Awesome! I'll make sure to use exc.

@cool-RR cool-RR force-pushed the 2020-06-11-raise-from branch from 30646dd to 5ad6f37 Compare June 12, 2020 15:54
@tk0miya tk0miya merged commit 0fc97a0 into sphinx-doc:3.x Jun 13, 2020
@tk0miya
Copy link
Member

tk0miya commented Jun 13, 2020

Merged. Do you have a plan to fix other code? It's very helpful to us :-)

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants