跳转到主要内容

Jupyter Notebooks的单元测试框架

项目描述

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

testbook

警告:这是旧包名nteract-testbook -- 请今后安装testbook,因为这个旧包名不再发布新版本。

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

以前的笔记本单元测试尝试涉及在笔记本本身中编写测试。然而,testbook将允许在单独的测试文件中对笔记本进行单元测试,从而将.ipynb文件视为.py文件。

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

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

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

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

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

import testbook



@testbook.testbook('/path/to/notebook.ipynb', execute=True)
def test_notebook(tb):
   sum = tb.ref("sum")

   assert sum(1, 2) == 3

安装testbook

pip install nteract-testbook

文档

有关更详细的说明,请参阅readthedocs

开发指南

阅读CONTRIBUTING.md以了解如何设置本地开发环境并将代码更改回testbook的说明。

项目详情


下载文件

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

源分布

此版本没有可用的源分布文件。请参阅生成分布存档的教程。

构建分布

nteract_testbook-0.1.3-py3-none-any.whl (9.8 kB 查看哈希值)

上传时间 Python 3

由以下提供支持