如何在 Jupyter notebooks 中进行单元测试

一般大家都知道，在编码过程中，是肯定要编写单元测试的，这点是程序员的自觉性，当然这也是非常正确的。

但是通常，Jupyter notebooks用于数据探究，所以大家在编码时可能会选择不编写单元测试，因为当他们在Jupyter中运行时，通常会查看每个单元格的结果，然后得出结论，之后继续。

但是，Jupyter通常会发生一些情况，比如Jupyter中的代码很快就超出了数据探究的范围。或者，Jupyter本身可能会产生结果，需要定期运行。也许需要维护代码并将其与外部数据源集成。然后，确保可以测试和验证notebook中的代码就尤其重要！

在这种情况下，那我们应该如何选择对Jupyter代码来进行单元测试？

一、用多种可用于Python代码的测试框架

比如可以将其从notebook 中提取到单独的Python模块中，然后再将其重新导入notebook 中。使用通常对单元代码进行单元测试的方式来测试该代码，无论是使用unittest，pytest，doctest还是其他单元测试框架。

二、在notebook中进行测试

如果最终决定要将代码保留在Jupyter notebook中，则实际上有一些单元测试选项。在复习其中的一些内容之前，先设置一个在Jupyter notebook中可能会遇到的示例。

假设您的notebook从API中提取了一些数据，从中计算出一些结果，然后生成了一些图表和其他数据摘要，这些摘要会一直保存在其他地方。也许有一个函数可以产生正确的API URL，我们想对该函数进行单元测试。

import datetime
import dateutil

def make_url(date):
    """Return the url for our API call based on date."""

    if isinstance(date, str):
        date = dateutil.parser.parse(date).date()
    elif not isinstance(date, datetime.date):
        raise ValueError("must be a date")
    if date >= datetime.date(2020, 1, 1):
        return f"https://api.example.com/v2/{date.year}/{date.month}/{date.day}"
    else:
        return f"https://api.example.com/v1/{date:%Y-%m-%d}"

三、使用unittest进行单元测试

通常在使用unittest进行测试时，我们会将测试方法放在单独的测试模块中，或者可能将这些方法混入主模块中。然后，我们需要执行unittest.