traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make sys.xxx variable references into links, note that print_last only 

works when an exception gets to the interactive prompt, and update the
examples after testing.  The last one is now a valid Sphinx doctest,
but of the preceding two one can't be made a doctest and the other one
I'm postponing to 3.x because sphinx handles doctests as Unicode strings
and that makes the 2.x output confusing.
This commit is contained in:
R. David Murray 2009-04-27 17:22:36 +00:00
parent 2622b549d7
commit ec047e0725
1 changed files with 22 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
Doc/library/traceback.rst
View File

@ -14,7 +14,7 @@ interpreter.
.. index:: object: traceback .. index:: object: traceback
The module uses traceback objects --- this is the object type that is stored in The module uses traceback objects --- this is the object type that is stored in
the variables ``sys.exc_traceback`` (deprecated) and ``sys.last_traceback`` and the variables :data:`sys.exc_traceback` (deprecated) and :data:`sys.last_traceback` and
returned as the third item from :func:`sys.exc_info`. returned as the third item from :func:`sys.exc_info`.
The module defines the following functions: The module defines the following functions:
@ -58,7 +58,8 @@ The module defines the following functions:
.. function:: print_last([limit[, file]]) .. function:: print_last([limit[, file]])
This is a shorthand for ``print_exception(sys.last_type, sys.last_value, This is a shorthand for ``print_exception(sys.last_type, sys.last_value,
sys.last_traceback, limit, file)``. sys.last_traceback, limit, file)``. In general it will work only after
an exception has reached an interactive prompt (see :data:`sys.last_type`).
.. function:: print_stack([f[, limit[, file]]]) .. function:: print_stack([f[, limit[, file]]])
@ -195,27 +196,25 @@ exception and traceback::
print "*** format_tb:" print "*** format_tb:"
print repr(traceback.format_tb(exceptionTraceback)) print repr(traceback.format_tb(exceptionTraceback))
print "*** tb_lineno:", traceback.tb_lineno(exceptionTraceback) print "*** tb_lineno:", traceback.tb_lineno(exceptionTraceback)
print "*** print_last:"
traceback.print_last()
The output for the example would look similar to this:: The output for the example would look similar to this::
*** print_tb: *** print_tb:
File "<doctest>", line 9, in <module> File "<doctest...>", line 10, in <module>
lumberjack() lumberjack()
*** print_exception: *** print_exception:
Traceback (most recent call last): Traceback (most recent call last):
File "<doctest>", line 9, in <module> File "<doctest...>", line 10, in <module>
lumberjack() lumberjack()
File "<doctest>", line 3, in lumberjack File "<doctest...>", line 4, in lumberjack
bright_side_of_death() bright_side_of_death()
IndexError: tuple index out of range IndexError: tuple index out of range
*** print_exc: *** print_exc:
Traceback (most recent call last): Traceback (most recent call last):
File "<doctest>", line 9, in <module> File "<doctest...>", line 10, in <module>
lumberjack() lumberjack()
File "<doctest>", line 3, in lumberjack File "<doctest...>", line 4, in lumberjack
bright_side_of_death() bright_side_of_death()
IndexError: tuple index out of range IndexError: tuple index out of range
*** format_exc, first and last line: *** format_exc, first and last line:
@ -223,27 +222,19 @@ The output for the example would look similar to this::
IndexError: tuple index out of range IndexError: tuple index out of range
*** format_exception: *** format_exception:
['Traceback (most recent call last):\n', ['Traceback (most recent call last):\n',
' File "<doctest>", line 9, in <module>\n lumberjack()\n', ' File "<doctest...>", line 10, in <module>\n lumberjack()\n',
' File "<doctest>", line 3, in lumberjack\n bright_side_of_death()\n', ' File "<doctest...>", line 4, in lumberjack\n bright_side_of_death()\n',
' File "<doctest>", line 6, in bright_side_of_death\n return tuple()[0]\n', ' File "<doctest...>", line 7, in bright_side_of_death\n return tuple()[0]\n',
'IndexError: tuple index out of range\n'] 'IndexError: tuple index out of range\n']
*** extract_tb: *** extract_tb:
[('<doctest>', 9, '<module>', 'lumberjack()'), [('<doctest...>', 10, '<module>', 'lumberjack()'),
('<doctest>', 3, 'lumberjack', 'bright_side_of_death()'), ('<doctest...>', 4, 'lumberjack', 'bright_side_of_death()'),
('<doctest>', 6, 'bright_side_of_death', 'return tuple()[0]')] (u'<doctest...>', 7, 'bright_side_of_death', 'return tuple()[0]')]
*** format_tb: *** format_tb:
[' File "<doctest>", line 9, in <module>\n lumberjack()\n', [' File "<doctest...>", line 10, in <module>\n lumberjack()\n',
' File "<doctest>", line 3, in lumberjack\n bright_side_of_death()\n', ' File "<doctest...>", line 4, in lumberjack\n bright_side_of_death()\n',
' File "<doctest>", line 6, in bright_side_of_death\n return tuple()[0]\n'] ' File "<doctest...>", line 7, in bright_side_of_death\n return tuple()[0]\n']
*** tb_lineno: 2 *** tb_lineno: 10
*** print_last:
Traceback (most recent call last):
File "<doctest>", line 9, in <module>
lumberjack()
File "<doctest>", line 3, in lumberjack
bright_side_of_death()
IndexError: tuple index out of range
The following example shows the different ways to print and format the stack:: The following example shows the different ways to print and format the stack::
@ -271,7 +262,10 @@ The following example shows the different ways to print and format the stack::
' File "<doctest>", line 8, in lumberstack\n print repr(traceback.format_stack())\n'] ' File "<doctest>", line 8, in lumberstack\n print repr(traceback.format_stack())\n']
This last example demonstrates the final few formatting functions:: This last example demonstrates the final few formatting functions:
.. doctest::
:options: +NORMALIZE_WHITESPACE
>>> import traceback >>> import traceback
>>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'), >>> traceback.format_list([('spam.py', 3, '<module>', 'spam.eggs()'),