root / PyCon07 / material / doctest.txt

===============
doctest example
===============

You can create documents with code examples. They look like prompt extracts.
Python provides a module called `doctest` that knows how to extract code
examples out of a text file, to execute them.

For example, this piece of code::

    >>> 1 + 1
    2

Can be interpreted by `doctest`, to ensure that the result is 2.

When an example fails, `doctest` raises an assertion error, like 
a classical unit test would do::

    >>> 1 + 1
    2