10000 Display exception notes in tracebacks by EtiennePelletier · Pull Request #14039 · ipython/ipython · GitHub
[go: up one dir, main page]
Skip to content

Display exception notes in tracebacks #14039

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

Jump to bottom
Merged
merged 3 commits into from
Jun 2, 2023
Merged

Display exception notes in tracebacks #14039

merged 3 commits into from
Jun 2, 2023

Conversation

EtiennePelletier
Copy link
Contributor

PEP 678 introduced the ability to add notes to exception objects. This has been released in Python 3.11 and is currently not implemented in IPython. These changes are fully compatible with older Python versions that don't include PEP 678.

Here's a sample test that shows the consistency in Python's stdlib traceback module (test 1) and the difference between Python and IPython's runtimes (test 2):

import traceback

print('--- test 1 ---')
try:
    raise Exception('Testing notes')
except Exception as e:
    e.add_note('Does this work?')
    e.add_note('Yes!')
    traceback.print_exc()

print('\n--- test 2 ---')
try:
    raise Exception('Testing notes')
except Exception as e:
    e.add_note('Does this work?')
    e.add_note('No!')
    raise

When executed with Python 3.11, both notes are displayed in both tracebacks:

$ python test.py 
--- test 1 ---
Traceback (most recent call last):
  File "/app/test.py", line 5, in <module>
    raise Exception('Testing notes')
Exception: Testing notes
Does this work?
Yes!

--- test 2 ---
Traceback (most recent call last):
  File "/app/test.py", line 13, in <module>
    raise Exception('Testing notes')
Exception: Testing notes
Does this work?
No!

In IPython's VerboseTB does not yet handle exception notes:

$ ipython test.py 
--- test 1 ---
Traceback (most recent call last):
  File "/app/test.py", line 5, in <module>
    raise Exception('Testing notes')
Exception: Testing notes
Does this work?
Yes!

--- test 2 ---
---------------------------------------------------------------------------
Exception                                 Traceback (most recent call last)
File /app/test.py:13
     11 print('\n--- test 2 ---')
     12 try:
---> 13     raise Exception('Testing notes')
     14 except Exception as e:
     15     e.add_note('Does this work?')

Exception: Testing notes

The changes I am suggesting are inspired from implementation of Lib/traceback.py (search for __notes__) and improvements for dealing with edge cases more nicely in cpython#103897.

Although notes are meant to be strings only, I kept some inspiration from the existing exception handling to ensure that the notes are uncolored and bytes decoded, if there are any. I am definitely open to using a different color if deemed better. For context, bpython keeps the notes uncolored, and Python's tutorial puts them in light gray, like the line numbers.

Here's how the test 2 looks like after these changes:
image

🐍 🤹‍♂️

@Zac-HD
Copy link
Contributor
Zac-HD commented Apr 28, 2023 •
edited
Loading

Oops, I checked for existing issues a few hours before this was opened and then created #14040 - it has tests and a changelog, but is a bit less careful about edge cases. Cherry-pick whatever you want and then I'll close my PR?

@Carreau
Copy link
Member
Carreau commented Apr 28, 2023

I'm guessing you both are at PyCon sprints !? Enjoy ! I'll likely get that in during May :-).

@Carreau Carreau added this to the 8.14 milestone Apr 28, 2023
@EtiennePelletier
Copy link
Contributor Author

Changes cherry-picked, good catch Zac on the Plain traceback format!

Carreau
Carreau reviewed Jun 2, 2023
View reviewed changes
.gitignore
@@ -27,6 +27,7 @@ __pycache__
*.swp
.pytest_cache
.python-version
.venv*/
Copy link
Member

Choose a reason for hiding this comment

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

You likely want that in your global gitignore to not have to do it for all your repos.

@Carreau
Copy link
Member
Carreau commented Jun 2, 2023

Let's try this. Sorry I was mostly travelling last month.

@Carreau Carreau merged commit 1d4e184 into ipython:main Jun 2, 2023
@Carreau Carreau mentioned this pull request Jun 2, 2023
Closed
This was referenced Jun 21, 2023
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Carreau Carreau Carreau left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
8.14
Development

Successfully merging this pull request may close these issues.
3 participants
@EtiennePelletier @Zac-HD @Carreau
0