Skip to content

gh-140456: Document that FrameSummary.line is a single line #153469

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

Closed
harjothkhara wants to merge 6 commits into from
Closed

gh-140456: Document that FrameSummary.line is a single line #153469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
67bab37
gh-140456: Clarify traceback source line documentation
harjothkhara Jul 10, 2026
a13acfa
Document that multiline display also needs an end line number
harjothkhara Jul 10, 2026
73fa48a
Add NEWS entry for gh-140456
harjothkhara Jul 12, 2026
c1cf6a6
Merge branch 'main' into codex/gh-140456-traceback-docs
harjothkhara Aug 15, 2026
e8fab24
gh-140456: Document that FrameSummary.line is a single line
harjothkhara Oct 27, 2026
36ff4f1
Merge branch 'main' into codex/gh-140456-traceback-docs
harjothkhara Nov 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/library/traceback.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,8 @@ in a :ref:`traceback <traceback-objects>`.

A string representing the source code for this frame, with leading and
trailing whitespace stripped.
It is a single line, the one at :attr:`~FrameSummary.lineno`, even if
the source code for this frame spans several lines.
If the source is not available, it is ``None``.

.. attribute:: FrameSummary.end_lineno
Expand Down
3 changes: 2 additions & 1 deletion Lib/traceback.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,8 @@ class FrameSummary:
- :attr:`name` The name of the function or method that was executing
when the frame was captured.
- :attr:`line` The text from the linecache module for the line
of code that was running when the frame was captured.
of code that was running when the frame was captured. It is a
single line, even if the code spans several lines.
- :attr:`locals` Either None if locals were not supplied, or a dict
mapping the name to the repr() of the variable.
- :attr:`end_lineno` The last line number of the source code for this frame.
Expand Down
Loading