Extract traceback info from an exception object

by

The answer to this question depends on the version of Python you’re using.

In Python 3

It’s simple: exceptions come equipped with a __traceback__ attribute that contains the traceback. This attribute is also writable, and can be conveniently set using the with_traceback method of exceptions: 

raise Exception("foo occurred").with_traceback(tracebackobj)

These features are minimally described as part of the raise documentation.

All credit for this part of the answer should go to Vyctor, who first posted this information. I’m including it here only because this answer is stuck at the top, and Python 3 is becoming more common.

In Python 2

It’s annoyingly complex. The trouble with tracebacks is that they have references to stack frames, and stack frames have references to the tracebacks that have references to stack frames that have references to… you get the idea. This causes problems for the garbage collector. (Thanks to ecatmur for first pointing this out.)

The nice way of solving this would be to surgically break the cycle after leaving the except clause, which is what Python 3 does. The Python 2 solution is much uglier: you are provided with an ad-hoc function,sys.exc_info(), which only works inside the except clause. It returns a tuple containing the exception, the exception type, and the traceback for whatever exception is currently being handled.

So if you are inside the except clause, you can use the output of sys.exc_info() along with the traceback module to do various useful things:

>>> import sys, traceback
>>> def raise_exception():
...     try:
...         raise Exception
...     except Exception:
...         ex_type, ex, tb = sys.exc_info()
...         traceback.print_tb(tb)
...     finally:
...         del tb
... 
>>> raise_exception()
  File "<stdin>", line 3, in raise_exception

But as your edit indicates, you’re trying to get the traceback that would have been printed if your exception had not been handled, after it has already been handled. That’s a much harder question. Unfortunately, sys.exc_info returns (None, None, None) when no exception is being handled. Other related sys attributes don’t help either. sys.exc_traceback is deprecated and undefined when no exception is being handled; sys.last_traceback seems perfect, but it appears only to be defined during interactive sessions.

If you can control how the exception is raised, you might be able to use inspect and a custom exception to store some of the information. But I’m not entirely sure how that would work.

To tell the truth, catching and returning an exception is kind of an unusual thing to do. This might be a sign that you need to refactor anyway.

More Related Contents:

  1. check what files are open in Python
  2. Importing installed package from script raises “AttributeError: module has no attribute” or “ImportError: cannot import name”
  3. Is there a built-in function to print all the current properties and values of an object?
  4. Is it a good practice to use try-except-else in Python?
  5. Catch a thread’s exception in the caller thread?
  6. selenium.common.exceptions.InvalidSelectorException with “span:contains(‘string’)”
  7. How to print an exception in Python?
  8. Python memory leaks [closed]
  9. Disable assertions in Python
  10. Print current call stack from a method in code
  11. Python exception chaining [duplicate]
  12. Importing installed package from script with the same name raises “AttributeError: module has no attribute” or “ImportError: cannot import name”
  13. In Python, how does one catch warnings as if they were exceptions?
  14. python tracing a segmentation fault
  15. Python type hinting with exceptions
  16. Python: Getting a traceback from a multiprocessing.Process
  17. Don’t show Python raise-line in the exception stack
  18. cannot override sys.excepthook
  19. Python: Print a variable’s name and value?
  20. Log exception with traceback in Python
  21. Attaching a process with pdb
  22. Default value in Python unpacking
  23. Adding information to an exception? [duplicate]
  24. Step-by-step debugging with IPython
  25. How to return a custom 404 Not Found page using FastAPI?
  26. Catching exception in context manager __enter__()
  27. pydev breakpoints not working
  28. How to watch for a variable change in python without dunder setattr or pdb
  29. Flask Config File – ‘DEBUG=True’ Do Nothing
  30. scipy convolve2d outputs wrong values

Leave a Comment