Jupyter 笔记本中的函数单元测试？

我有一个 Jupyter 笔记本，我打算反复运行。里面有函数，代码结构是这样的：

def construct_url(data):
    ...
    return url

def scrape_url(url):
    ... # fetch url, extract data
    return parsed_data

for i in mylist: 
    url = construct_url(i)
    data = scrape_url(url)
    ... # use the data to do analysis

我想编写测试construct_url and scrape_url。做到这一点最明智的方法是什么？

我考虑过的一些方法：

• 将函数移出到实用程序文件中，并在某个标准 Python 测试库中为该实用程序文件编写测试。可能是最好的选择，尽管这意味着并非所有代码在笔记本中都可见。
• 使用测试数据在笔记本本身内写入断言（向笔记本添加噪音）。
• 使用专门的 Jupyter 测试来测试单元格的内容（不要认为这有效，因为单元格的内容会发生变化）。

Python标准测试工具，例如doctest https://docs.python.org/3.6/library/doctest.html and unittest https://docs.python.org/3.6/library/unittest.html，可以直接在笔记本上使用。

Doctest

一个笔记本单元，在文档字符串中包含一个函数和一个测试用例：

def add(a, b):
    '''
    This is a test:
    >>> add(2, 2)
    5
    '''
    return a + b

运行文档字符串中所有测试用例的笔记本单元（笔记本中的最后一个单元）：

import doctest
doctest.testmod(verbose=True)

Output:

Trying:
    add(2, 2)
Expecting:
    5
**********************************************************************
File "__main__", line 4, in __main__.add
Failed example:
    add(2, 2)
Expected:
    5
Got:
    4
1 items had no tests:
    __main__
**********************************************************************
1 items had failures:
   1 of   1 in __main__.add
1 tests in 2 items.
0 passed and 1 failed.
***Test Failed*** 1 failures.

Unittest

一个笔记本单元具有以下功能：

def add(a, b):
    return a + b

包含测试用例的笔记本单元（笔记本中的最后一个单元）。执行单元时，单元中的最后一行运行测试用例：

import unittest

class TestNotebook(unittest.TestCase):
    
    def test_add(self):
        self.assertEqual(add(2, 2), 5)
        

unittest.main(argv=[''], verbosity=2, exit=False)

Output:

test_add (__main__.TestNotebook) ... FAIL

======================================================================
FAIL: test_add (__main__.TestNotebook)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "<ipython-input-15-4409ad9ffaea>", line 6, in test_add
    self.assertEqual(add(2, 2), 5)
AssertionError: 4 != 5

----------------------------------------------------------------------
Ran 1 test in 0.001s

FAILED (failures=1)

调试失败的测试

在调试失败的测试时，在某个时刻停止测试用例执行并运行调试器通常很有用。为此，请在要停止执行的行之前插入以下代码：

import pdb; pdb.set_trace()

例如：

def add(a, b):
    '''
    This is the test:
    >>> add(2, 2)
    5
    '''
    import pdb; pdb.set_trace()
    return a + b

对于此示例，下次运行 doctest 时，执行将在 return 语句和Python调试器 https://docs.python.org/3/library/pdb.html(pdb) 将启动。您将直接在笔记本中获得 pdb 提示符，这将允许您检查以下值a and b、跨过线等。

注意：从 Python 3.7 开始，内置breakpoint() https://docs.python.org/3.7/library/functions.html#breakpoint可以用来代替import pdb; pdb.set_trace().

I created a Jupyter notebook for experimenting https://gist.github.com/SergiyKolesnikov/f94d91b947051ab5d2ba1aa30e25f050#file-test_and_debug-ipynb with the techniques I have just described. You can try it out with