mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 08:59:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

gh-128481: Improve documentation for traceback.FrameSummary (#128484)

Browse source 
Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
This commit is contained in:
Damien 2025-03-02 17:29:12 +08:00 • committed by GitHub
parent 37145cb89f
commit 051f0e5683
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/traceback.rst
View file

@ -508,7 +508,9 @@ the module-level functions described above.
A :class:`!FrameSummary` object represents a single :ref:`frame <frame-objects>`
in a :ref:`traceback <traceback-objects>`.
.. class:: FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)
.. class:: FrameSummary(filename, lineno, name, *,\
lookup_line=True, locals=None,\
line=None, end_lineno=None, colno=None, end_colno=None)
Represents a single :ref:`frame <frame-objects>` in the
:ref:`traceback <traceback-objects>` or stack that is being formatted
@ -544,6 +546,22 @@ in a :ref:`traceback <traceback-objects>`.
trailing whitespace stripped.
If the source is not available, it is ``None``.
.. attribute:: FrameSummary.end_lineno
The last line number of the source code for this frame.
By default, it is set to ``lineno`` and indexation starts from 1.
.. attribute:: FrameSummary.colno
The column number of the source code for this frame.
By default, it is ``None`` and indexation starts from 0.
.. attribute:: FrameSummary.end_colno
The last column number of the source code for this frame.
By default, it is ``None`` and indexation starts from 0.
.. _traceback-example:
Examples of Using the Module-Level Functions