Feature Request: Expose Handling Frame Information in Python's Traceback Module
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
Proposal:
Problem: When dealing with chained exceptions in Python, there is no straightforward way to identify the "outermost handling frame": the frame in the except/finally block that starts the part of the stacktrace that's unique to the "during the handling" exception.
This information is not visible in the textual stacktrace, nor is it accessible programmatically via Python's traceback module (or similar tools).
Since this "handling frame" represents half of the link between 2 exceptions when shown in "chained mode", the fact that this information is missing makes it very hard to see how 2 chained exceptions actually relate to each other.
Proposal: Extend Python's traceback-related modules (e.g., traceback, sys.exc_info) to expose handling frame information. This would allow developers and tools to programmatically determine where exceptions are caught and re-raised in the call stack.
(It would seem to me that just changing the underlying datastructures leads to the least disruption in peoples' workflow, while still allowing for some users to extract the information if they need it)
Current Behavior:
Using the following example:
class OriginalException(Exception):
pass
class AnotherException(Exception):
pass
def raise_another_exception():
raise AnotherException()
def show_something():
try:
raise OriginalException()
except OriginalException:
raise_another_exception()
show_something()
Running this code produces:
Traceback (most recent call last):
File "example.py", line 15, in show_something
raise OriginalException()
__main__.OriginalException
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "example.py", line 20, in <module>
show_something()
File "example.py", line 17, in show_something
raise_another_exception()
File "example.py", line 10, in raise_another_exception
raise AnotherException()
__main__.AnotherException
In this traceback, line 17 (raise_another_exception()) is the handling frame, but there is no direct way to programmatically extract this information.
Proposed Improvement:
Enhance the traceback-related API(s) to expose handling frame information.
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
This is obviously not actually a discussion since it doesn't involve other people, but I do think it's useful context (and it's better to keep the longer story out of the feature-request)
Linked PRs
- gh-127021
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the traceback-related APIs and sys.exc_info, using the show_something and raise_another_exception example as the behavior to understand. Review linked PR gh-127021 for the existing work. Done means the traceback-related API exposes the handling frame for chained exceptions in a defined, usable way.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100