From 4b920d2d38e52433992ec1845d2d2826e42766cd Mon Sep 17 00:00:00 2001 From: Tomas Roun Date: Wed, 27 Nov 2024 22:51:36 +0100 Subject: [PATCH 1/5] Document traceback.print_list --- Doc/library/traceback.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 100a92b73d5497..8f94fc448f2482 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -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 From 9ea03bb0decb6ea18baa204c5f1006928cca4abc Mon Sep 17 00:00:00 2001 From: Tomas Roun Date: Wed, 27 Nov 2024 22:56:59 +0100 Subject: [PATCH 2/5] Add news entry --- .../Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst diff --git a/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst b/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst new file mode 100644 index 00000000000000..3bee346c1e2ce6 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst @@ -0,0 +1 @@ +Document :func:`traceback.print_list`. From daf86c8726865576141a83d43a610adc4a5da642 Mon Sep 17 00:00:00 2001 From: Tomas Roun Date: Thu, 28 Nov 2024 17:55:43 +0100 Subject: [PATCH 3/5] Update traceback.__all__ --- Lib/traceback.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Lib/traceback.py b/Lib/traceback.py index f73149271b9bc9..6367c00e4d4b86 100644 --- a/Lib/traceback.py +++ b/Lib/traceback.py @@ -15,7 +15,7 @@ '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. From 060a5979450d2978eed43c7bd4d8ecf7e8bb9af7 Mon Sep 17 00:00:00 2001 From: Tomas Roun Date: Thu, 28 Nov 2024 17:57:16 +0100 Subject: [PATCH 4/5] Update tests --- Lib/test/test_traceback.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Lib/test/test_traceback.py b/Lib/test/test_traceback.py index ec69412f5511eb..ea8d9f2137aca5 100644 --- a/Lib/test/test_traceback.py +++ b/Lib/test/test_traceback.py @@ -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': From e97528d5c7af99e2097da4d797ff4a1f0fff484a Mon Sep 17 00:00:00 2001 From: Tomas Roun Date: Sat, 30 Nov 2024 18:51:31 +0100 Subject: [PATCH 5/5] Update news entry --- .../2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst b/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst index 3bee346c1e2ce6..79b3faa3d0d385 100644 --- a/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst +++ b/Misc/NEWS.d/next/Documentation/2024-11-27-22-56-48.gh-issue-127347.xyddWS.rst @@ -1 +1 @@ -Document :func:`traceback.print_list`. +Publicly expose :func:`traceback.print_list` in :attr:`!traceback.__all__`.