mirror of
https://github.com/python/cpython.git
synced 2025-08-04 17:08:35 +00:00
gh-127347: Document traceback.print_list
(#127348)
Previously, `traceback.print_list` didn't have a documentation entry and was not exposed in `traceback.__all__`. Now it has a documentation entry and is exposed in `__all__`.
This commit is contained in:
parent
412e11fe6e
commit
8ba9f5bca9
4 changed files with 10 additions and 3 deletions
|
@ -157,6 +157,13 @@ Module-Level Functions
|
|||
arguments have the same meaning as for :func:`print_stack`.
|
||||
|
||||
|
||||
.. function:: print_list(extracted_list, file=None)
|
||||
|
||||
Print the list of tuples as returned by :func:`extract_tb` or
|
||||
:func:`extract_stack` as a formatted stack trace to the given file.
|
||||
If *file* is ``None``, the output is written to :data:`sys.stderr`.
|
||||
|
||||
|
||||
.. function:: format_list(extracted_list)
|
||||
|
||||
Given a list of tuples or :class:`FrameSummary` objects as returned by
|
||||
|
|
|
@ -4488,9 +4488,8 @@ class MiscTest(unittest.TestCase):
|
|||
|
||||
def test_all(self):
|
||||
expected = set()
|
||||
denylist = {'print_list'}
|
||||
for name in dir(traceback):
|
||||
if name.startswith('_') or name in denylist:
|
||||
if name.startswith('_'):
|
||||
continue
|
||||
module_object = getattr(traceback, name)
|
||||
if getattr(module_object, '__module__', None) == 'traceback':
|
||||
|
|
|
@ -15,7 +15,7 @@ __all__ = ['extract_stack', 'extract_tb', 'format_exception',
|
|||
'format_tb', 'print_exc', 'format_exc', 'print_exception',
|
||||
'print_last', 'print_stack', 'print_tb', 'clear_frames',
|
||||
'FrameSummary', 'StackSummary', 'TracebackException',
|
||||
'walk_stack', 'walk_tb']
|
||||
'walk_stack', 'walk_tb', 'print_list']
|
||||
|
||||
#
|
||||
# Formatting and printing lists of traceback lines.
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
Publicly expose :func:`traceback.print_list` in :attr:`!traceback.__all__`.
|
Loading…
Add table
Add a link
Reference in a new issue