def test_cache_nbs(tmp_path):
db = JupyterCacheBase(str(tmp_path))
path = os.path.join(NB_PATH, "basic.ipynb")
runner = CliRunner()
result = runner.invoke(cmd_cache.cache_nbs, ["-p", tmp_path, "--no-validate", path])
assert result.exception is None, result.output
assert result.exit_code == 0, result.output
assert "basic.ipynb" in result.output.strip(), result.output
assert db.list_cache_records()[0].uri == path
def test_remove_caches(tmp_path):
db = JupyterCacheBase(str(tmp_path))
db.cache_notebook_file(
path=os.path.join(NB_PATH, "basic.ipynb"),
uri="basic.ipynb",
check_validity=False,
)
runner = CliRunner()
result = runner.invoke(cmd_cache.remove_caches, ["-p", tmp_path, "1"])
assert result.exception is None, result.output
assert result.exit_code == 0, result.output
assert "Success" in result.output.strip(), result.output
assert db.list_cache_records() == []
def test_execution(tmp_path):
from jupyter_cache.executors import load_executor
db = JupyterCacheBase(str(tmp_path))
db.stage_notebook_file(path=os.path.join(NB_PATH, "basic_unrun.ipynb"))
db.stage_notebook_file(path=os.path.join(NB_PATH, "basic_failing.ipynb"))
db.stage_notebook_file(
path=os.path.join(NB_PATH, "external_output.ipynb"),
assets=(os.path.join(NB_PATH, "basic.ipynb"), ),
)
executor = load_executor("basic", db)
result = executor.run_and_cache()
print(result)
assert result == {
"succeeded": [
os.path.join(NB_PATH, "basic_unrun.ipynb"),
os.path.join(NB_PATH, "external_output.ipynb"),
],
"excepted": [os.path.join(NB_PATH, "basic_failing.ipynb")],
"errored": [],
}
assert len(db.list_cache_records()) == 2
bundle = db.get_cache_bundle(1)
assert bundle.nb.cells[0] == {
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [{
"name": "stdout",
"output_type": "stream",
"text": "1\n"
}],
"source": "a=1\nprint(a)",
}
assert "execution_seconds" in bundle.record.data
with db.cache_artefacts_temppath(2) as path:
paths = [
str(p.relative_to(path)) for p in path.glob("**/*") if p.is_file()
]
assert paths == ["artifact.txt"]
assert path.joinpath("artifact.txt").read_text(encoding="utf8") == "hi"
stage_record = db.get_staged_record(2)
assert stage_record.traceback is not None
assert "Exception: oopsie!" in stage_record.traceback
def test_basic_workflow(tmp_path):
cache = JupyterCacheBase(str(tmp_path))
with pytest.raises(NbValidityError):
cache.cache_notebook_file(path=os.path.join(NB_PATH, "basic.ipynb"))
cache.cache_notebook_file(
path=os.path.join(NB_PATH, "basic.ipynb"),
uri="basic.ipynb",
check_validity=False,
)
assert cache.list_cache_records()[0].uri == "basic.ipynb"
pk = cache.match_cache_file(path=os.path.join(NB_PATH, "basic.ipynb")).pk
nb_bundle = cache.get_cache_bundle(pk)
assert nb_bundle.nb.metadata["kernelspec"] == {
"display_name": "Python 3",
"language": "python",
"name": "python3",
}
assert set(nb_bundle.record.to_dict().keys()) == {
"pk",
"hashkey",
"uri",
"data",
"created",
"accessed",
"description",
}
# assert cache.get_cache_codecell(pk, 0).source == "a=1\nprint(a)"
path = os.path.join(NB_PATH, "basic_failing.ipynb")
diff = cache.diff_nbfile_with_cache(pk, path, as_str=True, use_color=False)
assert diff == dedent(
f"""\
nbdiff
--- cached pk=1
+++ other: {path}
## inserted before nb/cells/0:
+ code cell:
+ source:
+ raise Exception('oopsie!')
## deleted nb/cells/0:
- code cell:
- execution_count: 2
- source:
- a=1
- print(a)
- outputs:
- output 0:
- output_type: stream
- name: stdout
- text:
- 1
"""
)
cache.remove_cache(pk)
assert cache.list_cache_records() == []
cache.cache_notebook_file(
path=os.path.join(NB_PATH, "basic.ipynb"),
uri="basic.ipynb",
check_validity=False,
)
with pytest.raises(ValueError):
cache.stage_notebook_file(os.path.join(NB_PATH, "basic.ipynb"), assets=[""])
cache.stage_notebook_file(
os.path.join(NB_PATH, "basic.ipynb"),
assets=[os.path.join(NB_PATH, "basic.ipynb")],
)
assert [r.pk for r in cache.list_staged_records()] == [1]
assert [r.pk for r in cache.list_staged_unexecuted()] == []
cache.stage_notebook_file(os.path.join(NB_PATH, "basic_failing.ipynb"))
assert [r.pk for r in cache.list_staged_records()] == [1, 2]
assert [r.pk for r in cache.list_staged_unexecuted()] == [2]
bundle = cache.get_staged_notebook(os.path.join(NB_PATH, "basic_failing.ipynb"))
assert bundle.nb.metadata
cache.clear_cache()
assert cache.list_cache_records() == []