https://github.com/tkf/ipython-doctestmagic

Run and debug doctest in IPython
https://github.com/tkf/ipython-doctestmagic

Last synced: 9 months ago
JSON representation

Run and debug doctest in IPython

• Host: GitHub
• URL: https://github.com/tkf/ipython-doctestmagic
• Owner: tkf
• Created: 2012-10-05T19:22:09.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2018-10-13T05:41:32.000Z (about 7 years ago)
• Last Synced: 2025-04-15T08:20:08.507Z (9 months ago)
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 6
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README

Awesome Lists containing this project

README

          
%doctest [-n NAME] [-v] [-x] object [object ...]

Run doctest of given objects.

Example::

  %doctest some_object other_object  # run doctest for several objects

  %doctest -v some_object            # verbose ouput

  %doctest -x some_object            # debug doctest

Use the cell magic version of this magic command (``%%doctest``)

to write doctest directly in IPython shell.

positional arguments:

  object                Doctest is ran against docstrings of this object.

optional arguments:

  -n NAME, --name NAME           See :func:`doctest.run_docstring_examples`.

  -f, --file                     The object to be tested is a (path to a) file

  -o OPTION, --options OPTION    Pass on options to doctest

  -v, --verbose                  See :func:`doctest.run_docstring_examples`.

  -x, --stop                     Stop testing after the first error or failure.

                                 When this option is used, the error is stored

                                 in IPython shell so that you can debug it by

                                 turning on pdb flag before doctest (see

                                 ``%pdb``) or use ``%debug`` magic command

                                 afterward.