s/show_lines/show_source_lines/

Author: methane

Doc/library/traceback.rst

@@ -52,7 +52,7 @@ The module's API can be divided into two parts:
 Module-Level Functions
 ----------------------
 
-.. function:: print_tb(tb, limit=None, file=None, *, show_lines=True, recent_first=False)
+.. function:: print_tb(tb, limit=None, file=None, *, show_source_lines=True, recent_first=False)
 
    Print up to *limit* stack trace entries from
    :ref:`traceback object <traceback-objects>` *tb* (starting
@@ -63,7 +63,8 @@ Module-Level Functions
    :term:`file <file object>` or :term:`file-like object` to
    receive the output.
 
-   If *show_lines* is true (the default), source code lines will be included in the output.
+   If *show_source_lines* is true (the default), source code lines
+   will be included in the output.
 
    If *recent_first* is true, the most recent stack trace entries are printed
    first, otherwise the oldest entries are printed first. The default is false.
@@ -85,11 +86,12 @@ Module-Level Functions
        Added negative *limit* support.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
 .. function:: print_exception(exc, /[, value, tb], limit=None, \
-                              file=None, chain=True, *, show_lines=True, recent_first=False)
+                              file=None, chain=True, *, \
+                              show_source_lines=True, recent_first=False)
 
    Print exception information and stack trace entries from
    :ref:`traceback object <traceback-objects>`
@@ -118,7 +120,7 @@ Module-Level Functions
    printed as well, like the interpreter itself does when printing an unhandled
    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, the most recent stack trace entries are printed
    first, otherwise the oldest entries are printed first. The default is false.
@@ -131,45 +133,45 @@ Module-Level Functions
       positional-only.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: print_exc(limit=None, file=None, chain=True, *, show_lines=True, recent_first=False)
+.. function:: print_exc(limit=None, file=None, chain=True, *, show_source_lines=True, recent_first=False)
 
    This is a shorthand for ``print_exception(sys.exception(), limit=limit, file=file,
-   chain=chain, show_lines=show_lines, recent_first=recent_first)``.
+   chain=chain, show_source_lines=show_source_lines, recent_first=recent_first)``.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: print_last(limit=None, file=None, chain=True, *, show_lines=True, recent_first=False)
+.. function:: 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, show_lines=show_lines, recent_first=recent_first)``.
+   chain=chain, show_source_lines=show_source_lines, recent_first=recent_first)``.
    In general it will work only after an exception has reached an interactive
    prompt (see :data:`sys.last_exc`).
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: print_stack(f=None, limit=None, file=None, *, show_lines=True, recent_first=False)
+.. function:: print_stack(f=None, limit=None, file=None, *, show_source_lines=True, recent_first=False)
 
    Print up to *limit* stack trace entries (starting from the invocation
    point) if *limit* is positive.  Otherwise, print the last ``abs(limit)``
    entries.  If *limit* is omitted or ``None``, all entries are printed.
    The optional *f* argument can be used to specify an alternate
    :ref:`stack frame <frame-objects>`
    to start.  The optional *file* argument has the same meaning as for
-   :func:`print_tb`.  If *show_lines* is true, source code lines are
-   included in the output.
+   :func:`print_tb`.
+   If *show_source_lines* is true, source code lines are included in the output.
 
    .. versionchanged:: 3.5
       Added negative *limit* support.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
 .. function:: extract_tb(tb, limit=None)
@@ -193,29 +195,29 @@ Module-Level Functions
    arguments have the same meaning as for :func:`print_stack`.
 
 
-.. function:: print_list(extracted_list, file=None, *, show_lines=True)
+.. function:: print_list(extracted_list, file=None, *, show_source_lines=True)
 
    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`.
-   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.
 
    .. versionchanged:: next
-      Added the *show_lines* parameter.
+      Added the *show_source_lines* parameter.
 
 
-.. function:: format_list(extracted_list, *, show_lines=True)
+.. function:: format_list(extracted_list, *, show_source_lines=True)
 
    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``.  If *show_lines* is ``True``, source code lines
-   are included in the output.
+   text line is not ``None``.
+   If *show_source_lines* is true, source code lines are included in the output.
 
    .. versionchanged:: next
-      Added the *show_lines* parameter.
+      Added the *show_source_lines* parameter.
 
 
 .. function:: format_exception_only(exc, /[, value], *, show_group=False)
@@ -248,15 +250,16 @@ Module-Level Functions
       *show_group* parameter was added.
 
 
-.. function:: format_exception(exc, /[, value, tb], limit=None, chain=True, *, show_lines=True, recent_first=False, show_group=False)
+.. function:: format_exception(exc, /[, value, tb], limit=None, chain=True, *, \
+                               show_source_lines=True, recent_first=False)
 
    Format a stack trace and the exception information.  The arguments  have the
    same meaning as the corresponding arguments to :func:`print_exception`.  The
    return value is a list of strings, each ending in a newline and some
    containing internal newlines.  When these lines are concatenated and printed,
    exactly the same text is printed as does :func:`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, the most recent stack trace entries are printed
    first, otherwise the oldest entries are printed first. The default is false.
 
@@ -268,40 +271,40 @@ Module-Level Functions
       :func:`print_exception`.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: format_exc(limit=None, chain=True, *, show_lines=True, recent_first=False)
+.. function:: format_exc(limit=None, chain=True, *, show_source_lines=True, recent_first=False)
 
    This is like ``print_exc(limit)`` but returns a string instead of printing to
    a file.
 
-   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 most recent stack trace entries are printed
    first, otherwise the oldest entries are printed first. The default is false.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: format_tb(tb, limit=None, *, show_lines=True, recent_first=False)
+.. function:: format_tb(tb, limit=None, *, show_source_lines=True, recent_first=False)
 
-   A shorthand for ``format_list(extract_tb(tb, limit), show_lines=show_lines)``.
+   A shorthand for ``format_list(extract_tb(tb, limit), show_source_lines=show_source_lines)``.
 
    If *recent_first* is true, ``reversed(extract_tb(tb, limit))`` is used.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 
-.. function:: format_stack(f=None, limit=None, *, show_lines=True, recent_first=False)
+.. function:: format_stack(f=None, limit=None, *, show_source_lines=True, recent_first=False)
 
-   A shorthand for ``format_list(extract_stack(f, limit), show_lines=show_lines)``.
+   A shorthand for ``format_list(extract_stack(f, limit), show_source_lines=show_source_lines)``.
 
    If *recent_first* is true, ``reversed(extract_stack(f, limit))`` is used.
 
    .. versionchanged:: next
-      Added the *show_lines* and *recent_first* parameters.
+      Added the *show_source_lines* and *recent_first* parameters.
 
 .. function:: clear_frames(tb)
 
@@ -347,7 +350,8 @@ storing this information by avoiding holding references to
 In addition, they expose more options to configure the output compared to
 the module-level functions described above.
 
-.. class:: TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=False, capture_locals=False, compact=False, max_group_width=15, max_group_depth=10)
+.. class:: TracebackException(exc_type, exc_value, exc_traceback, *, limit=None, lookup_lines=False, \
+                              capture_locals=False, compact=False, max_group_width=15, max_group_depth=10)
 
    Capture an exception for later rendering. The meaning of *limit*,
    *lookup_lines* and *capture_locals* are as for the :class:`StackSummary`
@@ -375,7 +379,7 @@ the module-level functions described above.
 
    .. versionchanged:: next
       Changed *lookup_lines* default to ``False`` to avoid overhead when
-      formatting exceptions with ``show_lines=False``.
+      formatting exceptions with ``show_source_lines=False``.
 
    .. attribute:: __cause__
 
@@ -468,14 +472,14 @@ the module-level functions described above.
 
       .. versionchanged:: next
          Changed *lookup_lines* default to ``False`` to avoid overhead when
-         formatting exceptions with ``show_lines=False``.
+         formatting exceptions with ``show_source_lines=False``.
 
-   .. method::  print(*, file=None, chain=True, show_lines=True, recent_first=False)
+   .. method::  print(*, file=None, chain=True, show_source_lines=True, recent_first=False)
 
       Print to *file* (default ``sys.stderr``) the exception information returned by
       :meth:`format`.
 
-      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 exception is printed first followed by stack
       trace by "most recent call first" order.
@@ -485,9 +489,9 @@ the module-level functions described above.
       .. versionadded:: 3.11
 
       .. versionchanged:: next
-         Added the *show_lines* and *recent_first* parameters.
+         Added the *show_source_lines* and *recent_first* parameters.
 
-   .. method:: format(*, chain=True, show_lines=True, recent_first=False)
+   .. method:: format(*, chain=True, show_source_lines=True, recent_first=False)
 
       Format the exception.
 
@@ -498,17 +502,17 @@ the module-level functions described above.
       some containing internal newlines. :func:`~traceback.print_exception`
       is a wrapper around this method which just prints the lines to a file.
 
-      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 exception is printed first followed by stack
       trace by "most recent call first" order.
       Otherwise, the stack trace is printed first by "most recent call last" order
       followed by the exception.
 
       .. versionchanged:: next
-         Added the *show_lines* and *recent_first* parameters.
+         Added the *show_source_lines* and *recent_first* parameters.
 
-   .. method::  format_exception_only(*, show_group=False)
+   .. method:: format_exception_only(*, show_group=False)
 
       Format the exception part of the traceback.
 
@@ -561,7 +565,7 @@ the module-level functions described above.
 
       .. versionchanged:: next
          Changed *lookup_lines* default to ``False`` to avoid overhead when
-         formatting traceback with ``show_lines=False``.
+         formatting traceback with ``show_source_lines=False``.
 
    .. classmethod:: from_list(a_list)
 
@@ -570,7 +574,7 @@ the module-level functions described above.
       should be a 4-tuple with *filename*, *lineno*, *name*, *line* as the
       elements.
 
-   .. method:: format(*, show_lines=True)
+   .. method:: format(*, show_source_lines=True)
 
       Returns a list of strings ready for printing.  Each string in the
       resulting list corresponds to a single :ref:`frame <frame-objects>` from
@@ -582,29 +586,28 @@ the module-level functions described above.
       repetitions are shown, followed by a summary line stating the exact
       number of further repetitions.
 
-      If *show_lines* is true, includes source code lines in the output.
+      If *show_source_lines* is true, includes source code lines in the output.
 
       .. versionchanged:: 3.6
          Long sequences of repeated frames are now abbreviated.
 
       .. versionchanged:: next
-         Added the *show_lines* parameter.
+         Added the *show_source_lines* parameter.
 
-   .. method:: format_frame_summary(frame_summary, *, show_lines=True, **kwargs)
+   .. method:: format_frame_summary(frame_summary, *, show_source_lines=True, **kwargs)
 
       Returns a string for printing one of the :ref:`frames <frame-objects>`
       involved in the stack.
       This method is called for each :class:`FrameSummary` object to be
       printed by :meth:`StackSummary.format`. If it returns ``None``, the
       frame is omitted from the output.
 
-      The keyword argument *show_lines*, if ``True``, includes source code
-      lines in the output.
+      If *show_source_lines* is true, includes source code lines in the output.
 
       .. versionadded:: 3.11
 
       .. versionchanged:: next
-         Added the *show_lines* parameter.
+         Added the *show_source_lines* parameter.
 
 
 :class:`!FrameSummary` Objects

Doc/whatsnew/3.15.rst

@@ -305,10 +305,10 @@ tarfile
 traceback
 ----------
 
-* Add new *show_lines* and *recent_first* keyword only arguments to
+* Add new *show_source_lines* and *recent_first* keyword only arguments to
   the :mod:`traceback` functions.
 
-  The *show_lines* argument controls whether source code lines are displayed.
+  The *show_source_lines* argument controls whether source code lines are displayed.
   It is default to ``True``.
 
   The *recent_first* argument controls whether the most recent frames are