Installation and Getting Started¶
testbook
is a unit testing framework for testing code in Jupyter Notebooks.
Installing testbook
¶
pip install testbook
Create your first test¶
Consider the following code cell in a Jupyter Notebook,
def foo(x):
return x + 1
Here is the unit test for it which must be written in a Python module (.py
file).
from testbook import testbook
@testbook('/path/to/notebook.ipynb', execute=True)
def test_foo(tb):
foo = tb.ref("foo")
assert foo(2) == 3
That’s it! You can now execute the test.
General workflow when using testbook to write a unit test¶
Use
testbook.testbook
as a decorator or context manager to specify the path to the Jupyter Notebook. Passingexecute=True
will execute all the cells, and passingexecute=['cell-tag-1', 'cell-tag-2']
will only execute specific cells identified by cell tags.Obtain references to objects under test using the
.ref
method.Write the test!