Show More
@@ -1,1135 +1,1133 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Top-level display functions for displaying object in different formats.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | |
|
8 | 8 | try: |
|
9 | 9 | from base64 import encodebytes as base64_encode |
|
10 | 10 | except ImportError: |
|
11 | 11 | from base64 import encodestring as base64_encode |
|
12 | 12 | |
|
13 | 13 | from binascii import b2a_hex |
|
14 | 14 | import json |
|
15 | 15 | import mimetypes |
|
16 | 16 | import os |
|
17 | 17 | import struct |
|
18 | 18 | import sys |
|
19 | 19 | import warnings |
|
20 | 20 | |
|
21 | 21 | from IPython.utils.py3compat import cast_bytes_py2, cast_unicode |
|
22 | 22 | from IPython.testing.skipdoctest import skip_doctest |
|
23 | 23 | |
|
24 | 24 | __all__ = ['display', 'display_pretty', 'display_html', 'display_markdown', |
|
25 | 25 | 'display_svg', 'display_png', 'display_jpeg', 'display_latex', 'display_json', |
|
26 | 26 | 'display_javascript', 'display_pdf', 'DisplayObject', 'TextDisplayObject', |
|
27 | 27 | 'Pretty', 'HTML', 'Markdown', 'Math', 'Latex', 'SVG', 'JSON', 'Javascript', |
|
28 | 28 | 'Image', 'clear_output', 'set_matplotlib_formats', 'set_matplotlib_close', |
|
29 | 29 | 'publish_display_data', 'update_display', 'DisplayHandle'] |
|
30 | 30 | |
|
31 | 31 | #----------------------------------------------------------------------------- |
|
32 | 32 | # utility functions |
|
33 | 33 | #----------------------------------------------------------------------------- |
|
34 | 34 | |
|
35 | 35 | def _safe_exists(path): |
|
36 | 36 | """Check path, but don't let exceptions raise""" |
|
37 | 37 | try: |
|
38 | 38 | return os.path.exists(path) |
|
39 | 39 | except Exception: |
|
40 | 40 | return False |
|
41 | 41 | |
|
42 | 42 | def _merge(d1, d2): |
|
43 | 43 | """Like update, but merges sub-dicts instead of clobbering at the top level. |
|
44 | 44 | |
|
45 | 45 | Updates d1 in-place |
|
46 | 46 | """ |
|
47 | 47 | |
|
48 | 48 | if not isinstance(d2, dict) or not isinstance(d1, dict): |
|
49 | 49 | return d2 |
|
50 | 50 | for key, value in d2.items(): |
|
51 | 51 | d1[key] = _merge(d1.get(key), value) |
|
52 | 52 | return d1 |
|
53 | 53 | |
|
54 | 54 | def _display_mimetype(mimetype, objs, raw=False, metadata=None): |
|
55 | 55 | """internal implementation of all display_foo methods |
|
56 | 56 | |
|
57 | 57 | Parameters |
|
58 | 58 | ---------- |
|
59 | 59 | mimetype : str |
|
60 | 60 | The mimetype to be published (e.g. 'image/png') |
|
61 | 61 | objs : tuple of objects |
|
62 | 62 | The Python objects to display, or if raw=True raw text data to |
|
63 | 63 | display. |
|
64 | 64 | raw : bool |
|
65 | 65 | Are the data objects raw data or Python objects that need to be |
|
66 | 66 | formatted before display? [default: False] |
|
67 | 67 | metadata : dict (optional) |
|
68 | 68 | Metadata to be associated with the specific mimetype output. |
|
69 | 69 | """ |
|
70 | 70 | if metadata: |
|
71 | 71 | metadata = {mimetype: metadata} |
|
72 | 72 | if raw: |
|
73 | 73 | # turn list of pngdata into list of { 'image/png': pngdata } |
|
74 | 74 | objs = [ {mimetype: obj} for obj in objs ] |
|
75 | 75 | display(*objs, raw=raw, metadata=metadata, include=[mimetype]) |
|
76 | 76 | |
|
77 | 77 | #----------------------------------------------------------------------------- |
|
78 | 78 | # Main functions |
|
79 | 79 | #----------------------------------------------------------------------------- |
|
80 | 80 | |
|
81 | 81 | # use * to indicate transient is keyword-only |
|
82 | 82 | def publish_display_data(data, metadata=None, source=None, *, transient=None, **kwargs): |
|
83 | 83 | """Publish data and metadata to all frontends. |
|
84 | 84 | |
|
85 | 85 | See the ``display_data`` message in the messaging documentation for |
|
86 | 86 | more details about this message type. |
|
87 | 87 | |
|
88 | 88 | The following MIME types are currently implemented: |
|
89 | 89 | |
|
90 | 90 | * text/plain |
|
91 | 91 | * text/html |
|
92 | 92 | * text/markdown |
|
93 | 93 | * text/latex |
|
94 | 94 | * application/json |
|
95 | 95 | * application/javascript |
|
96 | 96 | * image/png |
|
97 | 97 | * image/jpeg |
|
98 | 98 | * image/svg+xml |
|
99 | 99 | |
|
100 | 100 | Parameters |
|
101 | 101 | ---------- |
|
102 | 102 | data : dict |
|
103 | 103 | A dictionary having keys that are valid MIME types (like |
|
104 | 104 | 'text/plain' or 'image/svg+xml') and values that are the data for |
|
105 | 105 | that MIME type. The data itself must be a JSON'able data |
|
106 | 106 | structure. Minimally all data should have the 'text/plain' data, |
|
107 | 107 | which can be displayed by all frontends. If more than the plain |
|
108 | 108 | text is given, it is up to the frontend to decide which |
|
109 | 109 | representation to use. |
|
110 | 110 | metadata : dict |
|
111 | 111 | A dictionary for metadata related to the data. This can contain |
|
112 | 112 | arbitrary key, value pairs that frontends can use to interpret |
|
113 | 113 | the data. mime-type keys matching those in data can be used |
|
114 | 114 | to specify metadata about particular representations. |
|
115 | 115 | source : str, deprecated |
|
116 | 116 | Unused. |
|
117 | 117 | transient : dict, keyword-only |
|
118 | 118 | A dictionary of transient data, such as display_id. |
|
119 | 119 | """ |
|
120 | 120 | from IPython.core.interactiveshell import InteractiveShell |
|
121 | 121 | |
|
122 | 122 | display_pub = InteractiveShell.instance().display_pub |
|
123 | 123 | |
|
124 | 124 | # only pass transient if supplied, |
|
125 | 125 | # to avoid errors with older ipykernel. |
|
126 | 126 | # TODO: We could check for ipykernel version and provide a detailed upgrade message. |
|
127 | 127 | if transient: |
|
128 | 128 | kwargs['transient'] = transient |
|
129 | 129 | |
|
130 | 130 | display_pub.publish( |
|
131 | 131 | data=data, |
|
132 | 132 | metadata=metadata, |
|
133 | 133 | **kwargs |
|
134 | 134 | ) |
|
135 | 135 | |
|
136 | 136 | |
|
137 | 137 | def _new_id(): |
|
138 | 138 | """Generate a new random text id with urandom""" |
|
139 | 139 | return b2a_hex(os.urandom(16)).decode('ascii') |
|
140 | 140 | |
|
141 | 141 | |
|
142 | 142 | def display(*objs, include=None, exclude=None, metadata=None, transient=None, display_id=None, **kwargs): |
|
143 | 143 | """Display a Python object in all frontends. |
|
144 | 144 | |
|
145 | 145 | By default all representations will be computed and sent to the frontends. |
|
146 | 146 | Frontends can decide which representation is used and how. |
|
147 | 147 | |
|
148 | 148 | Parameters |
|
149 | 149 | ---------- |
|
150 | 150 | objs : tuple of objects |
|
151 | 151 | The Python objects to display. |
|
152 | 152 | raw : bool, optional |
|
153 | 153 | Are the objects to be displayed already mimetype-keyed dicts of raw display data, |
|
154 | 154 | or Python objects that need to be formatted before display? [default: False] |
|
155 | 155 | include : list or tuple, optional |
|
156 | 156 | A list of format type strings (MIME types) to include in the |
|
157 | 157 | format data dict. If this is set *only* the format types included |
|
158 | 158 | in this list will be computed. |
|
159 | 159 | exclude : list or tuple, optional |
|
160 | 160 | A list of format type strings (MIME types) to exclude in the format |
|
161 | 161 | data dict. If this is set all format types will be computed, |
|
162 | 162 | except for those included in this argument. |
|
163 | 163 | metadata : dict, optional |
|
164 | 164 | A dictionary of metadata to associate with the output. |
|
165 | 165 | mime-type keys in this dictionary will be associated with the individual |
|
166 | 166 | representation formats, if they exist. |
|
167 | 167 | transient : dict, optional |
|
168 | 168 | A dictionary of transient data to associate with the output. |
|
169 | 169 | Data in this dict should not be persisted to files (e.g. notebooks). |
|
170 | 170 | display_id : str, optional |
|
171 | 171 | Set an id for the display. |
|
172 | 172 | This id can be used for updating this display area later via update_display. |
|
173 | 173 | If given as True, generate a new display_id |
|
174 | 174 | kwargs: additional keyword-args, optional |
|
175 | 175 | Additional keyword-arguments are passed through to the display publisher. |
|
176 | 176 | |
|
177 | 177 | Returns |
|
178 | 178 | ------- |
|
179 | 179 | |
|
180 | 180 | handle: DisplayHandle |
|
181 | 181 | Returns a handle on updatable displays, if display_id is given. |
|
182 | 182 | Returns None if no display_id is given (default). |
|
183 | 183 | """ |
|
184 | 184 | raw = kwargs.pop('raw', False) |
|
185 | 185 | if transient is None: |
|
186 | 186 | transient = {} |
|
187 | 187 | if display_id: |
|
188 | 188 | if display_id == True: |
|
189 | 189 | display_id = _new_id() |
|
190 | 190 | transient['display_id'] = display_id |
|
191 | 191 | if kwargs.get('update') and 'display_id' not in transient: |
|
192 | 192 | raise TypeError('display_id required for update_display') |
|
193 | 193 | if transient: |
|
194 | 194 | kwargs['transient'] = transient |
|
195 | 195 | |
|
196 | 196 | from IPython.core.interactiveshell import InteractiveShell |
|
197 | 197 | |
|
198 | 198 | if not raw: |
|
199 | 199 | format = InteractiveShell.instance().display_formatter.format |
|
200 | 200 | |
|
201 | 201 | for obj in objs: |
|
202 | 202 | if raw: |
|
203 | 203 | publish_display_data(data=obj, metadata=metadata, **kwargs) |
|
204 | 204 | else: |
|
205 | 205 | format_dict, md_dict = format(obj, include=include, exclude=exclude) |
|
206 | 206 | if not format_dict: |
|
207 | 207 | # nothing to display (e.g. _ipython_display_ took over) |
|
208 | 208 | continue |
|
209 | 209 | if metadata: |
|
210 | 210 | # kwarg-specified metadata gets precedence |
|
211 | 211 | _merge(md_dict, metadata) |
|
212 | 212 | publish_display_data(data=format_dict, metadata=md_dict, **kwargs) |
|
213 | 213 | if display_id: |
|
214 | 214 | return DisplayHandle(display_id) |
|
215 | 215 | |
|
216 | 216 | |
|
217 | 217 | # use * for keyword-only display_id arg |
|
218 | 218 | def update_display(obj, *, display_id, **kwargs): |
|
219 | 219 | """Update an existing display by id |
|
220 | 220 | |
|
221 | 221 | Parameters |
|
222 | 222 | ---------- |
|
223 | 223 | |
|
224 | 224 | obj: |
|
225 | 225 | The object with which to update the display |
|
226 | 226 | display_id: keyword-only |
|
227 | 227 | The id of the display to update |
|
228 | 228 | """ |
|
229 | 229 | kwargs['update'] = True |
|
230 | 230 | display(obj, display_id=display_id, **kwargs) |
|
231 | 231 | |
|
232 | 232 | |
|
233 | 233 | class DisplayHandle(object): |
|
234 | 234 | """A handle on an updatable display |
|
235 | 235 | |
|
236 | 236 | Call .update(obj) to display a new object. |
|
237 | 237 | |
|
238 | 238 | Call .display(obj) to add a new instance of this display, |
|
239 | 239 | and update existing instances. |
|
240 | 240 | """ |
|
241 | 241 | |
|
242 | 242 | def __init__(self, display_id=None): |
|
243 | 243 | if display_id is None: |
|
244 | 244 | display_id = _new_id() |
|
245 | 245 | self.display_id = display_id |
|
246 | 246 | |
|
247 | 247 | def __repr__(self): |
|
248 | 248 | return "<%s display_id=%s>" % (self.__class__.__name__, self.display_id) |
|
249 | 249 | |
|
250 | 250 | def display(self, obj, **kwargs): |
|
251 | 251 | """Make a new display with my id, updating existing instances. |
|
252 | 252 | |
|
253 | 253 | Parameters |
|
254 | 254 | ---------- |
|
255 | 255 | |
|
256 | 256 | obj: |
|
257 | 257 | object to display |
|
258 | 258 | **kwargs: |
|
259 | 259 | additional keyword arguments passed to display |
|
260 | 260 | """ |
|
261 | 261 | display(obj, display_id=self.display_id, **kwargs) |
|
262 | 262 | |
|
263 | 263 | def update(self, obj, **kwargs): |
|
264 | 264 | """Update existing displays with my id |
|
265 | 265 | |
|
266 | 266 | Parameters |
|
267 | 267 | ---------- |
|
268 | 268 | |
|
269 | 269 | obj: |
|
270 | 270 | object to display |
|
271 | 271 | **kwargs: |
|
272 | 272 | additional keyword arguments passed to update_display |
|
273 | 273 | """ |
|
274 | 274 | update_display(obj, display_id=self.display_id, **kwargs) |
|
275 | 275 | |
|
276 | 276 | |
|
277 | 277 | def display_pretty(*objs, **kwargs): |
|
278 | 278 | """Display the pretty (default) representation of an object. |
|
279 | 279 | |
|
280 | 280 | Parameters |
|
281 | 281 | ---------- |
|
282 | 282 | objs : tuple of objects |
|
283 | 283 | The Python objects to display, or if raw=True raw text data to |
|
284 | 284 | display. |
|
285 | 285 | raw : bool |
|
286 | 286 | Are the data objects raw data or Python objects that need to be |
|
287 | 287 | formatted before display? [default: False] |
|
288 | 288 | metadata : dict (optional) |
|
289 | 289 | Metadata to be associated with the specific mimetype output. |
|
290 | 290 | """ |
|
291 | 291 | _display_mimetype('text/plain', objs, **kwargs) |
|
292 | 292 | |
|
293 | 293 | |
|
294 | 294 | def display_html(*objs, **kwargs): |
|
295 | 295 | """Display the HTML representation of an object. |
|
296 | 296 | |
|
297 | 297 | Note: If raw=False and the object does not have a HTML |
|
298 | 298 | representation, no HTML will be shown. |
|
299 | 299 | |
|
300 | 300 | Parameters |
|
301 | 301 | ---------- |
|
302 | 302 | objs : tuple of objects |
|
303 | 303 | The Python objects to display, or if raw=True raw HTML data to |
|
304 | 304 | display. |
|
305 | 305 | raw : bool |
|
306 | 306 | Are the data objects raw data or Python objects that need to be |
|
307 | 307 | formatted before display? [default: False] |
|
308 | 308 | metadata : dict (optional) |
|
309 | 309 | Metadata to be associated with the specific mimetype output. |
|
310 | 310 | """ |
|
311 | 311 | _display_mimetype('text/html', objs, **kwargs) |
|
312 | 312 | |
|
313 | 313 | |
|
314 | 314 | def display_markdown(*objs, **kwargs): |
|
315 | 315 | """Displays the Markdown representation of an object. |
|
316 | 316 | |
|
317 | 317 | Parameters |
|
318 | 318 | ---------- |
|
319 | 319 | objs : tuple of objects |
|
320 | 320 | The Python objects to display, or if raw=True raw markdown data to |
|
321 | 321 | display. |
|
322 | 322 | raw : bool |
|
323 | 323 | Are the data objects raw data or Python objects that need to be |
|
324 | 324 | formatted before display? [default: False] |
|
325 | 325 | metadata : dict (optional) |
|
326 | 326 | Metadata to be associated with the specific mimetype output. |
|
327 | 327 | """ |
|
328 | 328 | |
|
329 | 329 | _display_mimetype('text/markdown', objs, **kwargs) |
|
330 | 330 | |
|
331 | 331 | |
|
332 | 332 | def display_svg(*objs, **kwargs): |
|
333 | 333 | """Display the SVG representation of an object. |
|
334 | 334 | |
|
335 | 335 | Parameters |
|
336 | 336 | ---------- |
|
337 | 337 | objs : tuple of objects |
|
338 | 338 | The Python objects to display, or if raw=True raw svg data to |
|
339 | 339 | display. |
|
340 | 340 | raw : bool |
|
341 | 341 | Are the data objects raw data or Python objects that need to be |
|
342 | 342 | formatted before display? [default: False] |
|
343 | 343 | metadata : dict (optional) |
|
344 | 344 | Metadata to be associated with the specific mimetype output. |
|
345 | 345 | """ |
|
346 | 346 | _display_mimetype('image/svg+xml', objs, **kwargs) |
|
347 | 347 | |
|
348 | 348 | |
|
349 | 349 | def display_png(*objs, **kwargs): |
|
350 | 350 | """Display the PNG representation of an object. |
|
351 | 351 | |
|
352 | 352 | Parameters |
|
353 | 353 | ---------- |
|
354 | 354 | objs : tuple of objects |
|
355 | 355 | The Python objects to display, or if raw=True raw png data to |
|
356 | 356 | display. |
|
357 | 357 | raw : bool |
|
358 | 358 | Are the data objects raw data or Python objects that need to be |
|
359 | 359 | formatted before display? [default: False] |
|
360 | 360 | metadata : dict (optional) |
|
361 | 361 | Metadata to be associated with the specific mimetype output. |
|
362 | 362 | """ |
|
363 | 363 | _display_mimetype('image/png', objs, **kwargs) |
|
364 | 364 | |
|
365 | 365 | |
|
366 | 366 | def display_jpeg(*objs, **kwargs): |
|
367 | 367 | """Display the JPEG representation of an object. |
|
368 | 368 | |
|
369 | 369 | Parameters |
|
370 | 370 | ---------- |
|
371 | 371 | objs : tuple of objects |
|
372 | 372 | The Python objects to display, or if raw=True raw JPEG data to |
|
373 | 373 | display. |
|
374 | 374 | raw : bool |
|
375 | 375 | Are the data objects raw data or Python objects that need to be |
|
376 | 376 | formatted before display? [default: False] |
|
377 | 377 | metadata : dict (optional) |
|
378 | 378 | Metadata to be associated with the specific mimetype output. |
|
379 | 379 | """ |
|
380 | 380 | _display_mimetype('image/jpeg', objs, **kwargs) |
|
381 | 381 | |
|
382 | 382 | |
|
383 | 383 | def display_latex(*objs, **kwargs): |
|
384 | 384 | """Display the LaTeX representation of an object. |
|
385 | 385 | |
|
386 | 386 | Parameters |
|
387 | 387 | ---------- |
|
388 | 388 | objs : tuple of objects |
|
389 | 389 | The Python objects to display, or if raw=True raw latex data to |
|
390 | 390 | display. |
|
391 | 391 | raw : bool |
|
392 | 392 | Are the data objects raw data or Python objects that need to be |
|
393 | 393 | formatted before display? [default: False] |
|
394 | 394 | metadata : dict (optional) |
|
395 | 395 | Metadata to be associated with the specific mimetype output. |
|
396 | 396 | """ |
|
397 | 397 | _display_mimetype('text/latex', objs, **kwargs) |
|
398 | 398 | |
|
399 | 399 | |
|
400 | 400 | def display_json(*objs, **kwargs): |
|
401 | 401 | """Display the JSON representation of an object. |
|
402 | 402 | |
|
403 | 403 | Note that not many frontends support displaying JSON. |
|
404 | 404 | |
|
405 | 405 | Parameters |
|
406 | 406 | ---------- |
|
407 | 407 | objs : tuple of objects |
|
408 | 408 | The Python objects to display, or if raw=True raw json data to |
|
409 | 409 | display. |
|
410 | 410 | raw : bool |
|
411 | 411 | Are the data objects raw data or Python objects that need to be |
|
412 | 412 | formatted before display? [default: False] |
|
413 | 413 | metadata : dict (optional) |
|
414 | 414 | Metadata to be associated with the specific mimetype output. |
|
415 | 415 | """ |
|
416 | 416 | _display_mimetype('application/json', objs, **kwargs) |
|
417 | 417 | |
|
418 | 418 | |
|
419 | 419 | def display_javascript(*objs, **kwargs): |
|
420 | 420 | """Display the Javascript representation of an object. |
|
421 | 421 | |
|
422 | 422 | Parameters |
|
423 | 423 | ---------- |
|
424 | 424 | objs : tuple of objects |
|
425 | 425 | The Python objects to display, or if raw=True raw javascript data to |
|
426 | 426 | display. |
|
427 | 427 | raw : bool |
|
428 | 428 | Are the data objects raw data or Python objects that need to be |
|
429 | 429 | formatted before display? [default: False] |
|
430 | 430 | metadata : dict (optional) |
|
431 | 431 | Metadata to be associated with the specific mimetype output. |
|
432 | 432 | """ |
|
433 | 433 | _display_mimetype('application/javascript', objs, **kwargs) |
|
434 | 434 | |
|
435 | 435 | |
|
436 | 436 | def display_pdf(*objs, **kwargs): |
|
437 | 437 | """Display the PDF representation of an object. |
|
438 | 438 | |
|
439 | 439 | Parameters |
|
440 | 440 | ---------- |
|
441 | 441 | objs : tuple of objects |
|
442 | 442 | The Python objects to display, or if raw=True raw javascript data to |
|
443 | 443 | display. |
|
444 | 444 | raw : bool |
|
445 | 445 | Are the data objects raw data or Python objects that need to be |
|
446 | 446 | formatted before display? [default: False] |
|
447 | 447 | metadata : dict (optional) |
|
448 | 448 | Metadata to be associated with the specific mimetype output. |
|
449 | 449 | """ |
|
450 | 450 | _display_mimetype('application/pdf', objs, **kwargs) |
|
451 | 451 | |
|
452 | 452 | |
|
453 | 453 | #----------------------------------------------------------------------------- |
|
454 | 454 | # Smart classes |
|
455 | 455 | #----------------------------------------------------------------------------- |
|
456 | 456 | |
|
457 | 457 | |
|
458 | 458 | class DisplayObject(object): |
|
459 | 459 | """An object that wraps data to be displayed.""" |
|
460 | 460 | |
|
461 | 461 | _read_flags = 'r' |
|
462 | 462 | _show_mem_addr = False |
|
463 | 463 | |
|
464 | 464 | def __init__(self, data=None, url=None, filename=None): |
|
465 | 465 | """Create a display object given raw data. |
|
466 | 466 | |
|
467 | 467 | When this object is returned by an expression or passed to the |
|
468 | 468 | display function, it will result in the data being displayed |
|
469 | 469 | in the frontend. The MIME type of the data should match the |
|
470 | 470 | subclasses used, so the Png subclass should be used for 'image/png' |
|
471 | 471 | data. If the data is a URL, the data will first be downloaded |
|
472 | 472 | and then displayed. If |
|
473 | 473 | |
|
474 | 474 | Parameters |
|
475 | 475 | ---------- |
|
476 | 476 | data : unicode, str or bytes |
|
477 | 477 | The raw data or a URL or file to load the data from |
|
478 | 478 | url : unicode |
|
479 | 479 | A URL to download the data from. |
|
480 | 480 | filename : unicode |
|
481 | 481 | Path to a local file to load the data from. |
|
482 | 482 | """ |
|
483 | 483 | if data is not None and isinstance(data, str): |
|
484 | 484 | if data.startswith('http') and url is None: |
|
485 | 485 | url = data |
|
486 | 486 | filename = None |
|
487 | 487 | data = None |
|
488 | 488 | elif _safe_exists(data) and filename is None: |
|
489 | 489 | url = None |
|
490 | 490 | filename = data |
|
491 | 491 | data = None |
|
492 | 492 | |
|
493 | 493 | self.data = data |
|
494 | 494 | self.url = url |
|
495 | 495 | self.filename = filename |
|
496 | 496 | |
|
497 | 497 | self.reload() |
|
498 | 498 | self._check_data() |
|
499 | 499 | |
|
500 | 500 | def __repr__(self): |
|
501 | 501 | if not self._show_mem_addr: |
|
502 | 502 | cls = self.__class__ |
|
503 | 503 | r = "<%s.%s object>" % (cls.__module__, cls.__name__) |
|
504 | 504 | else: |
|
505 | 505 | r = super(DisplayObject, self).__repr__() |
|
506 | 506 | return r |
|
507 | 507 | |
|
508 | 508 | def _check_data(self): |
|
509 | 509 | """Override in subclasses if there's something to check.""" |
|
510 | 510 | pass |
|
511 | 511 | |
|
512 | 512 | def reload(self): |
|
513 | 513 | """Reload the raw data from file or URL.""" |
|
514 | 514 | if self.filename is not None: |
|
515 | 515 | with open(self.filename, self._read_flags) as f: |
|
516 | 516 | self.data = f.read() |
|
517 | 517 | elif self.url is not None: |
|
518 | 518 | try: |
|
519 |
|
|
|
520 |
|
|
|
521 | except ImportError: | |
|
522 | from urllib2 import urlopen | |
|
519 | # Deferred import | |
|
520 | from urllib.request import urlopen | |
|
523 | 521 | response = urlopen(self.url) |
|
524 | 522 | self.data = response.read() |
|
525 | 523 | # extract encoding from header, if there is one: |
|
526 | 524 | encoding = None |
|
527 | 525 | for sub in response.headers['content-type'].split(';'): |
|
528 | 526 | sub = sub.strip() |
|
529 | 527 | if sub.startswith('charset'): |
|
530 | 528 | encoding = sub.split('=')[-1].strip() |
|
531 | 529 | break |
|
532 | 530 | # decode data, if an encoding was specified |
|
533 | 531 | if encoding: |
|
534 | 532 | self.data = self.data.decode(encoding, 'replace') |
|
535 | 533 | except: |
|
536 | 534 | self.data = None |
|
537 | 535 | |
|
538 | 536 | class TextDisplayObject(DisplayObject): |
|
539 | 537 | """Validate that display data is text""" |
|
540 | 538 | def _check_data(self): |
|
541 | 539 | if self.data is not None and not isinstance(self.data, str): |
|
542 | 540 | raise TypeError("%s expects text, not %r" % (self.__class__.__name__, self.data)) |
|
543 | 541 | |
|
544 | 542 | class Pretty(TextDisplayObject): |
|
545 | 543 | |
|
546 | 544 | def _repr_pretty_(self): |
|
547 | 545 | return self.data |
|
548 | 546 | |
|
549 | 547 | |
|
550 | 548 | class HTML(TextDisplayObject): |
|
551 | 549 | |
|
552 | 550 | def _repr_html_(self): |
|
553 | 551 | return self.data |
|
554 | 552 | |
|
555 | 553 | def __html__(self): |
|
556 | 554 | """ |
|
557 | 555 | This method exists to inform other HTML-using modules (e.g. Markupsafe, |
|
558 | 556 | htmltag, etc) that this object is HTML and does not need things like |
|
559 | 557 | special characters (<>&) escaped. |
|
560 | 558 | """ |
|
561 | 559 | return self._repr_html_() |
|
562 | 560 | |
|
563 | 561 | |
|
564 | 562 | class Markdown(TextDisplayObject): |
|
565 | 563 | |
|
566 | 564 | def _repr_markdown_(self): |
|
567 | 565 | return self.data |
|
568 | 566 | |
|
569 | 567 | |
|
570 | 568 | class Math(TextDisplayObject): |
|
571 | 569 | |
|
572 | 570 | def _repr_latex_(self): |
|
573 | 571 | s = self.data.strip('$') |
|
574 | 572 | return "$$%s$$" % s |
|
575 | 573 | |
|
576 | 574 | |
|
577 | 575 | class Latex(TextDisplayObject): |
|
578 | 576 | |
|
579 | 577 | def _repr_latex_(self): |
|
580 | 578 | return self.data |
|
581 | 579 | |
|
582 | 580 | |
|
583 | 581 | class SVG(DisplayObject): |
|
584 | 582 | |
|
585 | 583 | _read_flags = 'rb' |
|
586 | 584 | # wrap data in a property, which extracts the <svg> tag, discarding |
|
587 | 585 | # document headers |
|
588 | 586 | _data = None |
|
589 | 587 | |
|
590 | 588 | @property |
|
591 | 589 | def data(self): |
|
592 | 590 | return self._data |
|
593 | 591 | |
|
594 | 592 | @data.setter |
|
595 | 593 | def data(self, svg): |
|
596 | 594 | if svg is None: |
|
597 | 595 | self._data = None |
|
598 | 596 | return |
|
599 | 597 | # parse into dom object |
|
600 | 598 | from xml.dom import minidom |
|
601 | 599 | svg = cast_bytes_py2(svg) |
|
602 | 600 | x = minidom.parseString(svg) |
|
603 | 601 | # get svg tag (should be 1) |
|
604 | 602 | found_svg = x.getElementsByTagName('svg') |
|
605 | 603 | if found_svg: |
|
606 | 604 | svg = found_svg[0].toxml() |
|
607 | 605 | else: |
|
608 | 606 | # fallback on the input, trust the user |
|
609 | 607 | # but this is probably an error. |
|
610 | 608 | pass |
|
611 | 609 | svg = cast_unicode(svg) |
|
612 | 610 | self._data = svg |
|
613 | 611 | |
|
614 | 612 | def _repr_svg_(self): |
|
615 | 613 | return self.data |
|
616 | 614 | |
|
617 | 615 | |
|
618 | 616 | class JSON(DisplayObject): |
|
619 | 617 | """JSON expects a JSON-able dict or list |
|
620 | 618 | |
|
621 | 619 | not an already-serialized JSON string. |
|
622 | 620 | |
|
623 | 621 | Scalar types (None, number, string) are not allowed, only dict or list containers. |
|
624 | 622 | """ |
|
625 | 623 | # wrap data in a property, which warns about passing already-serialized JSON |
|
626 | 624 | _data = None |
|
627 | 625 | def __init__(self, data=None, url=None, filename=None, expanded=False, metadata=None): |
|
628 | 626 | """Create a JSON display object given raw data. |
|
629 | 627 | |
|
630 | 628 | Parameters |
|
631 | 629 | ---------- |
|
632 | 630 | data : dict or list |
|
633 | 631 | JSON data to display. Not an already-serialized JSON string. |
|
634 | 632 | Scalar types (None, number, string) are not allowed, only dict |
|
635 | 633 | or list containers. |
|
636 | 634 | url : unicode |
|
637 | 635 | A URL to download the data from. |
|
638 | 636 | filename : unicode |
|
639 | 637 | Path to a local file to load the data from. |
|
640 | 638 | expanded : boolean |
|
641 | 639 | Metadata to control whether a JSON display component is expanded. |
|
642 | 640 | metadata: dict |
|
643 | 641 | Specify extra metadata to attach to the json display object. |
|
644 | 642 | """ |
|
645 | 643 | self.expanded = expanded |
|
646 | 644 | self.metadata = metadata |
|
647 | 645 | super(JSON, self).__init__(data=data, url=url, filename=filename) |
|
648 | 646 | |
|
649 | 647 | def _check_data(self): |
|
650 | 648 | if self.data is not None and not isinstance(self.data, (dict, list)): |
|
651 | 649 | raise TypeError("%s expects JSONable dict or list, not %r" % (self.__class__.__name__, self.data)) |
|
652 | 650 | |
|
653 | 651 | @property |
|
654 | 652 | def data(self): |
|
655 | 653 | return self._data |
|
656 | 654 | |
|
657 | 655 | @data.setter |
|
658 | 656 | def data(self, data): |
|
659 | 657 | if isinstance(data, str): |
|
660 | 658 | warnings.warn("JSON expects JSONable dict or list, not JSON strings") |
|
661 | 659 | data = json.loads(data) |
|
662 | 660 | self._data = data |
|
663 | 661 | |
|
664 | 662 | def _data_and_metadata(self): |
|
665 | 663 | md = {'expanded': self.expanded} |
|
666 | 664 | if self.metadata: |
|
667 | 665 | md.update(self.metadata) |
|
668 | 666 | return self.data, md |
|
669 | 667 | |
|
670 | 668 | def _repr_json_(self): |
|
671 | 669 | return self._data_and_metadata() |
|
672 | 670 | |
|
673 | 671 | css_t = """$("head").append($("<link/>").attr({ |
|
674 | 672 | rel: "stylesheet", |
|
675 | 673 | type: "text/css", |
|
676 | 674 | href: "%s" |
|
677 | 675 | })); |
|
678 | 676 | """ |
|
679 | 677 | |
|
680 | 678 | lib_t1 = """$.getScript("%s", function () { |
|
681 | 679 | """ |
|
682 | 680 | lib_t2 = """}); |
|
683 | 681 | """ |
|
684 | 682 | |
|
685 | 683 | class Javascript(TextDisplayObject): |
|
686 | 684 | |
|
687 | 685 | def __init__(self, data=None, url=None, filename=None, lib=None, css=None): |
|
688 | 686 | """Create a Javascript display object given raw data. |
|
689 | 687 | |
|
690 | 688 | When this object is returned by an expression or passed to the |
|
691 | 689 | display function, it will result in the data being displayed |
|
692 | 690 | in the frontend. If the data is a URL, the data will first be |
|
693 | 691 | downloaded and then displayed. |
|
694 | 692 | |
|
695 | 693 | In the Notebook, the containing element will be available as `element`, |
|
696 | 694 | and jQuery will be available. Content appended to `element` will be |
|
697 | 695 | visible in the output area. |
|
698 | 696 | |
|
699 | 697 | Parameters |
|
700 | 698 | ---------- |
|
701 | 699 | data : unicode, str or bytes |
|
702 | 700 | The Javascript source code or a URL to download it from. |
|
703 | 701 | url : unicode |
|
704 | 702 | A URL to download the data from. |
|
705 | 703 | filename : unicode |
|
706 | 704 | Path to a local file to load the data from. |
|
707 | 705 | lib : list or str |
|
708 | 706 | A sequence of Javascript library URLs to load asynchronously before |
|
709 | 707 | running the source code. The full URLs of the libraries should |
|
710 | 708 | be given. A single Javascript library URL can also be given as a |
|
711 | 709 | string. |
|
712 | 710 | css: : list or str |
|
713 | 711 | A sequence of css files to load before running the source code. |
|
714 | 712 | The full URLs of the css files should be given. A single css URL |
|
715 | 713 | can also be given as a string. |
|
716 | 714 | """ |
|
717 | 715 | if isinstance(lib, str): |
|
718 | 716 | lib = [lib] |
|
719 | 717 | elif lib is None: |
|
720 | 718 | lib = [] |
|
721 | 719 | if isinstance(css, str): |
|
722 | 720 | css = [css] |
|
723 | 721 | elif css is None: |
|
724 | 722 | css = [] |
|
725 | 723 | if not isinstance(lib, (list,tuple)): |
|
726 | 724 | raise TypeError('expected sequence, got: %r' % lib) |
|
727 | 725 | if not isinstance(css, (list,tuple)): |
|
728 | 726 | raise TypeError('expected sequence, got: %r' % css) |
|
729 | 727 | self.lib = lib |
|
730 | 728 | self.css = css |
|
731 | 729 | super(Javascript, self).__init__(data=data, url=url, filename=filename) |
|
732 | 730 | |
|
733 | 731 | def _repr_javascript_(self): |
|
734 | 732 | r = '' |
|
735 | 733 | for c in self.css: |
|
736 | 734 | r += css_t % c |
|
737 | 735 | for l in self.lib: |
|
738 | 736 | r += lib_t1 % l |
|
739 | 737 | r += self.data |
|
740 | 738 | r += lib_t2*len(self.lib) |
|
741 | 739 | return r |
|
742 | 740 | |
|
743 | 741 | # constants for identifying png/jpeg data |
|
744 | 742 | _PNG = b'\x89PNG\r\n\x1a\n' |
|
745 | 743 | _JPEG = b'\xff\xd8' |
|
746 | 744 | |
|
747 | 745 | def _pngxy(data): |
|
748 | 746 | """read the (width, height) from a PNG header""" |
|
749 | 747 | ihdr = data.index(b'IHDR') |
|
750 | 748 | # next 8 bytes are width/height |
|
751 | 749 | w4h4 = data[ihdr+4:ihdr+12] |
|
752 | 750 | return struct.unpack('>ii', w4h4) |
|
753 | 751 | |
|
754 | 752 | def _jpegxy(data): |
|
755 | 753 | """read the (width, height) from a JPEG header""" |
|
756 | 754 | # adapted from http://www.64lines.com/jpeg-width-height |
|
757 | 755 | |
|
758 | 756 | idx = 4 |
|
759 | 757 | while True: |
|
760 | 758 | block_size = struct.unpack('>H', data[idx:idx+2])[0] |
|
761 | 759 | idx = idx + block_size |
|
762 | 760 | if data[idx:idx+2] == b'\xFF\xC0': |
|
763 | 761 | # found Start of Frame |
|
764 | 762 | iSOF = idx |
|
765 | 763 | break |
|
766 | 764 | else: |
|
767 | 765 | # read another block |
|
768 | 766 | idx += 2 |
|
769 | 767 | |
|
770 | 768 | h, w = struct.unpack('>HH', data[iSOF+5:iSOF+9]) |
|
771 | 769 | return w, h |
|
772 | 770 | |
|
773 | 771 | class Image(DisplayObject): |
|
774 | 772 | |
|
775 | 773 | _read_flags = 'rb' |
|
776 | 774 | _FMT_JPEG = u'jpeg' |
|
777 | 775 | _FMT_PNG = u'png' |
|
778 | 776 | _ACCEPTABLE_EMBEDDINGS = [_FMT_JPEG, _FMT_PNG] |
|
779 | 777 | |
|
780 | 778 | def __init__(self, data=None, url=None, filename=None, format=None, |
|
781 | 779 | embed=None, width=None, height=None, retina=False, |
|
782 | 780 | unconfined=False, metadata=None): |
|
783 | 781 | """Create a PNG/JPEG image object given raw data. |
|
784 | 782 | |
|
785 | 783 | When this object is returned by an input cell or passed to the |
|
786 | 784 | display function, it will result in the image being displayed |
|
787 | 785 | in the frontend. |
|
788 | 786 | |
|
789 | 787 | Parameters |
|
790 | 788 | ---------- |
|
791 | 789 | data : unicode, str or bytes |
|
792 | 790 | The raw image data or a URL or filename to load the data from. |
|
793 | 791 | This always results in embedded image data. |
|
794 | 792 | url : unicode |
|
795 | 793 | A URL to download the data from. If you specify `url=`, |
|
796 | 794 | the image data will not be embedded unless you also specify `embed=True`. |
|
797 | 795 | filename : unicode |
|
798 | 796 | Path to a local file to load the data from. |
|
799 | 797 | Images from a file are always embedded. |
|
800 | 798 | format : unicode |
|
801 | 799 | The format of the image data (png/jpeg/jpg). If a filename or URL is given |
|
802 | 800 | for format will be inferred from the filename extension. |
|
803 | 801 | embed : bool |
|
804 | 802 | Should the image data be embedded using a data URI (True) or be |
|
805 | 803 | loaded using an <img> tag. Set this to True if you want the image |
|
806 | 804 | to be viewable later with no internet connection in the notebook. |
|
807 | 805 | |
|
808 | 806 | Default is `True`, unless the keyword argument `url` is set, then |
|
809 | 807 | default value is `False`. |
|
810 | 808 | |
|
811 | 809 | Note that QtConsole is not able to display images if `embed` is set to `False` |
|
812 | 810 | width : int |
|
813 | 811 | Width in pixels to which to constrain the image in html |
|
814 | 812 | height : int |
|
815 | 813 | Height in pixels to which to constrain the image in html |
|
816 | 814 | retina : bool |
|
817 | 815 | Automatically set the width and height to half of the measured |
|
818 | 816 | width and height. |
|
819 | 817 | This only works for embedded images because it reads the width/height |
|
820 | 818 | from image data. |
|
821 | 819 | For non-embedded images, you can just set the desired display width |
|
822 | 820 | and height directly. |
|
823 | 821 | unconfined: bool |
|
824 | 822 | Set unconfined=True to disable max-width confinement of the image. |
|
825 | 823 | metadata: dict |
|
826 | 824 | Specify extra metadata to attach to the image. |
|
827 | 825 | |
|
828 | 826 | Examples |
|
829 | 827 | -------- |
|
830 | 828 | # embedded image data, works in qtconsole and notebook |
|
831 | 829 | # when passed positionally, the first arg can be any of raw image data, |
|
832 | 830 | # a URL, or a filename from which to load image data. |
|
833 | 831 | # The result is always embedding image data for inline images. |
|
834 | 832 | Image('http://www.google.fr/images/srpr/logo3w.png') |
|
835 | 833 | Image('/path/to/image.jpg') |
|
836 | 834 | Image(b'RAW_PNG_DATA...') |
|
837 | 835 | |
|
838 | 836 | # Specifying Image(url=...) does not embed the image data, |
|
839 | 837 | # it only generates `<img>` tag with a link to the source. |
|
840 | 838 | # This will not work in the qtconsole or offline. |
|
841 | 839 | Image(url='http://www.google.fr/images/srpr/logo3w.png') |
|
842 | 840 | |
|
843 | 841 | """ |
|
844 | 842 | if filename is not None: |
|
845 | 843 | ext = self._find_ext(filename) |
|
846 | 844 | elif url is not None: |
|
847 | 845 | ext = self._find_ext(url) |
|
848 | 846 | elif data is None: |
|
849 | 847 | raise ValueError("No image data found. Expecting filename, url, or data.") |
|
850 | 848 | elif isinstance(data, str) and ( |
|
851 | 849 | data.startswith('http') or _safe_exists(data) |
|
852 | 850 | ): |
|
853 | 851 | ext = self._find_ext(data) |
|
854 | 852 | else: |
|
855 | 853 | ext = None |
|
856 | 854 | |
|
857 | 855 | if format is None: |
|
858 | 856 | if ext is not None: |
|
859 | 857 | if ext == u'jpg' or ext == u'jpeg': |
|
860 | 858 | format = self._FMT_JPEG |
|
861 | 859 | if ext == u'png': |
|
862 | 860 | format = self._FMT_PNG |
|
863 | 861 | else: |
|
864 | 862 | format = ext.lower() |
|
865 | 863 | elif isinstance(data, bytes): |
|
866 | 864 | # infer image type from image data header, |
|
867 | 865 | # only if format has not been specified. |
|
868 | 866 | if data[:2] == _JPEG: |
|
869 | 867 | format = self._FMT_JPEG |
|
870 | 868 | |
|
871 | 869 | # failed to detect format, default png |
|
872 | 870 | if format is None: |
|
873 | 871 | format = 'png' |
|
874 | 872 | |
|
875 | 873 | if format.lower() == 'jpg': |
|
876 | 874 | # jpg->jpeg |
|
877 | 875 | format = self._FMT_JPEG |
|
878 | 876 | |
|
879 | 877 | self.format = format.lower() |
|
880 | 878 | self.embed = embed if embed is not None else (url is None) |
|
881 | 879 | |
|
882 | 880 | if self.embed and self.format not in self._ACCEPTABLE_EMBEDDINGS: |
|
883 | 881 | raise ValueError("Cannot embed the '%s' image format" % (self.format)) |
|
884 | 882 | self.width = width |
|
885 | 883 | self.height = height |
|
886 | 884 | self.retina = retina |
|
887 | 885 | self.unconfined = unconfined |
|
888 | 886 | self.metadata = metadata |
|
889 | 887 | super(Image, self).__init__(data=data, url=url, filename=filename) |
|
890 | 888 | |
|
891 | 889 | if retina: |
|
892 | 890 | self._retina_shape() |
|
893 | 891 | |
|
894 | 892 | def _retina_shape(self): |
|
895 | 893 | """load pixel-doubled width and height from image data""" |
|
896 | 894 | if not self.embed: |
|
897 | 895 | return |
|
898 | 896 | if self.format == 'png': |
|
899 | 897 | w, h = _pngxy(self.data) |
|
900 | 898 | elif self.format == 'jpeg': |
|
901 | 899 | w, h = _jpegxy(self.data) |
|
902 | 900 | else: |
|
903 | 901 | # retina only supports png |
|
904 | 902 | return |
|
905 | 903 | self.width = w // 2 |
|
906 | 904 | self.height = h // 2 |
|
907 | 905 | |
|
908 | 906 | def reload(self): |
|
909 | 907 | """Reload the raw data from file or URL.""" |
|
910 | 908 | if self.embed: |
|
911 | 909 | super(Image,self).reload() |
|
912 | 910 | if self.retina: |
|
913 | 911 | self._retina_shape() |
|
914 | 912 | |
|
915 | 913 | def _repr_html_(self): |
|
916 | 914 | if not self.embed: |
|
917 | 915 | width = height = klass = '' |
|
918 | 916 | if self.width: |
|
919 | 917 | width = ' width="%d"' % self.width |
|
920 | 918 | if self.height: |
|
921 | 919 | height = ' height="%d"' % self.height |
|
922 | 920 | if self.unconfined: |
|
923 | 921 | klass = ' class="unconfined"' |
|
924 | 922 | return u'<img src="{url}"{width}{height}{klass}/>'.format( |
|
925 | 923 | url=self.url, |
|
926 | 924 | width=width, |
|
927 | 925 | height=height, |
|
928 | 926 | klass=klass, |
|
929 | 927 | ) |
|
930 | 928 | |
|
931 | 929 | def _data_and_metadata(self): |
|
932 | 930 | """shortcut for returning metadata with shape information, if defined""" |
|
933 | 931 | md = {} |
|
934 | 932 | if self.width: |
|
935 | 933 | md['width'] = self.width |
|
936 | 934 | if self.height: |
|
937 | 935 | md['height'] = self.height |
|
938 | 936 | if self.unconfined: |
|
939 | 937 | md['unconfined'] = self.unconfined |
|
940 | 938 | if self.metadata: |
|
941 | 939 | md.update(self.metadata) |
|
942 | 940 | if md: |
|
943 | 941 | return self.data, md |
|
944 | 942 | else: |
|
945 | 943 | return self.data |
|
946 | 944 | |
|
947 | 945 | def _repr_png_(self): |
|
948 | 946 | if self.embed and self.format == u'png': |
|
949 | 947 | return self._data_and_metadata() |
|
950 | 948 | |
|
951 | 949 | def _repr_jpeg_(self): |
|
952 | 950 | if self.embed and (self.format == u'jpeg' or self.format == u'jpg'): |
|
953 | 951 | return self._data_and_metadata() |
|
954 | 952 | |
|
955 | 953 | def _find_ext(self, s): |
|
956 | 954 | return s.split('.')[-1].lower() |
|
957 | 955 | |
|
958 | 956 | class Video(DisplayObject): |
|
959 | 957 | |
|
960 | 958 | def __init__(self, data=None, url=None, filename=None, embed=False, mimetype=None): |
|
961 | 959 | """Create a video object given raw data or an URL. |
|
962 | 960 | |
|
963 | 961 | When this object is returned by an input cell or passed to the |
|
964 | 962 | display function, it will result in the video being displayed |
|
965 | 963 | in the frontend. |
|
966 | 964 | |
|
967 | 965 | Parameters |
|
968 | 966 | ---------- |
|
969 | 967 | data : unicode, str or bytes |
|
970 | 968 | The raw video data or a URL or filename to load the data from. |
|
971 | 969 | Raw data will require passing `embed=True`. |
|
972 | 970 | url : unicode |
|
973 | 971 | A URL for the video. If you specify `url=`, |
|
974 | 972 | the image data will not be embedded. |
|
975 | 973 | filename : unicode |
|
976 | 974 | Path to a local file containing the video. |
|
977 | 975 | Will be interpreted as a local URL unless `embed=True`. |
|
978 | 976 | embed : bool |
|
979 | 977 | Should the video be embedded using a data URI (True) or be |
|
980 | 978 | loaded using a <video> tag (False). |
|
981 | 979 | |
|
982 | 980 | Since videos are large, embedding them should be avoided, if possible. |
|
983 | 981 | You must confirm embedding as your intention by passing `embed=True`. |
|
984 | 982 | |
|
985 | 983 | Local files can be displayed with URLs without embedding the content, via:: |
|
986 | 984 | |
|
987 | 985 | Video('./video.mp4') |
|
988 | 986 | |
|
989 | 987 | mimetype: unicode |
|
990 | 988 | Specify the mimetype for embedded videos. |
|
991 | 989 | Default will be guessed from file extension, if available. |
|
992 | 990 | |
|
993 | 991 | Examples |
|
994 | 992 | -------- |
|
995 | 993 | |
|
996 | 994 | Video('https://archive.org/download/Sita_Sings_the_Blues/Sita_Sings_the_Blues_small.mp4') |
|
997 | 995 | Video('path/to/video.mp4') |
|
998 | 996 | Video('path/to/video.mp4', embed=True) |
|
999 | 997 | Video(b'raw-videodata', embed=True) |
|
1000 | 998 | """ |
|
1001 | 999 | if url is None and isinstance(data, str) and data.startswith(('http:', 'https:')): |
|
1002 | 1000 | url = data |
|
1003 | 1001 | data = None |
|
1004 | 1002 | elif os.path.exists(data): |
|
1005 | 1003 | filename = data |
|
1006 | 1004 | data = None |
|
1007 | 1005 | |
|
1008 | 1006 | if data and not embed: |
|
1009 | 1007 | msg = ''.join([ |
|
1010 | 1008 | "To embed videos, you must pass embed=True ", |
|
1011 | 1009 | "(this may make your notebook files huge)\n", |
|
1012 | 1010 | "Consider passing Video(url='...')", |
|
1013 | 1011 | ]) |
|
1014 | 1012 | raise ValueError(msg) |
|
1015 | 1013 | |
|
1016 | 1014 | self.mimetype = mimetype |
|
1017 | 1015 | self.embed = embed |
|
1018 | 1016 | super(Video, self).__init__(data=data, url=url, filename=filename) |
|
1019 | 1017 | |
|
1020 | 1018 | def _repr_html_(self): |
|
1021 | 1019 | # External URLs and potentially local files are not embedded into the |
|
1022 | 1020 | # notebook output. |
|
1023 | 1021 | if not self.embed: |
|
1024 | 1022 | url = self.url if self.url is not None else self.filename |
|
1025 | 1023 | output = """<video src="{0}" controls> |
|
1026 | 1024 | Your browser does not support the <code>video</code> element. |
|
1027 | 1025 | </video>""".format(url) |
|
1028 | 1026 | return output |
|
1029 | 1027 | |
|
1030 | 1028 | # Embedded videos are base64-encoded. |
|
1031 | 1029 | mimetype = self.mimetype |
|
1032 | 1030 | if self.filename is not None: |
|
1033 | 1031 | if not mimetype: |
|
1034 | 1032 | mimetype, _ = mimetypes.guess_type(self.filename) |
|
1035 | 1033 | |
|
1036 | 1034 | with open(self.filename, 'rb') as f: |
|
1037 | 1035 | video = f.read() |
|
1038 | 1036 | else: |
|
1039 | 1037 | video = self.data |
|
1040 | 1038 | if isinstance(video, str): |
|
1041 | 1039 | # unicode input is already b64-encoded |
|
1042 | 1040 | b64_video = video |
|
1043 | 1041 | else: |
|
1044 | 1042 | b64_video = base64_encode(video).decode('ascii').rstrip() |
|
1045 | 1043 | |
|
1046 | 1044 | output = """<video controls> |
|
1047 | 1045 | <source src="data:{0};base64,{1}" type="{0}"> |
|
1048 | 1046 | Your browser does not support the video tag. |
|
1049 | 1047 | </video>""".format(mimetype, b64_video) |
|
1050 | 1048 | return output |
|
1051 | 1049 | |
|
1052 | 1050 | def reload(self): |
|
1053 | 1051 | # TODO |
|
1054 | 1052 | pass |
|
1055 | 1053 | |
|
1056 | 1054 | def _repr_png_(self): |
|
1057 | 1055 | # TODO |
|
1058 | 1056 | pass |
|
1059 | 1057 | def _repr_jpeg_(self): |
|
1060 | 1058 | # TODO |
|
1061 | 1059 | pass |
|
1062 | 1060 | |
|
1063 | 1061 | def clear_output(wait=False): |
|
1064 | 1062 | """Clear the output of the current cell receiving output. |
|
1065 | 1063 | |
|
1066 | 1064 | Parameters |
|
1067 | 1065 | ---------- |
|
1068 | 1066 | wait : bool [default: false] |
|
1069 | 1067 | Wait to clear the output until new output is available to replace it.""" |
|
1070 | 1068 | from IPython.core.interactiveshell import InteractiveShell |
|
1071 | 1069 | if InteractiveShell.initialized(): |
|
1072 | 1070 | InteractiveShell.instance().display_pub.clear_output(wait) |
|
1073 | 1071 | else: |
|
1074 | 1072 | print('\033[2K\r', end='') |
|
1075 | 1073 | sys.stdout.flush() |
|
1076 | 1074 | print('\033[2K\r', end='') |
|
1077 | 1075 | sys.stderr.flush() |
|
1078 | 1076 | |
|
1079 | 1077 | |
|
1080 | 1078 | @skip_doctest |
|
1081 | 1079 | def set_matplotlib_formats(*formats, **kwargs): |
|
1082 | 1080 | """Select figure formats for the inline backend. Optionally pass quality for JPEG. |
|
1083 | 1081 | |
|
1084 | 1082 | For example, this enables PNG and JPEG output with a JPEG quality of 90%:: |
|
1085 | 1083 | |
|
1086 | 1084 | In [1]: set_matplotlib_formats('png', 'jpeg', quality=90) |
|
1087 | 1085 | |
|
1088 | 1086 | To set this in your config files use the following:: |
|
1089 | 1087 | |
|
1090 | 1088 | c.InlineBackend.figure_formats = {'png', 'jpeg'} |
|
1091 | 1089 | c.InlineBackend.print_figure_kwargs.update({'quality' : 90}) |
|
1092 | 1090 | |
|
1093 | 1091 | Parameters |
|
1094 | 1092 | ---------- |
|
1095 | 1093 | *formats : strs |
|
1096 | 1094 | One or more figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'. |
|
1097 | 1095 | **kwargs : |
|
1098 | 1096 | Keyword args will be relayed to ``figure.canvas.print_figure``. |
|
1099 | 1097 | """ |
|
1100 | 1098 | from IPython.core.interactiveshell import InteractiveShell |
|
1101 | 1099 | from IPython.core.pylabtools import select_figure_formats |
|
1102 | 1100 | # build kwargs, starting with InlineBackend config |
|
1103 | 1101 | kw = {} |
|
1104 | 1102 | from ipykernel.pylab.config import InlineBackend |
|
1105 | 1103 | cfg = InlineBackend.instance() |
|
1106 | 1104 | kw.update(cfg.print_figure_kwargs) |
|
1107 | 1105 | kw.update(**kwargs) |
|
1108 | 1106 | shell = InteractiveShell.instance() |
|
1109 | 1107 | select_figure_formats(shell, formats, **kw) |
|
1110 | 1108 | |
|
1111 | 1109 | @skip_doctest |
|
1112 | 1110 | def set_matplotlib_close(close=True): |
|
1113 | 1111 | """Set whether the inline backend closes all figures automatically or not. |
|
1114 | 1112 | |
|
1115 | 1113 | By default, the inline backend used in the IPython Notebook will close all |
|
1116 | 1114 | matplotlib figures automatically after each cell is run. This means that |
|
1117 | 1115 | plots in different cells won't interfere. Sometimes, you may want to make |
|
1118 | 1116 | a plot in one cell and then refine it in later cells. This can be accomplished |
|
1119 | 1117 | by:: |
|
1120 | 1118 | |
|
1121 | 1119 | In [1]: set_matplotlib_close(False) |
|
1122 | 1120 | |
|
1123 | 1121 | To set this in your config files use the following:: |
|
1124 | 1122 | |
|
1125 | 1123 | c.InlineBackend.close_figures = False |
|
1126 | 1124 | |
|
1127 | 1125 | Parameters |
|
1128 | 1126 | ---------- |
|
1129 | 1127 | close : bool |
|
1130 | 1128 | Should all matplotlib figures be automatically closed after each cell is |
|
1131 | 1129 | run? |
|
1132 | 1130 | """ |
|
1133 | 1131 | from ipykernel.pylab.config import InlineBackend |
|
1134 | 1132 | cfg = InlineBackend.instance() |
|
1135 | 1133 | cfg.close_figures = close |
@@ -1,174 +1,170 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """A class for managing IPython extensions.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | import os |
|
8 | 8 | from shutil import copyfile |
|
9 | 9 | import sys |
|
10 | 10 | from importlib import import_module |
|
11 | 11 | |
|
12 | 12 | from traitlets.config.configurable import Configurable |
|
13 | 13 | from IPython.utils.path import ensure_dir_exists |
|
14 | 14 | from traitlets import Instance |
|
15 | 15 | |
|
16 | 16 | try: |
|
17 | 17 | from importlib import reload |
|
18 | 18 | except ImportError : |
|
19 | 19 | ## deprecated since 3.4 |
|
20 | 20 | from imp import reload |
|
21 | 21 | |
|
22 | 22 | #----------------------------------------------------------------------------- |
|
23 | 23 | # Main class |
|
24 | 24 | #----------------------------------------------------------------------------- |
|
25 | 25 | |
|
26 | 26 | class ExtensionManager(Configurable): |
|
27 | 27 | """A class to manage IPython extensions. |
|
28 | 28 | |
|
29 | 29 | An IPython extension is an importable Python module that has |
|
30 | 30 | a function with the signature:: |
|
31 | 31 | |
|
32 | 32 | def load_ipython_extension(ipython): |
|
33 | 33 | # Do things with ipython |
|
34 | 34 | |
|
35 | 35 | This function is called after your extension is imported and the |
|
36 | 36 | currently active :class:`InteractiveShell` instance is passed as |
|
37 | 37 | the only argument. You can do anything you want with IPython at |
|
38 | 38 | that point, including defining new magic and aliases, adding new |
|
39 | 39 | components, etc. |
|
40 | 40 | |
|
41 | 41 | You can also optionally define an :func:`unload_ipython_extension(ipython)` |
|
42 | 42 | function, which will be called if the user unloads or reloads the extension. |
|
43 | 43 | The extension manager will only call :func:`load_ipython_extension` again |
|
44 | 44 | if the extension is reloaded. |
|
45 | 45 | |
|
46 | 46 | You can put your extension modules anywhere you want, as long as |
|
47 | 47 | they can be imported by Python's standard import mechanism. However, |
|
48 | 48 | to make it easy to write extensions, you can also put your extensions |
|
49 | 49 | in ``os.path.join(self.ipython_dir, 'extensions')``. This directory |
|
50 | 50 | is added to ``sys.path`` automatically. |
|
51 | 51 | """ |
|
52 | 52 | |
|
53 | 53 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) |
|
54 | 54 | |
|
55 | 55 | def __init__(self, shell=None, **kwargs): |
|
56 | 56 | super(ExtensionManager, self).__init__(shell=shell, **kwargs) |
|
57 | 57 | self.shell.observe( |
|
58 | 58 | self._on_ipython_dir_changed, names=('ipython_dir',) |
|
59 | 59 | ) |
|
60 | 60 | self.loaded = set() |
|
61 | 61 | |
|
62 | 62 | @property |
|
63 | 63 | def ipython_extension_dir(self): |
|
64 | 64 | return os.path.join(self.shell.ipython_dir, u'extensions') |
|
65 | 65 | |
|
66 | 66 | def _on_ipython_dir_changed(self, change): |
|
67 | 67 | ensure_dir_exists(self.ipython_extension_dir) |
|
68 | 68 | |
|
69 | 69 | def load_extension(self, module_str): |
|
70 | 70 | """Load an IPython extension by its module name. |
|
71 | 71 | |
|
72 | 72 | Returns the string "already loaded" if the extension is already loaded, |
|
73 | 73 | "no load function" if the module doesn't have a load_ipython_extension |
|
74 | 74 | function, or None if it succeeded. |
|
75 | 75 | """ |
|
76 | 76 | if module_str in self.loaded: |
|
77 | 77 | return "already loaded" |
|
78 | 78 | |
|
79 | 79 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
80 | 80 | |
|
81 | 81 | with self.shell.builtin_trap: |
|
82 | 82 | if module_str not in sys.modules: |
|
83 | 83 | with prepended_to_syspath(self.ipython_extension_dir): |
|
84 | 84 | import_module(module_str) |
|
85 | 85 | mod = sys.modules[module_str] |
|
86 | 86 | if self._call_load_ipython_extension(mod): |
|
87 | 87 | self.loaded.add(module_str) |
|
88 | 88 | else: |
|
89 | 89 | return "no load function" |
|
90 | 90 | |
|
91 | 91 | def unload_extension(self, module_str): |
|
92 | 92 | """Unload an IPython extension by its module name. |
|
93 | 93 | |
|
94 | 94 | This function looks up the extension's name in ``sys.modules`` and |
|
95 | 95 | simply calls ``mod.unload_ipython_extension(self)``. |
|
96 | 96 | |
|
97 | 97 | Returns the string "no unload function" if the extension doesn't define |
|
98 | 98 | a function to unload itself, "not loaded" if the extension isn't loaded, |
|
99 | 99 | otherwise None. |
|
100 | 100 | """ |
|
101 | 101 | if module_str not in self.loaded: |
|
102 | 102 | return "not loaded" |
|
103 | 103 | |
|
104 | 104 | if module_str in sys.modules: |
|
105 | 105 | mod = sys.modules[module_str] |
|
106 | 106 | if self._call_unload_ipython_extension(mod): |
|
107 | 107 | self.loaded.discard(module_str) |
|
108 | 108 | else: |
|
109 | 109 | return "no unload function" |
|
110 | 110 | |
|
111 | 111 | def reload_extension(self, module_str): |
|
112 | 112 | """Reload an IPython extension by calling reload. |
|
113 | 113 | |
|
114 | 114 | If the module has not been loaded before, |
|
115 | 115 | :meth:`InteractiveShell.load_extension` is called. Otherwise |
|
116 | 116 | :func:`reload` is called and then the :func:`load_ipython_extension` |
|
117 | 117 | function of the module, if it exists is called. |
|
118 | 118 | """ |
|
119 | 119 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
120 | 120 | |
|
121 | 121 | if (module_str in self.loaded) and (module_str in sys.modules): |
|
122 | 122 | self.unload_extension(module_str) |
|
123 | 123 | mod = sys.modules[module_str] |
|
124 | 124 | with prepended_to_syspath(self.ipython_extension_dir): |
|
125 | 125 | reload(mod) |
|
126 | 126 | if self._call_load_ipython_extension(mod): |
|
127 | 127 | self.loaded.add(module_str) |
|
128 | 128 | else: |
|
129 | 129 | self.load_extension(module_str) |
|
130 | 130 | |
|
131 | 131 | def _call_load_ipython_extension(self, mod): |
|
132 | 132 | if hasattr(mod, 'load_ipython_extension'): |
|
133 | 133 | mod.load_ipython_extension(self.shell) |
|
134 | 134 | return True |
|
135 | 135 | |
|
136 | 136 | def _call_unload_ipython_extension(self, mod): |
|
137 | 137 | if hasattr(mod, 'unload_ipython_extension'): |
|
138 | 138 | mod.unload_ipython_extension(self.shell) |
|
139 | 139 | return True |
|
140 | 140 | |
|
141 | 141 | def install_extension(self, url, filename=None): |
|
142 | 142 | """Download and install an IPython extension. |
|
143 | 143 | |
|
144 | 144 | If filename is given, the file will be so named (inside the extension |
|
145 | 145 | directory). Otherwise, the name from the URL will be used. The file must |
|
146 | 146 | have a .py or .zip extension; otherwise, a ValueError will be raised. |
|
147 | 147 | |
|
148 | 148 | Returns the full path to the installed file. |
|
149 | 149 | """ |
|
150 | 150 | # Ensure the extension directory exists |
|
151 | 151 | ensure_dir_exists(self.ipython_extension_dir) |
|
152 | 152 | |
|
153 | 153 | if os.path.isfile(url): |
|
154 | 154 | src_filename = os.path.basename(url) |
|
155 | 155 | copy = copyfile |
|
156 | 156 | else: |
|
157 | 157 | # Deferred imports |
|
158 | try: | |
|
159 |
|
|
|
160 | from urllib.request import urlretrieve | |
|
161 | except ImportError: | |
|
162 | from urlparse import urlparse | |
|
163 | from urllib import urlretrieve | |
|
158 | from urllib.parse import urlparse | |
|
159 | from urllib.request import urlretrieve | |
|
164 | 160 | src_filename = urlparse(url).path.split('/')[-1] |
|
165 | 161 | copy = urlretrieve |
|
166 | 162 | |
|
167 | 163 | if filename is None: |
|
168 | 164 | filename = src_filename |
|
169 | 165 | if os.path.splitext(filename)[1] not in ('.py', '.zip'): |
|
170 | 166 | raise ValueError("The file must have a .py or .zip extension", filename) |
|
171 | 167 | |
|
172 | 168 | filename = os.path.join(self.ipython_extension_dir, filename) |
|
173 | 169 | copy(url, filename) |
|
174 | 170 | return filename |
@@ -1,3223 +1,3220 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Main IPython class.""" |
|
3 | 3 | |
|
4 | 4 | #----------------------------------------------------------------------------- |
|
5 | 5 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> |
|
6 | 6 | # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu> |
|
7 | 7 | # Copyright (C) 2008-2011 The IPython Development Team |
|
8 | 8 | # |
|
9 | 9 | # Distributed under the terms of the BSD License. The full license is in |
|
10 | 10 | # the file COPYING, distributed as part of this software. |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | |
|
13 | 13 | |
|
14 | 14 | import __future__ |
|
15 | 15 | import abc |
|
16 | 16 | import ast |
|
17 | 17 | import atexit |
|
18 | 18 | import functools |
|
19 | 19 | import os |
|
20 | 20 | import re |
|
21 | 21 | import runpy |
|
22 | 22 | import sys |
|
23 | 23 | import tempfile |
|
24 | 24 | import traceback |
|
25 | 25 | import types |
|
26 | 26 | import subprocess |
|
27 | 27 | import warnings |
|
28 | 28 | from io import open as io_open |
|
29 | 29 | |
|
30 | 30 | from pickleshare import PickleShareDB |
|
31 | 31 | |
|
32 | 32 | from traitlets.config.configurable import SingletonConfigurable |
|
33 | 33 | from IPython.core import oinspect |
|
34 | 34 | from IPython.core import magic |
|
35 | 35 | from IPython.core import page |
|
36 | 36 | from IPython.core import prefilter |
|
37 | 37 | from IPython.core import shadowns |
|
38 | 38 | from IPython.core import ultratb |
|
39 | 39 | from IPython.core.alias import Alias, AliasManager |
|
40 | 40 | from IPython.core.autocall import ExitAutocall |
|
41 | 41 | from IPython.core.builtin_trap import BuiltinTrap |
|
42 | 42 | from IPython.core.events import EventManager, available_events |
|
43 | 43 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
44 | 44 | from IPython.core.debugger import Pdb |
|
45 | 45 | from IPython.core.display_trap import DisplayTrap |
|
46 | 46 | from IPython.core.displayhook import DisplayHook |
|
47 | 47 | from IPython.core.displaypub import DisplayPublisher |
|
48 | 48 | from IPython.core.error import InputRejected, UsageError |
|
49 | 49 | from IPython.core.extensions import ExtensionManager |
|
50 | 50 | from IPython.core.formatters import DisplayFormatter |
|
51 | 51 | from IPython.core.history import HistoryManager |
|
52 | 52 | from IPython.core.inputsplitter import ESC_MAGIC, ESC_MAGIC2 |
|
53 | 53 | from IPython.core.logger import Logger |
|
54 | 54 | from IPython.core.macro import Macro |
|
55 | 55 | from IPython.core.payload import PayloadManager |
|
56 | 56 | from IPython.core.prefilter import PrefilterManager |
|
57 | 57 | from IPython.core.profiledir import ProfileDir |
|
58 | 58 | from IPython.core.usage import default_banner |
|
59 | 59 | from IPython.testing.skipdoctest import skip_doctest |
|
60 | 60 | from IPython.utils import PyColorize |
|
61 | 61 | from IPython.utils import io |
|
62 | 62 | from IPython.utils import py3compat |
|
63 | 63 | from IPython.utils import openpy |
|
64 | 64 | from IPython.utils.decorators import undoc |
|
65 | 65 | from IPython.utils.io import ask_yes_no |
|
66 | 66 | from IPython.utils.ipstruct import Struct |
|
67 | 67 | from IPython.paths import get_ipython_dir |
|
68 | 68 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
69 | 69 | from IPython.utils.process import system, getoutput |
|
70 | 70 | from IPython.utils.py3compat import builtin_mod, with_metaclass |
|
71 | 71 | from IPython.utils.strdispatch import StrDispatch |
|
72 | 72 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
73 | 73 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
74 | 74 | from IPython.utils.tempdir import TemporaryDirectory |
|
75 | 75 | from traitlets import ( |
|
76 | 76 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
77 | 77 | observe, default, |
|
78 | 78 | ) |
|
79 | 79 | from warnings import warn |
|
80 | 80 | from logging import error |
|
81 | 81 | import IPython.core.hooks |
|
82 | 82 | |
|
83 | 83 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
84 | 84 | # See https://github.com/ipython/ipykernel/issues/157 |
|
85 | 85 | from IPython.utils.contexts import NoOpContext |
|
86 | 86 | |
|
87 | 87 | try: |
|
88 | 88 | import docrepr.sphinxify as sphx |
|
89 | 89 | |
|
90 | 90 | def sphinxify(doc): |
|
91 | 91 | with TemporaryDirectory() as dirname: |
|
92 | 92 | return { |
|
93 | 93 | 'text/html': sphx.sphinxify(doc, dirname), |
|
94 | 94 | 'text/plain': doc |
|
95 | 95 | } |
|
96 | 96 | except ImportError: |
|
97 | 97 | sphinxify = None |
|
98 | 98 | |
|
99 | 99 | |
|
100 | 100 | class ProvisionalWarning(DeprecationWarning): |
|
101 | 101 | """ |
|
102 | 102 | Warning class for unstable features |
|
103 | 103 | """ |
|
104 | 104 | pass |
|
105 | 105 | |
|
106 | 106 | #----------------------------------------------------------------------------- |
|
107 | 107 | # Globals |
|
108 | 108 | #----------------------------------------------------------------------------- |
|
109 | 109 | |
|
110 | 110 | # compiled regexps for autoindent management |
|
111 | 111 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
112 | 112 | |
|
113 | 113 | #----------------------------------------------------------------------------- |
|
114 | 114 | # Utilities |
|
115 | 115 | #----------------------------------------------------------------------------- |
|
116 | 116 | |
|
117 | 117 | @undoc |
|
118 | 118 | def softspace(file, newvalue): |
|
119 | 119 | """Copied from code.py, to remove the dependency""" |
|
120 | 120 | |
|
121 | 121 | oldvalue = 0 |
|
122 | 122 | try: |
|
123 | 123 | oldvalue = file.softspace |
|
124 | 124 | except AttributeError: |
|
125 | 125 | pass |
|
126 | 126 | try: |
|
127 | 127 | file.softspace = newvalue |
|
128 | 128 | except (AttributeError, TypeError): |
|
129 | 129 | # "attribute-less object" or "read-only attributes" |
|
130 | 130 | pass |
|
131 | 131 | return oldvalue |
|
132 | 132 | |
|
133 | 133 | @undoc |
|
134 | 134 | def no_op(*a, **kw): pass |
|
135 | 135 | |
|
136 | 136 | |
|
137 | 137 | class SpaceInInput(Exception): pass |
|
138 | 138 | |
|
139 | 139 | |
|
140 | 140 | def get_default_colors(): |
|
141 | 141 | "DEPRECATED" |
|
142 | 142 | warn('get_default_color is Deprecated, and is `Neutral` on all platforms.', |
|
143 | 143 | DeprecationWarning, stacklevel=2) |
|
144 | 144 | return 'Neutral' |
|
145 | 145 | |
|
146 | 146 | |
|
147 | 147 | class SeparateUnicode(Unicode): |
|
148 | 148 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
149 | 149 | |
|
150 | 150 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
151 | 151 | """ |
|
152 | 152 | |
|
153 | 153 | def validate(self, obj, value): |
|
154 | 154 | if value == '0': value = '' |
|
155 | 155 | value = value.replace('\\n','\n') |
|
156 | 156 | return super(SeparateUnicode, self).validate(obj, value) |
|
157 | 157 | |
|
158 | 158 | |
|
159 | 159 | @undoc |
|
160 | 160 | class DummyMod(object): |
|
161 | 161 | """A dummy module used for IPython's interactive module when |
|
162 | 162 | a namespace must be assigned to the module's __dict__.""" |
|
163 | 163 | pass |
|
164 | 164 | |
|
165 | 165 | |
|
166 | 166 | class ExecutionResult(object): |
|
167 | 167 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
168 | 168 | |
|
169 | 169 | Stores information about what took place. |
|
170 | 170 | """ |
|
171 | 171 | execution_count = None |
|
172 | 172 | error_before_exec = None |
|
173 | 173 | error_in_exec = None |
|
174 | 174 | result = None |
|
175 | 175 | |
|
176 | 176 | @property |
|
177 | 177 | def success(self): |
|
178 | 178 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
179 | 179 | |
|
180 | 180 | def raise_error(self): |
|
181 | 181 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
182 | 182 | if self.error_before_exec is not None: |
|
183 | 183 | raise self.error_before_exec |
|
184 | 184 | if self.error_in_exec is not None: |
|
185 | 185 | raise self.error_in_exec |
|
186 | 186 | |
|
187 | 187 | def __repr__(self): |
|
188 | 188 | name = self.__class__.__qualname__ |
|
189 | 189 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s result=%s>' %\ |
|
190 | 190 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.result)) |
|
191 | 191 | |
|
192 | 192 | |
|
193 | 193 | class InteractiveShell(SingletonConfigurable): |
|
194 | 194 | """An enhanced, interactive shell for Python.""" |
|
195 | 195 | |
|
196 | 196 | _instance = None |
|
197 | 197 | |
|
198 | 198 | ast_transformers = List([], help= |
|
199 | 199 | """ |
|
200 | 200 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
201 | 201 | to user input before code is run. |
|
202 | 202 | """ |
|
203 | 203 | ).tag(config=True) |
|
204 | 204 | |
|
205 | 205 | autocall = Enum((0,1,2), default_value=0, help= |
|
206 | 206 | """ |
|
207 | 207 | Make IPython automatically call any callable object even if you didn't |
|
208 | 208 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
209 | 209 | automatically. The value can be '0' to disable the feature, '1' for |
|
210 | 210 | 'smart' autocall, where it is not applied if there are no more |
|
211 | 211 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
212 | 212 | objects are automatically called (even if no arguments are present). |
|
213 | 213 | """ |
|
214 | 214 | ).tag(config=True) |
|
215 | 215 | # TODO: remove all autoindent logic and put into frontends. |
|
216 | 216 | # We can't do this yet because even runlines uses the autoindent. |
|
217 | 217 | autoindent = Bool(True, help= |
|
218 | 218 | """ |
|
219 | 219 | Autoindent IPython code entered interactively. |
|
220 | 220 | """ |
|
221 | 221 | ).tag(config=True) |
|
222 | 222 | |
|
223 | 223 | automagic = Bool(True, help= |
|
224 | 224 | """ |
|
225 | 225 | Enable magic commands to be called without the leading %. |
|
226 | 226 | """ |
|
227 | 227 | ).tag(config=True) |
|
228 | 228 | |
|
229 | 229 | banner1 = Unicode(default_banner, |
|
230 | 230 | help="""The part of the banner to be printed before the profile""" |
|
231 | 231 | ).tag(config=True) |
|
232 | 232 | banner2 = Unicode('', |
|
233 | 233 | help="""The part of the banner to be printed after the profile""" |
|
234 | 234 | ).tag(config=True) |
|
235 | 235 | |
|
236 | 236 | cache_size = Integer(1000, help= |
|
237 | 237 | """ |
|
238 | 238 | Set the size of the output cache. The default is 1000, you can |
|
239 | 239 | change it permanently in your config file. Setting it to 0 completely |
|
240 | 240 | disables the caching system, and the minimum value accepted is 20 (if |
|
241 | 241 | you provide a value less than 20, it is reset to 0 and a warning is |
|
242 | 242 | issued). This limit is defined because otherwise you'll spend more |
|
243 | 243 | time re-flushing a too small cache than working |
|
244 | 244 | """ |
|
245 | 245 | ).tag(config=True) |
|
246 | 246 | color_info = Bool(True, help= |
|
247 | 247 | """ |
|
248 | 248 | Use colors for displaying information about objects. Because this |
|
249 | 249 | information is passed through a pager (like 'less'), and some pagers |
|
250 | 250 | get confused with color codes, this capability can be turned off. |
|
251 | 251 | """ |
|
252 | 252 | ).tag(config=True) |
|
253 | 253 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
254 | 254 | default_value='Neutral', |
|
255 | 255 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
256 | 256 | ).tag(config=True) |
|
257 | 257 | debug = Bool(False).tag(config=True) |
|
258 | 258 | disable_failing_post_execute = Bool(False, |
|
259 | 259 | help="Don't call post-execute functions that have failed in the past." |
|
260 | 260 | ).tag(config=True) |
|
261 | 261 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
262 | 262 | displayhook_class = Type(DisplayHook) |
|
263 | 263 | display_pub_class = Type(DisplayPublisher) |
|
264 | 264 | |
|
265 | 265 | sphinxify_docstring = Bool(False, help= |
|
266 | 266 | """ |
|
267 | 267 | Enables rich html representation of docstrings. (This requires the |
|
268 | 268 | docrepr module). |
|
269 | 269 | """).tag(config=True) |
|
270 | 270 | |
|
271 | 271 | @observe("sphinxify_docstring") |
|
272 | 272 | def _sphinxify_docstring_changed(self, change): |
|
273 | 273 | if change['new']: |
|
274 | 274 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
275 | 275 | |
|
276 | 276 | enable_html_pager = Bool(False, help= |
|
277 | 277 | """ |
|
278 | 278 | (Provisional API) enables html representation in mime bundles sent |
|
279 | 279 | to pagers. |
|
280 | 280 | """).tag(config=True) |
|
281 | 281 | |
|
282 | 282 | @observe("enable_html_pager") |
|
283 | 283 | def _enable_html_pager_changed(self, change): |
|
284 | 284 | if change['new']: |
|
285 | 285 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
286 | 286 | |
|
287 | 287 | data_pub_class = None |
|
288 | 288 | |
|
289 | 289 | exit_now = Bool(False) |
|
290 | 290 | exiter = Instance(ExitAutocall) |
|
291 | 291 | @default('exiter') |
|
292 | 292 | def _exiter_default(self): |
|
293 | 293 | return ExitAutocall(self) |
|
294 | 294 | # Monotonically increasing execution counter |
|
295 | 295 | execution_count = Integer(1) |
|
296 | 296 | filename = Unicode("<ipython console>") |
|
297 | 297 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
298 | 298 | |
|
299 | 299 | # Input splitter, to transform input line by line and detect when a block |
|
300 | 300 | # is ready to be executed. |
|
301 | 301 | input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
302 | 302 | (), {'line_input_checker': True}) |
|
303 | 303 | |
|
304 | 304 | # This InputSplitter instance is used to transform completed cells before |
|
305 | 305 | # running them. It allows cell magics to contain blank lines. |
|
306 | 306 | input_transformer_manager = Instance('IPython.core.inputsplitter.IPythonInputSplitter', |
|
307 | 307 | (), {'line_input_checker': False}) |
|
308 | 308 | |
|
309 | 309 | logstart = Bool(False, help= |
|
310 | 310 | """ |
|
311 | 311 | Start logging to the default log file in overwrite mode. |
|
312 | 312 | Use `logappend` to specify a log file to **append** logs to. |
|
313 | 313 | """ |
|
314 | 314 | ).tag(config=True) |
|
315 | 315 | logfile = Unicode('', help= |
|
316 | 316 | """ |
|
317 | 317 | The name of the logfile to use. |
|
318 | 318 | """ |
|
319 | 319 | ).tag(config=True) |
|
320 | 320 | logappend = Unicode('', help= |
|
321 | 321 | """ |
|
322 | 322 | Start logging to the given file in append mode. |
|
323 | 323 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
324 | 324 | """ |
|
325 | 325 | ).tag(config=True) |
|
326 | 326 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
327 | 327 | ).tag(config=True) |
|
328 | 328 | pdb = Bool(False, help= |
|
329 | 329 | """ |
|
330 | 330 | Automatically call the pdb debugger after every exception. |
|
331 | 331 | """ |
|
332 | 332 | ).tag(config=True) |
|
333 | 333 | display_page = Bool(False, |
|
334 | 334 | help="""If True, anything that would be passed to the pager |
|
335 | 335 | will be displayed as regular output instead.""" |
|
336 | 336 | ).tag(config=True) |
|
337 | 337 | |
|
338 | 338 | # deprecated prompt traits: |
|
339 | 339 | |
|
340 | 340 | prompt_in1 = Unicode('In [\\#]: ', |
|
341 | 341 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
342 | 342 | ).tag(config=True) |
|
343 | 343 | prompt_in2 = Unicode(' .\\D.: ', |
|
344 | 344 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
345 | 345 | ).tag(config=True) |
|
346 | 346 | prompt_out = Unicode('Out[\\#]: ', |
|
347 | 347 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
348 | 348 | ).tag(config=True) |
|
349 | 349 | prompts_pad_left = Bool(True, |
|
350 | 350 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
351 | 351 | ).tag(config=True) |
|
352 | 352 | |
|
353 | 353 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
354 | 354 | def _prompt_trait_changed(self, change): |
|
355 | 355 | name = change['name'] |
|
356 | 356 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
357 | 357 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
358 | 358 | " object directly.".format(name=name)) |
|
359 | 359 | |
|
360 | 360 | # protect against weird cases where self.config may not exist: |
|
361 | 361 | |
|
362 | 362 | show_rewritten_input = Bool(True, |
|
363 | 363 | help="Show rewritten input, e.g. for autocall." |
|
364 | 364 | ).tag(config=True) |
|
365 | 365 | |
|
366 | 366 | quiet = Bool(False).tag(config=True) |
|
367 | 367 | |
|
368 | 368 | history_length = Integer(10000, |
|
369 | 369 | help='Total length of command history' |
|
370 | 370 | ).tag(config=True) |
|
371 | 371 | |
|
372 | 372 | history_load_length = Integer(1000, help= |
|
373 | 373 | """ |
|
374 | 374 | The number of saved history entries to be loaded |
|
375 | 375 | into the history buffer at startup. |
|
376 | 376 | """ |
|
377 | 377 | ).tag(config=True) |
|
378 | 378 | |
|
379 | 379 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none'], |
|
380 | 380 | default_value='last_expr', |
|
381 | 381 | help=""" |
|
382 | 382 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
383 | 383 | run interactively (displaying output from expressions).""" |
|
384 | 384 | ).tag(config=True) |
|
385 | 385 | |
|
386 | 386 | # TODO: this part of prompt management should be moved to the frontends. |
|
387 | 387 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
388 | 388 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
389 | 389 | separate_out = SeparateUnicode('').tag(config=True) |
|
390 | 390 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
391 | 391 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
392 | 392 | xmode = CaselessStrEnum(('Context','Plain', 'Verbose'), |
|
393 | 393 | default_value='Context').tag(config=True) |
|
394 | 394 | |
|
395 | 395 | # Subcomponents of InteractiveShell |
|
396 | 396 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
397 | 397 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
398 | 398 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
399 | 399 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
400 | 400 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
401 | 401 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
402 | 402 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
403 | 403 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
404 | 404 | |
|
405 | 405 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
406 | 406 | @property |
|
407 | 407 | def profile(self): |
|
408 | 408 | if self.profile_dir is not None: |
|
409 | 409 | name = os.path.basename(self.profile_dir.location) |
|
410 | 410 | return name.replace('profile_','') |
|
411 | 411 | |
|
412 | 412 | |
|
413 | 413 | # Private interface |
|
414 | 414 | _post_execute = Dict() |
|
415 | 415 | |
|
416 | 416 | # Tracks any GUI loop loaded for pylab |
|
417 | 417 | pylab_gui_select = None |
|
418 | 418 | |
|
419 | 419 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
420 | 420 | |
|
421 | 421 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
422 | 422 | user_module=None, user_ns=None, |
|
423 | 423 | custom_exceptions=((), None), **kwargs): |
|
424 | 424 | |
|
425 | 425 | # This is where traits with a config_key argument are updated |
|
426 | 426 | # from the values on config. |
|
427 | 427 | super(InteractiveShell, self).__init__(**kwargs) |
|
428 | 428 | if 'PromptManager' in self.config: |
|
429 | 429 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
430 | 430 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
431 | 431 | self.configurables = [self] |
|
432 | 432 | |
|
433 | 433 | # These are relatively independent and stateless |
|
434 | 434 | self.init_ipython_dir(ipython_dir) |
|
435 | 435 | self.init_profile_dir(profile_dir) |
|
436 | 436 | self.init_instance_attrs() |
|
437 | 437 | self.init_environment() |
|
438 | 438 | |
|
439 | 439 | # Check if we're in a virtualenv, and set up sys.path. |
|
440 | 440 | self.init_virtualenv() |
|
441 | 441 | |
|
442 | 442 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
443 | 443 | self.init_create_namespaces(user_module, user_ns) |
|
444 | 444 | # This has to be done after init_create_namespaces because it uses |
|
445 | 445 | # something in self.user_ns, but before init_sys_modules, which |
|
446 | 446 | # is the first thing to modify sys. |
|
447 | 447 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
448 | 448 | # is created, we are saving the overridden ones here. Not sure if this |
|
449 | 449 | # is what we want to do. |
|
450 | 450 | self.save_sys_module_state() |
|
451 | 451 | self.init_sys_modules() |
|
452 | 452 | |
|
453 | 453 | # While we're trying to have each part of the code directly access what |
|
454 | 454 | # it needs without keeping redundant references to objects, we have too |
|
455 | 455 | # much legacy code that expects ip.db to exist. |
|
456 | 456 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
457 | 457 | |
|
458 | 458 | self.init_history() |
|
459 | 459 | self.init_encoding() |
|
460 | 460 | self.init_prefilter() |
|
461 | 461 | |
|
462 | 462 | self.init_syntax_highlighting() |
|
463 | 463 | self.init_hooks() |
|
464 | 464 | self.init_events() |
|
465 | 465 | self.init_pushd_popd_magic() |
|
466 | 466 | self.init_user_ns() |
|
467 | 467 | self.init_logger() |
|
468 | 468 | self.init_builtins() |
|
469 | 469 | |
|
470 | 470 | # The following was in post_config_initialization |
|
471 | 471 | self.init_inspector() |
|
472 | 472 | self.raw_input_original = input |
|
473 | 473 | self.init_completer() |
|
474 | 474 | # TODO: init_io() needs to happen before init_traceback handlers |
|
475 | 475 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
476 | 476 | # This logic in in debugger.Pdb and should eventually be changed. |
|
477 | 477 | self.init_io() |
|
478 | 478 | self.init_traceback_handlers(custom_exceptions) |
|
479 | 479 | self.init_prompts() |
|
480 | 480 | self.init_display_formatter() |
|
481 | 481 | self.init_display_pub() |
|
482 | 482 | self.init_data_pub() |
|
483 | 483 | self.init_displayhook() |
|
484 | 484 | self.init_magics() |
|
485 | 485 | self.init_alias() |
|
486 | 486 | self.init_logstart() |
|
487 | 487 | self.init_pdb() |
|
488 | 488 | self.init_extension_manager() |
|
489 | 489 | self.init_payload() |
|
490 | 490 | self.init_deprecation_warnings() |
|
491 | 491 | self.hooks.late_startup_hook() |
|
492 | 492 | self.events.trigger('shell_initialized', self) |
|
493 | 493 | atexit.register(self.atexit_operations) |
|
494 | 494 | |
|
495 | 495 | def get_ipython(self): |
|
496 | 496 | """Return the currently running IPython instance.""" |
|
497 | 497 | return self |
|
498 | 498 | |
|
499 | 499 | #------------------------------------------------------------------------- |
|
500 | 500 | # Trait changed handlers |
|
501 | 501 | #------------------------------------------------------------------------- |
|
502 | 502 | @observe('ipython_dir') |
|
503 | 503 | def _ipython_dir_changed(self, change): |
|
504 | 504 | ensure_dir_exists(change['new']) |
|
505 | 505 | |
|
506 | 506 | def set_autoindent(self,value=None): |
|
507 | 507 | """Set the autoindent flag. |
|
508 | 508 | |
|
509 | 509 | If called with no arguments, it acts as a toggle.""" |
|
510 | 510 | if value is None: |
|
511 | 511 | self.autoindent = not self.autoindent |
|
512 | 512 | else: |
|
513 | 513 | self.autoindent = value |
|
514 | 514 | |
|
515 | 515 | #------------------------------------------------------------------------- |
|
516 | 516 | # init_* methods called by __init__ |
|
517 | 517 | #------------------------------------------------------------------------- |
|
518 | 518 | |
|
519 | 519 | def init_ipython_dir(self, ipython_dir): |
|
520 | 520 | if ipython_dir is not None: |
|
521 | 521 | self.ipython_dir = ipython_dir |
|
522 | 522 | return |
|
523 | 523 | |
|
524 | 524 | self.ipython_dir = get_ipython_dir() |
|
525 | 525 | |
|
526 | 526 | def init_profile_dir(self, profile_dir): |
|
527 | 527 | if profile_dir is not None: |
|
528 | 528 | self.profile_dir = profile_dir |
|
529 | 529 | return |
|
530 | 530 | self.profile_dir =\ |
|
531 | 531 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
532 | 532 | |
|
533 | 533 | def init_instance_attrs(self): |
|
534 | 534 | self.more = False |
|
535 | 535 | |
|
536 | 536 | # command compiler |
|
537 | 537 | self.compile = CachingCompiler() |
|
538 | 538 | |
|
539 | 539 | # Make an empty namespace, which extension writers can rely on both |
|
540 | 540 | # existing and NEVER being used by ipython itself. This gives them a |
|
541 | 541 | # convenient location for storing additional information and state |
|
542 | 542 | # their extensions may require, without fear of collisions with other |
|
543 | 543 | # ipython names that may develop later. |
|
544 | 544 | self.meta = Struct() |
|
545 | 545 | |
|
546 | 546 | # Temporary files used for various purposes. Deleted at exit. |
|
547 | 547 | self.tempfiles = [] |
|
548 | 548 | self.tempdirs = [] |
|
549 | 549 | |
|
550 | 550 | # keep track of where we started running (mainly for crash post-mortem) |
|
551 | 551 | # This is not being used anywhere currently. |
|
552 | 552 | self.starting_dir = os.getcwd() |
|
553 | 553 | |
|
554 | 554 | # Indentation management |
|
555 | 555 | self.indent_current_nsp = 0 |
|
556 | 556 | |
|
557 | 557 | # Dict to track post-execution functions that have been registered |
|
558 | 558 | self._post_execute = {} |
|
559 | 559 | |
|
560 | 560 | def init_environment(self): |
|
561 | 561 | """Any changes we need to make to the user's environment.""" |
|
562 | 562 | pass |
|
563 | 563 | |
|
564 | 564 | def init_encoding(self): |
|
565 | 565 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
566 | 566 | # under Win32 have it set to None, and we need to have a known valid |
|
567 | 567 | # encoding to use in the raw_input() method |
|
568 | 568 | try: |
|
569 | 569 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
570 | 570 | except AttributeError: |
|
571 | 571 | self.stdin_encoding = 'ascii' |
|
572 | 572 | |
|
573 | 573 | |
|
574 | 574 | @observe('colors') |
|
575 | 575 | def init_syntax_highlighting(self, changes=None): |
|
576 | 576 | # Python source parser/formatter for syntax highlighting |
|
577 | 577 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
578 | 578 | self.pycolorize = lambda src: pyformat(src,'str') |
|
579 | 579 | |
|
580 | 580 | def refresh_style(self): |
|
581 | 581 | # No-op here, used in subclass |
|
582 | 582 | pass |
|
583 | 583 | |
|
584 | 584 | def init_pushd_popd_magic(self): |
|
585 | 585 | # for pushd/popd management |
|
586 | 586 | self.home_dir = get_home_dir() |
|
587 | 587 | |
|
588 | 588 | self.dir_stack = [] |
|
589 | 589 | |
|
590 | 590 | def init_logger(self): |
|
591 | 591 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
592 | 592 | logmode='rotate') |
|
593 | 593 | |
|
594 | 594 | def init_logstart(self): |
|
595 | 595 | """Initialize logging in case it was requested at the command line. |
|
596 | 596 | """ |
|
597 | 597 | if self.logappend: |
|
598 | 598 | self.magic('logstart %s append' % self.logappend) |
|
599 | 599 | elif self.logfile: |
|
600 | 600 | self.magic('logstart %s' % self.logfile) |
|
601 | 601 | elif self.logstart: |
|
602 | 602 | self.magic('logstart') |
|
603 | 603 | |
|
604 | 604 | def init_deprecation_warnings(self): |
|
605 | 605 | """ |
|
606 | 606 | register default filter for deprecation warning. |
|
607 | 607 | |
|
608 | 608 | This will allow deprecation warning of function used interactively to show |
|
609 | 609 | warning to users, and still hide deprecation warning from libraries import. |
|
610 | 610 | """ |
|
611 | 611 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
612 | 612 | |
|
613 | 613 | def init_builtins(self): |
|
614 | 614 | # A single, static flag that we set to True. Its presence indicates |
|
615 | 615 | # that an IPython shell has been created, and we make no attempts at |
|
616 | 616 | # removing on exit or representing the existence of more than one |
|
617 | 617 | # IPython at a time. |
|
618 | 618 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
619 | 619 | |
|
620 | 620 | self.builtin_trap = BuiltinTrap(shell=self) |
|
621 | 621 | |
|
622 | 622 | def init_inspector(self): |
|
623 | 623 | # Object inspector |
|
624 | 624 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
625 | 625 | PyColorize.ANSICodeColors, |
|
626 | 626 | 'NoColor', |
|
627 | 627 | self.object_info_string_level) |
|
628 | 628 | |
|
629 | 629 | def init_io(self): |
|
630 | 630 | # This will just use sys.stdout and sys.stderr. If you want to |
|
631 | 631 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
632 | 632 | # *before* instantiating this class, because io holds onto |
|
633 | 633 | # references to the underlying streams. |
|
634 | 634 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
635 | 635 | # during initialization of the deprecated API. |
|
636 | 636 | with warnings.catch_warnings(): |
|
637 | 637 | warnings.simplefilter('ignore', DeprecationWarning) |
|
638 | 638 | io.stdout = io.IOStream(sys.stdout) |
|
639 | 639 | io.stderr = io.IOStream(sys.stderr) |
|
640 | 640 | |
|
641 | 641 | def init_prompts(self): |
|
642 | 642 | # Set system prompts, so that scripts can decide if they are running |
|
643 | 643 | # interactively. |
|
644 | 644 | sys.ps1 = 'In : ' |
|
645 | 645 | sys.ps2 = '...: ' |
|
646 | 646 | sys.ps3 = 'Out: ' |
|
647 | 647 | |
|
648 | 648 | def init_display_formatter(self): |
|
649 | 649 | self.display_formatter = DisplayFormatter(parent=self) |
|
650 | 650 | self.configurables.append(self.display_formatter) |
|
651 | 651 | |
|
652 | 652 | def init_display_pub(self): |
|
653 | 653 | self.display_pub = self.display_pub_class(parent=self) |
|
654 | 654 | self.configurables.append(self.display_pub) |
|
655 | 655 | |
|
656 | 656 | def init_data_pub(self): |
|
657 | 657 | if not self.data_pub_class: |
|
658 | 658 | self.data_pub = None |
|
659 | 659 | return |
|
660 | 660 | self.data_pub = self.data_pub_class(parent=self) |
|
661 | 661 | self.configurables.append(self.data_pub) |
|
662 | 662 | |
|
663 | 663 | def init_displayhook(self): |
|
664 | 664 | # Initialize displayhook, set in/out prompts and printing system |
|
665 | 665 | self.displayhook = self.displayhook_class( |
|
666 | 666 | parent=self, |
|
667 | 667 | shell=self, |
|
668 | 668 | cache_size=self.cache_size, |
|
669 | 669 | ) |
|
670 | 670 | self.configurables.append(self.displayhook) |
|
671 | 671 | # This is a context manager that installs/revmoes the displayhook at |
|
672 | 672 | # the appropriate time. |
|
673 | 673 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
674 | 674 | |
|
675 | 675 | def init_virtualenv(self): |
|
676 | 676 | """Add a virtualenv to sys.path so the user can import modules from it. |
|
677 | 677 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
678 | 678 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
679 | 679 | warning will appear suggesting the user installs IPython in the |
|
680 | 680 | virtualenv, but for many cases, it probably works well enough. |
|
681 | 681 | |
|
682 | 682 | Adapted from code snippets online. |
|
683 | 683 | |
|
684 | 684 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
685 | 685 | """ |
|
686 | 686 | if 'VIRTUAL_ENV' not in os.environ: |
|
687 | 687 | # Not in a virtualenv |
|
688 | 688 | return |
|
689 | 689 | |
|
690 | 690 | # venv detection: |
|
691 | 691 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
692 | 692 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
693 | 693 | # So we just check every item in the symlink tree (generally <= 3) |
|
694 | 694 | p = os.path.normcase(sys.executable) |
|
695 | 695 | paths = [p] |
|
696 | 696 | while os.path.islink(p): |
|
697 | 697 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) |
|
698 | 698 | paths.append(p) |
|
699 | 699 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) |
|
700 | 700 | if any(p.startswith(p_venv) for p in paths): |
|
701 | 701 | # Running properly in the virtualenv, don't need to do anything |
|
702 | 702 | return |
|
703 | 703 | |
|
704 | 704 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
705 | 705 | "install IPython inside the virtualenv.") |
|
706 | 706 | if sys.platform == "win32": |
|
707 | 707 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
708 | 708 | else: |
|
709 | 709 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
710 | 710 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
711 | 711 | |
|
712 | 712 | import site |
|
713 | 713 | sys.path.insert(0, virtual_env) |
|
714 | 714 | site.addsitedir(virtual_env) |
|
715 | 715 | |
|
716 | 716 | #------------------------------------------------------------------------- |
|
717 | 717 | # Things related to injections into the sys module |
|
718 | 718 | #------------------------------------------------------------------------- |
|
719 | 719 | |
|
720 | 720 | def save_sys_module_state(self): |
|
721 | 721 | """Save the state of hooks in the sys module. |
|
722 | 722 | |
|
723 | 723 | This has to be called after self.user_module is created. |
|
724 | 724 | """ |
|
725 | 725 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
726 | 726 | 'stdout': sys.stdout, |
|
727 | 727 | 'stderr': sys.stderr, |
|
728 | 728 | 'excepthook': sys.excepthook} |
|
729 | 729 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
730 | 730 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
731 | 731 | |
|
732 | 732 | def restore_sys_module_state(self): |
|
733 | 733 | """Restore the state of the sys module.""" |
|
734 | 734 | try: |
|
735 | 735 | for k, v in self._orig_sys_module_state.items(): |
|
736 | 736 | setattr(sys, k, v) |
|
737 | 737 | except AttributeError: |
|
738 | 738 | pass |
|
739 | 739 | # Reset what what done in self.init_sys_modules |
|
740 | 740 | if self._orig_sys_modules_main_mod is not None: |
|
741 | 741 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
742 | 742 | |
|
743 | 743 | #------------------------------------------------------------------------- |
|
744 | 744 | # Things related to the banner |
|
745 | 745 | #------------------------------------------------------------------------- |
|
746 | 746 | |
|
747 | 747 | @property |
|
748 | 748 | def banner(self): |
|
749 | 749 | banner = self.banner1 |
|
750 | 750 | if self.profile and self.profile != 'default': |
|
751 | 751 | banner += '\nIPython profile: %s\n' % self.profile |
|
752 | 752 | if self.banner2: |
|
753 | 753 | banner += '\n' + self.banner2 |
|
754 | 754 | return banner |
|
755 | 755 | |
|
756 | 756 | def show_banner(self, banner=None): |
|
757 | 757 | if banner is None: |
|
758 | 758 | banner = self.banner |
|
759 | 759 | sys.stdout.write(banner) |
|
760 | 760 | |
|
761 | 761 | #------------------------------------------------------------------------- |
|
762 | 762 | # Things related to hooks |
|
763 | 763 | #------------------------------------------------------------------------- |
|
764 | 764 | |
|
765 | 765 | def init_hooks(self): |
|
766 | 766 | # hooks holds pointers used for user-side customizations |
|
767 | 767 | self.hooks = Struct() |
|
768 | 768 | |
|
769 | 769 | self.strdispatchers = {} |
|
770 | 770 | |
|
771 | 771 | # Set all default hooks, defined in the IPython.hooks module. |
|
772 | 772 | hooks = IPython.core.hooks |
|
773 | 773 | for hook_name in hooks.__all__: |
|
774 | 774 | # default hooks have priority 100, i.e. low; user hooks should have |
|
775 | 775 | # 0-100 priority |
|
776 | 776 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
777 | 777 | |
|
778 | 778 | if self.display_page: |
|
779 | 779 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
780 | 780 | |
|
781 | 781 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
782 | 782 | _warn_deprecated=True): |
|
783 | 783 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
784 | 784 | |
|
785 | 785 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
786 | 786 | adding your function to one of these hooks, you can modify IPython's |
|
787 | 787 | behavior to call at runtime your own routines.""" |
|
788 | 788 | |
|
789 | 789 | # At some point in the future, this should validate the hook before it |
|
790 | 790 | # accepts it. Probably at least check that the hook takes the number |
|
791 | 791 | # of args it's supposed to. |
|
792 | 792 | |
|
793 | 793 | f = types.MethodType(hook,self) |
|
794 | 794 | |
|
795 | 795 | # check if the hook is for strdispatcher first |
|
796 | 796 | if str_key is not None: |
|
797 | 797 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
798 | 798 | sdp.add_s(str_key, f, priority ) |
|
799 | 799 | self.strdispatchers[name] = sdp |
|
800 | 800 | return |
|
801 | 801 | if re_key is not None: |
|
802 | 802 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
803 | 803 | sdp.add_re(re.compile(re_key), f, priority ) |
|
804 | 804 | self.strdispatchers[name] = sdp |
|
805 | 805 | return |
|
806 | 806 | |
|
807 | 807 | dp = getattr(self.hooks, name, None) |
|
808 | 808 | if name not in IPython.core.hooks.__all__: |
|
809 | 809 | print("Warning! Hook '%s' is not one of %s" % \ |
|
810 | 810 | (name, IPython.core.hooks.__all__ )) |
|
811 | 811 | |
|
812 | 812 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
813 | 813 | alternative = IPython.core.hooks.deprecated[name] |
|
814 | 814 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
815 | 815 | |
|
816 | 816 | if not dp: |
|
817 | 817 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
818 | 818 | |
|
819 | 819 | try: |
|
820 | 820 | dp.add(f,priority) |
|
821 | 821 | except AttributeError: |
|
822 | 822 | # it was not commandchain, plain old func - replace |
|
823 | 823 | dp = f |
|
824 | 824 | |
|
825 | 825 | setattr(self.hooks,name, dp) |
|
826 | 826 | |
|
827 | 827 | #------------------------------------------------------------------------- |
|
828 | 828 | # Things related to events |
|
829 | 829 | #------------------------------------------------------------------------- |
|
830 | 830 | |
|
831 | 831 | def init_events(self): |
|
832 | 832 | self.events = EventManager(self, available_events) |
|
833 | 833 | |
|
834 | 834 | self.events.register("pre_execute", self._clear_warning_registry) |
|
835 | 835 | |
|
836 | 836 | def register_post_execute(self, func): |
|
837 | 837 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
838 | 838 | |
|
839 | 839 | Register a function for calling after code execution. |
|
840 | 840 | """ |
|
841 | 841 | warn("ip.register_post_execute is deprecated, use " |
|
842 | 842 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
843 | 843 | self.events.register('post_run_cell', func) |
|
844 | 844 | |
|
845 | 845 | def _clear_warning_registry(self): |
|
846 | 846 | # clear the warning registry, so that different code blocks with |
|
847 | 847 | # overlapping line number ranges don't cause spurious suppression of |
|
848 | 848 | # warnings (see gh-6611 for details) |
|
849 | 849 | if "__warningregistry__" in self.user_global_ns: |
|
850 | 850 | del self.user_global_ns["__warningregistry__"] |
|
851 | 851 | |
|
852 | 852 | #------------------------------------------------------------------------- |
|
853 | 853 | # Things related to the "main" module |
|
854 | 854 | #------------------------------------------------------------------------- |
|
855 | 855 | |
|
856 | 856 | def new_main_mod(self, filename, modname): |
|
857 | 857 | """Return a new 'main' module object for user code execution. |
|
858 | 858 | |
|
859 | 859 | ``filename`` should be the path of the script which will be run in the |
|
860 | 860 | module. Requests with the same filename will get the same module, with |
|
861 | 861 | its namespace cleared. |
|
862 | 862 | |
|
863 | 863 | ``modname`` should be the module name - normally either '__main__' or |
|
864 | 864 | the basename of the file without the extension. |
|
865 | 865 | |
|
866 | 866 | When scripts are executed via %run, we must keep a reference to their |
|
867 | 867 | __main__ module around so that Python doesn't |
|
868 | 868 | clear it, rendering references to module globals useless. |
|
869 | 869 | |
|
870 | 870 | This method keeps said reference in a private dict, keyed by the |
|
871 | 871 | absolute path of the script. This way, for multiple executions of the |
|
872 | 872 | same script we only keep one copy of the namespace (the last one), |
|
873 | 873 | thus preventing memory leaks from old references while allowing the |
|
874 | 874 | objects from the last execution to be accessible. |
|
875 | 875 | """ |
|
876 | 876 | filename = os.path.abspath(filename) |
|
877 | 877 | try: |
|
878 | 878 | main_mod = self._main_mod_cache[filename] |
|
879 | 879 | except KeyError: |
|
880 | 880 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
881 | 881 | py3compat.cast_bytes_py2(modname), |
|
882 | 882 | doc="Module created for script run in IPython") |
|
883 | 883 | else: |
|
884 | 884 | main_mod.__dict__.clear() |
|
885 | 885 | main_mod.__name__ = modname |
|
886 | 886 | |
|
887 | 887 | main_mod.__file__ = filename |
|
888 | 888 | # It seems pydoc (and perhaps others) needs any module instance to |
|
889 | 889 | # implement a __nonzero__ method |
|
890 | 890 | main_mod.__nonzero__ = lambda : True |
|
891 | 891 | |
|
892 | 892 | return main_mod |
|
893 | 893 | |
|
894 | 894 | def clear_main_mod_cache(self): |
|
895 | 895 | """Clear the cache of main modules. |
|
896 | 896 | |
|
897 | 897 | Mainly for use by utilities like %reset. |
|
898 | 898 | |
|
899 | 899 | Examples |
|
900 | 900 | -------- |
|
901 | 901 | |
|
902 | 902 | In [15]: import IPython |
|
903 | 903 | |
|
904 | 904 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
905 | 905 | |
|
906 | 906 | In [17]: len(_ip._main_mod_cache) > 0 |
|
907 | 907 | Out[17]: True |
|
908 | 908 | |
|
909 | 909 | In [18]: _ip.clear_main_mod_cache() |
|
910 | 910 | |
|
911 | 911 | In [19]: len(_ip._main_mod_cache) == 0 |
|
912 | 912 | Out[19]: True |
|
913 | 913 | """ |
|
914 | 914 | self._main_mod_cache.clear() |
|
915 | 915 | |
|
916 | 916 | #------------------------------------------------------------------------- |
|
917 | 917 | # Things related to debugging |
|
918 | 918 | #------------------------------------------------------------------------- |
|
919 | 919 | |
|
920 | 920 | def init_pdb(self): |
|
921 | 921 | # Set calling of pdb on exceptions |
|
922 | 922 | # self.call_pdb is a property |
|
923 | 923 | self.call_pdb = self.pdb |
|
924 | 924 | |
|
925 | 925 | def _get_call_pdb(self): |
|
926 | 926 | return self._call_pdb |
|
927 | 927 | |
|
928 | 928 | def _set_call_pdb(self,val): |
|
929 | 929 | |
|
930 | 930 | if val not in (0,1,False,True): |
|
931 | 931 | raise ValueError('new call_pdb value must be boolean') |
|
932 | 932 | |
|
933 | 933 | # store value in instance |
|
934 | 934 | self._call_pdb = val |
|
935 | 935 | |
|
936 | 936 | # notify the actual exception handlers |
|
937 | 937 | self.InteractiveTB.call_pdb = val |
|
938 | 938 | |
|
939 | 939 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
940 | 940 | 'Control auto-activation of pdb at exceptions') |
|
941 | 941 | |
|
942 | 942 | def debugger(self,force=False): |
|
943 | 943 | """Call the pdb debugger. |
|
944 | 944 | |
|
945 | 945 | Keywords: |
|
946 | 946 | |
|
947 | 947 | - force(False): by default, this routine checks the instance call_pdb |
|
948 | 948 | flag and does not actually invoke the debugger if the flag is false. |
|
949 | 949 | The 'force' option forces the debugger to activate even if the flag |
|
950 | 950 | is false. |
|
951 | 951 | """ |
|
952 | 952 | |
|
953 | 953 | if not (force or self.call_pdb): |
|
954 | 954 | return |
|
955 | 955 | |
|
956 | 956 | if not hasattr(sys,'last_traceback'): |
|
957 | 957 | error('No traceback has been produced, nothing to debug.') |
|
958 | 958 | return |
|
959 | 959 | |
|
960 | 960 | self.InteractiveTB.debugger(force=True) |
|
961 | 961 | |
|
962 | 962 | #------------------------------------------------------------------------- |
|
963 | 963 | # Things related to IPython's various namespaces |
|
964 | 964 | #------------------------------------------------------------------------- |
|
965 | 965 | default_user_namespaces = True |
|
966 | 966 | |
|
967 | 967 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
968 | 968 | # Create the namespace where the user will operate. user_ns is |
|
969 | 969 | # normally the only one used, and it is passed to the exec calls as |
|
970 | 970 | # the locals argument. But we do carry a user_global_ns namespace |
|
971 | 971 | # given as the exec 'globals' argument, This is useful in embedding |
|
972 | 972 | # situations where the ipython shell opens in a context where the |
|
973 | 973 | # distinction between locals and globals is meaningful. For |
|
974 | 974 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
975 | 975 | |
|
976 | 976 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
977 | 977 | # level as a dict instead of a module. This is a manual fix, but I |
|
978 | 978 | # should really track down where the problem is coming from. Alex |
|
979 | 979 | # Schmolck reported this problem first. |
|
980 | 980 | |
|
981 | 981 | # A useful post by Alex Martelli on this topic: |
|
982 | 982 | # Re: inconsistent value from __builtins__ |
|
983 | 983 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
984 | 984 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
985 | 985 | # Gruppen: comp.lang.python |
|
986 | 986 | |
|
987 | 987 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
988 | 988 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
989 | 989 | # > <type 'dict'> |
|
990 | 990 | # > >>> print type(__builtins__) |
|
991 | 991 | # > <type 'module'> |
|
992 | 992 | # > Is this difference in return value intentional? |
|
993 | 993 | |
|
994 | 994 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
995 | 995 | # or a module, and it's been that way for a long time. Whether it's |
|
996 | 996 | # intentional (or sensible), I don't know. In any case, the idea is |
|
997 | 997 | # that if you need to access the built-in namespace directly, you |
|
998 | 998 | # should start with "import __builtin__" (note, no 's') which will |
|
999 | 999 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1000 | 1000 | |
|
1001 | 1001 | # These routines return a properly built module and dict as needed by |
|
1002 | 1002 | # the rest of the code, and can also be used by extension writers to |
|
1003 | 1003 | # generate properly initialized namespaces. |
|
1004 | 1004 | if (user_ns is not None) or (user_module is not None): |
|
1005 | 1005 | self.default_user_namespaces = False |
|
1006 | 1006 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1007 | 1007 | |
|
1008 | 1008 | # A record of hidden variables we have added to the user namespace, so |
|
1009 | 1009 | # we can list later only variables defined in actual interactive use. |
|
1010 | 1010 | self.user_ns_hidden = {} |
|
1011 | 1011 | |
|
1012 | 1012 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1013 | 1013 | # problem: after script execution (via %run), the module where the user |
|
1014 | 1014 | # code ran is deleted. Now that this object is a true module (needed |
|
1015 | 1015 | # so doctest and other tools work correctly), the Python module |
|
1016 | 1016 | # teardown mechanism runs over it, and sets to None every variable |
|
1017 | 1017 | # present in that module. Top-level references to objects from the |
|
1018 | 1018 | # script survive, because the user_ns is updated with them. However, |
|
1019 | 1019 | # calling functions defined in the script that use other things from |
|
1020 | 1020 | # the script will fail, because the function's closure had references |
|
1021 | 1021 | # to the original objects, which are now all None. So we must protect |
|
1022 | 1022 | # these modules from deletion by keeping a cache. |
|
1023 | 1023 | # |
|
1024 | 1024 | # To avoid keeping stale modules around (we only need the one from the |
|
1025 | 1025 | # last run), we use a dict keyed with the full path to the script, so |
|
1026 | 1026 | # only the last version of the module is held in the cache. Note, |
|
1027 | 1027 | # however, that we must cache the module *namespace contents* (their |
|
1028 | 1028 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1029 | 1029 | # (uncached) could be destroyed while still holding references (such as |
|
1030 | 1030 | # those held by GUI objects that tend to be long-lived)> |
|
1031 | 1031 | # |
|
1032 | 1032 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1033 | 1033 | # and clear_main_mod_cache() methods for details on use. |
|
1034 | 1034 | |
|
1035 | 1035 | # This is the cache used for 'main' namespaces |
|
1036 | 1036 | self._main_mod_cache = {} |
|
1037 | 1037 | |
|
1038 | 1038 | # A table holding all the namespaces IPython deals with, so that |
|
1039 | 1039 | # introspection facilities can search easily. |
|
1040 | 1040 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1041 | 1041 | 'user_local':self.user_ns, |
|
1042 | 1042 | 'builtin':builtin_mod.__dict__ |
|
1043 | 1043 | } |
|
1044 | 1044 | |
|
1045 | 1045 | @property |
|
1046 | 1046 | def user_global_ns(self): |
|
1047 | 1047 | return self.user_module.__dict__ |
|
1048 | 1048 | |
|
1049 | 1049 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1050 | 1050 | """Prepare the module and namespace in which user code will be run. |
|
1051 | 1051 | |
|
1052 | 1052 | When IPython is started normally, both parameters are None: a new module |
|
1053 | 1053 | is created automatically, and its __dict__ used as the namespace. |
|
1054 | 1054 | |
|
1055 | 1055 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1056 | 1056 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1057 | 1057 | becomes the global namespace. If both are provided (as they may be |
|
1058 | 1058 | when embedding), user_ns is the local namespace, and user_module |
|
1059 | 1059 | provides the global namespace. |
|
1060 | 1060 | |
|
1061 | 1061 | Parameters |
|
1062 | 1062 | ---------- |
|
1063 | 1063 | user_module : module, optional |
|
1064 | 1064 | The current user module in which IPython is being run. If None, |
|
1065 | 1065 | a clean module will be created. |
|
1066 | 1066 | user_ns : dict, optional |
|
1067 | 1067 | A namespace in which to run interactive commands. |
|
1068 | 1068 | |
|
1069 | 1069 | Returns |
|
1070 | 1070 | ------- |
|
1071 | 1071 | A tuple of user_module and user_ns, each properly initialised. |
|
1072 | 1072 | """ |
|
1073 | 1073 | if user_module is None and user_ns is not None: |
|
1074 | 1074 | user_ns.setdefault("__name__", "__main__") |
|
1075 | 1075 | user_module = DummyMod() |
|
1076 | 1076 | user_module.__dict__ = user_ns |
|
1077 | 1077 | |
|
1078 | 1078 | if user_module is None: |
|
1079 | 1079 | user_module = types.ModuleType("__main__", |
|
1080 | 1080 | doc="Automatically created module for IPython interactive environment") |
|
1081 | 1081 | |
|
1082 | 1082 | # We must ensure that __builtin__ (without the final 's') is always |
|
1083 | 1083 | # available and pointing to the __builtin__ *module*. For more details: |
|
1084 | 1084 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1085 | 1085 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1086 | 1086 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1087 | 1087 | |
|
1088 | 1088 | if user_ns is None: |
|
1089 | 1089 | user_ns = user_module.__dict__ |
|
1090 | 1090 | |
|
1091 | 1091 | return user_module, user_ns |
|
1092 | 1092 | |
|
1093 | 1093 | def init_sys_modules(self): |
|
1094 | 1094 | # We need to insert into sys.modules something that looks like a |
|
1095 | 1095 | # module but which accesses the IPython namespace, for shelve and |
|
1096 | 1096 | # pickle to work interactively. Normally they rely on getting |
|
1097 | 1097 | # everything out of __main__, but for embedding purposes each IPython |
|
1098 | 1098 | # instance has its own private namespace, so we can't go shoving |
|
1099 | 1099 | # everything into __main__. |
|
1100 | 1100 | |
|
1101 | 1101 | # note, however, that we should only do this for non-embedded |
|
1102 | 1102 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1103 | 1103 | # namespace. Embedded instances, on the other hand, should not do |
|
1104 | 1104 | # this because they need to manage the user local/global namespaces |
|
1105 | 1105 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1106 | 1106 | # shouldn't overtake the execution environment of the script they're |
|
1107 | 1107 | # embedded in). |
|
1108 | 1108 | |
|
1109 | 1109 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1110 | 1110 | main_name = self.user_module.__name__ |
|
1111 | 1111 | sys.modules[main_name] = self.user_module |
|
1112 | 1112 | |
|
1113 | 1113 | def init_user_ns(self): |
|
1114 | 1114 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1115 | 1115 | |
|
1116 | 1116 | Certain history lists are also initialized here, as they effectively |
|
1117 | 1117 | act as user namespaces. |
|
1118 | 1118 | |
|
1119 | 1119 | Notes |
|
1120 | 1120 | ----- |
|
1121 | 1121 | All data structures here are only filled in, they are NOT reset by this |
|
1122 | 1122 | method. If they were not empty before, data will simply be added to |
|
1123 | 1123 | therm. |
|
1124 | 1124 | """ |
|
1125 | 1125 | # This function works in two parts: first we put a few things in |
|
1126 | 1126 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1127 | 1127 | # initial variables aren't shown by %who. After the sync, we add the |
|
1128 | 1128 | # rest of what we *do* want the user to see with %who even on a new |
|
1129 | 1129 | # session (probably nothing, so they really only see their own stuff) |
|
1130 | 1130 | |
|
1131 | 1131 | # The user dict must *always* have a __builtin__ reference to the |
|
1132 | 1132 | # Python standard __builtin__ namespace, which must be imported. |
|
1133 | 1133 | # This is so that certain operations in prompt evaluation can be |
|
1134 | 1134 | # reliably executed with builtins. Note that we can NOT use |
|
1135 | 1135 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1136 | 1136 | # module, and can even mutate at runtime, depending on the context |
|
1137 | 1137 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1138 | 1138 | # always a module object, though it must be explicitly imported. |
|
1139 | 1139 | |
|
1140 | 1140 | # For more details: |
|
1141 | 1141 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1142 | 1142 | ns = dict() |
|
1143 | 1143 | |
|
1144 | 1144 | # make global variables for user access to the histories |
|
1145 | 1145 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1146 | 1146 | ns['_oh'] = self.history_manager.output_hist |
|
1147 | 1147 | ns['_dh'] = self.history_manager.dir_hist |
|
1148 | 1148 | |
|
1149 | 1149 | ns['_sh'] = shadowns |
|
1150 | 1150 | |
|
1151 | 1151 | # user aliases to input and output histories. These shouldn't show up |
|
1152 | 1152 | # in %who, as they can have very large reprs. |
|
1153 | 1153 | ns['In'] = self.history_manager.input_hist_parsed |
|
1154 | 1154 | ns['Out'] = self.history_manager.output_hist |
|
1155 | 1155 | |
|
1156 | 1156 | # Store myself as the public api!!! |
|
1157 | 1157 | ns['get_ipython'] = self.get_ipython |
|
1158 | 1158 | |
|
1159 | 1159 | ns['exit'] = self.exiter |
|
1160 | 1160 | ns['quit'] = self.exiter |
|
1161 | 1161 | |
|
1162 | 1162 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1163 | 1163 | # by %who |
|
1164 | 1164 | self.user_ns_hidden.update(ns) |
|
1165 | 1165 | |
|
1166 | 1166 | # Anything put into ns now would show up in %who. Think twice before |
|
1167 | 1167 | # putting anything here, as we really want %who to show the user their |
|
1168 | 1168 | # stuff, not our variables. |
|
1169 | 1169 | |
|
1170 | 1170 | # Finally, update the real user's namespace |
|
1171 | 1171 | self.user_ns.update(ns) |
|
1172 | 1172 | |
|
1173 | 1173 | @property |
|
1174 | 1174 | def all_ns_refs(self): |
|
1175 | 1175 | """Get a list of references to all the namespace dictionaries in which |
|
1176 | 1176 | IPython might store a user-created object. |
|
1177 | 1177 | |
|
1178 | 1178 | Note that this does not include the displayhook, which also caches |
|
1179 | 1179 | objects from the output.""" |
|
1180 | 1180 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1181 | 1181 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1182 | 1182 | |
|
1183 | 1183 | def reset(self, new_session=True): |
|
1184 | 1184 | """Clear all internal namespaces, and attempt to release references to |
|
1185 | 1185 | user objects. |
|
1186 | 1186 | |
|
1187 | 1187 | If new_session is True, a new history session will be opened. |
|
1188 | 1188 | """ |
|
1189 | 1189 | # Clear histories |
|
1190 | 1190 | self.history_manager.reset(new_session) |
|
1191 | 1191 | # Reset counter used to index all histories |
|
1192 | 1192 | if new_session: |
|
1193 | 1193 | self.execution_count = 1 |
|
1194 | 1194 | |
|
1195 | 1195 | # Flush cached output items |
|
1196 | 1196 | if self.displayhook.do_full_cache: |
|
1197 | 1197 | self.displayhook.flush() |
|
1198 | 1198 | |
|
1199 | 1199 | # The main execution namespaces must be cleared very carefully, |
|
1200 | 1200 | # skipping the deletion of the builtin-related keys, because doing so |
|
1201 | 1201 | # would cause errors in many object's __del__ methods. |
|
1202 | 1202 | if self.user_ns is not self.user_global_ns: |
|
1203 | 1203 | self.user_ns.clear() |
|
1204 | 1204 | ns = self.user_global_ns |
|
1205 | 1205 | drop_keys = set(ns.keys()) |
|
1206 | 1206 | drop_keys.discard('__builtin__') |
|
1207 | 1207 | drop_keys.discard('__builtins__') |
|
1208 | 1208 | drop_keys.discard('__name__') |
|
1209 | 1209 | for k in drop_keys: |
|
1210 | 1210 | del ns[k] |
|
1211 | 1211 | |
|
1212 | 1212 | self.user_ns_hidden.clear() |
|
1213 | 1213 | |
|
1214 | 1214 | # Restore the user namespaces to minimal usability |
|
1215 | 1215 | self.init_user_ns() |
|
1216 | 1216 | |
|
1217 | 1217 | # Restore the default and user aliases |
|
1218 | 1218 | self.alias_manager.clear_aliases() |
|
1219 | 1219 | self.alias_manager.init_aliases() |
|
1220 | 1220 | |
|
1221 | 1221 | # Flush the private list of module references kept for script |
|
1222 | 1222 | # execution protection |
|
1223 | 1223 | self.clear_main_mod_cache() |
|
1224 | 1224 | |
|
1225 | 1225 | def del_var(self, varname, by_name=False): |
|
1226 | 1226 | """Delete a variable from the various namespaces, so that, as |
|
1227 | 1227 | far as possible, we're not keeping any hidden references to it. |
|
1228 | 1228 | |
|
1229 | 1229 | Parameters |
|
1230 | 1230 | ---------- |
|
1231 | 1231 | varname : str |
|
1232 | 1232 | The name of the variable to delete. |
|
1233 | 1233 | by_name : bool |
|
1234 | 1234 | If True, delete variables with the given name in each |
|
1235 | 1235 | namespace. If False (default), find the variable in the user |
|
1236 | 1236 | namespace, and delete references to it. |
|
1237 | 1237 | """ |
|
1238 | 1238 | if varname in ('__builtin__', '__builtins__'): |
|
1239 | 1239 | raise ValueError("Refusing to delete %s" % varname) |
|
1240 | 1240 | |
|
1241 | 1241 | ns_refs = self.all_ns_refs |
|
1242 | 1242 | |
|
1243 | 1243 | if by_name: # Delete by name |
|
1244 | 1244 | for ns in ns_refs: |
|
1245 | 1245 | try: |
|
1246 | 1246 | del ns[varname] |
|
1247 | 1247 | except KeyError: |
|
1248 | 1248 | pass |
|
1249 | 1249 | else: # Delete by object |
|
1250 | 1250 | try: |
|
1251 | 1251 | obj = self.user_ns[varname] |
|
1252 | 1252 | except KeyError: |
|
1253 | 1253 | raise NameError("name '%s' is not defined" % varname) |
|
1254 | 1254 | # Also check in output history |
|
1255 | 1255 | ns_refs.append(self.history_manager.output_hist) |
|
1256 | 1256 | for ns in ns_refs: |
|
1257 | 1257 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1258 | 1258 | for name in to_delete: |
|
1259 | 1259 | del ns[name] |
|
1260 | 1260 | |
|
1261 | 1261 | # displayhook keeps extra references, but not in a dictionary |
|
1262 | 1262 | for name in ('_', '__', '___'): |
|
1263 | 1263 | if getattr(self.displayhook, name) is obj: |
|
1264 | 1264 | setattr(self.displayhook, name, None) |
|
1265 | 1265 | |
|
1266 | 1266 | def reset_selective(self, regex=None): |
|
1267 | 1267 | """Clear selective variables from internal namespaces based on a |
|
1268 | 1268 | specified regular expression. |
|
1269 | 1269 | |
|
1270 | 1270 | Parameters |
|
1271 | 1271 | ---------- |
|
1272 | 1272 | regex : string or compiled pattern, optional |
|
1273 | 1273 | A regular expression pattern that will be used in searching |
|
1274 | 1274 | variable names in the users namespaces. |
|
1275 | 1275 | """ |
|
1276 | 1276 | if regex is not None: |
|
1277 | 1277 | try: |
|
1278 | 1278 | m = re.compile(regex) |
|
1279 | 1279 | except TypeError: |
|
1280 | 1280 | raise TypeError('regex must be a string or compiled pattern') |
|
1281 | 1281 | # Search for keys in each namespace that match the given regex |
|
1282 | 1282 | # If a match is found, delete the key/value pair. |
|
1283 | 1283 | for ns in self.all_ns_refs: |
|
1284 | 1284 | for var in ns: |
|
1285 | 1285 | if m.search(var): |
|
1286 | 1286 | del ns[var] |
|
1287 | 1287 | |
|
1288 | 1288 | def push(self, variables, interactive=True): |
|
1289 | 1289 | """Inject a group of variables into the IPython user namespace. |
|
1290 | 1290 | |
|
1291 | 1291 | Parameters |
|
1292 | 1292 | ---------- |
|
1293 | 1293 | variables : dict, str or list/tuple of str |
|
1294 | 1294 | The variables to inject into the user's namespace. If a dict, a |
|
1295 | 1295 | simple update is done. If a str, the string is assumed to have |
|
1296 | 1296 | variable names separated by spaces. A list/tuple of str can also |
|
1297 | 1297 | be used to give the variable names. If just the variable names are |
|
1298 | 1298 | give (list/tuple/str) then the variable values looked up in the |
|
1299 | 1299 | callers frame. |
|
1300 | 1300 | interactive : bool |
|
1301 | 1301 | If True (default), the variables will be listed with the ``who`` |
|
1302 | 1302 | magic. |
|
1303 | 1303 | """ |
|
1304 | 1304 | vdict = None |
|
1305 | 1305 | |
|
1306 | 1306 | # We need a dict of name/value pairs to do namespace updates. |
|
1307 | 1307 | if isinstance(variables, dict): |
|
1308 | 1308 | vdict = variables |
|
1309 | 1309 | elif isinstance(variables, (str, list, tuple)): |
|
1310 | 1310 | if isinstance(variables, str): |
|
1311 | 1311 | vlist = variables.split() |
|
1312 | 1312 | else: |
|
1313 | 1313 | vlist = variables |
|
1314 | 1314 | vdict = {} |
|
1315 | 1315 | cf = sys._getframe(1) |
|
1316 | 1316 | for name in vlist: |
|
1317 | 1317 | try: |
|
1318 | 1318 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1319 | 1319 | except: |
|
1320 | 1320 | print('Could not get variable %s from %s' % |
|
1321 | 1321 | (name,cf.f_code.co_name)) |
|
1322 | 1322 | else: |
|
1323 | 1323 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1324 | 1324 | |
|
1325 | 1325 | # Propagate variables to user namespace |
|
1326 | 1326 | self.user_ns.update(vdict) |
|
1327 | 1327 | |
|
1328 | 1328 | # And configure interactive visibility |
|
1329 | 1329 | user_ns_hidden = self.user_ns_hidden |
|
1330 | 1330 | if interactive: |
|
1331 | 1331 | for name in vdict: |
|
1332 | 1332 | user_ns_hidden.pop(name, None) |
|
1333 | 1333 | else: |
|
1334 | 1334 | user_ns_hidden.update(vdict) |
|
1335 | 1335 | |
|
1336 | 1336 | def drop_by_id(self, variables): |
|
1337 | 1337 | """Remove a dict of variables from the user namespace, if they are the |
|
1338 | 1338 | same as the values in the dictionary. |
|
1339 | 1339 | |
|
1340 | 1340 | This is intended for use by extensions: variables that they've added can |
|
1341 | 1341 | be taken back out if they are unloaded, without removing any that the |
|
1342 | 1342 | user has overwritten. |
|
1343 | 1343 | |
|
1344 | 1344 | Parameters |
|
1345 | 1345 | ---------- |
|
1346 | 1346 | variables : dict |
|
1347 | 1347 | A dictionary mapping object names (as strings) to the objects. |
|
1348 | 1348 | """ |
|
1349 | 1349 | for name, obj in variables.items(): |
|
1350 | 1350 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1351 | 1351 | del self.user_ns[name] |
|
1352 | 1352 | self.user_ns_hidden.pop(name, None) |
|
1353 | 1353 | |
|
1354 | 1354 | #------------------------------------------------------------------------- |
|
1355 | 1355 | # Things related to object introspection |
|
1356 | 1356 | #------------------------------------------------------------------------- |
|
1357 | 1357 | |
|
1358 | 1358 | def _ofind(self, oname, namespaces=None): |
|
1359 | 1359 | """Find an object in the available namespaces. |
|
1360 | 1360 | |
|
1361 | 1361 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1362 | 1362 | |
|
1363 | 1363 | Has special code to detect magic functions. |
|
1364 | 1364 | """ |
|
1365 | 1365 | oname = oname.strip() |
|
1366 | 1366 | #print '1- oname: <%r>' % oname # dbg |
|
1367 | 1367 | if not oname.startswith(ESC_MAGIC) and \ |
|
1368 | 1368 | not oname.startswith(ESC_MAGIC2) and \ |
|
1369 | 1369 | not py3compat.isidentifier(oname, dotted=True): |
|
1370 | 1370 | return dict(found=False) |
|
1371 | 1371 | |
|
1372 | 1372 | if namespaces is None: |
|
1373 | 1373 | # Namespaces to search in: |
|
1374 | 1374 | # Put them in a list. The order is important so that we |
|
1375 | 1375 | # find things in the same order that Python finds them. |
|
1376 | 1376 | namespaces = [ ('Interactive', self.user_ns), |
|
1377 | 1377 | ('Interactive (global)', self.user_global_ns), |
|
1378 | 1378 | ('Python builtin', builtin_mod.__dict__), |
|
1379 | 1379 | ] |
|
1380 | 1380 | |
|
1381 | 1381 | # initialize results to 'null' |
|
1382 | 1382 | found = False; obj = None; ospace = None; |
|
1383 | 1383 | ismagic = False; isalias = False; parent = None |
|
1384 | 1384 | |
|
1385 | 1385 | # We need to special-case 'print', which as of python2.6 registers as a |
|
1386 | 1386 | # function but should only be treated as one if print_function was |
|
1387 | 1387 | # loaded with a future import. In this case, just bail. |
|
1388 | 1388 | if (oname == 'print' and not py3compat.PY3 and not \ |
|
1389 | 1389 | (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)): |
|
1390 | 1390 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1391 | 1391 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1392 | 1392 | |
|
1393 | 1393 | # Look for the given name by splitting it in parts. If the head is |
|
1394 | 1394 | # found, then we look for all the remaining parts as members, and only |
|
1395 | 1395 | # declare success if we can find them all. |
|
1396 | 1396 | oname_parts = oname.split('.') |
|
1397 | 1397 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1398 | 1398 | for nsname,ns in namespaces: |
|
1399 | 1399 | try: |
|
1400 | 1400 | obj = ns[oname_head] |
|
1401 | 1401 | except KeyError: |
|
1402 | 1402 | continue |
|
1403 | 1403 | else: |
|
1404 | 1404 | #print 'oname_rest:', oname_rest # dbg |
|
1405 | 1405 | for idx, part in enumerate(oname_rest): |
|
1406 | 1406 | try: |
|
1407 | 1407 | parent = obj |
|
1408 | 1408 | # The last part is looked up in a special way to avoid |
|
1409 | 1409 | # descriptor invocation as it may raise or have side |
|
1410 | 1410 | # effects. |
|
1411 | 1411 | if idx == len(oname_rest) - 1: |
|
1412 | 1412 | obj = self._getattr_property(obj, part) |
|
1413 | 1413 | else: |
|
1414 | 1414 | obj = getattr(obj, part) |
|
1415 | 1415 | except: |
|
1416 | 1416 | # Blanket except b/c some badly implemented objects |
|
1417 | 1417 | # allow __getattr__ to raise exceptions other than |
|
1418 | 1418 | # AttributeError, which then crashes IPython. |
|
1419 | 1419 | break |
|
1420 | 1420 | else: |
|
1421 | 1421 | # If we finish the for loop (no break), we got all members |
|
1422 | 1422 | found = True |
|
1423 | 1423 | ospace = nsname |
|
1424 | 1424 | break # namespace loop |
|
1425 | 1425 | |
|
1426 | 1426 | # Try to see if it's magic |
|
1427 | 1427 | if not found: |
|
1428 | 1428 | obj = None |
|
1429 | 1429 | if oname.startswith(ESC_MAGIC2): |
|
1430 | 1430 | oname = oname.lstrip(ESC_MAGIC2) |
|
1431 | 1431 | obj = self.find_cell_magic(oname) |
|
1432 | 1432 | elif oname.startswith(ESC_MAGIC): |
|
1433 | 1433 | oname = oname.lstrip(ESC_MAGIC) |
|
1434 | 1434 | obj = self.find_line_magic(oname) |
|
1435 | 1435 | else: |
|
1436 | 1436 | # search without prefix, so run? will find %run? |
|
1437 | 1437 | obj = self.find_line_magic(oname) |
|
1438 | 1438 | if obj is None: |
|
1439 | 1439 | obj = self.find_cell_magic(oname) |
|
1440 | 1440 | if obj is not None: |
|
1441 | 1441 | found = True |
|
1442 | 1442 | ospace = 'IPython internal' |
|
1443 | 1443 | ismagic = True |
|
1444 | 1444 | isalias = isinstance(obj, Alias) |
|
1445 | 1445 | |
|
1446 | 1446 | # Last try: special-case some literals like '', [], {}, etc: |
|
1447 | 1447 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1448 | 1448 | obj = eval(oname_head) |
|
1449 | 1449 | found = True |
|
1450 | 1450 | ospace = 'Interactive' |
|
1451 | 1451 | |
|
1452 | 1452 | return {'found':found, 'obj':obj, 'namespace':ospace, |
|
1453 | 1453 | 'ismagic':ismagic, 'isalias':isalias, 'parent':parent} |
|
1454 | 1454 | |
|
1455 | 1455 | @staticmethod |
|
1456 | 1456 | def _getattr_property(obj, attrname): |
|
1457 | 1457 | """Property-aware getattr to use in object finding. |
|
1458 | 1458 | |
|
1459 | 1459 | If attrname represents a property, return it unevaluated (in case it has |
|
1460 | 1460 | side effects or raises an error. |
|
1461 | 1461 | |
|
1462 | 1462 | """ |
|
1463 | 1463 | if not isinstance(obj, type): |
|
1464 | 1464 | try: |
|
1465 | 1465 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1466 | 1466 | # `obj`, but does so for property: |
|
1467 | 1467 | # |
|
1468 | 1468 | # property.__get__(self, None, cls) -> self |
|
1469 | 1469 | # |
|
1470 | 1470 | # The universal alternative is to traverse the mro manually |
|
1471 | 1471 | # searching for attrname in class dicts. |
|
1472 | 1472 | attr = getattr(type(obj), attrname) |
|
1473 | 1473 | except AttributeError: |
|
1474 | 1474 | pass |
|
1475 | 1475 | else: |
|
1476 | 1476 | # This relies on the fact that data descriptors (with both |
|
1477 | 1477 | # __get__ & __set__ magic methods) take precedence over |
|
1478 | 1478 | # instance-level attributes: |
|
1479 | 1479 | # |
|
1480 | 1480 | # class A(object): |
|
1481 | 1481 | # @property |
|
1482 | 1482 | # def foobar(self): return 123 |
|
1483 | 1483 | # a = A() |
|
1484 | 1484 | # a.__dict__['foobar'] = 345 |
|
1485 | 1485 | # a.foobar # == 123 |
|
1486 | 1486 | # |
|
1487 | 1487 | # So, a property may be returned right away. |
|
1488 | 1488 | if isinstance(attr, property): |
|
1489 | 1489 | return attr |
|
1490 | 1490 | |
|
1491 | 1491 | # Nothing helped, fall back. |
|
1492 | 1492 | return getattr(obj, attrname) |
|
1493 | 1493 | |
|
1494 | 1494 | def _object_find(self, oname, namespaces=None): |
|
1495 | 1495 | """Find an object and return a struct with info about it.""" |
|
1496 | 1496 | return Struct(self._ofind(oname, namespaces)) |
|
1497 | 1497 | |
|
1498 | 1498 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1499 | 1499 | """Generic interface to the inspector system. |
|
1500 | 1500 | |
|
1501 | 1501 | This function is meant to be called by pdef, pdoc & friends. |
|
1502 | 1502 | """ |
|
1503 | 1503 | info = self._object_find(oname, namespaces) |
|
1504 | 1504 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1505 | 1505 | if info.found: |
|
1506 | 1506 | pmethod = getattr(self.inspector, meth) |
|
1507 | 1507 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1508 | 1508 | # bundle. |
|
1509 | 1509 | formatter = format_screen if info.ismagic else docformat |
|
1510 | 1510 | if meth == 'pdoc': |
|
1511 | 1511 | pmethod(info.obj, oname, formatter) |
|
1512 | 1512 | elif meth == 'pinfo': |
|
1513 | 1513 | pmethod(info.obj, oname, formatter, info, |
|
1514 | 1514 | enable_html_pager=self.enable_html_pager, **kw) |
|
1515 | 1515 | else: |
|
1516 | 1516 | pmethod(info.obj, oname) |
|
1517 | 1517 | else: |
|
1518 | 1518 | print('Object `%s` not found.' % oname) |
|
1519 | 1519 | return 'not found' # so callers can take other action |
|
1520 | 1520 | |
|
1521 | 1521 | def object_inspect(self, oname, detail_level=0): |
|
1522 | 1522 | """Get object info about oname""" |
|
1523 | 1523 | with self.builtin_trap: |
|
1524 | 1524 | info = self._object_find(oname) |
|
1525 | 1525 | if info.found: |
|
1526 | 1526 | return self.inspector.info(info.obj, oname, info=info, |
|
1527 | 1527 | detail_level=detail_level |
|
1528 | 1528 | ) |
|
1529 | 1529 | else: |
|
1530 | 1530 | return oinspect.object_info(name=oname, found=False) |
|
1531 | 1531 | |
|
1532 | 1532 | def object_inspect_text(self, oname, detail_level=0): |
|
1533 | 1533 | """Get object info as formatted text""" |
|
1534 | 1534 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1535 | 1535 | |
|
1536 | 1536 | def object_inspect_mime(self, oname, detail_level=0): |
|
1537 | 1537 | """Get object info as a mimebundle of formatted representations. |
|
1538 | 1538 | |
|
1539 | 1539 | A mimebundle is a dictionary, keyed by mime-type. |
|
1540 | 1540 | It must always have the key `'text/plain'`. |
|
1541 | 1541 | """ |
|
1542 | 1542 | with self.builtin_trap: |
|
1543 | 1543 | info = self._object_find(oname) |
|
1544 | 1544 | if info.found: |
|
1545 | 1545 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1546 | 1546 | detail_level=detail_level |
|
1547 | 1547 | ) |
|
1548 | 1548 | else: |
|
1549 | 1549 | raise KeyError(oname) |
|
1550 | 1550 | |
|
1551 | 1551 | #------------------------------------------------------------------------- |
|
1552 | 1552 | # Things related to history management |
|
1553 | 1553 | #------------------------------------------------------------------------- |
|
1554 | 1554 | |
|
1555 | 1555 | def init_history(self): |
|
1556 | 1556 | """Sets up the command history, and starts regular autosaves.""" |
|
1557 | 1557 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1558 | 1558 | self.configurables.append(self.history_manager) |
|
1559 | 1559 | |
|
1560 | 1560 | #------------------------------------------------------------------------- |
|
1561 | 1561 | # Things related to exception handling and tracebacks (not debugging) |
|
1562 | 1562 | #------------------------------------------------------------------------- |
|
1563 | 1563 | |
|
1564 | 1564 | debugger_cls = Pdb |
|
1565 | 1565 | |
|
1566 | 1566 | def init_traceback_handlers(self, custom_exceptions): |
|
1567 | 1567 | # Syntax error handler. |
|
1568 | 1568 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1569 | 1569 | |
|
1570 | 1570 | # The interactive one is initialized with an offset, meaning we always |
|
1571 | 1571 | # want to remove the topmost item in the traceback, which is our own |
|
1572 | 1572 | # internal code. Valid modes: ['Plain','Context','Verbose'] |
|
1573 | 1573 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1574 | 1574 | color_scheme='NoColor', |
|
1575 | 1575 | tb_offset = 1, |
|
1576 | 1576 | check_cache=check_linecache_ipython, |
|
1577 | 1577 | debugger_cls=self.debugger_cls, parent=self) |
|
1578 | 1578 | |
|
1579 | 1579 | # The instance will store a pointer to the system-wide exception hook, |
|
1580 | 1580 | # so that runtime code (such as magics) can access it. This is because |
|
1581 | 1581 | # during the read-eval loop, it may get temporarily overwritten. |
|
1582 | 1582 | self.sys_excepthook = sys.excepthook |
|
1583 | 1583 | |
|
1584 | 1584 | # and add any custom exception handlers the user may have specified |
|
1585 | 1585 | self.set_custom_exc(*custom_exceptions) |
|
1586 | 1586 | |
|
1587 | 1587 | # Set the exception mode |
|
1588 | 1588 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1589 | 1589 | |
|
1590 | 1590 | def set_custom_exc(self, exc_tuple, handler): |
|
1591 | 1591 | """set_custom_exc(exc_tuple, handler) |
|
1592 | 1592 | |
|
1593 | 1593 | Set a custom exception handler, which will be called if any of the |
|
1594 | 1594 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1595 | 1595 | run_code() method). |
|
1596 | 1596 | |
|
1597 | 1597 | Parameters |
|
1598 | 1598 | ---------- |
|
1599 | 1599 | |
|
1600 | 1600 | exc_tuple : tuple of exception classes |
|
1601 | 1601 | A *tuple* of exception classes, for which to call the defined |
|
1602 | 1602 | handler. It is very important that you use a tuple, and NOT A |
|
1603 | 1603 | LIST here, because of the way Python's except statement works. If |
|
1604 | 1604 | you only want to trap a single exception, use a singleton tuple:: |
|
1605 | 1605 | |
|
1606 | 1606 | exc_tuple == (MyCustomException,) |
|
1607 | 1607 | |
|
1608 | 1608 | handler : callable |
|
1609 | 1609 | handler must have the following signature:: |
|
1610 | 1610 | |
|
1611 | 1611 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1612 | 1612 | ... |
|
1613 | 1613 | return structured_traceback |
|
1614 | 1614 | |
|
1615 | 1615 | Your handler must return a structured traceback (a list of strings), |
|
1616 | 1616 | or None. |
|
1617 | 1617 | |
|
1618 | 1618 | This will be made into an instance method (via types.MethodType) |
|
1619 | 1619 | of IPython itself, and it will be called if any of the exceptions |
|
1620 | 1620 | listed in the exc_tuple are caught. If the handler is None, an |
|
1621 | 1621 | internal basic one is used, which just prints basic info. |
|
1622 | 1622 | |
|
1623 | 1623 | To protect IPython from crashes, if your handler ever raises an |
|
1624 | 1624 | exception or returns an invalid result, it will be immediately |
|
1625 | 1625 | disabled. |
|
1626 | 1626 | |
|
1627 | 1627 | WARNING: by putting in your own exception handler into IPython's main |
|
1628 | 1628 | execution loop, you run a very good chance of nasty crashes. This |
|
1629 | 1629 | facility should only be used if you really know what you are doing.""" |
|
1630 | 1630 | |
|
1631 | 1631 | assert type(exc_tuple)==type(()) , \ |
|
1632 | 1632 | "The custom exceptions must be given AS A TUPLE." |
|
1633 | 1633 | |
|
1634 | 1634 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1635 | 1635 | print('*** Simple custom exception handler ***') |
|
1636 | 1636 | print('Exception type :',etype) |
|
1637 | 1637 | print('Exception value:',value) |
|
1638 | 1638 | print('Traceback :',tb) |
|
1639 | 1639 | #print 'Source code :','\n'.join(self.buffer) |
|
1640 | 1640 | |
|
1641 | 1641 | def validate_stb(stb): |
|
1642 | 1642 | """validate structured traceback return type |
|
1643 | 1643 | |
|
1644 | 1644 | return type of CustomTB *should* be a list of strings, but allow |
|
1645 | 1645 | single strings or None, which are harmless. |
|
1646 | 1646 | |
|
1647 | 1647 | This function will *always* return a list of strings, |
|
1648 | 1648 | and will raise a TypeError if stb is inappropriate. |
|
1649 | 1649 | """ |
|
1650 | 1650 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1651 | 1651 | if stb is None: |
|
1652 | 1652 | return [] |
|
1653 | 1653 | elif isinstance(stb, str): |
|
1654 | 1654 | return [stb] |
|
1655 | 1655 | elif not isinstance(stb, list): |
|
1656 | 1656 | raise TypeError(msg) |
|
1657 | 1657 | # it's a list |
|
1658 | 1658 | for line in stb: |
|
1659 | 1659 | # check every element |
|
1660 | 1660 | if not isinstance(line, str): |
|
1661 | 1661 | raise TypeError(msg) |
|
1662 | 1662 | return stb |
|
1663 | 1663 | |
|
1664 | 1664 | if handler is None: |
|
1665 | 1665 | wrapped = dummy_handler |
|
1666 | 1666 | else: |
|
1667 | 1667 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1668 | 1668 | """wrap CustomTB handler, to protect IPython from user code |
|
1669 | 1669 | |
|
1670 | 1670 | This makes it harder (but not impossible) for custom exception |
|
1671 | 1671 | handlers to crash IPython. |
|
1672 | 1672 | """ |
|
1673 | 1673 | try: |
|
1674 | 1674 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1675 | 1675 | return validate_stb(stb) |
|
1676 | 1676 | except: |
|
1677 | 1677 | # clear custom handler immediately |
|
1678 | 1678 | self.set_custom_exc((), None) |
|
1679 | 1679 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1680 | 1680 | # show the exception in handler first |
|
1681 | 1681 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1682 | 1682 | print(self.InteractiveTB.stb2text(stb)) |
|
1683 | 1683 | print("The original exception:") |
|
1684 | 1684 | stb = self.InteractiveTB.structured_traceback( |
|
1685 | 1685 | (etype,value,tb), tb_offset=tb_offset |
|
1686 | 1686 | ) |
|
1687 | 1687 | return stb |
|
1688 | 1688 | |
|
1689 | 1689 | self.CustomTB = types.MethodType(wrapped,self) |
|
1690 | 1690 | self.custom_exceptions = exc_tuple |
|
1691 | 1691 | |
|
1692 | 1692 | def excepthook(self, etype, value, tb): |
|
1693 | 1693 | """One more defense for GUI apps that call sys.excepthook. |
|
1694 | 1694 | |
|
1695 | 1695 | GUI frameworks like wxPython trap exceptions and call |
|
1696 | 1696 | sys.excepthook themselves. I guess this is a feature that |
|
1697 | 1697 | enables them to keep running after exceptions that would |
|
1698 | 1698 | otherwise kill their mainloop. This is a bother for IPython |
|
1699 | 1699 | which excepts to catch all of the program exceptions with a try: |
|
1700 | 1700 | except: statement. |
|
1701 | 1701 | |
|
1702 | 1702 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1703 | 1703 | any app directly invokes sys.excepthook, it will look to the user like |
|
1704 | 1704 | IPython crashed. In order to work around this, we can disable the |
|
1705 | 1705 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1706 | 1706 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1707 | 1707 | call sys.excepthook will generate a regular-looking exception from |
|
1708 | 1708 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1709 | 1709 | crashes. |
|
1710 | 1710 | |
|
1711 | 1711 | This hook should be used sparingly, only in places which are not likely |
|
1712 | 1712 | to be true IPython errors. |
|
1713 | 1713 | """ |
|
1714 | 1714 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1715 | 1715 | |
|
1716 | 1716 | def _get_exc_info(self, exc_tuple=None): |
|
1717 | 1717 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1718 | 1718 | |
|
1719 | 1719 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1720 | 1720 | from whichever source. |
|
1721 | 1721 | |
|
1722 | 1722 | raises ValueError if none of these contain any information |
|
1723 | 1723 | """ |
|
1724 | 1724 | if exc_tuple is None: |
|
1725 | 1725 | etype, value, tb = sys.exc_info() |
|
1726 | 1726 | else: |
|
1727 | 1727 | etype, value, tb = exc_tuple |
|
1728 | 1728 | |
|
1729 | 1729 | if etype is None: |
|
1730 | 1730 | if hasattr(sys, 'last_type'): |
|
1731 | 1731 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1732 | 1732 | sys.last_traceback |
|
1733 | 1733 | |
|
1734 | 1734 | if etype is None: |
|
1735 | 1735 | raise ValueError("No exception to find") |
|
1736 | 1736 | |
|
1737 | 1737 | # Now store the exception info in sys.last_type etc. |
|
1738 | 1738 | # WARNING: these variables are somewhat deprecated and not |
|
1739 | 1739 | # necessarily safe to use in a threaded environment, but tools |
|
1740 | 1740 | # like pdb depend on their existence, so let's set them. If we |
|
1741 | 1741 | # find problems in the field, we'll need to revisit their use. |
|
1742 | 1742 | sys.last_type = etype |
|
1743 | 1743 | sys.last_value = value |
|
1744 | 1744 | sys.last_traceback = tb |
|
1745 | 1745 | |
|
1746 | 1746 | return etype, value, tb |
|
1747 | 1747 | |
|
1748 | 1748 | def show_usage_error(self, exc): |
|
1749 | 1749 | """Show a short message for UsageErrors |
|
1750 | 1750 | |
|
1751 | 1751 | These are special exceptions that shouldn't show a traceback. |
|
1752 | 1752 | """ |
|
1753 | 1753 | print("UsageError: %s" % exc, file=sys.stderr) |
|
1754 | 1754 | |
|
1755 | 1755 | def get_exception_only(self, exc_tuple=None): |
|
1756 | 1756 | """ |
|
1757 | 1757 | Return as a string (ending with a newline) the exception that |
|
1758 | 1758 | just occurred, without any traceback. |
|
1759 | 1759 | """ |
|
1760 | 1760 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1761 | 1761 | msg = traceback.format_exception_only(etype, value) |
|
1762 | 1762 | return ''.join(msg) |
|
1763 | 1763 | |
|
1764 | 1764 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
1765 | 1765 | exception_only=False): |
|
1766 | 1766 | """Display the exception that just occurred. |
|
1767 | 1767 | |
|
1768 | 1768 | If nothing is known about the exception, this is the method which |
|
1769 | 1769 | should be used throughout the code for presenting user tracebacks, |
|
1770 | 1770 | rather than directly invoking the InteractiveTB object. |
|
1771 | 1771 | |
|
1772 | 1772 | A specific showsyntaxerror() also exists, but this method can take |
|
1773 | 1773 | care of calling it if needed, so unless you are explicitly catching a |
|
1774 | 1774 | SyntaxError exception, don't try to analyze the stack manually and |
|
1775 | 1775 | simply call this method.""" |
|
1776 | 1776 | |
|
1777 | 1777 | try: |
|
1778 | 1778 | try: |
|
1779 | 1779 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
1780 | 1780 | except ValueError: |
|
1781 | 1781 | print('No traceback available to show.', file=sys.stderr) |
|
1782 | 1782 | return |
|
1783 | 1783 | |
|
1784 | 1784 | if issubclass(etype, SyntaxError): |
|
1785 | 1785 | # Though this won't be called by syntax errors in the input |
|
1786 | 1786 | # line, there may be SyntaxError cases with imported code. |
|
1787 | 1787 | self.showsyntaxerror(filename) |
|
1788 | 1788 | elif etype is UsageError: |
|
1789 | 1789 | self.show_usage_error(value) |
|
1790 | 1790 | else: |
|
1791 | 1791 | if exception_only: |
|
1792 | 1792 | stb = ['An exception has occurred, use %tb to see ' |
|
1793 | 1793 | 'the full traceback.\n'] |
|
1794 | 1794 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
1795 | 1795 | value)) |
|
1796 | 1796 | else: |
|
1797 | 1797 | try: |
|
1798 | 1798 | # Exception classes can customise their traceback - we |
|
1799 | 1799 | # use this in IPython.parallel for exceptions occurring |
|
1800 | 1800 | # in the engines. This should return a list of strings. |
|
1801 | 1801 | stb = value._render_traceback_() |
|
1802 | 1802 | except Exception: |
|
1803 | 1803 | stb = self.InteractiveTB.structured_traceback(etype, |
|
1804 | 1804 | value, tb, tb_offset=tb_offset) |
|
1805 | 1805 | |
|
1806 | 1806 | self._showtraceback(etype, value, stb) |
|
1807 | 1807 | if self.call_pdb: |
|
1808 | 1808 | # drop into debugger |
|
1809 | 1809 | self.debugger(force=True) |
|
1810 | 1810 | return |
|
1811 | 1811 | |
|
1812 | 1812 | # Actually show the traceback |
|
1813 | 1813 | self._showtraceback(etype, value, stb) |
|
1814 | 1814 | |
|
1815 | 1815 | except KeyboardInterrupt: |
|
1816 | 1816 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
1817 | 1817 | |
|
1818 | 1818 | def _showtraceback(self, etype, evalue, stb): |
|
1819 | 1819 | """Actually show a traceback. |
|
1820 | 1820 | |
|
1821 | 1821 | Subclasses may override this method to put the traceback on a different |
|
1822 | 1822 | place, like a side channel. |
|
1823 | 1823 | """ |
|
1824 | 1824 | print(self.InteractiveTB.stb2text(stb)) |
|
1825 | 1825 | |
|
1826 | 1826 | def showsyntaxerror(self, filename=None): |
|
1827 | 1827 | """Display the syntax error that just occurred. |
|
1828 | 1828 | |
|
1829 | 1829 | This doesn't display a stack trace because there isn't one. |
|
1830 | 1830 | |
|
1831 | 1831 | If a filename is given, it is stuffed in the exception instead |
|
1832 | 1832 | of what was there before (because Python's parser always uses |
|
1833 | 1833 | "<string>" when reading from a string). |
|
1834 | 1834 | """ |
|
1835 | 1835 | etype, value, last_traceback = self._get_exc_info() |
|
1836 | 1836 | |
|
1837 | 1837 | if filename and issubclass(etype, SyntaxError): |
|
1838 | 1838 | try: |
|
1839 | 1839 | value.filename = filename |
|
1840 | 1840 | except: |
|
1841 | 1841 | # Not the format we expect; leave it alone |
|
1842 | 1842 | pass |
|
1843 | 1843 | |
|
1844 | 1844 | stb = self.SyntaxTB.structured_traceback(etype, value, []) |
|
1845 | 1845 | self._showtraceback(etype, value, stb) |
|
1846 | 1846 | |
|
1847 | 1847 | # This is overridden in TerminalInteractiveShell to show a message about |
|
1848 | 1848 | # the %paste magic. |
|
1849 | 1849 | def showindentationerror(self): |
|
1850 | 1850 | """Called by run_cell when there's an IndentationError in code entered |
|
1851 | 1851 | at the prompt. |
|
1852 | 1852 | |
|
1853 | 1853 | This is overridden in TerminalInteractiveShell to show a message about |
|
1854 | 1854 | the %paste magic.""" |
|
1855 | 1855 | self.showsyntaxerror() |
|
1856 | 1856 | |
|
1857 | 1857 | #------------------------------------------------------------------------- |
|
1858 | 1858 | # Things related to readline |
|
1859 | 1859 | #------------------------------------------------------------------------- |
|
1860 | 1860 | |
|
1861 | 1861 | def init_readline(self): |
|
1862 | 1862 | """DEPRECATED |
|
1863 | 1863 | |
|
1864 | 1864 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
1865 | 1865 | # Set a number of methods that depend on readline to be no-op |
|
1866 | 1866 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
1867 | 1867 | DeprecationWarning, stacklevel=2) |
|
1868 | 1868 | self.set_custom_completer = no_op |
|
1869 | 1869 | |
|
1870 | 1870 | @skip_doctest |
|
1871 | 1871 | def set_next_input(self, s, replace=False): |
|
1872 | 1872 | """ Sets the 'default' input string for the next command line. |
|
1873 | 1873 | |
|
1874 | 1874 | Example:: |
|
1875 | 1875 | |
|
1876 | 1876 | In [1]: _ip.set_next_input("Hello Word") |
|
1877 | 1877 | In [2]: Hello Word_ # cursor is here |
|
1878 | 1878 | """ |
|
1879 | 1879 | self.rl_next_input = py3compat.cast_bytes_py2(s) |
|
1880 | 1880 | |
|
1881 | 1881 | def _indent_current_str(self): |
|
1882 | 1882 | """return the current level of indentation as a string""" |
|
1883 | 1883 | return self.input_splitter.indent_spaces * ' ' |
|
1884 | 1884 | |
|
1885 | 1885 | #------------------------------------------------------------------------- |
|
1886 | 1886 | # Things related to text completion |
|
1887 | 1887 | #------------------------------------------------------------------------- |
|
1888 | 1888 | |
|
1889 | 1889 | def init_completer(self): |
|
1890 | 1890 | """Initialize the completion machinery. |
|
1891 | 1891 | |
|
1892 | 1892 | This creates completion machinery that can be used by client code, |
|
1893 | 1893 | either interactively in-process (typically triggered by the readline |
|
1894 | 1894 | library), programmatically (such as in test suites) or out-of-process |
|
1895 | 1895 | (typically over the network by remote frontends). |
|
1896 | 1896 | """ |
|
1897 | 1897 | from IPython.core.completer import IPCompleter |
|
1898 | 1898 | from IPython.core.completerlib import (module_completer, |
|
1899 | 1899 | magic_run_completer, cd_completer, reset_completer) |
|
1900 | 1900 | |
|
1901 | 1901 | self.Completer = IPCompleter(shell=self, |
|
1902 | 1902 | namespace=self.user_ns, |
|
1903 | 1903 | global_namespace=self.user_global_ns, |
|
1904 | 1904 | parent=self, |
|
1905 | 1905 | ) |
|
1906 | 1906 | self.configurables.append(self.Completer) |
|
1907 | 1907 | |
|
1908 | 1908 | # Add custom completers to the basic ones built into IPCompleter |
|
1909 | 1909 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
1910 | 1910 | self.strdispatchers['complete_command'] = sdisp |
|
1911 | 1911 | self.Completer.custom_completers = sdisp |
|
1912 | 1912 | |
|
1913 | 1913 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
1914 | 1914 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
1915 | 1915 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
1916 | 1916 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
1917 | 1917 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
1918 | 1918 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
1919 | 1919 | |
|
1920 | 1920 | |
|
1921 | 1921 | def complete(self, text, line=None, cursor_pos=None): |
|
1922 | 1922 | """Return the completed text and a list of completions. |
|
1923 | 1923 | |
|
1924 | 1924 | Parameters |
|
1925 | 1925 | ---------- |
|
1926 | 1926 | |
|
1927 | 1927 | text : string |
|
1928 | 1928 | A string of text to be completed on. It can be given as empty and |
|
1929 | 1929 | instead a line/position pair are given. In this case, the |
|
1930 | 1930 | completer itself will split the line like readline does. |
|
1931 | 1931 | |
|
1932 | 1932 | line : string, optional |
|
1933 | 1933 | The complete line that text is part of. |
|
1934 | 1934 | |
|
1935 | 1935 | cursor_pos : int, optional |
|
1936 | 1936 | The position of the cursor on the input line. |
|
1937 | 1937 | |
|
1938 | 1938 | Returns |
|
1939 | 1939 | ------- |
|
1940 | 1940 | text : string |
|
1941 | 1941 | The actual text that was completed. |
|
1942 | 1942 | |
|
1943 | 1943 | matches : list |
|
1944 | 1944 | A sorted list with all possible completions. |
|
1945 | 1945 | |
|
1946 | 1946 | The optional arguments allow the completion to take more context into |
|
1947 | 1947 | account, and are part of the low-level completion API. |
|
1948 | 1948 | |
|
1949 | 1949 | This is a wrapper around the completion mechanism, similar to what |
|
1950 | 1950 | readline does at the command line when the TAB key is hit. By |
|
1951 | 1951 | exposing it as a method, it can be used by other non-readline |
|
1952 | 1952 | environments (such as GUIs) for text completion. |
|
1953 | 1953 | |
|
1954 | 1954 | Simple usage example: |
|
1955 | 1955 | |
|
1956 | 1956 | In [1]: x = 'hello' |
|
1957 | 1957 | |
|
1958 | 1958 | In [2]: _ip.complete('x.l') |
|
1959 | 1959 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
1960 | 1960 | """ |
|
1961 | 1961 | |
|
1962 | 1962 | # Inject names into __builtin__ so we can complete on the added names. |
|
1963 | 1963 | with self.builtin_trap: |
|
1964 | 1964 | return self.Completer.complete(text, line, cursor_pos) |
|
1965 | 1965 | |
|
1966 | 1966 | def set_custom_completer(self, completer, pos=0): |
|
1967 | 1967 | """Adds a new custom completer function. |
|
1968 | 1968 | |
|
1969 | 1969 | The position argument (defaults to 0) is the index in the completers |
|
1970 | 1970 | list where you want the completer to be inserted.""" |
|
1971 | 1971 | |
|
1972 | 1972 | newcomp = types.MethodType(completer,self.Completer) |
|
1973 | 1973 | self.Completer.matchers.insert(pos,newcomp) |
|
1974 | 1974 | |
|
1975 | 1975 | def set_completer_frame(self, frame=None): |
|
1976 | 1976 | """Set the frame of the completer.""" |
|
1977 | 1977 | if frame: |
|
1978 | 1978 | self.Completer.namespace = frame.f_locals |
|
1979 | 1979 | self.Completer.global_namespace = frame.f_globals |
|
1980 | 1980 | else: |
|
1981 | 1981 | self.Completer.namespace = self.user_ns |
|
1982 | 1982 | self.Completer.global_namespace = self.user_global_ns |
|
1983 | 1983 | |
|
1984 | 1984 | #------------------------------------------------------------------------- |
|
1985 | 1985 | # Things related to magics |
|
1986 | 1986 | #------------------------------------------------------------------------- |
|
1987 | 1987 | |
|
1988 | 1988 | def init_magics(self): |
|
1989 | 1989 | from IPython.core import magics as m |
|
1990 | 1990 | self.magics_manager = magic.MagicsManager(shell=self, |
|
1991 | 1991 | parent=self, |
|
1992 | 1992 | user_magics=m.UserMagics(self)) |
|
1993 | 1993 | self.configurables.append(self.magics_manager) |
|
1994 | 1994 | |
|
1995 | 1995 | # Expose as public API from the magics manager |
|
1996 | 1996 | self.register_magics = self.magics_manager.register |
|
1997 | 1997 | |
|
1998 | 1998 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
1999 | 1999 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2000 | 2000 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2001 | 2001 | m.NamespaceMagics, m.OSMagics, m.PylabMagics, m.ScriptMagics, |
|
2002 | 2002 | ) |
|
2003 | 2003 | |
|
2004 | 2004 | # Register Magic Aliases |
|
2005 | 2005 | mman = self.magics_manager |
|
2006 | 2006 | # FIXME: magic aliases should be defined by the Magics classes |
|
2007 | 2007 | # or in MagicsManager, not here |
|
2008 | 2008 | mman.register_alias('ed', 'edit') |
|
2009 | 2009 | mman.register_alias('hist', 'history') |
|
2010 | 2010 | mman.register_alias('rep', 'recall') |
|
2011 | 2011 | mman.register_alias('SVG', 'svg', 'cell') |
|
2012 | 2012 | mman.register_alias('HTML', 'html', 'cell') |
|
2013 | 2013 | mman.register_alias('file', 'writefile', 'cell') |
|
2014 | 2014 | |
|
2015 | 2015 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2016 | 2016 | # should be split into a prompt manager and displayhook. We probably |
|
2017 | 2017 | # even need a centralize colors management object. |
|
2018 | 2018 | self.magic('colors %s' % self.colors) |
|
2019 | 2019 | |
|
2020 | 2020 | # Defined here so that it's included in the documentation |
|
2021 | 2021 | @functools.wraps(magic.MagicsManager.register_function) |
|
2022 | 2022 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2023 | 2023 | self.magics_manager.register_function(func, |
|
2024 | 2024 | magic_kind=magic_kind, magic_name=magic_name) |
|
2025 | 2025 | |
|
2026 | 2026 | def run_line_magic(self, magic_name, line): |
|
2027 | 2027 | """Execute the given line magic. |
|
2028 | 2028 | |
|
2029 | 2029 | Parameters |
|
2030 | 2030 | ---------- |
|
2031 | 2031 | magic_name : str |
|
2032 | 2032 | Name of the desired magic function, without '%' prefix. |
|
2033 | 2033 | |
|
2034 | 2034 | line : str |
|
2035 | 2035 | The rest of the input line as a single string. |
|
2036 | 2036 | """ |
|
2037 | 2037 | fn = self.find_line_magic(magic_name) |
|
2038 | 2038 | if fn is None: |
|
2039 | 2039 | cm = self.find_cell_magic(magic_name) |
|
2040 | 2040 | etpl = "Line magic function `%%%s` not found%s." |
|
2041 | 2041 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2042 | 2042 | 'did you mean that instead?)' % magic_name ) |
|
2043 | 2043 | error(etpl % (magic_name, extra)) |
|
2044 | 2044 | else: |
|
2045 | 2045 | # Note: this is the distance in the stack to the user's frame. |
|
2046 | 2046 | # This will need to be updated if the internal calling logic gets |
|
2047 | 2047 | # refactored, or else we'll be expanding the wrong variables. |
|
2048 | 2048 | stack_depth = 2 |
|
2049 | 2049 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2050 | 2050 | # Put magic args in a list so we can call with f(*a) syntax |
|
2051 | 2051 | args = [magic_arg_s] |
|
2052 | 2052 | kwargs = {} |
|
2053 | 2053 | # Grab local namespace if we need it: |
|
2054 | 2054 | if getattr(fn, "needs_local_scope", False): |
|
2055 | 2055 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2056 | 2056 | with self.builtin_trap: |
|
2057 | 2057 | result = fn(*args,**kwargs) |
|
2058 | 2058 | return result |
|
2059 | 2059 | |
|
2060 | 2060 | def run_cell_magic(self, magic_name, line, cell): |
|
2061 | 2061 | """Execute the given cell magic. |
|
2062 | 2062 | |
|
2063 | 2063 | Parameters |
|
2064 | 2064 | ---------- |
|
2065 | 2065 | magic_name : str |
|
2066 | 2066 | Name of the desired magic function, without '%' prefix. |
|
2067 | 2067 | |
|
2068 | 2068 | line : str |
|
2069 | 2069 | The rest of the first input line as a single string. |
|
2070 | 2070 | |
|
2071 | 2071 | cell : str |
|
2072 | 2072 | The body of the cell as a (possibly multiline) string. |
|
2073 | 2073 | """ |
|
2074 | 2074 | fn = self.find_cell_magic(magic_name) |
|
2075 | 2075 | if fn is None: |
|
2076 | 2076 | lm = self.find_line_magic(magic_name) |
|
2077 | 2077 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2078 | 2078 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2079 | 2079 | 'did you mean that instead?)'.format(magic_name)) |
|
2080 | 2080 | error(etpl.format(magic_name, extra)) |
|
2081 | 2081 | elif cell == '': |
|
2082 | 2082 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2083 | 2083 | if self.find_line_magic(magic_name) is not None: |
|
2084 | 2084 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2085 | 2085 | raise UsageError(message) |
|
2086 | 2086 | else: |
|
2087 | 2087 | # Note: this is the distance in the stack to the user's frame. |
|
2088 | 2088 | # This will need to be updated if the internal calling logic gets |
|
2089 | 2089 | # refactored, or else we'll be expanding the wrong variables. |
|
2090 | 2090 | stack_depth = 2 |
|
2091 | 2091 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2092 | 2092 | with self.builtin_trap: |
|
2093 | 2093 | result = fn(magic_arg_s, cell) |
|
2094 | 2094 | return result |
|
2095 | 2095 | |
|
2096 | 2096 | def find_line_magic(self, magic_name): |
|
2097 | 2097 | """Find and return a line magic by name. |
|
2098 | 2098 | |
|
2099 | 2099 | Returns None if the magic isn't found.""" |
|
2100 | 2100 | return self.magics_manager.magics['line'].get(magic_name) |
|
2101 | 2101 | |
|
2102 | 2102 | def find_cell_magic(self, magic_name): |
|
2103 | 2103 | """Find and return a cell magic by name. |
|
2104 | 2104 | |
|
2105 | 2105 | Returns None if the magic isn't found.""" |
|
2106 | 2106 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2107 | 2107 | |
|
2108 | 2108 | def find_magic(self, magic_name, magic_kind='line'): |
|
2109 | 2109 | """Find and return a magic of the given type by name. |
|
2110 | 2110 | |
|
2111 | 2111 | Returns None if the magic isn't found.""" |
|
2112 | 2112 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2113 | 2113 | |
|
2114 | 2114 | def magic(self, arg_s): |
|
2115 | 2115 | """DEPRECATED. Use run_line_magic() instead. |
|
2116 | 2116 | |
|
2117 | 2117 | Call a magic function by name. |
|
2118 | 2118 | |
|
2119 | 2119 | Input: a string containing the name of the magic function to call and |
|
2120 | 2120 | any additional arguments to be passed to the magic. |
|
2121 | 2121 | |
|
2122 | 2122 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2123 | 2123 | prompt: |
|
2124 | 2124 | |
|
2125 | 2125 | In[1]: %name -opt foo bar |
|
2126 | 2126 | |
|
2127 | 2127 | To call a magic without arguments, simply use magic('name'). |
|
2128 | 2128 | |
|
2129 | 2129 | This provides a proper Python function to call IPython's magics in any |
|
2130 | 2130 | valid Python code you can type at the interpreter, including loops and |
|
2131 | 2131 | compound statements. |
|
2132 | 2132 | """ |
|
2133 | 2133 | # TODO: should we issue a loud deprecation warning here? |
|
2134 | 2134 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2135 | 2135 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2136 | 2136 | return self.run_line_magic(magic_name, magic_arg_s) |
|
2137 | 2137 | |
|
2138 | 2138 | #------------------------------------------------------------------------- |
|
2139 | 2139 | # Things related to macros |
|
2140 | 2140 | #------------------------------------------------------------------------- |
|
2141 | 2141 | |
|
2142 | 2142 | def define_macro(self, name, themacro): |
|
2143 | 2143 | """Define a new macro |
|
2144 | 2144 | |
|
2145 | 2145 | Parameters |
|
2146 | 2146 | ---------- |
|
2147 | 2147 | name : str |
|
2148 | 2148 | The name of the macro. |
|
2149 | 2149 | themacro : str or Macro |
|
2150 | 2150 | The action to do upon invoking the macro. If a string, a new |
|
2151 | 2151 | Macro object is created by passing the string to it. |
|
2152 | 2152 | """ |
|
2153 | 2153 | |
|
2154 | 2154 | from IPython.core import macro |
|
2155 | 2155 | |
|
2156 | 2156 | if isinstance(themacro, str): |
|
2157 | 2157 | themacro = macro.Macro(themacro) |
|
2158 | 2158 | if not isinstance(themacro, macro.Macro): |
|
2159 | 2159 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2160 | 2160 | self.user_ns[name] = themacro |
|
2161 | 2161 | |
|
2162 | 2162 | #------------------------------------------------------------------------- |
|
2163 | 2163 | # Things related to the running of system commands |
|
2164 | 2164 | #------------------------------------------------------------------------- |
|
2165 | 2165 | |
|
2166 | 2166 | def system_piped(self, cmd): |
|
2167 | 2167 | """Call the given cmd in a subprocess, piping stdout/err |
|
2168 | 2168 | |
|
2169 | 2169 | Parameters |
|
2170 | 2170 | ---------- |
|
2171 | 2171 | cmd : str |
|
2172 | 2172 | Command to execute (can not end in '&', as background processes are |
|
2173 | 2173 | not supported. Should not be a command that expects input |
|
2174 | 2174 | other than simple text. |
|
2175 | 2175 | """ |
|
2176 | 2176 | if cmd.rstrip().endswith('&'): |
|
2177 | 2177 | # this is *far* from a rigorous test |
|
2178 | 2178 | # We do not support backgrounding processes because we either use |
|
2179 | 2179 | # pexpect or pipes to read from. Users can always just call |
|
2180 | 2180 | # os.system() or use ip.system=ip.system_raw |
|
2181 | 2181 | # if they really want a background process. |
|
2182 | 2182 | raise OSError("Background processes not supported.") |
|
2183 | 2183 | |
|
2184 | 2184 | # we explicitly do NOT return the subprocess status code, because |
|
2185 | 2185 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2186 | 2186 | # Instead, we store the exit_code in user_ns. |
|
2187 | 2187 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2188 | 2188 | |
|
2189 | 2189 | def system_raw(self, cmd): |
|
2190 | 2190 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2191 | 2191 | subprocess.call using the system shell on other platforms. |
|
2192 | 2192 | |
|
2193 | 2193 | Parameters |
|
2194 | 2194 | ---------- |
|
2195 | 2195 | cmd : str |
|
2196 | 2196 | Command to execute. |
|
2197 | 2197 | """ |
|
2198 | 2198 | cmd = self.var_expand(cmd, depth=1) |
|
2199 | 2199 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2200 | 2200 | if sys.platform == 'win32': |
|
2201 | 2201 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2202 | 2202 | with AvoidUNCPath() as path: |
|
2203 | 2203 | if path is not None: |
|
2204 | 2204 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2205 | 2205 | try: |
|
2206 | 2206 | ec = os.system(cmd) |
|
2207 | 2207 | except KeyboardInterrupt: |
|
2208 | 2208 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2209 | 2209 | ec = -2 |
|
2210 | 2210 | else: |
|
2211 | 2211 | # For posix the result of the subprocess.call() below is an exit |
|
2212 | 2212 | # code, which by convention is zero for success, positive for |
|
2213 | 2213 | # program failure. Exit codes above 128 are reserved for signals, |
|
2214 | 2214 | # and the formula for converting a signal to an exit code is usually |
|
2215 | 2215 | # signal_number+128. To more easily differentiate between exit |
|
2216 | 2216 | # codes and signals, ipython uses negative numbers. For instance |
|
2217 | 2217 | # since control-c is signal 2 but exit code 130, ipython's |
|
2218 | 2218 | # _exit_code variable will read -2. Note that some shells like |
|
2219 | 2219 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2220 | 2220 | executable = os.environ.get('SHELL', None) |
|
2221 | 2221 | try: |
|
2222 | 2222 | # Use env shell instead of default /bin/sh |
|
2223 | 2223 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2224 | 2224 | except KeyboardInterrupt: |
|
2225 | 2225 | # intercept control-C; a long traceback is not useful here |
|
2226 | 2226 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2227 | 2227 | ec = 130 |
|
2228 | 2228 | if ec > 128: |
|
2229 | 2229 | ec = -(ec - 128) |
|
2230 | 2230 | |
|
2231 | 2231 | # We explicitly do NOT return the subprocess status code, because |
|
2232 | 2232 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2233 | 2233 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2234 | 2234 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2235 | 2235 | # but raising SystemExit(_exit_code) will give status 254! |
|
2236 | 2236 | self.user_ns['_exit_code'] = ec |
|
2237 | 2237 | |
|
2238 | 2238 | # use piped system by default, because it is better behaved |
|
2239 | 2239 | system = system_piped |
|
2240 | 2240 | |
|
2241 | 2241 | def getoutput(self, cmd, split=True, depth=0): |
|
2242 | 2242 | """Get output (possibly including stderr) from a subprocess. |
|
2243 | 2243 | |
|
2244 | 2244 | Parameters |
|
2245 | 2245 | ---------- |
|
2246 | 2246 | cmd : str |
|
2247 | 2247 | Command to execute (can not end in '&', as background processes are |
|
2248 | 2248 | not supported. |
|
2249 | 2249 | split : bool, optional |
|
2250 | 2250 | If True, split the output into an IPython SList. Otherwise, an |
|
2251 | 2251 | IPython LSString is returned. These are objects similar to normal |
|
2252 | 2252 | lists and strings, with a few convenience attributes for easier |
|
2253 | 2253 | manipulation of line-based output. You can use '?' on them for |
|
2254 | 2254 | details. |
|
2255 | 2255 | depth : int, optional |
|
2256 | 2256 | How many frames above the caller are the local variables which should |
|
2257 | 2257 | be expanded in the command string? The default (0) assumes that the |
|
2258 | 2258 | expansion variables are in the stack frame calling this function. |
|
2259 | 2259 | """ |
|
2260 | 2260 | if cmd.rstrip().endswith('&'): |
|
2261 | 2261 | # this is *far* from a rigorous test |
|
2262 | 2262 | raise OSError("Background processes not supported.") |
|
2263 | 2263 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2264 | 2264 | if split: |
|
2265 | 2265 | out = SList(out.splitlines()) |
|
2266 | 2266 | else: |
|
2267 | 2267 | out = LSString(out) |
|
2268 | 2268 | return out |
|
2269 | 2269 | |
|
2270 | 2270 | #------------------------------------------------------------------------- |
|
2271 | 2271 | # Things related to aliases |
|
2272 | 2272 | #------------------------------------------------------------------------- |
|
2273 | 2273 | |
|
2274 | 2274 | def init_alias(self): |
|
2275 | 2275 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2276 | 2276 | self.configurables.append(self.alias_manager) |
|
2277 | 2277 | |
|
2278 | 2278 | #------------------------------------------------------------------------- |
|
2279 | 2279 | # Things related to extensions |
|
2280 | 2280 | #------------------------------------------------------------------------- |
|
2281 | 2281 | |
|
2282 | 2282 | def init_extension_manager(self): |
|
2283 | 2283 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2284 | 2284 | self.configurables.append(self.extension_manager) |
|
2285 | 2285 | |
|
2286 | 2286 | #------------------------------------------------------------------------- |
|
2287 | 2287 | # Things related to payloads |
|
2288 | 2288 | #------------------------------------------------------------------------- |
|
2289 | 2289 | |
|
2290 | 2290 | def init_payload(self): |
|
2291 | 2291 | self.payload_manager = PayloadManager(parent=self) |
|
2292 | 2292 | self.configurables.append(self.payload_manager) |
|
2293 | 2293 | |
|
2294 | 2294 | #------------------------------------------------------------------------- |
|
2295 | 2295 | # Things related to the prefilter |
|
2296 | 2296 | #------------------------------------------------------------------------- |
|
2297 | 2297 | |
|
2298 | 2298 | def init_prefilter(self): |
|
2299 | 2299 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2300 | 2300 | self.configurables.append(self.prefilter_manager) |
|
2301 | 2301 | # Ultimately this will be refactored in the new interpreter code, but |
|
2302 | 2302 | # for now, we should expose the main prefilter method (there's legacy |
|
2303 | 2303 | # code out there that may rely on this). |
|
2304 | 2304 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2305 | 2305 | |
|
2306 | 2306 | def auto_rewrite_input(self, cmd): |
|
2307 | 2307 | """Print to the screen the rewritten form of the user's command. |
|
2308 | 2308 | |
|
2309 | 2309 | This shows visual feedback by rewriting input lines that cause |
|
2310 | 2310 | automatic calling to kick in, like:: |
|
2311 | 2311 | |
|
2312 | 2312 | /f x |
|
2313 | 2313 | |
|
2314 | 2314 | into:: |
|
2315 | 2315 | |
|
2316 | 2316 | ------> f(x) |
|
2317 | 2317 | |
|
2318 | 2318 | after the user's input prompt. This helps the user understand that the |
|
2319 | 2319 | input line was transformed automatically by IPython. |
|
2320 | 2320 | """ |
|
2321 | 2321 | if not self.show_rewritten_input: |
|
2322 | 2322 | return |
|
2323 | 2323 | |
|
2324 | 2324 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2325 | 2325 | print("------> " + cmd) |
|
2326 | 2326 | |
|
2327 | 2327 | #------------------------------------------------------------------------- |
|
2328 | 2328 | # Things related to extracting values/expressions from kernel and user_ns |
|
2329 | 2329 | #------------------------------------------------------------------------- |
|
2330 | 2330 | |
|
2331 | 2331 | def _user_obj_error(self): |
|
2332 | 2332 | """return simple exception dict |
|
2333 | 2333 | |
|
2334 | 2334 | for use in user_expressions |
|
2335 | 2335 | """ |
|
2336 | 2336 | |
|
2337 | 2337 | etype, evalue, tb = self._get_exc_info() |
|
2338 | 2338 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2339 | 2339 | |
|
2340 | 2340 | exc_info = { |
|
2341 | 2341 | u'status' : 'error', |
|
2342 | 2342 | u'traceback' : stb, |
|
2343 | 2343 | u'ename' : etype.__name__, |
|
2344 | 2344 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2345 | 2345 | } |
|
2346 | 2346 | |
|
2347 | 2347 | return exc_info |
|
2348 | 2348 | |
|
2349 | 2349 | def _format_user_obj(self, obj): |
|
2350 | 2350 | """format a user object to display dict |
|
2351 | 2351 | |
|
2352 | 2352 | for use in user_expressions |
|
2353 | 2353 | """ |
|
2354 | 2354 | |
|
2355 | 2355 | data, md = self.display_formatter.format(obj) |
|
2356 | 2356 | value = { |
|
2357 | 2357 | 'status' : 'ok', |
|
2358 | 2358 | 'data' : data, |
|
2359 | 2359 | 'metadata' : md, |
|
2360 | 2360 | } |
|
2361 | 2361 | return value |
|
2362 | 2362 | |
|
2363 | 2363 | def user_expressions(self, expressions): |
|
2364 | 2364 | """Evaluate a dict of expressions in the user's namespace. |
|
2365 | 2365 | |
|
2366 | 2366 | Parameters |
|
2367 | 2367 | ---------- |
|
2368 | 2368 | expressions : dict |
|
2369 | 2369 | A dict with string keys and string values. The expression values |
|
2370 | 2370 | should be valid Python expressions, each of which will be evaluated |
|
2371 | 2371 | in the user namespace. |
|
2372 | 2372 | |
|
2373 | 2373 | Returns |
|
2374 | 2374 | ------- |
|
2375 | 2375 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2376 | 2376 | display_data of each value. |
|
2377 | 2377 | """ |
|
2378 | 2378 | out = {} |
|
2379 | 2379 | user_ns = self.user_ns |
|
2380 | 2380 | global_ns = self.user_global_ns |
|
2381 | 2381 | |
|
2382 | 2382 | for key, expr in expressions.items(): |
|
2383 | 2383 | try: |
|
2384 | 2384 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2385 | 2385 | except: |
|
2386 | 2386 | value = self._user_obj_error() |
|
2387 | 2387 | out[key] = value |
|
2388 | 2388 | return out |
|
2389 | 2389 | |
|
2390 | 2390 | #------------------------------------------------------------------------- |
|
2391 | 2391 | # Things related to the running of code |
|
2392 | 2392 | #------------------------------------------------------------------------- |
|
2393 | 2393 | |
|
2394 | 2394 | def ex(self, cmd): |
|
2395 | 2395 | """Execute a normal python statement in user namespace.""" |
|
2396 | 2396 | with self.builtin_trap: |
|
2397 | 2397 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2398 | 2398 | |
|
2399 | 2399 | def ev(self, expr): |
|
2400 | 2400 | """Evaluate python expression expr in user namespace. |
|
2401 | 2401 | |
|
2402 | 2402 | Returns the result of evaluation |
|
2403 | 2403 | """ |
|
2404 | 2404 | with self.builtin_trap: |
|
2405 | 2405 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2406 | 2406 | |
|
2407 | 2407 | def safe_execfile(self, fname, *where, **kw): |
|
2408 | 2408 | """A safe version of the builtin execfile(). |
|
2409 | 2409 | |
|
2410 | 2410 | This version will never throw an exception, but instead print |
|
2411 | 2411 | helpful error messages to the screen. This only works on pure |
|
2412 | 2412 | Python files with the .py extension. |
|
2413 | 2413 | |
|
2414 | 2414 | Parameters |
|
2415 | 2415 | ---------- |
|
2416 | 2416 | fname : string |
|
2417 | 2417 | The name of the file to be executed. |
|
2418 | 2418 | where : tuple |
|
2419 | 2419 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2420 | 2420 | If only one is given, it is passed as both. |
|
2421 | 2421 | exit_ignore : bool (False) |
|
2422 | 2422 | If True, then silence SystemExit for non-zero status (it is always |
|
2423 | 2423 | silenced for zero status, as it is so common). |
|
2424 | 2424 | raise_exceptions : bool (False) |
|
2425 | 2425 | If True raise exceptions everywhere. Meant for testing. |
|
2426 | 2426 | shell_futures : bool (False) |
|
2427 | 2427 | If True, the code will share future statements with the interactive |
|
2428 | 2428 | shell. It will both be affected by previous __future__ imports, and |
|
2429 | 2429 | any __future__ imports in the code will affect the shell. If False, |
|
2430 | 2430 | __future__ imports are not shared in either direction. |
|
2431 | 2431 | |
|
2432 | 2432 | """ |
|
2433 | 2433 | kw.setdefault('exit_ignore', False) |
|
2434 | 2434 | kw.setdefault('raise_exceptions', False) |
|
2435 | 2435 | kw.setdefault('shell_futures', False) |
|
2436 | 2436 | |
|
2437 | 2437 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2438 | 2438 | |
|
2439 | 2439 | # Make sure we can open the file |
|
2440 | 2440 | try: |
|
2441 | 2441 | with open(fname): |
|
2442 | 2442 | pass |
|
2443 | 2443 | except: |
|
2444 | 2444 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2445 | 2445 | return |
|
2446 | 2446 | |
|
2447 | 2447 | # Find things also in current directory. This is needed to mimic the |
|
2448 | 2448 | # behavior of running a script from the system command line, where |
|
2449 | 2449 | # Python inserts the script's directory into sys.path |
|
2450 | 2450 | dname = os.path.dirname(fname) |
|
2451 | 2451 | |
|
2452 | 2452 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2453 | 2453 | try: |
|
2454 | 2454 | glob, loc = (where + (None, ))[:2] |
|
2455 | 2455 | py3compat.execfile( |
|
2456 | 2456 | fname, glob, loc, |
|
2457 | 2457 | self.compile if kw['shell_futures'] else None) |
|
2458 | 2458 | except SystemExit as status: |
|
2459 | 2459 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2460 | 2460 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2461 | 2461 | # these are considered normal by the OS: |
|
2462 | 2462 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2463 | 2463 | # 0 |
|
2464 | 2464 | # > python -c'import sys;sys.exit()'; echo $? |
|
2465 | 2465 | # 0 |
|
2466 | 2466 | # For other exit status, we show the exception unless |
|
2467 | 2467 | # explicitly silenced, but only in short form. |
|
2468 | 2468 | if status.code: |
|
2469 | 2469 | if kw['raise_exceptions']: |
|
2470 | 2470 | raise |
|
2471 | 2471 | if not kw['exit_ignore']: |
|
2472 | 2472 | self.showtraceback(exception_only=True) |
|
2473 | 2473 | except: |
|
2474 | 2474 | if kw['raise_exceptions']: |
|
2475 | 2475 | raise |
|
2476 | 2476 | # tb offset is 2 because we wrap execfile |
|
2477 | 2477 | self.showtraceback(tb_offset=2) |
|
2478 | 2478 | |
|
2479 | 2479 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2480 | 2480 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2481 | 2481 | |
|
2482 | 2482 | Parameters |
|
2483 | 2483 | ---------- |
|
2484 | 2484 | fname : str |
|
2485 | 2485 | The name of the file to execute. The filename must have a |
|
2486 | 2486 | .ipy or .ipynb extension. |
|
2487 | 2487 | shell_futures : bool (False) |
|
2488 | 2488 | If True, the code will share future statements with the interactive |
|
2489 | 2489 | shell. It will both be affected by previous __future__ imports, and |
|
2490 | 2490 | any __future__ imports in the code will affect the shell. If False, |
|
2491 | 2491 | __future__ imports are not shared in either direction. |
|
2492 | 2492 | raise_exceptions : bool (False) |
|
2493 | 2493 | If True raise exceptions everywhere. Meant for testing. |
|
2494 | 2494 | """ |
|
2495 | 2495 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2496 | 2496 | |
|
2497 | 2497 | # Make sure we can open the file |
|
2498 | 2498 | try: |
|
2499 | 2499 | with open(fname): |
|
2500 | 2500 | pass |
|
2501 | 2501 | except: |
|
2502 | 2502 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2503 | 2503 | return |
|
2504 | 2504 | |
|
2505 | 2505 | # Find things also in current directory. This is needed to mimic the |
|
2506 | 2506 | # behavior of running a script from the system command line, where |
|
2507 | 2507 | # Python inserts the script's directory into sys.path |
|
2508 | 2508 | dname = os.path.dirname(fname) |
|
2509 | 2509 | |
|
2510 | 2510 | def get_cells(): |
|
2511 | 2511 | """generator for sequence of code blocks to run""" |
|
2512 | 2512 | if fname.endswith('.ipynb'): |
|
2513 | 2513 | from nbformat import read |
|
2514 | 2514 | with io_open(fname) as f: |
|
2515 | 2515 | nb = read(f, as_version=4) |
|
2516 | 2516 | if not nb.cells: |
|
2517 | 2517 | return |
|
2518 | 2518 | for cell in nb.cells: |
|
2519 | 2519 | if cell.cell_type == 'code': |
|
2520 | 2520 | yield cell.source |
|
2521 | 2521 | else: |
|
2522 | 2522 | with open(fname) as f: |
|
2523 | 2523 | yield f.read() |
|
2524 | 2524 | |
|
2525 | 2525 | with prepended_to_syspath(dname): |
|
2526 | 2526 | try: |
|
2527 | 2527 | for cell in get_cells(): |
|
2528 | 2528 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2529 | 2529 | if raise_exceptions: |
|
2530 | 2530 | result.raise_error() |
|
2531 | 2531 | elif not result.success: |
|
2532 | 2532 | break |
|
2533 | 2533 | except: |
|
2534 | 2534 | if raise_exceptions: |
|
2535 | 2535 | raise |
|
2536 | 2536 | self.showtraceback() |
|
2537 | 2537 | warn('Unknown failure executing file: <%s>' % fname) |
|
2538 | 2538 | |
|
2539 | 2539 | def safe_run_module(self, mod_name, where): |
|
2540 | 2540 | """A safe version of runpy.run_module(). |
|
2541 | 2541 | |
|
2542 | 2542 | This version will never throw an exception, but instead print |
|
2543 | 2543 | helpful error messages to the screen. |
|
2544 | 2544 | |
|
2545 | 2545 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2546 | 2546 | |
|
2547 | 2547 | Parameters |
|
2548 | 2548 | ---------- |
|
2549 | 2549 | mod_name : string |
|
2550 | 2550 | The name of the module to be executed. |
|
2551 | 2551 | where : dict |
|
2552 | 2552 | The globals namespace. |
|
2553 | 2553 | """ |
|
2554 | 2554 | try: |
|
2555 | 2555 | try: |
|
2556 | 2556 | where.update( |
|
2557 | 2557 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2558 | 2558 | alter_sys=True) |
|
2559 | 2559 | ) |
|
2560 | 2560 | except SystemExit as status: |
|
2561 | 2561 | if status.code: |
|
2562 | 2562 | raise |
|
2563 | 2563 | except: |
|
2564 | 2564 | self.showtraceback() |
|
2565 | 2565 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2566 | 2566 | |
|
2567 | 2567 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2568 | 2568 | """Run a complete IPython cell. |
|
2569 | 2569 | |
|
2570 | 2570 | Parameters |
|
2571 | 2571 | ---------- |
|
2572 | 2572 | raw_cell : str |
|
2573 | 2573 | The code (including IPython code such as %magic functions) to run. |
|
2574 | 2574 | store_history : bool |
|
2575 | 2575 | If True, the raw and translated cell will be stored in IPython's |
|
2576 | 2576 | history. For user code calling back into IPython's machinery, this |
|
2577 | 2577 | should be set to False. |
|
2578 | 2578 | silent : bool |
|
2579 | 2579 | If True, avoid side-effects, such as implicit displayhooks and |
|
2580 | 2580 | and logging. silent=True forces store_history=False. |
|
2581 | 2581 | shell_futures : bool |
|
2582 | 2582 | If True, the code will share future statements with the interactive |
|
2583 | 2583 | shell. It will both be affected by previous __future__ imports, and |
|
2584 | 2584 | any __future__ imports in the code will affect the shell. If False, |
|
2585 | 2585 | __future__ imports are not shared in either direction. |
|
2586 | 2586 | |
|
2587 | 2587 | Returns |
|
2588 | 2588 | ------- |
|
2589 | 2589 | result : :class:`ExecutionResult` |
|
2590 | 2590 | """ |
|
2591 | 2591 | result = ExecutionResult() |
|
2592 | 2592 | |
|
2593 | 2593 | if (not raw_cell) or raw_cell.isspace(): |
|
2594 | 2594 | self.last_execution_succeeded = True |
|
2595 | 2595 | return result |
|
2596 | 2596 | |
|
2597 | 2597 | if silent: |
|
2598 | 2598 | store_history = False |
|
2599 | 2599 | |
|
2600 | 2600 | if store_history: |
|
2601 | 2601 | result.execution_count = self.execution_count |
|
2602 | 2602 | |
|
2603 | 2603 | def error_before_exec(value): |
|
2604 | 2604 | result.error_before_exec = value |
|
2605 | 2605 | self.last_execution_succeeded = False |
|
2606 | 2606 | return result |
|
2607 | 2607 | |
|
2608 | 2608 | self.events.trigger('pre_execute') |
|
2609 | 2609 | if not silent: |
|
2610 | 2610 | self.events.trigger('pre_run_cell') |
|
2611 | 2611 | |
|
2612 | 2612 | # If any of our input transformation (input_transformer_manager or |
|
2613 | 2613 | # prefilter_manager) raises an exception, we store it in this variable |
|
2614 | 2614 | # so that we can display the error after logging the input and storing |
|
2615 | 2615 | # it in the history. |
|
2616 | 2616 | preprocessing_exc_tuple = None |
|
2617 | 2617 | try: |
|
2618 | 2618 | # Static input transformations |
|
2619 | 2619 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
2620 | 2620 | except SyntaxError: |
|
2621 | 2621 | preprocessing_exc_tuple = sys.exc_info() |
|
2622 | 2622 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
2623 | 2623 | else: |
|
2624 | 2624 | if len(cell.splitlines()) == 1: |
|
2625 | 2625 | # Dynamic transformations - only applied for single line commands |
|
2626 | 2626 | with self.builtin_trap: |
|
2627 | 2627 | try: |
|
2628 | 2628 | # use prefilter_lines to handle trailing newlines |
|
2629 | 2629 | # restore trailing newline for ast.parse |
|
2630 | 2630 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
2631 | 2631 | except Exception: |
|
2632 | 2632 | # don't allow prefilter errors to crash IPython |
|
2633 | 2633 | preprocessing_exc_tuple = sys.exc_info() |
|
2634 | 2634 | |
|
2635 | 2635 | # Store raw and processed history |
|
2636 | 2636 | if store_history: |
|
2637 | 2637 | self.history_manager.store_inputs(self.execution_count, |
|
2638 | 2638 | cell, raw_cell) |
|
2639 | 2639 | if not silent: |
|
2640 | 2640 | self.logger.log(cell, raw_cell) |
|
2641 | 2641 | |
|
2642 | 2642 | # Display the exception if input processing failed. |
|
2643 | 2643 | if preprocessing_exc_tuple is not None: |
|
2644 | 2644 | self.showtraceback(preprocessing_exc_tuple) |
|
2645 | 2645 | if store_history: |
|
2646 | 2646 | self.execution_count += 1 |
|
2647 | 2647 | return error_before_exec(preprocessing_exc_tuple[2]) |
|
2648 | 2648 | |
|
2649 | 2649 | # Our own compiler remembers the __future__ environment. If we want to |
|
2650 | 2650 | # run code with a separate __future__ environment, use the default |
|
2651 | 2651 | # compiler |
|
2652 | 2652 | compiler = self.compile if shell_futures else CachingCompiler() |
|
2653 | 2653 | |
|
2654 | 2654 | with self.builtin_trap: |
|
2655 | 2655 | cell_name = self.compile.cache(cell, self.execution_count) |
|
2656 | 2656 | |
|
2657 | 2657 | with self.display_trap: |
|
2658 | 2658 | # Compile to bytecode |
|
2659 | 2659 | try: |
|
2660 | 2660 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
2661 | 2661 | except self.custom_exceptions as e: |
|
2662 | 2662 | etype, value, tb = sys.exc_info() |
|
2663 | 2663 | self.CustomTB(etype, value, tb) |
|
2664 | 2664 | return error_before_exec(e) |
|
2665 | 2665 | except IndentationError as e: |
|
2666 | 2666 | self.showindentationerror() |
|
2667 | 2667 | if store_history: |
|
2668 | 2668 | self.execution_count += 1 |
|
2669 | 2669 | return error_before_exec(e) |
|
2670 | 2670 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
2671 | 2671 | MemoryError) as e: |
|
2672 | 2672 | self.showsyntaxerror() |
|
2673 | 2673 | if store_history: |
|
2674 | 2674 | self.execution_count += 1 |
|
2675 | 2675 | return error_before_exec(e) |
|
2676 | 2676 | |
|
2677 | 2677 | # Apply AST transformations |
|
2678 | 2678 | try: |
|
2679 | 2679 | code_ast = self.transform_ast(code_ast) |
|
2680 | 2680 | except InputRejected as e: |
|
2681 | 2681 | self.showtraceback() |
|
2682 | 2682 | if store_history: |
|
2683 | 2683 | self.execution_count += 1 |
|
2684 | 2684 | return error_before_exec(e) |
|
2685 | 2685 | |
|
2686 | 2686 | # Give the displayhook a reference to our ExecutionResult so it |
|
2687 | 2687 | # can fill in the output value. |
|
2688 | 2688 | self.displayhook.exec_result = result |
|
2689 | 2689 | |
|
2690 | 2690 | # Execute the user code |
|
2691 | 2691 | interactivity = "none" if silent else self.ast_node_interactivity |
|
2692 | 2692 | has_raised = self.run_ast_nodes(code_ast.body, cell_name, |
|
2693 | 2693 | interactivity=interactivity, compiler=compiler, result=result) |
|
2694 | 2694 | |
|
2695 | 2695 | self.last_execution_succeeded = not has_raised |
|
2696 | 2696 | |
|
2697 | 2697 | # Reset this so later displayed values do not modify the |
|
2698 | 2698 | # ExecutionResult |
|
2699 | 2699 | self.displayhook.exec_result = None |
|
2700 | 2700 | |
|
2701 | 2701 | self.events.trigger('post_execute') |
|
2702 | 2702 | if not silent: |
|
2703 | 2703 | self.events.trigger('post_run_cell') |
|
2704 | 2704 | |
|
2705 | 2705 | if store_history: |
|
2706 | 2706 | # Write output to the database. Does nothing unless |
|
2707 | 2707 | # history output logging is enabled. |
|
2708 | 2708 | self.history_manager.store_output(self.execution_count) |
|
2709 | 2709 | # Each cell is a *single* input, regardless of how many lines it has |
|
2710 | 2710 | self.execution_count += 1 |
|
2711 | 2711 | |
|
2712 | 2712 | return result |
|
2713 | 2713 | |
|
2714 | 2714 | def transform_ast(self, node): |
|
2715 | 2715 | """Apply the AST transformations from self.ast_transformers |
|
2716 | 2716 | |
|
2717 | 2717 | Parameters |
|
2718 | 2718 | ---------- |
|
2719 | 2719 | node : ast.Node |
|
2720 | 2720 | The root node to be transformed. Typically called with the ast.Module |
|
2721 | 2721 | produced by parsing user input. |
|
2722 | 2722 | |
|
2723 | 2723 | Returns |
|
2724 | 2724 | ------- |
|
2725 | 2725 | An ast.Node corresponding to the node it was called with. Note that it |
|
2726 | 2726 | may also modify the passed object, so don't rely on references to the |
|
2727 | 2727 | original AST. |
|
2728 | 2728 | """ |
|
2729 | 2729 | for transformer in self.ast_transformers: |
|
2730 | 2730 | try: |
|
2731 | 2731 | node = transformer.visit(node) |
|
2732 | 2732 | except InputRejected: |
|
2733 | 2733 | # User-supplied AST transformers can reject an input by raising |
|
2734 | 2734 | # an InputRejected. Short-circuit in this case so that we |
|
2735 | 2735 | # don't unregister the transform. |
|
2736 | 2736 | raise |
|
2737 | 2737 | except Exception: |
|
2738 | 2738 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
2739 | 2739 | self.ast_transformers.remove(transformer) |
|
2740 | 2740 | |
|
2741 | 2741 | if self.ast_transformers: |
|
2742 | 2742 | ast.fix_missing_locations(node) |
|
2743 | 2743 | return node |
|
2744 | 2744 | |
|
2745 | 2745 | |
|
2746 | 2746 | def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr', |
|
2747 | 2747 | compiler=compile, result=None): |
|
2748 | 2748 | """Run a sequence of AST nodes. The execution mode depends on the |
|
2749 | 2749 | interactivity parameter. |
|
2750 | 2750 | |
|
2751 | 2751 | Parameters |
|
2752 | 2752 | ---------- |
|
2753 | 2753 | nodelist : list |
|
2754 | 2754 | A sequence of AST nodes to run. |
|
2755 | 2755 | cell_name : str |
|
2756 | 2756 | Will be passed to the compiler as the filename of the cell. Typically |
|
2757 | 2757 | the value returned by ip.compile.cache(cell). |
|
2758 | 2758 | interactivity : str |
|
2759 | 2759 | 'all', 'last', 'last_expr' or 'none', specifying which nodes should be |
|
2760 | 2760 | run interactively (displaying output from expressions). 'last_expr' |
|
2761 | 2761 | will run the last node interactively only if it is an expression (i.e. |
|
2762 | 2762 | expressions in loops or other blocks are not displayed. Other values |
|
2763 | 2763 | for this parameter will raise a ValueError. |
|
2764 | 2764 | compiler : callable |
|
2765 | 2765 | A function with the same interface as the built-in compile(), to turn |
|
2766 | 2766 | the AST nodes into code objects. Default is the built-in compile(). |
|
2767 | 2767 | result : ExecutionResult, optional |
|
2768 | 2768 | An object to store exceptions that occur during execution. |
|
2769 | 2769 | |
|
2770 | 2770 | Returns |
|
2771 | 2771 | ------- |
|
2772 | 2772 | True if an exception occurred while running code, False if it finished |
|
2773 | 2773 | running. |
|
2774 | 2774 | """ |
|
2775 | 2775 | if not nodelist: |
|
2776 | 2776 | return |
|
2777 | 2777 | |
|
2778 | 2778 | if interactivity == 'last_expr': |
|
2779 | 2779 | if isinstance(nodelist[-1], ast.Expr): |
|
2780 | 2780 | interactivity = "last" |
|
2781 | 2781 | else: |
|
2782 | 2782 | interactivity = "none" |
|
2783 | 2783 | |
|
2784 | 2784 | if interactivity == 'none': |
|
2785 | 2785 | to_run_exec, to_run_interactive = nodelist, [] |
|
2786 | 2786 | elif interactivity == 'last': |
|
2787 | 2787 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
2788 | 2788 | elif interactivity == 'all': |
|
2789 | 2789 | to_run_exec, to_run_interactive = [], nodelist |
|
2790 | 2790 | else: |
|
2791 | 2791 | raise ValueError("Interactivity was %r" % interactivity) |
|
2792 | 2792 | |
|
2793 | 2793 | try: |
|
2794 | 2794 | for i, node in enumerate(to_run_exec): |
|
2795 | 2795 | mod = ast.Module([node]) |
|
2796 | 2796 | code = compiler(mod, cell_name, "exec") |
|
2797 | 2797 | if self.run_code(code, result): |
|
2798 | 2798 | return True |
|
2799 | 2799 | |
|
2800 | 2800 | for i, node in enumerate(to_run_interactive): |
|
2801 | 2801 | mod = ast.Interactive([node]) |
|
2802 | 2802 | code = compiler(mod, cell_name, "single") |
|
2803 | 2803 | if self.run_code(code, result): |
|
2804 | 2804 | return True |
|
2805 | 2805 | |
|
2806 | 2806 | # Flush softspace |
|
2807 | 2807 | if softspace(sys.stdout, 0): |
|
2808 | 2808 | print() |
|
2809 | 2809 | |
|
2810 | 2810 | except: |
|
2811 | 2811 | # It's possible to have exceptions raised here, typically by |
|
2812 | 2812 | # compilation of odd code (such as a naked 'return' outside a |
|
2813 | 2813 | # function) that did parse but isn't valid. Typically the exception |
|
2814 | 2814 | # is a SyntaxError, but it's safest just to catch anything and show |
|
2815 | 2815 | # the user a traceback. |
|
2816 | 2816 | |
|
2817 | 2817 | # We do only one try/except outside the loop to minimize the impact |
|
2818 | 2818 | # on runtime, and also because if any node in the node list is |
|
2819 | 2819 | # broken, we should stop execution completely. |
|
2820 | 2820 | if result: |
|
2821 | 2821 | result.error_before_exec = sys.exc_info()[1] |
|
2822 | 2822 | self.showtraceback() |
|
2823 | 2823 | return True |
|
2824 | 2824 | |
|
2825 | 2825 | return False |
|
2826 | 2826 | |
|
2827 | 2827 | def run_code(self, code_obj, result=None): |
|
2828 | 2828 | """Execute a code object. |
|
2829 | 2829 | |
|
2830 | 2830 | When an exception occurs, self.showtraceback() is called to display a |
|
2831 | 2831 | traceback. |
|
2832 | 2832 | |
|
2833 | 2833 | Parameters |
|
2834 | 2834 | ---------- |
|
2835 | 2835 | code_obj : code object |
|
2836 | 2836 | A compiled code object, to be executed |
|
2837 | 2837 | result : ExecutionResult, optional |
|
2838 | 2838 | An object to store exceptions that occur during execution. |
|
2839 | 2839 | |
|
2840 | 2840 | Returns |
|
2841 | 2841 | ------- |
|
2842 | 2842 | False : successful execution. |
|
2843 | 2843 | True : an error occurred. |
|
2844 | 2844 | """ |
|
2845 | 2845 | # Set our own excepthook in case the user code tries to call it |
|
2846 | 2846 | # directly, so that the IPython crash handler doesn't get triggered |
|
2847 | 2847 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
2848 | 2848 | |
|
2849 | 2849 | # we save the original sys.excepthook in the instance, in case config |
|
2850 | 2850 | # code (such as magics) needs access to it. |
|
2851 | 2851 | self.sys_excepthook = old_excepthook |
|
2852 | 2852 | outflag = 1 # happens in more places, so it's easier as default |
|
2853 | 2853 | try: |
|
2854 | 2854 | try: |
|
2855 | 2855 | self.hooks.pre_run_code_hook() |
|
2856 | 2856 | #rprint('Running code', repr(code_obj)) # dbg |
|
2857 | 2857 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
2858 | 2858 | finally: |
|
2859 | 2859 | # Reset our crash handler in place |
|
2860 | 2860 | sys.excepthook = old_excepthook |
|
2861 | 2861 | except SystemExit as e: |
|
2862 | 2862 | if result is not None: |
|
2863 | 2863 | result.error_in_exec = e |
|
2864 | 2864 | self.showtraceback(exception_only=True) |
|
2865 | 2865 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
2866 | 2866 | except self.custom_exceptions: |
|
2867 | 2867 | etype, value, tb = sys.exc_info() |
|
2868 | 2868 | if result is not None: |
|
2869 | 2869 | result.error_in_exec = value |
|
2870 | 2870 | self.CustomTB(etype, value, tb) |
|
2871 | 2871 | except: |
|
2872 | 2872 | if result is not None: |
|
2873 | 2873 | result.error_in_exec = sys.exc_info()[1] |
|
2874 | 2874 | self.showtraceback() |
|
2875 | 2875 | else: |
|
2876 | 2876 | outflag = 0 |
|
2877 | 2877 | return outflag |
|
2878 | 2878 | |
|
2879 | 2879 | # For backwards compatibility |
|
2880 | 2880 | runcode = run_code |
|
2881 | 2881 | |
|
2882 | 2882 | #------------------------------------------------------------------------- |
|
2883 | 2883 | # Things related to GUI support and pylab |
|
2884 | 2884 | #------------------------------------------------------------------------- |
|
2885 | 2885 | |
|
2886 | 2886 | active_eventloop = None |
|
2887 | 2887 | |
|
2888 | 2888 | def enable_gui(self, gui=None): |
|
2889 | 2889 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
2890 | 2890 | |
|
2891 | 2891 | def enable_matplotlib(self, gui=None): |
|
2892 | 2892 | """Enable interactive matplotlib and inline figure support. |
|
2893 | 2893 | |
|
2894 | 2894 | This takes the following steps: |
|
2895 | 2895 | |
|
2896 | 2896 | 1. select the appropriate eventloop and matplotlib backend |
|
2897 | 2897 | 2. set up matplotlib for interactive use with that backend |
|
2898 | 2898 | 3. configure formatters for inline figure display |
|
2899 | 2899 | 4. enable the selected gui eventloop |
|
2900 | 2900 | |
|
2901 | 2901 | Parameters |
|
2902 | 2902 | ---------- |
|
2903 | 2903 | gui : optional, string |
|
2904 | 2904 | If given, dictates the choice of matplotlib GUI backend to use |
|
2905 | 2905 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2906 | 2906 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2907 | 2907 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2908 | 2908 | user's matplotlibrc configuration file). Note that not all backends |
|
2909 | 2909 | make sense in all contexts, for example a terminal ipython can't |
|
2910 | 2910 | display figures inline. |
|
2911 | 2911 | """ |
|
2912 | 2912 | from IPython.core import pylabtools as pt |
|
2913 | 2913 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
2914 | 2914 | |
|
2915 | 2915 | if gui != 'inline': |
|
2916 | 2916 | # If we have our first gui selection, store it |
|
2917 | 2917 | if self.pylab_gui_select is None: |
|
2918 | 2918 | self.pylab_gui_select = gui |
|
2919 | 2919 | # Otherwise if they are different |
|
2920 | 2920 | elif gui != self.pylab_gui_select: |
|
2921 | 2921 | print ('Warning: Cannot change to a different GUI toolkit: %s.' |
|
2922 | 2922 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
2923 | 2923 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
2924 | 2924 | |
|
2925 | 2925 | pt.activate_matplotlib(backend) |
|
2926 | 2926 | pt.configure_inline_support(self, backend) |
|
2927 | 2927 | |
|
2928 | 2928 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
2929 | 2929 | # plot updates into account |
|
2930 | 2930 | self.enable_gui(gui) |
|
2931 | 2931 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
2932 | 2932 | pt.mpl_runner(self.safe_execfile) |
|
2933 | 2933 | |
|
2934 | 2934 | return gui, backend |
|
2935 | 2935 | |
|
2936 | 2936 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
2937 | 2937 | """Activate pylab support at runtime. |
|
2938 | 2938 | |
|
2939 | 2939 | This turns on support for matplotlib, preloads into the interactive |
|
2940 | 2940 | namespace all of numpy and pylab, and configures IPython to correctly |
|
2941 | 2941 | interact with the GUI event loop. The GUI backend to be used can be |
|
2942 | 2942 | optionally selected with the optional ``gui`` argument. |
|
2943 | 2943 | |
|
2944 | 2944 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
2945 | 2945 | |
|
2946 | 2946 | Parameters |
|
2947 | 2947 | ---------- |
|
2948 | 2948 | gui : optional, string |
|
2949 | 2949 | If given, dictates the choice of matplotlib GUI backend to use |
|
2950 | 2950 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
2951 | 2951 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
2952 | 2952 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
2953 | 2953 | user's matplotlibrc configuration file). Note that not all backends |
|
2954 | 2954 | make sense in all contexts, for example a terminal ipython can't |
|
2955 | 2955 | display figures inline. |
|
2956 | 2956 | import_all : optional, bool, default: True |
|
2957 | 2957 | Whether to do `from numpy import *` and `from pylab import *` |
|
2958 | 2958 | in addition to module imports. |
|
2959 | 2959 | welcome_message : deprecated |
|
2960 | 2960 | This argument is ignored, no welcome message will be displayed. |
|
2961 | 2961 | """ |
|
2962 | 2962 | from IPython.core.pylabtools import import_pylab |
|
2963 | 2963 | |
|
2964 | 2964 | gui, backend = self.enable_matplotlib(gui) |
|
2965 | 2965 | |
|
2966 | 2966 | # We want to prevent the loading of pylab to pollute the user's |
|
2967 | 2967 | # namespace as shown by the %who* magics, so we execute the activation |
|
2968 | 2968 | # code in an empty namespace, and we update *both* user_ns and |
|
2969 | 2969 | # user_ns_hidden with this information. |
|
2970 | 2970 | ns = {} |
|
2971 | 2971 | import_pylab(ns, import_all) |
|
2972 | 2972 | # warn about clobbered names |
|
2973 | 2973 | ignored = {"__builtins__"} |
|
2974 | 2974 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
2975 | 2975 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
2976 | 2976 | self.user_ns.update(ns) |
|
2977 | 2977 | self.user_ns_hidden.update(ns) |
|
2978 | 2978 | return gui, backend, clobbered |
|
2979 | 2979 | |
|
2980 | 2980 | #------------------------------------------------------------------------- |
|
2981 | 2981 | # Utilities |
|
2982 | 2982 | #------------------------------------------------------------------------- |
|
2983 | 2983 | |
|
2984 | 2984 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
2985 | 2985 | """Expand python variables in a string. |
|
2986 | 2986 | |
|
2987 | 2987 | The depth argument indicates how many frames above the caller should |
|
2988 | 2988 | be walked to look for the local namespace where to expand variables. |
|
2989 | 2989 | |
|
2990 | 2990 | The global namespace for expansion is always the user's interactive |
|
2991 | 2991 | namespace. |
|
2992 | 2992 | """ |
|
2993 | 2993 | ns = self.user_ns.copy() |
|
2994 | 2994 | try: |
|
2995 | 2995 | frame = sys._getframe(depth+1) |
|
2996 | 2996 | except ValueError: |
|
2997 | 2997 | # This is thrown if there aren't that many frames on the stack, |
|
2998 | 2998 | # e.g. if a script called run_line_magic() directly. |
|
2999 | 2999 | pass |
|
3000 | 3000 | else: |
|
3001 | 3001 | ns.update(frame.f_locals) |
|
3002 | 3002 | |
|
3003 | 3003 | try: |
|
3004 | 3004 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3005 | 3005 | # name, and expanding **ns for .format() would make it collide with |
|
3006 | 3006 | # the 'self' argument of the method. |
|
3007 | 3007 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3008 | 3008 | except Exception: |
|
3009 | 3009 | # if formatter couldn't format, just let it go untransformed |
|
3010 | 3010 | pass |
|
3011 | 3011 | return cmd |
|
3012 | 3012 | |
|
3013 | 3013 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3014 | 3014 | """Make a new tempfile and return its filename. |
|
3015 | 3015 | |
|
3016 | 3016 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3017 | 3017 | but it registers the created filename internally so ipython cleans it up |
|
3018 | 3018 | at exit time. |
|
3019 | 3019 | |
|
3020 | 3020 | Optional inputs: |
|
3021 | 3021 | |
|
3022 | 3022 | - data(None): if data is given, it gets written out to the temp file |
|
3023 | 3023 | immediately, and the file is closed again.""" |
|
3024 | 3024 | |
|
3025 | 3025 | dirname = tempfile.mkdtemp(prefix=prefix) |
|
3026 | 3026 | self.tempdirs.append(dirname) |
|
3027 | 3027 | |
|
3028 | 3028 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) |
|
3029 | 3029 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3030 | 3030 | self.tempfiles.append(filename) |
|
3031 | 3031 | |
|
3032 | 3032 | if data: |
|
3033 | 3033 | tmp_file = open(filename,'w') |
|
3034 | 3034 | tmp_file.write(data) |
|
3035 | 3035 | tmp_file.close() |
|
3036 | 3036 | return filename |
|
3037 | 3037 | |
|
3038 | 3038 | @undoc |
|
3039 | 3039 | def write(self,data): |
|
3040 | 3040 | """DEPRECATED: Write a string to the default output""" |
|
3041 | 3041 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3042 | 3042 | DeprecationWarning, stacklevel=2) |
|
3043 | 3043 | sys.stdout.write(data) |
|
3044 | 3044 | |
|
3045 | 3045 | @undoc |
|
3046 | 3046 | def write_err(self,data): |
|
3047 | 3047 | """DEPRECATED: Write a string to the default error output""" |
|
3048 | 3048 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3049 | 3049 | DeprecationWarning, stacklevel=2) |
|
3050 | 3050 | sys.stderr.write(data) |
|
3051 | 3051 | |
|
3052 | 3052 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3053 | 3053 | if self.quiet: |
|
3054 | 3054 | return True |
|
3055 | 3055 | return ask_yes_no(prompt,default,interrupt) |
|
3056 | 3056 | |
|
3057 | 3057 | def show_usage(self): |
|
3058 | 3058 | """Show a usage message""" |
|
3059 | 3059 | page.page(IPython.core.usage.interactive_usage) |
|
3060 | 3060 | |
|
3061 | 3061 | def extract_input_lines(self, range_str, raw=False): |
|
3062 | 3062 | """Return as a string a set of input history slices. |
|
3063 | 3063 | |
|
3064 | 3064 | Parameters |
|
3065 | 3065 | ---------- |
|
3066 | 3066 | range_str : string |
|
3067 | 3067 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3068 | 3068 | since this function is for use by magic functions which get their |
|
3069 | 3069 | arguments as strings. The number before the / is the session |
|
3070 | 3070 | number: ~n goes n back from the current session. |
|
3071 | 3071 | |
|
3072 | 3072 | raw : bool, optional |
|
3073 | 3073 | By default, the processed input is used. If this is true, the raw |
|
3074 | 3074 | input history is used instead. |
|
3075 | 3075 | |
|
3076 | 3076 | Notes |
|
3077 | 3077 | ----- |
|
3078 | 3078 | |
|
3079 | 3079 | Slices can be described with two notations: |
|
3080 | 3080 | |
|
3081 | 3081 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3082 | 3082 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3083 | 3083 | """ |
|
3084 | 3084 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3085 | 3085 | return "\n".join(x for _, _, x in lines) |
|
3086 | 3086 | |
|
3087 | 3087 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3088 | 3088 | """Get a code string from history, file, url, or a string or macro. |
|
3089 | 3089 | |
|
3090 | 3090 | This is mainly used by magic functions. |
|
3091 | 3091 | |
|
3092 | 3092 | Parameters |
|
3093 | 3093 | ---------- |
|
3094 | 3094 | |
|
3095 | 3095 | target : str |
|
3096 | 3096 | |
|
3097 | 3097 | A string specifying code to retrieve. This will be tried respectively |
|
3098 | 3098 | as: ranges of input history (see %history for syntax), url, |
|
3099 | 3099 | corresponding .py file, filename, or an expression evaluating to a |
|
3100 | 3100 | string or Macro in the user namespace. |
|
3101 | 3101 | |
|
3102 | 3102 | raw : bool |
|
3103 | 3103 | If true (default), retrieve raw history. Has no effect on the other |
|
3104 | 3104 | retrieval mechanisms. |
|
3105 | 3105 | |
|
3106 | 3106 | py_only : bool (default False) |
|
3107 | 3107 | Only try to fetch python code, do not try alternative methods to decode file |
|
3108 | 3108 | if unicode fails. |
|
3109 | 3109 | |
|
3110 | 3110 | Returns |
|
3111 | 3111 | ------- |
|
3112 | 3112 | A string of code. |
|
3113 | 3113 | |
|
3114 | 3114 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3115 | 3115 | to an object of another type. In each case, .args[0] is a printable |
|
3116 | 3116 | message. |
|
3117 | 3117 | """ |
|
3118 | 3118 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3119 | 3119 | if code: |
|
3120 | 3120 | return code |
|
3121 | 3121 | try: |
|
3122 | 3122 | if target.startswith(('http://', 'https://')): |
|
3123 | 3123 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3124 | 3124 | except UnicodeDecodeError: |
|
3125 | 3125 | if not py_only : |
|
3126 | 3126 | # Deferred import |
|
3127 | try: | |
|
3128 | from urllib.request import urlopen # Py3 | |
|
3129 | except ImportError: | |
|
3130 | from urllib import urlopen | |
|
3127 | from urllib.request import urlopen | |
|
3131 | 3128 | response = urlopen(target) |
|
3132 | 3129 | return response.read().decode('latin1') |
|
3133 | 3130 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3134 | 3131 | |
|
3135 | 3132 | potential_target = [target] |
|
3136 | 3133 | try : |
|
3137 | 3134 | potential_target.insert(0,get_py_filename(target)) |
|
3138 | 3135 | except IOError: |
|
3139 | 3136 | pass |
|
3140 | 3137 | |
|
3141 | 3138 | for tgt in potential_target : |
|
3142 | 3139 | if os.path.isfile(tgt): # Read file |
|
3143 | 3140 | try : |
|
3144 | 3141 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3145 | 3142 | except UnicodeDecodeError : |
|
3146 | 3143 | if not py_only : |
|
3147 | 3144 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3148 | 3145 | return f.read() |
|
3149 | 3146 | raise ValueError(("'%s' seem to be unreadable.") % target) |
|
3150 | 3147 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3151 | 3148 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3152 | 3149 | |
|
3153 | 3150 | if search_ns: |
|
3154 | 3151 | # Inspect namespace to load object source |
|
3155 | 3152 | object_info = self.object_inspect(target, detail_level=1) |
|
3156 | 3153 | if object_info['found'] and object_info['source']: |
|
3157 | 3154 | return object_info['source'] |
|
3158 | 3155 | |
|
3159 | 3156 | try: # User namespace |
|
3160 | 3157 | codeobj = eval(target, self.user_ns) |
|
3161 | 3158 | except Exception: |
|
3162 | 3159 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3163 | 3160 | "nor in the user namespace.") % target) |
|
3164 | 3161 | |
|
3165 | 3162 | if isinstance(codeobj, str): |
|
3166 | 3163 | return codeobj |
|
3167 | 3164 | elif isinstance(codeobj, Macro): |
|
3168 | 3165 | return codeobj.value |
|
3169 | 3166 | |
|
3170 | 3167 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3171 | 3168 | codeobj) |
|
3172 | 3169 | |
|
3173 | 3170 | #------------------------------------------------------------------------- |
|
3174 | 3171 | # Things related to IPython exiting |
|
3175 | 3172 | #------------------------------------------------------------------------- |
|
3176 | 3173 | def atexit_operations(self): |
|
3177 | 3174 | """This will be executed at the time of exit. |
|
3178 | 3175 | |
|
3179 | 3176 | Cleanup operations and saving of persistent data that is done |
|
3180 | 3177 | unconditionally by IPython should be performed here. |
|
3181 | 3178 | |
|
3182 | 3179 | For things that may depend on startup flags or platform specifics (such |
|
3183 | 3180 | as having readline or not), register a separate atexit function in the |
|
3184 | 3181 | code that has the appropriate information, rather than trying to |
|
3185 | 3182 | clutter |
|
3186 | 3183 | """ |
|
3187 | 3184 | # Close the history session (this stores the end time and line count) |
|
3188 | 3185 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3189 | 3186 | # history db |
|
3190 | 3187 | self.history_manager.end_session() |
|
3191 | 3188 | |
|
3192 | 3189 | # Cleanup all tempfiles and folders left around |
|
3193 | 3190 | for tfile in self.tempfiles: |
|
3194 | 3191 | try: |
|
3195 | 3192 | os.unlink(tfile) |
|
3196 | 3193 | except OSError: |
|
3197 | 3194 | pass |
|
3198 | 3195 | |
|
3199 | 3196 | for tdir in self.tempdirs: |
|
3200 | 3197 | try: |
|
3201 | 3198 | os.rmdir(tdir) |
|
3202 | 3199 | except OSError: |
|
3203 | 3200 | pass |
|
3204 | 3201 | |
|
3205 | 3202 | # Clear all user namespaces to release all references cleanly. |
|
3206 | 3203 | self.reset(new_session=False) |
|
3207 | 3204 | |
|
3208 | 3205 | # Run user hooks |
|
3209 | 3206 | self.hooks.shutdown_hook() |
|
3210 | 3207 | |
|
3211 | 3208 | def cleanup(self): |
|
3212 | 3209 | self.restore_sys_module_state() |
|
3213 | 3210 | |
|
3214 | 3211 | |
|
3215 | 3212 | # Overridden in terminal subclass to change prompts |
|
3216 | 3213 | def switch_doctest_mode(self, mode): |
|
3217 | 3214 | pass |
|
3218 | 3215 | |
|
3219 | 3216 | |
|
3220 | 3217 | class InteractiveShellABC(with_metaclass(abc.ABCMeta, object)): |
|
3221 | 3218 | """An abstract base class for InteractiveShell.""" |
|
3222 | 3219 | |
|
3223 | 3220 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,558 +1,557 b'' | |||
|
1 | 1 | """Various display related classes. |
|
2 | 2 | |
|
3 | 3 | Authors : MinRK, gregcaporaso, dannystaple |
|
4 | 4 | """ |
|
5 | 5 | from os.path import exists, isfile, splitext, abspath, join, isdir |
|
6 | 6 | from os import walk, sep |
|
7 | 7 | |
|
8 | 8 | from IPython.core.display import DisplayObject |
|
9 | 9 | |
|
10 | 10 | __all__ = ['Audio', 'IFrame', 'YouTubeVideo', 'VimeoVideo', 'ScribdDocument', |
|
11 | 11 | 'FileLink', 'FileLinks'] |
|
12 | 12 | |
|
13 | 13 | |
|
14 | 14 | class Audio(DisplayObject): |
|
15 | 15 | """Create an audio object. |
|
16 | 16 | |
|
17 | 17 | When this object is returned by an input cell or passed to the |
|
18 | 18 | display function, it will result in Audio controls being displayed |
|
19 | 19 | in the frontend (only works in the notebook). |
|
20 | 20 | |
|
21 | 21 | Parameters |
|
22 | 22 | ---------- |
|
23 | 23 | data : numpy array, list, unicode, str or bytes |
|
24 | 24 | Can be one of |
|
25 | 25 | |
|
26 | 26 | * Numpy 1d array containing the desired waveform (mono) |
|
27 | 27 | * Numpy 2d array containing waveforms for each channel. |
|
28 | 28 | Shape=(NCHAN, NSAMPLES). For the standard channel order, see |
|
29 | 29 | http://msdn.microsoft.com/en-us/library/windows/hardware/dn653308(v=vs.85).aspx |
|
30 | 30 | * List of float or integer representing the waveform (mono) |
|
31 | 31 | * String containing the filename |
|
32 | 32 | * Bytestring containing raw PCM data or |
|
33 | 33 | * URL pointing to a file on the web. |
|
34 | 34 | |
|
35 | 35 | If the array option is used the waveform will be normalized. |
|
36 | 36 | |
|
37 | 37 | If a filename or url is used the format support will be browser |
|
38 | 38 | dependent. |
|
39 | 39 | url : unicode |
|
40 | 40 | A URL to download the data from. |
|
41 | 41 | filename : unicode |
|
42 | 42 | Path to a local file to load the data from. |
|
43 | 43 | embed : boolean |
|
44 | 44 | Should the audio data be embedded using a data URI (True) or should |
|
45 | 45 | the original source be referenced. Set this to True if you want the |
|
46 | 46 | audio to playable later with no internet connection in the notebook. |
|
47 | 47 | |
|
48 | 48 | Default is `True`, unless the keyword argument `url` is set, then |
|
49 | 49 | default value is `False`. |
|
50 | 50 | rate : integer |
|
51 | 51 | The sampling rate of the raw data. |
|
52 | 52 | Only required when data parameter is being used as an array |
|
53 | 53 | autoplay : bool |
|
54 | 54 | Set to True if the audio should immediately start playing. |
|
55 | 55 | Default is `False`. |
|
56 | 56 | |
|
57 | 57 | Examples |
|
58 | 58 | -------- |
|
59 | 59 | :: |
|
60 | 60 | |
|
61 | 61 | # Generate a sound |
|
62 | 62 | import numpy as np |
|
63 | 63 | framerate = 44100 |
|
64 | 64 | t = np.linspace(0,5,framerate*5) |
|
65 | 65 | data = np.sin(2*np.pi*220*t) + np.sin(2*np.pi*224*t)) |
|
66 | 66 | Audio(data,rate=framerate) |
|
67 | 67 | |
|
68 | 68 | # Can also do stereo or more channels |
|
69 | 69 | dataleft = np.sin(2*np.pi*220*t) |
|
70 | 70 | dataright = np.sin(2*np.pi*224*t) |
|
71 | 71 | Audio([dataleft, dataright],rate=framerate) |
|
72 | 72 | |
|
73 | 73 | Audio("http://www.nch.com.au/acm/8k16bitpcm.wav") # From URL |
|
74 | 74 | Audio(url="http://www.w3schools.com/html/horse.ogg") |
|
75 | 75 | |
|
76 | 76 | Audio('/path/to/sound.wav') # From file |
|
77 | 77 | Audio(filename='/path/to/sound.ogg') |
|
78 | 78 | |
|
79 | 79 | Audio(b'RAW_WAV_DATA..) # From bytes |
|
80 | 80 | Audio(data=b'RAW_WAV_DATA..) |
|
81 | 81 | |
|
82 | 82 | """ |
|
83 | 83 | _read_flags = 'rb' |
|
84 | 84 | |
|
85 | 85 | def __init__(self, data=None, filename=None, url=None, embed=None, rate=None, autoplay=False): |
|
86 | 86 | if filename is None and url is None and data is None: |
|
87 | 87 | raise ValueError("No image data found. Expecting filename, url, or data.") |
|
88 | 88 | if embed is False and url is None: |
|
89 | 89 | raise ValueError("No url found. Expecting url when embed=False") |
|
90 | 90 | |
|
91 | 91 | if url is not None and embed is not True: |
|
92 | 92 | self.embed = False |
|
93 | 93 | else: |
|
94 | 94 | self.embed = True |
|
95 | 95 | self.autoplay = autoplay |
|
96 | 96 | super(Audio, self).__init__(data=data, url=url, filename=filename) |
|
97 | 97 | |
|
98 | 98 | if self.data is not None and not isinstance(self.data, bytes): |
|
99 | 99 | self.data = self._make_wav(data,rate) |
|
100 | 100 | |
|
101 | 101 | def reload(self): |
|
102 | 102 | """Reload the raw data from file or URL.""" |
|
103 | 103 | import mimetypes |
|
104 | 104 | if self.embed: |
|
105 | 105 | super(Audio, self).reload() |
|
106 | 106 | |
|
107 | 107 | if self.filename is not None: |
|
108 | 108 | self.mimetype = mimetypes.guess_type(self.filename)[0] |
|
109 | 109 | elif self.url is not None: |
|
110 | 110 | self.mimetype = mimetypes.guess_type(self.url)[0] |
|
111 | 111 | else: |
|
112 | 112 | self.mimetype = "audio/wav" |
|
113 | 113 | |
|
114 | 114 | def _make_wav(self, data, rate): |
|
115 | 115 | """ Transform a numpy array to a PCM bytestring """ |
|
116 | 116 | import struct |
|
117 | 117 | from io import BytesIO |
|
118 | 118 | import wave |
|
119 | 119 | |
|
120 | 120 | try: |
|
121 | 121 | import numpy as np |
|
122 | 122 | |
|
123 | 123 | data = np.array(data, dtype=float) |
|
124 | 124 | if len(data.shape) == 1: |
|
125 | 125 | nchan = 1 |
|
126 | 126 | elif len(data.shape) == 2: |
|
127 | 127 | # In wave files,channels are interleaved. E.g., |
|
128 | 128 | # "L1R1L2R2..." for stereo. See |
|
129 | 129 | # http://msdn.microsoft.com/en-us/library/windows/hardware/dn653308(v=vs.85).aspx |
|
130 | 130 | # for channel ordering |
|
131 | 131 | nchan = data.shape[0] |
|
132 | 132 | data = data.T.ravel() |
|
133 | 133 | else: |
|
134 | 134 | raise ValueError('Array audio input must be a 1D or 2D array') |
|
135 | 135 | scaled = np.int16(data/np.max(np.abs(data))*32767).tolist() |
|
136 | 136 | except ImportError: |
|
137 | 137 | # check that it is a "1D" list |
|
138 | 138 | idata = iter(data) # fails if not an iterable |
|
139 | 139 | try: |
|
140 | 140 | iter(idata.next()) |
|
141 | 141 | raise TypeError('Only lists of mono audio are ' |
|
142 | 142 | 'supported if numpy is not installed') |
|
143 | 143 | except TypeError: |
|
144 | 144 | # this means it's not a nested list, which is what we want |
|
145 | 145 | pass |
|
146 | 146 | maxabsvalue = float(max([abs(x) for x in data])) |
|
147 | 147 | scaled = [int(x/maxabsvalue*32767) for x in data] |
|
148 | 148 | nchan = 1 |
|
149 | 149 | |
|
150 | 150 | fp = BytesIO() |
|
151 | 151 | waveobj = wave.open(fp,mode='wb') |
|
152 | 152 | waveobj.setnchannels(nchan) |
|
153 | 153 | waveobj.setframerate(rate) |
|
154 | 154 | waveobj.setsampwidth(2) |
|
155 | 155 | waveobj.setcomptype('NONE','NONE') |
|
156 | 156 | waveobj.writeframes(b''.join([struct.pack('<h',x) for x in scaled])) |
|
157 | 157 | val = fp.getvalue() |
|
158 | 158 | waveobj.close() |
|
159 | 159 | |
|
160 | 160 | return val |
|
161 | 161 | |
|
162 | 162 | def _data_and_metadata(self): |
|
163 | 163 | """shortcut for returning metadata with url information, if defined""" |
|
164 | 164 | md = {} |
|
165 | 165 | if self.url: |
|
166 | 166 | md['url'] = self.url |
|
167 | 167 | if md: |
|
168 | 168 | return self.data, md |
|
169 | 169 | else: |
|
170 | 170 | return self.data |
|
171 | 171 | |
|
172 | 172 | def _repr_html_(self): |
|
173 | 173 | src = """ |
|
174 | 174 | <audio controls="controls" {autoplay}> |
|
175 | 175 | <source src="{src}" type="{type}" /> |
|
176 | 176 | Your browser does not support the audio element. |
|
177 | 177 | </audio> |
|
178 | 178 | """ |
|
179 | 179 | return src.format(src=self.src_attr(),type=self.mimetype, autoplay=self.autoplay_attr()) |
|
180 | 180 | |
|
181 | 181 | def src_attr(self): |
|
182 | 182 | import base64 |
|
183 | 183 | if self.embed and (self.data is not None): |
|
184 | 184 | data = base64=base64.b64encode(self.data).decode('ascii') |
|
185 | 185 | return """data:{type};base64,{base64}""".format(type=self.mimetype, |
|
186 | 186 | base64=data) |
|
187 | 187 | elif self.url is not None: |
|
188 | 188 | return self.url |
|
189 | 189 | else: |
|
190 | 190 | return "" |
|
191 | 191 | |
|
192 | 192 | def autoplay_attr(self): |
|
193 | 193 | if(self.autoplay): |
|
194 | 194 | return 'autoplay="autoplay"' |
|
195 | 195 | else: |
|
196 | 196 | return '' |
|
197 | 197 | |
|
198 | 198 | class IFrame(object): |
|
199 | 199 | """ |
|
200 | 200 | Generic class to embed an iframe in an IPython notebook |
|
201 | 201 | """ |
|
202 | 202 | |
|
203 | 203 | iframe = """ |
|
204 | 204 | <iframe |
|
205 | 205 | width="{width}" |
|
206 | 206 | height="{height}" |
|
207 | 207 | src="{src}{params}" |
|
208 | 208 | frameborder="0" |
|
209 | 209 | allowfullscreen |
|
210 | 210 | ></iframe> |
|
211 | 211 | """ |
|
212 | 212 | |
|
213 | 213 | def __init__(self, src, width, height, **kwargs): |
|
214 | 214 | self.src = src |
|
215 | 215 | self.width = width |
|
216 | 216 | self.height = height |
|
217 | 217 | self.params = kwargs |
|
218 | 218 | |
|
219 | 219 | def _repr_html_(self): |
|
220 | 220 | """return the embed iframe""" |
|
221 | 221 | if self.params: |
|
222 | 222 | try: |
|
223 | 223 | from urllib.parse import urlencode # Py 3 |
|
224 | 224 | except ImportError: |
|
225 | 225 | from urllib import urlencode |
|
226 | 226 | params = "?" + urlencode(self.params) |
|
227 | 227 | else: |
|
228 | 228 | params = "" |
|
229 | 229 | return self.iframe.format(src=self.src, |
|
230 | 230 | width=self.width, |
|
231 | 231 | height=self.height, |
|
232 | 232 | params=params) |
|
233 | 233 | |
|
234 | 234 | class YouTubeVideo(IFrame): |
|
235 | 235 | """Class for embedding a YouTube Video in an IPython session, based on its video id. |
|
236 | 236 | |
|
237 | 237 | e.g. to embed the video from https://www.youtube.com/watch?v=foo , you would |
|
238 | 238 | do:: |
|
239 | 239 | |
|
240 | 240 | vid = YouTubeVideo("foo") |
|
241 | 241 | display(vid) |
|
242 | 242 | |
|
243 | 243 | To start from 30 seconds:: |
|
244 | 244 | |
|
245 | 245 | vid = YouTubeVideo("abc", start=30) |
|
246 | 246 | display(vid) |
|
247 | 247 | |
|
248 | 248 | To calculate seconds from time as hours, minutes, seconds use |
|
249 | 249 | :class:`datetime.timedelta`:: |
|
250 | 250 | |
|
251 | 251 | start=int(timedelta(hours=1, minutes=46, seconds=40).total_seconds()) |
|
252 | 252 | |
|
253 | 253 | Other parameters can be provided as documented at |
|
254 | 254 | https://developers.google.com/youtube/player_parameters#parameter-subheader |
|
255 | 255 | |
|
256 | 256 | When converting the notebook using nbconvert, a jpeg representation of the video |
|
257 | 257 | will be inserted in the document. |
|
258 | 258 | """ |
|
259 | 259 | |
|
260 | 260 | def __init__(self, id, width=400, height=300, **kwargs): |
|
261 | 261 | self.id=id |
|
262 | 262 | src = "https://www.youtube.com/embed/{0}".format(id) |
|
263 | 263 | super(YouTubeVideo, self).__init__(src, width, height, **kwargs) |
|
264 | 264 | |
|
265 | 265 | def _repr_jpeg_(self): |
|
266 | try: | |
|
267 |
|
|
|
268 | except ImportError: | |
|
269 | from urllib2 import urlopen | |
|
266 | # Deferred import | |
|
267 | from urllib.request import urlopen | |
|
268 | ||
|
270 | 269 | try: |
|
271 | 270 | return urlopen("https://img.youtube.com/vi/{id}/hqdefault.jpg".format(id=self.id)).read() |
|
272 | 271 | except IOError: |
|
273 | 272 | return None |
|
274 | 273 | |
|
275 | 274 | class VimeoVideo(IFrame): |
|
276 | 275 | """ |
|
277 | 276 | Class for embedding a Vimeo video in an IPython session, based on its video id. |
|
278 | 277 | """ |
|
279 | 278 | |
|
280 | 279 | def __init__(self, id, width=400, height=300, **kwargs): |
|
281 | 280 | src="https://player.vimeo.com/video/{0}".format(id) |
|
282 | 281 | super(VimeoVideo, self).__init__(src, width, height, **kwargs) |
|
283 | 282 | |
|
284 | 283 | class ScribdDocument(IFrame): |
|
285 | 284 | """ |
|
286 | 285 | Class for embedding a Scribd document in an IPython session |
|
287 | 286 | |
|
288 | 287 | Use the start_page params to specify a starting point in the document |
|
289 | 288 | Use the view_mode params to specify display type one off scroll | slideshow | book |
|
290 | 289 | |
|
291 | 290 | e.g to Display Wes' foundational paper about PANDAS in book mode from page 3 |
|
292 | 291 | |
|
293 | 292 | ScribdDocument(71048089, width=800, height=400, start_page=3, view_mode="book") |
|
294 | 293 | """ |
|
295 | 294 | |
|
296 | 295 | def __init__(self, id, width=400, height=300, **kwargs): |
|
297 | 296 | src="https://www.scribd.com/embeds/{0}/content".format(id) |
|
298 | 297 | super(ScribdDocument, self).__init__(src, width, height, **kwargs) |
|
299 | 298 | |
|
300 | 299 | class FileLink(object): |
|
301 | 300 | """Class for embedding a local file link in an IPython session, based on path |
|
302 | 301 | |
|
303 | 302 | e.g. to embed a link that was generated in the IPython notebook as my/data.txt |
|
304 | 303 | |
|
305 | 304 | you would do:: |
|
306 | 305 | |
|
307 | 306 | local_file = FileLink("my/data.txt") |
|
308 | 307 | display(local_file) |
|
309 | 308 | |
|
310 | 309 | or in the HTML notebook, just:: |
|
311 | 310 | |
|
312 | 311 | FileLink("my/data.txt") |
|
313 | 312 | """ |
|
314 | 313 | |
|
315 | 314 | html_link_str = "<a href='%s' target='_blank'>%s</a>" |
|
316 | 315 | |
|
317 | 316 | def __init__(self, |
|
318 | 317 | path, |
|
319 | 318 | url_prefix='', |
|
320 | 319 | result_html_prefix='', |
|
321 | 320 | result_html_suffix='<br>'): |
|
322 | 321 | """ |
|
323 | 322 | Parameters |
|
324 | 323 | ---------- |
|
325 | 324 | path : str |
|
326 | 325 | path to the file or directory that should be formatted |
|
327 | 326 | directory_prefix : str |
|
328 | 327 | prefix to be prepended to all files to form a working link [default: |
|
329 | 328 | 'files'] |
|
330 | 329 | result_html_prefix : str |
|
331 | 330 | text to append to beginning to link [default: none] |
|
332 | 331 | result_html_suffix : str |
|
333 | 332 | text to append at the end of link [default: '<br>'] |
|
334 | 333 | """ |
|
335 | 334 | if isdir(path): |
|
336 | 335 | raise ValueError("Cannot display a directory using FileLink. " |
|
337 | 336 | "Use FileLinks to display '%s'." % path) |
|
338 | 337 | self.path = path |
|
339 | 338 | self.url_prefix = url_prefix |
|
340 | 339 | self.result_html_prefix = result_html_prefix |
|
341 | 340 | self.result_html_suffix = result_html_suffix |
|
342 | 341 | |
|
343 | 342 | def _format_path(self): |
|
344 | 343 | fp = ''.join([self.url_prefix,self.path]) |
|
345 | 344 | return ''.join([self.result_html_prefix, |
|
346 | 345 | self.html_link_str % (fp, self.path), |
|
347 | 346 | self.result_html_suffix]) |
|
348 | 347 | |
|
349 | 348 | def _repr_html_(self): |
|
350 | 349 | """return html link to file |
|
351 | 350 | """ |
|
352 | 351 | if not exists(self.path): |
|
353 | 352 | return ("Path (<tt>%s</tt>) doesn't exist. " |
|
354 | 353 | "It may still be in the process of " |
|
355 | 354 | "being generated, or you may have the " |
|
356 | 355 | "incorrect path." % self.path) |
|
357 | 356 | |
|
358 | 357 | return self._format_path() |
|
359 | 358 | |
|
360 | 359 | def __repr__(self): |
|
361 | 360 | """return absolute path to file |
|
362 | 361 | """ |
|
363 | 362 | return abspath(self.path) |
|
364 | 363 | |
|
365 | 364 | class FileLinks(FileLink): |
|
366 | 365 | """Class for embedding local file links in an IPython session, based on path |
|
367 | 366 | |
|
368 | 367 | e.g. to embed links to files that were generated in the IPython notebook |
|
369 | 368 | under ``my/data``, you would do:: |
|
370 | 369 | |
|
371 | 370 | local_files = FileLinks("my/data") |
|
372 | 371 | display(local_files) |
|
373 | 372 | |
|
374 | 373 | or in the HTML notebook, just:: |
|
375 | 374 | |
|
376 | 375 | FileLinks("my/data") |
|
377 | 376 | """ |
|
378 | 377 | def __init__(self, |
|
379 | 378 | path, |
|
380 | 379 | url_prefix='', |
|
381 | 380 | included_suffixes=None, |
|
382 | 381 | result_html_prefix='', |
|
383 | 382 | result_html_suffix='<br>', |
|
384 | 383 | notebook_display_formatter=None, |
|
385 | 384 | terminal_display_formatter=None, |
|
386 | 385 | recursive=True): |
|
387 | 386 | """ |
|
388 | 387 | See :class:`FileLink` for the ``path``, ``url_prefix``, |
|
389 | 388 | ``result_html_prefix`` and ``result_html_suffix`` parameters. |
|
390 | 389 | |
|
391 | 390 | included_suffixes : list |
|
392 | 391 | Filename suffixes to include when formatting output [default: include |
|
393 | 392 | all files] |
|
394 | 393 | |
|
395 | 394 | notebook_display_formatter : function |
|
396 | 395 | Used to format links for display in the notebook. See discussion of |
|
397 | 396 | formatter functions below. |
|
398 | 397 | |
|
399 | 398 | terminal_display_formatter : function |
|
400 | 399 | Used to format links for display in the terminal. See discussion of |
|
401 | 400 | formatter functions below. |
|
402 | 401 | |
|
403 | 402 | Formatter functions must be of the form:: |
|
404 | 403 | |
|
405 | 404 | f(dirname, fnames, included_suffixes) |
|
406 | 405 | |
|
407 | 406 | dirname : str |
|
408 | 407 | The name of a directory |
|
409 | 408 | fnames : list |
|
410 | 409 | The files in that directory |
|
411 | 410 | included_suffixes : list |
|
412 | 411 | The file suffixes that should be included in the output (passing None |
|
413 | 412 | meansto include all suffixes in the output in the built-in formatters) |
|
414 | 413 | recursive : boolean |
|
415 | 414 | Whether to recurse into subdirectories. Default is True. |
|
416 | 415 | |
|
417 | 416 | The function should return a list of lines that will be printed in the |
|
418 | 417 | notebook (if passing notebook_display_formatter) or the terminal (if |
|
419 | 418 | passing terminal_display_formatter). This function is iterated over for |
|
420 | 419 | each directory in self.path. Default formatters are in place, can be |
|
421 | 420 | passed here to support alternative formatting. |
|
422 | 421 | |
|
423 | 422 | """ |
|
424 | 423 | if isfile(path): |
|
425 | 424 | raise ValueError("Cannot display a file using FileLinks. " |
|
426 | 425 | "Use FileLink to display '%s'." % path) |
|
427 | 426 | self.included_suffixes = included_suffixes |
|
428 | 427 | # remove trailing slashs for more consistent output formatting |
|
429 | 428 | path = path.rstrip('/') |
|
430 | 429 | |
|
431 | 430 | self.path = path |
|
432 | 431 | self.url_prefix = url_prefix |
|
433 | 432 | self.result_html_prefix = result_html_prefix |
|
434 | 433 | self.result_html_suffix = result_html_suffix |
|
435 | 434 | |
|
436 | 435 | self.notebook_display_formatter = \ |
|
437 | 436 | notebook_display_formatter or self._get_notebook_display_formatter() |
|
438 | 437 | self.terminal_display_formatter = \ |
|
439 | 438 | terminal_display_formatter or self._get_terminal_display_formatter() |
|
440 | 439 | |
|
441 | 440 | self.recursive = recursive |
|
442 | 441 | |
|
443 | 442 | def _get_display_formatter(self, |
|
444 | 443 | dirname_output_format, |
|
445 | 444 | fname_output_format, |
|
446 | 445 | fp_format, |
|
447 | 446 | fp_cleaner=None): |
|
448 | 447 | """ generate built-in formatter function |
|
449 | 448 | |
|
450 | 449 | this is used to define both the notebook and terminal built-in |
|
451 | 450 | formatters as they only differ by some wrapper text for each entry |
|
452 | 451 | |
|
453 | 452 | dirname_output_format: string to use for formatting directory |
|
454 | 453 | names, dirname will be substituted for a single "%s" which |
|
455 | 454 | must appear in this string |
|
456 | 455 | fname_output_format: string to use for formatting file names, |
|
457 | 456 | if a single "%s" appears in the string, fname will be substituted |
|
458 | 457 | if two "%s" appear in the string, the path to fname will be |
|
459 | 458 | substituted for the first and fname will be substituted for the |
|
460 | 459 | second |
|
461 | 460 | fp_format: string to use for formatting filepaths, must contain |
|
462 | 461 | exactly two "%s" and the dirname will be subsituted for the first |
|
463 | 462 | and fname will be substituted for the second |
|
464 | 463 | """ |
|
465 | 464 | def f(dirname, fnames, included_suffixes=None): |
|
466 | 465 | result = [] |
|
467 | 466 | # begin by figuring out which filenames, if any, |
|
468 | 467 | # are going to be displayed |
|
469 | 468 | display_fnames = [] |
|
470 | 469 | for fname in fnames: |
|
471 | 470 | if (isfile(join(dirname,fname)) and |
|
472 | 471 | (included_suffixes is None or |
|
473 | 472 | splitext(fname)[1] in included_suffixes)): |
|
474 | 473 | display_fnames.append(fname) |
|
475 | 474 | |
|
476 | 475 | if len(display_fnames) == 0: |
|
477 | 476 | # if there are no filenames to display, don't print anything |
|
478 | 477 | # (not even the directory name) |
|
479 | 478 | pass |
|
480 | 479 | else: |
|
481 | 480 | # otherwise print the formatted directory name followed by |
|
482 | 481 | # the formatted filenames |
|
483 | 482 | dirname_output_line = dirname_output_format % dirname |
|
484 | 483 | result.append(dirname_output_line) |
|
485 | 484 | for fname in display_fnames: |
|
486 | 485 | fp = fp_format % (dirname,fname) |
|
487 | 486 | if fp_cleaner is not None: |
|
488 | 487 | fp = fp_cleaner(fp) |
|
489 | 488 | try: |
|
490 | 489 | # output can include both a filepath and a filename... |
|
491 | 490 | fname_output_line = fname_output_format % (fp, fname) |
|
492 | 491 | except TypeError: |
|
493 | 492 | # ... or just a single filepath |
|
494 | 493 | fname_output_line = fname_output_format % fname |
|
495 | 494 | result.append(fname_output_line) |
|
496 | 495 | return result |
|
497 | 496 | return f |
|
498 | 497 | |
|
499 | 498 | def _get_notebook_display_formatter(self, |
|
500 | 499 | spacer=" "): |
|
501 | 500 | """ generate function to use for notebook formatting |
|
502 | 501 | """ |
|
503 | 502 | dirname_output_format = \ |
|
504 | 503 | self.result_html_prefix + "%s/" + self.result_html_suffix |
|
505 | 504 | fname_output_format = \ |
|
506 | 505 | self.result_html_prefix + spacer + self.html_link_str + self.result_html_suffix |
|
507 | 506 | fp_format = self.url_prefix + '%s/%s' |
|
508 | 507 | if sep == "\\": |
|
509 | 508 | # Working on a platform where the path separator is "\", so |
|
510 | 509 | # must convert these to "/" for generating a URI |
|
511 | 510 | def fp_cleaner(fp): |
|
512 | 511 | # Replace all occurences of backslash ("\") with a forward |
|
513 | 512 | # slash ("/") - this is necessary on windows when a path is |
|
514 | 513 | # provided as input, but we must link to a URI |
|
515 | 514 | return fp.replace('\\','/') |
|
516 | 515 | else: |
|
517 | 516 | fp_cleaner = None |
|
518 | 517 | |
|
519 | 518 | return self._get_display_formatter(dirname_output_format, |
|
520 | 519 | fname_output_format, |
|
521 | 520 | fp_format, |
|
522 | 521 | fp_cleaner) |
|
523 | 522 | |
|
524 | 523 | def _get_terminal_display_formatter(self, |
|
525 | 524 | spacer=" "): |
|
526 | 525 | """ generate function to use for terminal formatting |
|
527 | 526 | """ |
|
528 | 527 | dirname_output_format = "%s/" |
|
529 | 528 | fname_output_format = spacer + "%s" |
|
530 | 529 | fp_format = '%s/%s' |
|
531 | 530 | |
|
532 | 531 | return self._get_display_formatter(dirname_output_format, |
|
533 | 532 | fname_output_format, |
|
534 | 533 | fp_format) |
|
535 | 534 | |
|
536 | 535 | def _format_path(self): |
|
537 | 536 | result_lines = [] |
|
538 | 537 | if self.recursive: |
|
539 | 538 | walked_dir = list(walk(self.path)) |
|
540 | 539 | else: |
|
541 | 540 | walked_dir = [next(walk(self.path))] |
|
542 | 541 | walked_dir.sort() |
|
543 | 542 | for dirname, subdirs, fnames in walked_dir: |
|
544 | 543 | result_lines += self.notebook_display_formatter(dirname, fnames, self.included_suffixes) |
|
545 | 544 | return '\n'.join(result_lines) |
|
546 | 545 | |
|
547 | 546 | def __repr__(self): |
|
548 | 547 | """return newline-separated absolute paths |
|
549 | 548 | """ |
|
550 | 549 | result_lines = [] |
|
551 | 550 | if self.recursive: |
|
552 | 551 | walked_dir = list(walk(self.path)) |
|
553 | 552 | else: |
|
554 | 553 | walked_dir = [next(walk(self.path))] |
|
555 | 554 | walked_dir.sort() |
|
556 | 555 | for dirname, subdirs, fnames in walked_dir: |
|
557 | 556 | result_lines += self.terminal_display_formatter(dirname, fnames, self.included_suffixes) |
|
558 | 557 | return '\n'.join(result_lines) |
General Comments 0
You need to be logged in to leave comments.
Login now