-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
current.py
195 lines (147 loc) · 4.94 KB
/
current.py
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
import json
from xml.etree import ElementTree as ET
import re
from IPython.nbformat import v2
from IPython.nbformat import v1
from IPython.nbformat.v2 import (
NotebookNode,
new_code_cell, new_text_cell, new_notebook, new_output, new_worksheet
)
current_nbformat = 2
class NBFormatError(Exception):
pass
def parse_json(s, **kwargs):
"""Parse a string into a (nbformat, dict) tuple."""
d = json.loads(s, **kwargs)
nbformat = d.get('nbformat',1)
return nbformat, d
def parse_xml(s, **kwargs):
"""Parse a string into a (nbformat, etree) tuple."""
root = ET.fromstring(s)
nbformat_e = root.find('nbformat')
if nbformat_e is not None:
nbformat = int(nbformat_e.text)
else:
raise NBFormatError('No nbformat version found')
return nbformat, root
def parse_py(s, **kwargs):
"""Parse a string into a (nbformat, string) tuple."""
pattern = r'# <nbformat>(?P<nbformat>\d+)</nbformat>'
m = re.search(pattern,s)
if m is not None:
nbformat = int(m.group('nbformat'))
else:
raise NBFormatError('No nbformat version found')
return nbformat, s
def reads_json(s, **kwargs):
"""Read a JSON notebook from a string and return the NotebookNode object."""
nbformat, d = parse_json(s, **kwargs)
if nbformat == 1:
nb = v1.to_notebook_json(d, **kwargs)
nb = v2.convert_to_this_nbformat(nb, orig_version=1)
elif nbformat == 2:
nb = v2.to_notebook_json(d, **kwargs)
else:
raise NBFormatError('Unsupported JSON nbformat version: %i' % nbformat)
return nb
def writes_json(nb, **kwargs):
return v2.writes_json(nb, **kwargs)
def reads_xml(s, **kwargs):
"""Read an XML notebook from a string and return the NotebookNode object."""
nbformat, root = parse_xml(s, **kwargs)
if nbformat == 2:
nb = v2.to_notebook_xml(root, **kwargs)
else:
raise NBFormatError('Unsupported XML nbformat version: %i' % nbformat)
return nb
def writes_xml(nb, **kwargs):
return v2.writes_xml(nb, **kwargs)
def reads_py(s, **kwargs):
"""Read a .py notebook from a string and return the NotebookNode object."""
nbformat, s = parse_py(s, **kwargs)
if nbformat == 2:
nb = v2.to_notebook_py(s, **kwargs)
else:
raise NBFormatError('Unsupported PY nbformat version: %i' % nbformat)
return nb
def writes_py(nb, **kwargs):
return v2.writes_py(nb, **kwargs)
# High level API
def reads(s, format, **kwargs):
"""Read a notebook from a string and return the NotebookNode object.
This function properly handles notebooks of any version. The notebook
returned will always be in the current version's format.
Parameters
----------
s : str
The raw string to read the notebook from.
format : ('xml','json','py')
The format that the string is in.
Returns
-------
nb : NotebookNode
The notebook that was read.
"""
if format == 'xml':
return reads_xml(s, **kwargs)
elif format == 'json':
return reads_json(s, **kwargs)
elif format == 'py':
return reads_py(s, **kwargs)
else:
raise NBFormatError('Unsupported format: %s' % format)
def writes(nb, format, **kwargs):
"""Write a notebook to a string in a given format in the current nbformat version.
This function always writes the notebook in the current nbformat version.
Parameters
----------
nb : NotebookNode
The notebook to write.
format : ('xml','json','py')
The format to write the notebook in.
Returns
-------
s : str
The notebook string.
"""
if format == 'xml':
return writes_xml(nb, **kwargs)
elif format == 'json':
return writes_json(nb, **kwargs)
elif format == 'py':
return writes_py(nb, **kwargs)
else:
raise NBFormatError('Unsupported format: %s' % format)
def read(fp, format, **kwargs):
"""Read a notebook from a file and return the NotebookNode object.
This function properly handles notebooks of any version. The notebook
returned will always be in the current version's format.
Parameters
----------
fp : file
Any file-like object with a read method.
format : ('xml','json','py')
The format that the string is in.
Returns
-------
nb : NotebookNode
The notebook that was read.
"""
return reads(fp.read(), format, **kwargs)
def write(nb, fp, format, **kwargs):
"""Write a notebook to a file in a given format in the current nbformat version.
This function always writes the notebook in the current nbformat version.
Parameters
----------
nb : NotebookNode
The notebook to write.
fp : file
Any file-like object with a write method.
format : ('xml','json','py')
The format to write the notebook in.
Returns
-------
s : str
The notebook string.
"""
return fp.write(writes(nb, format, **kwargs))