gh-135751: traceback: add recent_first and show_source_lines #135752
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
methane
added
type-feature
There was a problem hiding this comment.
Pull Request Overview
Adds two new keyword-only parameters, show_lines and recent_first, to the traceback module’s formatting and printing APIs, allowing callers to suppress source lines or invert traceback order.
- Introduce
show_linesandrecent_firstacross module-level functions andTracebackException/StackSummarymethods - Update internal printing/formatting logic to pass these flags through
- Extend tests and documentation to cover new behavior
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Misc/NEWS.d/next/Library/2025-06-20-21-16-32…rst | Announce new parameters in the NEWS file |
| Lib/traceback.py | Core implementation: API signatures and logic updates |
| Lib/test/test_traceback.py | New unit tests for show_lines and recent_first flags |
| Doc/whatsnew/3.15.rst | Document what’s new section for show_lines/recent_first |
| Doc/library/traceback.rst | Update function/method docstrings to include new flags |
Comments suppressed due to low confidence (4)
Lib/traceback.py:31
- The first line of the docstring was truncated and now only mentions
extract_stack(). It should refer to bothextract_tb()andextract_stack(), e.g., "Print the list of tuples as returned byextract_tb()orextract_stack()as a formatted stack trace to the given file."
extract_stack() as a formatted stack trace to the given file.
Doc/whatsnew/3.15.rst:181
- [nitpick] Grammar in release notes: replace "It is default to
True." with "Defaults toTrue." for clarity.
It is default to ``True``.
Doc/library/traceback.rst:125
- [nitpick] This sentence is duplicated immediately above; remove one instance to avoid redundancy.
If *show_lines* is false, source code lines are not included in the output.
Doc/library/traceback.rst:175
- [nitpick] Using "next" as a version string may be confusing. Consider using the actual upcoming version number or a placeholder like "3.x" for clarity.
.. versionchanged:: next
methane
commented
Jun 20, 2025
Co-authored-by: Copilot <[email protected]>
hugovk
reviewed
Jun 20, 2025
iritkatriel
reviewed
Jun 20, 2025
iritkatriel
reviewed
Jun 20, 2025
| def print(self, *, file=None, chain=True, **kwargs): | ||
| def print(self, *, file=None, chain=True, show_lines=True, recent_first=False, **kwargs): | ||
| """Print the result of self.format(chain=chain) to 'file'.""" | ||
| colorize = kwargs.get("colorize", False) |
There was a problem hiding this comment.
Why not add the new args via **kwargs as was done for colorize? It would save having to update all the signatures.
There was a problem hiding this comment.
I think colorize is in kwargs because of its hidden parameter. Callars determine use COLOR automatically by isatty() and env variables and pass it to here. colorize is not documented.
On the other hand, show_lines and recent_first are explicit parameter.
User need to determine and specify them manually.
Co-authored-by: Hugo van Kemenade <[email protected]>
methane
commented
Jun 20, 2025
Co-authored-by: Brian Schubert <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
methane
force-pushed
the
traceback-show_lines
branch
from
0651ed2 to
2a56c6d
Compare
methane
changed the title
methane
force-pushed
the
traceback-show_lines
branch
from
9297884 to
94a11de
Compare
methane
force-pushed
the
traceback-show_lines
branch
from
94a11de to
2612590
Compare
|
Please try to avoid |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
recent_firstandshow_linesparameters #135751📚 Documentation preview 📚: https://cpython-previews--135752.org.readthedocs.build/