Show More
@@ -1,253 +1,253 b'' | |||
|
1 | 1 | """Code for converting notebooks to and from v3.""" |
|
2 | 2 | |
|
3 | 3 | # Copyright (c) IPython Development Team. |
|
4 | 4 | # Distributed under the terms of the Modified BSD License. |
|
5 | 5 | |
|
6 | 6 | import json |
|
7 | 7 | import re |
|
8 | 8 | |
|
9 | 9 | from .nbbase import ( |
|
10 | 10 | nbformat, nbformat_minor, |
|
11 | 11 | NotebookNode, |
|
12 | 12 | ) |
|
13 | 13 | |
|
14 | 14 | from IPython.nbformat import v3 |
|
15 | 15 | from IPython.utils.log import get_logger |
|
16 | 16 | |
|
17 | 17 | def _warn_if_invalid(nb, version): |
|
18 | 18 | """Log validation errors, if there are any.""" |
|
19 | 19 | from IPython.nbformat import validate, ValidationError |
|
20 | 20 | try: |
|
21 | 21 | validate(nb, version=version) |
|
22 | 22 | except ValidationError as e: |
|
23 | 23 | get_logger().error("Notebook JSON is not valid v%i: %s", version, e) |
|
24 | 24 | |
|
25 | 25 | def upgrade(nb, from_version=3, from_minor=0): |
|
26 | 26 | """Convert a notebook to v4. |
|
27 | 27 | |
|
28 | 28 | Parameters |
|
29 | 29 | ---------- |
|
30 | 30 | nb : NotebookNode |
|
31 | 31 | The Python representation of the notebook to convert. |
|
32 | 32 | from_version : int |
|
33 | 33 | The original version of the notebook to convert. |
|
34 | 34 | from_minor : int |
|
35 | 35 | The original minor version of the notebook to convert (only relevant for v >= 3). |
|
36 | 36 | """ |
|
37 | 37 | if from_version == 3: |
|
38 | 38 | # Validate the notebook before conversion |
|
39 | 39 | _warn_if_invalid(nb, from_version) |
|
40 | 40 | |
|
41 | 41 | # Mark the original nbformat so consumers know it has been converted |
|
42 | 42 | orig_nbformat = nb.pop('orig_nbformat', None) |
|
43 | 43 | nb.metadata.orig_nbformat = orig_nbformat or 3 |
|
44 | 44 | |
|
45 | 45 | # Mark the new format |
|
46 | 46 | nb.nbformat = nbformat |
|
47 | 47 | nb.nbformat_minor = nbformat_minor |
|
48 | 48 | |
|
49 | 49 | # remove worksheet(s) |
|
50 | 50 | nb['cells'] = cells = [] |
|
51 | 51 | # In the unlikely event of multiple worksheets, |
|
52 | 52 | # they will be flattened |
|
53 | 53 | for ws in nb.pop('worksheets', []): |
|
54 | 54 | # upgrade each cell |
|
55 | 55 | for cell in ws['cells']: |
|
56 | 56 | cells.append(upgrade_cell(cell)) |
|
57 | 57 | # upgrade metadata |
|
58 | 58 | nb.metadata.pop('name', '') |
|
59 | 59 | nb.metadata.pop('signature', '') |
|
60 | 60 | # Validate the converted notebook before returning it |
|
61 | 61 | _warn_if_invalid(nb, nbformat) |
|
62 | 62 | return nb |
|
63 | 63 | elif from_version == 4: |
|
64 | 64 | # nothing to do |
|
65 | 65 | if from_minor != nbformat_minor: |
|
66 | 66 | nb.metadata.orig_nbformat_minor = from_minor |
|
67 | 67 | nb.nbformat_minor = nbformat_minor |
|
68 | 68 | |
|
69 | 69 | return nb |
|
70 | 70 | else: |
|
71 | 71 | raise ValueError('Cannot convert a notebook directly from v%s to v4. ' \ |
|
72 | 72 | 'Try using the IPython.nbformat.convert module.' % from_version) |
|
73 | 73 | |
|
74 | 74 | def upgrade_cell(cell): |
|
75 | 75 | """upgrade a cell from v3 to v4 |
|
76 | 76 | |
|
77 | 77 | heading cell: |
|
78 | 78 | - -> markdown heading |
|
79 | 79 | code cell: |
|
80 | 80 | - remove language metadata |
|
81 | 81 | - cell.input -> cell.source |
|
82 | 82 | - cell.prompt_number -> cell.execution_count |
|
83 | 83 | - update outputs |
|
84 | 84 | """ |
|
85 | 85 | cell.setdefault('metadata', NotebookNode()) |
|
86 | 86 | if cell.cell_type == 'code': |
|
87 | 87 | cell.pop('language', '') |
|
88 | 88 | if 'collapsed' in cell: |
|
89 | 89 | cell.metadata['collapsed'] = cell.pop('collapsed') |
|
90 | 90 | cell.source = cell.pop('input', '') |
|
91 | 91 | cell.execution_count = cell.pop('prompt_number', None) |
|
92 | 92 | cell.outputs = upgrade_outputs(cell.outputs) |
|
93 | 93 | elif cell.cell_type == 'heading': |
|
94 | 94 | cell.cell_type = 'markdown' |
|
95 | 95 | level = cell.pop('level', 1) |
|
96 | 96 | cell.source = u'{hashes} {single_line}'.format( |
|
97 | 97 | hashes='#' * level, |
|
98 | 98 | single_line = ' '.join(cell.get('source', '').splitlines()), |
|
99 | 99 | ) |
|
100 | 100 | elif cell.cell_type == 'html': |
|
101 | 101 | # Technically, this exists. It will never happen in practice. |
|
102 | 102 | cell.cell_type = 'markdown' |
|
103 | 103 | return cell |
|
104 | 104 | |
|
105 | 105 | def downgrade_cell(cell): |
|
106 | 106 | """downgrade a cell from v4 to v3 |
|
107 | 107 | |
|
108 | 108 | code cell: |
|
109 | 109 | - set cell.language |
|
110 | 110 | - cell.input <- cell.source |
|
111 | 111 | - cell.prompt_number <- cell.execution_count |
|
112 | 112 | - update outputs |
|
113 | 113 | markdown cell: |
|
114 | 114 | - single-line heading -> heading cell |
|
115 | 115 | """ |
|
116 | 116 | if cell.cell_type == 'code': |
|
117 | 117 | cell.language = 'python' |
|
118 | 118 | cell.input = cell.pop('source', '') |
|
119 | 119 | cell.prompt_number = cell.pop('execution_count', None) |
|
120 | 120 | cell.collapsed = cell.metadata.pop('collapsed', False) |
|
121 | 121 | cell.outputs = downgrade_outputs(cell.outputs) |
|
122 | 122 | elif cell.cell_type == 'markdown': |
|
123 | 123 | source = cell.get('source', '') |
|
124 | 124 | if '\n' not in source and source.startswith('#'): |
|
125 | 125 | prefix, text = re.match(r'(#+)\s*(.*)', source).groups() |
|
126 | 126 | cell.cell_type = 'heading' |
|
127 | 127 | cell.source = text |
|
128 | 128 | cell.level = len(prefix) |
|
129 | 129 | return cell |
|
130 | 130 | |
|
131 | 131 | _mime_map = { |
|
132 | 132 | "text" : "text/plain", |
|
133 | 133 | "html" : "text/html", |
|
134 | 134 | "svg" : "image/svg+xml", |
|
135 | 135 | "png" : "image/png", |
|
136 | 136 | "jpeg" : "image/jpeg", |
|
137 | 137 | "latex" : "text/latex", |
|
138 | 138 | "json" : "application/json", |
|
139 | 139 | "javascript" : "application/javascript", |
|
140 | 140 | }; |
|
141 | 141 | |
|
142 | 142 | def to_mime_key(d): |
|
143 | 143 | """convert dict with v3 aliases to plain mime-type keys""" |
|
144 | 144 | for alias, mime in _mime_map.items(): |
|
145 | 145 | if alias in d: |
|
146 | 146 | d[mime] = d.pop(alias) |
|
147 | 147 | return d |
|
148 | 148 | |
|
149 | 149 | def from_mime_key(d): |
|
150 | 150 | """convert dict with mime-type keys to v3 aliases""" |
|
151 | 151 | for alias, mime in _mime_map.items(): |
|
152 | 152 | if mime in d: |
|
153 | 153 | d[alias] = d.pop(mime) |
|
154 | 154 | return d |
|
155 | 155 | |
|
156 | 156 | def upgrade_output(output): |
|
157 | 157 | """upgrade a single code cell output from v3 to v4 |
|
158 | 158 | |
|
159 | 159 | - pyout -> execute_result |
|
160 | 160 | - pyerr -> error |
|
161 | 161 | - output.type -> output.data.mime/type |
|
162 | 162 | - mime-type keys |
|
163 | 163 | - stream.stream -> stream.name |
|
164 | 164 | """ |
|
165 | 165 | if output['output_type'] in {'pyout', 'display_data'}: |
|
166 | 166 | output.setdefault('metadata', NotebookNode()) |
|
167 | 167 | if output['output_type'] == 'pyout': |
|
168 | 168 | output['output_type'] = 'execute_result' |
|
169 | 169 | output['execution_count'] = output.pop('prompt_number', None) |
|
170 | 170 | |
|
171 | 171 | # move output data into data sub-dict |
|
172 | 172 | data = {} |
|
173 | 173 | for key in list(output): |
|
174 | 174 | if key in {'output_type', 'execution_count', 'metadata'}: |
|
175 | 175 | continue |
|
176 | 176 | data[key] = output.pop(key) |
|
177 | 177 | to_mime_key(data) |
|
178 | 178 | output['data'] = data |
|
179 | 179 | to_mime_key(output.metadata) |
|
180 | 180 | if 'application/json' in data: |
|
181 | 181 | data['application/json'] = json.loads(data['application/json']) |
|
182 | 182 | # promote ascii bytes (from v2) to unicode |
|
183 | 183 | for key in ('image/png', 'image/jpeg'): |
|
184 | 184 | if key in data and isinstance(data[key], bytes): |
|
185 | 185 | data[key] = data[key].decode('ascii') |
|
186 | 186 | elif output['output_type'] == 'pyerr': |
|
187 | 187 | output['output_type'] = 'error' |
|
188 | 188 | elif output['output_type'] == 'stream': |
|
189 | output['name'] = output.pop('stream') | |
|
189 | output['name'] = output.pop('stream', 'stdout') | |
|
190 | 190 | return output |
|
191 | 191 | |
|
192 | 192 | def downgrade_output(output): |
|
193 | 193 | """downgrade a single code cell output to v3 from v4 |
|
194 | 194 | |
|
195 | 195 | - pyout <- execute_result |
|
196 | 196 | - pyerr <- error |
|
197 | 197 | - output.data.mime/type -> output.type |
|
198 | 198 | - un-mime-type keys |
|
199 | 199 | - stream.stream <- stream.name |
|
200 | 200 | """ |
|
201 | 201 | if output['output_type'] in {'execute_result', 'display_data'}: |
|
202 | 202 | if output['output_type'] == 'execute_result': |
|
203 | 203 | output['output_type'] = 'pyout' |
|
204 | 204 | output['prompt_number'] = output.pop('execution_count', None) |
|
205 | 205 | |
|
206 | 206 | # promote data dict to top-level output namespace |
|
207 | 207 | data = output.pop('data', {}) |
|
208 | 208 | if 'application/json' in data: |
|
209 | 209 | data['application/json'] = json.dumps(data['application/json']) |
|
210 | 210 | from_mime_key(data) |
|
211 | 211 | output.update(data) |
|
212 | 212 | from_mime_key(output.get('metadata', {})) |
|
213 | 213 | elif output['output_type'] == 'error': |
|
214 | 214 | output['output_type'] = 'pyerr' |
|
215 | 215 | elif output['output_type'] == 'stream': |
|
216 | 216 | output['stream'] = output.pop('name') |
|
217 | 217 | return output |
|
218 | 218 | |
|
219 | 219 | def upgrade_outputs(outputs): |
|
220 | 220 | """upgrade outputs of a code cell from v3 to v4""" |
|
221 | 221 | return [upgrade_output(op) for op in outputs] |
|
222 | 222 | |
|
223 | 223 | def downgrade_outputs(outputs): |
|
224 | 224 | """downgrade outputs of a code cell to v3 from v4""" |
|
225 | 225 | return [downgrade_output(op) for op in outputs] |
|
226 | 226 | |
|
227 | 227 | def downgrade(nb): |
|
228 | 228 | """Convert a v4 notebook to v3. |
|
229 | 229 | |
|
230 | 230 | Parameters |
|
231 | 231 | ---------- |
|
232 | 232 | nb : NotebookNode |
|
233 | 233 | The Python representation of the notebook to convert. |
|
234 | 234 | """ |
|
235 | 235 | if nb.nbformat != nbformat: |
|
236 | 236 | return nb |
|
237 | 237 | |
|
238 | 238 | # Validate the notebook before conversion |
|
239 | 239 | _warn_if_invalid(nb, nbformat) |
|
240 | 240 | |
|
241 | 241 | nb.nbformat = v3.nbformat |
|
242 | 242 | nb.nbformat_minor = v3.nbformat_minor |
|
243 | 243 | cells = [ downgrade_cell(cell) for cell in nb.pop('cells') ] |
|
244 | 244 | nb.worksheets = [v3.new_worksheet(cells=cells)] |
|
245 | 245 | nb.metadata.setdefault('name', '') |
|
246 | 246 | |
|
247 | 247 | # Validate the converted notebook before returning it |
|
248 | 248 | _warn_if_invalid(nb, v3.nbformat) |
|
249 | 249 | |
|
250 | 250 | nb.orig_nbformat = nb.metadata.pop('orig_nbformat', nbformat) |
|
251 | 251 | nb.orig_nbformat_minor = nb.metadata.pop('orig_nbformat_minor', nbformat_minor) |
|
252 | 252 | |
|
253 | 253 | return nb |
General Comments 0
You need to be logged in to leave comments.
Login now