跳转到主要内容

Jupyter Notebooks的单元测试框架

项目描述

Build Status image Documentation Status PyPI Python 3.6 Python 3.7 Python 3.8 Code style: black

testbook

testbook 是Jupyter Notebooks中测试代码的单元测试框架扩展。

之前的单元测试notebook尝试涉及在notebook本身中编写测试。然而,testbook允许对单独的测试文件中的notebooks运行单元测试,因此将 .ipynb 文件视为 .py 文件。

testbook帮助您为Jupyter Notebooks设置 常规单元测试

以下是一个使用testbook编写的单元测试示例

考虑以下Jupyter Notebook中的代码单元

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

您可以使用 testbook 在Python文件中编写单元测试,如下所示

from testbook import testbook


@testbook('/path/to/notebook.ipynb', execute=True)
def test_func(tb):
   func = tb.get("func")

   assert func(1, 2) == 3

安装 testbook

pip install testbook

注意:这不会为运行您的笔记本安装任何内核。您需要以正常运行笔记本的方式安装。通常,这是通过 pip install ipykernel 完成的

或者,如果您想安装所有相同的开发依赖项和ipython内核,可以使用以下命令安装这些依赖项

pip install testbook[dev]

文档

有关更详细的信息,请参阅readthedocs

开发指南

阅读CONTRIBUTING.md,了解如何设置本地开发环境并将代码更改提交到testbook。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

此版本没有提供源代码分发文件。请参阅生成分发存档的教程

构建分发

testbook-0.4.2-py3-none-any.whl (11.8 kB 查看哈希值)

上传时间 Python 3

由以下组织支持