Python: using doctests for classes

Question

Is it possible to use Python's doctest concept for classes, not just functions?

If so, where shall I put the doctests - at the class' docstring, or at the constructor's docstring?

To clarify, I'm looking for something like:

class Test:     """     >>> a=Test(5)     >>> a.multiply_by_2()     10     """     def __init__(self, number):         self._number=number      def multiply_by_2(self):         return self._number*2 

Thanks in advance,

Adam

Answer 1

Instead of instantiating the object in every method, you can use the extraglobs argument:

class Test:     def multiply_by_2(self):         """         >>> t.multiply_by_2()         10         """         return self._number*2  if __name__ == '__main__':     import doctest     doctest.testmod(extraglobs={'t': Test()})