From 051f0e5683fec3840fa7fc99723741dd2d701eae Mon Sep 17 00:00:00 2001 From: Damien <81557462+Damien-Chen@users.noreply.github.com> Date: Sun, 2 Mar 2025 17:29:12 +0800 Subject: gh-128481: Improve documentation for `traceback.FrameSummary` (#128484) Complete the `traceback.FrameSummary` signature and add missing documentation for the `colno` and `end_{col,line}no` attributes. --- Doc/library/traceback.rst | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 3475b01..757fdf6 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -508,7 +508,9 @@ the module-level functions described above. A :class:`!FrameSummary` object represents a single :ref:`frame ` in a :ref:`traceback `. -.. 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 ` in the :ref:`traceback ` or stack that is being formatted @@ -544,6 +546,22 @@ in a :ref:`traceback `. 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 -- cgit v0.12