Source code for tests.test_nbless

from pathlib import Path

import nbformat
import pytest
from tests.make_temp import make_files, make_notebook, exec_notebook

from nbless import nbless, nbuild, nbexec, nbconv, nbraze, nbdeck


[docs]def test_nbuild_one_cell(tmp_path: Path) -> None:
    """Run ``nbuild`` to create 3 temporary notebook files from 3 tempfiles."""
    for tempfile in make_files(tmp_path):
        assert nbuild([tempfile]).cells[0].source == Path(tempfile).read_text()


[docs]def test_nbless_one_cell(tmp_path: Path) -> None:
    """Run ``nbless`` to create and execute three notebook files."""
    for tempfile in make_files(tmp_path):
        assert nbless([tempfile]).cells[0].source == Path(tempfile).read_text()


[docs]def test_nbuild_three_cells(tmp_path: Path) -> None:
    """Run ``nbuild`` to create a temporary notebook file from 3 tempfiles."""
    files = make_files(tmp_path)
    cells = nbuild(files).cells
    assert [c.cell_type for c in cells] == ["markdown", "code", "markdown"]
    for cell, tempfile in zip(cells, files):
        assert cell.source == Path(tempfile).read_text()


[docs]def test_nbless_three_cells(tmp_path: Path) -> None:
    """Run ``nbless`` to create and execute a 3-cell notebook file."""
    files = make_files(tmp_path)
    cells = nbless(files).cells
    assert [c.cell_type for c in cells] == ["markdown", "code", "markdown"]
    for cell, tempfile in zip(cells, files):
        assert cell.source == Path(tempfile).read_text()


[docs]def test_nbexec(tmp_path: Path) -> None:
    """Run ``nbexec`` to execute a temporary notebook file."""
    for cell in nbexec(make_notebook(tmp_path)).cells:
        if cell.cell_type == "code":
            assert cell.execution_count
            for output in cell.outputs:
                assert output


[docs]@pytest.mark.parametrize("not_exporters", ["htm", "ipython", "markup"])
def test_raises(not_exporters, tmp_path: Path) -> None:
    """Make sure a ``ValueError`` is raised if ``nbconv`` gets a bad exporter."""
    nb = make_notebook(tmp_path)
    with pytest.raises(ValueError):
        nbconv(in_file=nb, exporter=not_exporters)
        nbconv(in_file=nb, out_file="out." + not_exporters)


[docs]@pytest.mark.parametrize("exporters", ["html", "asciidoc", "rst"])
def test_nbconv(exporters, tmp_path: Path) -> None:
    """Convert a temporary notebook with each exporter in ``exporters``."""
    nb = make_notebook(tmp_path)
    assert nbconv(in_file=nb, exporter=exporters)[0].endswith("." + exporters)
    assert nbconv(in_file=nb)[0].endswith(".html")


[docs]def test_nbconv_file_contents(tmp_path: Path):
    """Run ``nbconv`` with the ``exporter`` or ``out_file`` argument."""
    nb = make_notebook(tmp_path)
    assert nbconv(in_file=nb, exporter="html")[1].startswith("<!DOCTYPE html>")
    assert nbconv(in_file=nb, out_file="o.html")[1].startswith("<!DOCTYPE html")
    assert nbconv(in_file=nb, out_file="o.___")[1].startswith("<!DOCTYPE html>")
    assert nbconv(in_file=nb, out_file="o.asc")[1].startswith("\n[[background]")
    assert nbconv(in_file=nb, exporter="rst")[1].startswith("\nBackground\n")
    assert nbconv(in_file=nb, out_file="o.rst")[1].startswith("\nBackground\n")


[docs]def test_nbraze(tmp_path: Path):
    """Extract code and markdown files from the cells of an input notebook."""
    fdict = nbraze(make_notebook(tmp_path))
    assert [Path(f).suffix for f in fdict] == [".md", ".py", ".md"]
    assert fdict["notebook_cell0.md"].startswith("# Background\nMatplotlib")
    assert fdict["notebook_cell1.py"].startswith("import numpy as np\n")
    assert fdict["notebook_cell2.md"].startswith("# Discussion\nMatplotlib")


[docs]def test_language_info(tmp_path: Path):
    """Infer the code file extension from ``metadata.language_info``."""
    nb = exec_notebook(tmp_path)
    nbnode = nbformat.read(nb, as_version=4)
    assert nbnode.metadata.language_info.name == "python"
    fdict = nbraze(nb)
    assert [Path(f).suffix for f in fdict] == [".md", ".py", ".md"]
    assert fdict["notebook_cell0.md"].startswith("# Background\nMatplotlib")
    assert fdict["notebook_cell1.py"].startswith("import numpy as np\n")
    assert fdict["notebook_cell2.md"].startswith("# Discussion\nMatplotlib")


[docs]def test_nbdeck(tmp_path: Path):
    """ Set up a Jupyter notebook to be viewed as or converted into slides."""
    cells = nbdeck(make_notebook(tmp_path)).cells
    c = 0
    for cell in cells:
        if cell.cell_type == "markdown" and cell.source.startswith("#"):
            c += 1
            assert cell.metadata.slideshow == {"slide_type": "slide"}
    assert c == 2
    assert len(cells) == 3
Source code for tests.test_nbless

Nbless

Navigation

Related Topics
