mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-22 11:36:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-27910: Update documentation of traceback module (GH-6116)

Browse source 
In the documentation for the traceback module, the definitions of functions
extract_tb(), format_list() and classmethod StackSummary.from_list()
mention the old style 4-tuples that these functions used to return or accept.

Since Python 3.5, however, they return or accept a FrameSummary object
instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.

Co-Authored-By: Berker Peksag <berker.peksag@gmail.com>
This commit is contained in:
torsava 2018-08-02 17:08:59 +01:00 • committed by Berker Peksag
parent a2fe1e52eb
commit f394ee5eaf
2 changed files with 35 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

36
Doc/library/traceback.rst
View file

@ -88,14 +88,16 @@ The module defines the following functions:
.. function:: extract_tb(tb, limit=None)
Return a list of "pre-processed" stack trace entries extracted from the
traceback object *tb*. It is useful for alternate formatting of
stack traces. The optional *limit* argument has the same meaning as for
:func:`print_tb`. A "pre-processed" stack trace entry is a 4-tuple
(*filename*, *line number*, *function name*, *text*) representing the
information that is usually printed for a stack trace. The *text* is a
string with leading and trailing whitespace stripped; if the source is
not available it is ``None``.
Return a :class:`StackSummary` object representing a list of "pre-processed"
stack trace entries extracted from the traceback object *tb*. It is useful
for alternate formatting of stack traces. The optional *limit* argument has
the same meaning as for :func:`print_tb`. A "pre-processed" stack trace
entry is a :class:`FrameSummary` object containing attributes
:attr:`~FrameSummary.filename`, :attr:`~FrameSummary.lineno`,
:attr:`~FrameSummary.name`, and :attr:`~FrameSummary.line` representing the
information that is usually printed for a stack trace. The
:attr:`~FrameSummary.line` is a string with leading and trailing
whitespace stripped; if the source is not available it is ``None``.
.. function:: extract_stack(f=None, limit=None)
@ -107,12 +109,12 @@ The module defines the following functions:
.. function:: format_list(extracted_list)
Given a list of tuples as returned by :func:`extract_tb` or
:func:`extract_stack`, return a list of strings ready for printing. Each
string in the resulting list corresponds to the item with the same index in
the argument list. Each string ends in a newline; the strings may contain
internal newlines as well, for those items whose source text line is not
``None``.
Given a list of tuples or :class:`FrameSummary` objects as returned by
:func:`extract_tb` or :func:`extract_stack`, return a list of strings ready
for printing. Each string in the resulting list corresponds to the item with
the same index in the argument list. Each string ends in a newline; the
strings may contain internal newlines as well, for those items whose source
text line is not ``None``.
.. function:: format_exception_only(etype, value)
@ -293,9 +295,9 @@ capture data for later printing in a lightweight fashion.
.. classmethod:: from_list(a_list)
Construct a :class:`StackSummary` object from a supplied old-style list
of tuples. Each tuple should be a 4-tuple with filename, lineno, name,
line as the elements.
Construct a :class:`StackSummary` object from a supplied list of
:class:`FrameSummary` objects or old-style list of tuples. Each tuple
should be a 4-tuple with filename, lineno, name, line as the elements.
.. method:: format()