Skip to content

traceback: add recent_first and show_lines parameters #135751

@methane

Description

@methane

Feature or enhancement

Proposal:

traceback.print_exception() and other APIs showing traceback is optimized for developers looking console:

  • It uses "most recent call last" order and print exception later.
  • It shows source code lines. It makes the traceback huge when using large library like sqlalchemy.

On the other hand, Python applications would send traceback to observability backends like DataDog, New Relic, Grafana Loki, etc...
In such cases, "most recent first" order and shorter traceback without source are preferred because most other languages uses "most recent first" order and no source.

stdlib traceback should provide shorter and "most recent first" traceback format.

source:

import traceback

def f1():
    return 1 / 0

def f2():
    return f1()

try:
    f2()
except ZeroDivisionError as e:
    print("# default format")
    traceback.print_exception(e)

    print()
    print("# show_lines=False")
    traceback.print_exception(e, show_lines=False)

    print()
    print("# show_lines=False, recent_first=True")
    traceback.print_exception(e, show_lines=False, recent_first=True)

output:

# default format
Traceback (most recent call last):
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 10, in <module>
    f2()
    ~~^^
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 7, in f2
    return f1()
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 4, in f1
    return 1 / 0
           ~~^~~
ZeroDivisionError: division by zero

# show_lines=False
Traceback (most recent call last):
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 10, in <module>
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 7, in f2
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 4, in f1
ZeroDivisionError: division by zero

# show_lines=False, recent_first=True
ZeroDivisionError: division by zero
Traceback (most recent call first):
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 4, in f1
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 7, in f2
  File "/Users/inada-n/work/python/cpython/tb_demo.py", line 10, in <module>

Has this already been discussed elsewhere?

I have already discussed this feature proposal on Discourse

Links to previous discussion of this feature:

https://discuss.python.org/t/shorter-and-reversed-format-for-traceback/51139

Linked PRs

Metadata

Metadata

Assignees

Labels

stdlibPython modules in the Lib dirtype-featureA feature request or enhancement

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    pFad - Phonifier reborn

    Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

    Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


    Alternative Proxies:

    Alternative Proxy

    pFad Proxy

    pFad v3 Proxy

    pFad v4 Proxy