Show More
@@ -1,1211 +1,1233 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 | from binascii import b2a_base64, hexlify |
|
9 | 9 | import json |
|
10 | 10 | import mimetypes |
|
11 | 11 | import os |
|
12 | 12 | import struct |
|
13 | 13 | import warnings |
|
14 | 14 | from copy import deepcopy |
|
15 | 15 | from os.path import splitext |
|
16 | 16 | from pathlib import Path, PurePath |
|
17 | 17 | |
|
18 | 18 | from IPython.utils.py3compat import cast_unicode |
|
19 | 19 | from IPython.testing.skipdoctest import skip_doctest |
|
20 | 20 | from . import display_functions |
|
21 | 21 | |
|
22 | 22 | |
|
23 | 23 | __all__ = ['display_pretty', 'display_html', 'display_markdown', |
|
24 | 24 | 'display_svg', 'display_png', 'display_jpeg', 'display_latex', 'display_json', |
|
25 | 25 | 'display_javascript', 'display_pdf', 'DisplayObject', 'TextDisplayObject', |
|
26 | 26 | 'Pretty', 'HTML', 'Markdown', 'Math', 'Latex', 'SVG', 'ProgressBar', 'JSON', |
|
27 | 27 | 'GeoJSON', 'Javascript', 'Image', 'set_matplotlib_formats', |
|
28 | 28 | 'set_matplotlib_close', |
|
29 | 29 | 'Video'] |
|
30 | 30 | |
|
31 | 31 | _deprecated_names = ["display", "clear_output", "publish_display_data", "update_display", "DisplayHandle"] |
|
32 | 32 | |
|
33 | 33 | __all__ = __all__ + _deprecated_names |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | # ----- warn to import from IPython.display ----- |
|
37 | 37 | |
|
38 | 38 | from warnings import warn |
|
39 | 39 | |
|
40 | 40 | |
|
41 | 41 | def __getattr__(name): |
|
42 | 42 | if name in _deprecated_names: |
|
43 | 43 | warn(f"Importing {name} from IPython.core.display is deprecated since IPython 7.14, please import from IPython display", DeprecationWarning, stacklevel=2) |
|
44 | 44 | return getattr(display_functions, name) |
|
45 | 45 | |
|
46 | 46 | if name in globals().keys(): |
|
47 | 47 | return globals()[name] |
|
48 | 48 | else: |
|
49 | 49 | raise AttributeError(f"module {__name__} has no attribute {name}") |
|
50 | 50 | |
|
51 | 51 | |
|
52 | 52 | #----------------------------------------------------------------------------- |
|
53 | 53 | # utility functions |
|
54 | 54 | #----------------------------------------------------------------------------- |
|
55 | 55 | |
|
56 | 56 | def _safe_exists(path): |
|
57 | 57 | """Check path, but don't let exceptions raise""" |
|
58 | 58 | try: |
|
59 | 59 | return os.path.exists(path) |
|
60 | 60 | except Exception: |
|
61 | 61 | return False |
|
62 | 62 | |
|
63 | 63 | |
|
64 | 64 | def _display_mimetype(mimetype, objs, raw=False, metadata=None): |
|
65 | 65 | """internal implementation of all display_foo methods |
|
66 | 66 | |
|
67 | 67 | Parameters |
|
68 | 68 | ---------- |
|
69 | 69 | mimetype : str |
|
70 | 70 | The mimetype to be published (e.g. 'image/png') |
|
71 | 71 | *objs : object |
|
72 | 72 | The Python objects to display, or if raw=True raw text data to |
|
73 | 73 | display. |
|
74 | 74 | raw : bool |
|
75 | 75 | Are the data objects raw data or Python objects that need to be |
|
76 | 76 | formatted before display? [default: False] |
|
77 | 77 | metadata : dict (optional) |
|
78 | 78 | Metadata to be associated with the specific mimetype output. |
|
79 | 79 | """ |
|
80 | 80 | if metadata: |
|
81 | 81 | metadata = {mimetype: metadata} |
|
82 | 82 | if raw: |
|
83 | 83 | # turn list of pngdata into list of { 'image/png': pngdata } |
|
84 | 84 | objs = [ {mimetype: obj} for obj in objs ] |
|
85 | 85 | display(*objs, raw=raw, metadata=metadata, include=[mimetype]) |
|
86 | 86 | |
|
87 | 87 | #----------------------------------------------------------------------------- |
|
88 | 88 | # Main functions |
|
89 | 89 | #----------------------------------------------------------------------------- |
|
90 | 90 | |
|
91 | 91 | |
|
92 | 92 | def display_pretty(*objs, **kwargs): |
|
93 | 93 | """Display the pretty (default) representation of an object. |
|
94 | 94 | |
|
95 | 95 | Parameters |
|
96 | 96 | ---------- |
|
97 | 97 | *objs : object |
|
98 | 98 | The Python objects to display, or if raw=True raw text data to |
|
99 | 99 | display. |
|
100 | 100 | raw : bool |
|
101 | 101 | Are the data objects raw data or Python objects that need to be |
|
102 | 102 | formatted before display? [default: False] |
|
103 | 103 | metadata : dict (optional) |
|
104 | 104 | Metadata to be associated with the specific mimetype output. |
|
105 | 105 | """ |
|
106 | 106 | _display_mimetype('text/plain', objs, **kwargs) |
|
107 | 107 | |
|
108 | 108 | |
|
109 | 109 | def display_html(*objs, **kwargs): |
|
110 | 110 | """Display the HTML representation of an object. |
|
111 | 111 | |
|
112 | 112 | Note: If raw=False and the object does not have a HTML |
|
113 | 113 | representation, no HTML will be shown. |
|
114 | 114 | |
|
115 | 115 | Parameters |
|
116 | 116 | ---------- |
|
117 | 117 | *objs : object |
|
118 | 118 | The Python objects to display, or if raw=True raw HTML data to |
|
119 | 119 | display. |
|
120 | 120 | raw : bool |
|
121 | 121 | Are the data objects raw data or Python objects that need to be |
|
122 | 122 | formatted before display? [default: False] |
|
123 | 123 | metadata : dict (optional) |
|
124 | 124 | Metadata to be associated with the specific mimetype output. |
|
125 | 125 | """ |
|
126 | 126 | _display_mimetype('text/html', objs, **kwargs) |
|
127 | 127 | |
|
128 | 128 | |
|
129 | 129 | def display_markdown(*objs, **kwargs): |
|
130 | 130 | """Displays the Markdown representation of an object. |
|
131 | 131 | |
|
132 | 132 | Parameters |
|
133 | 133 | ---------- |
|
134 | 134 | *objs : object |
|
135 | 135 | The Python objects to display, or if raw=True raw markdown data to |
|
136 | 136 | display. |
|
137 | 137 | raw : bool |
|
138 | 138 | Are the data objects raw data or Python objects that need to be |
|
139 | 139 | formatted before display? [default: False] |
|
140 | 140 | metadata : dict (optional) |
|
141 | 141 | Metadata to be associated with the specific mimetype output. |
|
142 | 142 | """ |
|
143 | 143 | |
|
144 | 144 | _display_mimetype('text/markdown', objs, **kwargs) |
|
145 | 145 | |
|
146 | 146 | |
|
147 | 147 | def display_svg(*objs, **kwargs): |
|
148 | 148 | """Display the SVG representation of an object. |
|
149 | 149 | |
|
150 | 150 | Parameters |
|
151 | 151 | ---------- |
|
152 | 152 | *objs : object |
|
153 | 153 | The Python objects to display, or if raw=True raw svg data to |
|
154 | 154 | display. |
|
155 | 155 | raw : bool |
|
156 | 156 | Are the data objects raw data or Python objects that need to be |
|
157 | 157 | formatted before display? [default: False] |
|
158 | 158 | metadata : dict (optional) |
|
159 | 159 | Metadata to be associated with the specific mimetype output. |
|
160 | 160 | """ |
|
161 | 161 | _display_mimetype('image/svg+xml', objs, **kwargs) |
|
162 | 162 | |
|
163 | 163 | |
|
164 | 164 | def display_png(*objs, **kwargs): |
|
165 | 165 | """Display the PNG representation of an object. |
|
166 | 166 | |
|
167 | 167 | Parameters |
|
168 | 168 | ---------- |
|
169 | 169 | *objs : object |
|
170 | 170 | The Python objects to display, or if raw=True raw png data to |
|
171 | 171 | display. |
|
172 | 172 | raw : bool |
|
173 | 173 | Are the data objects raw data or Python objects that need to be |
|
174 | 174 | formatted before display? [default: False] |
|
175 | 175 | metadata : dict (optional) |
|
176 | 176 | Metadata to be associated with the specific mimetype output. |
|
177 | 177 | """ |
|
178 | 178 | _display_mimetype('image/png', objs, **kwargs) |
|
179 | 179 | |
|
180 | 180 | |
|
181 | 181 | def display_jpeg(*objs, **kwargs): |
|
182 | 182 | """Display the JPEG representation of an object. |
|
183 | 183 | |
|
184 | 184 | Parameters |
|
185 | 185 | ---------- |
|
186 | 186 | *objs : object |
|
187 | 187 | The Python objects to display, or if raw=True raw JPEG data to |
|
188 | 188 | display. |
|
189 | 189 | raw : bool |
|
190 | 190 | Are the data objects raw data or Python objects that need to be |
|
191 | 191 | formatted before display? [default: False] |
|
192 | 192 | metadata : dict (optional) |
|
193 | 193 | Metadata to be associated with the specific mimetype output. |
|
194 | 194 | """ |
|
195 | 195 | _display_mimetype('image/jpeg', objs, **kwargs) |
|
196 | 196 | |
|
197 | 197 | |
|
198 | 198 | def display_latex(*objs, **kwargs): |
|
199 | 199 | """Display the LaTeX representation of an object. |
|
200 | 200 | |
|
201 | 201 | Parameters |
|
202 | 202 | ---------- |
|
203 | 203 | *objs : object |
|
204 | 204 | The Python objects to display, or if raw=True raw latex data to |
|
205 | 205 | display. |
|
206 | 206 | raw : bool |
|
207 | 207 | Are the data objects raw data or Python objects that need to be |
|
208 | 208 | formatted before display? [default: False] |
|
209 | 209 | metadata : dict (optional) |
|
210 | 210 | Metadata to be associated with the specific mimetype output. |
|
211 | 211 | """ |
|
212 | 212 | _display_mimetype('text/latex', objs, **kwargs) |
|
213 | 213 | |
|
214 | 214 | |
|
215 | 215 | def display_json(*objs, **kwargs): |
|
216 | 216 | """Display the JSON representation of an object. |
|
217 | 217 | |
|
218 | 218 | Note that not many frontends support displaying JSON. |
|
219 | 219 | |
|
220 | 220 | Parameters |
|
221 | 221 | ---------- |
|
222 | 222 | *objs : object |
|
223 | 223 | The Python objects to display, or if raw=True raw json data to |
|
224 | 224 | display. |
|
225 | 225 | raw : bool |
|
226 | 226 | Are the data objects raw data or Python objects that need to be |
|
227 | 227 | formatted before display? [default: False] |
|
228 | 228 | metadata : dict (optional) |
|
229 | 229 | Metadata to be associated with the specific mimetype output. |
|
230 | 230 | """ |
|
231 | 231 | _display_mimetype('application/json', objs, **kwargs) |
|
232 | 232 | |
|
233 | 233 | |
|
234 | 234 | def display_javascript(*objs, **kwargs): |
|
235 | 235 | """Display the Javascript representation of an object. |
|
236 | 236 | |
|
237 | 237 | Parameters |
|
238 | 238 | ---------- |
|
239 | 239 | *objs : object |
|
240 | 240 | The Python objects to display, or if raw=True raw javascript data to |
|
241 | 241 | display. |
|
242 | 242 | raw : bool |
|
243 | 243 | Are the data objects raw data or Python objects that need to be |
|
244 | 244 | formatted before display? [default: False] |
|
245 | 245 | metadata : dict (optional) |
|
246 | 246 | Metadata to be associated with the specific mimetype output. |
|
247 | 247 | """ |
|
248 | 248 | _display_mimetype('application/javascript', objs, **kwargs) |
|
249 | 249 | |
|
250 | 250 | |
|
251 | 251 | def display_pdf(*objs, **kwargs): |
|
252 | 252 | """Display the PDF representation of an object. |
|
253 | 253 | |
|
254 | 254 | Parameters |
|
255 | 255 | ---------- |
|
256 | 256 | *objs : object |
|
257 | 257 | The Python objects to display, or if raw=True raw javascript data to |
|
258 | 258 | display. |
|
259 | 259 | raw : bool |
|
260 | 260 | Are the data objects raw data or Python objects that need to be |
|
261 | 261 | formatted before display? [default: False] |
|
262 | 262 | metadata : dict (optional) |
|
263 | 263 | Metadata to be associated with the specific mimetype output. |
|
264 | 264 | """ |
|
265 | 265 | _display_mimetype('application/pdf', objs, **kwargs) |
|
266 | 266 | |
|
267 | 267 | |
|
268 | 268 | #----------------------------------------------------------------------------- |
|
269 | 269 | # Smart classes |
|
270 | 270 | #----------------------------------------------------------------------------- |
|
271 | 271 | |
|
272 | 272 | |
|
273 | 273 | class DisplayObject(object): |
|
274 | 274 | """An object that wraps data to be displayed.""" |
|
275 | 275 | |
|
276 | 276 | _read_flags = 'r' |
|
277 | 277 | _show_mem_addr = False |
|
278 | 278 | metadata = None |
|
279 | 279 | |
|
280 | 280 | def __init__(self, data=None, url=None, filename=None, metadata=None): |
|
281 | 281 | """Create a display object given raw data. |
|
282 | 282 | |
|
283 | 283 | When this object is returned by an expression or passed to the |
|
284 | 284 | display function, it will result in the data being displayed |
|
285 | 285 | in the frontend. The MIME type of the data should match the |
|
286 | 286 | subclasses used, so the Png subclass should be used for 'image/png' |
|
287 | 287 | data. If the data is a URL, the data will first be downloaded |
|
288 | 288 | and then displayed. If |
|
289 | 289 | |
|
290 | 290 | Parameters |
|
291 | 291 | ---------- |
|
292 | 292 | data : unicode, str or bytes |
|
293 | 293 | The raw data or a URL or file to load the data from |
|
294 | 294 | url : unicode |
|
295 | 295 | A URL to download the data from. |
|
296 | 296 | filename : unicode |
|
297 | 297 | Path to a local file to load the data from. |
|
298 | 298 | metadata : dict |
|
299 | 299 | Dict of metadata associated to be the object when displayed |
|
300 | 300 | """ |
|
301 | 301 | if isinstance(data, (Path, PurePath)): |
|
302 | 302 | data = str(data) |
|
303 | 303 | |
|
304 | 304 | if data is not None and isinstance(data, str): |
|
305 | 305 | if data.startswith('http') and url is None: |
|
306 | 306 | url = data |
|
307 | 307 | filename = None |
|
308 | 308 | data = None |
|
309 | 309 | elif _safe_exists(data) and filename is None: |
|
310 | 310 | url = None |
|
311 | 311 | filename = data |
|
312 | 312 | data = None |
|
313 | 313 | |
|
314 | 314 | self.url = url |
|
315 | 315 | self.filename = filename |
|
316 | 316 | # because of @data.setter methods in |
|
317 | 317 | # subclasses ensure url and filename are set |
|
318 | 318 | # before assigning to self.data |
|
319 | 319 | self.data = data |
|
320 | 320 | |
|
321 | 321 | if metadata is not None: |
|
322 | 322 | self.metadata = metadata |
|
323 | 323 | elif self.metadata is None: |
|
324 | 324 | self.metadata = {} |
|
325 | 325 | |
|
326 | 326 | self.reload() |
|
327 | 327 | self._check_data() |
|
328 | 328 | |
|
329 | 329 | def __repr__(self): |
|
330 | 330 | if not self._show_mem_addr: |
|
331 | 331 | cls = self.__class__ |
|
332 | 332 | r = "<%s.%s object>" % (cls.__module__, cls.__name__) |
|
333 | 333 | else: |
|
334 | 334 | r = super(DisplayObject, self).__repr__() |
|
335 | 335 | return r |
|
336 | 336 | |
|
337 | 337 | def _check_data(self): |
|
338 | 338 | """Override in subclasses if there's something to check.""" |
|
339 | 339 | pass |
|
340 | 340 | |
|
341 | 341 | def _data_and_metadata(self): |
|
342 | 342 | """shortcut for returning metadata with shape information, if defined""" |
|
343 | 343 | if self.metadata: |
|
344 | 344 | return self.data, deepcopy(self.metadata) |
|
345 | 345 | else: |
|
346 | 346 | return self.data |
|
347 | 347 | |
|
348 | 348 | def reload(self): |
|
349 | 349 | """Reload the raw data from file or URL.""" |
|
350 | 350 | if self.filename is not None: |
|
351 | 351 | with open(self.filename, self._read_flags) as f: |
|
352 | 352 | self.data = f.read() |
|
353 | 353 | elif self.url is not None: |
|
354 | 354 | # Deferred import |
|
355 | 355 | from urllib.request import urlopen |
|
356 | 356 | response = urlopen(self.url) |
|
357 | 357 | data = response.read() |
|
358 | 358 | # extract encoding from header, if there is one: |
|
359 | 359 | encoding = None |
|
360 | 360 | if 'content-type' in response.headers: |
|
361 | 361 | for sub in response.headers['content-type'].split(';'): |
|
362 | 362 | sub = sub.strip() |
|
363 | 363 | if sub.startswith('charset'): |
|
364 | 364 | encoding = sub.split('=')[-1].strip() |
|
365 | 365 | break |
|
366 | 366 | if 'content-encoding' in response.headers: |
|
367 | 367 | # TODO: do deflate? |
|
368 | 368 | if 'gzip' in response.headers['content-encoding']: |
|
369 | 369 | import gzip |
|
370 | 370 | from io import BytesIO |
|
371 | 371 | with gzip.open(BytesIO(data), 'rt', encoding=encoding) as fp: |
|
372 | 372 | encoding = None |
|
373 | 373 | data = fp.read() |
|
374 | 374 | |
|
375 | 375 | # decode data, if an encoding was specified |
|
376 | 376 | # We only touch self.data once since |
|
377 | 377 | # subclasses such as SVG have @data.setter methods |
|
378 | 378 | # that transform self.data into ... well svg. |
|
379 | 379 | if encoding: |
|
380 | 380 | self.data = data.decode(encoding, 'replace') |
|
381 | 381 | else: |
|
382 | 382 | self.data = data |
|
383 | 383 | |
|
384 | 384 | |
|
385 | 385 | class TextDisplayObject(DisplayObject): |
|
386 | 386 | """Validate that display data is text""" |
|
387 | 387 | def _check_data(self): |
|
388 | 388 | if self.data is not None and not isinstance(self.data, str): |
|
389 | 389 | raise TypeError("%s expects text, not %r" % (self.__class__.__name__, self.data)) |
|
390 | 390 | |
|
391 | 391 | class Pretty(TextDisplayObject): |
|
392 | 392 | |
|
393 | 393 | def _repr_pretty_(self, pp, cycle): |
|
394 | 394 | return pp.text(self.data) |
|
395 | 395 | |
|
396 | 396 | |
|
397 | 397 | class HTML(TextDisplayObject): |
|
398 | 398 | |
|
399 | 399 | def __init__(self, data=None, url=None, filename=None, metadata=None): |
|
400 | 400 | def warn(): |
|
401 | 401 | if not data: |
|
402 | 402 | return False |
|
403 | 403 | |
|
404 | 404 | # |
|
405 | 405 | # Avoid calling lower() on the entire data, because it could be a |
|
406 | 406 | # long string and we're only interested in its beginning and end. |
|
407 | 407 | # |
|
408 | 408 | prefix = data[:10].lower() |
|
409 | 409 | suffix = data[-10:].lower() |
|
410 | 410 | return prefix.startswith("<iframe ") and suffix.endswith("</iframe>") |
|
411 | 411 | |
|
412 | 412 | if warn(): |
|
413 | 413 | warnings.warn("Consider using IPython.display.IFrame instead") |
|
414 | 414 | super(HTML, self).__init__(data=data, url=url, filename=filename, metadata=metadata) |
|
415 | 415 | |
|
416 | 416 | def _repr_html_(self): |
|
417 | 417 | return self._data_and_metadata() |
|
418 | 418 | |
|
419 | 419 | def __html__(self): |
|
420 | 420 | """ |
|
421 | 421 | This method exists to inform other HTML-using modules (e.g. Markupsafe, |
|
422 | 422 | htmltag, etc) that this object is HTML and does not need things like |
|
423 | 423 | special characters (<>&) escaped. |
|
424 | 424 | """ |
|
425 | 425 | return self._repr_html_() |
|
426 | 426 | |
|
427 | 427 | |
|
428 | 428 | class Markdown(TextDisplayObject): |
|
429 | 429 | |
|
430 | 430 | def _repr_markdown_(self): |
|
431 | 431 | return self._data_and_metadata() |
|
432 | 432 | |
|
433 | 433 | |
|
434 | 434 | class Math(TextDisplayObject): |
|
435 | 435 | |
|
436 | 436 | def _repr_latex_(self): |
|
437 | 437 | s = r"$\displaystyle %s$" % self.data.strip('$') |
|
438 | 438 | if self.metadata: |
|
439 | 439 | return s, deepcopy(self.metadata) |
|
440 | 440 | else: |
|
441 | 441 | return s |
|
442 | 442 | |
|
443 | 443 | |
|
444 | 444 | class Latex(TextDisplayObject): |
|
445 | 445 | |
|
446 | 446 | def _repr_latex_(self): |
|
447 | 447 | return self._data_and_metadata() |
|
448 | 448 | |
|
449 | 449 | |
|
450 | 450 | class SVG(DisplayObject): |
|
451 | 451 | """Embed an SVG into the display. |
|
452 | 452 | |
|
453 | 453 | Note if you just want to view a svg image via a URL use `:class:Image` with |
|
454 | 454 | a url=URL keyword argument. |
|
455 | 455 | """ |
|
456 | 456 | |
|
457 | 457 | _read_flags = 'rb' |
|
458 | 458 | # wrap data in a property, which extracts the <svg> tag, discarding |
|
459 | 459 | # document headers |
|
460 | 460 | _data = None |
|
461 | 461 | |
|
462 | 462 | @property |
|
463 | 463 | def data(self): |
|
464 | 464 | return self._data |
|
465 | 465 | |
|
466 | 466 | @data.setter |
|
467 | 467 | def data(self, svg): |
|
468 | 468 | if svg is None: |
|
469 | 469 | self._data = None |
|
470 | 470 | return |
|
471 | 471 | # parse into dom object |
|
472 | 472 | from xml.dom import minidom |
|
473 | 473 | x = minidom.parseString(svg) |
|
474 | 474 | # get svg tag (should be 1) |
|
475 | 475 | found_svg = x.getElementsByTagName('svg') |
|
476 | 476 | if found_svg: |
|
477 | 477 | svg = found_svg[0].toxml() |
|
478 | 478 | else: |
|
479 | 479 | # fallback on the input, trust the user |
|
480 | 480 | # but this is probably an error. |
|
481 | 481 | pass |
|
482 | 482 | svg = cast_unicode(svg) |
|
483 | 483 | self._data = svg |
|
484 | 484 | |
|
485 | 485 | def _repr_svg_(self): |
|
486 | 486 | return self._data_and_metadata() |
|
487 | 487 | |
|
488 | 488 | class ProgressBar(DisplayObject): |
|
489 | 489 | """Progressbar supports displaying a progressbar like element |
|
490 | 490 | """ |
|
491 | 491 | def __init__(self, total): |
|
492 | 492 | """Creates a new progressbar |
|
493 | 493 | |
|
494 | 494 | Parameters |
|
495 | 495 | ---------- |
|
496 | 496 | total : int |
|
497 | 497 | maximum size of the progressbar |
|
498 | 498 | """ |
|
499 | 499 | self.total = total |
|
500 | 500 | self._progress = 0 |
|
501 | 501 | self.html_width = '60ex' |
|
502 | 502 | self.text_width = 60 |
|
503 | 503 | self._display_id = hexlify(os.urandom(8)).decode('ascii') |
|
504 | 504 | |
|
505 | 505 | def __repr__(self): |
|
506 | 506 | fraction = self.progress / self.total |
|
507 | 507 | filled = '=' * int(fraction * self.text_width) |
|
508 | 508 | rest = ' ' * (self.text_width - len(filled)) |
|
509 | 509 | return '[{}{}] {}/{}'.format( |
|
510 | 510 | filled, rest, |
|
511 | 511 | self.progress, self.total, |
|
512 | 512 | ) |
|
513 | 513 | |
|
514 | 514 | def _repr_html_(self): |
|
515 | 515 | return "<progress style='width:{}' max='{}' value='{}'></progress>".format( |
|
516 | 516 | self.html_width, self.total, self.progress) |
|
517 | 517 | |
|
518 | 518 | def display(self): |
|
519 | 519 | display(self, display_id=self._display_id) |
|
520 | 520 | |
|
521 | 521 | def update(self): |
|
522 | 522 | display(self, display_id=self._display_id, update=True) |
|
523 | 523 | |
|
524 | 524 | @property |
|
525 | 525 | def progress(self): |
|
526 | 526 | return self._progress |
|
527 | 527 | |
|
528 | 528 | @progress.setter |
|
529 | 529 | def progress(self, value): |
|
530 | 530 | self._progress = value |
|
531 | 531 | self.update() |
|
532 | 532 | |
|
533 | 533 | def __iter__(self): |
|
534 | 534 | self.display() |
|
535 | 535 | self._progress = -1 # First iteration is 0 |
|
536 | 536 | return self |
|
537 | 537 | |
|
538 | 538 | def __next__(self): |
|
539 | 539 | """Returns current value and increments display by one.""" |
|
540 | 540 | self.progress += 1 |
|
541 | 541 | if self.progress < self.total: |
|
542 | 542 | return self.progress |
|
543 | 543 | else: |
|
544 | 544 | raise StopIteration() |
|
545 | 545 | |
|
546 | 546 | class JSON(DisplayObject): |
|
547 | 547 | """JSON expects a JSON-able dict or list |
|
548 | 548 | |
|
549 | 549 | not an already-serialized JSON string. |
|
550 | 550 | |
|
551 | 551 | Scalar types (None, number, string) are not allowed, only dict or list containers. |
|
552 | 552 | """ |
|
553 | 553 | # wrap data in a property, which warns about passing already-serialized JSON |
|
554 | 554 | _data = None |
|
555 | 555 | def __init__(self, data=None, url=None, filename=None, expanded=False, metadata=None, root='root', **kwargs): |
|
556 | 556 | """Create a JSON display object given raw data. |
|
557 | 557 | |
|
558 | 558 | Parameters |
|
559 | 559 | ---------- |
|
560 | 560 | data : dict or list |
|
561 | 561 | JSON data to display. Not an already-serialized JSON string. |
|
562 | 562 | Scalar types (None, number, string) are not allowed, only dict |
|
563 | 563 | or list containers. |
|
564 | 564 | url : unicode |
|
565 | 565 | A URL to download the data from. |
|
566 | 566 | filename : unicode |
|
567 | 567 | Path to a local file to load the data from. |
|
568 | 568 | expanded : boolean |
|
569 | 569 | Metadata to control whether a JSON display component is expanded. |
|
570 | 570 | metadata : dict |
|
571 | 571 | Specify extra metadata to attach to the json display object. |
|
572 | 572 | root : str |
|
573 | 573 | The name of the root element of the JSON tree |
|
574 | 574 | """ |
|
575 | 575 | self.metadata = { |
|
576 | 576 | 'expanded': expanded, |
|
577 | 577 | 'root': root, |
|
578 | 578 | } |
|
579 | 579 | if metadata: |
|
580 | 580 | self.metadata.update(metadata) |
|
581 | 581 | if kwargs: |
|
582 | 582 | self.metadata.update(kwargs) |
|
583 | 583 | super(JSON, self).__init__(data=data, url=url, filename=filename) |
|
584 | 584 | |
|
585 | 585 | def _check_data(self): |
|
586 | 586 | if self.data is not None and not isinstance(self.data, (dict, list)): |
|
587 | 587 | raise TypeError("%s expects JSONable dict or list, not %r" % (self.__class__.__name__, self.data)) |
|
588 | 588 | |
|
589 | 589 | @property |
|
590 | 590 | def data(self): |
|
591 | 591 | return self._data |
|
592 | 592 | |
|
593 | 593 | @data.setter |
|
594 | 594 | def data(self, data): |
|
595 | 595 | if isinstance(data, (Path, PurePath)): |
|
596 | 596 | data = str(data) |
|
597 | 597 | |
|
598 | 598 | if isinstance(data, str): |
|
599 | 599 | if self.filename is None and self.url is None: |
|
600 | 600 | warnings.warn("JSON expects JSONable dict or list, not JSON strings") |
|
601 | 601 | data = json.loads(data) |
|
602 | 602 | self._data = data |
|
603 | 603 | |
|
604 | 604 | def _data_and_metadata(self): |
|
605 | 605 | return self.data, self.metadata |
|
606 | 606 | |
|
607 | 607 | def _repr_json_(self): |
|
608 | 608 | return self._data_and_metadata() |
|
609 | 609 | |
|
610 | 610 | _css_t = """var link = document.createElement("link"); |
|
611 | 611 | link.ref = "stylesheet"; |
|
612 | 612 | link.type = "text/css"; |
|
613 | 613 | link.href = "%s"; |
|
614 | 614 | document.head.appendChild(link); |
|
615 | 615 | """ |
|
616 | 616 | |
|
617 | 617 | _lib_t1 = """new Promise(function(resolve, reject) { |
|
618 | 618 | var script = document.createElement("script"); |
|
619 | 619 | script.onload = resolve; |
|
620 | 620 | script.onerror = reject; |
|
621 | 621 | script.src = "%s"; |
|
622 | 622 | document.head.appendChild(script); |
|
623 | 623 | }).then(() => { |
|
624 | 624 | """ |
|
625 | 625 | |
|
626 | 626 | _lib_t2 = """ |
|
627 | 627 | });""" |
|
628 | 628 | |
|
629 | 629 | class GeoJSON(JSON): |
|
630 | 630 | """GeoJSON expects JSON-able dict |
|
631 | 631 | |
|
632 | 632 | not an already-serialized JSON string. |
|
633 | 633 | |
|
634 | 634 | Scalar types (None, number, string) are not allowed, only dict containers. |
|
635 | 635 | """ |
|
636 | 636 | |
|
637 | 637 | def __init__(self, *args, **kwargs): |
|
638 | 638 | """Create a GeoJSON display object given raw data. |
|
639 | 639 | |
|
640 | 640 | Parameters |
|
641 | 641 | ---------- |
|
642 | 642 | data : dict or list |
|
643 | 643 | VegaLite data. Not an already-serialized JSON string. |
|
644 | 644 | Scalar types (None, number, string) are not allowed, only dict |
|
645 | 645 | or list containers. |
|
646 | 646 | url_template : string |
|
647 | 647 | Leaflet TileLayer URL template: http://leafletjs.com/reference.html#url-template |
|
648 | 648 | layer_options : dict |
|
649 | 649 | Leaflet TileLayer options: http://leafletjs.com/reference.html#tilelayer-options |
|
650 | 650 | url : unicode |
|
651 | 651 | A URL to download the data from. |
|
652 | 652 | filename : unicode |
|
653 | 653 | Path to a local file to load the data from. |
|
654 | 654 | metadata : dict |
|
655 | 655 | Specify extra metadata to attach to the json display object. |
|
656 | 656 | |
|
657 | 657 | Examples |
|
658 | 658 | -------- |
|
659 | 659 | The following will display an interactive map of Mars with a point of |
|
660 | 660 | interest on frontend that do support GeoJSON display. |
|
661 | 661 | |
|
662 | 662 | >>> from IPython.display import GeoJSON |
|
663 | 663 | |
|
664 | 664 | >>> GeoJSON(data={ |
|
665 | 665 | ... "type": "Feature", |
|
666 | 666 | ... "geometry": { |
|
667 | 667 | ... "type": "Point", |
|
668 | 668 | ... "coordinates": [-81.327, 296.038] |
|
669 | 669 | ... } |
|
670 | 670 | ... }, |
|
671 | 671 | ... url_template="http://s3-eu-west-1.amazonaws.com/whereonmars.cartodb.net/{basemap_id}/{z}/{x}/{y}.png", |
|
672 | 672 | ... layer_options={ |
|
673 | 673 | ... "basemap_id": "celestia_mars-shaded-16k_global", |
|
674 | 674 | ... "attribution" : "Celestia/praesepe", |
|
675 | 675 | ... "minZoom" : 0, |
|
676 | 676 | ... "maxZoom" : 18, |
|
677 | 677 | ... }) |
|
678 | 678 | <IPython.core.display.GeoJSON object> |
|
679 | 679 | |
|
680 | 680 | In the terminal IPython, you will only see the text representation of |
|
681 | 681 | the GeoJSON object. |
|
682 | 682 | |
|
683 | 683 | """ |
|
684 | 684 | |
|
685 | 685 | super(GeoJSON, self).__init__(*args, **kwargs) |
|
686 | 686 | |
|
687 | 687 | |
|
688 | 688 | def _ipython_display_(self): |
|
689 | 689 | bundle = { |
|
690 | 690 | 'application/geo+json': self.data, |
|
691 | 691 | 'text/plain': '<IPython.display.GeoJSON object>' |
|
692 | 692 | } |
|
693 | 693 | metadata = { |
|
694 | 694 | 'application/geo+json': self.metadata |
|
695 | 695 | } |
|
696 | 696 | display(bundle, metadata=metadata, raw=True) |
|
697 | 697 | |
|
698 | 698 | class Javascript(TextDisplayObject): |
|
699 | 699 | |
|
700 | 700 | def __init__(self, data=None, url=None, filename=None, lib=None, css=None): |
|
701 | 701 | """Create a Javascript display object given raw data. |
|
702 | 702 | |
|
703 | 703 | When this object is returned by an expression or passed to the |
|
704 | 704 | display function, it will result in the data being displayed |
|
705 | 705 | in the frontend. If the data is a URL, the data will first be |
|
706 | 706 | downloaded and then displayed. |
|
707 | 707 | |
|
708 | 708 | In the Notebook, the containing element will be available as `element`, |
|
709 | 709 | and jQuery will be available. Content appended to `element` will be |
|
710 | 710 | visible in the output area. |
|
711 | 711 | |
|
712 | 712 | Parameters |
|
713 | 713 | ---------- |
|
714 | 714 | data : unicode, str or bytes |
|
715 | 715 | The Javascript source code or a URL to download it from. |
|
716 | 716 | url : unicode |
|
717 | 717 | A URL to download the data from. |
|
718 | 718 | filename : unicode |
|
719 | 719 | Path to a local file to load the data from. |
|
720 | 720 | lib : list or str |
|
721 | 721 | A sequence of Javascript library URLs to load asynchronously before |
|
722 | 722 | running the source code. The full URLs of the libraries should |
|
723 | 723 | be given. A single Javascript library URL can also be given as a |
|
724 | 724 | string. |
|
725 | 725 | css : list or str |
|
726 | 726 | A sequence of css files to load before running the source code. |
|
727 | 727 | The full URLs of the css files should be given. A single css URL |
|
728 | 728 | can also be given as a string. |
|
729 | 729 | """ |
|
730 | 730 | if isinstance(lib, str): |
|
731 | 731 | lib = [lib] |
|
732 | 732 | elif lib is None: |
|
733 | 733 | lib = [] |
|
734 | 734 | if isinstance(css, str): |
|
735 | 735 | css = [css] |
|
736 | 736 | elif css is None: |
|
737 | 737 | css = [] |
|
738 | 738 | if not isinstance(lib, (list,tuple)): |
|
739 | 739 | raise TypeError('expected sequence, got: %r' % lib) |
|
740 | 740 | if not isinstance(css, (list,tuple)): |
|
741 | 741 | raise TypeError('expected sequence, got: %r' % css) |
|
742 | 742 | self.lib = lib |
|
743 | 743 | self.css = css |
|
744 | 744 | super(Javascript, self).__init__(data=data, url=url, filename=filename) |
|
745 | 745 | |
|
746 | 746 | def _repr_javascript_(self): |
|
747 | 747 | r = '' |
|
748 | 748 | for c in self.css: |
|
749 | 749 | r += _css_t % c |
|
750 | 750 | for l in self.lib: |
|
751 | 751 | r += _lib_t1 % l |
|
752 | 752 | r += self.data |
|
753 | 753 | r += _lib_t2*len(self.lib) |
|
754 | 754 | return r |
|
755 | 755 | |
|
756 | 756 | # constants for identifying png/jpeg data |
|
757 | 757 | _PNG = b'\x89PNG\r\n\x1a\n' |
|
758 | 758 | _JPEG = b'\xff\xd8' |
|
759 | 759 | |
|
760 | 760 | def _pngxy(data): |
|
761 | 761 | """read the (width, height) from a PNG header""" |
|
762 | 762 | ihdr = data.index(b'IHDR') |
|
763 | 763 | # next 8 bytes are width/height |
|
764 | 764 | return struct.unpack('>ii', data[ihdr+4:ihdr+12]) |
|
765 | 765 | |
|
766 | 766 | def _jpegxy(data): |
|
767 | 767 | """read the (width, height) from a JPEG header""" |
|
768 | 768 | # adapted from http://www.64lines.com/jpeg-width-height |
|
769 | 769 | |
|
770 | 770 | idx = 4 |
|
771 | 771 | while True: |
|
772 | 772 | block_size = struct.unpack('>H', data[idx:idx+2])[0] |
|
773 | 773 | idx = idx + block_size |
|
774 | 774 | if data[idx:idx+2] == b'\xFF\xC0': |
|
775 | 775 | # found Start of Frame |
|
776 | 776 | iSOF = idx |
|
777 | 777 | break |
|
778 | 778 | else: |
|
779 | 779 | # read another block |
|
780 | 780 | idx += 2 |
|
781 | 781 | |
|
782 | 782 | h, w = struct.unpack('>HH', data[iSOF+5:iSOF+9]) |
|
783 | 783 | return w, h |
|
784 | 784 | |
|
785 | 785 | def _gifxy(data): |
|
786 | 786 | """read the (width, height) from a GIF header""" |
|
787 | 787 | return struct.unpack('<HH', data[6:10]) |
|
788 | 788 | |
|
789 | 789 | |
|
790 | 790 | class Image(DisplayObject): |
|
791 | 791 | |
|
792 | 792 | _read_flags = 'rb' |
|
793 | 793 | _FMT_JPEG = u'jpeg' |
|
794 | 794 | _FMT_PNG = u'png' |
|
795 | 795 | _FMT_GIF = u'gif' |
|
796 | 796 | _ACCEPTABLE_EMBEDDINGS = [_FMT_JPEG, _FMT_PNG, _FMT_GIF] |
|
797 | 797 | _MIMETYPES = { |
|
798 | 798 | _FMT_PNG: 'image/png', |
|
799 | 799 | _FMT_JPEG: 'image/jpeg', |
|
800 | 800 | _FMT_GIF: 'image/gif', |
|
801 | 801 | } |
|
802 | 802 | |
|
803 | 803 | def __init__(self, data=None, url=None, filename=None, format=None, |
|
804 | 804 | embed=None, width=None, height=None, retina=False, |
|
805 | 805 | unconfined=False, metadata=None): |
|
806 | 806 | """Create a PNG/JPEG/GIF image object given raw data. |
|
807 | 807 | |
|
808 | 808 | When this object is returned by an input cell or passed to the |
|
809 | 809 | display function, it will result in the image being displayed |
|
810 | 810 | in the frontend. |
|
811 | 811 | |
|
812 | 812 | Parameters |
|
813 | 813 | ---------- |
|
814 | 814 | data : unicode, str or bytes |
|
815 | 815 | The raw image data or a URL or filename to load the data from. |
|
816 | 816 | This always results in embedded image data. |
|
817 | 817 | url : unicode |
|
818 | 818 | A URL to download the data from. If you specify `url=`, |
|
819 | 819 | the image data will not be embedded unless you also specify `embed=True`. |
|
820 | 820 | filename : unicode |
|
821 | 821 | Path to a local file to load the data from. |
|
822 | 822 | Images from a file are always embedded. |
|
823 | 823 | format : unicode |
|
824 | 824 | The format of the image data (png/jpeg/jpg/gif). If a filename or URL is given |
|
825 | 825 | for format will be inferred from the filename extension. |
|
826 | 826 | embed : bool |
|
827 | 827 | Should the image data be embedded using a data URI (True) or be |
|
828 | 828 | loaded using an <img> tag. Set this to True if you want the image |
|
829 | 829 | to be viewable later with no internet connection in the notebook. |
|
830 | 830 | |
|
831 | 831 | Default is `True`, unless the keyword argument `url` is set, then |
|
832 | 832 | default value is `False`. |
|
833 | 833 | |
|
834 | 834 | Note that QtConsole is not able to display images if `embed` is set to `False` |
|
835 | 835 | width : int |
|
836 | 836 | Width in pixels to which to constrain the image in html |
|
837 | 837 | height : int |
|
838 | 838 | Height in pixels to which to constrain the image in html |
|
839 | 839 | retina : bool |
|
840 | 840 | Automatically set the width and height to half of the measured |
|
841 | 841 | width and height. |
|
842 | 842 | This only works for embedded images because it reads the width/height |
|
843 | 843 | from image data. |
|
844 | 844 | For non-embedded images, you can just set the desired display width |
|
845 | 845 | and height directly. |
|
846 | 846 | unconfined : bool |
|
847 | 847 | Set unconfined=True to disable max-width confinement of the image. |
|
848 | 848 | metadata : dict |
|
849 | 849 | Specify extra metadata to attach to the image. |
|
850 | 850 | |
|
851 | 851 | Examples |
|
852 | 852 | -------- |
|
853 | 853 | embedded image data, works in qtconsole and notebook |
|
854 | 854 | when passed positionally, the first arg can be any of raw image data, |
|
855 | 855 | a URL, or a filename from which to load image data. |
|
856 | 856 | The result is always embedding image data for inline images. |
|
857 | 857 | |
|
858 | 858 | >>> Image('http://www.google.fr/images/srpr/logo3w.png') |
|
859 | 859 | <IPython.core.display.Image object> |
|
860 | 860 | |
|
861 | 861 | >>> Image('/path/to/image.jpg') |
|
862 | 862 | <IPython.core.display.Image object> |
|
863 | 863 | |
|
864 | 864 | >>> Image(b'RAW_PNG_DATA...') |
|
865 | 865 | <IPython.core.display.Image object> |
|
866 | 866 | |
|
867 | 867 | Specifying Image(url=...) does not embed the image data, |
|
868 | 868 | it only generates ``<img>`` tag with a link to the source. |
|
869 | 869 | This will not work in the qtconsole or offline. |
|
870 | 870 | |
|
871 | 871 | >>> Image(url='http://www.google.fr/images/srpr/logo3w.png') |
|
872 | 872 | <IPython.core.display.Image object> |
|
873 | 873 | |
|
874 | 874 | """ |
|
875 | 875 | if isinstance(data, (Path, PurePath)): |
|
876 | 876 | data = str(data) |
|
877 | 877 | |
|
878 | 878 | if filename is not None: |
|
879 | 879 | ext = self._find_ext(filename) |
|
880 | 880 | elif url is not None: |
|
881 | 881 | ext = self._find_ext(url) |
|
882 | 882 | elif data is None: |
|
883 | 883 | raise ValueError("No image data found. Expecting filename, url, or data.") |
|
884 | 884 | elif isinstance(data, str) and ( |
|
885 | 885 | data.startswith('http') or _safe_exists(data) |
|
886 | 886 | ): |
|
887 | 887 | ext = self._find_ext(data) |
|
888 | 888 | else: |
|
889 | 889 | ext = None |
|
890 | 890 | |
|
891 | 891 | if format is None: |
|
892 | 892 | if ext is not None: |
|
893 | 893 | if ext == u'jpg' or ext == u'jpeg': |
|
894 | 894 | format = self._FMT_JPEG |
|
895 | 895 | elif ext == u'png': |
|
896 | 896 | format = self._FMT_PNG |
|
897 | 897 | elif ext == u'gif': |
|
898 | 898 | format = self._FMT_GIF |
|
899 | 899 | else: |
|
900 | 900 | format = ext.lower() |
|
901 | 901 | elif isinstance(data, bytes): |
|
902 | 902 | # infer image type from image data header, |
|
903 | 903 | # only if format has not been specified. |
|
904 | 904 | if data[:2] == _JPEG: |
|
905 | 905 | format = self._FMT_JPEG |
|
906 | 906 | |
|
907 | 907 | # failed to detect format, default png |
|
908 | 908 | if format is None: |
|
909 | 909 | format = self._FMT_PNG |
|
910 | 910 | |
|
911 | 911 | if format.lower() == 'jpg': |
|
912 | 912 | # jpg->jpeg |
|
913 | 913 | format = self._FMT_JPEG |
|
914 | 914 | |
|
915 | 915 | self.format = format.lower() |
|
916 | 916 | self.embed = embed if embed is not None else (url is None) |
|
917 | 917 | |
|
918 | 918 | if self.embed and self.format not in self._ACCEPTABLE_EMBEDDINGS: |
|
919 | 919 | raise ValueError("Cannot embed the '%s' image format" % (self.format)) |
|
920 | 920 | if self.embed: |
|
921 | 921 | self._mimetype = self._MIMETYPES.get(self.format) |
|
922 | 922 | |
|
923 | 923 | self.width = width |
|
924 | 924 | self.height = height |
|
925 | 925 | self.retina = retina |
|
926 | 926 | self.unconfined = unconfined |
|
927 | 927 | super(Image, self).__init__(data=data, url=url, filename=filename, |
|
928 | 928 | metadata=metadata) |
|
929 | 929 | |
|
930 | 930 | if self.width is None and self.metadata.get('width', {}): |
|
931 | 931 | self.width = metadata['width'] |
|
932 | 932 | |
|
933 | 933 | if self.height is None and self.metadata.get('height', {}): |
|
934 | 934 | self.height = metadata['height'] |
|
935 | 935 | |
|
936 | 936 | if retina: |
|
937 | 937 | self._retina_shape() |
|
938 | 938 | |
|
939 | 939 | |
|
940 | 940 | def _retina_shape(self): |
|
941 | 941 | """load pixel-doubled width and height from image data""" |
|
942 | 942 | if not self.embed: |
|
943 | 943 | return |
|
944 | 944 | if self.format == self._FMT_PNG: |
|
945 | 945 | w, h = _pngxy(self.data) |
|
946 | 946 | elif self.format == self._FMT_JPEG: |
|
947 | 947 | w, h = _jpegxy(self.data) |
|
948 | 948 | elif self.format == self._FMT_GIF: |
|
949 | 949 | w, h = _gifxy(self.data) |
|
950 | 950 | else: |
|
951 | 951 | # retina only supports png |
|
952 | 952 | return |
|
953 | 953 | self.width = w // 2 |
|
954 | 954 | self.height = h // 2 |
|
955 | 955 | |
|
956 | 956 | def reload(self): |
|
957 | 957 | """Reload the raw data from file or URL.""" |
|
958 | 958 | if self.embed: |
|
959 | 959 | super(Image,self).reload() |
|
960 | 960 | if self.retina: |
|
961 | 961 | self._retina_shape() |
|
962 | 962 | |
|
963 | 963 | def _repr_html_(self): |
|
964 | 964 | if not self.embed: |
|
965 | 965 | width = height = klass = '' |
|
966 | 966 | if self.width: |
|
967 | 967 | width = ' width="%d"' % self.width |
|
968 | 968 | if self.height: |
|
969 | 969 | height = ' height="%d"' % self.height |
|
970 | 970 | if self.unconfined: |
|
971 | 971 | klass = ' class="unconfined"' |
|
972 | 972 | return u'<img src="{url}"{width}{height}{klass}/>'.format( |
|
973 | 973 | url=self.url, |
|
974 | 974 | width=width, |
|
975 | 975 | height=height, |
|
976 | 976 | klass=klass, |
|
977 | 977 | ) |
|
978 | 978 | |
|
979 | 979 | def _repr_mimebundle_(self, include=None, exclude=None): |
|
980 | 980 | """Return the image as a mimebundle |
|
981 | 981 | |
|
982 | 982 | Any new mimetype support should be implemented here. |
|
983 | 983 | """ |
|
984 | 984 | if self.embed: |
|
985 | 985 | mimetype = self._mimetype |
|
986 | 986 | data, metadata = self._data_and_metadata(always_both=True) |
|
987 | 987 | if metadata: |
|
988 | 988 | metadata = {mimetype: metadata} |
|
989 | 989 | return {mimetype: data}, metadata |
|
990 | 990 | else: |
|
991 | 991 | return {'text/html': self._repr_html_()} |
|
992 | 992 | |
|
993 | 993 | def _data_and_metadata(self, always_both=False): |
|
994 | 994 | """shortcut for returning metadata with shape information, if defined""" |
|
995 | 995 | try: |
|
996 | 996 | b64_data = b2a_base64(self.data).decode('ascii') |
|
997 | 997 | except TypeError as e: |
|
998 | 998 | raise FileNotFoundError( |
|
999 | 999 | "No such file or directory: '%s'" % (self.data)) from e |
|
1000 | 1000 | md = {} |
|
1001 | 1001 | if self.metadata: |
|
1002 | 1002 | md.update(self.metadata) |
|
1003 | 1003 | if self.width: |
|
1004 | 1004 | md['width'] = self.width |
|
1005 | 1005 | if self.height: |
|
1006 | 1006 | md['height'] = self.height |
|
1007 | 1007 | if self.unconfined: |
|
1008 | 1008 | md['unconfined'] = self.unconfined |
|
1009 | 1009 | if md or always_both: |
|
1010 | 1010 | return b64_data, md |
|
1011 | 1011 | else: |
|
1012 | 1012 | return b64_data |
|
1013 | 1013 | |
|
1014 | 1014 | def _repr_png_(self): |
|
1015 | 1015 | if self.embed and self.format == self._FMT_PNG: |
|
1016 | 1016 | return self._data_and_metadata() |
|
1017 | 1017 | |
|
1018 | 1018 | def _repr_jpeg_(self): |
|
1019 | 1019 | if self.embed and self.format == self._FMT_JPEG: |
|
1020 | 1020 | return self._data_and_metadata() |
|
1021 | 1021 | |
|
1022 | 1022 | def _find_ext(self, s): |
|
1023 | 1023 | base, ext = splitext(s) |
|
1024 | 1024 | |
|
1025 | 1025 | if not ext: |
|
1026 | 1026 | return base |
|
1027 | 1027 | |
|
1028 | 1028 | # `splitext` includes leading period, so we skip it |
|
1029 | 1029 | return ext[1:].lower() |
|
1030 | 1030 | |
|
1031 | 1031 | |
|
1032 | 1032 | class Video(DisplayObject): |
|
1033 | 1033 | |
|
1034 | 1034 | def __init__(self, data=None, url=None, filename=None, embed=False, |
|
1035 | 1035 | mimetype=None, width=None, height=None, html_attributes="controls"): |
|
1036 | 1036 | """Create a video object given raw data or an URL. |
|
1037 | 1037 | |
|
1038 | 1038 | When this object is returned by an input cell or passed to the |
|
1039 | 1039 | display function, it will result in the video being displayed |
|
1040 | 1040 | in the frontend. |
|
1041 | 1041 | |
|
1042 | 1042 | Parameters |
|
1043 | 1043 | ---------- |
|
1044 | 1044 | data : unicode, str or bytes |
|
1045 | 1045 | The raw video data or a URL or filename to load the data from. |
|
1046 | 1046 | Raw data will require passing ``embed=True``. |
|
1047 | 1047 | url : unicode |
|
1048 | 1048 | A URL for the video. If you specify ``url=``, |
|
1049 | 1049 | the image data will not be embedded. |
|
1050 | 1050 | filename : unicode |
|
1051 | 1051 | Path to a local file containing the video. |
|
1052 | 1052 | Will be interpreted as a local URL unless ``embed=True``. |
|
1053 | 1053 | embed : bool |
|
1054 | 1054 | Should the video be embedded using a data URI (True) or be |
|
1055 | 1055 | loaded using a <video> tag (False). |
|
1056 | 1056 | |
|
1057 | 1057 | Since videos are large, embedding them should be avoided, if possible. |
|
1058 | 1058 | You must confirm embedding as your intention by passing ``embed=True``. |
|
1059 | 1059 | |
|
1060 | 1060 | Local files can be displayed with URLs without embedding the content, via:: |
|
1061 | 1061 | |
|
1062 | 1062 | Video('./video.mp4') |
|
1063 | 1063 | mimetype : unicode |
|
1064 | 1064 | Specify the mimetype for embedded videos. |
|
1065 | 1065 | Default will be guessed from file extension, if available. |
|
1066 | 1066 | width : int |
|
1067 | 1067 | Width in pixels to which to constrain the video in HTML. |
|
1068 | 1068 | If not supplied, defaults to the width of the video. |
|
1069 | 1069 | height : int |
|
1070 | 1070 | Height in pixels to which to constrain the video in html. |
|
1071 | 1071 | If not supplied, defaults to the height of the video. |
|
1072 | 1072 | html_attributes : str |
|
1073 | 1073 | Attributes for the HTML ``<video>`` block. |
|
1074 | 1074 | Default: ``"controls"`` to get video controls. |
|
1075 | 1075 | Other examples: ``"controls muted"`` for muted video with controls, |
|
1076 | 1076 | ``"loop autoplay"`` for looping autoplaying video without controls. |
|
1077 | 1077 | |
|
1078 | 1078 | Examples |
|
1079 | 1079 | -------- |
|
1080 | 1080 | :: |
|
1081 | 1081 | |
|
1082 | 1082 | Video('https://archive.org/download/Sita_Sings_the_Blues/Sita_Sings_the_Blues_small.mp4') |
|
1083 | 1083 | Video('path/to/video.mp4') |
|
1084 | 1084 | Video('path/to/video.mp4', embed=True) |
|
1085 | 1085 | Video('path/to/video.mp4', embed=True, html_attributes="controls muted autoplay") |
|
1086 | 1086 | Video(b'raw-videodata', embed=True) |
|
1087 | 1087 | """ |
|
1088 | 1088 | if isinstance(data, (Path, PurePath)): |
|
1089 | 1089 | data = str(data) |
|
1090 | 1090 | |
|
1091 | 1091 | if url is None and isinstance(data, str) and data.startswith(('http:', 'https:')): |
|
1092 | 1092 | url = data |
|
1093 | 1093 | data = None |
|
1094 | 1094 | elif data is not None and os.path.exists(data): |
|
1095 | 1095 | filename = data |
|
1096 | 1096 | data = None |
|
1097 | 1097 | |
|
1098 | 1098 | if data and not embed: |
|
1099 | 1099 | msg = ''.join([ |
|
1100 | 1100 | "To embed videos, you must pass embed=True ", |
|
1101 | 1101 | "(this may make your notebook files huge)\n", |
|
1102 | 1102 | "Consider passing Video(url='...')", |
|
1103 | 1103 | ]) |
|
1104 | 1104 | raise ValueError(msg) |
|
1105 | 1105 | |
|
1106 | 1106 | self.mimetype = mimetype |
|
1107 | 1107 | self.embed = embed |
|
1108 | 1108 | self.width = width |
|
1109 | 1109 | self.height = height |
|
1110 | 1110 | self.html_attributes = html_attributes |
|
1111 | 1111 | super(Video, self).__init__(data=data, url=url, filename=filename) |
|
1112 | 1112 | |
|
1113 | 1113 | def _repr_html_(self): |
|
1114 | 1114 | width = height = '' |
|
1115 | 1115 | if self.width: |
|
1116 | 1116 | width = ' width="%d"' % self.width |
|
1117 | 1117 | if self.height: |
|
1118 | 1118 | height = ' height="%d"' % self.height |
|
1119 | 1119 | |
|
1120 | 1120 | # External URLs and potentially local files are not embedded into the |
|
1121 | 1121 | # notebook output. |
|
1122 | 1122 | if not self.embed: |
|
1123 | 1123 | url = self.url if self.url is not None else self.filename |
|
1124 | 1124 | output = """<video src="{0}" {1} {2} {3}> |
|
1125 | 1125 | Your browser does not support the <code>video</code> element. |
|
1126 | 1126 | </video>""".format(url, self.html_attributes, width, height) |
|
1127 | 1127 | return output |
|
1128 | 1128 | |
|
1129 | 1129 | # Embedded videos are base64-encoded. |
|
1130 | 1130 | mimetype = self.mimetype |
|
1131 | 1131 | if self.filename is not None: |
|
1132 | 1132 | if not mimetype: |
|
1133 | 1133 | mimetype, _ = mimetypes.guess_type(self.filename) |
|
1134 | 1134 | |
|
1135 | 1135 | with open(self.filename, 'rb') as f: |
|
1136 | 1136 | video = f.read() |
|
1137 | 1137 | else: |
|
1138 | 1138 | video = self.data |
|
1139 | 1139 | if isinstance(video, str): |
|
1140 | 1140 | # unicode input is already b64-encoded |
|
1141 | 1141 | b64_video = video |
|
1142 | 1142 | else: |
|
1143 | 1143 | b64_video = b2a_base64(video).decode('ascii').rstrip() |
|
1144 | 1144 | |
|
1145 | 1145 | output = """<video {0} {1} {2}> |
|
1146 | 1146 | <source src="data:{3};base64,{4}" type="{3}"> |
|
1147 | 1147 | Your browser does not support the video tag. |
|
1148 | 1148 | </video>""".format(self.html_attributes, width, height, mimetype, b64_video) |
|
1149 | 1149 | return output |
|
1150 | 1150 | |
|
1151 | 1151 | def reload(self): |
|
1152 | 1152 | # TODO |
|
1153 | 1153 | pass |
|
1154 | 1154 | |
|
1155 | 1155 | |
|
1156 | 1156 | @skip_doctest |
|
1157 | 1157 | def set_matplotlib_formats(*formats, **kwargs): |
|
1158 | """Select figure formats for the inline backend. Optionally pass quality for JPEG. | |
|
1158 | """ | |
|
1159 | .. deprecated:: 7.23 | |
|
1160 | ||
|
1161 | use `matplotlib_inline.backend_inline.set_matplotlib_formats()` | |
|
1162 | ||
|
1163 | Select figure formats for the inline backend. Optionally pass quality for JPEG. | |
|
1159 | 1164 | |
|
1160 | 1165 | For example, this enables PNG and JPEG output with a JPEG quality of 90%:: |
|
1161 | 1166 | |
|
1162 | 1167 | In [1]: set_matplotlib_formats('png', 'jpeg', quality=90) |
|
1163 | 1168 | |
|
1164 | 1169 | To set this in your config files use the following:: |
|
1165 | 1170 | |
|
1166 | 1171 | c.InlineBackend.figure_formats = {'png', 'jpeg'} |
|
1167 | 1172 | c.InlineBackend.print_figure_kwargs.update({'quality' : 90}) |
|
1168 | 1173 | |
|
1169 | 1174 | Parameters |
|
1170 | 1175 | ---------- |
|
1171 | 1176 | *formats : strs |
|
1172 | 1177 | One or more figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'. |
|
1173 | 1178 | **kwargs |
|
1174 | 1179 | Keyword args will be relayed to ``figure.canvas.print_figure``. |
|
1175 | 1180 | """ |
|
1176 | from IPython.core.interactiveshell import InteractiveShell | |
|
1177 | from IPython.core.pylabtools import select_figure_formats | |
|
1178 | # build kwargs, starting with InlineBackend config | |
|
1179 | kw = {} | |
|
1180 | from ipykernel.pylab.config import InlineBackend | |
|
1181 | cfg = InlineBackend.instance() | |
|
1182 | kw.update(cfg.print_figure_kwargs) | |
|
1183 | kw.update(**kwargs) | |
|
1184 | shell = InteractiveShell.instance() | |
|
1185 | select_figure_formats(shell, formats, **kw) | |
|
1181 | warnings.warn( | |
|
1182 | "`set_matplotlib_formats` is deprecated since IPython 7.23, directly " | |
|
1183 | "use `matplotlib_inline.backend_inline.set_matplotlib_formats()`", | |
|
1184 | DeprecationWarning, | |
|
1185 | stacklevel=2, | |
|
1186 | ) | |
|
1187 | ||
|
1188 | from matplotlib_inline.backend_inline import ( | |
|
1189 | set_matplotlib_formats as set_matplotlib_formats_orig, | |
|
1190 | ) | |
|
1191 | ||
|
1192 | set_matplotlib_formats_orig(*formats, **kwargs) | |
|
1186 | 1193 | |
|
1187 | 1194 | @skip_doctest |
|
1188 | 1195 | def set_matplotlib_close(close=True): |
|
1189 | """Set whether the inline backend closes all figures automatically or not. | |
|
1196 | """ | |
|
1197 | .. deprecated:: 7.23 | |
|
1198 | ||
|
1199 | use `matplotlib_inline.backend_inline.set_matplotlib_close()` | |
|
1200 | ||
|
1201 | ||
|
1202 | Set whether the inline backend closes all figures automatically or not. | |
|
1190 | 1203 | |
|
1191 | 1204 | By default, the inline backend used in the IPython Notebook will close all |
|
1192 | 1205 | matplotlib figures automatically after each cell is run. This means that |
|
1193 | 1206 | plots in different cells won't interfere. Sometimes, you may want to make |
|
1194 | 1207 | a plot in one cell and then refine it in later cells. This can be accomplished |
|
1195 | 1208 | by:: |
|
1196 | 1209 | |
|
1197 | 1210 | In [1]: set_matplotlib_close(False) |
|
1198 | 1211 | |
|
1199 | 1212 | To set this in your config files use the following:: |
|
1200 | 1213 | |
|
1201 | 1214 | c.InlineBackend.close_figures = False |
|
1202 | 1215 | |
|
1203 | 1216 | Parameters |
|
1204 | 1217 | ---------- |
|
1205 | 1218 | close : bool |
|
1206 | 1219 | Should all matplotlib figures be automatically closed after each cell is |
|
1207 | 1220 | run? |
|
1208 | 1221 | """ |
|
1209 | from ipykernel.pylab.config import InlineBackend | |
|
1210 | cfg = InlineBackend.instance() | |
|
1211 | cfg.close_figures = close | |
|
1222 | warnings.warn( | |
|
1223 | "`set_matplotlib_close` is deprecated since IPython 7.23, directly " | |
|
1224 | "use `matplotlib_inline.backend_inline.set_matplotlib_close()`", | |
|
1225 | DeprecationWarning, | |
|
1226 | stacklevel=2, | |
|
1227 | ) | |
|
1228 | ||
|
1229 | from matplotlib_inline.backend_inline import ( | |
|
1230 | set_matplotlib_close as set_matplotlib_close_orig, | |
|
1231 | ) | |
|
1232 | ||
|
1233 | set_matplotlib_close_orig(close) |
@@ -1,3851 +1,3852 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 abc |
|
15 | 15 | import ast |
|
16 | 16 | import atexit |
|
17 | 17 | import builtins as builtin_mod |
|
18 | 18 | import functools |
|
19 | 19 | import inspect |
|
20 | 20 | import os |
|
21 | 21 | import re |
|
22 | 22 | import runpy |
|
23 | 23 | import sys |
|
24 | 24 | import tempfile |
|
25 | 25 | import traceback |
|
26 | 26 | import types |
|
27 | 27 | import subprocess |
|
28 | 28 | import warnings |
|
29 | 29 | from io import open as io_open |
|
30 | 30 | |
|
31 | 31 | from pathlib import Path |
|
32 | 32 | from pickleshare import PickleShareDB |
|
33 | 33 | |
|
34 | 34 | from traitlets.config.configurable import SingletonConfigurable |
|
35 | 35 | from traitlets.utils.importstring import import_item |
|
36 | 36 | from IPython.core import oinspect |
|
37 | 37 | from IPython.core import magic |
|
38 | 38 | from IPython.core import page |
|
39 | 39 | from IPython.core import prefilter |
|
40 | 40 | from IPython.core import ultratb |
|
41 | 41 | from IPython.core.alias import Alias, AliasManager |
|
42 | 42 | from IPython.core.autocall import ExitAutocall |
|
43 | 43 | from IPython.core.builtin_trap import BuiltinTrap |
|
44 | 44 | from IPython.core.events import EventManager, available_events |
|
45 | 45 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
46 | 46 | from IPython.core.debugger import Pdb |
|
47 | 47 | from IPython.core.display_trap import DisplayTrap |
|
48 | 48 | from IPython.core.displayhook import DisplayHook |
|
49 | 49 | from IPython.core.displaypub import DisplayPublisher |
|
50 | 50 | from IPython.core.error import InputRejected, UsageError |
|
51 | 51 | from IPython.core.extensions import ExtensionManager |
|
52 | 52 | from IPython.core.formatters import DisplayFormatter |
|
53 | 53 | from IPython.core.history import HistoryManager |
|
54 | 54 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
55 | 55 | from IPython.core.logger import Logger |
|
56 | 56 | from IPython.core.macro import Macro |
|
57 | 57 | from IPython.core.payload import PayloadManager |
|
58 | 58 | from IPython.core.prefilter import PrefilterManager |
|
59 | 59 | from IPython.core.profiledir import ProfileDir |
|
60 | 60 | from IPython.core.usage import default_banner |
|
61 | 61 | from IPython.display import display |
|
62 | 62 | from IPython.testing.skipdoctest import skip_doctest |
|
63 | 63 | from IPython.utils import PyColorize |
|
64 | 64 | from IPython.utils import io |
|
65 | 65 | from IPython.utils import py3compat |
|
66 | 66 | from IPython.utils import openpy |
|
67 | 67 | from IPython.utils.decorators import undoc |
|
68 | 68 | from IPython.utils.io import ask_yes_no |
|
69 | 69 | from IPython.utils.ipstruct import Struct |
|
70 | 70 | from IPython.paths import get_ipython_dir |
|
71 | 71 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
72 | 72 | from IPython.utils.process import system, getoutput |
|
73 | 73 | from IPython.utils.strdispatch import StrDispatch |
|
74 | 74 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
75 | 75 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
76 | 76 | from IPython.utils.tempdir import TemporaryDirectory |
|
77 | 77 | from traitlets import ( |
|
78 | 78 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
79 | 79 | observe, default, validate, Any |
|
80 | 80 | ) |
|
81 | 81 | from warnings import warn |
|
82 | 82 | from logging import error |
|
83 | 83 | import IPython.core.hooks |
|
84 | 84 | |
|
85 | 85 | from typing import List as ListType, Tuple, Optional |
|
86 | 86 | from ast import AST |
|
87 | 87 | |
|
88 | 88 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
89 | 89 | # See https://github.com/ipython/ipykernel/issues/157 |
|
90 | 90 | # (2016, let's try to remove than in IPython 8.0) |
|
91 | 91 | from IPython.utils.contexts import NoOpContext |
|
92 | 92 | |
|
93 | 93 | try: |
|
94 | 94 | import docrepr.sphinxify as sphx |
|
95 | 95 | |
|
96 | 96 | def sphinxify(doc): |
|
97 | 97 | with TemporaryDirectory() as dirname: |
|
98 | 98 | return { |
|
99 | 99 | 'text/html': sphx.sphinxify(doc, dirname), |
|
100 | 100 | 'text/plain': doc |
|
101 | 101 | } |
|
102 | 102 | except ImportError: |
|
103 | 103 | sphinxify = None |
|
104 | 104 | |
|
105 | 105 | |
|
106 | 106 | class ProvisionalWarning(DeprecationWarning): |
|
107 | 107 | """ |
|
108 | 108 | Warning class for unstable features |
|
109 | 109 | """ |
|
110 | 110 | pass |
|
111 | 111 | |
|
112 | 112 | if sys.version_info > (3,8): |
|
113 | 113 | from ast import Module |
|
114 | 114 | else : |
|
115 | 115 | # mock the new API, ignore second argument |
|
116 | 116 | # see https://github.com/ipython/ipython/issues/11590 |
|
117 | 117 | from ast import Module as OriginalModule |
|
118 | 118 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
119 | 119 | |
|
120 | 120 | if sys.version_info > (3,6): |
|
121 | 121 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
122 | 122 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
123 | 123 | else: |
|
124 | 124 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
125 | 125 | _single_targets_nodes = (ast.AugAssign, ) |
|
126 | 126 | |
|
127 | 127 | #----------------------------------------------------------------------------- |
|
128 | 128 | # Await Helpers |
|
129 | 129 | #----------------------------------------------------------------------------- |
|
130 | 130 | |
|
131 | 131 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: |
|
132 | 132 | """Return a function that do not create a new local scope. |
|
133 | 133 | |
|
134 | 134 | Given a function, create a clone of this function where the co_newlocal flag |
|
135 | 135 | has been removed, making this function code actually run in the sourounding |
|
136 | 136 | scope. |
|
137 | 137 | |
|
138 | 138 | We need this in order to run asynchronous code in user level namespace. |
|
139 | 139 | """ |
|
140 | 140 | from types import CodeType, FunctionType |
|
141 | 141 | CO_NEWLOCALS = 0x0002 |
|
142 | 142 | code = function.__code__ |
|
143 | 143 | new_co_flags = code.co_flags & ~CO_NEWLOCALS |
|
144 | 144 | if sys.version_info > (3, 8, 0, 'alpha', 3): |
|
145 | 145 | new_code = code.replace(co_flags=new_co_flags) |
|
146 | 146 | else: |
|
147 | 147 | new_code = CodeType( |
|
148 | 148 | code.co_argcount, |
|
149 | 149 | code.co_kwonlyargcount, |
|
150 | 150 | code.co_nlocals, |
|
151 | 151 | code.co_stacksize, |
|
152 | 152 | new_co_flags, |
|
153 | 153 | code.co_code, |
|
154 | 154 | code.co_consts, |
|
155 | 155 | code.co_names, |
|
156 | 156 | code.co_varnames, |
|
157 | 157 | code.co_filename, |
|
158 | 158 | code.co_name, |
|
159 | 159 | code.co_firstlineno, |
|
160 | 160 | code.co_lnotab, |
|
161 | 161 | code.co_freevars, |
|
162 | 162 | code.co_cellvars |
|
163 | 163 | ) |
|
164 | 164 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | # we still need to run things using the asyncio eventloop, but there is no |
|
168 | 168 | # async integration |
|
169 | 169 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) |
|
170 | 170 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: |
|
174 | 174 | """ |
|
175 | 175 | Parse a cell with top-level await and modify the AST to be able to run it later. |
|
176 | 176 | |
|
177 | 177 | Parameters |
|
178 | 178 | ---------- |
|
179 | 179 | cell: str |
|
180 | 180 | The code cell to asyncronify |
|
181 | 181 | wrapper_name: str |
|
182 | 182 | The name of the function to be used to wrap the passed `cell`. It is |
|
183 | 183 | advised to **not** use a python identifier in order to not pollute the |
|
184 | 184 | global namespace in which the function will be ran. |
|
185 | 185 | |
|
186 | 186 | Returns |
|
187 | 187 | ------- |
|
188 | 188 | ModuleType: |
|
189 | 189 | A module object AST containing **one** function named `wrapper_name`. |
|
190 | 190 | |
|
191 | 191 | The given code is wrapped in a async-def function, parsed into an AST, and |
|
192 | 192 | the resulting function definition AST is modified to return the last |
|
193 | 193 | expression. |
|
194 | 194 | |
|
195 | 195 | The last expression or await node is moved into a return statement at the |
|
196 | 196 | end of the function, and removed from its original location. If the last |
|
197 | 197 | node is not Expr or Await nothing is done. |
|
198 | 198 | |
|
199 | 199 | The function `__code__` will need to be later modified (by |
|
200 | 200 | ``removed_co_newlocals``) in a subsequent step to not create new `locals()` |
|
201 | 201 | meaning that the local and global scope are the same, ie as if the body of |
|
202 | 202 | the function was at module level. |
|
203 | 203 | |
|
204 | 204 | Lastly a call to `locals()` is made just before the last expression of the |
|
205 | 205 | function, or just after the last assignment or statement to make sure the |
|
206 | 206 | global dict is updated as python function work with a local fast cache which |
|
207 | 207 | is updated only on `local()` calls. |
|
208 | 208 | """ |
|
209 | 209 | |
|
210 | 210 | from ast import Expr, Await, Return |
|
211 | 211 | if sys.version_info >= (3,8): |
|
212 | 212 | return ast.parse(cell) |
|
213 | 213 | tree = ast.parse(_asyncify(cell)) |
|
214 | 214 | |
|
215 | 215 | function_def = tree.body[0] |
|
216 | 216 | function_def.name = wrapper_name |
|
217 | 217 | try_block = function_def.body[0] |
|
218 | 218 | lastexpr = try_block.body[-1] |
|
219 | 219 | if isinstance(lastexpr, (Expr, Await)): |
|
220 | 220 | try_block.body[-1] = Return(lastexpr.value) |
|
221 | 221 | ast.fix_missing_locations(tree) |
|
222 | 222 | return tree |
|
223 | 223 | #----------------------------------------------------------------------------- |
|
224 | 224 | # Globals |
|
225 | 225 | #----------------------------------------------------------------------------- |
|
226 | 226 | |
|
227 | 227 | # compiled regexps for autoindent management |
|
228 | 228 | dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass') |
|
229 | 229 | |
|
230 | 230 | #----------------------------------------------------------------------------- |
|
231 | 231 | # Utilities |
|
232 | 232 | #----------------------------------------------------------------------------- |
|
233 | 233 | |
|
234 | 234 | @undoc |
|
235 | 235 | def softspace(file, newvalue): |
|
236 | 236 | """Copied from code.py, to remove the dependency""" |
|
237 | 237 | |
|
238 | 238 | oldvalue = 0 |
|
239 | 239 | try: |
|
240 | 240 | oldvalue = file.softspace |
|
241 | 241 | except AttributeError: |
|
242 | 242 | pass |
|
243 | 243 | try: |
|
244 | 244 | file.softspace = newvalue |
|
245 | 245 | except (AttributeError, TypeError): |
|
246 | 246 | # "attribute-less object" or "read-only attributes" |
|
247 | 247 | pass |
|
248 | 248 | return oldvalue |
|
249 | 249 | |
|
250 | 250 | @undoc |
|
251 | 251 | def no_op(*a, **kw): |
|
252 | 252 | pass |
|
253 | 253 | |
|
254 | 254 | |
|
255 | 255 | class SpaceInInput(Exception): pass |
|
256 | 256 | |
|
257 | 257 | |
|
258 | 258 | def get_default_colors(): |
|
259 | 259 | "DEPRECATED" |
|
260 | 260 | warn('get_default_color is deprecated since IPython 5.0, and returns `Neutral` on all platforms.', |
|
261 | 261 | DeprecationWarning, stacklevel=2) |
|
262 | 262 | return 'Neutral' |
|
263 | 263 | |
|
264 | 264 | |
|
265 | 265 | class SeparateUnicode(Unicode): |
|
266 | 266 | r"""A Unicode subclass to validate separate_in, separate_out, etc. |
|
267 | 267 | |
|
268 | 268 | This is a Unicode based trait that converts '0'->'' and ``'\\n'->'\n'``. |
|
269 | 269 | """ |
|
270 | 270 | |
|
271 | 271 | def validate(self, obj, value): |
|
272 | 272 | if value == '0': value = '' |
|
273 | 273 | value = value.replace('\\n','\n') |
|
274 | 274 | return super(SeparateUnicode, self).validate(obj, value) |
|
275 | 275 | |
|
276 | 276 | |
|
277 | 277 | @undoc |
|
278 | 278 | class DummyMod(object): |
|
279 | 279 | """A dummy module used for IPython's interactive module when |
|
280 | 280 | a namespace must be assigned to the module's __dict__.""" |
|
281 | 281 | __spec__ = None |
|
282 | 282 | |
|
283 | 283 | |
|
284 | 284 | class ExecutionInfo(object): |
|
285 | 285 | """The arguments used for a call to :meth:`InteractiveShell.run_cell` |
|
286 | 286 | |
|
287 | 287 | Stores information about what is going to happen. |
|
288 | 288 | """ |
|
289 | 289 | raw_cell = None |
|
290 | 290 | store_history = False |
|
291 | 291 | silent = False |
|
292 | 292 | shell_futures = True |
|
293 | 293 | |
|
294 | 294 | def __init__(self, raw_cell, store_history, silent, shell_futures): |
|
295 | 295 | self.raw_cell = raw_cell |
|
296 | 296 | self.store_history = store_history |
|
297 | 297 | self.silent = silent |
|
298 | 298 | self.shell_futures = shell_futures |
|
299 | 299 | |
|
300 | 300 | def __repr__(self): |
|
301 | 301 | name = self.__class__.__qualname__ |
|
302 | 302 | raw_cell = ((self.raw_cell[:50] + '..') |
|
303 | 303 | if len(self.raw_cell) > 50 else self.raw_cell) |
|
304 | 304 | return '<%s object at %x, raw_cell="%s" store_history=%s silent=%s shell_futures=%s>' %\ |
|
305 | 305 | (name, id(self), raw_cell, self.store_history, self.silent, self.shell_futures) |
|
306 | 306 | |
|
307 | 307 | |
|
308 | 308 | class ExecutionResult(object): |
|
309 | 309 | """The result of a call to :meth:`InteractiveShell.run_cell` |
|
310 | 310 | |
|
311 | 311 | Stores information about what took place. |
|
312 | 312 | """ |
|
313 | 313 | execution_count = None |
|
314 | 314 | error_before_exec = None |
|
315 | 315 | error_in_exec = None |
|
316 | 316 | info = None |
|
317 | 317 | result = None |
|
318 | 318 | |
|
319 | 319 | def __init__(self, info): |
|
320 | 320 | self.info = info |
|
321 | 321 | |
|
322 | 322 | @property |
|
323 | 323 | def success(self): |
|
324 | 324 | return (self.error_before_exec is None) and (self.error_in_exec is None) |
|
325 | 325 | |
|
326 | 326 | def raise_error(self): |
|
327 | 327 | """Reraises error if `success` is `False`, otherwise does nothing""" |
|
328 | 328 | if self.error_before_exec is not None: |
|
329 | 329 | raise self.error_before_exec |
|
330 | 330 | if self.error_in_exec is not None: |
|
331 | 331 | raise self.error_in_exec |
|
332 | 332 | |
|
333 | 333 | def __repr__(self): |
|
334 | 334 | name = self.__class__.__qualname__ |
|
335 | 335 | return '<%s object at %x, execution_count=%s error_before_exec=%s error_in_exec=%s info=%s result=%s>' %\ |
|
336 | 336 | (name, id(self), self.execution_count, self.error_before_exec, self.error_in_exec, repr(self.info), repr(self.result)) |
|
337 | 337 | |
|
338 | 338 | |
|
339 | 339 | class InteractiveShell(SingletonConfigurable): |
|
340 | 340 | """An enhanced, interactive shell for Python.""" |
|
341 | 341 | |
|
342 | 342 | _instance = None |
|
343 | 343 | |
|
344 | 344 | ast_transformers = List([], help= |
|
345 | 345 | """ |
|
346 | 346 | A list of ast.NodeTransformer subclass instances, which will be applied |
|
347 | 347 | to user input before code is run. |
|
348 | 348 | """ |
|
349 | 349 | ).tag(config=True) |
|
350 | 350 | |
|
351 | 351 | autocall = Enum((0,1,2), default_value=0, help= |
|
352 | 352 | """ |
|
353 | 353 | Make IPython automatically call any callable object even if you didn't |
|
354 | 354 | type explicit parentheses. For example, 'str 43' becomes 'str(43)' |
|
355 | 355 | automatically. The value can be '0' to disable the feature, '1' for |
|
356 | 356 | 'smart' autocall, where it is not applied if there are no more |
|
357 | 357 | arguments on the line, and '2' for 'full' autocall, where all callable |
|
358 | 358 | objects are automatically called (even if no arguments are present). |
|
359 | 359 | """ |
|
360 | 360 | ).tag(config=True) |
|
361 | 361 | |
|
362 | 362 | autoindent = Bool(True, help= |
|
363 | 363 | """ |
|
364 | 364 | Autoindent IPython code entered interactively. |
|
365 | 365 | """ |
|
366 | 366 | ).tag(config=True) |
|
367 | 367 | |
|
368 | 368 | autoawait = Bool(True, help= |
|
369 | 369 | """ |
|
370 | 370 | Automatically run await statement in the top level repl. |
|
371 | 371 | """ |
|
372 | 372 | ).tag(config=True) |
|
373 | 373 | |
|
374 | 374 | loop_runner_map ={ |
|
375 | 375 | 'asyncio':(_asyncio_runner, True), |
|
376 | 376 | 'curio':(_curio_runner, True), |
|
377 | 377 | 'trio':(_trio_runner, True), |
|
378 | 378 | 'sync': (_pseudo_sync_runner, False) |
|
379 | 379 | } |
|
380 | 380 | |
|
381 | 381 | loop_runner = Any(default_value="IPython.core.interactiveshell._asyncio_runner", |
|
382 | 382 | allow_none=True, |
|
383 | 383 | help="""Select the loop runner that will be used to execute top-level asynchronous code""" |
|
384 | 384 | ).tag(config=True) |
|
385 | 385 | |
|
386 | 386 | @default('loop_runner') |
|
387 | 387 | def _default_loop_runner(self): |
|
388 | 388 | return import_item("IPython.core.interactiveshell._asyncio_runner") |
|
389 | 389 | |
|
390 | 390 | @validate('loop_runner') |
|
391 | 391 | def _import_runner(self, proposal): |
|
392 | 392 | if isinstance(proposal.value, str): |
|
393 | 393 | if proposal.value in self.loop_runner_map: |
|
394 | 394 | runner, autoawait = self.loop_runner_map[proposal.value] |
|
395 | 395 | self.autoawait = autoawait |
|
396 | 396 | return runner |
|
397 | 397 | runner = import_item(proposal.value) |
|
398 | 398 | if not callable(runner): |
|
399 | 399 | raise ValueError('loop_runner must be callable') |
|
400 | 400 | return runner |
|
401 | 401 | if not callable(proposal.value): |
|
402 | 402 | raise ValueError('loop_runner must be callable') |
|
403 | 403 | return proposal.value |
|
404 | 404 | |
|
405 | 405 | automagic = Bool(True, help= |
|
406 | 406 | """ |
|
407 | 407 | Enable magic commands to be called without the leading %. |
|
408 | 408 | """ |
|
409 | 409 | ).tag(config=True) |
|
410 | 410 | |
|
411 | 411 | banner1 = Unicode(default_banner, |
|
412 | 412 | help="""The part of the banner to be printed before the profile""" |
|
413 | 413 | ).tag(config=True) |
|
414 | 414 | banner2 = Unicode('', |
|
415 | 415 | help="""The part of the banner to be printed after the profile""" |
|
416 | 416 | ).tag(config=True) |
|
417 | 417 | |
|
418 | 418 | cache_size = Integer(1000, help= |
|
419 | 419 | """ |
|
420 | 420 | Set the size of the output cache. The default is 1000, you can |
|
421 | 421 | change it permanently in your config file. Setting it to 0 completely |
|
422 | 422 | disables the caching system, and the minimum value accepted is 3 (if |
|
423 | 423 | you provide a value less than 3, it is reset to 0 and a warning is |
|
424 | 424 | issued). This limit is defined because otherwise you'll spend more |
|
425 | 425 | time re-flushing a too small cache than working |
|
426 | 426 | """ |
|
427 | 427 | ).tag(config=True) |
|
428 | 428 | color_info = Bool(True, help= |
|
429 | 429 | """ |
|
430 | 430 | Use colors for displaying information about objects. Because this |
|
431 | 431 | information is passed through a pager (like 'less'), and some pagers |
|
432 | 432 | get confused with color codes, this capability can be turned off. |
|
433 | 433 | """ |
|
434 | 434 | ).tag(config=True) |
|
435 | 435 | colors = CaselessStrEnum(('Neutral', 'NoColor','LightBG','Linux'), |
|
436 | 436 | default_value='Neutral', |
|
437 | 437 | help="Set the color scheme (NoColor, Neutral, Linux, or LightBG)." |
|
438 | 438 | ).tag(config=True) |
|
439 | 439 | debug = Bool(False).tag(config=True) |
|
440 | 440 | disable_failing_post_execute = Bool(False, |
|
441 | 441 | help="Don't call post-execute functions that have failed in the past." |
|
442 | 442 | ).tag(config=True) |
|
443 | 443 | display_formatter = Instance(DisplayFormatter, allow_none=True) |
|
444 | 444 | displayhook_class = Type(DisplayHook) |
|
445 | 445 | display_pub_class = Type(DisplayPublisher) |
|
446 | 446 | compiler_class = Type(CachingCompiler) |
|
447 | 447 | |
|
448 | 448 | sphinxify_docstring = Bool(False, help= |
|
449 | 449 | """ |
|
450 | 450 | Enables rich html representation of docstrings. (This requires the |
|
451 | 451 | docrepr module). |
|
452 | 452 | """).tag(config=True) |
|
453 | 453 | |
|
454 | 454 | @observe("sphinxify_docstring") |
|
455 | 455 | def _sphinxify_docstring_changed(self, change): |
|
456 | 456 | if change['new']: |
|
457 | 457 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
458 | 458 | |
|
459 | 459 | enable_html_pager = Bool(False, help= |
|
460 | 460 | """ |
|
461 | 461 | (Provisional API) enables html representation in mime bundles sent |
|
462 | 462 | to pagers. |
|
463 | 463 | """).tag(config=True) |
|
464 | 464 | |
|
465 | 465 | @observe("enable_html_pager") |
|
466 | 466 | def _enable_html_pager_changed(self, change): |
|
467 | 467 | if change['new']: |
|
468 | 468 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
469 | 469 | |
|
470 | 470 | data_pub_class = None |
|
471 | 471 | |
|
472 | 472 | exit_now = Bool(False) |
|
473 | 473 | exiter = Instance(ExitAutocall) |
|
474 | 474 | @default('exiter') |
|
475 | 475 | def _exiter_default(self): |
|
476 | 476 | return ExitAutocall(self) |
|
477 | 477 | # Monotonically increasing execution counter |
|
478 | 478 | execution_count = Integer(1) |
|
479 | 479 | filename = Unicode("<ipython console>") |
|
480 | 480 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
481 | 481 | |
|
482 | 482 | # Used to transform cells before running them, and check whether code is complete |
|
483 | 483 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', |
|
484 | 484 | ()) |
|
485 | 485 | |
|
486 | 486 | @property |
|
487 | 487 | def input_transformers_cleanup(self): |
|
488 | 488 | return self.input_transformer_manager.cleanup_transforms |
|
489 | 489 | |
|
490 | 490 | input_transformers_post = List([], |
|
491 | 491 | help="A list of string input transformers, to be applied after IPython's " |
|
492 | 492 | "own input transformations." |
|
493 | 493 | ) |
|
494 | 494 | |
|
495 | 495 | @property |
|
496 | 496 | def input_splitter(self): |
|
497 | 497 | """Make this available for backward compatibility (pre-7.0 release) with existing code. |
|
498 | 498 | |
|
499 | 499 | For example, ipykernel ipykernel currently uses |
|
500 | 500 | `shell.input_splitter.check_complete` |
|
501 | 501 | """ |
|
502 | 502 | from warnings import warn |
|
503 | 503 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", |
|
504 | 504 | DeprecationWarning, stacklevel=2 |
|
505 | 505 | ) |
|
506 | 506 | return self.input_transformer_manager |
|
507 | 507 | |
|
508 | 508 | logstart = Bool(False, help= |
|
509 | 509 | """ |
|
510 | 510 | Start logging to the default log file in overwrite mode. |
|
511 | 511 | Use `logappend` to specify a log file to **append** logs to. |
|
512 | 512 | """ |
|
513 | 513 | ).tag(config=True) |
|
514 | 514 | logfile = Unicode('', help= |
|
515 | 515 | """ |
|
516 | 516 | The name of the logfile to use. |
|
517 | 517 | """ |
|
518 | 518 | ).tag(config=True) |
|
519 | 519 | logappend = Unicode('', help= |
|
520 | 520 | """ |
|
521 | 521 | Start logging to the given file in append mode. |
|
522 | 522 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
523 | 523 | """ |
|
524 | 524 | ).tag(config=True) |
|
525 | 525 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
526 | 526 | ).tag(config=True) |
|
527 | 527 | pdb = Bool(False, help= |
|
528 | 528 | """ |
|
529 | 529 | Automatically call the pdb debugger after every exception. |
|
530 | 530 | """ |
|
531 | 531 | ).tag(config=True) |
|
532 | 532 | display_page = Bool(False, |
|
533 | 533 | help="""If True, anything that would be passed to the pager |
|
534 | 534 | will be displayed as regular output instead.""" |
|
535 | 535 | ).tag(config=True) |
|
536 | 536 | |
|
537 | 537 | # deprecated prompt traits: |
|
538 | 538 | |
|
539 | 539 | prompt_in1 = Unicode('In [\\#]: ', |
|
540 | 540 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
541 | 541 | ).tag(config=True) |
|
542 | 542 | prompt_in2 = Unicode(' .\\D.: ', |
|
543 | 543 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
544 | 544 | ).tag(config=True) |
|
545 | 545 | prompt_out = Unicode('Out[\\#]: ', |
|
546 | 546 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
547 | 547 | ).tag(config=True) |
|
548 | 548 | prompts_pad_left = Bool(True, |
|
549 | 549 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
550 | 550 | ).tag(config=True) |
|
551 | 551 | |
|
552 | 552 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
553 | 553 | def _prompt_trait_changed(self, change): |
|
554 | 554 | name = change['name'] |
|
555 | 555 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
556 | 556 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
557 | 557 | " object directly.".format(name=name)) |
|
558 | 558 | |
|
559 | 559 | # protect against weird cases where self.config may not exist: |
|
560 | 560 | |
|
561 | 561 | show_rewritten_input = Bool(True, |
|
562 | 562 | help="Show rewritten input, e.g. for autocall." |
|
563 | 563 | ).tag(config=True) |
|
564 | 564 | |
|
565 | 565 | quiet = Bool(False).tag(config=True) |
|
566 | 566 | |
|
567 | 567 | history_length = Integer(10000, |
|
568 | 568 | help='Total length of command history' |
|
569 | 569 | ).tag(config=True) |
|
570 | 570 | |
|
571 | 571 | history_load_length = Integer(1000, help= |
|
572 | 572 | """ |
|
573 | 573 | The number of saved history entries to be loaded |
|
574 | 574 | into the history buffer at startup. |
|
575 | 575 | """ |
|
576 | 576 | ).tag(config=True) |
|
577 | 577 | |
|
578 | 578 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
579 | 579 | default_value='last_expr', |
|
580 | 580 | help=""" |
|
581 | 581 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
582 | 582 | which nodes should be run interactively (displaying output from expressions). |
|
583 | 583 | """ |
|
584 | 584 | ).tag(config=True) |
|
585 | 585 | |
|
586 | 586 | # TODO: this part of prompt management should be moved to the frontends. |
|
587 | 587 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
588 | 588 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
589 | 589 | separate_out = SeparateUnicode('').tag(config=True) |
|
590 | 590 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
591 | 591 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
592 | 592 | xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'), |
|
593 | 593 | default_value='Context', |
|
594 | 594 | help="Switch modes for the IPython exception handlers." |
|
595 | 595 | ).tag(config=True) |
|
596 | 596 | |
|
597 | 597 | # Subcomponents of InteractiveShell |
|
598 | 598 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
599 | 599 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
600 | 600 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
601 | 601 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
602 | 602 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
603 | 603 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
604 | 604 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
605 | 605 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
606 | 606 | |
|
607 | 607 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
608 | 608 | @property |
|
609 | 609 | def profile(self): |
|
610 | 610 | if self.profile_dir is not None: |
|
611 | 611 | name = os.path.basename(self.profile_dir.location) |
|
612 | 612 | return name.replace('profile_','') |
|
613 | 613 | |
|
614 | 614 | |
|
615 | 615 | # Private interface |
|
616 | 616 | _post_execute = Dict() |
|
617 | 617 | |
|
618 | 618 | # Tracks any GUI loop loaded for pylab |
|
619 | 619 | pylab_gui_select = None |
|
620 | 620 | |
|
621 | 621 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
622 | 622 | |
|
623 | 623 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
624 | 624 | |
|
625 | 625 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
626 | 626 | user_module=None, user_ns=None, |
|
627 | 627 | custom_exceptions=((), None), **kwargs): |
|
628 | 628 | |
|
629 | 629 | # This is where traits with a config_key argument are updated |
|
630 | 630 | # from the values on config. |
|
631 | 631 | super(InteractiveShell, self).__init__(**kwargs) |
|
632 | 632 | if 'PromptManager' in self.config: |
|
633 | 633 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
634 | 634 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
635 | 635 | self.configurables = [self] |
|
636 | 636 | |
|
637 | 637 | # These are relatively independent and stateless |
|
638 | 638 | self.init_ipython_dir(ipython_dir) |
|
639 | 639 | self.init_profile_dir(profile_dir) |
|
640 | 640 | self.init_instance_attrs() |
|
641 | 641 | self.init_environment() |
|
642 | 642 | |
|
643 | 643 | # Check if we're in a virtualenv, and set up sys.path. |
|
644 | 644 | self.init_virtualenv() |
|
645 | 645 | |
|
646 | 646 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
647 | 647 | self.init_create_namespaces(user_module, user_ns) |
|
648 | 648 | # This has to be done after init_create_namespaces because it uses |
|
649 | 649 | # something in self.user_ns, but before init_sys_modules, which |
|
650 | 650 | # is the first thing to modify sys. |
|
651 | 651 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
652 | 652 | # is created, we are saving the overridden ones here. Not sure if this |
|
653 | 653 | # is what we want to do. |
|
654 | 654 | self.save_sys_module_state() |
|
655 | 655 | self.init_sys_modules() |
|
656 | 656 | |
|
657 | 657 | # While we're trying to have each part of the code directly access what |
|
658 | 658 | # it needs without keeping redundant references to objects, we have too |
|
659 | 659 | # much legacy code that expects ip.db to exist. |
|
660 | 660 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
661 | 661 | |
|
662 | 662 | self.init_history() |
|
663 | 663 | self.init_encoding() |
|
664 | 664 | self.init_prefilter() |
|
665 | 665 | |
|
666 | 666 | self.init_syntax_highlighting() |
|
667 | 667 | self.init_hooks() |
|
668 | 668 | self.init_events() |
|
669 | 669 | self.init_pushd_popd_magic() |
|
670 | 670 | self.init_user_ns() |
|
671 | 671 | self.init_logger() |
|
672 | 672 | self.init_builtins() |
|
673 | 673 | |
|
674 | 674 | # The following was in post_config_initialization |
|
675 | 675 | self.init_inspector() |
|
676 | 676 | self.raw_input_original = input |
|
677 | 677 | self.init_completer() |
|
678 | 678 | # TODO: init_io() needs to happen before init_traceback handlers |
|
679 | 679 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
680 | 680 | # This logic in in debugger.Pdb and should eventually be changed. |
|
681 | 681 | self.init_io() |
|
682 | 682 | self.init_traceback_handlers(custom_exceptions) |
|
683 | 683 | self.init_prompts() |
|
684 | 684 | self.init_display_formatter() |
|
685 | 685 | self.init_display_pub() |
|
686 | 686 | self.init_data_pub() |
|
687 | 687 | self.init_displayhook() |
|
688 | 688 | self.init_magics() |
|
689 | 689 | self.init_alias() |
|
690 | 690 | self.init_logstart() |
|
691 | 691 | self.init_pdb() |
|
692 | 692 | self.init_extension_manager() |
|
693 | 693 | self.init_payload() |
|
694 | 694 | self.init_deprecation_warnings() |
|
695 | 695 | self.hooks.late_startup_hook() |
|
696 | 696 | self.events.trigger('shell_initialized', self) |
|
697 | 697 | atexit.register(self.atexit_operations) |
|
698 | 698 | |
|
699 | 699 | # The trio runner is used for running Trio in the foreground thread. It |
|
700 | 700 | # is different from `_trio_runner(async_fn)` in `async_helpers.py` |
|
701 | 701 | # which calls `trio.run()` for every cell. This runner runs all cells |
|
702 | 702 | # inside a single Trio event loop. If used, it is set from |
|
703 | 703 | # `ipykernel.kernelapp`. |
|
704 | 704 | self.trio_runner = None |
|
705 | 705 | |
|
706 | 706 | def get_ipython(self): |
|
707 | 707 | """Return the currently running IPython instance.""" |
|
708 | 708 | return self |
|
709 | 709 | |
|
710 | 710 | #------------------------------------------------------------------------- |
|
711 | 711 | # Trait changed handlers |
|
712 | 712 | #------------------------------------------------------------------------- |
|
713 | 713 | @observe('ipython_dir') |
|
714 | 714 | def _ipython_dir_changed(self, change): |
|
715 | 715 | ensure_dir_exists(change['new']) |
|
716 | 716 | |
|
717 | 717 | def set_autoindent(self,value=None): |
|
718 | 718 | """Set the autoindent flag. |
|
719 | 719 | |
|
720 | 720 | If called with no arguments, it acts as a toggle.""" |
|
721 | 721 | if value is None: |
|
722 | 722 | self.autoindent = not self.autoindent |
|
723 | 723 | else: |
|
724 | 724 | self.autoindent = value |
|
725 | 725 | |
|
726 | 726 | def set_trio_runner(self, tr): |
|
727 | 727 | self.trio_runner = tr |
|
728 | 728 | |
|
729 | 729 | #------------------------------------------------------------------------- |
|
730 | 730 | # init_* methods called by __init__ |
|
731 | 731 | #------------------------------------------------------------------------- |
|
732 | 732 | |
|
733 | 733 | def init_ipython_dir(self, ipython_dir): |
|
734 | 734 | if ipython_dir is not None: |
|
735 | 735 | self.ipython_dir = ipython_dir |
|
736 | 736 | return |
|
737 | 737 | |
|
738 | 738 | self.ipython_dir = get_ipython_dir() |
|
739 | 739 | |
|
740 | 740 | def init_profile_dir(self, profile_dir): |
|
741 | 741 | if profile_dir is not None: |
|
742 | 742 | self.profile_dir = profile_dir |
|
743 | 743 | return |
|
744 | 744 | self.profile_dir = ProfileDir.create_profile_dir_by_name( |
|
745 | 745 | self.ipython_dir, "default" |
|
746 | 746 | ) |
|
747 | 747 | |
|
748 | 748 | def init_instance_attrs(self): |
|
749 | 749 | self.more = False |
|
750 | 750 | |
|
751 | 751 | # command compiler |
|
752 | 752 | self.compile = self.compiler_class() |
|
753 | 753 | |
|
754 | 754 | # Make an empty namespace, which extension writers can rely on both |
|
755 | 755 | # existing and NEVER being used by ipython itself. This gives them a |
|
756 | 756 | # convenient location for storing additional information and state |
|
757 | 757 | # their extensions may require, without fear of collisions with other |
|
758 | 758 | # ipython names that may develop later. |
|
759 | 759 | self.meta = Struct() |
|
760 | 760 | |
|
761 | 761 | # Temporary files used for various purposes. Deleted at exit. |
|
762 | 762 | # The files here are stored with Path from Pathlib |
|
763 | 763 | self.tempfiles = [] |
|
764 | 764 | self.tempdirs = [] |
|
765 | 765 | |
|
766 | 766 | # keep track of where we started running (mainly for crash post-mortem) |
|
767 | 767 | # This is not being used anywhere currently. |
|
768 | 768 | self.starting_dir = os.getcwd() |
|
769 | 769 | |
|
770 | 770 | # Indentation management |
|
771 | 771 | self.indent_current_nsp = 0 |
|
772 | 772 | |
|
773 | 773 | # Dict to track post-execution functions that have been registered |
|
774 | 774 | self._post_execute = {} |
|
775 | 775 | |
|
776 | 776 | def init_environment(self): |
|
777 | 777 | """Any changes we need to make to the user's environment.""" |
|
778 | 778 | pass |
|
779 | 779 | |
|
780 | 780 | def init_encoding(self): |
|
781 | 781 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
782 | 782 | # under Win32 have it set to None, and we need to have a known valid |
|
783 | 783 | # encoding to use in the raw_input() method |
|
784 | 784 | try: |
|
785 | 785 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
786 | 786 | except AttributeError: |
|
787 | 787 | self.stdin_encoding = 'ascii' |
|
788 | 788 | |
|
789 | 789 | |
|
790 | 790 | @observe('colors') |
|
791 | 791 | def init_syntax_highlighting(self, changes=None): |
|
792 | 792 | # Python source parser/formatter for syntax highlighting |
|
793 | 793 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
794 | 794 | self.pycolorize = lambda src: pyformat(src,'str') |
|
795 | 795 | |
|
796 | 796 | def refresh_style(self): |
|
797 | 797 | # No-op here, used in subclass |
|
798 | 798 | pass |
|
799 | 799 | |
|
800 | 800 | def init_pushd_popd_magic(self): |
|
801 | 801 | # for pushd/popd management |
|
802 | 802 | self.home_dir = get_home_dir() |
|
803 | 803 | |
|
804 | 804 | self.dir_stack = [] |
|
805 | 805 | |
|
806 | 806 | def init_logger(self): |
|
807 | 807 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
808 | 808 | logmode='rotate') |
|
809 | 809 | |
|
810 | 810 | def init_logstart(self): |
|
811 | 811 | """Initialize logging in case it was requested at the command line. |
|
812 | 812 | """ |
|
813 | 813 | if self.logappend: |
|
814 | 814 | self.magic('logstart %s append' % self.logappend) |
|
815 | 815 | elif self.logfile: |
|
816 | 816 | self.magic('logstart %s' % self.logfile) |
|
817 | 817 | elif self.logstart: |
|
818 | 818 | self.magic('logstart') |
|
819 | 819 | |
|
820 | 820 | def init_deprecation_warnings(self): |
|
821 | 821 | """ |
|
822 | 822 | register default filter for deprecation warning. |
|
823 | 823 | |
|
824 | 824 | This will allow deprecation warning of function used interactively to show |
|
825 | 825 | warning to users, and still hide deprecation warning from libraries import. |
|
826 | 826 | """ |
|
827 | 827 | if sys.version_info < (3,7): |
|
828 | 828 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
829 | 829 | |
|
830 | 830 | |
|
831 | 831 | def init_builtins(self): |
|
832 | 832 | # A single, static flag that we set to True. Its presence indicates |
|
833 | 833 | # that an IPython shell has been created, and we make no attempts at |
|
834 | 834 | # removing on exit or representing the existence of more than one |
|
835 | 835 | # IPython at a time. |
|
836 | 836 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
837 | 837 | builtin_mod.__dict__['display'] = display |
|
838 | 838 | |
|
839 | 839 | self.builtin_trap = BuiltinTrap(shell=self) |
|
840 | 840 | |
|
841 | 841 | @observe('colors') |
|
842 | 842 | def init_inspector(self, changes=None): |
|
843 | 843 | # Object inspector |
|
844 | 844 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
845 | 845 | PyColorize.ANSICodeColors, |
|
846 | 846 | self.colors, |
|
847 | 847 | self.object_info_string_level) |
|
848 | 848 | |
|
849 | 849 | def init_io(self): |
|
850 | 850 | # This will just use sys.stdout and sys.stderr. If you want to |
|
851 | 851 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
852 | 852 | # *before* instantiating this class, because io holds onto |
|
853 | 853 | # references to the underlying streams. |
|
854 | 854 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
855 | 855 | # during initialization of the deprecated API. |
|
856 | 856 | with warnings.catch_warnings(): |
|
857 | 857 | warnings.simplefilter('ignore', DeprecationWarning) |
|
858 | 858 | io.stdout = io.IOStream(sys.stdout) |
|
859 | 859 | io.stderr = io.IOStream(sys.stderr) |
|
860 | 860 | |
|
861 | 861 | def init_prompts(self): |
|
862 | 862 | # Set system prompts, so that scripts can decide if they are running |
|
863 | 863 | # interactively. |
|
864 | 864 | sys.ps1 = 'In : ' |
|
865 | 865 | sys.ps2 = '...: ' |
|
866 | 866 | sys.ps3 = 'Out: ' |
|
867 | 867 | |
|
868 | 868 | def init_display_formatter(self): |
|
869 | 869 | self.display_formatter = DisplayFormatter(parent=self) |
|
870 | 870 | self.configurables.append(self.display_formatter) |
|
871 | 871 | |
|
872 | 872 | def init_display_pub(self): |
|
873 | 873 | self.display_pub = self.display_pub_class(parent=self, shell=self) |
|
874 | 874 | self.configurables.append(self.display_pub) |
|
875 | 875 | |
|
876 | 876 | def init_data_pub(self): |
|
877 | 877 | if not self.data_pub_class: |
|
878 | 878 | self.data_pub = None |
|
879 | 879 | return |
|
880 | 880 | self.data_pub = self.data_pub_class(parent=self) |
|
881 | 881 | self.configurables.append(self.data_pub) |
|
882 | 882 | |
|
883 | 883 | def init_displayhook(self): |
|
884 | 884 | # Initialize displayhook, set in/out prompts and printing system |
|
885 | 885 | self.displayhook = self.displayhook_class( |
|
886 | 886 | parent=self, |
|
887 | 887 | shell=self, |
|
888 | 888 | cache_size=self.cache_size, |
|
889 | 889 | ) |
|
890 | 890 | self.configurables.append(self.displayhook) |
|
891 | 891 | # This is a context manager that installs/revmoes the displayhook at |
|
892 | 892 | # the appropriate time. |
|
893 | 893 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
894 | 894 | |
|
895 | 895 | def init_virtualenv(self): |
|
896 | 896 | """Add the current virtualenv to sys.path so the user can import modules from it. |
|
897 | 897 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
898 | 898 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
899 | 899 | warning will appear suggesting the user installs IPython in the |
|
900 | 900 | virtualenv, but for many cases, it probably works well enough. |
|
901 | 901 | |
|
902 | 902 | Adapted from code snippets online. |
|
903 | 903 | |
|
904 | 904 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
905 | 905 | """ |
|
906 | 906 | if 'VIRTUAL_ENV' not in os.environ: |
|
907 | 907 | # Not in a virtualenv |
|
908 | 908 | return |
|
909 | 909 | elif os.environ["VIRTUAL_ENV"] == "": |
|
910 | 910 | warn("Virtual env path set to '', please check if this is intended.") |
|
911 | 911 | return |
|
912 | 912 | |
|
913 | 913 | p = Path(sys.executable) |
|
914 | 914 | p_venv = Path(os.environ["VIRTUAL_ENV"]) |
|
915 | 915 | |
|
916 | 916 | # fallback venv detection: |
|
917 | 917 | # stdlib venv may symlink sys.executable, so we can't use realpath. |
|
918 | 918 | # but others can symlink *to* the venv Python, so we can't just use sys.executable. |
|
919 | 919 | # So we just check every item in the symlink tree (generally <= 3) |
|
920 | 920 | paths = [p] |
|
921 | 921 | while p.is_symlink(): |
|
922 | 922 | p = Path(os.readlink(p)) |
|
923 | 923 | paths.append(p.resolve()) |
|
924 | 924 | |
|
925 | 925 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
926 | 926 | if str(p_venv).startswith("\\cygdrive"): |
|
927 | 927 | p_venv = Path(str(p_venv)[11:]) |
|
928 | 928 | elif len(str(p_venv)) >= 2 and str(p_venv)[1] == ":": |
|
929 | 929 | p_venv = Path(str(p_venv)[2:]) |
|
930 | 930 | |
|
931 | 931 | if any(os.fspath(p_venv) in os.fspath(p) for p in paths): |
|
932 | 932 | # Our exe is inside or has access to the virtualenv, don't need to do anything. |
|
933 | 933 | return |
|
934 | 934 | |
|
935 | 935 | if sys.platform == "win32": |
|
936 | 936 | virtual_env = Path(os.environ["VIRTUAL_ENV"], "Lib", "site-packages") |
|
937 | 937 | else: |
|
938 | 938 | virtual_env_path = Path( |
|
939 | 939 | os.environ["VIRTUAL_ENV"], "lib", "python{}.{}", "site-packages" |
|
940 | 940 | ) |
|
941 | 941 | p_ver = sys.version_info[:2] |
|
942 | 942 | |
|
943 | 943 | # Predict version from py[thon]-x.x in the $VIRTUAL_ENV |
|
944 | 944 | re_m = re.search(r"\bpy(?:thon)?([23])\.(\d+)\b", os.environ["VIRTUAL_ENV"]) |
|
945 | 945 | if re_m: |
|
946 | 946 | predicted_path = Path(str(virtual_env_path).format(*re_m.groups())) |
|
947 | 947 | if predicted_path.exists(): |
|
948 | 948 | p_ver = re_m.groups() |
|
949 | 949 | |
|
950 | 950 | virtual_env = str(virtual_env_path).format(*p_ver) |
|
951 | 951 | |
|
952 | 952 | warn( |
|
953 | 953 | "Attempting to work in a virtualenv. If you encounter problems, " |
|
954 | 954 | "please install IPython inside the virtualenv." |
|
955 | 955 | ) |
|
956 | 956 | import site |
|
957 | 957 | sys.path.insert(0, virtual_env) |
|
958 | 958 | site.addsitedir(virtual_env) |
|
959 | 959 | |
|
960 | 960 | #------------------------------------------------------------------------- |
|
961 | 961 | # Things related to injections into the sys module |
|
962 | 962 | #------------------------------------------------------------------------- |
|
963 | 963 | |
|
964 | 964 | def save_sys_module_state(self): |
|
965 | 965 | """Save the state of hooks in the sys module. |
|
966 | 966 | |
|
967 | 967 | This has to be called after self.user_module is created. |
|
968 | 968 | """ |
|
969 | 969 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
970 | 970 | 'stdout': sys.stdout, |
|
971 | 971 | 'stderr': sys.stderr, |
|
972 | 972 | 'excepthook': sys.excepthook} |
|
973 | 973 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
974 | 974 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
975 | 975 | |
|
976 | 976 | def restore_sys_module_state(self): |
|
977 | 977 | """Restore the state of the sys module.""" |
|
978 | 978 | try: |
|
979 | 979 | for k, v in self._orig_sys_module_state.items(): |
|
980 | 980 | setattr(sys, k, v) |
|
981 | 981 | except AttributeError: |
|
982 | 982 | pass |
|
983 | 983 | # Reset what what done in self.init_sys_modules |
|
984 | 984 | if self._orig_sys_modules_main_mod is not None: |
|
985 | 985 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
986 | 986 | |
|
987 | 987 | #------------------------------------------------------------------------- |
|
988 | 988 | # Things related to the banner |
|
989 | 989 | #------------------------------------------------------------------------- |
|
990 | 990 | |
|
991 | 991 | @property |
|
992 | 992 | def banner(self): |
|
993 | 993 | banner = self.banner1 |
|
994 | 994 | if self.profile and self.profile != 'default': |
|
995 | 995 | banner += '\nIPython profile: %s\n' % self.profile |
|
996 | 996 | if self.banner2: |
|
997 | 997 | banner += '\n' + self.banner2 |
|
998 | 998 | return banner |
|
999 | 999 | |
|
1000 | 1000 | def show_banner(self, banner=None): |
|
1001 | 1001 | if banner is None: |
|
1002 | 1002 | banner = self.banner |
|
1003 | 1003 | sys.stdout.write(banner) |
|
1004 | 1004 | |
|
1005 | 1005 | #------------------------------------------------------------------------- |
|
1006 | 1006 | # Things related to hooks |
|
1007 | 1007 | #------------------------------------------------------------------------- |
|
1008 | 1008 | |
|
1009 | 1009 | def init_hooks(self): |
|
1010 | 1010 | # hooks holds pointers used for user-side customizations |
|
1011 | 1011 | self.hooks = Struct() |
|
1012 | 1012 | |
|
1013 | 1013 | self.strdispatchers = {} |
|
1014 | 1014 | |
|
1015 | 1015 | # Set all default hooks, defined in the IPython.hooks module. |
|
1016 | 1016 | hooks = IPython.core.hooks |
|
1017 | 1017 | for hook_name in hooks.__all__: |
|
1018 | 1018 | # default hooks have priority 100, i.e. low; user hooks should have |
|
1019 | 1019 | # 0-100 priority |
|
1020 | 1020 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
1021 | 1021 | |
|
1022 | 1022 | if self.display_page: |
|
1023 | 1023 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
1024 | 1024 | |
|
1025 | 1025 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
1026 | 1026 | _warn_deprecated=True): |
|
1027 | 1027 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1028 | 1028 | |
|
1029 | 1029 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1030 | 1030 | adding your function to one of these hooks, you can modify IPython's |
|
1031 | 1031 | behavior to call at runtime your own routines.""" |
|
1032 | 1032 | |
|
1033 | 1033 | # At some point in the future, this should validate the hook before it |
|
1034 | 1034 | # accepts it. Probably at least check that the hook takes the number |
|
1035 | 1035 | # of args it's supposed to. |
|
1036 | 1036 | |
|
1037 | 1037 | f = types.MethodType(hook,self) |
|
1038 | 1038 | |
|
1039 | 1039 | # check if the hook is for strdispatcher first |
|
1040 | 1040 | if str_key is not None: |
|
1041 | 1041 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1042 | 1042 | sdp.add_s(str_key, f, priority ) |
|
1043 | 1043 | self.strdispatchers[name] = sdp |
|
1044 | 1044 | return |
|
1045 | 1045 | if re_key is not None: |
|
1046 | 1046 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1047 | 1047 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1048 | 1048 | self.strdispatchers[name] = sdp |
|
1049 | 1049 | return |
|
1050 | 1050 | |
|
1051 | 1051 | dp = getattr(self.hooks, name, None) |
|
1052 | 1052 | if name not in IPython.core.hooks.__all__: |
|
1053 | 1053 | print("Warning! Hook '%s' is not one of %s" % \ |
|
1054 | 1054 | (name, IPython.core.hooks.__all__ )) |
|
1055 | 1055 | |
|
1056 | 1056 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
1057 | 1057 | alternative = IPython.core.hooks.deprecated[name] |
|
1058 | 1058 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
1059 | 1059 | |
|
1060 | 1060 | if not dp: |
|
1061 | 1061 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1062 | 1062 | |
|
1063 | 1063 | try: |
|
1064 | 1064 | dp.add(f,priority) |
|
1065 | 1065 | except AttributeError: |
|
1066 | 1066 | # it was not commandchain, plain old func - replace |
|
1067 | 1067 | dp = f |
|
1068 | 1068 | |
|
1069 | 1069 | setattr(self.hooks,name, dp) |
|
1070 | 1070 | |
|
1071 | 1071 | #------------------------------------------------------------------------- |
|
1072 | 1072 | # Things related to events |
|
1073 | 1073 | #------------------------------------------------------------------------- |
|
1074 | 1074 | |
|
1075 | 1075 | def init_events(self): |
|
1076 | 1076 | self.events = EventManager(self, available_events) |
|
1077 | 1077 | |
|
1078 | 1078 | self.events.register("pre_execute", self._clear_warning_registry) |
|
1079 | 1079 | |
|
1080 | 1080 | def register_post_execute(self, func): |
|
1081 | 1081 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
1082 | 1082 | |
|
1083 | 1083 | Register a function for calling after code execution. |
|
1084 | 1084 | """ |
|
1085 | 1085 | warn("ip.register_post_execute is deprecated, use " |
|
1086 | 1086 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
1087 | 1087 | self.events.register('post_run_cell', func) |
|
1088 | 1088 | |
|
1089 | 1089 | def _clear_warning_registry(self): |
|
1090 | 1090 | # clear the warning registry, so that different code blocks with |
|
1091 | 1091 | # overlapping line number ranges don't cause spurious suppression of |
|
1092 | 1092 | # warnings (see gh-6611 for details) |
|
1093 | 1093 | if "__warningregistry__" in self.user_global_ns: |
|
1094 | 1094 | del self.user_global_ns["__warningregistry__"] |
|
1095 | 1095 | |
|
1096 | 1096 | #------------------------------------------------------------------------- |
|
1097 | 1097 | # Things related to the "main" module |
|
1098 | 1098 | #------------------------------------------------------------------------- |
|
1099 | 1099 | |
|
1100 | 1100 | def new_main_mod(self, filename, modname): |
|
1101 | 1101 | """Return a new 'main' module object for user code execution. |
|
1102 | 1102 | |
|
1103 | 1103 | ``filename`` should be the path of the script which will be run in the |
|
1104 | 1104 | module. Requests with the same filename will get the same module, with |
|
1105 | 1105 | its namespace cleared. |
|
1106 | 1106 | |
|
1107 | 1107 | ``modname`` should be the module name - normally either '__main__' or |
|
1108 | 1108 | the basename of the file without the extension. |
|
1109 | 1109 | |
|
1110 | 1110 | When scripts are executed via %run, we must keep a reference to their |
|
1111 | 1111 | __main__ module around so that Python doesn't |
|
1112 | 1112 | clear it, rendering references to module globals useless. |
|
1113 | 1113 | |
|
1114 | 1114 | This method keeps said reference in a private dict, keyed by the |
|
1115 | 1115 | absolute path of the script. This way, for multiple executions of the |
|
1116 | 1116 | same script we only keep one copy of the namespace (the last one), |
|
1117 | 1117 | thus preventing memory leaks from old references while allowing the |
|
1118 | 1118 | objects from the last execution to be accessible. |
|
1119 | 1119 | """ |
|
1120 | 1120 | filename = os.path.abspath(filename) |
|
1121 | 1121 | try: |
|
1122 | 1122 | main_mod = self._main_mod_cache[filename] |
|
1123 | 1123 | except KeyError: |
|
1124 | 1124 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
1125 | 1125 | modname, |
|
1126 | 1126 | doc="Module created for script run in IPython") |
|
1127 | 1127 | else: |
|
1128 | 1128 | main_mod.__dict__.clear() |
|
1129 | 1129 | main_mod.__name__ = modname |
|
1130 | 1130 | |
|
1131 | 1131 | main_mod.__file__ = filename |
|
1132 | 1132 | # It seems pydoc (and perhaps others) needs any module instance to |
|
1133 | 1133 | # implement a __nonzero__ method |
|
1134 | 1134 | main_mod.__nonzero__ = lambda : True |
|
1135 | 1135 | |
|
1136 | 1136 | return main_mod |
|
1137 | 1137 | |
|
1138 | 1138 | def clear_main_mod_cache(self): |
|
1139 | 1139 | """Clear the cache of main modules. |
|
1140 | 1140 | |
|
1141 | 1141 | Mainly for use by utilities like %reset. |
|
1142 | 1142 | |
|
1143 | 1143 | Examples |
|
1144 | 1144 | -------- |
|
1145 | 1145 | In [15]: import IPython |
|
1146 | 1146 | |
|
1147 | 1147 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
1148 | 1148 | |
|
1149 | 1149 | In [17]: len(_ip._main_mod_cache) > 0 |
|
1150 | 1150 | Out[17]: True |
|
1151 | 1151 | |
|
1152 | 1152 | In [18]: _ip.clear_main_mod_cache() |
|
1153 | 1153 | |
|
1154 | 1154 | In [19]: len(_ip._main_mod_cache) == 0 |
|
1155 | 1155 | Out[19]: True |
|
1156 | 1156 | """ |
|
1157 | 1157 | self._main_mod_cache.clear() |
|
1158 | 1158 | |
|
1159 | 1159 | #------------------------------------------------------------------------- |
|
1160 | 1160 | # Things related to debugging |
|
1161 | 1161 | #------------------------------------------------------------------------- |
|
1162 | 1162 | |
|
1163 | 1163 | def init_pdb(self): |
|
1164 | 1164 | # Set calling of pdb on exceptions |
|
1165 | 1165 | # self.call_pdb is a property |
|
1166 | 1166 | self.call_pdb = self.pdb |
|
1167 | 1167 | |
|
1168 | 1168 | def _get_call_pdb(self): |
|
1169 | 1169 | return self._call_pdb |
|
1170 | 1170 | |
|
1171 | 1171 | def _set_call_pdb(self,val): |
|
1172 | 1172 | |
|
1173 | 1173 | if val not in (0,1,False,True): |
|
1174 | 1174 | raise ValueError('new call_pdb value must be boolean') |
|
1175 | 1175 | |
|
1176 | 1176 | # store value in instance |
|
1177 | 1177 | self._call_pdb = val |
|
1178 | 1178 | |
|
1179 | 1179 | # notify the actual exception handlers |
|
1180 | 1180 | self.InteractiveTB.call_pdb = val |
|
1181 | 1181 | |
|
1182 | 1182 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1183 | 1183 | 'Control auto-activation of pdb at exceptions') |
|
1184 | 1184 | |
|
1185 | 1185 | def debugger(self,force=False): |
|
1186 | 1186 | """Call the pdb debugger. |
|
1187 | 1187 | |
|
1188 | 1188 | Keywords: |
|
1189 | 1189 | |
|
1190 | 1190 | - force(False): by default, this routine checks the instance call_pdb |
|
1191 | 1191 | flag and does not actually invoke the debugger if the flag is false. |
|
1192 | 1192 | The 'force' option forces the debugger to activate even if the flag |
|
1193 | 1193 | is false. |
|
1194 | 1194 | """ |
|
1195 | 1195 | |
|
1196 | 1196 | if not (force or self.call_pdb): |
|
1197 | 1197 | return |
|
1198 | 1198 | |
|
1199 | 1199 | if not hasattr(sys,'last_traceback'): |
|
1200 | 1200 | error('No traceback has been produced, nothing to debug.') |
|
1201 | 1201 | return |
|
1202 | 1202 | |
|
1203 | 1203 | self.InteractiveTB.debugger(force=True) |
|
1204 | 1204 | |
|
1205 | 1205 | #------------------------------------------------------------------------- |
|
1206 | 1206 | # Things related to IPython's various namespaces |
|
1207 | 1207 | #------------------------------------------------------------------------- |
|
1208 | 1208 | default_user_namespaces = True |
|
1209 | 1209 | |
|
1210 | 1210 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1211 | 1211 | # Create the namespace where the user will operate. user_ns is |
|
1212 | 1212 | # normally the only one used, and it is passed to the exec calls as |
|
1213 | 1213 | # the locals argument. But we do carry a user_global_ns namespace |
|
1214 | 1214 | # given as the exec 'globals' argument, This is useful in embedding |
|
1215 | 1215 | # situations where the ipython shell opens in a context where the |
|
1216 | 1216 | # distinction between locals and globals is meaningful. For |
|
1217 | 1217 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1218 | 1218 | |
|
1219 | 1219 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1220 | 1220 | # level as a dict instead of a module. This is a manual fix, but I |
|
1221 | 1221 | # should really track down where the problem is coming from. Alex |
|
1222 | 1222 | # Schmolck reported this problem first. |
|
1223 | 1223 | |
|
1224 | 1224 | # A useful post by Alex Martelli on this topic: |
|
1225 | 1225 | # Re: inconsistent value from __builtins__ |
|
1226 | 1226 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1227 | 1227 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1228 | 1228 | # Gruppen: comp.lang.python |
|
1229 | 1229 | |
|
1230 | 1230 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1231 | 1231 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1232 | 1232 | # > <type 'dict'> |
|
1233 | 1233 | # > >>> print type(__builtins__) |
|
1234 | 1234 | # > <type 'module'> |
|
1235 | 1235 | # > Is this difference in return value intentional? |
|
1236 | 1236 | |
|
1237 | 1237 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1238 | 1238 | # or a module, and it's been that way for a long time. Whether it's |
|
1239 | 1239 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1240 | 1240 | # that if you need to access the built-in namespace directly, you |
|
1241 | 1241 | # should start with "import __builtin__" (note, no 's') which will |
|
1242 | 1242 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1243 | 1243 | |
|
1244 | 1244 | # These routines return a properly built module and dict as needed by |
|
1245 | 1245 | # the rest of the code, and can also be used by extension writers to |
|
1246 | 1246 | # generate properly initialized namespaces. |
|
1247 | 1247 | if (user_ns is not None) or (user_module is not None): |
|
1248 | 1248 | self.default_user_namespaces = False |
|
1249 | 1249 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1250 | 1250 | |
|
1251 | 1251 | # A record of hidden variables we have added to the user namespace, so |
|
1252 | 1252 | # we can list later only variables defined in actual interactive use. |
|
1253 | 1253 | self.user_ns_hidden = {} |
|
1254 | 1254 | |
|
1255 | 1255 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1256 | 1256 | # problem: after script execution (via %run), the module where the user |
|
1257 | 1257 | # code ran is deleted. Now that this object is a true module (needed |
|
1258 | 1258 | # so doctest and other tools work correctly), the Python module |
|
1259 | 1259 | # teardown mechanism runs over it, and sets to None every variable |
|
1260 | 1260 | # present in that module. Top-level references to objects from the |
|
1261 | 1261 | # script survive, because the user_ns is updated with them. However, |
|
1262 | 1262 | # calling functions defined in the script that use other things from |
|
1263 | 1263 | # the script will fail, because the function's closure had references |
|
1264 | 1264 | # to the original objects, which are now all None. So we must protect |
|
1265 | 1265 | # these modules from deletion by keeping a cache. |
|
1266 | 1266 | # |
|
1267 | 1267 | # To avoid keeping stale modules around (we only need the one from the |
|
1268 | 1268 | # last run), we use a dict keyed with the full path to the script, so |
|
1269 | 1269 | # only the last version of the module is held in the cache. Note, |
|
1270 | 1270 | # however, that we must cache the module *namespace contents* (their |
|
1271 | 1271 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1272 | 1272 | # (uncached) could be destroyed while still holding references (such as |
|
1273 | 1273 | # those held by GUI objects that tend to be long-lived)> |
|
1274 | 1274 | # |
|
1275 | 1275 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1276 | 1276 | # and clear_main_mod_cache() methods for details on use. |
|
1277 | 1277 | |
|
1278 | 1278 | # This is the cache used for 'main' namespaces |
|
1279 | 1279 | self._main_mod_cache = {} |
|
1280 | 1280 | |
|
1281 | 1281 | # A table holding all the namespaces IPython deals with, so that |
|
1282 | 1282 | # introspection facilities can search easily. |
|
1283 | 1283 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1284 | 1284 | 'user_local':self.user_ns, |
|
1285 | 1285 | 'builtin':builtin_mod.__dict__ |
|
1286 | 1286 | } |
|
1287 | 1287 | |
|
1288 | 1288 | @property |
|
1289 | 1289 | def user_global_ns(self): |
|
1290 | 1290 | return self.user_module.__dict__ |
|
1291 | 1291 | |
|
1292 | 1292 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1293 | 1293 | """Prepare the module and namespace in which user code will be run. |
|
1294 | 1294 | |
|
1295 | 1295 | When IPython is started normally, both parameters are None: a new module |
|
1296 | 1296 | is created automatically, and its __dict__ used as the namespace. |
|
1297 | 1297 | |
|
1298 | 1298 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1299 | 1299 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1300 | 1300 | becomes the global namespace. If both are provided (as they may be |
|
1301 | 1301 | when embedding), user_ns is the local namespace, and user_module |
|
1302 | 1302 | provides the global namespace. |
|
1303 | 1303 | |
|
1304 | 1304 | Parameters |
|
1305 | 1305 | ---------- |
|
1306 | 1306 | user_module : module, optional |
|
1307 | 1307 | The current user module in which IPython is being run. If None, |
|
1308 | 1308 | a clean module will be created. |
|
1309 | 1309 | user_ns : dict, optional |
|
1310 | 1310 | A namespace in which to run interactive commands. |
|
1311 | 1311 | |
|
1312 | 1312 | Returns |
|
1313 | 1313 | ------- |
|
1314 | 1314 | A tuple of user_module and user_ns, each properly initialised. |
|
1315 | 1315 | """ |
|
1316 | 1316 | if user_module is None and user_ns is not None: |
|
1317 | 1317 | user_ns.setdefault("__name__", "__main__") |
|
1318 | 1318 | user_module = DummyMod() |
|
1319 | 1319 | user_module.__dict__ = user_ns |
|
1320 | 1320 | |
|
1321 | 1321 | if user_module is None: |
|
1322 | 1322 | user_module = types.ModuleType("__main__", |
|
1323 | 1323 | doc="Automatically created module for IPython interactive environment") |
|
1324 | 1324 | |
|
1325 | 1325 | # We must ensure that __builtin__ (without the final 's') is always |
|
1326 | 1326 | # available and pointing to the __builtin__ *module*. For more details: |
|
1327 | 1327 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1328 | 1328 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1329 | 1329 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1330 | 1330 | |
|
1331 | 1331 | if user_ns is None: |
|
1332 | 1332 | user_ns = user_module.__dict__ |
|
1333 | 1333 | |
|
1334 | 1334 | return user_module, user_ns |
|
1335 | 1335 | |
|
1336 | 1336 | def init_sys_modules(self): |
|
1337 | 1337 | # We need to insert into sys.modules something that looks like a |
|
1338 | 1338 | # module but which accesses the IPython namespace, for shelve and |
|
1339 | 1339 | # pickle to work interactively. Normally they rely on getting |
|
1340 | 1340 | # everything out of __main__, but for embedding purposes each IPython |
|
1341 | 1341 | # instance has its own private namespace, so we can't go shoving |
|
1342 | 1342 | # everything into __main__. |
|
1343 | 1343 | |
|
1344 | 1344 | # note, however, that we should only do this for non-embedded |
|
1345 | 1345 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1346 | 1346 | # namespace. Embedded instances, on the other hand, should not do |
|
1347 | 1347 | # this because they need to manage the user local/global namespaces |
|
1348 | 1348 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1349 | 1349 | # shouldn't overtake the execution environment of the script they're |
|
1350 | 1350 | # embedded in). |
|
1351 | 1351 | |
|
1352 | 1352 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1353 | 1353 | main_name = self.user_module.__name__ |
|
1354 | 1354 | sys.modules[main_name] = self.user_module |
|
1355 | 1355 | |
|
1356 | 1356 | def init_user_ns(self): |
|
1357 | 1357 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1358 | 1358 | |
|
1359 | 1359 | Certain history lists are also initialized here, as they effectively |
|
1360 | 1360 | act as user namespaces. |
|
1361 | 1361 | |
|
1362 | 1362 | Notes |
|
1363 | 1363 | ----- |
|
1364 | 1364 | All data structures here are only filled in, they are NOT reset by this |
|
1365 | 1365 | method. If they were not empty before, data will simply be added to |
|
1366 | 1366 | them. |
|
1367 | 1367 | """ |
|
1368 | 1368 | # This function works in two parts: first we put a few things in |
|
1369 | 1369 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1370 | 1370 | # initial variables aren't shown by %who. After the sync, we add the |
|
1371 | 1371 | # rest of what we *do* want the user to see with %who even on a new |
|
1372 | 1372 | # session (probably nothing, so they really only see their own stuff) |
|
1373 | 1373 | |
|
1374 | 1374 | # The user dict must *always* have a __builtin__ reference to the |
|
1375 | 1375 | # Python standard __builtin__ namespace, which must be imported. |
|
1376 | 1376 | # This is so that certain operations in prompt evaluation can be |
|
1377 | 1377 | # reliably executed with builtins. Note that we can NOT use |
|
1378 | 1378 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1379 | 1379 | # module, and can even mutate at runtime, depending on the context |
|
1380 | 1380 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1381 | 1381 | # always a module object, though it must be explicitly imported. |
|
1382 | 1382 | |
|
1383 | 1383 | # For more details: |
|
1384 | 1384 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1385 | 1385 | ns = {} |
|
1386 | 1386 | |
|
1387 | 1387 | # make global variables for user access to the histories |
|
1388 | 1388 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1389 | 1389 | ns['_oh'] = self.history_manager.output_hist |
|
1390 | 1390 | ns['_dh'] = self.history_manager.dir_hist |
|
1391 | 1391 | |
|
1392 | 1392 | # user aliases to input and output histories. These shouldn't show up |
|
1393 | 1393 | # in %who, as they can have very large reprs. |
|
1394 | 1394 | ns['In'] = self.history_manager.input_hist_parsed |
|
1395 | 1395 | ns['Out'] = self.history_manager.output_hist |
|
1396 | 1396 | |
|
1397 | 1397 | # Store myself as the public api!!! |
|
1398 | 1398 | ns['get_ipython'] = self.get_ipython |
|
1399 | 1399 | |
|
1400 | 1400 | ns['exit'] = self.exiter |
|
1401 | 1401 | ns['quit'] = self.exiter |
|
1402 | 1402 | |
|
1403 | 1403 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1404 | 1404 | # by %who |
|
1405 | 1405 | self.user_ns_hidden.update(ns) |
|
1406 | 1406 | |
|
1407 | 1407 | # Anything put into ns now would show up in %who. Think twice before |
|
1408 | 1408 | # putting anything here, as we really want %who to show the user their |
|
1409 | 1409 | # stuff, not our variables. |
|
1410 | 1410 | |
|
1411 | 1411 | # Finally, update the real user's namespace |
|
1412 | 1412 | self.user_ns.update(ns) |
|
1413 | 1413 | |
|
1414 | 1414 | @property |
|
1415 | 1415 | def all_ns_refs(self): |
|
1416 | 1416 | """Get a list of references to all the namespace dictionaries in which |
|
1417 | 1417 | IPython might store a user-created object. |
|
1418 | 1418 | |
|
1419 | 1419 | Note that this does not include the displayhook, which also caches |
|
1420 | 1420 | objects from the output.""" |
|
1421 | 1421 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1422 | 1422 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1423 | 1423 | |
|
1424 | 1424 | def reset(self, new_session=True, aggressive=False): |
|
1425 | 1425 | """Clear all internal namespaces, and attempt to release references to |
|
1426 | 1426 | user objects. |
|
1427 | 1427 | |
|
1428 | 1428 | If new_session is True, a new history session will be opened. |
|
1429 | 1429 | """ |
|
1430 | 1430 | # Clear histories |
|
1431 | 1431 | self.history_manager.reset(new_session) |
|
1432 | 1432 | # Reset counter used to index all histories |
|
1433 | 1433 | if new_session: |
|
1434 | 1434 | self.execution_count = 1 |
|
1435 | 1435 | |
|
1436 | 1436 | # Reset last execution result |
|
1437 | 1437 | self.last_execution_succeeded = True |
|
1438 | 1438 | self.last_execution_result = None |
|
1439 | 1439 | |
|
1440 | 1440 | # Flush cached output items |
|
1441 | 1441 | if self.displayhook.do_full_cache: |
|
1442 | 1442 | self.displayhook.flush() |
|
1443 | 1443 | |
|
1444 | 1444 | # The main execution namespaces must be cleared very carefully, |
|
1445 | 1445 | # skipping the deletion of the builtin-related keys, because doing so |
|
1446 | 1446 | # would cause errors in many object's __del__ methods. |
|
1447 | 1447 | if self.user_ns is not self.user_global_ns: |
|
1448 | 1448 | self.user_ns.clear() |
|
1449 | 1449 | ns = self.user_global_ns |
|
1450 | 1450 | drop_keys = set(ns.keys()) |
|
1451 | 1451 | drop_keys.discard('__builtin__') |
|
1452 | 1452 | drop_keys.discard('__builtins__') |
|
1453 | 1453 | drop_keys.discard('__name__') |
|
1454 | 1454 | for k in drop_keys: |
|
1455 | 1455 | del ns[k] |
|
1456 | 1456 | |
|
1457 | 1457 | self.user_ns_hidden.clear() |
|
1458 | 1458 | |
|
1459 | 1459 | # Restore the user namespaces to minimal usability |
|
1460 | 1460 | self.init_user_ns() |
|
1461 | 1461 | if aggressive and not hasattr(self, "_sys_modules_keys"): |
|
1462 | 1462 | print("Cannot restore sys.module, no snapshot") |
|
1463 | 1463 | elif aggressive: |
|
1464 | 1464 | print("culling sys module...") |
|
1465 | 1465 | current_keys = set(sys.modules.keys()) |
|
1466 | 1466 | for k in current_keys - self._sys_modules_keys: |
|
1467 | 1467 | if k.startswith("multiprocessing"): |
|
1468 | 1468 | continue |
|
1469 | 1469 | del sys.modules[k] |
|
1470 | 1470 | |
|
1471 | 1471 | # Restore the default and user aliases |
|
1472 | 1472 | self.alias_manager.clear_aliases() |
|
1473 | 1473 | self.alias_manager.init_aliases() |
|
1474 | 1474 | |
|
1475 | 1475 | # Now define aliases that only make sense on the terminal, because they |
|
1476 | 1476 | # need direct access to the console in a way that we can't emulate in |
|
1477 | 1477 | # GUI or web frontend |
|
1478 | 1478 | if os.name == 'posix': |
|
1479 | 1479 | for cmd in ('clear', 'more', 'less', 'man'): |
|
1480 | 1480 | if cmd not in self.magics_manager.magics['line']: |
|
1481 | 1481 | self.alias_manager.soft_define_alias(cmd, cmd) |
|
1482 | 1482 | |
|
1483 | 1483 | # Flush the private list of module references kept for script |
|
1484 | 1484 | # execution protection |
|
1485 | 1485 | self.clear_main_mod_cache() |
|
1486 | 1486 | |
|
1487 | 1487 | def del_var(self, varname, by_name=False): |
|
1488 | 1488 | """Delete a variable from the various namespaces, so that, as |
|
1489 | 1489 | far as possible, we're not keeping any hidden references to it. |
|
1490 | 1490 | |
|
1491 | 1491 | Parameters |
|
1492 | 1492 | ---------- |
|
1493 | 1493 | varname : str |
|
1494 | 1494 | The name of the variable to delete. |
|
1495 | 1495 | by_name : bool |
|
1496 | 1496 | If True, delete variables with the given name in each |
|
1497 | 1497 | namespace. If False (default), find the variable in the user |
|
1498 | 1498 | namespace, and delete references to it. |
|
1499 | 1499 | """ |
|
1500 | 1500 | if varname in ('__builtin__', '__builtins__'): |
|
1501 | 1501 | raise ValueError("Refusing to delete %s" % varname) |
|
1502 | 1502 | |
|
1503 | 1503 | ns_refs = self.all_ns_refs |
|
1504 | 1504 | |
|
1505 | 1505 | if by_name: # Delete by name |
|
1506 | 1506 | for ns in ns_refs: |
|
1507 | 1507 | try: |
|
1508 | 1508 | del ns[varname] |
|
1509 | 1509 | except KeyError: |
|
1510 | 1510 | pass |
|
1511 | 1511 | else: # Delete by object |
|
1512 | 1512 | try: |
|
1513 | 1513 | obj = self.user_ns[varname] |
|
1514 | 1514 | except KeyError as e: |
|
1515 | 1515 | raise NameError("name '%s' is not defined" % varname) from e |
|
1516 | 1516 | # Also check in output history |
|
1517 | 1517 | ns_refs.append(self.history_manager.output_hist) |
|
1518 | 1518 | for ns in ns_refs: |
|
1519 | 1519 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1520 | 1520 | for name in to_delete: |
|
1521 | 1521 | del ns[name] |
|
1522 | 1522 | |
|
1523 | 1523 | # Ensure it is removed from the last execution result |
|
1524 | 1524 | if self.last_execution_result.result is obj: |
|
1525 | 1525 | self.last_execution_result = None |
|
1526 | 1526 | |
|
1527 | 1527 | # displayhook keeps extra references, but not in a dictionary |
|
1528 | 1528 | for name in ('_', '__', '___'): |
|
1529 | 1529 | if getattr(self.displayhook, name) is obj: |
|
1530 | 1530 | setattr(self.displayhook, name, None) |
|
1531 | 1531 | |
|
1532 | 1532 | def reset_selective(self, regex=None): |
|
1533 | 1533 | """Clear selective variables from internal namespaces based on a |
|
1534 | 1534 | specified regular expression. |
|
1535 | 1535 | |
|
1536 | 1536 | Parameters |
|
1537 | 1537 | ---------- |
|
1538 | 1538 | regex : string or compiled pattern, optional |
|
1539 | 1539 | A regular expression pattern that will be used in searching |
|
1540 | 1540 | variable names in the users namespaces. |
|
1541 | 1541 | """ |
|
1542 | 1542 | if regex is not None: |
|
1543 | 1543 | try: |
|
1544 | 1544 | m = re.compile(regex) |
|
1545 | 1545 | except TypeError as e: |
|
1546 | 1546 | raise TypeError('regex must be a string or compiled pattern') from e |
|
1547 | 1547 | # Search for keys in each namespace that match the given regex |
|
1548 | 1548 | # If a match is found, delete the key/value pair. |
|
1549 | 1549 | for ns in self.all_ns_refs: |
|
1550 | 1550 | for var in ns: |
|
1551 | 1551 | if m.search(var): |
|
1552 | 1552 | del ns[var] |
|
1553 | 1553 | |
|
1554 | 1554 | def push(self, variables, interactive=True): |
|
1555 | 1555 | """Inject a group of variables into the IPython user namespace. |
|
1556 | 1556 | |
|
1557 | 1557 | Parameters |
|
1558 | 1558 | ---------- |
|
1559 | 1559 | variables : dict, str or list/tuple of str |
|
1560 | 1560 | The variables to inject into the user's namespace. If a dict, a |
|
1561 | 1561 | simple update is done. If a str, the string is assumed to have |
|
1562 | 1562 | variable names separated by spaces. A list/tuple of str can also |
|
1563 | 1563 | be used to give the variable names. If just the variable names are |
|
1564 | 1564 | give (list/tuple/str) then the variable values looked up in the |
|
1565 | 1565 | callers frame. |
|
1566 | 1566 | interactive : bool |
|
1567 | 1567 | If True (default), the variables will be listed with the ``who`` |
|
1568 | 1568 | magic. |
|
1569 | 1569 | """ |
|
1570 | 1570 | vdict = None |
|
1571 | 1571 | |
|
1572 | 1572 | # We need a dict of name/value pairs to do namespace updates. |
|
1573 | 1573 | if isinstance(variables, dict): |
|
1574 | 1574 | vdict = variables |
|
1575 | 1575 | elif isinstance(variables, (str, list, tuple)): |
|
1576 | 1576 | if isinstance(variables, str): |
|
1577 | 1577 | vlist = variables.split() |
|
1578 | 1578 | else: |
|
1579 | 1579 | vlist = variables |
|
1580 | 1580 | vdict = {} |
|
1581 | 1581 | cf = sys._getframe(1) |
|
1582 | 1582 | for name in vlist: |
|
1583 | 1583 | try: |
|
1584 | 1584 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1585 | 1585 | except: |
|
1586 | 1586 | print('Could not get variable %s from %s' % |
|
1587 | 1587 | (name,cf.f_code.co_name)) |
|
1588 | 1588 | else: |
|
1589 | 1589 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1590 | 1590 | |
|
1591 | 1591 | # Propagate variables to user namespace |
|
1592 | 1592 | self.user_ns.update(vdict) |
|
1593 | 1593 | |
|
1594 | 1594 | # And configure interactive visibility |
|
1595 | 1595 | user_ns_hidden = self.user_ns_hidden |
|
1596 | 1596 | if interactive: |
|
1597 | 1597 | for name in vdict: |
|
1598 | 1598 | user_ns_hidden.pop(name, None) |
|
1599 | 1599 | else: |
|
1600 | 1600 | user_ns_hidden.update(vdict) |
|
1601 | 1601 | |
|
1602 | 1602 | def drop_by_id(self, variables): |
|
1603 | 1603 | """Remove a dict of variables from the user namespace, if they are the |
|
1604 | 1604 | same as the values in the dictionary. |
|
1605 | 1605 | |
|
1606 | 1606 | This is intended for use by extensions: variables that they've added can |
|
1607 | 1607 | be taken back out if they are unloaded, without removing any that the |
|
1608 | 1608 | user has overwritten. |
|
1609 | 1609 | |
|
1610 | 1610 | Parameters |
|
1611 | 1611 | ---------- |
|
1612 | 1612 | variables : dict |
|
1613 | 1613 | A dictionary mapping object names (as strings) to the objects. |
|
1614 | 1614 | """ |
|
1615 | 1615 | for name, obj in variables.items(): |
|
1616 | 1616 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1617 | 1617 | del self.user_ns[name] |
|
1618 | 1618 | self.user_ns_hidden.pop(name, None) |
|
1619 | 1619 | |
|
1620 | 1620 | #------------------------------------------------------------------------- |
|
1621 | 1621 | # Things related to object introspection |
|
1622 | 1622 | #------------------------------------------------------------------------- |
|
1623 | 1623 | |
|
1624 | 1624 | def _ofind(self, oname, namespaces=None): |
|
1625 | 1625 | """Find an object in the available namespaces. |
|
1626 | 1626 | |
|
1627 | 1627 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1628 | 1628 | |
|
1629 | 1629 | Has special code to detect magic functions. |
|
1630 | 1630 | """ |
|
1631 | 1631 | oname = oname.strip() |
|
1632 | 1632 | if not oname.startswith(ESC_MAGIC) and \ |
|
1633 | 1633 | not oname.startswith(ESC_MAGIC2) and \ |
|
1634 | 1634 | not all(a.isidentifier() for a in oname.split(".")): |
|
1635 | 1635 | return {'found': False} |
|
1636 | 1636 | |
|
1637 | 1637 | if namespaces is None: |
|
1638 | 1638 | # Namespaces to search in: |
|
1639 | 1639 | # Put them in a list. The order is important so that we |
|
1640 | 1640 | # find things in the same order that Python finds them. |
|
1641 | 1641 | namespaces = [ ('Interactive', self.user_ns), |
|
1642 | 1642 | ('Interactive (global)', self.user_global_ns), |
|
1643 | 1643 | ('Python builtin', builtin_mod.__dict__), |
|
1644 | 1644 | ] |
|
1645 | 1645 | |
|
1646 | 1646 | ismagic = False |
|
1647 | 1647 | isalias = False |
|
1648 | 1648 | found = False |
|
1649 | 1649 | ospace = None |
|
1650 | 1650 | parent = None |
|
1651 | 1651 | obj = None |
|
1652 | 1652 | |
|
1653 | 1653 | |
|
1654 | 1654 | # Look for the given name by splitting it in parts. If the head is |
|
1655 | 1655 | # found, then we look for all the remaining parts as members, and only |
|
1656 | 1656 | # declare success if we can find them all. |
|
1657 | 1657 | oname_parts = oname.split('.') |
|
1658 | 1658 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1659 | 1659 | for nsname,ns in namespaces: |
|
1660 | 1660 | try: |
|
1661 | 1661 | obj = ns[oname_head] |
|
1662 | 1662 | except KeyError: |
|
1663 | 1663 | continue |
|
1664 | 1664 | else: |
|
1665 | 1665 | for idx, part in enumerate(oname_rest): |
|
1666 | 1666 | try: |
|
1667 | 1667 | parent = obj |
|
1668 | 1668 | # The last part is looked up in a special way to avoid |
|
1669 | 1669 | # descriptor invocation as it may raise or have side |
|
1670 | 1670 | # effects. |
|
1671 | 1671 | if idx == len(oname_rest) - 1: |
|
1672 | 1672 | obj = self._getattr_property(obj, part) |
|
1673 | 1673 | else: |
|
1674 | 1674 | obj = getattr(obj, part) |
|
1675 | 1675 | except: |
|
1676 | 1676 | # Blanket except b/c some badly implemented objects |
|
1677 | 1677 | # allow __getattr__ to raise exceptions other than |
|
1678 | 1678 | # AttributeError, which then crashes IPython. |
|
1679 | 1679 | break |
|
1680 | 1680 | else: |
|
1681 | 1681 | # If we finish the for loop (no break), we got all members |
|
1682 | 1682 | found = True |
|
1683 | 1683 | ospace = nsname |
|
1684 | 1684 | break # namespace loop |
|
1685 | 1685 | |
|
1686 | 1686 | # Try to see if it's magic |
|
1687 | 1687 | if not found: |
|
1688 | 1688 | obj = None |
|
1689 | 1689 | if oname.startswith(ESC_MAGIC2): |
|
1690 | 1690 | oname = oname.lstrip(ESC_MAGIC2) |
|
1691 | 1691 | obj = self.find_cell_magic(oname) |
|
1692 | 1692 | elif oname.startswith(ESC_MAGIC): |
|
1693 | 1693 | oname = oname.lstrip(ESC_MAGIC) |
|
1694 | 1694 | obj = self.find_line_magic(oname) |
|
1695 | 1695 | else: |
|
1696 | 1696 | # search without prefix, so run? will find %run? |
|
1697 | 1697 | obj = self.find_line_magic(oname) |
|
1698 | 1698 | if obj is None: |
|
1699 | 1699 | obj = self.find_cell_magic(oname) |
|
1700 | 1700 | if obj is not None: |
|
1701 | 1701 | found = True |
|
1702 | 1702 | ospace = 'IPython internal' |
|
1703 | 1703 | ismagic = True |
|
1704 | 1704 | isalias = isinstance(obj, Alias) |
|
1705 | 1705 | |
|
1706 | 1706 | # Last try: special-case some literals like '', [], {}, etc: |
|
1707 | 1707 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1708 | 1708 | obj = eval(oname_head) |
|
1709 | 1709 | found = True |
|
1710 | 1710 | ospace = 'Interactive' |
|
1711 | 1711 | |
|
1712 | 1712 | return { |
|
1713 | 1713 | 'obj':obj, |
|
1714 | 1714 | 'found':found, |
|
1715 | 1715 | 'parent':parent, |
|
1716 | 1716 | 'ismagic':ismagic, |
|
1717 | 1717 | 'isalias':isalias, |
|
1718 | 1718 | 'namespace':ospace |
|
1719 | 1719 | } |
|
1720 | 1720 | |
|
1721 | 1721 | @staticmethod |
|
1722 | 1722 | def _getattr_property(obj, attrname): |
|
1723 | 1723 | """Property-aware getattr to use in object finding. |
|
1724 | 1724 | |
|
1725 | 1725 | If attrname represents a property, return it unevaluated (in case it has |
|
1726 | 1726 | side effects or raises an error. |
|
1727 | 1727 | |
|
1728 | 1728 | """ |
|
1729 | 1729 | if not isinstance(obj, type): |
|
1730 | 1730 | try: |
|
1731 | 1731 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1732 | 1732 | # `obj`, but does so for property: |
|
1733 | 1733 | # |
|
1734 | 1734 | # property.__get__(self, None, cls) -> self |
|
1735 | 1735 | # |
|
1736 | 1736 | # The universal alternative is to traverse the mro manually |
|
1737 | 1737 | # searching for attrname in class dicts. |
|
1738 | 1738 | attr = getattr(type(obj), attrname) |
|
1739 | 1739 | except AttributeError: |
|
1740 | 1740 | pass |
|
1741 | 1741 | else: |
|
1742 | 1742 | # This relies on the fact that data descriptors (with both |
|
1743 | 1743 | # __get__ & __set__ magic methods) take precedence over |
|
1744 | 1744 | # instance-level attributes: |
|
1745 | 1745 | # |
|
1746 | 1746 | # class A(object): |
|
1747 | 1747 | # @property |
|
1748 | 1748 | # def foobar(self): return 123 |
|
1749 | 1749 | # a = A() |
|
1750 | 1750 | # a.__dict__['foobar'] = 345 |
|
1751 | 1751 | # a.foobar # == 123 |
|
1752 | 1752 | # |
|
1753 | 1753 | # So, a property may be returned right away. |
|
1754 | 1754 | if isinstance(attr, property): |
|
1755 | 1755 | return attr |
|
1756 | 1756 | |
|
1757 | 1757 | # Nothing helped, fall back. |
|
1758 | 1758 | return getattr(obj, attrname) |
|
1759 | 1759 | |
|
1760 | 1760 | def _object_find(self, oname, namespaces=None): |
|
1761 | 1761 | """Find an object and return a struct with info about it.""" |
|
1762 | 1762 | return Struct(self._ofind(oname, namespaces)) |
|
1763 | 1763 | |
|
1764 | 1764 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1765 | 1765 | """Generic interface to the inspector system. |
|
1766 | 1766 | |
|
1767 | 1767 | This function is meant to be called by pdef, pdoc & friends. |
|
1768 | 1768 | """ |
|
1769 | 1769 | info = self._object_find(oname, namespaces) |
|
1770 | 1770 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1771 | 1771 | if info.found: |
|
1772 | 1772 | pmethod = getattr(self.inspector, meth) |
|
1773 | 1773 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1774 | 1774 | # bundle. |
|
1775 | 1775 | formatter = format_screen if info.ismagic else docformat |
|
1776 | 1776 | if meth == 'pdoc': |
|
1777 | 1777 | pmethod(info.obj, oname, formatter) |
|
1778 | 1778 | elif meth == 'pinfo': |
|
1779 | 1779 | pmethod( |
|
1780 | 1780 | info.obj, |
|
1781 | 1781 | oname, |
|
1782 | 1782 | formatter, |
|
1783 | 1783 | info, |
|
1784 | 1784 | enable_html_pager=self.enable_html_pager, |
|
1785 | 1785 | **kw |
|
1786 | 1786 | ) |
|
1787 | 1787 | else: |
|
1788 | 1788 | pmethod(info.obj, oname) |
|
1789 | 1789 | else: |
|
1790 | 1790 | print('Object `%s` not found.' % oname) |
|
1791 | 1791 | return 'not found' # so callers can take other action |
|
1792 | 1792 | |
|
1793 | 1793 | def object_inspect(self, oname, detail_level=0): |
|
1794 | 1794 | """Get object info about oname""" |
|
1795 | 1795 | with self.builtin_trap: |
|
1796 | 1796 | info = self._object_find(oname) |
|
1797 | 1797 | if info.found: |
|
1798 | 1798 | return self.inspector.info(info.obj, oname, info=info, |
|
1799 | 1799 | detail_level=detail_level |
|
1800 | 1800 | ) |
|
1801 | 1801 | else: |
|
1802 | 1802 | return oinspect.object_info(name=oname, found=False) |
|
1803 | 1803 | |
|
1804 | 1804 | def object_inspect_text(self, oname, detail_level=0): |
|
1805 | 1805 | """Get object info as formatted text""" |
|
1806 | 1806 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1807 | 1807 | |
|
1808 | 1808 | def object_inspect_mime(self, oname, detail_level=0): |
|
1809 | 1809 | """Get object info as a mimebundle of formatted representations. |
|
1810 | 1810 | |
|
1811 | 1811 | A mimebundle is a dictionary, keyed by mime-type. |
|
1812 | 1812 | It must always have the key `'text/plain'`. |
|
1813 | 1813 | """ |
|
1814 | 1814 | with self.builtin_trap: |
|
1815 | 1815 | info = self._object_find(oname) |
|
1816 | 1816 | if info.found: |
|
1817 | 1817 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1818 | 1818 | detail_level=detail_level |
|
1819 | 1819 | ) |
|
1820 | 1820 | else: |
|
1821 | 1821 | raise KeyError(oname) |
|
1822 | 1822 | |
|
1823 | 1823 | #------------------------------------------------------------------------- |
|
1824 | 1824 | # Things related to history management |
|
1825 | 1825 | #------------------------------------------------------------------------- |
|
1826 | 1826 | |
|
1827 | 1827 | def init_history(self): |
|
1828 | 1828 | """Sets up the command history, and starts regular autosaves.""" |
|
1829 | 1829 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1830 | 1830 | self.configurables.append(self.history_manager) |
|
1831 | 1831 | |
|
1832 | 1832 | #------------------------------------------------------------------------- |
|
1833 | 1833 | # Things related to exception handling and tracebacks (not debugging) |
|
1834 | 1834 | #------------------------------------------------------------------------- |
|
1835 | 1835 | |
|
1836 | 1836 | debugger_cls = Pdb |
|
1837 | 1837 | |
|
1838 | 1838 | def init_traceback_handlers(self, custom_exceptions): |
|
1839 | 1839 | # Syntax error handler. |
|
1840 | 1840 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1841 | 1841 | |
|
1842 | 1842 | # The interactive one is initialized with an offset, meaning we always |
|
1843 | 1843 | # want to remove the topmost item in the traceback, which is our own |
|
1844 | 1844 | # internal code. Valid modes: ['Plain','Context','Verbose','Minimal'] |
|
1845 | 1845 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1846 | 1846 | color_scheme='NoColor', |
|
1847 | 1847 | tb_offset = 1, |
|
1848 | 1848 | check_cache=check_linecache_ipython, |
|
1849 | 1849 | debugger_cls=self.debugger_cls, parent=self) |
|
1850 | 1850 | |
|
1851 | 1851 | # The instance will store a pointer to the system-wide exception hook, |
|
1852 | 1852 | # so that runtime code (such as magics) can access it. This is because |
|
1853 | 1853 | # during the read-eval loop, it may get temporarily overwritten. |
|
1854 | 1854 | self.sys_excepthook = sys.excepthook |
|
1855 | 1855 | |
|
1856 | 1856 | # and add any custom exception handlers the user may have specified |
|
1857 | 1857 | self.set_custom_exc(*custom_exceptions) |
|
1858 | 1858 | |
|
1859 | 1859 | # Set the exception mode |
|
1860 | 1860 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1861 | 1861 | |
|
1862 | 1862 | def set_custom_exc(self, exc_tuple, handler): |
|
1863 | 1863 | """set_custom_exc(exc_tuple, handler) |
|
1864 | 1864 | |
|
1865 | 1865 | Set a custom exception handler, which will be called if any of the |
|
1866 | 1866 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1867 | 1867 | run_code() method). |
|
1868 | 1868 | |
|
1869 | 1869 | Parameters |
|
1870 | 1870 | ---------- |
|
1871 | 1871 | |
|
1872 | 1872 | exc_tuple : tuple of exception classes |
|
1873 | 1873 | A *tuple* of exception classes, for which to call the defined |
|
1874 | 1874 | handler. It is very important that you use a tuple, and NOT A |
|
1875 | 1875 | LIST here, because of the way Python's except statement works. If |
|
1876 | 1876 | you only want to trap a single exception, use a singleton tuple:: |
|
1877 | 1877 | |
|
1878 | 1878 | exc_tuple == (MyCustomException,) |
|
1879 | 1879 | |
|
1880 | 1880 | handler : callable |
|
1881 | 1881 | handler must have the following signature:: |
|
1882 | 1882 | |
|
1883 | 1883 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1884 | 1884 | ... |
|
1885 | 1885 | return structured_traceback |
|
1886 | 1886 | |
|
1887 | 1887 | Your handler must return a structured traceback (a list of strings), |
|
1888 | 1888 | or None. |
|
1889 | 1889 | |
|
1890 | 1890 | This will be made into an instance method (via types.MethodType) |
|
1891 | 1891 | of IPython itself, and it will be called if any of the exceptions |
|
1892 | 1892 | listed in the exc_tuple are caught. If the handler is None, an |
|
1893 | 1893 | internal basic one is used, which just prints basic info. |
|
1894 | 1894 | |
|
1895 | 1895 | To protect IPython from crashes, if your handler ever raises an |
|
1896 | 1896 | exception or returns an invalid result, it will be immediately |
|
1897 | 1897 | disabled. |
|
1898 | 1898 | |
|
1899 | 1899 | Notes |
|
1900 | 1900 | ----- |
|
1901 | 1901 | |
|
1902 | 1902 | WARNING: by putting in your own exception handler into IPython's main |
|
1903 | 1903 | execution loop, you run a very good chance of nasty crashes. This |
|
1904 | 1904 | facility should only be used if you really know what you are doing. |
|
1905 | 1905 | """ |
|
1906 | 1906 | |
|
1907 | 1907 | if not isinstance(exc_tuple, tuple): |
|
1908 | 1908 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1909 | 1909 | |
|
1910 | 1910 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1911 | 1911 | print('*** Simple custom exception handler ***') |
|
1912 | 1912 | print('Exception type :', etype) |
|
1913 | 1913 | print('Exception value:', value) |
|
1914 | 1914 | print('Traceback :', tb) |
|
1915 | 1915 | |
|
1916 | 1916 | def validate_stb(stb): |
|
1917 | 1917 | """validate structured traceback return type |
|
1918 | 1918 | |
|
1919 | 1919 | return type of CustomTB *should* be a list of strings, but allow |
|
1920 | 1920 | single strings or None, which are harmless. |
|
1921 | 1921 | |
|
1922 | 1922 | This function will *always* return a list of strings, |
|
1923 | 1923 | and will raise a TypeError if stb is inappropriate. |
|
1924 | 1924 | """ |
|
1925 | 1925 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1926 | 1926 | if stb is None: |
|
1927 | 1927 | return [] |
|
1928 | 1928 | elif isinstance(stb, str): |
|
1929 | 1929 | return [stb] |
|
1930 | 1930 | elif not isinstance(stb, list): |
|
1931 | 1931 | raise TypeError(msg) |
|
1932 | 1932 | # it's a list |
|
1933 | 1933 | for line in stb: |
|
1934 | 1934 | # check every element |
|
1935 | 1935 | if not isinstance(line, str): |
|
1936 | 1936 | raise TypeError(msg) |
|
1937 | 1937 | return stb |
|
1938 | 1938 | |
|
1939 | 1939 | if handler is None: |
|
1940 | 1940 | wrapped = dummy_handler |
|
1941 | 1941 | else: |
|
1942 | 1942 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1943 | 1943 | """wrap CustomTB handler, to protect IPython from user code |
|
1944 | 1944 | |
|
1945 | 1945 | This makes it harder (but not impossible) for custom exception |
|
1946 | 1946 | handlers to crash IPython. |
|
1947 | 1947 | """ |
|
1948 | 1948 | try: |
|
1949 | 1949 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1950 | 1950 | return validate_stb(stb) |
|
1951 | 1951 | except: |
|
1952 | 1952 | # clear custom handler immediately |
|
1953 | 1953 | self.set_custom_exc((), None) |
|
1954 | 1954 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1955 | 1955 | # show the exception in handler first |
|
1956 | 1956 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1957 | 1957 | print(self.InteractiveTB.stb2text(stb)) |
|
1958 | 1958 | print("The original exception:") |
|
1959 | 1959 | stb = self.InteractiveTB.structured_traceback( |
|
1960 | 1960 | (etype,value,tb), tb_offset=tb_offset |
|
1961 | 1961 | ) |
|
1962 | 1962 | return stb |
|
1963 | 1963 | |
|
1964 | 1964 | self.CustomTB = types.MethodType(wrapped,self) |
|
1965 | 1965 | self.custom_exceptions = exc_tuple |
|
1966 | 1966 | |
|
1967 | 1967 | def excepthook(self, etype, value, tb): |
|
1968 | 1968 | """One more defense for GUI apps that call sys.excepthook. |
|
1969 | 1969 | |
|
1970 | 1970 | GUI frameworks like wxPython trap exceptions and call |
|
1971 | 1971 | sys.excepthook themselves. I guess this is a feature that |
|
1972 | 1972 | enables them to keep running after exceptions that would |
|
1973 | 1973 | otherwise kill their mainloop. This is a bother for IPython |
|
1974 | 1974 | which excepts to catch all of the program exceptions with a try: |
|
1975 | 1975 | except: statement. |
|
1976 | 1976 | |
|
1977 | 1977 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1978 | 1978 | any app directly invokes sys.excepthook, it will look to the user like |
|
1979 | 1979 | IPython crashed. In order to work around this, we can disable the |
|
1980 | 1980 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1981 | 1981 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1982 | 1982 | call sys.excepthook will generate a regular-looking exception from |
|
1983 | 1983 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1984 | 1984 | crashes. |
|
1985 | 1985 | |
|
1986 | 1986 | This hook should be used sparingly, only in places which are not likely |
|
1987 | 1987 | to be true IPython errors. |
|
1988 | 1988 | """ |
|
1989 | 1989 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1990 | 1990 | |
|
1991 | 1991 | def _get_exc_info(self, exc_tuple=None): |
|
1992 | 1992 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1993 | 1993 | |
|
1994 | 1994 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1995 | 1995 | from whichever source. |
|
1996 | 1996 | |
|
1997 | 1997 | raises ValueError if none of these contain any information |
|
1998 | 1998 | """ |
|
1999 | 1999 | if exc_tuple is None: |
|
2000 | 2000 | etype, value, tb = sys.exc_info() |
|
2001 | 2001 | else: |
|
2002 | 2002 | etype, value, tb = exc_tuple |
|
2003 | 2003 | |
|
2004 | 2004 | if etype is None: |
|
2005 | 2005 | if hasattr(sys, 'last_type'): |
|
2006 | 2006 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
2007 | 2007 | sys.last_traceback |
|
2008 | 2008 | |
|
2009 | 2009 | if etype is None: |
|
2010 | 2010 | raise ValueError("No exception to find") |
|
2011 | 2011 | |
|
2012 | 2012 | # Now store the exception info in sys.last_type etc. |
|
2013 | 2013 | # WARNING: these variables are somewhat deprecated and not |
|
2014 | 2014 | # necessarily safe to use in a threaded environment, but tools |
|
2015 | 2015 | # like pdb depend on their existence, so let's set them. If we |
|
2016 | 2016 | # find problems in the field, we'll need to revisit their use. |
|
2017 | 2017 | sys.last_type = etype |
|
2018 | 2018 | sys.last_value = value |
|
2019 | 2019 | sys.last_traceback = tb |
|
2020 | 2020 | |
|
2021 | 2021 | return etype, value, tb |
|
2022 | 2022 | |
|
2023 | 2023 | def show_usage_error(self, exc): |
|
2024 | 2024 | """Show a short message for UsageErrors |
|
2025 | 2025 | |
|
2026 | 2026 | These are special exceptions that shouldn't show a traceback. |
|
2027 | 2027 | """ |
|
2028 | 2028 | print("UsageError: %s" % exc, file=sys.stderr) |
|
2029 | 2029 | |
|
2030 | 2030 | def get_exception_only(self, exc_tuple=None): |
|
2031 | 2031 | """ |
|
2032 | 2032 | Return as a string (ending with a newline) the exception that |
|
2033 | 2033 | just occurred, without any traceback. |
|
2034 | 2034 | """ |
|
2035 | 2035 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2036 | 2036 | msg = traceback.format_exception_only(etype, value) |
|
2037 | 2037 | return ''.join(msg) |
|
2038 | 2038 | |
|
2039 | 2039 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
2040 | 2040 | exception_only=False, running_compiled_code=False): |
|
2041 | 2041 | """Display the exception that just occurred. |
|
2042 | 2042 | |
|
2043 | 2043 | If nothing is known about the exception, this is the method which |
|
2044 | 2044 | should be used throughout the code for presenting user tracebacks, |
|
2045 | 2045 | rather than directly invoking the InteractiveTB object. |
|
2046 | 2046 | |
|
2047 | 2047 | A specific showsyntaxerror() also exists, but this method can take |
|
2048 | 2048 | care of calling it if needed, so unless you are explicitly catching a |
|
2049 | 2049 | SyntaxError exception, don't try to analyze the stack manually and |
|
2050 | 2050 | simply call this method.""" |
|
2051 | 2051 | |
|
2052 | 2052 | try: |
|
2053 | 2053 | try: |
|
2054 | 2054 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2055 | 2055 | except ValueError: |
|
2056 | 2056 | print('No traceback available to show.', file=sys.stderr) |
|
2057 | 2057 | return |
|
2058 | 2058 | |
|
2059 | 2059 | if issubclass(etype, SyntaxError): |
|
2060 | 2060 | # Though this won't be called by syntax errors in the input |
|
2061 | 2061 | # line, there may be SyntaxError cases with imported code. |
|
2062 | 2062 | self.showsyntaxerror(filename, running_compiled_code) |
|
2063 | 2063 | elif etype is UsageError: |
|
2064 | 2064 | self.show_usage_error(value) |
|
2065 | 2065 | else: |
|
2066 | 2066 | if exception_only: |
|
2067 | 2067 | stb = ['An exception has occurred, use %tb to see ' |
|
2068 | 2068 | 'the full traceback.\n'] |
|
2069 | 2069 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
2070 | 2070 | value)) |
|
2071 | 2071 | else: |
|
2072 | 2072 | try: |
|
2073 | 2073 | # Exception classes can customise their traceback - we |
|
2074 | 2074 | # use this in IPython.parallel for exceptions occurring |
|
2075 | 2075 | # in the engines. This should return a list of strings. |
|
2076 | 2076 | stb = value._render_traceback_() |
|
2077 | 2077 | except Exception: |
|
2078 | 2078 | stb = self.InteractiveTB.structured_traceback(etype, |
|
2079 | 2079 | value, tb, tb_offset=tb_offset) |
|
2080 | 2080 | |
|
2081 | 2081 | self._showtraceback(etype, value, stb) |
|
2082 | 2082 | if self.call_pdb: |
|
2083 | 2083 | # drop into debugger |
|
2084 | 2084 | self.debugger(force=True) |
|
2085 | 2085 | return |
|
2086 | 2086 | |
|
2087 | 2087 | # Actually show the traceback |
|
2088 | 2088 | self._showtraceback(etype, value, stb) |
|
2089 | 2089 | |
|
2090 | 2090 | except KeyboardInterrupt: |
|
2091 | 2091 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2092 | 2092 | |
|
2093 | 2093 | def _showtraceback(self, etype, evalue, stb: str): |
|
2094 | 2094 | """Actually show a traceback. |
|
2095 | 2095 | |
|
2096 | 2096 | Subclasses may override this method to put the traceback on a different |
|
2097 | 2097 | place, like a side channel. |
|
2098 | 2098 | """ |
|
2099 | 2099 | val = self.InteractiveTB.stb2text(stb) |
|
2100 | 2100 | try: |
|
2101 | 2101 | print(val) |
|
2102 | 2102 | except UnicodeEncodeError: |
|
2103 | 2103 | print(val.encode("utf-8", "backslashreplace").decode()) |
|
2104 | 2104 | |
|
2105 | 2105 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
2106 | 2106 | """Display the syntax error that just occurred. |
|
2107 | 2107 | |
|
2108 | 2108 | This doesn't display a stack trace because there isn't one. |
|
2109 | 2109 | |
|
2110 | 2110 | If a filename is given, it is stuffed in the exception instead |
|
2111 | 2111 | of what was there before (because Python's parser always uses |
|
2112 | 2112 | "<string>" when reading from a string). |
|
2113 | 2113 | |
|
2114 | 2114 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
2115 | 2115 | longer stack trace will be displayed. |
|
2116 | 2116 | """ |
|
2117 | 2117 | etype, value, last_traceback = self._get_exc_info() |
|
2118 | 2118 | |
|
2119 | 2119 | if filename and issubclass(etype, SyntaxError): |
|
2120 | 2120 | try: |
|
2121 | 2121 | value.filename = filename |
|
2122 | 2122 | except: |
|
2123 | 2123 | # Not the format we expect; leave it alone |
|
2124 | 2124 | pass |
|
2125 | 2125 | |
|
2126 | 2126 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
2127 | 2127 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
2128 | 2128 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
2129 | 2129 | self._showtraceback(etype, value, stb) |
|
2130 | 2130 | |
|
2131 | 2131 | # This is overridden in TerminalInteractiveShell to show a message about |
|
2132 | 2132 | # the %paste magic. |
|
2133 | 2133 | def showindentationerror(self): |
|
2134 | 2134 | """Called by _run_cell when there's an IndentationError in code entered |
|
2135 | 2135 | at the prompt. |
|
2136 | 2136 | |
|
2137 | 2137 | This is overridden in TerminalInteractiveShell to show a message about |
|
2138 | 2138 | the %paste magic.""" |
|
2139 | 2139 | self.showsyntaxerror() |
|
2140 | 2140 | |
|
2141 | 2141 | #------------------------------------------------------------------------- |
|
2142 | 2142 | # Things related to readline |
|
2143 | 2143 | #------------------------------------------------------------------------- |
|
2144 | 2144 | |
|
2145 | 2145 | def init_readline(self): |
|
2146 | 2146 | """DEPRECATED |
|
2147 | 2147 | |
|
2148 | 2148 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
2149 | 2149 | # Set a number of methods that depend on readline to be no-op |
|
2150 | 2150 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
2151 | 2151 | DeprecationWarning, stacklevel=2) |
|
2152 | 2152 | self.set_custom_completer = no_op |
|
2153 | 2153 | |
|
2154 | 2154 | @skip_doctest |
|
2155 | 2155 | def set_next_input(self, s, replace=False): |
|
2156 | 2156 | """ Sets the 'default' input string for the next command line. |
|
2157 | 2157 | |
|
2158 | 2158 | Example:: |
|
2159 | 2159 | |
|
2160 | 2160 | In [1]: _ip.set_next_input("Hello Word") |
|
2161 | 2161 | In [2]: Hello Word_ # cursor is here |
|
2162 | 2162 | """ |
|
2163 | 2163 | self.rl_next_input = s |
|
2164 | 2164 | |
|
2165 | 2165 | def _indent_current_str(self): |
|
2166 | 2166 | """return the current level of indentation as a string""" |
|
2167 | 2167 | return self.input_splitter.get_indent_spaces() * ' ' |
|
2168 | 2168 | |
|
2169 | 2169 | #------------------------------------------------------------------------- |
|
2170 | 2170 | # Things related to text completion |
|
2171 | 2171 | #------------------------------------------------------------------------- |
|
2172 | 2172 | |
|
2173 | 2173 | def init_completer(self): |
|
2174 | 2174 | """Initialize the completion machinery. |
|
2175 | 2175 | |
|
2176 | 2176 | This creates completion machinery that can be used by client code, |
|
2177 | 2177 | either interactively in-process (typically triggered by the readline |
|
2178 | 2178 | library), programmatically (such as in test suites) or out-of-process |
|
2179 | 2179 | (typically over the network by remote frontends). |
|
2180 | 2180 | """ |
|
2181 | 2181 | from IPython.core.completer import IPCompleter |
|
2182 | 2182 | from IPython.core.completerlib import (module_completer, |
|
2183 | 2183 | magic_run_completer, cd_completer, reset_completer) |
|
2184 | 2184 | |
|
2185 | 2185 | self.Completer = IPCompleter(shell=self, |
|
2186 | 2186 | namespace=self.user_ns, |
|
2187 | 2187 | global_namespace=self.user_global_ns, |
|
2188 | 2188 | parent=self, |
|
2189 | 2189 | ) |
|
2190 | 2190 | self.configurables.append(self.Completer) |
|
2191 | 2191 | |
|
2192 | 2192 | # Add custom completers to the basic ones built into IPCompleter |
|
2193 | 2193 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2194 | 2194 | self.strdispatchers['complete_command'] = sdisp |
|
2195 | 2195 | self.Completer.custom_completers = sdisp |
|
2196 | 2196 | |
|
2197 | 2197 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2198 | 2198 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2199 | 2199 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
2200 | 2200 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2201 | 2201 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2202 | 2202 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2203 | 2203 | |
|
2204 | 2204 | @skip_doctest |
|
2205 | 2205 | def complete(self, text, line=None, cursor_pos=None): |
|
2206 | 2206 | """Return the completed text and a list of completions. |
|
2207 | 2207 | |
|
2208 | 2208 | Parameters |
|
2209 | 2209 | ---------- |
|
2210 | 2210 | |
|
2211 | 2211 | text : string |
|
2212 | 2212 | A string of text to be completed on. It can be given as empty and |
|
2213 | 2213 | instead a line/position pair are given. In this case, the |
|
2214 | 2214 | completer itself will split the line like readline does. |
|
2215 | 2215 | |
|
2216 | 2216 | line : string, optional |
|
2217 | 2217 | The complete line that text is part of. |
|
2218 | 2218 | |
|
2219 | 2219 | cursor_pos : int, optional |
|
2220 | 2220 | The position of the cursor on the input line. |
|
2221 | 2221 | |
|
2222 | 2222 | Returns |
|
2223 | 2223 | ------- |
|
2224 | 2224 | text : string |
|
2225 | 2225 | The actual text that was completed. |
|
2226 | 2226 | |
|
2227 | 2227 | matches : list |
|
2228 | 2228 | A sorted list with all possible completions. |
|
2229 | 2229 | |
|
2230 | 2230 | |
|
2231 | 2231 | Notes |
|
2232 | 2232 | ----- |
|
2233 | 2233 | The optional arguments allow the completion to take more context into |
|
2234 | 2234 | account, and are part of the low-level completion API. |
|
2235 | 2235 | |
|
2236 | 2236 | This is a wrapper around the completion mechanism, similar to what |
|
2237 | 2237 | readline does at the command line when the TAB key is hit. By |
|
2238 | 2238 | exposing it as a method, it can be used by other non-readline |
|
2239 | 2239 | environments (such as GUIs) for text completion. |
|
2240 | 2240 | |
|
2241 | 2241 | Examples |
|
2242 | 2242 | -------- |
|
2243 | 2243 | |
|
2244 | 2244 | In [1]: x = 'hello' |
|
2245 | 2245 | |
|
2246 | 2246 | In [2]: _ip.complete('x.l') |
|
2247 | 2247 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2248 | 2248 | """ |
|
2249 | 2249 | |
|
2250 | 2250 | # Inject names into __builtin__ so we can complete on the added names. |
|
2251 | 2251 | with self.builtin_trap: |
|
2252 | 2252 | return self.Completer.complete(text, line, cursor_pos) |
|
2253 | 2253 | |
|
2254 | 2254 | def set_custom_completer(self, completer, pos=0) -> None: |
|
2255 | 2255 | """Adds a new custom completer function. |
|
2256 | 2256 | |
|
2257 | 2257 | The position argument (defaults to 0) is the index in the completers |
|
2258 | 2258 | list where you want the completer to be inserted. |
|
2259 | 2259 | |
|
2260 | 2260 | `completer` should have the following signature:: |
|
2261 | 2261 | |
|
2262 | 2262 | def completion(self: Completer, text: string) -> List[str]: |
|
2263 | 2263 | raise NotImplementedError |
|
2264 | 2264 | |
|
2265 | 2265 | It will be bound to the current Completer instance and pass some text |
|
2266 | 2266 | and return a list with current completions to suggest to the user. |
|
2267 | 2267 | """ |
|
2268 | 2268 | |
|
2269 | 2269 | newcomp = types.MethodType(completer, self.Completer) |
|
2270 | 2270 | self.Completer.custom_matchers.insert(pos,newcomp) |
|
2271 | 2271 | |
|
2272 | 2272 | def set_completer_frame(self, frame=None): |
|
2273 | 2273 | """Set the frame of the completer.""" |
|
2274 | 2274 | if frame: |
|
2275 | 2275 | self.Completer.namespace = frame.f_locals |
|
2276 | 2276 | self.Completer.global_namespace = frame.f_globals |
|
2277 | 2277 | else: |
|
2278 | 2278 | self.Completer.namespace = self.user_ns |
|
2279 | 2279 | self.Completer.global_namespace = self.user_global_ns |
|
2280 | 2280 | |
|
2281 | 2281 | #------------------------------------------------------------------------- |
|
2282 | 2282 | # Things related to magics |
|
2283 | 2283 | #------------------------------------------------------------------------- |
|
2284 | 2284 | |
|
2285 | 2285 | def init_magics(self): |
|
2286 | 2286 | from IPython.core import magics as m |
|
2287 | 2287 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2288 | 2288 | parent=self, |
|
2289 | 2289 | user_magics=m.UserMagics(self)) |
|
2290 | 2290 | self.configurables.append(self.magics_manager) |
|
2291 | 2291 | |
|
2292 | 2292 | # Expose as public API from the magics manager |
|
2293 | 2293 | self.register_magics = self.magics_manager.register |
|
2294 | 2294 | |
|
2295 | 2295 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2296 | 2296 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2297 | 2297 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2298 | 2298 | m.NamespaceMagics, m.OSMagics, m.PackagingMagics, |
|
2299 | 2299 | m.PylabMagics, m.ScriptMagics, |
|
2300 | 2300 | ) |
|
2301 | 2301 | self.register_magics(m.AsyncMagics) |
|
2302 | 2302 | |
|
2303 | 2303 | # Register Magic Aliases |
|
2304 | 2304 | mman = self.magics_manager |
|
2305 | 2305 | # FIXME: magic aliases should be defined by the Magics classes |
|
2306 | 2306 | # or in MagicsManager, not here |
|
2307 | 2307 | mman.register_alias('ed', 'edit') |
|
2308 | 2308 | mman.register_alias('hist', 'history') |
|
2309 | 2309 | mman.register_alias('rep', 'recall') |
|
2310 | 2310 | mman.register_alias('SVG', 'svg', 'cell') |
|
2311 | 2311 | mman.register_alias('HTML', 'html', 'cell') |
|
2312 | 2312 | mman.register_alias('file', 'writefile', 'cell') |
|
2313 | 2313 | |
|
2314 | 2314 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2315 | 2315 | # should be split into a prompt manager and displayhook. We probably |
|
2316 | 2316 | # even need a centralize colors management object. |
|
2317 | 2317 | self.run_line_magic('colors', self.colors) |
|
2318 | 2318 | |
|
2319 | 2319 | # Defined here so that it's included in the documentation |
|
2320 | 2320 | @functools.wraps(magic.MagicsManager.register_function) |
|
2321 | 2321 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2322 | 2322 | self.magics_manager.register_function( |
|
2323 | 2323 | func, magic_kind=magic_kind, magic_name=magic_name |
|
2324 | 2324 | ) |
|
2325 | 2325 | |
|
2326 | 2326 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2327 | 2327 | """Execute the given line magic. |
|
2328 | 2328 | |
|
2329 | 2329 | Parameters |
|
2330 | 2330 | ---------- |
|
2331 | 2331 | magic_name : str |
|
2332 | 2332 | Name of the desired magic function, without '%' prefix. |
|
2333 | 2333 | line : str |
|
2334 | 2334 | The rest of the input line as a single string. |
|
2335 | 2335 | _stack_depth : int |
|
2336 | 2336 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2337 | 2337 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2338 | 2338 | """ |
|
2339 | 2339 | fn = self.find_line_magic(magic_name) |
|
2340 | 2340 | if fn is None: |
|
2341 | 2341 | cm = self.find_cell_magic(magic_name) |
|
2342 | 2342 | etpl = "Line magic function `%%%s` not found%s." |
|
2343 | 2343 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2344 | 2344 | 'did you mean that instead?)' % magic_name ) |
|
2345 | 2345 | raise UsageError(etpl % (magic_name, extra)) |
|
2346 | 2346 | else: |
|
2347 | 2347 | # Note: this is the distance in the stack to the user's frame. |
|
2348 | 2348 | # This will need to be updated if the internal calling logic gets |
|
2349 | 2349 | # refactored, or else we'll be expanding the wrong variables. |
|
2350 | 2350 | |
|
2351 | 2351 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2352 | 2352 | stack_depth = _stack_depth |
|
2353 | 2353 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2354 | 2354 | # magic has opted out of var_expand |
|
2355 | 2355 | magic_arg_s = line |
|
2356 | 2356 | else: |
|
2357 | 2357 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2358 | 2358 | # Put magic args in a list so we can call with f(*a) syntax |
|
2359 | 2359 | args = [magic_arg_s] |
|
2360 | 2360 | kwargs = {} |
|
2361 | 2361 | # Grab local namespace if we need it: |
|
2362 | 2362 | if getattr(fn, "needs_local_scope", False): |
|
2363 | 2363 | kwargs['local_ns'] = self.get_local_scope(stack_depth) |
|
2364 | 2364 | with self.builtin_trap: |
|
2365 | 2365 | result = fn(*args, **kwargs) |
|
2366 | 2366 | return result |
|
2367 | 2367 | |
|
2368 | 2368 | def get_local_scope(self, stack_depth): |
|
2369 | 2369 | """Get local scope at given stack depth. |
|
2370 | 2370 | |
|
2371 | 2371 | Parameters |
|
2372 | 2372 | ---------- |
|
2373 | 2373 | stack_depth : int |
|
2374 | 2374 | Depth relative to calling frame |
|
2375 | 2375 | """ |
|
2376 | 2376 | return sys._getframe(stack_depth + 1).f_locals |
|
2377 | 2377 | |
|
2378 | 2378 | def run_cell_magic(self, magic_name, line, cell): |
|
2379 | 2379 | """Execute the given cell magic. |
|
2380 | 2380 | |
|
2381 | 2381 | Parameters |
|
2382 | 2382 | ---------- |
|
2383 | 2383 | magic_name : str |
|
2384 | 2384 | Name of the desired magic function, without '%' prefix. |
|
2385 | 2385 | line : str |
|
2386 | 2386 | The rest of the first input line as a single string. |
|
2387 | 2387 | cell : str |
|
2388 | 2388 | The body of the cell as a (possibly multiline) string. |
|
2389 | 2389 | """ |
|
2390 | 2390 | fn = self.find_cell_magic(magic_name) |
|
2391 | 2391 | if fn is None: |
|
2392 | 2392 | lm = self.find_line_magic(magic_name) |
|
2393 | 2393 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2394 | 2394 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2395 | 2395 | 'did you mean that instead?)'.format(magic_name)) |
|
2396 | 2396 | raise UsageError(etpl.format(magic_name, extra)) |
|
2397 | 2397 | elif cell == '': |
|
2398 | 2398 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2399 | 2399 | if self.find_line_magic(magic_name) is not None: |
|
2400 | 2400 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2401 | 2401 | raise UsageError(message) |
|
2402 | 2402 | else: |
|
2403 | 2403 | # Note: this is the distance in the stack to the user's frame. |
|
2404 | 2404 | # This will need to be updated if the internal calling logic gets |
|
2405 | 2405 | # refactored, or else we'll be expanding the wrong variables. |
|
2406 | 2406 | stack_depth = 2 |
|
2407 | 2407 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2408 | 2408 | # magic has opted out of var_expand |
|
2409 | 2409 | magic_arg_s = line |
|
2410 | 2410 | else: |
|
2411 | 2411 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2412 | 2412 | kwargs = {} |
|
2413 | 2413 | if getattr(fn, "needs_local_scope", False): |
|
2414 | 2414 | kwargs['local_ns'] = self.user_ns |
|
2415 | 2415 | |
|
2416 | 2416 | with self.builtin_trap: |
|
2417 | 2417 | args = (magic_arg_s, cell) |
|
2418 | 2418 | result = fn(*args, **kwargs) |
|
2419 | 2419 | return result |
|
2420 | 2420 | |
|
2421 | 2421 | def find_line_magic(self, magic_name): |
|
2422 | 2422 | """Find and return a line magic by name. |
|
2423 | 2423 | |
|
2424 | 2424 | Returns None if the magic isn't found.""" |
|
2425 | 2425 | return self.magics_manager.magics['line'].get(magic_name) |
|
2426 | 2426 | |
|
2427 | 2427 | def find_cell_magic(self, magic_name): |
|
2428 | 2428 | """Find and return a cell magic by name. |
|
2429 | 2429 | |
|
2430 | 2430 | Returns None if the magic isn't found.""" |
|
2431 | 2431 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2432 | 2432 | |
|
2433 | 2433 | def find_magic(self, magic_name, magic_kind='line'): |
|
2434 | 2434 | """Find and return a magic of the given type by name. |
|
2435 | 2435 | |
|
2436 | 2436 | Returns None if the magic isn't found.""" |
|
2437 | 2437 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2438 | 2438 | |
|
2439 | 2439 | def magic(self, arg_s): |
|
2440 | 2440 | """DEPRECATED. Use run_line_magic() instead. |
|
2441 | 2441 | |
|
2442 | 2442 | Call a magic function by name. |
|
2443 | 2443 | |
|
2444 | 2444 | Input: a string containing the name of the magic function to call and |
|
2445 | 2445 | any additional arguments to be passed to the magic. |
|
2446 | 2446 | |
|
2447 | 2447 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2448 | 2448 | prompt: |
|
2449 | 2449 | |
|
2450 | 2450 | In[1]: %name -opt foo bar |
|
2451 | 2451 | |
|
2452 | 2452 | To call a magic without arguments, simply use magic('name'). |
|
2453 | 2453 | |
|
2454 | 2454 | This provides a proper Python function to call IPython's magics in any |
|
2455 | 2455 | valid Python code you can type at the interpreter, including loops and |
|
2456 | 2456 | compound statements. |
|
2457 | 2457 | """ |
|
2458 | 2458 | # TODO: should we issue a loud deprecation warning here? |
|
2459 | 2459 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2460 | 2460 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2461 | 2461 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2462 | 2462 | |
|
2463 | 2463 | #------------------------------------------------------------------------- |
|
2464 | 2464 | # Things related to macros |
|
2465 | 2465 | #------------------------------------------------------------------------- |
|
2466 | 2466 | |
|
2467 | 2467 | def define_macro(self, name, themacro): |
|
2468 | 2468 | """Define a new macro |
|
2469 | 2469 | |
|
2470 | 2470 | Parameters |
|
2471 | 2471 | ---------- |
|
2472 | 2472 | name : str |
|
2473 | 2473 | The name of the macro. |
|
2474 | 2474 | themacro : str or Macro |
|
2475 | 2475 | The action to do upon invoking the macro. If a string, a new |
|
2476 | 2476 | Macro object is created by passing the string to it. |
|
2477 | 2477 | """ |
|
2478 | 2478 | |
|
2479 | 2479 | from IPython.core import macro |
|
2480 | 2480 | |
|
2481 | 2481 | if isinstance(themacro, str): |
|
2482 | 2482 | themacro = macro.Macro(themacro) |
|
2483 | 2483 | if not isinstance(themacro, macro.Macro): |
|
2484 | 2484 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2485 | 2485 | self.user_ns[name] = themacro |
|
2486 | 2486 | |
|
2487 | 2487 | #------------------------------------------------------------------------- |
|
2488 | 2488 | # Things related to the running of system commands |
|
2489 | 2489 | #------------------------------------------------------------------------- |
|
2490 | 2490 | |
|
2491 | 2491 | def system_piped(self, cmd): |
|
2492 | 2492 | """Call the given cmd in a subprocess, piping stdout/err |
|
2493 | 2493 | |
|
2494 | 2494 | Parameters |
|
2495 | 2495 | ---------- |
|
2496 | 2496 | cmd : str |
|
2497 | 2497 | Command to execute (can not end in '&', as background processes are |
|
2498 | 2498 | not supported. Should not be a command that expects input |
|
2499 | 2499 | other than simple text. |
|
2500 | 2500 | """ |
|
2501 | 2501 | if cmd.rstrip().endswith('&'): |
|
2502 | 2502 | # this is *far* from a rigorous test |
|
2503 | 2503 | # We do not support backgrounding processes because we either use |
|
2504 | 2504 | # pexpect or pipes to read from. Users can always just call |
|
2505 | 2505 | # os.system() or use ip.system=ip.system_raw |
|
2506 | 2506 | # if they really want a background process. |
|
2507 | 2507 | raise OSError("Background processes not supported.") |
|
2508 | 2508 | |
|
2509 | 2509 | # we explicitly do NOT return the subprocess status code, because |
|
2510 | 2510 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2511 | 2511 | # Instead, we store the exit_code in user_ns. |
|
2512 | 2512 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2513 | 2513 | |
|
2514 | 2514 | def system_raw(self, cmd): |
|
2515 | 2515 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2516 | 2516 | subprocess.call using the system shell on other platforms. |
|
2517 | 2517 | |
|
2518 | 2518 | Parameters |
|
2519 | 2519 | ---------- |
|
2520 | 2520 | cmd : str |
|
2521 | 2521 | Command to execute. |
|
2522 | 2522 | """ |
|
2523 | 2523 | cmd = self.var_expand(cmd, depth=1) |
|
2524 | 2524 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2525 | 2525 | if sys.platform == 'win32': |
|
2526 | 2526 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2527 | 2527 | with AvoidUNCPath() as path: |
|
2528 | 2528 | if path is not None: |
|
2529 | 2529 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2530 | 2530 | try: |
|
2531 | 2531 | ec = os.system(cmd) |
|
2532 | 2532 | except KeyboardInterrupt: |
|
2533 | 2533 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2534 | 2534 | ec = -2 |
|
2535 | 2535 | else: |
|
2536 | 2536 | # For posix the result of the subprocess.call() below is an exit |
|
2537 | 2537 | # code, which by convention is zero for success, positive for |
|
2538 | 2538 | # program failure. Exit codes above 128 are reserved for signals, |
|
2539 | 2539 | # and the formula for converting a signal to an exit code is usually |
|
2540 | 2540 | # signal_number+128. To more easily differentiate between exit |
|
2541 | 2541 | # codes and signals, ipython uses negative numbers. For instance |
|
2542 | 2542 | # since control-c is signal 2 but exit code 130, ipython's |
|
2543 | 2543 | # _exit_code variable will read -2. Note that some shells like |
|
2544 | 2544 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2545 | 2545 | executable = os.environ.get('SHELL', None) |
|
2546 | 2546 | try: |
|
2547 | 2547 | # Use env shell instead of default /bin/sh |
|
2548 | 2548 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2549 | 2549 | except KeyboardInterrupt: |
|
2550 | 2550 | # intercept control-C; a long traceback is not useful here |
|
2551 | 2551 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2552 | 2552 | ec = 130 |
|
2553 | 2553 | if ec > 128: |
|
2554 | 2554 | ec = -(ec - 128) |
|
2555 | 2555 | |
|
2556 | 2556 | # We explicitly do NOT return the subprocess status code, because |
|
2557 | 2557 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2558 | 2558 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2559 | 2559 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2560 | 2560 | # but raising SystemExit(_exit_code) will give status 254! |
|
2561 | 2561 | self.user_ns['_exit_code'] = ec |
|
2562 | 2562 | |
|
2563 | 2563 | # use piped system by default, because it is better behaved |
|
2564 | 2564 | system = system_piped |
|
2565 | 2565 | |
|
2566 | 2566 | def getoutput(self, cmd, split=True, depth=0): |
|
2567 | 2567 | """Get output (possibly including stderr) from a subprocess. |
|
2568 | 2568 | |
|
2569 | 2569 | Parameters |
|
2570 | 2570 | ---------- |
|
2571 | 2571 | cmd : str |
|
2572 | 2572 | Command to execute (can not end in '&', as background processes are |
|
2573 | 2573 | not supported. |
|
2574 | 2574 | split : bool, optional |
|
2575 | 2575 | If True, split the output into an IPython SList. Otherwise, an |
|
2576 | 2576 | IPython LSString is returned. These are objects similar to normal |
|
2577 | 2577 | lists and strings, with a few convenience attributes for easier |
|
2578 | 2578 | manipulation of line-based output. You can use '?' on them for |
|
2579 | 2579 | details. |
|
2580 | 2580 | depth : int, optional |
|
2581 | 2581 | How many frames above the caller are the local variables which should |
|
2582 | 2582 | be expanded in the command string? The default (0) assumes that the |
|
2583 | 2583 | expansion variables are in the stack frame calling this function. |
|
2584 | 2584 | """ |
|
2585 | 2585 | if cmd.rstrip().endswith('&'): |
|
2586 | 2586 | # this is *far* from a rigorous test |
|
2587 | 2587 | raise OSError("Background processes not supported.") |
|
2588 | 2588 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2589 | 2589 | if split: |
|
2590 | 2590 | out = SList(out.splitlines()) |
|
2591 | 2591 | else: |
|
2592 | 2592 | out = LSString(out) |
|
2593 | 2593 | return out |
|
2594 | 2594 | |
|
2595 | 2595 | #------------------------------------------------------------------------- |
|
2596 | 2596 | # Things related to aliases |
|
2597 | 2597 | #------------------------------------------------------------------------- |
|
2598 | 2598 | |
|
2599 | 2599 | def init_alias(self): |
|
2600 | 2600 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2601 | 2601 | self.configurables.append(self.alias_manager) |
|
2602 | 2602 | |
|
2603 | 2603 | #------------------------------------------------------------------------- |
|
2604 | 2604 | # Things related to extensions |
|
2605 | 2605 | #------------------------------------------------------------------------- |
|
2606 | 2606 | |
|
2607 | 2607 | def init_extension_manager(self): |
|
2608 | 2608 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2609 | 2609 | self.configurables.append(self.extension_manager) |
|
2610 | 2610 | |
|
2611 | 2611 | #------------------------------------------------------------------------- |
|
2612 | 2612 | # Things related to payloads |
|
2613 | 2613 | #------------------------------------------------------------------------- |
|
2614 | 2614 | |
|
2615 | 2615 | def init_payload(self): |
|
2616 | 2616 | self.payload_manager = PayloadManager(parent=self) |
|
2617 | 2617 | self.configurables.append(self.payload_manager) |
|
2618 | 2618 | |
|
2619 | 2619 | #------------------------------------------------------------------------- |
|
2620 | 2620 | # Things related to the prefilter |
|
2621 | 2621 | #------------------------------------------------------------------------- |
|
2622 | 2622 | |
|
2623 | 2623 | def init_prefilter(self): |
|
2624 | 2624 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2625 | 2625 | self.configurables.append(self.prefilter_manager) |
|
2626 | 2626 | # Ultimately this will be refactored in the new interpreter code, but |
|
2627 | 2627 | # for now, we should expose the main prefilter method (there's legacy |
|
2628 | 2628 | # code out there that may rely on this). |
|
2629 | 2629 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2630 | 2630 | |
|
2631 | 2631 | def auto_rewrite_input(self, cmd): |
|
2632 | 2632 | """Print to the screen the rewritten form of the user's command. |
|
2633 | 2633 | |
|
2634 | 2634 | This shows visual feedback by rewriting input lines that cause |
|
2635 | 2635 | automatic calling to kick in, like:: |
|
2636 | 2636 | |
|
2637 | 2637 | /f x |
|
2638 | 2638 | |
|
2639 | 2639 | into:: |
|
2640 | 2640 | |
|
2641 | 2641 | ------> f(x) |
|
2642 | 2642 | |
|
2643 | 2643 | after the user's input prompt. This helps the user understand that the |
|
2644 | 2644 | input line was transformed automatically by IPython. |
|
2645 | 2645 | """ |
|
2646 | 2646 | if not self.show_rewritten_input: |
|
2647 | 2647 | return |
|
2648 | 2648 | |
|
2649 | 2649 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2650 | 2650 | print("------> " + cmd) |
|
2651 | 2651 | |
|
2652 | 2652 | #------------------------------------------------------------------------- |
|
2653 | 2653 | # Things related to extracting values/expressions from kernel and user_ns |
|
2654 | 2654 | #------------------------------------------------------------------------- |
|
2655 | 2655 | |
|
2656 | 2656 | def _user_obj_error(self): |
|
2657 | 2657 | """return simple exception dict |
|
2658 | 2658 | |
|
2659 | 2659 | for use in user_expressions |
|
2660 | 2660 | """ |
|
2661 | 2661 | |
|
2662 | 2662 | etype, evalue, tb = self._get_exc_info() |
|
2663 | 2663 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2664 | 2664 | |
|
2665 | 2665 | exc_info = { |
|
2666 | 2666 | "status": "error", |
|
2667 | 2667 | "traceback": stb, |
|
2668 | 2668 | "ename": etype.__name__, |
|
2669 | 2669 | "evalue": py3compat.safe_unicode(evalue), |
|
2670 | 2670 | } |
|
2671 | 2671 | |
|
2672 | 2672 | return exc_info |
|
2673 | 2673 | |
|
2674 | 2674 | def _format_user_obj(self, obj): |
|
2675 | 2675 | """format a user object to display dict |
|
2676 | 2676 | |
|
2677 | 2677 | for use in user_expressions |
|
2678 | 2678 | """ |
|
2679 | 2679 | |
|
2680 | 2680 | data, md = self.display_formatter.format(obj) |
|
2681 | 2681 | value = { |
|
2682 | 2682 | 'status' : 'ok', |
|
2683 | 2683 | 'data' : data, |
|
2684 | 2684 | 'metadata' : md, |
|
2685 | 2685 | } |
|
2686 | 2686 | return value |
|
2687 | 2687 | |
|
2688 | 2688 | def user_expressions(self, expressions): |
|
2689 | 2689 | """Evaluate a dict of expressions in the user's namespace. |
|
2690 | 2690 | |
|
2691 | 2691 | Parameters |
|
2692 | 2692 | ---------- |
|
2693 | 2693 | expressions : dict |
|
2694 | 2694 | A dict with string keys and string values. The expression values |
|
2695 | 2695 | should be valid Python expressions, each of which will be evaluated |
|
2696 | 2696 | in the user namespace. |
|
2697 | 2697 | |
|
2698 | 2698 | Returns |
|
2699 | 2699 | ------- |
|
2700 | 2700 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2701 | 2701 | display_data of each value. |
|
2702 | 2702 | """ |
|
2703 | 2703 | out = {} |
|
2704 | 2704 | user_ns = self.user_ns |
|
2705 | 2705 | global_ns = self.user_global_ns |
|
2706 | 2706 | |
|
2707 | 2707 | for key, expr in expressions.items(): |
|
2708 | 2708 | try: |
|
2709 | 2709 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2710 | 2710 | except: |
|
2711 | 2711 | value = self._user_obj_error() |
|
2712 | 2712 | out[key] = value |
|
2713 | 2713 | return out |
|
2714 | 2714 | |
|
2715 | 2715 | #------------------------------------------------------------------------- |
|
2716 | 2716 | # Things related to the running of code |
|
2717 | 2717 | #------------------------------------------------------------------------- |
|
2718 | 2718 | |
|
2719 | 2719 | def ex(self, cmd): |
|
2720 | 2720 | """Execute a normal python statement in user namespace.""" |
|
2721 | 2721 | with self.builtin_trap: |
|
2722 | 2722 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2723 | 2723 | |
|
2724 | 2724 | def ev(self, expr): |
|
2725 | 2725 | """Evaluate python expression expr in user namespace. |
|
2726 | 2726 | |
|
2727 | 2727 | Returns the result of evaluation |
|
2728 | 2728 | """ |
|
2729 | 2729 | with self.builtin_trap: |
|
2730 | 2730 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2731 | 2731 | |
|
2732 | 2732 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2733 | 2733 | """A safe version of the builtin execfile(). |
|
2734 | 2734 | |
|
2735 | 2735 | This version will never throw an exception, but instead print |
|
2736 | 2736 | helpful error messages to the screen. This only works on pure |
|
2737 | 2737 | Python files with the .py extension. |
|
2738 | 2738 | |
|
2739 | 2739 | Parameters |
|
2740 | 2740 | ---------- |
|
2741 | 2741 | fname : string |
|
2742 | 2742 | The name of the file to be executed. |
|
2743 | 2743 | where : tuple |
|
2744 | 2744 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2745 | 2745 | If only one is given, it is passed as both. |
|
2746 | 2746 | exit_ignore : bool (False) |
|
2747 | 2747 | If True, then silence SystemExit for non-zero status (it is always |
|
2748 | 2748 | silenced for zero status, as it is so common). |
|
2749 | 2749 | raise_exceptions : bool (False) |
|
2750 | 2750 | If True raise exceptions everywhere. Meant for testing. |
|
2751 | 2751 | shell_futures : bool (False) |
|
2752 | 2752 | If True, the code will share future statements with the interactive |
|
2753 | 2753 | shell. It will both be affected by previous __future__ imports, and |
|
2754 | 2754 | any __future__ imports in the code will affect the shell. If False, |
|
2755 | 2755 | __future__ imports are not shared in either direction. |
|
2756 | 2756 | |
|
2757 | 2757 | """ |
|
2758 | 2758 | fname = Path(fname).expanduser().resolve() |
|
2759 | 2759 | |
|
2760 | 2760 | # Make sure we can open the file |
|
2761 | 2761 | try: |
|
2762 | 2762 | with fname.open(): |
|
2763 | 2763 | pass |
|
2764 | 2764 | except: |
|
2765 | 2765 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2766 | 2766 | return |
|
2767 | 2767 | |
|
2768 | 2768 | # Find things also in current directory. This is needed to mimic the |
|
2769 | 2769 | # behavior of running a script from the system command line, where |
|
2770 | 2770 | # Python inserts the script's directory into sys.path |
|
2771 | 2771 | dname = str(fname.parent) |
|
2772 | 2772 | |
|
2773 | 2773 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2774 | 2774 | try: |
|
2775 | 2775 | glob, loc = (where + (None, ))[:2] |
|
2776 | 2776 | py3compat.execfile( |
|
2777 | 2777 | fname, glob, loc, |
|
2778 | 2778 | self.compile if shell_futures else None) |
|
2779 | 2779 | except SystemExit as status: |
|
2780 | 2780 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2781 | 2781 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2782 | 2782 | # these are considered normal by the OS: |
|
2783 | 2783 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2784 | 2784 | # 0 |
|
2785 | 2785 | # > python -c'import sys;sys.exit()'; echo $? |
|
2786 | 2786 | # 0 |
|
2787 | 2787 | # For other exit status, we show the exception unless |
|
2788 | 2788 | # explicitly silenced, but only in short form. |
|
2789 | 2789 | if status.code: |
|
2790 | 2790 | if raise_exceptions: |
|
2791 | 2791 | raise |
|
2792 | 2792 | if not exit_ignore: |
|
2793 | 2793 | self.showtraceback(exception_only=True) |
|
2794 | 2794 | except: |
|
2795 | 2795 | if raise_exceptions: |
|
2796 | 2796 | raise |
|
2797 | 2797 | # tb offset is 2 because we wrap execfile |
|
2798 | 2798 | self.showtraceback(tb_offset=2) |
|
2799 | 2799 | |
|
2800 | 2800 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2801 | 2801 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2802 | 2802 | |
|
2803 | 2803 | Parameters |
|
2804 | 2804 | ---------- |
|
2805 | 2805 | fname : str |
|
2806 | 2806 | The name of the file to execute. The filename must have a |
|
2807 | 2807 | .ipy or .ipynb extension. |
|
2808 | 2808 | shell_futures : bool (False) |
|
2809 | 2809 | If True, the code will share future statements with the interactive |
|
2810 | 2810 | shell. It will both be affected by previous __future__ imports, and |
|
2811 | 2811 | any __future__ imports in the code will affect the shell. If False, |
|
2812 | 2812 | __future__ imports are not shared in either direction. |
|
2813 | 2813 | raise_exceptions : bool (False) |
|
2814 | 2814 | If True raise exceptions everywhere. Meant for testing. |
|
2815 | 2815 | """ |
|
2816 | 2816 | fname = Path(fname).expanduser().resolve() |
|
2817 | 2817 | |
|
2818 | 2818 | # Make sure we can open the file |
|
2819 | 2819 | try: |
|
2820 | 2820 | with fname.open(): |
|
2821 | 2821 | pass |
|
2822 | 2822 | except: |
|
2823 | 2823 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2824 | 2824 | return |
|
2825 | 2825 | |
|
2826 | 2826 | # Find things also in current directory. This is needed to mimic the |
|
2827 | 2827 | # behavior of running a script from the system command line, where |
|
2828 | 2828 | # Python inserts the script's directory into sys.path |
|
2829 | 2829 | dname = str(fname.parent) |
|
2830 | 2830 | |
|
2831 | 2831 | def get_cells(): |
|
2832 | 2832 | """generator for sequence of code blocks to run""" |
|
2833 | 2833 | if fname.suffix == ".ipynb": |
|
2834 | 2834 | from nbformat import read |
|
2835 | 2835 | nb = read(fname, as_version=4) |
|
2836 | 2836 | if not nb.cells: |
|
2837 | 2837 | return |
|
2838 | 2838 | for cell in nb.cells: |
|
2839 | 2839 | if cell.cell_type == 'code': |
|
2840 | 2840 | yield cell.source |
|
2841 | 2841 | else: |
|
2842 | 2842 | yield fname.read_text() |
|
2843 | 2843 | |
|
2844 | 2844 | with prepended_to_syspath(dname): |
|
2845 | 2845 | try: |
|
2846 | 2846 | for cell in get_cells(): |
|
2847 | 2847 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2848 | 2848 | if raise_exceptions: |
|
2849 | 2849 | result.raise_error() |
|
2850 | 2850 | elif not result.success: |
|
2851 | 2851 | break |
|
2852 | 2852 | except: |
|
2853 | 2853 | if raise_exceptions: |
|
2854 | 2854 | raise |
|
2855 | 2855 | self.showtraceback() |
|
2856 | 2856 | warn('Unknown failure executing file: <%s>' % fname) |
|
2857 | 2857 | |
|
2858 | 2858 | def safe_run_module(self, mod_name, where): |
|
2859 | 2859 | """A safe version of runpy.run_module(). |
|
2860 | 2860 | |
|
2861 | 2861 | This version will never throw an exception, but instead print |
|
2862 | 2862 | helpful error messages to the screen. |
|
2863 | 2863 | |
|
2864 | 2864 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2865 | 2865 | |
|
2866 | 2866 | Parameters |
|
2867 | 2867 | ---------- |
|
2868 | 2868 | mod_name : string |
|
2869 | 2869 | The name of the module to be executed. |
|
2870 | 2870 | where : dict |
|
2871 | 2871 | The globals namespace. |
|
2872 | 2872 | """ |
|
2873 | 2873 | try: |
|
2874 | 2874 | try: |
|
2875 | 2875 | where.update( |
|
2876 | 2876 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2877 | 2877 | alter_sys=True) |
|
2878 | 2878 | ) |
|
2879 | 2879 | except SystemExit as status: |
|
2880 | 2880 | if status.code: |
|
2881 | 2881 | raise |
|
2882 | 2882 | except: |
|
2883 | 2883 | self.showtraceback() |
|
2884 | 2884 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2885 | 2885 | |
|
2886 | 2886 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2887 | 2887 | """Run a complete IPython cell. |
|
2888 | 2888 | |
|
2889 | 2889 | Parameters |
|
2890 | 2890 | ---------- |
|
2891 | 2891 | raw_cell : str |
|
2892 | 2892 | The code (including IPython code such as %magic functions) to run. |
|
2893 | 2893 | store_history : bool |
|
2894 | 2894 | If True, the raw and translated cell will be stored in IPython's |
|
2895 | 2895 | history. For user code calling back into IPython's machinery, this |
|
2896 | 2896 | should be set to False. |
|
2897 | 2897 | silent : bool |
|
2898 | 2898 | If True, avoid side-effects, such as implicit displayhooks and |
|
2899 | 2899 | and logging. silent=True forces store_history=False. |
|
2900 | 2900 | shell_futures : bool |
|
2901 | 2901 | If True, the code will share future statements with the interactive |
|
2902 | 2902 | shell. It will both be affected by previous __future__ imports, and |
|
2903 | 2903 | any __future__ imports in the code will affect the shell. If False, |
|
2904 | 2904 | __future__ imports are not shared in either direction. |
|
2905 | 2905 | |
|
2906 | 2906 | Returns |
|
2907 | 2907 | ------- |
|
2908 | 2908 | result : :class:`ExecutionResult` |
|
2909 | 2909 | """ |
|
2910 | 2910 | result = None |
|
2911 | 2911 | try: |
|
2912 | 2912 | result = self._run_cell( |
|
2913 | 2913 | raw_cell, store_history, silent, shell_futures) |
|
2914 | 2914 | finally: |
|
2915 | 2915 | self.events.trigger('post_execute') |
|
2916 | 2916 | if not silent: |
|
2917 | 2917 | self.events.trigger('post_run_cell', result) |
|
2918 | 2918 | return result |
|
2919 | 2919 | |
|
2920 | 2920 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool) -> ExecutionResult: |
|
2921 | 2921 | """Internal method to run a complete IPython cell.""" |
|
2922 | 2922 | |
|
2923 | 2923 | # we need to avoid calling self.transform_cell multiple time on the same thing |
|
2924 | 2924 | # so we need to store some results: |
|
2925 | 2925 | preprocessing_exc_tuple = None |
|
2926 | 2926 | try: |
|
2927 | 2927 | transformed_cell = self.transform_cell(raw_cell) |
|
2928 | 2928 | except Exception: |
|
2929 | 2929 | transformed_cell = raw_cell |
|
2930 | 2930 | preprocessing_exc_tuple = sys.exc_info() |
|
2931 | 2931 | |
|
2932 | 2932 | assert transformed_cell is not None |
|
2933 | 2933 | coro = self.run_cell_async( |
|
2934 | 2934 | raw_cell, |
|
2935 | 2935 | store_history=store_history, |
|
2936 | 2936 | silent=silent, |
|
2937 | 2937 | shell_futures=shell_futures, |
|
2938 | 2938 | transformed_cell=transformed_cell, |
|
2939 | 2939 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2940 | 2940 | ) |
|
2941 | 2941 | |
|
2942 | 2942 | # run_cell_async is async, but may not actually need an eventloop. |
|
2943 | 2943 | # when this is the case, we want to run it using the pseudo_sync_runner |
|
2944 | 2944 | # so that code can invoke eventloops (for example via the %run , and |
|
2945 | 2945 | # `%paste` magic. |
|
2946 | 2946 | if self.trio_runner: |
|
2947 | 2947 | runner = self.trio_runner |
|
2948 | 2948 | elif self.should_run_async( |
|
2949 | 2949 | raw_cell, |
|
2950 | 2950 | transformed_cell=transformed_cell, |
|
2951 | 2951 | preprocessing_exc_tuple=preprocessing_exc_tuple, |
|
2952 | 2952 | ): |
|
2953 | 2953 | runner = self.loop_runner |
|
2954 | 2954 | else: |
|
2955 | 2955 | runner = _pseudo_sync_runner |
|
2956 | 2956 | |
|
2957 | 2957 | try: |
|
2958 | 2958 | return runner(coro) |
|
2959 | 2959 | except BaseException as e: |
|
2960 | 2960 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) |
|
2961 | 2961 | result = ExecutionResult(info) |
|
2962 | 2962 | result.error_in_exec = e |
|
2963 | 2963 | self.showtraceback(running_compiled_code=True) |
|
2964 | 2964 | return result |
|
2965 | 2965 | |
|
2966 | 2966 | def should_run_async( |
|
2967 | 2967 | self, raw_cell: str, *, transformed_cell=None, preprocessing_exc_tuple=None |
|
2968 | 2968 | ) -> bool: |
|
2969 | 2969 | """Return whether a cell should be run asynchronously via a coroutine runner |
|
2970 | 2970 | |
|
2971 | 2971 | Parameters |
|
2972 | 2972 | ---------- |
|
2973 | 2973 | raw_cell: str |
|
2974 | 2974 | The code to be executed |
|
2975 | 2975 | |
|
2976 | 2976 | Returns |
|
2977 | 2977 | ------- |
|
2978 | 2978 | result: bool |
|
2979 | 2979 | Whether the code needs to be run with a coroutine runner or not |
|
2980 | 2980 | |
|
2981 | 2981 | .. versionadded: 7.0 |
|
2982 | 2982 | """ |
|
2983 | 2983 | if not self.autoawait: |
|
2984 | 2984 | return False |
|
2985 | 2985 | if preprocessing_exc_tuple is not None: |
|
2986 | 2986 | return False |
|
2987 | 2987 | assert preprocessing_exc_tuple is None |
|
2988 | 2988 | if transformed_cell is None: |
|
2989 | 2989 | warnings.warn( |
|
2990 | 2990 | "`should_run_async` will not call `transform_cell`" |
|
2991 | 2991 | " automatically in the future. Please pass the result to" |
|
2992 | 2992 | " `transformed_cell` argument and any exception that happen" |
|
2993 | 2993 | " during the" |
|
2994 | 2994 | "transform in `preprocessing_exc_tuple` in" |
|
2995 | 2995 | " IPython 7.17 and above.", |
|
2996 | 2996 | DeprecationWarning, |
|
2997 | 2997 | stacklevel=2, |
|
2998 | 2998 | ) |
|
2999 | 2999 | try: |
|
3000 | 3000 | cell = self.transform_cell(raw_cell) |
|
3001 | 3001 | except Exception: |
|
3002 | 3002 | # any exception during transform will be raised |
|
3003 | 3003 | # prior to execution |
|
3004 | 3004 | return False |
|
3005 | 3005 | else: |
|
3006 | 3006 | cell = transformed_cell |
|
3007 | 3007 | return _should_be_async(cell) |
|
3008 | 3008 | |
|
3009 | 3009 | async def run_cell_async( |
|
3010 | 3010 | self, |
|
3011 | 3011 | raw_cell: str, |
|
3012 | 3012 | store_history=False, |
|
3013 | 3013 | silent=False, |
|
3014 | 3014 | shell_futures=True, |
|
3015 | 3015 | *, |
|
3016 | 3016 | transformed_cell: Optional[str] = None, |
|
3017 | 3017 | preprocessing_exc_tuple: Optional[Any] = None |
|
3018 | 3018 | ) -> ExecutionResult: |
|
3019 | 3019 | """Run a complete IPython cell asynchronously. |
|
3020 | 3020 | |
|
3021 | 3021 | Parameters |
|
3022 | 3022 | ---------- |
|
3023 | 3023 | raw_cell : str |
|
3024 | 3024 | The code (including IPython code such as %magic functions) to run. |
|
3025 | 3025 | store_history : bool |
|
3026 | 3026 | If True, the raw and translated cell will be stored in IPython's |
|
3027 | 3027 | history. For user code calling back into IPython's machinery, this |
|
3028 | 3028 | should be set to False. |
|
3029 | 3029 | silent : bool |
|
3030 | 3030 | If True, avoid side-effects, such as implicit displayhooks and |
|
3031 | 3031 | and logging. silent=True forces store_history=False. |
|
3032 | 3032 | shell_futures : bool |
|
3033 | 3033 | If True, the code will share future statements with the interactive |
|
3034 | 3034 | shell. It will both be affected by previous __future__ imports, and |
|
3035 | 3035 | any __future__ imports in the code will affect the shell. If False, |
|
3036 | 3036 | __future__ imports are not shared in either direction. |
|
3037 | 3037 | transformed_cell: str |
|
3038 | 3038 | cell that was passed through transformers |
|
3039 | 3039 | preprocessing_exc_tuple: |
|
3040 | 3040 | trace if the transformation failed. |
|
3041 | 3041 | |
|
3042 | 3042 | Returns |
|
3043 | 3043 | ------- |
|
3044 | 3044 | result : :class:`ExecutionResult` |
|
3045 | 3045 | |
|
3046 | 3046 | .. versionadded: 7.0 |
|
3047 | 3047 | """ |
|
3048 | 3048 | info = ExecutionInfo( |
|
3049 | 3049 | raw_cell, store_history, silent, shell_futures) |
|
3050 | 3050 | result = ExecutionResult(info) |
|
3051 | 3051 | |
|
3052 | 3052 | if (not raw_cell) or raw_cell.isspace(): |
|
3053 | 3053 | self.last_execution_succeeded = True |
|
3054 | 3054 | self.last_execution_result = result |
|
3055 | 3055 | return result |
|
3056 | 3056 | |
|
3057 | 3057 | if silent: |
|
3058 | 3058 | store_history = False |
|
3059 | 3059 | |
|
3060 | 3060 | if store_history: |
|
3061 | 3061 | result.execution_count = self.execution_count |
|
3062 | 3062 | |
|
3063 | 3063 | def error_before_exec(value): |
|
3064 | 3064 | if store_history: |
|
3065 | 3065 | self.execution_count += 1 |
|
3066 | 3066 | result.error_before_exec = value |
|
3067 | 3067 | self.last_execution_succeeded = False |
|
3068 | 3068 | self.last_execution_result = result |
|
3069 | 3069 | return result |
|
3070 | 3070 | |
|
3071 | 3071 | self.events.trigger('pre_execute') |
|
3072 | 3072 | if not silent: |
|
3073 | 3073 | self.events.trigger('pre_run_cell', info) |
|
3074 | 3074 | |
|
3075 | 3075 | if transformed_cell is None: |
|
3076 | 3076 | warnings.warn( |
|
3077 | 3077 | "`run_cell_async` will not call `transform_cell`" |
|
3078 | 3078 | " automatically in the future. Please pass the result to" |
|
3079 | 3079 | " `transformed_cell` argument and any exception that happen" |
|
3080 | 3080 | " during the" |
|
3081 | 3081 | "transform in `preprocessing_exc_tuple` in" |
|
3082 | 3082 | " IPython 7.17 and above.", |
|
3083 | 3083 | DeprecationWarning, |
|
3084 | 3084 | stacklevel=2, |
|
3085 | 3085 | ) |
|
3086 | 3086 | # If any of our input transformation (input_transformer_manager or |
|
3087 | 3087 | # prefilter_manager) raises an exception, we store it in this variable |
|
3088 | 3088 | # so that we can display the error after logging the input and storing |
|
3089 | 3089 | # it in the history. |
|
3090 | 3090 | try: |
|
3091 | 3091 | cell = self.transform_cell(raw_cell) |
|
3092 | 3092 | except Exception: |
|
3093 | 3093 | preprocessing_exc_tuple = sys.exc_info() |
|
3094 | 3094 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
3095 | 3095 | else: |
|
3096 | 3096 | preprocessing_exc_tuple = None |
|
3097 | 3097 | else: |
|
3098 | 3098 | if preprocessing_exc_tuple is None: |
|
3099 | 3099 | cell = transformed_cell |
|
3100 | 3100 | else: |
|
3101 | 3101 | cell = raw_cell |
|
3102 | 3102 | |
|
3103 | 3103 | # Store raw and processed history |
|
3104 | 3104 | if store_history: |
|
3105 | 3105 | self.history_manager.store_inputs(self.execution_count, |
|
3106 | 3106 | cell, raw_cell) |
|
3107 | 3107 | if not silent: |
|
3108 | 3108 | self.logger.log(cell, raw_cell) |
|
3109 | 3109 | |
|
3110 | 3110 | # Display the exception if input processing failed. |
|
3111 | 3111 | if preprocessing_exc_tuple is not None: |
|
3112 | 3112 | self.showtraceback(preprocessing_exc_tuple) |
|
3113 | 3113 | if store_history: |
|
3114 | 3114 | self.execution_count += 1 |
|
3115 | 3115 | return error_before_exec(preprocessing_exc_tuple[1]) |
|
3116 | 3116 | |
|
3117 | 3117 | # Our own compiler remembers the __future__ environment. If we want to |
|
3118 | 3118 | # run code with a separate __future__ environment, use the default |
|
3119 | 3119 | # compiler |
|
3120 | 3120 | compiler = self.compile if shell_futures else self.compiler_class() |
|
3121 | 3121 | |
|
3122 | 3122 | _run_async = False |
|
3123 | 3123 | |
|
3124 | 3124 | with self.builtin_trap: |
|
3125 | 3125 | cell_name = self.compile.cache( |
|
3126 | 3126 | cell, self.execution_count, raw_code=raw_cell |
|
3127 | 3127 | ) |
|
3128 | 3128 | |
|
3129 | 3129 | with self.display_trap: |
|
3130 | 3130 | # Compile to bytecode |
|
3131 | 3131 | try: |
|
3132 | 3132 | if sys.version_info < (3,8) and self.autoawait: |
|
3133 | 3133 | if _should_be_async(cell): |
|
3134 | 3134 | # the code AST below will not be user code: we wrap it |
|
3135 | 3135 | # in an `async def`. This will likely make some AST |
|
3136 | 3136 | # transformer below miss some transform opportunity and |
|
3137 | 3137 | # introduce a small coupling to run_code (in which we |
|
3138 | 3138 | # bake some assumptions of what _ast_asyncify returns. |
|
3139 | 3139 | # they are ways around (like grafting part of the ast |
|
3140 | 3140 | # later: |
|
3141 | 3141 | # - Here, return code_ast.body[0].body[1:-1], as well |
|
3142 | 3142 | # as last expression in return statement which is |
|
3143 | 3143 | # the user code part. |
|
3144 | 3144 | # - Let it go through the AST transformers, and graft |
|
3145 | 3145 | # - it back after the AST transform |
|
3146 | 3146 | # But that seem unreasonable, at least while we |
|
3147 | 3147 | # do not need it. |
|
3148 | 3148 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') |
|
3149 | 3149 | _run_async = True |
|
3150 | 3150 | else: |
|
3151 | 3151 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3152 | 3152 | else: |
|
3153 | 3153 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3154 | 3154 | except self.custom_exceptions as e: |
|
3155 | 3155 | etype, value, tb = sys.exc_info() |
|
3156 | 3156 | self.CustomTB(etype, value, tb) |
|
3157 | 3157 | return error_before_exec(e) |
|
3158 | 3158 | except IndentationError as e: |
|
3159 | 3159 | self.showindentationerror() |
|
3160 | 3160 | return error_before_exec(e) |
|
3161 | 3161 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
3162 | 3162 | MemoryError) as e: |
|
3163 | 3163 | self.showsyntaxerror() |
|
3164 | 3164 | return error_before_exec(e) |
|
3165 | 3165 | |
|
3166 | 3166 | # Apply AST transformations |
|
3167 | 3167 | try: |
|
3168 | 3168 | code_ast = self.transform_ast(code_ast) |
|
3169 | 3169 | except InputRejected as e: |
|
3170 | 3170 | self.showtraceback() |
|
3171 | 3171 | return error_before_exec(e) |
|
3172 | 3172 | |
|
3173 | 3173 | # Give the displayhook a reference to our ExecutionResult so it |
|
3174 | 3174 | # can fill in the output value. |
|
3175 | 3175 | self.displayhook.exec_result = result |
|
3176 | 3176 | |
|
3177 | 3177 | # Execute the user code |
|
3178 | 3178 | interactivity = "none" if silent else self.ast_node_interactivity |
|
3179 | 3179 | if _run_async: |
|
3180 | 3180 | interactivity = 'async' |
|
3181 | 3181 | |
|
3182 | 3182 | has_raised = await self.run_ast_nodes(code_ast.body, cell_name, |
|
3183 | 3183 | interactivity=interactivity, compiler=compiler, result=result) |
|
3184 | 3184 | |
|
3185 | 3185 | self.last_execution_succeeded = not has_raised |
|
3186 | 3186 | self.last_execution_result = result |
|
3187 | 3187 | |
|
3188 | 3188 | # Reset this so later displayed values do not modify the |
|
3189 | 3189 | # ExecutionResult |
|
3190 | 3190 | self.displayhook.exec_result = None |
|
3191 | 3191 | |
|
3192 | 3192 | if store_history: |
|
3193 | 3193 | # Write output to the database. Does nothing unless |
|
3194 | 3194 | # history output logging is enabled. |
|
3195 | 3195 | self.history_manager.store_output(self.execution_count) |
|
3196 | 3196 | # Each cell is a *single* input, regardless of how many lines it has |
|
3197 | 3197 | self.execution_count += 1 |
|
3198 | 3198 | |
|
3199 | 3199 | return result |
|
3200 | 3200 | |
|
3201 | 3201 | def transform_cell(self, raw_cell): |
|
3202 | 3202 | """Transform an input cell before parsing it. |
|
3203 | 3203 | |
|
3204 | 3204 | Static transformations, implemented in IPython.core.inputtransformer2, |
|
3205 | 3205 | deal with things like ``%magic`` and ``!system`` commands. |
|
3206 | 3206 | These run on all input. |
|
3207 | 3207 | Dynamic transformations, for things like unescaped magics and the exit |
|
3208 | 3208 | autocall, depend on the state of the interpreter. |
|
3209 | 3209 | These only apply to single line inputs. |
|
3210 | 3210 | |
|
3211 | 3211 | These string-based transformations are followed by AST transformations; |
|
3212 | 3212 | see :meth:`transform_ast`. |
|
3213 | 3213 | """ |
|
3214 | 3214 | # Static input transformations |
|
3215 | 3215 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
3216 | 3216 | |
|
3217 | 3217 | if len(cell.splitlines()) == 1: |
|
3218 | 3218 | # Dynamic transformations - only applied for single line commands |
|
3219 | 3219 | with self.builtin_trap: |
|
3220 | 3220 | # use prefilter_lines to handle trailing newlines |
|
3221 | 3221 | # restore trailing newline for ast.parse |
|
3222 | 3222 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
3223 | 3223 | |
|
3224 | 3224 | lines = cell.splitlines(keepends=True) |
|
3225 | 3225 | for transform in self.input_transformers_post: |
|
3226 | 3226 | lines = transform(lines) |
|
3227 | 3227 | cell = ''.join(lines) |
|
3228 | 3228 | |
|
3229 | 3229 | return cell |
|
3230 | 3230 | |
|
3231 | 3231 | def transform_ast(self, node): |
|
3232 | 3232 | """Apply the AST transformations from self.ast_transformers |
|
3233 | 3233 | |
|
3234 | 3234 | Parameters |
|
3235 | 3235 | ---------- |
|
3236 | 3236 | node : ast.Node |
|
3237 | 3237 | The root node to be transformed. Typically called with the ast.Module |
|
3238 | 3238 | produced by parsing user input. |
|
3239 | 3239 | |
|
3240 | 3240 | Returns |
|
3241 | 3241 | ------- |
|
3242 | 3242 | An ast.Node corresponding to the node it was called with. Note that it |
|
3243 | 3243 | may also modify the passed object, so don't rely on references to the |
|
3244 | 3244 | original AST. |
|
3245 | 3245 | """ |
|
3246 | 3246 | for transformer in self.ast_transformers: |
|
3247 | 3247 | try: |
|
3248 | 3248 | node = transformer.visit(node) |
|
3249 | 3249 | except InputRejected: |
|
3250 | 3250 | # User-supplied AST transformers can reject an input by raising |
|
3251 | 3251 | # an InputRejected. Short-circuit in this case so that we |
|
3252 | 3252 | # don't unregister the transform. |
|
3253 | 3253 | raise |
|
3254 | 3254 | except Exception: |
|
3255 | 3255 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
3256 | 3256 | self.ast_transformers.remove(transformer) |
|
3257 | 3257 | |
|
3258 | 3258 | if self.ast_transformers: |
|
3259 | 3259 | ast.fix_missing_locations(node) |
|
3260 | 3260 | return node |
|
3261 | 3261 | |
|
3262 | 3262 | async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
3263 | 3263 | compiler=compile, result=None): |
|
3264 | 3264 | """Run a sequence of AST nodes. The execution mode depends on the |
|
3265 | 3265 | interactivity parameter. |
|
3266 | 3266 | |
|
3267 | 3267 | Parameters |
|
3268 | 3268 | ---------- |
|
3269 | 3269 | nodelist : list |
|
3270 | 3270 | A sequence of AST nodes to run. |
|
3271 | 3271 | cell_name : str |
|
3272 | 3272 | Will be passed to the compiler as the filename of the cell. Typically |
|
3273 | 3273 | the value returned by ip.compile.cache(cell). |
|
3274 | 3274 | interactivity : str |
|
3275 | 3275 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
3276 | 3276 | specifying which nodes should be run interactively (displaying output |
|
3277 | 3277 | from expressions). 'last_expr' will run the last node interactively |
|
3278 | 3278 | only if it is an expression (i.e. expressions in loops or other blocks |
|
3279 | 3279 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
3280 | 3280 | or the last assignment. Other values for this parameter will raise a |
|
3281 | 3281 | ValueError. |
|
3282 | 3282 | |
|
3283 | 3283 | Experimental value: 'async' Will try to run top level interactive |
|
3284 | 3284 | async/await code in default runner, this will not respect the |
|
3285 | 3285 | interactivity setting and will only run the last node if it is an |
|
3286 | 3286 | expression. |
|
3287 | 3287 | |
|
3288 | 3288 | compiler : callable |
|
3289 | 3289 | A function with the same interface as the built-in compile(), to turn |
|
3290 | 3290 | the AST nodes into code objects. Default is the built-in compile(). |
|
3291 | 3291 | result : ExecutionResult, optional |
|
3292 | 3292 | An object to store exceptions that occur during execution. |
|
3293 | 3293 | |
|
3294 | 3294 | Returns |
|
3295 | 3295 | ------- |
|
3296 | 3296 | True if an exception occurred while running code, False if it finished |
|
3297 | 3297 | running. |
|
3298 | 3298 | """ |
|
3299 | 3299 | if not nodelist: |
|
3300 | 3300 | return |
|
3301 | 3301 | |
|
3302 | 3302 | if interactivity == 'last_expr_or_assign': |
|
3303 | 3303 | if isinstance(nodelist[-1], _assign_nodes): |
|
3304 | 3304 | asg = nodelist[-1] |
|
3305 | 3305 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
3306 | 3306 | target = asg.targets[0] |
|
3307 | 3307 | elif isinstance(asg, _single_targets_nodes): |
|
3308 | 3308 | target = asg.target |
|
3309 | 3309 | else: |
|
3310 | 3310 | target = None |
|
3311 | 3311 | if isinstance(target, ast.Name): |
|
3312 | 3312 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
3313 | 3313 | ast.fix_missing_locations(nnode) |
|
3314 | 3314 | nodelist.append(nnode) |
|
3315 | 3315 | interactivity = 'last_expr' |
|
3316 | 3316 | |
|
3317 | 3317 | _async = False |
|
3318 | 3318 | if interactivity == 'last_expr': |
|
3319 | 3319 | if isinstance(nodelist[-1], ast.Expr): |
|
3320 | 3320 | interactivity = "last" |
|
3321 | 3321 | else: |
|
3322 | 3322 | interactivity = "none" |
|
3323 | 3323 | |
|
3324 | 3324 | if interactivity == 'none': |
|
3325 | 3325 | to_run_exec, to_run_interactive = nodelist, [] |
|
3326 | 3326 | elif interactivity == 'last': |
|
3327 | 3327 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
3328 | 3328 | elif interactivity == 'all': |
|
3329 | 3329 | to_run_exec, to_run_interactive = [], nodelist |
|
3330 | 3330 | elif interactivity == 'async': |
|
3331 | 3331 | to_run_exec, to_run_interactive = [], nodelist |
|
3332 | 3332 | _async = True |
|
3333 | 3333 | else: |
|
3334 | 3334 | raise ValueError("Interactivity was %r" % interactivity) |
|
3335 | 3335 | |
|
3336 | 3336 | try: |
|
3337 | 3337 | if _async and sys.version_info > (3,8): |
|
3338 | 3338 | raise ValueError("This branch should never happen on Python 3.8 and above, " |
|
3339 | 3339 | "please try to upgrade IPython and open a bug report with your case.") |
|
3340 | 3340 | if _async: |
|
3341 | 3341 | # If interactivity is async the semantics of run_code are |
|
3342 | 3342 | # completely different Skip usual machinery. |
|
3343 | 3343 | mod = Module(nodelist, []) |
|
3344 | 3344 | async_wrapper_code = compiler(mod, cell_name, 'exec') |
|
3345 | 3345 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) |
|
3346 | 3346 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ |
|
3347 | 3347 | if (await self.run_code(async_code, result, async_=True)): |
|
3348 | 3348 | return True |
|
3349 | 3349 | else: |
|
3350 | 3350 | if sys.version_info > (3, 8): |
|
3351 | 3351 | def compare(code): |
|
3352 | 3352 | is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE) |
|
3353 | 3353 | return is_async |
|
3354 | 3354 | else: |
|
3355 | 3355 | def compare(code): |
|
3356 | 3356 | return _async |
|
3357 | 3357 | |
|
3358 | 3358 | # refactor that to just change the mod constructor. |
|
3359 | 3359 | to_run = [] |
|
3360 | 3360 | for node in to_run_exec: |
|
3361 | 3361 | to_run.append((node, 'exec')) |
|
3362 | 3362 | |
|
3363 | 3363 | for node in to_run_interactive: |
|
3364 | 3364 | to_run.append((node, 'single')) |
|
3365 | 3365 | |
|
3366 | 3366 | for node,mode in to_run: |
|
3367 | 3367 | if mode == 'exec': |
|
3368 | 3368 | mod = Module([node], []) |
|
3369 | 3369 | elif mode == 'single': |
|
3370 | 3370 | mod = ast.Interactive([node]) |
|
3371 | 3371 | with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0): |
|
3372 | 3372 | code = compiler(mod, cell_name, mode) |
|
3373 | 3373 | asy = compare(code) |
|
3374 | 3374 | if (await self.run_code(code, result, async_=asy)): |
|
3375 | 3375 | return True |
|
3376 | 3376 | |
|
3377 | 3377 | # Flush softspace |
|
3378 | 3378 | if softspace(sys.stdout, 0): |
|
3379 | 3379 | print() |
|
3380 | 3380 | |
|
3381 | 3381 | except: |
|
3382 | 3382 | # It's possible to have exceptions raised here, typically by |
|
3383 | 3383 | # compilation of odd code (such as a naked 'return' outside a |
|
3384 | 3384 | # function) that did parse but isn't valid. Typically the exception |
|
3385 | 3385 | # is a SyntaxError, but it's safest just to catch anything and show |
|
3386 | 3386 | # the user a traceback. |
|
3387 | 3387 | |
|
3388 | 3388 | # We do only one try/except outside the loop to minimize the impact |
|
3389 | 3389 | # on runtime, and also because if any node in the node list is |
|
3390 | 3390 | # broken, we should stop execution completely. |
|
3391 | 3391 | if result: |
|
3392 | 3392 | result.error_before_exec = sys.exc_info()[1] |
|
3393 | 3393 | self.showtraceback() |
|
3394 | 3394 | return True |
|
3395 | 3395 | |
|
3396 | 3396 | return False |
|
3397 | 3397 | |
|
3398 | 3398 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): |
|
3399 | 3399 | """ |
|
3400 | 3400 | Evaluate an asynchronous code object using a code runner |
|
3401 | 3401 | |
|
3402 | 3402 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. |
|
3403 | 3403 | |
|
3404 | 3404 | Returns coroutine object, which can be executed via async loop runner |
|
3405 | 3405 | |
|
3406 | 3406 | WARNING: The semantics of `async_exec` are quite different from `exec`, |
|
3407 | 3407 | in particular you can only pass a single namespace. It also return a |
|
3408 | 3408 | handle to the value of the last things returned by code_object. |
|
3409 | 3409 | """ |
|
3410 | 3410 | |
|
3411 | 3411 | return eval(code_obj, user_ns) |
|
3412 | 3412 | |
|
3413 | 3413 | async def run_code(self, code_obj, result=None, *, async_=False): |
|
3414 | 3414 | """Execute a code object. |
|
3415 | 3415 | |
|
3416 | 3416 | When an exception occurs, self.showtraceback() is called to display a |
|
3417 | 3417 | traceback. |
|
3418 | 3418 | |
|
3419 | 3419 | Parameters |
|
3420 | 3420 | ---------- |
|
3421 | 3421 | code_obj : code object |
|
3422 | 3422 | A compiled code object, to be executed |
|
3423 | 3423 | result : ExecutionResult, optional |
|
3424 | 3424 | An object to store exceptions that occur during execution. |
|
3425 | 3425 | async_ : Bool (Experimental) |
|
3426 | 3426 | Attempt to run top-level asynchronous code in a default loop. |
|
3427 | 3427 | |
|
3428 | 3428 | Returns |
|
3429 | 3429 | ------- |
|
3430 | 3430 | False : successful execution. |
|
3431 | 3431 | True : an error occurred. |
|
3432 | 3432 | """ |
|
3433 | 3433 | # special value to say that anything above is IPython and should be |
|
3434 | 3434 | # hidden. |
|
3435 | 3435 | __tracebackhide__ = "__ipython_bottom__" |
|
3436 | 3436 | # Set our own excepthook in case the user code tries to call it |
|
3437 | 3437 | # directly, so that the IPython crash handler doesn't get triggered |
|
3438 | 3438 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
3439 | 3439 | |
|
3440 | 3440 | # we save the original sys.excepthook in the instance, in case config |
|
3441 | 3441 | # code (such as magics) needs access to it. |
|
3442 | 3442 | self.sys_excepthook = old_excepthook |
|
3443 | 3443 | outflag = True # happens in more places, so it's easier as default |
|
3444 | 3444 | try: |
|
3445 | 3445 | try: |
|
3446 | 3446 | self.hooks.pre_run_code_hook() |
|
3447 | 3447 | if async_ and sys.version_info < (3,8): |
|
3448 | 3448 | last_expr = (await self._async_exec(code_obj, self.user_ns)) |
|
3449 | 3449 | code = compile('last_expr', 'fake', "single") |
|
3450 | 3450 | exec(code, {'last_expr': last_expr}) |
|
3451 | 3451 | elif async_ : |
|
3452 | 3452 | await eval(code_obj, self.user_global_ns, self.user_ns) |
|
3453 | 3453 | else: |
|
3454 | 3454 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
3455 | 3455 | finally: |
|
3456 | 3456 | # Reset our crash handler in place |
|
3457 | 3457 | sys.excepthook = old_excepthook |
|
3458 | 3458 | except SystemExit as e: |
|
3459 | 3459 | if result is not None: |
|
3460 | 3460 | result.error_in_exec = e |
|
3461 | 3461 | self.showtraceback(exception_only=True) |
|
3462 | 3462 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
3463 | 3463 | except self.custom_exceptions: |
|
3464 | 3464 | etype, value, tb = sys.exc_info() |
|
3465 | 3465 | if result is not None: |
|
3466 | 3466 | result.error_in_exec = value |
|
3467 | 3467 | self.CustomTB(etype, value, tb) |
|
3468 | 3468 | except: |
|
3469 | 3469 | if result is not None: |
|
3470 | 3470 | result.error_in_exec = sys.exc_info()[1] |
|
3471 | 3471 | self.showtraceback(running_compiled_code=True) |
|
3472 | 3472 | else: |
|
3473 | 3473 | outflag = False |
|
3474 | 3474 | return outflag |
|
3475 | 3475 | |
|
3476 | 3476 | # For backwards compatibility |
|
3477 | 3477 | runcode = run_code |
|
3478 | 3478 | |
|
3479 | 3479 | def check_complete(self, code: str) -> Tuple[str, str]: |
|
3480 | 3480 | """Return whether a block of code is ready to execute, or should be continued |
|
3481 | 3481 | |
|
3482 | 3482 | Parameters |
|
3483 | 3483 | ---------- |
|
3484 | 3484 | source : string |
|
3485 | 3485 | Python input code, which can be multiline. |
|
3486 | 3486 | |
|
3487 | 3487 | Returns |
|
3488 | 3488 | ------- |
|
3489 | 3489 | status : str |
|
3490 | 3490 | One of 'complete', 'incomplete', or 'invalid' if source is not a |
|
3491 | 3491 | prefix of valid code. |
|
3492 | 3492 | indent : str |
|
3493 | 3493 | When status is 'incomplete', this is some whitespace to insert on |
|
3494 | 3494 | the next line of the prompt. |
|
3495 | 3495 | """ |
|
3496 | 3496 | status, nspaces = self.input_transformer_manager.check_complete(code) |
|
3497 | 3497 | return status, ' ' * (nspaces or 0) |
|
3498 | 3498 | |
|
3499 | 3499 | #------------------------------------------------------------------------- |
|
3500 | 3500 | # Things related to GUI support and pylab |
|
3501 | 3501 | #------------------------------------------------------------------------- |
|
3502 | 3502 | |
|
3503 | 3503 | active_eventloop = None |
|
3504 | 3504 | |
|
3505 | 3505 | def enable_gui(self, gui=None): |
|
3506 | 3506 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
3507 | 3507 | |
|
3508 | 3508 | def enable_matplotlib(self, gui=None): |
|
3509 | 3509 | """Enable interactive matplotlib and inline figure support. |
|
3510 | 3510 | |
|
3511 | 3511 | This takes the following steps: |
|
3512 | 3512 | |
|
3513 | 3513 | 1. select the appropriate eventloop and matplotlib backend |
|
3514 | 3514 | 2. set up matplotlib for interactive use with that backend |
|
3515 | 3515 | 3. configure formatters for inline figure display |
|
3516 | 3516 | 4. enable the selected gui eventloop |
|
3517 | 3517 | |
|
3518 | 3518 | Parameters |
|
3519 | 3519 | ---------- |
|
3520 | 3520 | gui : optional, string |
|
3521 | 3521 | If given, dictates the choice of matplotlib GUI backend to use |
|
3522 | 3522 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3523 | 3523 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3524 | 3524 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3525 | 3525 | user's matplotlibrc configuration file). Note that not all backends |
|
3526 | 3526 | make sense in all contexts, for example a terminal ipython can't |
|
3527 | 3527 | display figures inline. |
|
3528 | 3528 | """ |
|
3529 | 3529 | from IPython.core import pylabtools as pt |
|
3530 | from matplotlib_inline.backend_inline import configure_inline_support | |
|
3530 | 3531 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3531 | 3532 | |
|
3532 | 3533 | if gui != 'inline': |
|
3533 | 3534 | # If we have our first gui selection, store it |
|
3534 | 3535 | if self.pylab_gui_select is None: |
|
3535 | 3536 | self.pylab_gui_select = gui |
|
3536 | 3537 | # Otherwise if they are different |
|
3537 | 3538 | elif gui != self.pylab_gui_select: |
|
3538 | 3539 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3539 | 3540 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3540 | 3541 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3541 | 3542 | |
|
3542 | 3543 | pt.activate_matplotlib(backend) |
|
3543 |
|
|
|
3544 | configure_inline_support(self, backend) | |
|
3544 | 3545 | |
|
3545 | 3546 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3546 | 3547 | # plot updates into account |
|
3547 | 3548 | self.enable_gui(gui) |
|
3548 | 3549 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3549 | 3550 | pt.mpl_runner(self.safe_execfile) |
|
3550 | 3551 | |
|
3551 | 3552 | return gui, backend |
|
3552 | 3553 | |
|
3553 | 3554 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3554 | 3555 | """Activate pylab support at runtime. |
|
3555 | 3556 | |
|
3556 | 3557 | This turns on support for matplotlib, preloads into the interactive |
|
3557 | 3558 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3558 | 3559 | interact with the GUI event loop. The GUI backend to be used can be |
|
3559 | 3560 | optionally selected with the optional ``gui`` argument. |
|
3560 | 3561 | |
|
3561 | 3562 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3562 | 3563 | |
|
3563 | 3564 | Parameters |
|
3564 | 3565 | ---------- |
|
3565 | 3566 | gui : optional, string |
|
3566 | 3567 | If given, dictates the choice of matplotlib GUI backend to use |
|
3567 | 3568 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3568 | 3569 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3569 | 3570 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3570 | 3571 | user's matplotlibrc configuration file). Note that not all backends |
|
3571 | 3572 | make sense in all contexts, for example a terminal ipython can't |
|
3572 | 3573 | display figures inline. |
|
3573 | 3574 | import_all : optional, bool, default: True |
|
3574 | 3575 | Whether to do `from numpy import *` and `from pylab import *` |
|
3575 | 3576 | in addition to module imports. |
|
3576 | 3577 | welcome_message : deprecated |
|
3577 | 3578 | This argument is ignored, no welcome message will be displayed. |
|
3578 | 3579 | """ |
|
3579 | 3580 | from IPython.core.pylabtools import import_pylab |
|
3580 | 3581 | |
|
3581 | 3582 | gui, backend = self.enable_matplotlib(gui) |
|
3582 | 3583 | |
|
3583 | 3584 | # We want to prevent the loading of pylab to pollute the user's |
|
3584 | 3585 | # namespace as shown by the %who* magics, so we execute the activation |
|
3585 | 3586 | # code in an empty namespace, and we update *both* user_ns and |
|
3586 | 3587 | # user_ns_hidden with this information. |
|
3587 | 3588 | ns = {} |
|
3588 | 3589 | import_pylab(ns, import_all) |
|
3589 | 3590 | # warn about clobbered names |
|
3590 | 3591 | ignored = {"__builtins__"} |
|
3591 | 3592 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3592 | 3593 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3593 | 3594 | self.user_ns.update(ns) |
|
3594 | 3595 | self.user_ns_hidden.update(ns) |
|
3595 | 3596 | return gui, backend, clobbered |
|
3596 | 3597 | |
|
3597 | 3598 | #------------------------------------------------------------------------- |
|
3598 | 3599 | # Utilities |
|
3599 | 3600 | #------------------------------------------------------------------------- |
|
3600 | 3601 | |
|
3601 | 3602 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3602 | 3603 | """Expand python variables in a string. |
|
3603 | 3604 | |
|
3604 | 3605 | The depth argument indicates how many frames above the caller should |
|
3605 | 3606 | be walked to look for the local namespace where to expand variables. |
|
3606 | 3607 | |
|
3607 | 3608 | The global namespace for expansion is always the user's interactive |
|
3608 | 3609 | namespace. |
|
3609 | 3610 | """ |
|
3610 | 3611 | ns = self.user_ns.copy() |
|
3611 | 3612 | try: |
|
3612 | 3613 | frame = sys._getframe(depth+1) |
|
3613 | 3614 | except ValueError: |
|
3614 | 3615 | # This is thrown if there aren't that many frames on the stack, |
|
3615 | 3616 | # e.g. if a script called run_line_magic() directly. |
|
3616 | 3617 | pass |
|
3617 | 3618 | else: |
|
3618 | 3619 | ns.update(frame.f_locals) |
|
3619 | 3620 | |
|
3620 | 3621 | try: |
|
3621 | 3622 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3622 | 3623 | # name, and expanding **ns for .format() would make it collide with |
|
3623 | 3624 | # the 'self' argument of the method. |
|
3624 | 3625 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3625 | 3626 | except Exception: |
|
3626 | 3627 | # if formatter couldn't format, just let it go untransformed |
|
3627 | 3628 | pass |
|
3628 | 3629 | return cmd |
|
3629 | 3630 | |
|
3630 | 3631 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3631 | 3632 | """Make a new tempfile and return its filename. |
|
3632 | 3633 | |
|
3633 | 3634 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3634 | 3635 | but it registers the created filename internally so ipython cleans it up |
|
3635 | 3636 | at exit time. |
|
3636 | 3637 | |
|
3637 | 3638 | Optional inputs: |
|
3638 | 3639 | |
|
3639 | 3640 | - data(None): if data is given, it gets written out to the temp file |
|
3640 | 3641 | immediately, and the file is closed again.""" |
|
3641 | 3642 | |
|
3642 | 3643 | dir_path = Path(tempfile.mkdtemp(prefix=prefix)) |
|
3643 | 3644 | self.tempdirs.append(dir_path) |
|
3644 | 3645 | |
|
3645 | 3646 | handle, filename = tempfile.mkstemp(".py", prefix, dir=str(dir_path)) |
|
3646 | 3647 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3647 | 3648 | |
|
3648 | 3649 | file_path = Path(filename) |
|
3649 | 3650 | self.tempfiles.append(file_path) |
|
3650 | 3651 | |
|
3651 | 3652 | if data: |
|
3652 | 3653 | file_path.write_text(data) |
|
3653 | 3654 | return filename |
|
3654 | 3655 | |
|
3655 | 3656 | @undoc |
|
3656 | 3657 | def write(self,data): |
|
3657 | 3658 | """DEPRECATED: Write a string to the default output""" |
|
3658 | 3659 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3659 | 3660 | DeprecationWarning, stacklevel=2) |
|
3660 | 3661 | sys.stdout.write(data) |
|
3661 | 3662 | |
|
3662 | 3663 | @undoc |
|
3663 | 3664 | def write_err(self,data): |
|
3664 | 3665 | """DEPRECATED: Write a string to the default error output""" |
|
3665 | 3666 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3666 | 3667 | DeprecationWarning, stacklevel=2) |
|
3667 | 3668 | sys.stderr.write(data) |
|
3668 | 3669 | |
|
3669 | 3670 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3670 | 3671 | if self.quiet: |
|
3671 | 3672 | return True |
|
3672 | 3673 | return ask_yes_no(prompt,default,interrupt) |
|
3673 | 3674 | |
|
3674 | 3675 | def show_usage(self): |
|
3675 | 3676 | """Show a usage message""" |
|
3676 | 3677 | page.page(IPython.core.usage.interactive_usage) |
|
3677 | 3678 | |
|
3678 | 3679 | def extract_input_lines(self, range_str, raw=False): |
|
3679 | 3680 | """Return as a string a set of input history slices. |
|
3680 | 3681 | |
|
3681 | 3682 | Parameters |
|
3682 | 3683 | ---------- |
|
3683 | 3684 | range_str : string |
|
3684 | 3685 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3685 | 3686 | since this function is for use by magic functions which get their |
|
3686 | 3687 | arguments as strings. The number before the / is the session |
|
3687 | 3688 | number: ~n goes n back from the current session. |
|
3688 | 3689 | |
|
3689 | 3690 | raw : bool, optional |
|
3690 | 3691 | By default, the processed input is used. If this is true, the raw |
|
3691 | 3692 | input history is used instead. |
|
3692 | 3693 | |
|
3693 | 3694 | Notes |
|
3694 | 3695 | ----- |
|
3695 | 3696 | |
|
3696 | 3697 | Slices can be described with two notations: |
|
3697 | 3698 | |
|
3698 | 3699 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3699 | 3700 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3700 | 3701 | """ |
|
3701 | 3702 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3702 | 3703 | return "\n".join(x for _, _, x in lines) |
|
3703 | 3704 | |
|
3704 | 3705 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3705 | 3706 | """Get a code string from history, file, url, or a string or macro. |
|
3706 | 3707 | |
|
3707 | 3708 | This is mainly used by magic functions. |
|
3708 | 3709 | |
|
3709 | 3710 | Parameters |
|
3710 | 3711 | ---------- |
|
3711 | 3712 | |
|
3712 | 3713 | target : str |
|
3713 | 3714 | |
|
3714 | 3715 | A string specifying code to retrieve. This will be tried respectively |
|
3715 | 3716 | as: ranges of input history (see %history for syntax), url, |
|
3716 | 3717 | corresponding .py file, filename, or an expression evaluating to a |
|
3717 | 3718 | string or Macro in the user namespace. |
|
3718 | 3719 | |
|
3719 | 3720 | raw : bool |
|
3720 | 3721 | If true (default), retrieve raw history. Has no effect on the other |
|
3721 | 3722 | retrieval mechanisms. |
|
3722 | 3723 | |
|
3723 | 3724 | py_only : bool (default False) |
|
3724 | 3725 | Only try to fetch python code, do not try alternative methods to decode file |
|
3725 | 3726 | if unicode fails. |
|
3726 | 3727 | |
|
3727 | 3728 | Returns |
|
3728 | 3729 | ------- |
|
3729 | 3730 | A string of code. |
|
3730 | 3731 | |
|
3731 | 3732 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3732 | 3733 | to an object of another type. In each case, .args[0] is a printable |
|
3733 | 3734 | message. |
|
3734 | 3735 | """ |
|
3735 | 3736 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3736 | 3737 | if code: |
|
3737 | 3738 | return code |
|
3738 | 3739 | try: |
|
3739 | 3740 | if target.startswith(('http://', 'https://')): |
|
3740 | 3741 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3741 | 3742 | except UnicodeDecodeError as e: |
|
3742 | 3743 | if not py_only : |
|
3743 | 3744 | # Deferred import |
|
3744 | 3745 | from urllib.request import urlopen |
|
3745 | 3746 | response = urlopen(target) |
|
3746 | 3747 | return response.read().decode('latin1') |
|
3747 | 3748 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3748 | 3749 | |
|
3749 | 3750 | potential_target = [target] |
|
3750 | 3751 | try : |
|
3751 | 3752 | potential_target.insert(0,get_py_filename(target)) |
|
3752 | 3753 | except IOError: |
|
3753 | 3754 | pass |
|
3754 | 3755 | |
|
3755 | 3756 | for tgt in potential_target : |
|
3756 | 3757 | if os.path.isfile(tgt): # Read file |
|
3757 | 3758 | try : |
|
3758 | 3759 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3759 | 3760 | except UnicodeDecodeError as e: |
|
3760 | 3761 | if not py_only : |
|
3761 | 3762 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3762 | 3763 | return f.read() |
|
3763 | 3764 | raise ValueError(("'%s' seem to be unreadable.") % target) from e |
|
3764 | 3765 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3765 | 3766 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3766 | 3767 | |
|
3767 | 3768 | if search_ns: |
|
3768 | 3769 | # Inspect namespace to load object source |
|
3769 | 3770 | object_info = self.object_inspect(target, detail_level=1) |
|
3770 | 3771 | if object_info['found'] and object_info['source']: |
|
3771 | 3772 | return object_info['source'] |
|
3772 | 3773 | |
|
3773 | 3774 | try: # User namespace |
|
3774 | 3775 | codeobj = eval(target, self.user_ns) |
|
3775 | 3776 | except Exception as e: |
|
3776 | 3777 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3777 | 3778 | "nor in the user namespace.") % target) from e |
|
3778 | 3779 | |
|
3779 | 3780 | if isinstance(codeobj, str): |
|
3780 | 3781 | return codeobj |
|
3781 | 3782 | elif isinstance(codeobj, Macro): |
|
3782 | 3783 | return codeobj.value |
|
3783 | 3784 | |
|
3784 | 3785 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3785 | 3786 | codeobj) |
|
3786 | 3787 | |
|
3787 | 3788 | def _atexit_once(self): |
|
3788 | 3789 | """ |
|
3789 | 3790 | At exist operation that need to be called at most once. |
|
3790 | 3791 | Second call to this function per instance will do nothing. |
|
3791 | 3792 | """ |
|
3792 | 3793 | |
|
3793 | 3794 | if not getattr(self, "_atexit_once_called", False): |
|
3794 | 3795 | self._atexit_once_called = True |
|
3795 | 3796 | # Clear all user namespaces to release all references cleanly. |
|
3796 | 3797 | self.reset(new_session=False) |
|
3797 | 3798 | # Close the history session (this stores the end time and line count) |
|
3798 | 3799 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3799 | 3800 | # history db |
|
3800 | 3801 | self.history_manager.end_session() |
|
3801 | 3802 | self.history_manager = None |
|
3802 | 3803 | |
|
3803 | 3804 | #------------------------------------------------------------------------- |
|
3804 | 3805 | # Things related to IPython exiting |
|
3805 | 3806 | #------------------------------------------------------------------------- |
|
3806 | 3807 | def atexit_operations(self): |
|
3807 | 3808 | """This will be executed at the time of exit. |
|
3808 | 3809 | |
|
3809 | 3810 | Cleanup operations and saving of persistent data that is done |
|
3810 | 3811 | unconditionally by IPython should be performed here. |
|
3811 | 3812 | |
|
3812 | 3813 | For things that may depend on startup flags or platform specifics (such |
|
3813 | 3814 | as having readline or not), register a separate atexit function in the |
|
3814 | 3815 | code that has the appropriate information, rather than trying to |
|
3815 | 3816 | clutter |
|
3816 | 3817 | """ |
|
3817 | 3818 | self._atexit_once() |
|
3818 | 3819 | |
|
3819 | 3820 | # Cleanup all tempfiles and folders left around |
|
3820 | 3821 | for tfile in self.tempfiles: |
|
3821 | 3822 | try: |
|
3822 | 3823 | tfile.unlink() |
|
3823 | 3824 | self.tempfiles.remove(tfile) |
|
3824 | 3825 | except FileNotFoundError: |
|
3825 | 3826 | pass |
|
3826 | 3827 | del self.tempfiles |
|
3827 | 3828 | for tdir in self.tempdirs: |
|
3828 | 3829 | try: |
|
3829 | 3830 | tdir.rmdir() |
|
3830 | 3831 | self.tempdirs.remove(tdir) |
|
3831 | 3832 | except FileNotFoundError: |
|
3832 | 3833 | pass |
|
3833 | 3834 | del self.tempdirs |
|
3834 | 3835 | |
|
3835 | 3836 | |
|
3836 | 3837 | # Run user hooks |
|
3837 | 3838 | self.hooks.shutdown_hook() |
|
3838 | 3839 | |
|
3839 | 3840 | def cleanup(self): |
|
3840 | 3841 | self.restore_sys_module_state() |
|
3841 | 3842 | |
|
3842 | 3843 | |
|
3843 | 3844 | # Overridden in terminal subclass to change prompts |
|
3844 | 3845 | def switch_doctest_mode(self, mode): |
|
3845 | 3846 | pass |
|
3846 | 3847 | |
|
3847 | 3848 | |
|
3848 | 3849 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3849 | 3850 | """An abstract base class for InteractiveShell.""" |
|
3850 | 3851 | |
|
3851 | 3852 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,419 +1,388 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Pylab (matplotlib) support utilities.""" |
|
3 | 3 | |
|
4 | 4 | # Copyright (c) IPython Development Team. |
|
5 | 5 | # Distributed under the terms of the Modified BSD License. |
|
6 | 6 | |
|
7 | 7 | from io import BytesIO |
|
8 | import warnings | |
|
8 | 9 | |
|
9 | 10 | from IPython.core.display import _pngxy |
|
10 | 11 | from IPython.utils.decorators import flag_calls |
|
11 | 12 | |
|
12 | 13 | # If user specifies a GUI, that dictates the backend, otherwise we read the |
|
13 | 14 | # user's mpl default from the mpl rc structure |
|
14 |
backends = { |
|
|
15 | 'gtk': 'GTKAgg', | |
|
16 |
|
|
|
17 | 'wx': 'WXAgg', | |
|
18 | 'qt4': 'Qt4Agg', | |
|
19 | 'qt5': 'Qt5Agg', | |
|
20 |
|
|
|
21 | 'osx': 'MacOSX', | |
|
22 | 'nbagg': 'nbAgg', | |
|
23 | 'notebook': 'nbAgg', | |
|
24 | 'agg': 'agg', | |
|
25 | 'svg': 'svg', | |
|
26 | 'pdf': 'pdf', | |
|
27 | 'ps': 'ps', | |
|
28 | 'inline': 'module://ipykernel.pylab.backend_inline', | |
|
29 | 'ipympl': 'module://ipympl.backend_nbagg', | |
|
30 |
|
|
|
15 | backends = { | |
|
16 | "tk": "TkAgg", | |
|
17 | "gtk": "GTKAgg", | |
|
18 | "gtk3": "GTK3Agg", | |
|
19 | "wx": "WXAgg", | |
|
20 | "qt4": "Qt4Agg", | |
|
21 | "qt5": "Qt5Agg", | |
|
22 | "qt": "Qt5Agg", | |
|
23 | "osx": "MacOSX", | |
|
24 | "nbagg": "nbAgg", | |
|
25 | "notebook": "nbAgg", | |
|
26 | "agg": "agg", | |
|
27 | "svg": "svg", | |
|
28 | "pdf": "pdf", | |
|
29 | "ps": "ps", | |
|
30 | "inline": "module://matplotlib_inline.backend_inline", | |
|
31 | "ipympl": "module://ipympl.backend_nbagg", | |
|
32 | "widget": "module://ipympl.backend_nbagg", | |
|
31 | 33 | } |
|
32 | 34 | |
|
33 | 35 | # We also need a reverse backends2guis mapping that will properly choose which |
|
34 | 36 | # GUI support to activate based on the desired matplotlib backend. For the |
|
35 | 37 | # most part it's just a reverse of the above dict, but we also need to add a |
|
36 | 38 | # few others that map to the same GUI manually: |
|
37 | 39 | backend2gui = dict(zip(backends.values(), backends.keys())) |
|
38 | 40 | # Our tests expect backend2gui to just return 'qt' |
|
39 | 41 | backend2gui['Qt4Agg'] = 'qt' |
|
40 | 42 | # In the reverse mapping, there are a few extra valid matplotlib backends that |
|
41 | 43 | # map to the same GUI support |
|
42 | 44 | backend2gui['GTK'] = backend2gui['GTKCairo'] = 'gtk' |
|
43 | 45 | backend2gui['GTK3Cairo'] = 'gtk3' |
|
44 | 46 | backend2gui['WX'] = 'wx' |
|
45 | 47 | backend2gui['CocoaAgg'] = 'osx' |
|
46 | 48 | # And some backends that don't need GUI integration |
|
47 |
del backend2gui[ |
|
|
48 |
del backend2gui[ |
|
|
49 |
del backend2gui[ |
|
|
50 |
del backend2gui[ |
|
|
51 |
del backend2gui[ |
|
|
52 |
del backend2gui[ |
|
|
49 | del backend2gui["nbAgg"] | |
|
50 | del backend2gui["agg"] | |
|
51 | del backend2gui["svg"] | |
|
52 | del backend2gui["pdf"] | |
|
53 | del backend2gui["ps"] | |
|
54 | del backend2gui["module://matplotlib_inline.backend_inline"] | |
|
53 | 55 | |
|
54 | 56 | #----------------------------------------------------------------------------- |
|
55 | 57 | # Matplotlib utilities |
|
56 | 58 | #----------------------------------------------------------------------------- |
|
57 | 59 | |
|
58 | 60 | |
|
59 | 61 | def getfigs(*fig_nums): |
|
60 | 62 | """Get a list of matplotlib figures by figure numbers. |
|
61 | 63 | |
|
62 | 64 | If no arguments are given, all available figures are returned. If the |
|
63 | 65 | argument list contains references to invalid figures, a warning is printed |
|
64 | 66 | but the function continues pasting further figures. |
|
65 | 67 | |
|
66 | 68 | Parameters |
|
67 | 69 | ---------- |
|
68 | 70 | figs : tuple |
|
69 | 71 | A tuple of ints giving the figure numbers of the figures to return. |
|
70 | 72 | """ |
|
71 | 73 | from matplotlib._pylab_helpers import Gcf |
|
72 | 74 | if not fig_nums: |
|
73 | 75 | fig_managers = Gcf.get_all_fig_managers() |
|
74 | 76 | return [fm.canvas.figure for fm in fig_managers] |
|
75 | 77 | else: |
|
76 | 78 | figs = [] |
|
77 | 79 | for num in fig_nums: |
|
78 | 80 | f = Gcf.figs.get(num) |
|
79 | 81 | if f is None: |
|
80 | 82 | print('Warning: figure %s not available.' % num) |
|
81 | 83 | else: |
|
82 | 84 | figs.append(f.canvas.figure) |
|
83 | 85 | return figs |
|
84 | 86 | |
|
85 | 87 | |
|
86 | 88 | def figsize(sizex, sizey): |
|
87 | 89 | """Set the default figure size to be [sizex, sizey]. |
|
88 | 90 | |
|
89 | 91 | This is just an easy to remember, convenience wrapper that sets:: |
|
90 | 92 | |
|
91 | 93 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] |
|
92 | 94 | """ |
|
93 | 95 | import matplotlib |
|
94 | 96 | matplotlib.rcParams['figure.figsize'] = [sizex, sizey] |
|
95 | 97 | |
|
96 | 98 | |
|
97 | 99 | def print_figure(fig, fmt='png', bbox_inches='tight', **kwargs): |
|
98 | 100 | """Print a figure to an image, and return the resulting file data |
|
99 | 101 | |
|
100 | 102 | Returned data will be bytes unless ``fmt='svg'``, |
|
101 | 103 | in which case it will be unicode. |
|
102 | 104 | |
|
103 | 105 | Any keyword args are passed to fig.canvas.print_figure, |
|
104 | 106 | such as ``quality`` or ``bbox_inches``. |
|
105 | 107 | """ |
|
106 | 108 | # When there's an empty figure, we shouldn't return anything, otherwise we |
|
107 | 109 | # get big blank areas in the qt console. |
|
108 | 110 | if not fig.axes and not fig.lines: |
|
109 | 111 | return |
|
110 | 112 | |
|
111 | 113 | dpi = fig.dpi |
|
112 | 114 | if fmt == 'retina': |
|
113 | 115 | dpi = dpi * 2 |
|
114 | 116 | fmt = 'png' |
|
115 | 117 | |
|
116 | 118 | # build keyword args |
|
117 | 119 | kw = { |
|
118 | 120 | "format":fmt, |
|
119 | 121 | "facecolor":fig.get_facecolor(), |
|
120 | 122 | "edgecolor":fig.get_edgecolor(), |
|
121 | 123 | "dpi":dpi, |
|
122 | 124 | "bbox_inches":bbox_inches, |
|
123 | 125 | } |
|
124 | 126 | # **kwargs get higher priority |
|
125 | 127 | kw.update(kwargs) |
|
126 | 128 | |
|
127 | 129 | bytes_io = BytesIO() |
|
128 | 130 | if fig.canvas is None: |
|
129 | 131 | from matplotlib.backend_bases import FigureCanvasBase |
|
130 | 132 | FigureCanvasBase(fig) |
|
131 | 133 | |
|
132 | 134 | fig.canvas.print_figure(bytes_io, **kw) |
|
133 | 135 | data = bytes_io.getvalue() |
|
134 | 136 | if fmt == 'svg': |
|
135 | 137 | data = data.decode('utf-8') |
|
136 | 138 | return data |
|
137 | 139 | |
|
138 | 140 | def retina_figure(fig, **kwargs): |
|
139 | 141 | """format a figure as a pixel-doubled (retina) PNG""" |
|
140 | 142 | pngdata = print_figure(fig, fmt='retina', **kwargs) |
|
141 | 143 | # Make sure that retina_figure acts just like print_figure and returns |
|
142 | 144 | # None when the figure is empty. |
|
143 | 145 | if pngdata is None: |
|
144 | 146 | return |
|
145 | 147 | w, h = _pngxy(pngdata) |
|
146 | 148 | metadata = {"width": w//2, "height":h//2} |
|
147 | 149 | return pngdata, metadata |
|
148 | 150 | |
|
149 | 151 | # We need a little factory function here to create the closure where |
|
150 | 152 | # safe_execfile can live. |
|
151 | 153 | def mpl_runner(safe_execfile): |
|
152 | 154 | """Factory to return a matplotlib-enabled runner for %run. |
|
153 | 155 | |
|
154 | 156 | Parameters |
|
155 | 157 | ---------- |
|
156 | 158 | safe_execfile : function |
|
157 | 159 | This must be a function with the same interface as the |
|
158 | 160 | :meth:`safe_execfile` method of IPython. |
|
159 | 161 | |
|
160 | 162 | Returns |
|
161 | 163 | ------- |
|
162 | 164 | A function suitable for use as the ``runner`` argument of the %run magic |
|
163 | 165 | function. |
|
164 | 166 | """ |
|
165 | 167 | |
|
166 | 168 | def mpl_execfile(fname,*where,**kw): |
|
167 | 169 | """matplotlib-aware wrapper around safe_execfile. |
|
168 | 170 | |
|
169 | 171 | Its interface is identical to that of the :func:`execfile` builtin. |
|
170 | 172 | |
|
171 | 173 | This is ultimately a call to execfile(), but wrapped in safeties to |
|
172 | 174 | properly handle interactive rendering.""" |
|
173 | 175 | |
|
174 | 176 | import matplotlib |
|
175 | 177 | import matplotlib.pyplot as plt |
|
176 | 178 | |
|
177 | 179 | #print '*** Matplotlib runner ***' # dbg |
|
178 | 180 | # turn off rendering until end of script |
|
179 | 181 | is_interactive = matplotlib.rcParams['interactive'] |
|
180 | 182 | matplotlib.interactive(False) |
|
181 | 183 | safe_execfile(fname,*where,**kw) |
|
182 | 184 | matplotlib.interactive(is_interactive) |
|
183 | 185 | # make rendering call now, if the user tried to do it |
|
184 | 186 | if plt.draw_if_interactive.called: |
|
185 | 187 | plt.draw() |
|
186 | 188 | plt.draw_if_interactive.called = False |
|
187 | 189 | |
|
188 | 190 | # re-draw everything that is stale |
|
189 | 191 | try: |
|
190 | 192 | da = plt.draw_all |
|
191 | 193 | except AttributeError: |
|
192 | 194 | pass |
|
193 | 195 | else: |
|
194 | 196 | da() |
|
195 | 197 | |
|
196 | 198 | return mpl_execfile |
|
197 | 199 | |
|
198 | 200 | |
|
199 | 201 | def _reshow_nbagg_figure(fig): |
|
200 | 202 | """reshow an nbagg figure""" |
|
201 | 203 | try: |
|
202 | 204 | reshow = fig.canvas.manager.reshow |
|
203 | 205 | except AttributeError as e: |
|
204 | 206 | raise NotImplementedError() from e |
|
205 | 207 | else: |
|
206 | 208 | reshow() |
|
207 | 209 | |
|
208 | 210 | |
|
209 | 211 | def select_figure_formats(shell, formats, **kwargs): |
|
210 | 212 | """Select figure formats for the inline backend. |
|
211 | 213 | |
|
212 | 214 | Parameters |
|
213 | 215 | ========== |
|
214 | 216 | shell : InteractiveShell |
|
215 | 217 | The main IPython instance. |
|
216 | 218 | formats : str or set |
|
217 | 219 | One or a set of figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'. |
|
218 | 220 | **kwargs : any |
|
219 | 221 | Extra keyword arguments to be passed to fig.canvas.print_figure. |
|
220 | 222 | """ |
|
221 | 223 | import matplotlib |
|
222 | 224 | from matplotlib.figure import Figure |
|
223 | 225 | |
|
224 | 226 | svg_formatter = shell.display_formatter.formatters['image/svg+xml'] |
|
225 | 227 | png_formatter = shell.display_formatter.formatters['image/png'] |
|
226 | 228 | jpg_formatter = shell.display_formatter.formatters['image/jpeg'] |
|
227 | 229 | pdf_formatter = shell.display_formatter.formatters['application/pdf'] |
|
228 | 230 | |
|
229 | 231 | if isinstance(formats, str): |
|
230 | 232 | formats = {formats} |
|
231 | 233 | # cast in case of list / tuple |
|
232 | 234 | formats = set(formats) |
|
233 | 235 | |
|
234 | 236 | [ f.pop(Figure, None) for f in shell.display_formatter.formatters.values() ] |
|
235 | 237 | mplbackend = matplotlib.get_backend().lower() |
|
236 | 238 | if mplbackend == 'nbagg' or mplbackend == 'module://ipympl.backend_nbagg': |
|
237 | 239 | formatter = shell.display_formatter.ipython_display_formatter |
|
238 | 240 | formatter.for_type(Figure, _reshow_nbagg_figure) |
|
239 | 241 | |
|
240 | 242 | supported = {'png', 'png2x', 'retina', 'jpg', 'jpeg', 'svg', 'pdf'} |
|
241 | 243 | bad = formats.difference(supported) |
|
242 | 244 | if bad: |
|
243 | 245 | bs = "%s" % ','.join([repr(f) for f in bad]) |
|
244 | 246 | gs = "%s" % ','.join([repr(f) for f in supported]) |
|
245 | 247 | raise ValueError("supported formats are: %s not %s" % (gs, bs)) |
|
246 | 248 | |
|
247 | 249 | if 'png' in formats: |
|
248 | 250 | png_formatter.for_type(Figure, lambda fig: print_figure(fig, 'png', **kwargs)) |
|
249 | 251 | if 'retina' in formats or 'png2x' in formats: |
|
250 | 252 | png_formatter.for_type(Figure, lambda fig: retina_figure(fig, **kwargs)) |
|
251 | 253 | if 'jpg' in formats or 'jpeg' in formats: |
|
252 | 254 | jpg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'jpg', **kwargs)) |
|
253 | 255 | if 'svg' in formats: |
|
254 | 256 | svg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'svg', **kwargs)) |
|
255 | 257 | if 'pdf' in formats: |
|
256 | 258 | pdf_formatter.for_type(Figure, lambda fig: print_figure(fig, 'pdf', **kwargs)) |
|
257 | 259 | |
|
258 | 260 | #----------------------------------------------------------------------------- |
|
259 | 261 | # Code for initializing matplotlib and importing pylab |
|
260 | 262 | #----------------------------------------------------------------------------- |
|
261 | 263 | |
|
262 | 264 | |
|
263 | 265 | def find_gui_and_backend(gui=None, gui_select=None): |
|
264 | 266 | """Given a gui string return the gui and mpl backend. |
|
265 | 267 | |
|
266 | 268 | Parameters |
|
267 | 269 | ---------- |
|
268 | 270 | gui : str |
|
269 | 271 | Can be one of ('tk','gtk','wx','qt','qt4','inline','agg'). |
|
270 | 272 | gui_select : str |
|
271 | 273 | Can be one of ('tk','gtk','wx','qt','qt4','inline'). |
|
272 | 274 | This is any gui already selected by the shell. |
|
273 | 275 | |
|
274 | 276 | Returns |
|
275 | 277 | ------- |
|
276 | 278 | A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg', |
|
277 |
'WXAgg','Qt4Agg','module:// |
|
|
279 | 'WXAgg','Qt4Agg','module://matplotlib_inline.backend_inline','agg'). | |
|
278 | 280 | """ |
|
279 | 281 | |
|
280 | 282 | import matplotlib |
|
281 | 283 | |
|
282 | 284 | if gui and gui != 'auto': |
|
283 | 285 | # select backend based on requested gui |
|
284 | 286 | backend = backends[gui] |
|
285 | 287 | if gui == 'agg': |
|
286 | 288 | gui = None |
|
287 | 289 | else: |
|
288 | 290 | # We need to read the backend from the original data structure, *not* |
|
289 | 291 | # from mpl.rcParams, since a prior invocation of %matplotlib may have |
|
290 | 292 | # overwritten that. |
|
291 | 293 | # WARNING: this assumes matplotlib 1.1 or newer!! |
|
292 | 294 | backend = matplotlib.rcParamsOrig['backend'] |
|
293 | 295 | # In this case, we need to find what the appropriate gui selection call |
|
294 | 296 | # should be for IPython, so we can activate inputhook accordingly |
|
295 | 297 | gui = backend2gui.get(backend, None) |
|
296 | 298 | |
|
297 | 299 | # If we have already had a gui active, we need it and inline are the |
|
298 | 300 | # ones allowed. |
|
299 | 301 | if gui_select and gui != gui_select: |
|
300 | 302 | gui = gui_select |
|
301 | 303 | backend = backends[gui] |
|
302 | 304 | |
|
303 | 305 | return gui, backend |
|
304 | 306 | |
|
305 | 307 | |
|
306 | 308 | def activate_matplotlib(backend): |
|
307 | 309 | """Activate the given backend and set interactive to True.""" |
|
308 | 310 | |
|
309 | 311 | import matplotlib |
|
310 | 312 | matplotlib.interactive(True) |
|
311 | 313 | |
|
312 | 314 | # Matplotlib had a bug where even switch_backend could not force |
|
313 | 315 | # the rcParam to update. This needs to be set *before* the module |
|
314 | 316 | # magic of switch_backend(). |
|
315 | 317 | matplotlib.rcParams['backend'] = backend |
|
316 | 318 | |
|
317 | 319 | # Due to circular imports, pyplot may be only partially initialised |
|
318 | 320 | # when this function runs. |
|
319 | 321 | # So avoid needing matplotlib attribute-lookup to access pyplot. |
|
320 | 322 | from matplotlib import pyplot as plt |
|
321 | 323 | |
|
322 | 324 | plt.switch_backend(backend) |
|
323 | 325 | |
|
324 | 326 | plt.show._needmain = False |
|
325 | 327 | # We need to detect at runtime whether show() is called by the user. |
|
326 | 328 | # For this, we wrap it into a decorator which adds a 'called' flag. |
|
327 | 329 | plt.draw_if_interactive = flag_calls(plt.draw_if_interactive) |
|
328 | 330 | |
|
329 | 331 | |
|
330 | 332 | def import_pylab(user_ns, import_all=True): |
|
331 | 333 | """Populate the namespace with pylab-related values. |
|
332 | 334 | |
|
333 | 335 | Imports matplotlib, pylab, numpy, and everything from pylab and numpy. |
|
334 | 336 | |
|
335 | 337 | Also imports a few names from IPython (figsize, display, getfigs) |
|
336 | 338 | |
|
337 | 339 | """ |
|
338 | 340 | |
|
339 | 341 | # Import numpy as np/pyplot as plt are conventions we're trying to |
|
340 | 342 | # somewhat standardize on. Making them available to users by default |
|
341 | 343 | # will greatly help this. |
|
342 | 344 | s = ("import numpy\n" |
|
343 | 345 | "import matplotlib\n" |
|
344 | 346 | "from matplotlib import pylab, mlab, pyplot\n" |
|
345 | 347 | "np = numpy\n" |
|
346 | 348 | "plt = pyplot\n" |
|
347 | 349 | ) |
|
348 | 350 | exec(s, user_ns) |
|
349 | 351 | |
|
350 | 352 | if import_all: |
|
351 | 353 | s = ("from matplotlib.pylab import *\n" |
|
352 | 354 | "from numpy import *\n") |
|
353 | 355 | exec(s, user_ns) |
|
354 | 356 | |
|
355 | 357 | # IPython symbols to add |
|
356 | 358 | user_ns['figsize'] = figsize |
|
357 | 359 | from IPython.display import display |
|
358 | 360 | # Add display and getfigs to the user's namespace |
|
359 | 361 | user_ns['display'] = display |
|
360 | 362 | user_ns['getfigs'] = getfigs |
|
361 | 363 | |
|
362 | 364 | |
|
363 | 365 | def configure_inline_support(shell, backend): |
|
364 | """Configure an IPython shell object for matplotlib use. | |
|
366 | """ | |
|
367 | .. deprecated: 7.23 | |
|
368 | ||
|
369 | use `matplotlib_inline.backend_inline.configure_inline_support()` | |
|
370 | ||
|
371 | Configure an IPython shell object for matplotlib use. | |
|
365 | 372 | |
|
366 | 373 | Parameters |
|
367 | 374 | ---------- |
|
368 | 375 | shell : InteractiveShell instance |
|
369 | 376 | |
|
370 | 377 | backend : matplotlib backend |
|
371 | 378 | """ |
|
372 | # If using our svg payload backend, register the post-execution | |
|
373 | # function that will pick up the results for display. This can only be | |
|
374 | # done with access to the real shell object. | |
|
379 | warnings.warn( | |
|
380 | "`configure_inline_support` is deprecated since IPython 7.23, directly " | |
|
381 | "use `matplotlib_inline.backend_inline.configure_inline_support()`", | |
|
382 | DeprecationWarning, | |
|
383 | stacklevel=2, | |
|
384 | ) | |
|
375 | 385 | |
|
376 | # Note: if we can't load the inline backend, then there's no point | |
|
377 | # continuing (such as in terminal-only shells in environments without | |
|
378 | # zeromq available). | |
|
379 | try: | |
|
380 | from ipykernel.pylab.backend_inline import InlineBackend | |
|
381 | except ImportError: | |
|
382 | return | |
|
383 | import matplotlib | |
|
386 | from matplotlib_inline.backend_inline import configure_inline_support_orig | |
|
384 | 387 | |
|
385 | cfg = InlineBackend.instance(parent=shell) | |
|
386 | cfg.shell = shell | |
|
387 | if cfg not in shell.configurables: | |
|
388 | shell.configurables.append(cfg) | |
|
389 | ||
|
390 | if backend == backends['inline']: | |
|
391 | from ipykernel.pylab.backend_inline import flush_figures | |
|
392 | shell.events.register('post_execute', flush_figures) | |
|
393 | ||
|
394 | # Save rcParams that will be overwrittern | |
|
395 | shell._saved_rcParams = {} | |
|
396 | for k in cfg.rc: | |
|
397 | shell._saved_rcParams[k] = matplotlib.rcParams[k] | |
|
398 | # load inline_rc | |
|
399 | matplotlib.rcParams.update(cfg.rc) | |
|
400 | new_backend_name = "inline" | |
|
401 | else: | |
|
402 | from ipykernel.pylab.backend_inline import flush_figures | |
|
403 | try: | |
|
404 | shell.events.unregister('post_execute', flush_figures) | |
|
405 | except ValueError: | |
|
406 | pass | |
|
407 | if hasattr(shell, '_saved_rcParams'): | |
|
408 | matplotlib.rcParams.update(shell._saved_rcParams) | |
|
409 | del shell._saved_rcParams | |
|
410 | new_backend_name = "other" | |
|
411 | ||
|
412 | # only enable the formats once -> don't change the enabled formats (which the user may | |
|
413 | # has changed) when getting another "%matplotlib inline" call. | |
|
414 | # See https://github.com/ipython/ipykernel/issues/29 | |
|
415 | cur_backend = getattr(configure_inline_support, "current_backend", "unset") | |
|
416 | if new_backend_name != cur_backend: | |
|
417 | # Setup the default figure format | |
|
418 | select_figure_formats(shell, cfg.figure_formats, **cfg.print_figure_kwargs) | |
|
419 | configure_inline_support.current_backend = new_backend_name | |
|
388 | configure_inline_support_orig(shell, backend) |
@@ -1,463 +1,463 b'' | |||
|
1 | 1 | # Copyright (c) IPython Development Team. |
|
2 | 2 | # Distributed under the terms of the Modified BSD License. |
|
3 | 3 | |
|
4 | 4 | import json |
|
5 | 5 | import os |
|
6 | 6 | import warnings |
|
7 | 7 | |
|
8 | 8 | from unittest import mock |
|
9 | 9 | |
|
10 | 10 | import nose.tools as nt |
|
11 | 11 | |
|
12 | 12 | from IPython import display |
|
13 | 13 | from IPython.core.getipython import get_ipython |
|
14 | 14 | from IPython.utils.io import capture_output |
|
15 | 15 | from IPython.utils.tempdir import NamedFileInTemporaryDirectory |
|
16 | 16 | from IPython import paths as ipath |
|
17 | 17 | from IPython.testing.tools import AssertNotPrints |
|
18 | 18 | |
|
19 | 19 | import IPython.testing.decorators as dec |
|
20 | 20 | |
|
21 | 21 | def test_image_size(): |
|
22 | 22 | """Simple test for display.Image(args, width=x,height=y)""" |
|
23 | 23 | thisurl = 'http://www.google.fr/images/srpr/logo3w.png' |
|
24 | 24 | img = display.Image(url=thisurl, width=200, height=200) |
|
25 | 25 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
26 | 26 | img = display.Image(url=thisurl, metadata={'width':200, 'height':200}) |
|
27 | 27 | nt.assert_equal(u'<img src="%s" width="200" height="200"/>' % (thisurl), img._repr_html_()) |
|
28 | 28 | img = display.Image(url=thisurl, width=200) |
|
29 | 29 | nt.assert_equal(u'<img src="%s" width="200"/>' % (thisurl), img._repr_html_()) |
|
30 | 30 | img = display.Image(url=thisurl) |
|
31 | 31 | nt.assert_equal(u'<img src="%s"/>' % (thisurl), img._repr_html_()) |
|
32 | 32 | img = display.Image(url=thisurl, unconfined=True) |
|
33 | 33 | nt.assert_equal(u'<img src="%s" class="unconfined"/>' % (thisurl), img._repr_html_()) |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | def test_image_mimes(): |
|
37 | 37 | fmt = get_ipython().display_formatter.format |
|
38 | 38 | for format in display.Image._ACCEPTABLE_EMBEDDINGS: |
|
39 | 39 | mime = display.Image._MIMETYPES[format] |
|
40 | 40 | img = display.Image(b'garbage', format=format) |
|
41 | 41 | data, metadata = fmt(img) |
|
42 | 42 | nt.assert_equal(sorted(data), sorted([mime, 'text/plain'])) |
|
43 | 43 | |
|
44 | 44 | |
|
45 | 45 | def test_geojson(): |
|
46 | 46 | |
|
47 | 47 | gj = display.GeoJSON(data={ |
|
48 | 48 | "type": "Feature", |
|
49 | 49 | "geometry": { |
|
50 | 50 | "type": "Point", |
|
51 | 51 | "coordinates": [-81.327, 296.038] |
|
52 | 52 | }, |
|
53 | 53 | "properties": { |
|
54 | 54 | "name": "Inca City" |
|
55 | 55 | } |
|
56 | 56 | }, |
|
57 | 57 | url_template="http://s3-eu-west-1.amazonaws.com/whereonmars.cartodb.net/{basemap_id}/{z}/{x}/{y}.png", |
|
58 | 58 | layer_options={ |
|
59 | 59 | "basemap_id": "celestia_mars-shaded-16k_global", |
|
60 | 60 | "attribution": "Celestia/praesepe", |
|
61 | 61 | "minZoom": 0, |
|
62 | 62 | "maxZoom": 18, |
|
63 | 63 | }) |
|
64 | 64 | nt.assert_equal(u'<IPython.core.display.GeoJSON object>', str(gj)) |
|
65 | 65 | |
|
66 | 66 | def test_retina_png(): |
|
67 | 67 | here = os.path.dirname(__file__) |
|
68 | 68 | img = display.Image(os.path.join(here, "2x2.png"), retina=True) |
|
69 | 69 | nt.assert_equal(img.height, 1) |
|
70 | 70 | nt.assert_equal(img.width, 1) |
|
71 | 71 | data, md = img._repr_png_() |
|
72 | 72 | nt.assert_equal(md['width'], 1) |
|
73 | 73 | nt.assert_equal(md['height'], 1) |
|
74 | 74 | |
|
75 | 75 | def test_embed_svg_url(): |
|
76 | 76 | import gzip |
|
77 | 77 | from io import BytesIO |
|
78 | 78 | svg_data = b'<svg><circle x="0" y="0" r="1"/></svg>' |
|
79 | 79 | url = 'http://test.com/circle.svg' |
|
80 | 80 | |
|
81 | 81 | gzip_svg = BytesIO() |
|
82 | 82 | with gzip.open(gzip_svg, 'wb') as fp: |
|
83 | 83 | fp.write(svg_data) |
|
84 | 84 | gzip_svg = gzip_svg.getvalue() |
|
85 | 85 | |
|
86 | 86 | def mocked_urlopen(*args, **kwargs): |
|
87 | 87 | class MockResponse: |
|
88 | 88 | def __init__(self, svg): |
|
89 | 89 | self._svg_data = svg |
|
90 | 90 | self.headers = {'content-type': 'image/svg+xml'} |
|
91 | 91 | |
|
92 | 92 | def read(self): |
|
93 | 93 | return self._svg_data |
|
94 | 94 | |
|
95 | 95 | if args[0] == url: |
|
96 | 96 | return MockResponse(svg_data) |
|
97 | 97 | elif args[0] == url + 'z': |
|
98 | 98 | ret= MockResponse(gzip_svg) |
|
99 | 99 | ret.headers['content-encoding']= 'gzip' |
|
100 | 100 | return ret |
|
101 | 101 | return MockResponse(None) |
|
102 | 102 | |
|
103 | 103 | with mock.patch('urllib.request.urlopen', side_effect=mocked_urlopen): |
|
104 | 104 | svg = display.SVG(url=url) |
|
105 | 105 | nt.assert_true(svg._repr_svg_().startswith('<svg')) |
|
106 | 106 | svg = display.SVG(url=url + 'z') |
|
107 | 107 | nt.assert_true(svg._repr_svg_().startswith('<svg')) |
|
108 | 108 | |
|
109 | 109 | def test_retina_jpeg(): |
|
110 | 110 | here = os.path.dirname(__file__) |
|
111 | 111 | img = display.Image(os.path.join(here, "2x2.jpg"), retina=True) |
|
112 | 112 | nt.assert_equal(img.height, 1) |
|
113 | 113 | nt.assert_equal(img.width, 1) |
|
114 | 114 | data, md = img._repr_jpeg_() |
|
115 | 115 | nt.assert_equal(md['width'], 1) |
|
116 | 116 | nt.assert_equal(md['height'], 1) |
|
117 | 117 | |
|
118 | 118 | def test_base64image(): |
|
119 | 119 | display.Image("iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEUAAACnej3aAAAAAWJLR0QAiAUdSAAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB94BCRQnOqNu0b4AAAAKSURBVAjXY2AAAAACAAHiIbwzAAAAAElFTkSuQmCC") |
|
120 | 120 | |
|
121 | 121 | def test_image_filename_defaults(): |
|
122 | 122 | '''test format constraint, and validity of jpeg and png''' |
|
123 | 123 | tpath = ipath.get_ipython_package_dir() |
|
124 | 124 | nt.assert_raises(ValueError, display.Image, filename=os.path.join(tpath, 'testing/tests/badformat.zip'), |
|
125 | 125 | embed=True) |
|
126 | 126 | nt.assert_raises(ValueError, display.Image) |
|
127 | 127 | nt.assert_raises(ValueError, display.Image, data='this is not an image', format='badformat', embed=True) |
|
128 | 128 | # check boths paths to allow packages to test at build and install time |
|
129 | 129 | imgfile = os.path.join(tpath, 'core/tests/2x2.png') |
|
130 | 130 | img = display.Image(filename=imgfile) |
|
131 | 131 | nt.assert_equal('png', img.format) |
|
132 | 132 | nt.assert_is_not_none(img._repr_png_()) |
|
133 | 133 | img = display.Image(filename=os.path.join(tpath, 'testing/tests/logo.jpg'), embed=False) |
|
134 | 134 | nt.assert_equal('jpeg', img.format) |
|
135 | 135 | nt.assert_is_none(img._repr_jpeg_()) |
|
136 | 136 | |
|
137 | 137 | def _get_inline_config(): |
|
138 |
from |
|
|
138 | from matplotlib_inline.config import InlineBackend | |
|
139 | 139 | return InlineBackend.instance() |
|
140 | 140 | |
|
141 | 141 | |
|
142 | 142 | @dec.skip_without("ipykernel") |
|
143 | 143 | @dec.skip_without("matplotlib") |
|
144 | 144 | def test_set_matplotlib_close(): |
|
145 | 145 | cfg = _get_inline_config() |
|
146 | 146 | cfg.close_figures = False |
|
147 | 147 | display.set_matplotlib_close() |
|
148 | 148 | assert cfg.close_figures |
|
149 | 149 | display.set_matplotlib_close(False) |
|
150 | 150 | assert not cfg.close_figures |
|
151 | 151 | |
|
152 | 152 | _fmt_mime_map = { |
|
153 | 153 | 'png': 'image/png', |
|
154 | 154 | 'jpeg': 'image/jpeg', |
|
155 | 155 | 'pdf': 'application/pdf', |
|
156 | 156 | 'retina': 'image/png', |
|
157 | 157 | 'svg': 'image/svg+xml', |
|
158 | 158 | } |
|
159 | 159 | |
|
160 | 160 | @dec.skip_without('matplotlib') |
|
161 | 161 | def test_set_matplotlib_formats(): |
|
162 | 162 | from matplotlib.figure import Figure |
|
163 | 163 | formatters = get_ipython().display_formatter.formatters |
|
164 | 164 | for formats in [ |
|
165 | 165 | ('png',), |
|
166 | 166 | ('pdf', 'svg'), |
|
167 | 167 | ('jpeg', 'retina', 'png'), |
|
168 | 168 | (), |
|
169 | 169 | ]: |
|
170 | 170 | active_mimes = {_fmt_mime_map[fmt] for fmt in formats} |
|
171 | 171 | display.set_matplotlib_formats(*formats) |
|
172 | 172 | for mime, f in formatters.items(): |
|
173 | 173 | if mime in active_mimes: |
|
174 | 174 | nt.assert_in(Figure, f) |
|
175 | 175 | else: |
|
176 | 176 | nt.assert_not_in(Figure, f) |
|
177 | 177 | |
|
178 | 178 | |
|
179 | 179 | @dec.skip_without("ipykernel") |
|
180 | 180 | @dec.skip_without("matplotlib") |
|
181 | 181 | def test_set_matplotlib_formats_kwargs(): |
|
182 | 182 | from matplotlib.figure import Figure |
|
183 | 183 | ip = get_ipython() |
|
184 | 184 | cfg = _get_inline_config() |
|
185 | 185 | cfg.print_figure_kwargs.update(dict(foo='bar')) |
|
186 | 186 | kwargs = dict(dpi=150) |
|
187 | 187 | display.set_matplotlib_formats('png', **kwargs) |
|
188 | 188 | formatter = ip.display_formatter.formatters['image/png'] |
|
189 | 189 | f = formatter.lookup_by_type(Figure) |
|
190 | 190 | cell = f.__closure__[0].cell_contents |
|
191 | 191 | expected = kwargs |
|
192 | 192 | expected.update(cfg.print_figure_kwargs) |
|
193 | 193 | nt.assert_equal(cell, expected) |
|
194 | 194 | |
|
195 | 195 | def test_display_available(): |
|
196 | 196 | """ |
|
197 | 197 | Test that display is available without import |
|
198 | 198 | |
|
199 | 199 | We don't really care if it's in builtin or anything else, but it should |
|
200 | 200 | always be available. |
|
201 | 201 | """ |
|
202 | 202 | ip = get_ipython() |
|
203 | 203 | with AssertNotPrints('NameError'): |
|
204 | 204 | ip.run_cell('display') |
|
205 | 205 | try: |
|
206 | 206 | ip.run_cell('del display') |
|
207 | 207 | except NameError: |
|
208 | 208 | pass # it's ok, it might be in builtins |
|
209 | 209 | # even if deleted it should be back |
|
210 | 210 | with AssertNotPrints('NameError'): |
|
211 | 211 | ip.run_cell('display') |
|
212 | 212 | |
|
213 | 213 | def test_textdisplayobj_pretty_repr(): |
|
214 | 214 | p = display.Pretty("This is a simple test") |
|
215 | 215 | nt.assert_equal(repr(p), '<IPython.core.display.Pretty object>') |
|
216 | 216 | nt.assert_equal(p.data, 'This is a simple test') |
|
217 | 217 | |
|
218 | 218 | p._show_mem_addr = True |
|
219 | 219 | nt.assert_equal(repr(p), object.__repr__(p)) |
|
220 | 220 | |
|
221 | 221 | def test_displayobject_repr(): |
|
222 | 222 | h = display.HTML('<br />') |
|
223 | 223 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
224 | 224 | h._show_mem_addr = True |
|
225 | 225 | nt.assert_equal(repr(h), object.__repr__(h)) |
|
226 | 226 | h._show_mem_addr = False |
|
227 | 227 | nt.assert_equal(repr(h), '<IPython.core.display.HTML object>') |
|
228 | 228 | |
|
229 | 229 | j = display.Javascript('') |
|
230 | 230 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
231 | 231 | j._show_mem_addr = True |
|
232 | 232 | nt.assert_equal(repr(j), object.__repr__(j)) |
|
233 | 233 | j._show_mem_addr = False |
|
234 | 234 | nt.assert_equal(repr(j), '<IPython.core.display.Javascript object>') |
|
235 | 235 | |
|
236 | 236 | @mock.patch('warnings.warn') |
|
237 | 237 | def test_encourage_iframe_over_html(m_warn): |
|
238 | 238 | display.HTML() |
|
239 | 239 | m_warn.assert_not_called() |
|
240 | 240 | |
|
241 | 241 | display.HTML('<br />') |
|
242 | 242 | m_warn.assert_not_called() |
|
243 | 243 | |
|
244 | 244 | display.HTML('<html><p>Lots of content here</p><iframe src="http://a.com"></iframe>') |
|
245 | 245 | m_warn.assert_not_called() |
|
246 | 246 | |
|
247 | 247 | display.HTML('<iframe src="http://a.com"></iframe>') |
|
248 | 248 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
249 | 249 | |
|
250 | 250 | m_warn.reset_mock() |
|
251 | 251 | display.HTML('<IFRAME SRC="http://a.com"></IFRAME>') |
|
252 | 252 | m_warn.assert_called_with('Consider using IPython.display.IFrame instead') |
|
253 | 253 | |
|
254 | 254 | def test_progress(): |
|
255 | 255 | p = display.ProgressBar(10) |
|
256 | 256 | nt.assert_in('0/10',repr(p)) |
|
257 | 257 | p.html_width = '100%' |
|
258 | 258 | p.progress = 5 |
|
259 | 259 | nt.assert_equal(p._repr_html_(), "<progress style='width:100%' max='10' value='5'></progress>") |
|
260 | 260 | |
|
261 | 261 | def test_progress_iter(): |
|
262 | 262 | with capture_output(display=False) as captured: |
|
263 | 263 | for i in display.ProgressBar(5): |
|
264 | 264 | out = captured.stdout |
|
265 | 265 | nt.assert_in('{0}/5'.format(i), out) |
|
266 | 266 | out = captured.stdout |
|
267 | 267 | nt.assert_in('5/5', out) |
|
268 | 268 | |
|
269 | 269 | def test_json(): |
|
270 | 270 | d = {'a': 5} |
|
271 | 271 | lis = [d] |
|
272 | 272 | metadata = [ |
|
273 | 273 | {'expanded': False, 'root': 'root'}, |
|
274 | 274 | {'expanded': True, 'root': 'root'}, |
|
275 | 275 | {'expanded': False, 'root': 'custom'}, |
|
276 | 276 | {'expanded': True, 'root': 'custom'}, |
|
277 | 277 | ] |
|
278 | 278 | json_objs = [ |
|
279 | 279 | display.JSON(d), |
|
280 | 280 | display.JSON(d, expanded=True), |
|
281 | 281 | display.JSON(d, root='custom'), |
|
282 | 282 | display.JSON(d, expanded=True, root='custom'), |
|
283 | 283 | ] |
|
284 | 284 | for j, md in zip(json_objs, metadata): |
|
285 | 285 | nt.assert_equal(j._repr_json_(), (d, md)) |
|
286 | 286 | |
|
287 | 287 | with warnings.catch_warnings(record=True) as w: |
|
288 | 288 | warnings.simplefilter("always") |
|
289 | 289 | j = display.JSON(json.dumps(d)) |
|
290 | 290 | nt.assert_equal(len(w), 1) |
|
291 | 291 | nt.assert_equal(j._repr_json_(), (d, metadata[0])) |
|
292 | 292 | |
|
293 | 293 | json_objs = [ |
|
294 | 294 | display.JSON(lis), |
|
295 | 295 | display.JSON(lis, expanded=True), |
|
296 | 296 | display.JSON(lis, root='custom'), |
|
297 | 297 | display.JSON(lis, expanded=True, root='custom'), |
|
298 | 298 | ] |
|
299 | 299 | for j, md in zip(json_objs, metadata): |
|
300 | 300 | nt.assert_equal(j._repr_json_(), (lis, md)) |
|
301 | 301 | |
|
302 | 302 | with warnings.catch_warnings(record=True) as w: |
|
303 | 303 | warnings.simplefilter("always") |
|
304 | 304 | j = display.JSON(json.dumps(lis)) |
|
305 | 305 | nt.assert_equal(len(w), 1) |
|
306 | 306 | nt.assert_equal(j._repr_json_(), (lis, metadata[0])) |
|
307 | 307 | |
|
308 | 308 | def test_video_embedding(): |
|
309 | 309 | """use a tempfile, with dummy-data, to ensure that video embedding doesn't crash""" |
|
310 | 310 | v = display.Video("http://ignored") |
|
311 | 311 | assert not v.embed |
|
312 | 312 | html = v._repr_html_() |
|
313 | 313 | nt.assert_not_in('src="data:', html) |
|
314 | 314 | nt.assert_in('src="http://ignored"', html) |
|
315 | 315 | |
|
316 | 316 | with nt.assert_raises(ValueError): |
|
317 | 317 | v = display.Video(b'abc') |
|
318 | 318 | |
|
319 | 319 | with NamedFileInTemporaryDirectory('test.mp4') as f: |
|
320 | 320 | f.write(b'abc') |
|
321 | 321 | f.close() |
|
322 | 322 | |
|
323 | 323 | v = display.Video(f.name) |
|
324 | 324 | assert not v.embed |
|
325 | 325 | html = v._repr_html_() |
|
326 | 326 | nt.assert_not_in('src="data:', html) |
|
327 | 327 | |
|
328 | 328 | v = display.Video(f.name, embed=True) |
|
329 | 329 | html = v._repr_html_() |
|
330 | 330 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
331 | 331 | |
|
332 | 332 | v = display.Video(f.name, embed=True, mimetype='video/other') |
|
333 | 333 | html = v._repr_html_() |
|
334 | 334 | nt.assert_in('src="data:video/other;base64,YWJj"',html) |
|
335 | 335 | |
|
336 | 336 | v = display.Video(b'abc', embed=True, mimetype='video/mp4') |
|
337 | 337 | html = v._repr_html_() |
|
338 | 338 | nt.assert_in('src="data:video/mp4;base64,YWJj"',html) |
|
339 | 339 | |
|
340 | 340 | v = display.Video(u'YWJj', embed=True, mimetype='video/xyz') |
|
341 | 341 | html = v._repr_html_() |
|
342 | 342 | nt.assert_in('src="data:video/xyz;base64,YWJj"',html) |
|
343 | 343 | |
|
344 | 344 | def test_html_metadata(): |
|
345 | 345 | s = "<h1>Test</h1>" |
|
346 | 346 | h = display.HTML(s, metadata={"isolated": True}) |
|
347 | 347 | nt.assert_equal(h._repr_html_(), (s, {"isolated": True})) |
|
348 | 348 | |
|
349 | 349 | def test_display_id(): |
|
350 | 350 | ip = get_ipython() |
|
351 | 351 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
352 | 352 | handle = display.display('x') |
|
353 | 353 | nt.assert_is(handle, None) |
|
354 | 354 | handle = display.display('y', display_id='secret') |
|
355 | 355 | nt.assert_is_instance(handle, display.DisplayHandle) |
|
356 | 356 | handle2 = display.display('z', display_id=True) |
|
357 | 357 | nt.assert_is_instance(handle2, display.DisplayHandle) |
|
358 | 358 | nt.assert_not_equal(handle.display_id, handle2.display_id) |
|
359 | 359 | |
|
360 | 360 | nt.assert_equal(pub.call_count, 3) |
|
361 | 361 | args, kwargs = pub.call_args_list[0] |
|
362 | 362 | nt.assert_equal(args, ()) |
|
363 | 363 | nt.assert_equal(kwargs, { |
|
364 | 364 | 'data': { |
|
365 | 365 | 'text/plain': repr('x') |
|
366 | 366 | }, |
|
367 | 367 | 'metadata': {}, |
|
368 | 368 | }) |
|
369 | 369 | args, kwargs = pub.call_args_list[1] |
|
370 | 370 | nt.assert_equal(args, ()) |
|
371 | 371 | nt.assert_equal(kwargs, { |
|
372 | 372 | 'data': { |
|
373 | 373 | 'text/plain': repr('y') |
|
374 | 374 | }, |
|
375 | 375 | 'metadata': {}, |
|
376 | 376 | 'transient': { |
|
377 | 377 | 'display_id': handle.display_id, |
|
378 | 378 | }, |
|
379 | 379 | }) |
|
380 | 380 | args, kwargs = pub.call_args_list[2] |
|
381 | 381 | nt.assert_equal(args, ()) |
|
382 | 382 | nt.assert_equal(kwargs, { |
|
383 | 383 | 'data': { |
|
384 | 384 | 'text/plain': repr('z') |
|
385 | 385 | }, |
|
386 | 386 | 'metadata': {}, |
|
387 | 387 | 'transient': { |
|
388 | 388 | 'display_id': handle2.display_id, |
|
389 | 389 | }, |
|
390 | 390 | }) |
|
391 | 391 | |
|
392 | 392 | |
|
393 | 393 | def test_update_display(): |
|
394 | 394 | ip = get_ipython() |
|
395 | 395 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
396 | 396 | with nt.assert_raises(TypeError): |
|
397 | 397 | display.update_display('x') |
|
398 | 398 | display.update_display('x', display_id='1') |
|
399 | 399 | display.update_display('y', display_id='2') |
|
400 | 400 | args, kwargs = pub.call_args_list[0] |
|
401 | 401 | nt.assert_equal(args, ()) |
|
402 | 402 | nt.assert_equal(kwargs, { |
|
403 | 403 | 'data': { |
|
404 | 404 | 'text/plain': repr('x') |
|
405 | 405 | }, |
|
406 | 406 | 'metadata': {}, |
|
407 | 407 | 'transient': { |
|
408 | 408 | 'display_id': '1', |
|
409 | 409 | }, |
|
410 | 410 | 'update': True, |
|
411 | 411 | }) |
|
412 | 412 | args, kwargs = pub.call_args_list[1] |
|
413 | 413 | nt.assert_equal(args, ()) |
|
414 | 414 | nt.assert_equal(kwargs, { |
|
415 | 415 | 'data': { |
|
416 | 416 | 'text/plain': repr('y') |
|
417 | 417 | }, |
|
418 | 418 | 'metadata': {}, |
|
419 | 419 | 'transient': { |
|
420 | 420 | 'display_id': '2', |
|
421 | 421 | }, |
|
422 | 422 | 'update': True, |
|
423 | 423 | }) |
|
424 | 424 | |
|
425 | 425 | |
|
426 | 426 | def test_display_handle(): |
|
427 | 427 | ip = get_ipython() |
|
428 | 428 | handle = display.DisplayHandle() |
|
429 | 429 | nt.assert_is_instance(handle.display_id, str) |
|
430 | 430 | handle = display.DisplayHandle('my-id') |
|
431 | 431 | nt.assert_equal(handle.display_id, 'my-id') |
|
432 | 432 | with mock.patch.object(ip.display_pub, 'publish') as pub: |
|
433 | 433 | handle.display('x') |
|
434 | 434 | handle.update('y') |
|
435 | 435 | |
|
436 | 436 | args, kwargs = pub.call_args_list[0] |
|
437 | 437 | nt.assert_equal(args, ()) |
|
438 | 438 | nt.assert_equal(kwargs, { |
|
439 | 439 | 'data': { |
|
440 | 440 | 'text/plain': repr('x') |
|
441 | 441 | }, |
|
442 | 442 | 'metadata': {}, |
|
443 | 443 | 'transient': { |
|
444 | 444 | 'display_id': handle.display_id, |
|
445 | 445 | } |
|
446 | 446 | }) |
|
447 | 447 | args, kwargs = pub.call_args_list[1] |
|
448 | 448 | nt.assert_equal(args, ()) |
|
449 | 449 | nt.assert_equal(kwargs, { |
|
450 | 450 | 'data': { |
|
451 | 451 | 'text/plain': repr('y') |
|
452 | 452 | }, |
|
453 | 453 | 'metadata': {}, |
|
454 | 454 | 'transient': { |
|
455 | 455 | 'display_id': handle.display_id, |
|
456 | 456 | }, |
|
457 | 457 | 'update': True, |
|
458 | 458 | }) |
|
459 | 459 | |
|
460 | 460 | |
|
461 | 461 | @nt.raises(FileNotFoundError) |
|
462 | 462 | def test_image_bad_filename_raises_proper_exception(): |
|
463 | 463 | display.Image("/this/file/does/not/exist/")._repr_png_() |
@@ -1,265 +1,268 b'' | |||
|
1 | 1 | """Tests for pylab tools module. |
|
2 | 2 | """ |
|
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 | from io import UnsupportedOperation, BytesIO |
|
9 | 9 | |
|
10 | 10 | import matplotlib |
|
11 | 11 | matplotlib.use('Agg') |
|
12 | 12 | from matplotlib.figure import Figure |
|
13 | 13 | |
|
14 | 14 | from nose import SkipTest |
|
15 | 15 | import nose.tools as nt |
|
16 | 16 | |
|
17 | 17 | from matplotlib import pyplot as plt |
|
18 | import matplotlib_inline | |
|
18 | 19 | import numpy as np |
|
19 | 20 | |
|
20 | 21 | from IPython.core.getipython import get_ipython |
|
21 | 22 | from IPython.core.interactiveshell import InteractiveShell |
|
22 | 23 | from IPython.core.display import _PNG, _JPEG |
|
23 | 24 | from .. import pylabtools as pt |
|
24 | 25 | |
|
25 | 26 | from IPython.testing import decorators as dec |
|
26 | 27 | |
|
27 | 28 | |
|
28 | 29 | def test_figure_to_svg(): |
|
29 | 30 | # simple empty-figure test |
|
30 | 31 | fig = plt.figure() |
|
31 | 32 | nt.assert_equal(pt.print_figure(fig, 'svg'), None) |
|
32 | 33 | |
|
33 | 34 | plt.close('all') |
|
34 | 35 | |
|
35 | 36 | # simple check for at least svg-looking output |
|
36 | 37 | fig = plt.figure() |
|
37 | 38 | ax = fig.add_subplot(1,1,1) |
|
38 | 39 | ax.plot([1,2,3]) |
|
39 | 40 | plt.draw() |
|
40 | 41 | svg = pt.print_figure(fig, 'svg')[:100].lower() |
|
41 | 42 | nt.assert_in(u'doctype svg', svg) |
|
42 | 43 | |
|
43 | 44 | def _check_pil_jpeg_bytes(): |
|
44 | 45 | """Skip if PIL can't write JPEGs to BytesIO objects""" |
|
45 | 46 | # PIL's JPEG plugin can't write to BytesIO objects |
|
46 | 47 | # Pillow fixes this |
|
47 | 48 | from PIL import Image |
|
48 | 49 | buf = BytesIO() |
|
49 | 50 | img = Image.new("RGB", (4,4)) |
|
50 | 51 | try: |
|
51 | 52 | img.save(buf, 'jpeg') |
|
52 | 53 | except Exception as e: |
|
53 | 54 | ename = e.__class__.__name__ |
|
54 | 55 | raise SkipTest("PIL can't write JPEG to BytesIO: %s: %s" % (ename, e)) from e |
|
55 | 56 | |
|
56 | 57 | @dec.skip_without("PIL.Image") |
|
57 | 58 | def test_figure_to_jpeg(): |
|
58 | 59 | _check_pil_jpeg_bytes() |
|
59 | 60 | # simple check for at least jpeg-looking output |
|
60 | 61 | fig = plt.figure() |
|
61 | 62 | ax = fig.add_subplot(1,1,1) |
|
62 | 63 | ax.plot([1,2,3]) |
|
63 | 64 | plt.draw() |
|
64 | 65 | jpeg = pt.print_figure(fig, 'jpeg', pil_kwargs={'optimize': 50})[:100].lower() |
|
65 | 66 | assert jpeg.startswith(_JPEG) |
|
66 | 67 | |
|
67 | 68 | def test_retina_figure(): |
|
68 | 69 | # simple empty-figure test |
|
69 | 70 | fig = plt.figure() |
|
70 | 71 | nt.assert_equal(pt.retina_figure(fig), None) |
|
71 | 72 | plt.close('all') |
|
72 | 73 | |
|
73 | 74 | fig = plt.figure() |
|
74 | 75 | ax = fig.add_subplot(1,1,1) |
|
75 | 76 | ax.plot([1,2,3]) |
|
76 | 77 | plt.draw() |
|
77 | 78 | png, md = pt.retina_figure(fig) |
|
78 | 79 | assert png.startswith(_PNG) |
|
79 | 80 | nt.assert_in('width', md) |
|
80 | 81 | nt.assert_in('height', md) |
|
81 | 82 | |
|
82 | 83 | _fmt_mime_map = { |
|
83 | 84 | 'png': 'image/png', |
|
84 | 85 | 'jpeg': 'image/jpeg', |
|
85 | 86 | 'pdf': 'application/pdf', |
|
86 | 87 | 'retina': 'image/png', |
|
87 | 88 | 'svg': 'image/svg+xml', |
|
88 | 89 | } |
|
89 | 90 | |
|
90 | 91 | def test_select_figure_formats_str(): |
|
91 | 92 | ip = get_ipython() |
|
92 | 93 | for fmt, active_mime in _fmt_mime_map.items(): |
|
93 | 94 | pt.select_figure_formats(ip, fmt) |
|
94 | 95 | for mime, f in ip.display_formatter.formatters.items(): |
|
95 | 96 | if mime == active_mime: |
|
96 | 97 | nt.assert_in(Figure, f) |
|
97 | 98 | else: |
|
98 | 99 | nt.assert_not_in(Figure, f) |
|
99 | 100 | |
|
100 | 101 | def test_select_figure_formats_kwargs(): |
|
101 | 102 | ip = get_ipython() |
|
102 | 103 | kwargs = dict(quality=10, bbox_inches='tight') |
|
103 | 104 | pt.select_figure_formats(ip, 'png', **kwargs) |
|
104 | 105 | formatter = ip.display_formatter.formatters['image/png'] |
|
105 | 106 | f = formatter.lookup_by_type(Figure) |
|
106 | 107 | cell = f.__closure__[0].cell_contents |
|
107 | 108 | nt.assert_equal(cell, kwargs) |
|
108 | 109 | |
|
109 | 110 | # check that the formatter doesn't raise |
|
110 | 111 | fig = plt.figure() |
|
111 | 112 | ax = fig.add_subplot(1,1,1) |
|
112 | 113 | ax.plot([1,2,3]) |
|
113 | 114 | plt.draw() |
|
114 | 115 | formatter.enabled = True |
|
115 | 116 | png = formatter(fig) |
|
116 | 117 | assert png.startswith(_PNG) |
|
117 | 118 | |
|
118 | 119 | def test_select_figure_formats_set(): |
|
119 | 120 | ip = get_ipython() |
|
120 | 121 | for fmts in [ |
|
121 | 122 | {'png', 'svg'}, |
|
122 | 123 | ['png'], |
|
123 | 124 | ('jpeg', 'pdf', 'retina'), |
|
124 | 125 | {'svg'}, |
|
125 | 126 | ]: |
|
126 | 127 | active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} |
|
127 | 128 | pt.select_figure_formats(ip, fmts) |
|
128 | 129 | for mime, f in ip.display_formatter.formatters.items(): |
|
129 | 130 | if mime in active_mimes: |
|
130 | 131 | nt.assert_in(Figure, f) |
|
131 | 132 | else: |
|
132 | 133 | nt.assert_not_in(Figure, f) |
|
133 | 134 | |
|
134 | 135 | def test_select_figure_formats_bad(): |
|
135 | 136 | ip = get_ipython() |
|
136 | 137 | with nt.assert_raises(ValueError): |
|
137 | 138 | pt.select_figure_formats(ip, 'foo') |
|
138 | 139 | with nt.assert_raises(ValueError): |
|
139 | 140 | pt.select_figure_formats(ip, {'png', 'foo'}) |
|
140 | 141 | with nt.assert_raises(ValueError): |
|
141 | 142 | pt.select_figure_formats(ip, ['retina', 'pdf', 'bar', 'bad']) |
|
142 | 143 | |
|
143 | 144 | def test_import_pylab(): |
|
144 | 145 | ns = {} |
|
145 | 146 | pt.import_pylab(ns, import_all=False) |
|
146 | 147 | nt.assert_true('plt' in ns) |
|
147 | 148 | nt.assert_equal(ns['np'], np) |
|
148 | 149 | |
|
149 | 150 | from traitlets.config import Config |
|
150 | 151 | |
|
151 | 152 | |
|
152 | 153 | class TestPylabSwitch(object): |
|
153 | 154 | class Shell(InteractiveShell): |
|
154 | 155 | def init_history(self): |
|
155 | 156 | """Sets up the command history, and starts regular autosaves.""" |
|
156 | 157 | self.config.HistoryManager.hist_file = ":memory:" |
|
157 | 158 | super().init_history() |
|
158 | 159 | |
|
159 | 160 | def enable_gui(self, gui): |
|
160 | 161 | pass |
|
161 | 162 | |
|
162 | 163 | def setup(self): |
|
163 | 164 | import matplotlib |
|
164 | 165 | def act_mpl(backend): |
|
165 | 166 | matplotlib.rcParams['backend'] = backend |
|
166 | 167 | |
|
167 | 168 | # Save rcParams since they get modified |
|
168 | 169 | self._saved_rcParams = matplotlib.rcParams |
|
169 | 170 | self._saved_rcParamsOrig = matplotlib.rcParamsOrig |
|
170 | 171 | matplotlib.rcParams = dict(backend='Qt4Agg') |
|
171 | 172 | matplotlib.rcParamsOrig = dict(backend='Qt4Agg') |
|
172 | 173 | |
|
173 | 174 | # Mock out functions |
|
174 | 175 | self._save_am = pt.activate_matplotlib |
|
175 | 176 | pt.activate_matplotlib = act_mpl |
|
176 | 177 | self._save_ip = pt.import_pylab |
|
177 | 178 | pt.import_pylab = lambda *a,**kw:None |
|
178 | self._save_cis = pt.configure_inline_support | |
|
179 |
pt.configure_inline_support = |
|
|
179 | self._save_cis = matplotlib_inline.backend_inline.configure_inline_support | |
|
180 | matplotlib_inline.backend_inline.configure_inline_support = ( | |
|
181 | lambda *a, **kw: None | |
|
182 | ) | |
|
180 | 183 | |
|
181 | 184 | def teardown(self): |
|
182 | 185 | pt.activate_matplotlib = self._save_am |
|
183 | 186 | pt.import_pylab = self._save_ip |
|
184 | pt.configure_inline_support = self._save_cis | |
|
187 | matplotlib_inline.backend_inline.configure_inline_support = self._save_cis | |
|
185 | 188 | import matplotlib |
|
186 | 189 | matplotlib.rcParams = self._saved_rcParams |
|
187 | 190 | matplotlib.rcParamsOrig = self._saved_rcParamsOrig |
|
188 | 191 | |
|
189 | 192 | def test_qt(self): |
|
190 | 193 | |
|
191 | 194 | s = self.Shell() |
|
192 | 195 | gui, backend = s.enable_matplotlib(None) |
|
193 | 196 | nt.assert_equal(gui, 'qt') |
|
194 | 197 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
195 | 198 | |
|
196 | 199 | gui, backend = s.enable_matplotlib('inline') |
|
197 | 200 | nt.assert_equal(gui, 'inline') |
|
198 | 201 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
199 | 202 | |
|
200 | 203 | gui, backend = s.enable_matplotlib('qt') |
|
201 | 204 | nt.assert_equal(gui, 'qt') |
|
202 | 205 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
203 | 206 | |
|
204 | 207 | gui, backend = s.enable_matplotlib('inline') |
|
205 | 208 | nt.assert_equal(gui, 'inline') |
|
206 | 209 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
207 | 210 | |
|
208 | 211 | gui, backend = s.enable_matplotlib() |
|
209 | 212 | nt.assert_equal(gui, 'qt') |
|
210 | 213 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
211 | 214 | |
|
212 | 215 | def test_inline(self): |
|
213 | 216 | s = self.Shell() |
|
214 | 217 | gui, backend = s.enable_matplotlib('inline') |
|
215 | 218 | nt.assert_equal(gui, 'inline') |
|
216 | 219 | nt.assert_equal(s.pylab_gui_select, None) |
|
217 | 220 | |
|
218 | 221 | gui, backend = s.enable_matplotlib('inline') |
|
219 | 222 | nt.assert_equal(gui, 'inline') |
|
220 | 223 | nt.assert_equal(s.pylab_gui_select, None) |
|
221 | 224 | |
|
222 | 225 | gui, backend = s.enable_matplotlib('qt') |
|
223 | 226 | nt.assert_equal(gui, 'qt') |
|
224 | 227 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
225 | 228 | |
|
226 | 229 | def test_inline_twice(self): |
|
227 | 230 | "Using '%matplotlib inline' twice should not reset formatters" |
|
228 | 231 | |
|
229 | 232 | ip = self.Shell() |
|
230 | 233 | gui, backend = ip.enable_matplotlib('inline') |
|
231 | 234 | nt.assert_equal(gui, 'inline') |
|
232 | 235 | |
|
233 | 236 | fmts = {'png'} |
|
234 | 237 | active_mimes = {_fmt_mime_map[fmt] for fmt in fmts} |
|
235 | 238 | pt.select_figure_formats(ip, fmts) |
|
236 | 239 | |
|
237 | 240 | gui, backend = ip.enable_matplotlib('inline') |
|
238 | 241 | nt.assert_equal(gui, 'inline') |
|
239 | 242 | |
|
240 | 243 | for mime, f in ip.display_formatter.formatters.items(): |
|
241 | 244 | if mime in active_mimes: |
|
242 | 245 | nt.assert_in(Figure, f) |
|
243 | 246 | else: |
|
244 | 247 | nt.assert_not_in(Figure, f) |
|
245 | 248 | |
|
246 | 249 | def test_qt_gtk(self): |
|
247 | 250 | s = self.Shell() |
|
248 | 251 | gui, backend = s.enable_matplotlib('qt') |
|
249 | 252 | nt.assert_equal(gui, 'qt') |
|
250 | 253 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
251 | 254 | |
|
252 | 255 | gui, backend = s.enable_matplotlib('gtk') |
|
253 | 256 | nt.assert_equal(gui, 'qt') |
|
254 | 257 | nt.assert_equal(s.pylab_gui_select, 'qt') |
|
255 | 258 | |
|
256 | 259 | |
|
257 | 260 | def test_no_gui_backends(): |
|
258 | 261 | for k in ['agg', 'svg', 'pdf', 'ps']: |
|
259 | 262 | assert k not in pt.backend2gui |
|
260 | 263 | |
|
261 | 264 | |
|
262 | 265 | def test_figure_no_canvas(): |
|
263 | 266 | fig = Figure() |
|
264 | 267 | fig.canvas = None |
|
265 | 268 | pt.print_figure(fig) |
@@ -1,271 +1,272 b'' | |||
|
1 | 1 | #!/usr/bin/env python3 |
|
2 | 2 | # -*- coding: utf-8 -*- |
|
3 | 3 | """Setup script for IPython. |
|
4 | 4 | |
|
5 | 5 | Under Posix environments it works like a typical setup.py script. |
|
6 | 6 | Under Windows, the command sdist is not supported, since IPython |
|
7 | 7 | requires utilities which are not available under Windows.""" |
|
8 | 8 | |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | # Copyright (c) 2008-2011, IPython Development Team. |
|
11 | 11 | # Copyright (c) 2001-2007, Fernando Perez <fernando.perez@colorado.edu> |
|
12 | 12 | # Copyright (c) 2001, Janko Hauser <jhauser@zscout.de> |
|
13 | 13 | # Copyright (c) 2001, Nathaniel Gray <n8gray@caltech.edu> |
|
14 | 14 | # |
|
15 | 15 | # Distributed under the terms of the Modified BSD License. |
|
16 | 16 | # |
|
17 | 17 | # The full license is in the file COPYING.rst, distributed with this software. |
|
18 | 18 | #----------------------------------------------------------------------------- |
|
19 | 19 | |
|
20 | 20 | import os |
|
21 | 21 | import sys |
|
22 | 22 | from pathlib import Path |
|
23 | 23 | |
|
24 | 24 | # **Python version check** |
|
25 | 25 | # |
|
26 | 26 | # This check is also made in IPython/__init__, don't forget to update both when |
|
27 | 27 | # changing Python version requirements. |
|
28 | 28 | if sys.version_info < (3, 7): |
|
29 | 29 | pip_message = 'This may be due to an out of date pip. Make sure you have pip >= 9.0.1.' |
|
30 | 30 | try: |
|
31 | 31 | import pip |
|
32 | 32 | pip_version = tuple([int(x) for x in pip.__version__.split('.')[:3]]) |
|
33 | 33 | if pip_version < (9, 0, 1) : |
|
34 | 34 | pip_message = 'Your pip version is out of date, please install pip >= 9.0.1. '\ |
|
35 | 35 | 'pip {} detected.'.format(pip.__version__) |
|
36 | 36 | else: |
|
37 | 37 | # pip is new enough - it must be something else |
|
38 | 38 | pip_message = '' |
|
39 | 39 | except Exception: |
|
40 | 40 | pass |
|
41 | 41 | |
|
42 | 42 | |
|
43 | 43 | error = """ |
|
44 | 44 | IPython 7.17+ supports Python 3.7 and above, following NEP 29. |
|
45 | 45 | When using Python 2.7, please install IPython 5.x LTS Long Term Support version. |
|
46 | 46 | Python 3.3 and 3.4 were supported up to IPython 6.x. |
|
47 | 47 | Python 3.5 was supported with IPython 7.0 to 7.9. |
|
48 | 48 | Python 3.6 was supported with IPython up to 7.16. |
|
49 | 49 | |
|
50 | 50 | See IPython `README.rst` file for more information: |
|
51 | 51 | |
|
52 | 52 | https://github.com/ipython/ipython/blob/master/README.rst |
|
53 | 53 | |
|
54 | 54 | Python {py} detected. |
|
55 | 55 | {pip} |
|
56 | 56 | """.format(py=sys.version_info, pip=pip_message ) |
|
57 | 57 | |
|
58 | 58 | print(error, file=sys.stderr) |
|
59 | 59 | sys.exit(1) |
|
60 | 60 | |
|
61 | 61 | # At least we're on the python version we need, move on. |
|
62 | 62 | |
|
63 | 63 | # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly |
|
64 | 64 | # update it when the contents of directories change. |
|
65 | 65 | if Path("MANIFEST").exists(): |
|
66 | 66 | Path("MANIFEST").unlink() |
|
67 | 67 | |
|
68 | 68 | from distutils.core import setup |
|
69 | 69 | |
|
70 | 70 | # Our own imports |
|
71 | 71 | from setupbase import target_update |
|
72 | 72 | |
|
73 | 73 | from setupbase import ( |
|
74 | 74 | setup_args, |
|
75 | 75 | find_packages, |
|
76 | 76 | find_package_data, |
|
77 | 77 | check_package_data_first, |
|
78 | 78 | find_entry_points, |
|
79 | 79 | build_scripts_entrypt, |
|
80 | 80 | find_data_files, |
|
81 | 81 | git_prebuild, |
|
82 | 82 | install_symlinked, |
|
83 | 83 | install_lib_symlink, |
|
84 | 84 | install_scripts_for_symlink, |
|
85 | 85 | unsymlink, |
|
86 | 86 | ) |
|
87 | 87 | |
|
88 | 88 | #------------------------------------------------------------------------------- |
|
89 | 89 | # Handle OS specific things |
|
90 | 90 | #------------------------------------------------------------------------------- |
|
91 | 91 | |
|
92 | 92 | if os.name in ('nt','dos'): |
|
93 | 93 | os_name = 'windows' |
|
94 | 94 | else: |
|
95 | 95 | os_name = os.name |
|
96 | 96 | |
|
97 | 97 | # Under Windows, 'sdist' has not been supported. Now that the docs build with |
|
98 | 98 | # Sphinx it might work, but let's not turn it on until someone confirms that it |
|
99 | 99 | # actually works. |
|
100 | 100 | if os_name == 'windows' and 'sdist' in sys.argv: |
|
101 | 101 | print('The sdist command is not available under Windows. Exiting.') |
|
102 | 102 | sys.exit(1) |
|
103 | 103 | |
|
104 | 104 | |
|
105 | 105 | #------------------------------------------------------------------------------- |
|
106 | 106 | # Things related to the IPython documentation |
|
107 | 107 | #------------------------------------------------------------------------------- |
|
108 | 108 | |
|
109 | 109 | # update the manuals when building a source dist |
|
110 | 110 | if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'): |
|
111 | 111 | |
|
112 | 112 | # List of things to be updated. Each entry is a triplet of args for |
|
113 | 113 | # target_update() |
|
114 | 114 | to_update = [ |
|
115 | 115 | ('docs/man/ipython.1.gz', |
|
116 | 116 | ['docs/man/ipython.1'], |
|
117 | 117 | 'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'), |
|
118 | 118 | ] |
|
119 | 119 | |
|
120 | 120 | |
|
121 | 121 | [ target_update(*t) for t in to_update ] |
|
122 | 122 | |
|
123 | 123 | #--------------------------------------------------------------------------- |
|
124 | 124 | # Find all the packages, package data, and data_files |
|
125 | 125 | #--------------------------------------------------------------------------- |
|
126 | 126 | |
|
127 | 127 | packages = find_packages() |
|
128 | 128 | package_data = find_package_data() |
|
129 | 129 | |
|
130 | 130 | data_files = find_data_files() |
|
131 | 131 | |
|
132 | 132 | setup_args['packages'] = packages |
|
133 | 133 | setup_args['package_data'] = package_data |
|
134 | 134 | setup_args['data_files'] = data_files |
|
135 | 135 | |
|
136 | 136 | #--------------------------------------------------------------------------- |
|
137 | 137 | # custom distutils commands |
|
138 | 138 | #--------------------------------------------------------------------------- |
|
139 | 139 | # imports here, so they are after setuptools import if there was one |
|
140 | 140 | from distutils.command.sdist import sdist |
|
141 | 141 | |
|
142 | 142 | setup_args['cmdclass'] = { |
|
143 | 143 | 'build_py': \ |
|
144 | 144 | check_package_data_first(git_prebuild('IPython')), |
|
145 | 145 | 'sdist' : git_prebuild('IPython', sdist), |
|
146 | 146 | 'symlink': install_symlinked, |
|
147 | 147 | 'install_lib_symlink': install_lib_symlink, |
|
148 | 148 | 'install_scripts_sym': install_scripts_for_symlink, |
|
149 | 149 | 'unsymlink': unsymlink, |
|
150 | 150 | } |
|
151 | 151 | |
|
152 | 152 | |
|
153 | 153 | #--------------------------------------------------------------------------- |
|
154 | 154 | # Handle scripts, dependencies, and setuptools specific things |
|
155 | 155 | #--------------------------------------------------------------------------- |
|
156 | 156 | |
|
157 | 157 | # For some commands, use setuptools. Note that we do NOT list install here! |
|
158 | 158 | # If you want a setuptools-enhanced install, just run 'setupegg.py install' |
|
159 | 159 | needs_setuptools = {'develop', 'release', 'bdist_egg', 'bdist_rpm', |
|
160 | 160 | 'bdist', 'bdist_dumb', 'bdist_wininst', 'bdist_wheel', |
|
161 | 161 | 'egg_info', 'easy_install', 'upload', 'install_egg_info', |
|
162 | 162 | } |
|
163 | 163 | |
|
164 | 164 | if len(needs_setuptools.intersection(sys.argv)) > 0: |
|
165 | 165 | import setuptools |
|
166 | 166 | |
|
167 | 167 | # This dict is used for passing extra arguments that are setuptools |
|
168 | 168 | # specific to setup |
|
169 | 169 | setuptools_extra_args = {} |
|
170 | 170 | |
|
171 | 171 | # setuptools requirements |
|
172 | 172 | |
|
173 | 173 | extras_require = dict( |
|
174 | 174 | parallel=["ipyparallel"], |
|
175 | 175 | qtconsole=["qtconsole"], |
|
176 | 176 | doc=["Sphinx>=1.3"], |
|
177 | 177 | test=[ |
|
178 | 178 | "nose>=0.10.1", |
|
179 | 179 | "requests", |
|
180 | 180 | "testpath", |
|
181 | 181 | "pygments", |
|
182 | 182 | "nbformat", |
|
183 | 183 | "ipykernel", |
|
184 | 184 | "numpy>=1.16", |
|
185 | 185 | ], |
|
186 | 186 | terminal=[], |
|
187 | 187 | kernel=["ipykernel"], |
|
188 | 188 | nbformat=["nbformat"], |
|
189 | 189 | notebook=["notebook", "ipywidgets"], |
|
190 | 190 | nbconvert=["nbconvert"], |
|
191 | 191 | ) |
|
192 | 192 | |
|
193 | 193 | install_requires = [ |
|
194 |
|
|
|
195 |
|
|
|
196 |
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
|
201 |
|
|
|
202 |
|
|
|
194 | "setuptools>=18.5", | |
|
195 | "jedi>=0.16", | |
|
196 | "decorator", | |
|
197 | "pickleshare", | |
|
198 | "traitlets>=4.2", | |
|
199 | "prompt_toolkit>=2.0.0,<3.1.0,!=3.0.0,!=3.0.1", | |
|
200 | "pygments", | |
|
201 | "backcall", | |
|
202 | "stack_data", | |
|
203 | "matplotlib-inline", | |
|
203 | 204 | ] |
|
204 | 205 | |
|
205 | 206 | # Platform-specific dependencies: |
|
206 | 207 | # This is the correct way to specify these, |
|
207 | 208 | # but requires pip >= 6. pip < 6 ignores these. |
|
208 | 209 | |
|
209 | 210 | extras_require.update( |
|
210 | 211 | { |
|
211 | 212 | ':sys_platform != "win32"': ["pexpect>4.3"], |
|
212 | 213 | ':sys_platform == "darwin"': ["appnope"], |
|
213 | 214 | ':sys_platform == "win32"': ["colorama"], |
|
214 | 215 | } |
|
215 | 216 | ) |
|
216 | 217 | # FIXME: re-specify above platform dependencies for pip < 6 |
|
217 | 218 | # These would result in non-portable bdists. |
|
218 | 219 | if not any(arg.startswith('bdist') for arg in sys.argv): |
|
219 | 220 | if sys.platform == 'darwin': |
|
220 | 221 | install_requires.extend(['appnope']) |
|
221 | 222 | |
|
222 | 223 | if not sys.platform.startswith("win"): |
|
223 | 224 | install_requires.append("pexpect>4.3") |
|
224 | 225 | |
|
225 | 226 | # workaround pypa/setuptools#147, where setuptools misspells |
|
226 | 227 | # platform_python_implementation as python_implementation |
|
227 | 228 | if 'setuptools' in sys.modules: |
|
228 | 229 | for key in list(extras_require): |
|
229 | 230 | if 'platform_python_implementation' in key: |
|
230 | 231 | new_key = key.replace('platform_python_implementation', 'python_implementation') |
|
231 | 232 | extras_require[new_key] = extras_require.pop(key) |
|
232 | 233 | |
|
233 | 234 | everything = set() |
|
234 | 235 | for key, deps in extras_require.items(): |
|
235 | 236 | if ':' not in key: |
|
236 | 237 | everything.update(deps) |
|
237 | 238 | extras_require['all'] = list(sorted(everything)) |
|
238 | 239 | |
|
239 | 240 | if 'setuptools' in sys.modules: |
|
240 | 241 | setuptools_extra_args['python_requires'] = '>=3.7' |
|
241 | 242 | setuptools_extra_args['zip_safe'] = False |
|
242 | 243 | setuptools_extra_args['entry_points'] = { |
|
243 | 244 | 'console_scripts': find_entry_points(), |
|
244 | 245 | 'pygments.lexers': [ |
|
245 | 246 | 'ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer', |
|
246 | 247 | 'ipython = IPython.lib.lexers:IPythonLexer', |
|
247 | 248 | 'ipython3 = IPython.lib.lexers:IPython3Lexer', |
|
248 | 249 | ], |
|
249 | 250 | } |
|
250 | 251 | setup_args['extras_require'] = extras_require |
|
251 | 252 | setup_args['install_requires'] = install_requires |
|
252 | 253 | |
|
253 | 254 | else: |
|
254 | 255 | # scripts has to be a non-empty list, or install_scripts isn't called |
|
255 | 256 | setup_args['scripts'] = [e.split('=')[0].strip() for e in find_entry_points()] |
|
256 | 257 | |
|
257 | 258 | setup_args['cmdclass']['build_scripts'] = build_scripts_entrypt |
|
258 | 259 | |
|
259 | 260 | #--------------------------------------------------------------------------- |
|
260 | 261 | # Do the actual setup now |
|
261 | 262 | #--------------------------------------------------------------------------- |
|
262 | 263 | |
|
263 | 264 | setup_args.update(setuptools_extra_args) |
|
264 | 265 | |
|
265 | 266 | |
|
266 | 267 | |
|
267 | 268 | def main(): |
|
268 | 269 | setup(**setup_args) |
|
269 | 270 | |
|
270 | 271 | if __name__ == '__main__': |
|
271 | 272 | main() |
General Comments 0
You need to be logged in to leave comments.
Login now