
Development Tools
*****************

The modules described in this chapter help you write software.  For
example, the ``pydoc`` module takes a module and generates
documentation based on the module's contents.  The ``doctest`` and
``unittest`` modules contains frameworks for writing unit tests that
automatically exercise code and verify that the expected output is
produced.  **2to3** can translate Python 2.x source code into valid
Python 3.x code.

The list of modules described in this chapter is:

* ``pydoc`` --- Documentation generator and online help system
* ``doctest`` --- Test interactive Python examples
  * Simple Usage: Checking Examples in Docstrings
  * Simple Usage: Checking Examples in a Text File
  * How It Works
    * Which Docstrings Are Examined?
    * How are Docstring Examples Recognized?
    * What's the Execution Context?
    * What About Exceptions?
    * Option Flags and Directives
    * Warnings
  * Basic API
  * Unittest API
  * Advanced API
    * DocTest Objects
    * Example Objects
    * DocTestFinder objects
    * DocTestParser objects
    * DocTestRunner objects
    * OutputChecker objects
  * Debugging
  * Soapbox
* ``unittest`` --- Unit testing framework
  * Basic example
  * Organizing test code
  * Re-using old test code
  * Classes and functions
  * TestCase Objects
  * TestSuite Objects
  * TestResult Objects
  * TestLoader Objects
* 2to3 - Automated Python 2 to 3 code translation
  * Using 2to3
  * ``lib2to3`` - 2to3's library
* ``test`` --- Regression tests package for Python
  * Writing Unit Tests for the ``test`` package
  * Running tests using ``test.regrtest``
* ``test.support`` --- Utility functions for tests