可以在jupyter单元函数上运行python doctest吗?

时间:2016-10-19 17:30:46

标签: ipython jupyter jupyter-notebook doctest

似乎有一个软件包可以启用此功能,但我在python 3.5.2或2.7.12中没有运气:

from ipython_doctester import test

@test
def my_fun():
    '''
    >>> 2 + 3
    6
    '''
    pass

TypeError: data must be a dict, got: 'ipython_doctester'

是否可以使用此软件包或其他方式从jupyter单元格运行doctest?

我也看了%doctest_mode,我发现它关闭了Doctest模式,但是无法从单元格中运行实际的doctest。

4 个答案:

答案 0 :(得分:8)

在Jupyter笔记本上试试这个:

def my_fun():
    '''
    >>> 2 + 3
    6
    '''
    pass

import doctest
doctest.testmod()

结果应为:

**********************************************************************
File "__main__", line 3, in __main__.my_fun
Failed example:
    2 + 3
Expected:
    6
Got:
    5
**********************************************************************
1 items had failures:
   1 of   1 in __main__.my_fun
***Test Failed*** 1 failures.
TestResults(failed=1, attempted=3)

(我使用的是python 2.7.12)

答案 1 :(得分:2)

我一直在关注这个页面,但是想要为单个函数运行测试。在那种情况下,https://stackoverflow.com/a/10081450/741316的答案有帮助。即:

def my_fun():
    '''
    >>> 2 + 3
    6
    '''
    pass

import doctest
doctest.run_docstring_examples(my_fun, globals())

答案 2 :(得分:1)

我用@ pelson的答案来编写这个装饰

import doctest
import copy
import functools
def test(func):
    globs = copy.copy(globals())
    globs.update({func.__name__:func})
    doctest.run_docstring_examples(func, globs, verbose=True, name=func.__name__)
    return func

查看带有doctest的要点:https://gist.github.com/2torus/f78b7cef5770927a92e3ca652f38ff89

答案 3 :(得分:0)

您可以使用nbqa在笔记本中运行doctest:

$ nbqa doctest my_notebook.ipynb
**********************************************************************
File "my_notebook.ipynb", cell_2:11, in my_notebook.add
Failed example:
    add(2, 2)
Expected:
    4
Got:
    5
**********************************************************************
1 items had failures:
1 of   2 in my_notebook.hello
***Test Failed*** 1 failures.