run_notebook.py

import fnmatch
import os
import subprocess
import tempfile

import nbformat


def _notebook_run(path):
    """
        Execute a notebook via nbconvert and collect output.
       :returns (parsed nb object, execution errors)
    """
    dirname, __ = os.path.split(path)
    os.chdir(dirname)
    with tempfile.NamedTemporaryFile(suffix=".ipynb") as fout:
        args = [
            "jupyter", "nbconvert", "--to", "notebook", "--execute",
            "--ExecutePreprocessor.timeout=60",
            "--output", fout.name, path]
        subprocess.check_call(args)

        fout.seek(0)
        nb = nbformat.read(fout.name, nbformat.current_nbformat)

    errors = [
        output for cell in nb.cells if "outputs" in cell
        for output in cell["outputs"] if output.output_type == "error"]

    return nb, errors


def run_ipynb():
    src = os.getcwd()
    for root, dirnames, filenames in os.walk(src):
        # Do not run notebooks in ipynb_checkpoints
        if root.endswith(".ipynb_checkpoints"):
            continue
        for filename in fnmatch.filter(filenames, '*.ipynb'):
            path = os.path.join(root, filename)
            print("Detected ipython notebook {} to run tests on".format(path))
            nb, errors = _notebook_run(path)
            print("Percentage of errored cells is {}".format(100 * (len(errors) / len(nb.cells))))
            assert errors == []


if __name__ == '__main__':
    # Runs all cells in all the ipython notebooks in the current directory
    run_ipynb()