Tabs in output generated by the tested code are not modified. If expected output does contain aīlank line, put in your doctest example each place a blank lineĪll hard tab characters are expanded to spaces, using 8-column tab stops. Taken to signal the end of expected output. Line containing the code, and the expected output (if any) extends to the nextĮxpected output cannot contain an all-whitespace line, since such a line is no NO NO!!! >Īny expected output must immediately follow the final '> ' or '. > # comments are ignored > x = 12 > x 12 > if x = 13. Strings are treated as if they were docstrings. In addition, if M._test_ exists and “is true”, it must be a dict, and eachĮntry maps a (string) name to a function object, class object, or string.įunction and class object docstrings found from M._test_ are searched, and Objects imported into the module are not searched. The module docstring, and all function, class and method docstrings are Information about actually running doctest on these examples, see the following This is the information that you need to know to write doctest examples for Handles exceptions, and how option flags can be used to control its behavior. How it finds interactive examples, what execution context it uses, how it

This section examines in detail how doctest works: which docstrings it looks at,

It must be run with testfile(), not testmod().įor more information on testfile(), see section Basic API. If you run example.py directly from the command line, doctestīecause the file name does not end with. floor ( n ) != n : raise ValueError ( 'n must be exact integer' ) if n + 1 = n : # catch a value like 1e300 raise OverflowError ( 'n too large' ) result = 1 factor = 2 while factor <= n : result *= factor factor += 1 return result if _name_ = '_main_' : import doctest doctest. OverflowError: n too large ''' import math if not n >= 0 : raise ValueError ( 'n must be >= 0' ) if math. ValueError: n must be exact integer > factorial(30.0) 265252859812191058636308480000000 It must also not be ridiculously large: > factorial(1e100) Traceback (most recent call last). ValueError: n must be >= 0 Factorials of floats are OK, but the float must be an exact integer: > factorial(30.1) Traceback (most recent call last). For example, > factorial(5) 120 ''' def factorial ( n ): '''Return the factorial of n, an exact integer >= 0. The example module supplies one function, factorial().

Text print test page