Software: Apache/2.0.54 (Unix) mod_perl/1.99_09 Perl/v5.8.0 mod_ssl/2.0.54 OpenSSL/0.9.7l DAV/2 FrontPage/5.0.2.2635 PHP/4.4.0 mod_gzip/2.0.26.1a 

uname -a: Linux snow.he.net 4.4.276-v2-mono-1 #1 SMP Wed Jul 21 11:21:17 PDT 2021 i686 

uid=99(nobody) gid=98(nobody) groups=98(nobody) 

Safe-mode: OFF (not secure)

/opt/doc/python-2.3.4/html/Python-Docs-2.3.4/lib/   drwxr-xr-x
Free 318.34 GB of 458.09 GB (69.49%)
                            Encoder    Tools    Proc.    FTP brute    Sec.    SQL    PHP-code    Update    Feedback    Self remove    Logout    

Viewing file:     node135.html (6.14 KB)      -rw-r--r--

Python Library Reference

Previous: 5.2.1 Normal Usage Up: 5.2 doctest Next: 5.2.3 What's the Execution

---

5.2.2 Which Docstrings Are Examined?

See the docstrings in doctest.py for all the details. They're unsurprising: the module docstring, and all function, class and method docstrings are searched. Optionally, the tester can be directed to exclude docstrings attached to objects with private names. Objects imported into the module are not searched.

In addition, if M.__test__ exists and "is true", it must be a dict, and each entry maps a (string) name to a function object, class object, or string. Function and class object docstrings found from M.__test__ are searched even if the tester has been directed to skip over private names in the rest of the module. In output, a key K in M.__test__ appears with name

<name of M>.__test__.K

Any classes found are recursively searched similarly, to test docstrings in their contained methods and nested classes. While private names reached from M's globals can be optionally skipped, all names reached from M.__test__ are searched.

---

Python Library Reference

Previous: 5.2.1 Normal Usage Up: 5.2 doctest Next: 5.2.3 What's the Execution

---

Release 2.3.4, documentation updated on May 20, 2004.