Skip to content

Commit

Permalink
bpo-29660: traceback: Document that etype is ignored in some places. (G…
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau authored and Mariatta committed Jun 1, 2017
1 parent c9ccace commit cdb89cd
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions Doc/library/traceback.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,19 @@ The module defines the following functions:
* if *tb* is not ``None``, it prints a header ``Traceback (most recent
call last):``
* it prints the exception *etype* and *value* after the stack trace
* if *etype* is :exc:`SyntaxError` and *value* has the appropriate format, it
prints the line where the syntax error occurred with a caret indicating the
approximate position of the error.
* if *type(value)* is :exc:`SyntaxError` and *value* has the appropriate
format, it prints the line where the syntax error occurred with a caret
indicating the approximate position of the error.

The optional *limit* argument has the same meaning as for :func:`print_tb`.
If *chain* is true (the default), then chained exceptions (the
:attr:`__cause__` or :attr:`__context__` attributes of the exception) will be
printed as well, like the interpreter itself does when printing an unhandled
exception.

.. versionchanged:: 3.5
The *etype* argument is ignored and inferred from the type of *value*.


.. function:: print_exc(limit=None, file=None, chain=True)

Expand Down Expand Up @@ -131,6 +134,9 @@ The module defines the following functions:
containing internal newlines. When these lines are concatenated and printed,
exactly the same text is printed as does :func:`print_exception`.

.. versionchanged:: 3.5
The *etype* argument is ignored and inferred from the type of *value*.


.. function:: format_exc(limit=None, chain=True)

Expand Down Expand Up @@ -372,6 +378,7 @@ exception and traceback:
print("*** print_tb:")
traceback.print_tb(exc_traceback, limit=1, file=sys.stdout)
print("*** print_exception:")
# exc_type below is ignored on 3.5 and later
traceback.print_exception(exc_type, exc_value, exc_traceback,
limit=2, file=sys.stdout)
print("*** print_exc:")
Expand All @@ -381,6 +388,7 @@ exception and traceback:
print(formatted_lines[0])
print(formatted_lines[-1])
print("*** format_exception:")
# exc_type below is ignored on 3.5 and later
print(repr(traceback.format_exception(exc_type, exc_value,
exc_traceback)))
print("*** extract_tb:")
Expand Down

0 comments on commit cdb89cd

Please sign in to comment.