PyDocs

Nav

Development Tools

DocTestSuite

doctest

function (source)
  • DocTestSuite(module=None, globs=None, extraglobs=None, test_finder=None, setUp=None, tearDown=None, optionflags=0, checker=None)
Convert doctest tests for a module to a unittest test suite.

This converts each documentation string in a module that
contains doctest tests to a unittest test case.  If any of the
tests in a doc string fail, then the test case fails.  An exception
is raised showing the name of the file containing the test and a
(sometimes approximate) line number.

The `module` argument provides the module to be tested.  The argument
can be either a module or a module name.

If no argument is given, the calling module is used.

A number of options may be provided as keyword arguments:

setUp
  A set-up function.  This is called before running the
  tests in each file. The setUp function will be passed a DocTest
  object.  The setUp function can access the test globals as the
  globs attribute of the test passed.

tearDown
  A tear-down function.  This is called after running the
  tests in each file.  The tearDown function will be passed a DocTest
  object.  The tearDown function can access the test globals as the
  globs attribute of the test passed.

globs
  A dictionary containing initial global variables for the tests.

optionflags
   A set of doctest option flags expressed as an integer.
Changed in 3.5, 3.15
  • 3.5: DocTestSuite() returns an empty unittest.TestSuite if module contains no docstrings instead of raising ValueError.
  • 3.15: Run each example as a subtest.
0 Examples
No examples for doctest/DocTestSuite.
See Also
No see-alsos for doctest/DocTestSuite
0 Notes
No notes for DocTestSuite