from pathlib import Path
import nbformat
from click.testing import CliRunner
from cli import nbless_cli, nbuild_cli, nbexec_cli, nbconv_cli, nbraze_cli, nbdeck_cli
from tests.make_temp import make_files, make_notebook
[docs]def test_nbless_cli(tmp_path: Path) -> None:
"""Run nbless to create and execute a notebook from temporary files."""
runner = CliRunner()
with runner.isolated_filesystem():
files = make_files(tmp_path)
result = runner.invoke(nbless_cli.nbless_cli, files)
cells = nbformat.reads(result.output, as_version=4).cells
assert result.exit_code == 0
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_cli_out(tmp_path: Path) -> None:
"""Run nbless to create and execute a notebook with a custom filename."""
runner = CliRunner()
with runner.isolated_filesystem():
files = make_files(tmp_path)
args = files + ["-o", "blessed.ipynb"]
runner.invoke(nbless_cli.nbless_cli, args)
cells = nbformat.read("blessed.ipynb", as_version=4).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_nbuild_cli(tmp_path: Path) -> None:
"""Run nbuild to create a notebook file from temporary source files."""
runner = CliRunner()
with runner.isolated_filesystem():
files = make_files(tmp_path)
result = runner.invoke(nbuild_cli.nbuild_cli, files)
cells = nbformat.reads(result.output, as_version=4).cells
assert result.exit_code == 0
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_nbuild_cli_out(tmp_path: Path) -> None:
"""Run nbuild to create a notebook file with a custom filename."""
runner = CliRunner()
with runner.isolated_filesystem():
files = make_files(tmp_path)
args = files + ["-o", "built.ipynb"]
runner.invoke(nbuild_cli.nbuild_cli, args)
cells = nbformat.read("built.ipynb", as_version=4).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_cli(tmp_path: Path) -> None:
"""Run nbexec to execute a temporary notebook file."""
runner = CliRunner()
with runner.isolated_filesystem():
nb = make_notebook(tmp_path)
result = runner.invoke(nbexec_cli.nbexec_cli, nb)
cells = nbformat.reads(result.output, as_version=4).cells
for cell in cells:
if cell.cell_type == "code":
assert cell.execution_count
for output in cell.outputs:
assert output
[docs]def test_nbexec_cli_out(tmp_path: Path) -> None:
"""Run nbexec to execute a temporary notebook with a custom filename."""
runner = CliRunner()
with runner.isolated_filesystem():
nb = make_notebook(tmp_path)
runner.invoke(nbexec_cli.nbexec_cli, [nb, "-o", "exe.ipynb"])
cells = nbformat.read("exe.ipynb", as_version=4).cells
for cell in cells:
if cell.cell_type == "code":
assert cell.execution_count
for output in cell.outputs:
assert output
[docs]def test_nbconv_cli(tmp_path: Path) -> None:
"""Convert ``tempfiles`` with each exporter in ``exporters``."""
runner = CliRunner()
with runner.isolated_filesystem():
nb = make_notebook(tmp_path)
runner.invoke(nbconv_cli.nbconv_cli, [nb, "-e", "html"])
assert Path("notebook.html").read_text().startswith("<!DOCTYPE html>")
runner.invoke(nbconv_cli.nbconv_cli, [nb, "-o", "report.html"])
assert Path("report.html").read_text().startswith("<!DOCTYPE html>\n")
runner.invoke(nbconv_cli.nbconv_cli, [nb, "-o", "report.adoc"])
assert Path("report.adoc").read_text().startswith("\n[[background]]")
[docs]def test_nbraze_cli(tmp_path: Path):
"""Extract code and markdown files from the cells of an input notebook."""
runner = CliRunner()
with runner.isolated_filesystem():
runner.invoke(nbraze_cli.nbraze_cli, make_notebook(tmp_path))
assert Path("notebook_cell0.md").read_text().startswith("# Background")
assert Path("notebook_cell1.py").read_text().startswith("import numpy")
assert Path("notebook_cell2.md").read_text().startswith("# Discussion")
[docs]def test_nbdeck_cli(tmp_path: Path):
"""Print a notebook that can be viewed as or converted into slides."""
runner = CliRunner()
with runner.isolated_filesystem():
nb = make_notebook(tmp_path)
result = runner.invoke(nbdeck_cli.nbdeck_cli, nb)
cells = nbformat.reads(result.output, as_version=4).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
[docs]def test_nbdeck_cli_out(tmp_path: Path):
"""Set up a Jupyter notebook to be viewed as or converted into slides."""
runner = CliRunner()
with runner.isolated_filesystem():
nb = make_notebook(tmp_path)
runner.invoke(nbdeck_cli.nbdeck_cli, [nb, "-o", "slides.ipynb"])
cells = nbformat.read("slides.ipynb", as_version=4).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
