show_source_lines

Author: methane

Lib/traceback.py

@@ -26,22 +26,22 @@
 #
 
 
-def print_list(extracted_list, file=None, *, show_lines=True):
+def print_list(extracted_list, file=None, *, show_source_lines=True):
     """Print the list of tuples as returned by extract_tb() or
     extract_stack() as a formatted stack trace to the given file.
 
     To print in "recent call first" order, call "extracted_list.reverse()"
     before passing it to this function.
 
-    If 'show_lines' is true, source code lines are included in the output.
+    If 'show_source_lines' is true, source code lines are included in the output.
     """
     if file is None:
         file = sys.stderr
     for item in StackSummary.from_list(extracted_list).format(
-            show_lines=show_lines):
+            show_source_lines=show_source_lines):
         print(item, file=file, end="")
 
-def format_list(extracted_list, *, show_lines=True):
+def format_list(extracted_list, *, show_source_lines=True):
     """Format a list of tuples or FrameSummary objects for printing.
 
     Given a list of tuples or FrameSummary objects as returned by
@@ -51,38 +51,40 @@ def format_list(extracted_list, *, show_lines=True):
     Each string ends in a newline; the strings may contain internal newlines as
     well, for those items whose source text line is not None.
 
-    If 'show_lines' is true, source code lines are included in the output.
+    If 'show_source_lines' is true, source code lines are included in the output.
     """
-    return StackSummary.from_list(extracted_list).format(show_lines=show_lines)
+    return StackSummary.from_list(extracted_list).format(
+            show_source_lines=show_source_lines)
 
 #
 # Printing and Extracting Tracebacks.
 #
 
-def print_tb(tb, limit=None, file=None, *, show_lines=True, recent_first=False):
+def print_tb(tb, limit=None, file=None, *,
+             show_source_lines=True, recent_first=False):
     """Print up to 'limit' stack trace entries from the traceback 'tb'.
 
     If 'limit' is omitted or None, all entries are printed.  If 'file'
     is omitted or None, the output goes to sys.stderr; otherwise
     'file' should be an open file or file-like object with a write()
     method.
 
-    If 'show_lines' is true, source code lines are included in the output.
+    If 'show_source_lines' is true, source code lines are included in the output.
     If 'recent_first' is true, the stack trace is printed in "most recent call
     first" order.
     """
     tblist = extract_tb(tb, limit=limit)
     if recent_first:
         tblist.reverse()
-    print_list(tblist, file=file, show_lines=show_lines)
+    print_list(tblist, file=file, show_source_lines=show_source_lines)
 
-def format_tb(tb, limit=None, *, show_lines=True, recent_first=False):
+def format_tb(tb, limit=None, *, show_source_lines=True, recent_first=False):
     """A shorthand for 'format_list(extract_tb(tb, limit))'."""
 
     tblist = extract_tb(tb, limit=limit)
     if recent_first:
         tblist.reverse()
-    return tblist.format(show_lines=show_lines)
+    return tblist.format(show_source_lines=show_source_lines)
 
 def extract_tb(tb, limit=None):
     """
@@ -135,7 +137,7 @@ def _parse_value_tb(exc, value, tb):
 
 
 def print_exception(exc, /, value=_sentinel, tb=_sentinel, limit=None,
-                    file=None, chain=True, *, show_lines=True,
+                    file=None, chain=True, *, show_source_lines=True,
                     recent_first=False, **kwargs):
     """Print exception up to 'limit' stack trace entries from 'tb' to 'file'.
 
@@ -147,15 +149,15 @@ def print_exception(exc, /, value=_sentinel, tb=_sentinel, limit=None,
     occurred with a caret on the next line indicating the approximate
     position of the error.
 
-    If 'show_lines' is true, source code lines are included in the output.
+    If 'show_source_lines' is true, source code lines are included in the output.
     If 'recent_first' is true, exception is printed first and traceback is shown
     by "most recent call first" order.
     """
     colorize = kwargs.get("colorize", False)
     value, tb = _parse_value_tb(exc, value, tb)
     te = TracebackException(type(value), value, tb, limit=limit, compact=True)
     te.print(file=file, chain=chain, colorize=colorize,
-             show_lines=show_lines, recent_first=recent_first)
+             show_source_lines=show_source_lines, recent_first=recent_first)
 
 
 BUILTIN_EXCEPTION_LIMIT = object()
@@ -167,8 +169,8 @@ def _print_exception_bltin(exc, /):
     return print_exception(exc, limit=BUILTIN_EXCEPTION_LIMIT, file=file, colorize=colorize)
 
 
-def format_exception(exc, /, value=_sentinel, tb=_sentinel, limit=None,
-                     chain=True, *, show_lines=True, recent_first=False, **kwargs):
+def format_exception(exc, /, value=_sentinel, tb=_sentinel, limit=None, chain=True,
+                     *, show_source_lines=True, recent_first=False, **kwargs):
     """Format a stack trace and the exception information.
 
     The arguments have the same meaning as the corresponding arguments
@@ -181,7 +183,8 @@ def format_exception(exc, /, value=_sentinel, tb=_sentinel, limit=None,
     value, tb = _parse_value_tb(exc, value, tb)
     te = TracebackException(type(value), value, tb, limit=limit, compact=True)
     return list(te.format(chain=chain, colorize=colorize,
-                          show_lines=show_lines, recent_first=recent_first))
+                          show_source_lines=show_source_lines,
+                          recent_first=recent_first))
 
 
 def format_exception_only(exc, /, value=_sentinel, *, show_group=False, **kwargs):
@@ -230,63 +233,64 @@ def _safe_string(value, what, func=str):
 
 # --
 
-def print_exc(limit=None, file=None, chain=True, *, show_lines=True,
+def print_exc(limit=None, file=None, chain=True, *, show_source_lines=True,
               recent_first=False):
     """Shorthand for 'print_exception(sys.exception(), limit=limit, file=file, chain=chain, ...)'."""
     print_exception(sys.exception(), limit=limit, file=file, chain=chain,
-                    show_lines=show_lines, recent_first=recent_first)
+                    show_source_lines=show_source_lines, recent_first=recent_first)
 
-def format_exc(limit=None, chain=True, *, show_lines=True, recent_first=False):
+def format_exc(limit=None, chain=True, *, show_source_lines=True, recent_first=False):
     """Like print_exc() but return a string."""
     return "".join(format_exception(
         sys.exception(), limit=limit, chain=chain,
-        show_lines=show_lines, recent_first=recent_first))
+        show_source_lines=show_source_lines, recent_first=recent_first))
 
-def print_last(limit=None, file=None, chain=True, *, show_lines=True,
+def print_last(limit=None, file=None, chain=True, *, show_source_lines=True,
                recent_first=False):
     """This is a shorthand for 'print_exception(sys.last_exc, limit=limit, file=file, chain=chain, ...)'."""
     if not hasattr(sys, "last_exc") and not hasattr(sys, "last_type"):
         raise ValueError("no last exception")
 
     if hasattr(sys, "last_exc"):
         print_exception(sys.last_exc, limit=limit, file=file, chain=chain,
-                        show_lines=show_lines, recent_first=recent_first)
+                        show_source_lines=show_source_lines, recent_first=recent_first)
     else:
         print_exception(sys.last_type, sys.last_value, sys.last_traceback,
                         limit=limit, file=file, chain=chain,
-                        show_lines=show_lines, recent_first=recent_first)
+                        show_source_lines=show_source_lines, recent_first=recent_first)
 
 
 #
 # Printing and Extracting Stacks.
 #
 
-def print_stack(f=None, limit=None, file=None, *, show_lines=True, recent_first=False):
+def print_stack(f=None, limit=None, file=None, *, show_source_lines=True,
+                recent_first=False):
     """Print a stack trace from its invocation point.
 
     The optional 'f' argument can be used to specify an alternate
     stack frame at which to start. The optional 'limit' and 'file'
     arguments have the same meaning as for print_exception().
 
-    If 'show_lines' is true, source code lines are included in the output.
+    If 'show_source_lines' is true, source code lines are included in the output.
     If 'recent_first' is true, stack is printed by "most recent call first" order.
     """
     if f is None:
         f = sys._getframe().f_back
     stack = extract_stack(f, limit=limit)
     if recent_first:
         stack.reverse()
-    print_list(stack, file=file, show_lines=show_lines)
+    print_list(stack, file=file, show_source_lines=show_source_lines)
 
 
-def format_stack(f=None, limit=None, *, show_lines=True, recent_first=False):
-    """Shorthand for 'format_list(extract_stack(f, limit), show_lines)'."""
+def format_stack(f=None, limit=None, *, show_source_lines=True, recent_first=False):
+    """Shorthand for 'format_list(extract_stack(f, limit), show_source_lines)'."""
     if f is None:
         f = sys._getframe().f_back
     stack = extract_stack(f, limit=limit)
     if recent_first:
         stack.reverse()
-    return format_list(stack, show_lines=show_lines)
+    return format_list(stack, show_source_lines=show_source_lines)
 
 
 def extract_stack(f=None, limit=None):
@@ -573,7 +577,7 @@ def from_list(klass, a_list):
                 result.append(FrameSummary(filename, lineno, name, line=line))
         return result
 
-    def format_frame_summary(self, frame_summary, *, show_lines=True, **kwargs):
+    def format_frame_summary(self, frame_summary, *, show_source_lines=True, **kwargs):
         """Format the lines for a single FrameSummary.
 
         Returns a string representing one frame involved in the stack. This
@@ -601,7 +605,8 @@ def format_frame_summary(self, frame_summary, *, show_lines=True, **kwargs):
                 theme.reset,
             )
         )
-        if show_lines and frame_summary._dedented_lines and frame_summary._dedented_lines.strip():
+        if (show_source_lines
+                and frame_summary._dedented_lines and frame_summary._dedented_lines.strip()):
             if (
                 frame_summary.colno is None or
                 frame_summary.end_colno is None
@@ -790,7 +795,7 @@ def _spawns_full_line(value):
             return True
         return False
 
-    def format(self, *, show_lines=True, **kwargs):
+    def format(self, *, show_source_lines=True, **kwargs):
         """Format the stack ready for printing.
 
         Returns a list of strings ready for printing.  Each string in the
@@ -809,7 +814,8 @@ def format(self, *, show_lines=True, **kwargs):
         last_name = None
         count = 0
         for frame_summary in self:
-            formatted_frame = self.format_frame_summary(frame_summary, show_lines=show_lines, colorize=colorize)
+            formatted_frame = self.format_frame_summary(
+                    frame_summary, show_source_lines=show_source_lines, colorize=colorize)
             if formatted_frame is None:
                 continue
             if (last_file is None or last_file != frame_summary.filename or
@@ -1513,7 +1519,8 @@ def _format_syntax_error(self, stype, **kwargs):
             filename_suffix,
         )
 
-    def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False, **kwargs):
+    def format(self, *, chain=True, show_source_lines=True, _ctx=None,
+               recent_first=False, **kwargs):
         """Format the exception.
 
         If chain is not *True*, *__cause__* and *__context__* will not be formatted.
@@ -1556,13 +1563,13 @@ def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False,
                 if not recent_first and exc.stack:
                     yield from _ctx.emit('Traceback (most recent call last):\n')
                     yield from _ctx.emit(exc.stack.format(
-                        show_lines=show_lines, colorize=colorize))
+                        show_source_lines=show_source_lines, colorize=colorize))
                 yield from _ctx.emit(exc.format_exception_only(colorize=colorize))
                 if recent_first and exc.stack:
                     yield from _ctx.emit('Traceback (most recent call first):\n')
                     reversed_stack = StackSummary(reversed(self.stack))
                     yield from _ctx.emit(reversed_stack.format(
-                        show_lines=show_lines, colorize=colorize))
+                        show_source_lines=show_source_lines, colorize=colorize))
             elif _ctx.exception_group_depth > self.max_group_depth:
                 # exception group, but depth exceeds limit
                 yield from _ctx.emit(
@@ -1578,7 +1585,7 @@ def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False,
                         'Exception Group Traceback (most recent call last):\n',
                         margin_char = '+' if is_toplevel else None)
                     yield from _ctx.emit(exc.stack.format(
-                        show_lines=show_lines, colorize=colorize))
+                        show_source_lines=show_source_lines, colorize=colorize))
 
                 yield from _ctx.emit(exc.format_exception_only(colorize=colorize))
                 if recent_first and exc.stack:
@@ -1587,7 +1594,7 @@ def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False,
                         margin_char = '+' if is_toplevel else None)
                     reversed_stack = StackSummary(reversed(self.stack))
                     yield from _ctx.emit(reversed_stack.format(
-                        show_lines=show_lines, colorize=colorize))
+                        show_source_lines=show_source_lines, colorize=colorize))
 
                 num_excs = len(exc.exceptions)
                 if num_excs <= self.max_group_width:
@@ -1611,7 +1618,9 @@ def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False,
                            f'+---------------- {title} ----------------\n')
                     _ctx.exception_group_depth += 1
                     if not truncated:
-                        yield from exc.exceptions[i].format(chain=chain, show_lines=show_lines, _ctx=_ctx, colorize=colorize)
+                        yield from exc.exceptions[i].format(
+                                chain=chain, show_source_lines=show_source_lines,
+                                _ctx=_ctx, colorize=colorize)
                     else:
                         remaining = num_excs - self.max_group_width
                         plural = 's' if remaining > 1 else ''
@@ -1629,12 +1638,13 @@ def format(self, *, chain=True, show_lines=True, _ctx=None, recent_first=False,
                     _ctx.exception_group_depth = 0
 
 
-    def print(self, *, file=None, chain=True, show_lines=True, recent_first=False, **kwargs):
+    def print(self, *, file=None, chain=True, show_source_lines=True,
+              recent_first=False, **kwargs):
         """Print the result of self.format(chain=chain) to 'file'."""
         colorize = kwargs.get("colorize", False)
         if file is None:
             file = sys.stderr
-        for line in self.format(chain=chain, show_lines=show_lines,
+        for line in self.format(chain=chain, show_source_lines=show_source_lines,
                                 recent_first=recent_first, colorize=colorize):
             print(line, file=file, end="")