@@ -143,13 +143,13 @@ Simple Usage: Checking Examples in Docstrings
143143---------------------------------------------
144144
145145The simplest way to start using doctest (but not necessarily the way you'll
146- continue to do it) is to end each module :mod: `M ` with::
146+ continue to do it) is to end each module :mod: `! M ` with::
147147
148148 if __name__ == "__main__":
149149 import doctest
150150 doctest.testmod()
151151
152- :mod: `doctest ` then examines docstrings in module :mod: `M `.
152+ :mod: `! doctest ` then examines docstrings in module :mod: `! M `.
153153
154154Running the module as a script causes the examples in the docstrings to get
155155executed and verified::
@@ -403,10 +403,10 @@ What's the Execution Context?
403403^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
404404
405405By default, each time :mod: `doctest ` finds a docstring to test, it uses a
406- *shallow copy * of :mod: `M `'s globals, so that running tests doesn't change the
407- module's real globals, and so that one test in :mod: `M ` can't leave behind
406+ *shallow copy * of :mod: `! M `'s globals, so that running tests doesn't change the
407+ module's real globals, and so that one test in :mod: `! M ` can't leave behind
408408crumbs that accidentally allow another test to work. This means examples can
409- freely use any names defined at top-level in :mod: `M `, and names defined earlier
409+ freely use any names defined at top-level in :mod: `! M `, and names defined earlier
410410in the docstring being run. Examples cannot see names defined in other
411411docstrings.
412412
@@ -958,7 +958,8 @@ and :ref:`doctest-simple-testfile`.
958958
959959 Optional argument *exclude_empty * defaults to false. If true, objects for which
960960 no doctests are found are excluded from consideration. The default is a backward
961- compatibility hack, so that code still using :meth: `doctest.master.summarize ` in
961+ compatibility hack, so that code still using
962+ :meth: `doctest.master.summarize <DocTestRunner.summarize> ` in
962963 conjunction with :func: `testmod ` continues to get output for objects with no
963964 tests. The *exclude_empty * argument to the newer :class: `DocTestFinder `
964965 constructor defaults to true.
@@ -997,7 +998,7 @@ As your collection of doctest'ed modules grows, you'll want a way to run all
997998their doctests systematically. :mod: `doctest ` provides two functions that can
998999be used to create :mod: `unittest ` test suites from modules and text files
9991000containing doctests. To integrate with :mod: `unittest ` test discovery, include
1000- a :func : `load_tests ` function in your test module::
1001+ a :ref : `load_tests < load_tests-protocol > ` function in your test module::
10011002
10021003 import unittest
10031004 import doctest
@@ -1111,19 +1112,24 @@ from text files and modules with doctests:
11111112 :func: `DocTestSuite ` returns an empty :class: `unittest.TestSuite ` if *module *
11121113 contains no docstrings instead of raising :exc: `ValueError `.
11131114
1115+ .. exception :: failureException
1116+
1117+ When doctests which have been converted to unit tests by :func: `DocFileSuite `
1118+ or :func: `DocTestSuite ` fail, this exception is raised showing the name of
1119+ the file containing the test and a (sometimes approximate) line number.
11141120
11151121Under the covers, :func: `DocTestSuite ` creates a :class: `unittest.TestSuite ` out
1116- of :class: `doctest.DocTestCase ` instances, and :class: `DocTestCase ` is a
1117- subclass of :class: `unittest.TestCase `. :class: `DocTestCase ` isn't documented
1122+ of :class: `! doctest.DocTestCase ` instances, and :class: `! DocTestCase ` is a
1123+ subclass of :class: `unittest.TestCase `. :class: `! DocTestCase ` isn't documented
11181124here (it's an internal detail), but studying its code can answer questions about
11191125the exact details of :mod: `unittest ` integration.
11201126
11211127Similarly, :func: `DocFileSuite ` creates a :class: `unittest.TestSuite ` out of
1122- :class: `doctest.DocFileCase ` instances, and :class: `DocFileCase ` is a subclass
1123- of :class: `DocTestCase `.
1128+ :class: `! doctest.DocFileCase ` instances, and :class: `! DocFileCase ` is a subclass
1129+ of :class: `! DocTestCase `.
11241130
11251131So both ways of creating a :class: `unittest.TestSuite ` run instances of
1126- :class: `DocTestCase `. This is important for a subtle reason: when you run
1132+ :class: `! DocTestCase `. This is important for a subtle reason: when you run
11271133:mod: `doctest ` functions yourself, you can control the :mod: `doctest ` options in
11281134use directly, by passing option flags to :mod: `doctest ` functions. However, if
11291135you're writing a :mod: `unittest ` framework, :mod: `unittest ` ultimately controls
@@ -1144,14 +1150,14 @@ reporting flags specific to :mod:`unittest` support, via this function:
11441150 section :ref: `doctest-options `. Only "reporting flags" can be used.
11451151
11461152 This is a module-global setting, and affects all future doctests run by module
1147- :mod: `unittest `: the :meth: `runTest ` method of :class: `DocTestCase ` looks at
1148- the option flags specified for the test case when the :class: `DocTestCase `
1153+ :mod: `unittest `: the :meth: `! runTest ` method of :class: `! DocTestCase ` looks at
1154+ the option flags specified for the test case when the :class: `! DocTestCase `
11491155 instance was constructed. If no reporting flags were specified (which is the
1150- typical and expected case), :mod: `doctest `'s :mod: `unittest ` reporting flags are
1156+ typical and expected case), :mod: `! doctest `'s :mod: `unittest ` reporting flags are
11511157 :ref: `bitwise ORed <bitwise >` into the option flags, and the option flags
11521158 so augmented are passed to the :class: `DocTestRunner ` instance created to
11531159 run the doctest. If any reporting flags were specified when the
1154- :class: `DocTestCase ` instance was constructed, :mod: `doctest `'s
1160+ :class: `! DocTestCase ` instance was constructed, :mod: `! doctest `'s
11551161 :mod: `unittest ` reporting flags are ignored.
11561162
11571163 The value of the :mod: `unittest ` reporting flags in effect before the function
@@ -1321,7 +1327,8 @@ Example Objects
13211327 A dictionary mapping from option flags to ``True `` or ``False ``, which is used
13221328 to override default options for this example. Any option flags not contained
13231329 in this dictionary are left at their default value (as specified by the
1324- :class: `DocTestRunner `'s :attr: `optionflags `). By default, no options are set.
1330+ :class: `DocTestRunner `'s :ref: `optionflags <doctest-options >`).
1331+ By default, no options are set.
13251332
13261333
13271334.. _doctest-doctestfinder :
@@ -1560,7 +1567,7 @@ DocTestRunner objects
15601567
15611568 The output of each example is checked using the :class: `DocTestRunner `'s
15621569 output checker, and the results are formatted by the
1563- :meth: `DocTestRunner.report_\* ` methods.
1570+ :meth: `! DocTestRunner.report_\* ` methods.
15641571
15651572
15661573 .. method :: summarize(verbose=None)
@@ -1735,12 +1742,12 @@ code under the debugger:
17351742 module) of the object with the doctests of interest. The result is a string,
17361743 containing the object's docstring converted to a Python script, as described for
17371744 :func: `script_from_examples ` above. For example, if module :file: `a.py `
1738- contains a top-level function :func: `f `, then ::
1745+ contains a top-level function :func: `! f `, then ::
17391746
17401747 import a, doctest
17411748 print(doctest.testsource(a, "a.f"))
17421749
1743- prints a script version of function :func: `f `'s docstring, with doctests
1750+ prints a script version of function :func: `! f `'s docstring, with doctests
17441751 converted to code, and the rest placed in comments.
17451752
17461753
0 commit comments