1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
"""Test the APIs at the top-level of nbformat"""
# Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
from __future__ import annotations
import json
import os
import pathlib
from tempfile import TemporaryDirectory
from typing import Any
from jsonschema import ValidationError
from nbformat import __version__ as nbf_version
from nbformat import current_nbformat, read, write, writes
from nbformat.reader import get_version
from nbformat.validator import isvalid
from .base import TestsBase
class TestAPI(TestsBase):
def test_read(self):
"""Can older notebooks be opened and automatically converted to the current
nbformat?"""
# Open a version 2 notebook.
with self.fopen("test2.ipynb", "r") as f:
nb = read(f, as_version=current_nbformat)
# Check that the notebook was upgraded to the latest version automatically.
(major, minor) = get_version(nb)
self.assertEqual(major, current_nbformat)
def test_write_downgrade_2(self):
"""downgrade a v3 notebook to v2"""
# Open a version 3 notebook.
with self.fopen("test3.ipynb", "r") as f:
nb = read(f, as_version=3)
jsons = writes(nb, version=2)
nb2 = json.loads(jsons)
(major, minor) = get_version(nb2)
self.assertEqual(major, 2)
def test_read_write_path(self):
"""read() and write() take filesystem paths"""
path = os.path.join(self._get_files_path(), "test4.ipynb")
nb = read(path, as_version=4)
with TemporaryDirectory() as td:
dest = os.path.join(td, "echidna.ipynb")
write(nb, dest)
assert os.path.isfile(dest)
def test_read_write_pathlib_object(self):
"""read() and write() take path-like objects such as pathlib objects"""
path = pathlib.Path(self._get_files_path()) / "test4.ipynb"
nb = read(path, as_version=4)
with TemporaryDirectory() as td:
dest = pathlib.Path(td) / "echidna.ipynb"
write(nb, dest)
assert os.path.isfile(dest)
def test_capture_validation_error(self):
"""Test that validation error can be captured on read() and write()"""
validation_error: dict[str, Any] = {}
path = os.path.join(self._get_files_path(), "invalid.ipynb")
nb = read(path, as_version=4, capture_validation_error=validation_error)
assert not isvalid(nb)
assert "ValidationError" in validation_error
assert isinstance(validation_error["ValidationError"], ValidationError)
validation_error = {}
with TemporaryDirectory() as td:
dest = os.path.join(td, "invalid.ipynb")
write(nb, dest, capture_validation_error=validation_error)
assert os.path.isfile(dest)
assert "ValidationError" in validation_error
assert isinstance(validation_error["ValidationError"], ValidationError)
# Repeat with a valid notebook file
validation_error = {}
path = os.path.join(self._get_files_path(), "test4.ipynb")
nb = read(path, as_version=4, capture_validation_error=validation_error)
assert isvalid(nb)
assert "ValidationError" not in validation_error
validation_error = {}
with TemporaryDirectory() as td:
dest = os.path.join(td, "test4.ipynb")
write(nb, dest, capture_validation_error=validation_error)
assert os.path.isfile(dest)
assert "ValidationError" not in validation_error
|
