Show More
@@ -1,1024 +1,1024 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Display formatters. |
|
3 | 3 | |
|
4 | 4 | Inheritance diagram: |
|
5 | 5 | |
|
6 | 6 | .. inheritance-diagram:: IPython.core.formatters |
|
7 | 7 | :parts: 3 |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | # Copyright (c) IPython Development Team. |
|
11 | 11 | # Distributed under the terms of the Modified BSD License. |
|
12 | 12 | |
|
13 | 13 | import abc |
|
14 | 14 | import json |
|
15 | 15 | import sys |
|
16 | 16 | import traceback |
|
17 | 17 | import warnings |
|
18 | 18 | from io import StringIO |
|
19 | 19 | |
|
20 | 20 | from decorator import decorator |
|
21 | 21 | |
|
22 | 22 | from traitlets.config.configurable import Configurable |
|
23 | 23 | from .getipython import get_ipython |
|
24 | 24 | from ..utils.sentinel import Sentinel |
|
25 | 25 | from ..utils.dir2 import get_real_method |
|
26 | 26 | from ..lib import pretty |
|
27 | 27 | from traitlets import ( |
|
28 | 28 | Bool, Dict, Integer, Unicode, CUnicode, ObjectName, List, |
|
29 | 29 | ForwardDeclaredInstance, |
|
30 | 30 | default, observe, |
|
31 | 31 | ) |
|
32 | 32 | |
|
33 | 33 | |
|
34 | 34 | class DisplayFormatter(Configurable): |
|
35 | 35 | |
|
36 | 36 | active_types = List(Unicode(), |
|
37 | 37 | help="""List of currently active mime-types to display. |
|
38 | 38 | You can use this to set a white-list for formats to display. |
|
39 | 39 | |
|
40 | 40 | Most users will not need to change this value. |
|
41 | 41 | """).tag(config=True) |
|
42 | 42 | |
|
43 | 43 | @default('active_types') |
|
44 | 44 | def _active_types_default(self): |
|
45 | 45 | return self.format_types |
|
46 | 46 | |
|
47 | 47 | @observe('active_types') |
|
48 | 48 | def _active_types_changed(self, change): |
|
49 | 49 | for key, formatter in self.formatters.items(): |
|
50 | 50 | if key in change['new']: |
|
51 | 51 | formatter.enabled = True |
|
52 | 52 | else: |
|
53 | 53 | formatter.enabled = False |
|
54 | 54 | |
|
55 | 55 | ipython_display_formatter = ForwardDeclaredInstance('FormatterABC') |
|
56 | 56 | @default('ipython_display_formatter') |
|
57 | 57 | def _default_formatter(self): |
|
58 | 58 | return IPythonDisplayFormatter(parent=self) |
|
59 | 59 | |
|
60 | 60 | mimebundle_formatter = ForwardDeclaredInstance('FormatterABC') |
|
61 | 61 | @default('mimebundle_formatter') |
|
62 | 62 | def _default_mime_formatter(self): |
|
63 | 63 | return MimeBundleFormatter(parent=self) |
|
64 | 64 | |
|
65 | 65 | # A dict of formatter whose keys are format types (MIME types) and whose |
|
66 | 66 | # values are subclasses of BaseFormatter. |
|
67 | 67 | formatters = Dict() |
|
68 | 68 | @default('formatters') |
|
69 | 69 | def _formatters_default(self): |
|
70 | 70 | """Activate the default formatters.""" |
|
71 | 71 | formatter_classes = [ |
|
72 | 72 | PlainTextFormatter, |
|
73 | 73 | HTMLFormatter, |
|
74 | 74 | MarkdownFormatter, |
|
75 | 75 | SVGFormatter, |
|
76 | 76 | PNGFormatter, |
|
77 | 77 | PDFFormatter, |
|
78 | 78 | JPEGFormatter, |
|
79 | 79 | LatexFormatter, |
|
80 | 80 | JSONFormatter, |
|
81 | 81 | JavascriptFormatter |
|
82 | 82 | ] |
|
83 | 83 | d = {} |
|
84 | 84 | for cls in formatter_classes: |
|
85 | 85 | f = cls(parent=self) |
|
86 | 86 | d[f.format_type] = f |
|
87 | 87 | return d |
|
88 | 88 | |
|
89 | 89 | def format(self, obj, include=None, exclude=None): |
|
90 | 90 | """Return a format data dict for an object. |
|
91 | 91 | |
|
92 | 92 | By default all format types will be computed. |
|
93 | 93 | |
|
94 | 94 | The following MIME types are usually implemented: |
|
95 | 95 | |
|
96 | 96 | * text/plain |
|
97 | 97 | * text/html |
|
98 | 98 | * text/markdown |
|
99 | 99 | * text/latex |
|
100 | 100 | * application/json |
|
101 | 101 | * application/javascript |
|
102 | 102 | * application/pdf |
|
103 | 103 | * image/png |
|
104 | 104 | * image/jpeg |
|
105 | 105 | * image/svg+xml |
|
106 | 106 | |
|
107 | 107 | Parameters |
|
108 | 108 | ---------- |
|
109 | 109 | obj : object |
|
110 | 110 | The Python object whose format data will be computed. |
|
111 | 111 | include : list, tuple or set; optional |
|
112 | 112 | A list of format type strings (MIME types) to include in the |
|
113 | 113 | format data dict. If this is set *only* the format types included |
|
114 | 114 | in this list will be computed. |
|
115 | 115 | exclude : list, tuple or set; optional |
|
116 | 116 | A list of format type string (MIME types) to exclude in the format |
|
117 | 117 | data dict. If this is set all format types will be computed, |
|
118 | 118 | except for those included in this argument. |
|
119 | 119 | Mimetypes present in exclude will take precedence over the ones in include |
|
120 | 120 | |
|
121 | 121 | Returns |
|
122 | 122 | ------- |
|
123 | 123 | (format_dict, metadata_dict) : tuple of two dicts |
|
124 | 124 | |
|
125 | 125 | format_dict is a dictionary of key/value pairs, one of each format that was |
|
126 | 126 | generated for the object. The keys are the format types, which |
|
127 | 127 | will usually be MIME type strings and the values and JSON'able |
|
128 | 128 | data structure containing the raw data for the representation in |
|
129 | 129 | that format. |
|
130 | 130 | |
|
131 | 131 | metadata_dict is a dictionary of metadata about each mime-type output. |
|
132 | 132 | Its keys will be a strict subset of the keys in format_dict. |
|
133 | 133 | |
|
134 | 134 | Notes |
|
135 | 135 | ----- |
|
136 | 136 | |
|
137 | 137 | If an object implement `_repr_mimebundle_` as well as various |
|
138 | 138 | `_repr_*_`, the data returned by `_repr_mimebundle_` will take |
|
139 | 139 | precedence and the corresponding `_repr_*_` for this mimetype will |
|
140 | 140 | not be called. |
|
141 | 141 | |
|
142 | 142 | """ |
|
143 | 143 | format_dict = {} |
|
144 | 144 | md_dict = {} |
|
145 | 145 | |
|
146 | 146 | if self.ipython_display_formatter(obj): |
|
147 | 147 | # object handled itself, don't proceed |
|
148 | 148 | return {}, {} |
|
149 | 149 | |
|
150 | 150 | format_dict, md_dict = self.mimebundle_formatter(obj, include=include, exclude=exclude) |
|
151 | 151 | |
|
152 | 152 | if format_dict or md_dict: |
|
153 | 153 | if include: |
|
154 | 154 | format_dict = {k:v for k,v in format_dict.items() if k in include} |
|
155 | 155 | md_dict = {k:v for k,v in md_dict.items() if k in include} |
|
156 | 156 | if exclude: |
|
157 | 157 | format_dict = {k:v for k,v in format_dict.items() if k not in exclude} |
|
158 | 158 | md_dict = {k:v for k,v in md_dict.items() if k not in exclude} |
|
159 | 159 | |
|
160 | 160 | for format_type, formatter in self.formatters.items(): |
|
161 | 161 | if format_type in format_dict: |
|
162 | 162 | # already got it from mimebundle, maybe don't render again. |
|
163 | 163 | # exception: manually registered per-mime renderer |
|
164 | 164 | # check priority: |
|
165 | 165 | # 1. user-registered per-mime formatter |
|
166 | 166 | # 2. mime-bundle (user-registered or repr method) |
|
167 | 167 | # 3. default per-mime formatter (e.g. repr method) |
|
168 | 168 | try: |
|
169 | 169 | formatter.lookup(obj) |
|
170 | 170 | except KeyError: |
|
171 | 171 | # no special formatter, use mime-bundle-provided value |
|
172 | 172 | continue |
|
173 | 173 | if include and format_type not in include: |
|
174 | 174 | continue |
|
175 | 175 | if exclude and format_type in exclude: |
|
176 | 176 | continue |
|
177 | 177 | |
|
178 | 178 | md = None |
|
179 | 179 | try: |
|
180 | 180 | data = formatter(obj) |
|
181 | 181 | except: |
|
182 | 182 | # FIXME: log the exception |
|
183 | 183 | raise |
|
184 | 184 | |
|
185 | 185 | # formatters can return raw data or (data, metadata) |
|
186 | 186 | if isinstance(data, tuple) and len(data) == 2: |
|
187 | 187 | data, md = data |
|
188 | 188 | |
|
189 | 189 | if data is not None: |
|
190 | 190 | format_dict[format_type] = data |
|
191 | 191 | if md is not None: |
|
192 | 192 | md_dict[format_type] = md |
|
193 | 193 | return format_dict, md_dict |
|
194 | 194 | |
|
195 | 195 | @property |
|
196 | 196 | def format_types(self): |
|
197 | 197 | """Return the format types (MIME types) of the active formatters.""" |
|
198 | 198 | return list(self.formatters.keys()) |
|
199 | 199 | |
|
200 | 200 | |
|
201 | 201 | #----------------------------------------------------------------------------- |
|
202 | 202 | # Formatters for specific format types (text, html, svg, etc.) |
|
203 | 203 | #----------------------------------------------------------------------------- |
|
204 | 204 | |
|
205 | 205 | |
|
206 | 206 | def _safe_repr(obj): |
|
207 | 207 | """Try to return a repr of an object |
|
208 | 208 | |
|
209 | 209 | always returns a string, at least. |
|
210 | 210 | """ |
|
211 | 211 | try: |
|
212 | 212 | return repr(obj) |
|
213 | 213 | except Exception as e: |
|
214 | 214 | return "un-repr-able object (%r)" % e |
|
215 | 215 | |
|
216 | 216 | |
|
217 | 217 | class FormatterWarning(UserWarning): |
|
218 | 218 | """Warning class for errors in formatters""" |
|
219 | 219 | |
|
220 | 220 | @decorator |
|
221 | 221 | def catch_format_error(method, self, *args, **kwargs): |
|
222 | 222 | """show traceback on failed format call""" |
|
223 | 223 | try: |
|
224 | 224 | r = method(self, *args, **kwargs) |
|
225 | 225 | except NotImplementedError: |
|
226 | 226 | # don't warn on NotImplementedErrors |
|
227 | 227 | return self._check_return(None, args[0]) |
|
228 | 228 | except Exception: |
|
229 | 229 | exc_info = sys.exc_info() |
|
230 | 230 | ip = get_ipython() |
|
231 | 231 | if ip is not None: |
|
232 | 232 | ip.showtraceback(exc_info) |
|
233 | 233 | else: |
|
234 | 234 | traceback.print_exception(*exc_info) |
|
235 | 235 | return self._check_return(None, args[0]) |
|
236 | 236 | return self._check_return(r, args[0]) |
|
237 | 237 | |
|
238 | 238 | |
|
239 | 239 | class FormatterABC(metaclass=abc.ABCMeta): |
|
240 | 240 | """ Abstract base class for Formatters. |
|
241 | 241 | |
|
242 | 242 | A formatter is a callable class that is responsible for computing the |
|
243 | 243 | raw format data for a particular format type (MIME type). For example, |
|
244 | 244 | an HTML formatter would have a format type of `text/html` and would return |
|
245 | 245 | the HTML representation of the object when called. |
|
246 | 246 | """ |
|
247 | 247 | |
|
248 | 248 | # The format type of the data returned, usually a MIME type. |
|
249 | 249 | format_type = 'text/plain' |
|
250 | 250 | |
|
251 | 251 | # Is the formatter enabled... |
|
252 | 252 | enabled = True |
|
253 | 253 | |
|
254 | 254 | @abc.abstractmethod |
|
255 | 255 | def __call__(self, obj): |
|
256 | 256 | """Return a JSON'able representation of the object. |
|
257 | 257 | |
|
258 | 258 | If the object cannot be formatted by this formatter, |
|
259 | 259 | warn and return None. |
|
260 | 260 | """ |
|
261 | 261 | return repr(obj) |
|
262 | 262 | |
|
263 | 263 | |
|
264 | 264 | def _mod_name_key(typ): |
|
265 | 265 | """Return a (__module__, __name__) tuple for a type. |
|
266 | 266 | |
|
267 | 267 | Used as key in Formatter.deferred_printers. |
|
268 | 268 | """ |
|
269 | 269 | module = getattr(typ, '__module__', None) |
|
270 | 270 | name = getattr(typ, '__name__', None) |
|
271 | 271 | return (module, name) |
|
272 | 272 | |
|
273 | 273 | |
|
274 | 274 | def _get_type(obj): |
|
275 | 275 | """Return the type of an instance (old and new-style)""" |
|
276 | 276 | return getattr(obj, '__class__', None) or type(obj) |
|
277 | 277 | |
|
278 | 278 | |
|
279 | 279 | _raise_key_error = Sentinel('_raise_key_error', __name__, |
|
280 | 280 | """ |
|
281 | 281 | Special value to raise a KeyError |
|
282 | 282 | |
|
283 | 283 | Raise KeyError in `BaseFormatter.pop` if passed as the default value to `pop` |
|
284 | 284 | """) |
|
285 | 285 | |
|
286 | 286 | |
|
287 | 287 | class BaseFormatter(Configurable): |
|
288 | 288 | """A base formatter class that is configurable. |
|
289 | 289 | |
|
290 | 290 | This formatter should usually be used as the base class of all formatters. |
|
291 | 291 | It is a traited :class:`Configurable` class and includes an extensible |
|
292 | 292 | API for users to determine how their objects are formatted. The following |
|
293 | 293 | logic is used to find a function to format an given object. |
|
294 | 294 | |
|
295 | 295 | 1. The object is introspected to see if it has a method with the name |
|
296 | 296 | :attr:`print_method`. If is does, that object is passed to that method |
|
297 | 297 | for formatting. |
|
298 | 298 | 2. If no print method is found, three internal dictionaries are consulted |
|
299 | 299 | to find print method: :attr:`singleton_printers`, :attr:`type_printers` |
|
300 | 300 | and :attr:`deferred_printers`. |
|
301 | 301 | |
|
302 | 302 | Users should use these dictionaries to register functions that will be |
|
303 | 303 | used to compute the format data for their objects (if those objects don't |
|
304 | 304 | have the special print methods). The easiest way of using these |
|
305 | 305 | dictionaries is through the :meth:`for_type` and :meth:`for_type_by_name` |
|
306 | 306 | methods. |
|
307 | 307 | |
|
308 | 308 | If no function/callable is found to compute the format data, ``None`` is |
|
309 | 309 | returned and this format type is not used. |
|
310 | 310 | """ |
|
311 | 311 | |
|
312 | 312 | format_type = Unicode('text/plain') |
|
313 | 313 | _return_type = str |
|
314 | 314 | |
|
315 | 315 | enabled = Bool(True).tag(config=True) |
|
316 | 316 | |
|
317 | 317 | print_method = ObjectName('__repr__') |
|
318 | 318 | |
|
319 | 319 | # The singleton printers. |
|
320 | 320 | # Maps the IDs of the builtin singleton objects to the format functions. |
|
321 | 321 | singleton_printers = Dict().tag(config=True) |
|
322 | 322 | |
|
323 | 323 | # The type-specific printers. |
|
324 | 324 | # Map type objects to the format functions. |
|
325 | 325 | type_printers = Dict().tag(config=True) |
|
326 | 326 | |
|
327 | 327 | # The deferred-import type-specific printers. |
|
328 | 328 | # Map (modulename, classname) pairs to the format functions. |
|
329 | 329 | deferred_printers = Dict().tag(config=True) |
|
330 | 330 | |
|
331 | 331 | @catch_format_error |
|
332 | 332 | def __call__(self, obj): |
|
333 | 333 | """Compute the format for an object.""" |
|
334 | 334 | if self.enabled: |
|
335 | 335 | # lookup registered printer |
|
336 | 336 | try: |
|
337 | 337 | printer = self.lookup(obj) |
|
338 | 338 | except KeyError: |
|
339 | 339 | pass |
|
340 | 340 | else: |
|
341 | 341 | return printer(obj) |
|
342 | 342 | # Finally look for special method names |
|
343 | 343 | method = get_real_method(obj, self.print_method) |
|
344 | 344 | if method is not None: |
|
345 | 345 | return method() |
|
346 | 346 | return None |
|
347 | 347 | else: |
|
348 | 348 | return None |
|
349 | 349 | |
|
350 | 350 | def __contains__(self, typ): |
|
351 | 351 | """map in to lookup_by_type""" |
|
352 | 352 | try: |
|
353 | 353 | self.lookup_by_type(typ) |
|
354 | 354 | except KeyError: |
|
355 | 355 | return False |
|
356 | 356 | else: |
|
357 | 357 | return True |
|
358 | 358 | |
|
359 | 359 | def _check_return(self, r, obj): |
|
360 | 360 | """Check that a return value is appropriate |
|
361 | 361 | |
|
362 | 362 | Return the value if so, None otherwise, warning if invalid. |
|
363 | 363 | """ |
|
364 | 364 | if r is None or isinstance(r, self._return_type) or \ |
|
365 | 365 | (isinstance(r, tuple) and r and isinstance(r[0], self._return_type)): |
|
366 | 366 | return r |
|
367 | 367 | else: |
|
368 | 368 | warnings.warn( |
|
369 | 369 | "%s formatter returned invalid type %s (expected %s) for object: %s" % \ |
|
370 | 370 | (self.format_type, type(r), self._return_type, _safe_repr(obj)), |
|
371 | 371 | FormatterWarning |
|
372 | 372 | ) |
|
373 | 373 | |
|
374 | 374 | def lookup(self, obj): |
|
375 | 375 | """Look up the formatter for a given instance. |
|
376 | 376 | |
|
377 | 377 | Parameters |
|
378 | 378 | ---------- |
|
379 | 379 | obj : object instance |
|
380 | 380 | |
|
381 | 381 | Returns |
|
382 | 382 | ------- |
|
383 | 383 | f : callable |
|
384 | 384 | The registered formatting callable for the type. |
|
385 | 385 | |
|
386 | 386 | Raises |
|
387 | 387 | ------ |
|
388 | 388 | KeyError if the type has not been registered. |
|
389 | 389 | """ |
|
390 | 390 | # look for singleton first |
|
391 | 391 | obj_id = id(obj) |
|
392 | 392 | if obj_id in self.singleton_printers: |
|
393 | 393 | return self.singleton_printers[obj_id] |
|
394 | 394 | # then lookup by type |
|
395 | 395 | return self.lookup_by_type(_get_type(obj)) |
|
396 | 396 | |
|
397 | 397 | def lookup_by_type(self, typ): |
|
398 | 398 | """Look up the registered formatter for a type. |
|
399 | 399 | |
|
400 | 400 | Parameters |
|
401 | 401 | ---------- |
|
402 | 402 | typ : type or '__module__.__name__' string for a type |
|
403 | 403 | |
|
404 | 404 | Returns |
|
405 | 405 | ------- |
|
406 | 406 | f : callable |
|
407 | 407 | The registered formatting callable for the type. |
|
408 | 408 | |
|
409 | 409 | Raises |
|
410 | 410 | ------ |
|
411 | 411 | KeyError if the type has not been registered. |
|
412 | 412 | """ |
|
413 | 413 | if isinstance(typ, str): |
|
414 | 414 | typ_key = tuple(typ.rsplit('.',1)) |
|
415 | 415 | if typ_key not in self.deferred_printers: |
|
416 | 416 | # We may have it cached in the type map. We will have to |
|
417 | 417 | # iterate over all of the types to check. |
|
418 | 418 | for cls in self.type_printers: |
|
419 | 419 | if _mod_name_key(cls) == typ_key: |
|
420 | 420 | return self.type_printers[cls] |
|
421 | 421 | else: |
|
422 | 422 | return self.deferred_printers[typ_key] |
|
423 | 423 | else: |
|
424 | 424 | for cls in pretty._get_mro(typ): |
|
425 | 425 | if cls in self.type_printers or self._in_deferred_types(cls): |
|
426 | 426 | return self.type_printers[cls] |
|
427 | 427 | |
|
428 | 428 | # If we have reached here, the lookup failed. |
|
429 | 429 | raise KeyError("No registered printer for {0!r}".format(typ)) |
|
430 | 430 | |
|
431 | 431 | def for_type(self, typ, func=None): |
|
432 | 432 | """Add a format function for a given type. |
|
433 | 433 | |
|
434 | 434 | Parameters |
|
435 | 435 | ----------- |
|
436 | 436 | typ : type or '__module__.__name__' string for a type |
|
437 | 437 | The class of the object that will be formatted using `func`. |
|
438 | 438 | func : callable |
|
439 | 439 | A callable for computing the format data. |
|
440 | 440 | `func` will be called with the object to be formatted, |
|
441 | 441 | and will return the raw data in this formatter's format. |
|
442 | 442 | Subclasses may use a different call signature for the |
|
443 | 443 | `func` argument. |
|
444 | 444 | |
|
445 | 445 | If `func` is None or not specified, there will be no change, |
|
446 | 446 | only returning the current value. |
|
447 | 447 | |
|
448 | 448 | Returns |
|
449 | 449 | ------- |
|
450 | 450 | oldfunc : callable |
|
451 | 451 | The currently registered callable. |
|
452 | 452 | If you are registering a new formatter, |
|
453 | 453 | this will be the previous value (to enable restoring later). |
|
454 | 454 | """ |
|
455 | 455 | # if string given, interpret as 'pkg.module.class_name' |
|
456 | 456 | if isinstance(typ, str): |
|
457 | 457 | type_module, type_name = typ.rsplit('.', 1) |
|
458 | 458 | return self.for_type_by_name(type_module, type_name, func) |
|
459 | 459 | |
|
460 | 460 | try: |
|
461 | 461 | oldfunc = self.lookup_by_type(typ) |
|
462 | 462 | except KeyError: |
|
463 | 463 | oldfunc = None |
|
464 | 464 | |
|
465 | 465 | if func is not None: |
|
466 | 466 | self.type_printers[typ] = func |
|
467 | 467 | |
|
468 | 468 | return oldfunc |
|
469 | 469 | |
|
470 | 470 | def for_type_by_name(self, type_module, type_name, func=None): |
|
471 | 471 | """Add a format function for a type specified by the full dotted |
|
472 | 472 | module and name of the type, rather than the type of the object. |
|
473 | 473 | |
|
474 | 474 | Parameters |
|
475 | 475 | ---------- |
|
476 | 476 | type_module : str |
|
477 | 477 | The full dotted name of the module the type is defined in, like |
|
478 | 478 | ``numpy``. |
|
479 | 479 | type_name : str |
|
480 | 480 | The name of the type (the class name), like ``dtype`` |
|
481 | 481 | func : callable |
|
482 | 482 | A callable for computing the format data. |
|
483 | 483 | `func` will be called with the object to be formatted, |
|
484 | 484 | and will return the raw data in this formatter's format. |
|
485 | 485 | Subclasses may use a different call signature for the |
|
486 | 486 | `func` argument. |
|
487 | 487 | |
|
488 | 488 | If `func` is None or unspecified, there will be no change, |
|
489 | 489 | only returning the current value. |
|
490 | 490 | |
|
491 | 491 | Returns |
|
492 | 492 | ------- |
|
493 | 493 | oldfunc : callable |
|
494 | 494 | The currently registered callable. |
|
495 | 495 | If you are registering a new formatter, |
|
496 | 496 | this will be the previous value (to enable restoring later). |
|
497 | 497 | """ |
|
498 | 498 | key = (type_module, type_name) |
|
499 | 499 | |
|
500 | 500 | try: |
|
501 | 501 | oldfunc = self.lookup_by_type("%s.%s" % key) |
|
502 | 502 | except KeyError: |
|
503 | 503 | oldfunc = None |
|
504 | 504 | |
|
505 | 505 | if func is not None: |
|
506 | 506 | self.deferred_printers[key] = func |
|
507 | 507 | return oldfunc |
|
508 | 508 | |
|
509 | 509 | def pop(self, typ, default=_raise_key_error): |
|
510 | 510 | """Pop a formatter for the given type. |
|
511 | 511 | |
|
512 | 512 | Parameters |
|
513 | 513 | ---------- |
|
514 | 514 | typ : type or '__module__.__name__' string for a type |
|
515 | 515 | default : object |
|
516 | 516 | value to be returned if no formatter is registered for typ. |
|
517 | 517 | |
|
518 | 518 | Returns |
|
519 | 519 | ------- |
|
520 | 520 | obj : object |
|
521 | 521 | The last registered object for the type. |
|
522 | 522 | |
|
523 | 523 | Raises |
|
524 | 524 | ------ |
|
525 | 525 | KeyError if the type is not registered and default is not specified. |
|
526 | 526 | """ |
|
527 | 527 | |
|
528 | 528 | if isinstance(typ, str): |
|
529 | 529 | typ_key = tuple(typ.rsplit('.',1)) |
|
530 | 530 | if typ_key not in self.deferred_printers: |
|
531 | 531 | # We may have it cached in the type map. We will have to |
|
532 | 532 | # iterate over all of the types to check. |
|
533 | 533 | for cls in self.type_printers: |
|
534 | 534 | if _mod_name_key(cls) == typ_key: |
|
535 | 535 | old = self.type_printers.pop(cls) |
|
536 | 536 | break |
|
537 | 537 | else: |
|
538 | 538 | old = default |
|
539 | 539 | else: |
|
540 | 540 | old = self.deferred_printers.pop(typ_key) |
|
541 | 541 | else: |
|
542 | 542 | if typ in self.type_printers: |
|
543 | 543 | old = self.type_printers.pop(typ) |
|
544 | 544 | else: |
|
545 | 545 | old = self.deferred_printers.pop(_mod_name_key(typ), default) |
|
546 | 546 | if old is _raise_key_error: |
|
547 | 547 | raise KeyError("No registered value for {0!r}".format(typ)) |
|
548 | 548 | return old |
|
549 | 549 | |
|
550 | 550 | def _in_deferred_types(self, cls): |
|
551 | 551 | """ |
|
552 | 552 | Check if the given class is specified in the deferred type registry. |
|
553 | 553 | |
|
554 | 554 | Successful matches will be moved to the regular type registry for future use. |
|
555 | 555 | """ |
|
556 | 556 | mod = getattr(cls, '__module__', None) |
|
557 | 557 | name = getattr(cls, '__name__', None) |
|
558 | 558 | key = (mod, name) |
|
559 | 559 | if key in self.deferred_printers: |
|
560 | 560 | # Move the printer over to the regular registry. |
|
561 | 561 | printer = self.deferred_printers.pop(key) |
|
562 | 562 | self.type_printers[cls] = printer |
|
563 | 563 | return True |
|
564 | 564 | return False |
|
565 | 565 | |
|
566 | 566 | |
|
567 | 567 | class PlainTextFormatter(BaseFormatter): |
|
568 | 568 | """The default pretty-printer. |
|
569 | 569 | |
|
570 | 570 | This uses :mod:`IPython.lib.pretty` to compute the format data of |
|
571 | 571 | the object. If the object cannot be pretty printed, :func:`repr` is used. |
|
572 | 572 | See the documentation of :mod:`IPython.lib.pretty` for details on |
|
573 | 573 | how to write pretty printers. Here is a simple example:: |
|
574 | 574 | |
|
575 | 575 | def dtype_pprinter(obj, p, cycle): |
|
576 | 576 | if cycle: |
|
577 | 577 | return p.text('dtype(...)') |
|
578 | 578 | if hasattr(obj, 'fields'): |
|
579 | 579 | if obj.fields is None: |
|
580 | 580 | p.text(repr(obj)) |
|
581 | 581 | else: |
|
582 | 582 | p.begin_group(7, 'dtype([') |
|
583 | 583 | for i, field in enumerate(obj.descr): |
|
584 | 584 | if i > 0: |
|
585 | 585 | p.text(',') |
|
586 | 586 | p.breakable() |
|
587 | 587 | p.pretty(field) |
|
588 | 588 | p.end_group(7, '])') |
|
589 | 589 | """ |
|
590 | 590 | |
|
591 | 591 | # The format type of data returned. |
|
592 | 592 | format_type = Unicode('text/plain') |
|
593 | 593 | |
|
594 | 594 | # This subclass ignores this attribute as it always need to return |
|
595 | 595 | # something. |
|
596 | 596 | enabled = Bool(True).tag(config=False) |
|
597 | 597 | |
|
598 | 598 | max_seq_length = Integer(pretty.MAX_SEQ_LENGTH, |
|
599 | 599 | help="""Truncate large collections (lists, dicts, tuples, sets) to this size. |
|
600 | 600 | |
|
601 | 601 | Set to 0 to disable truncation. |
|
602 | 602 | """ |
|
603 | 603 | ).tag(config=True) |
|
604 | 604 | |
|
605 | 605 | # Look for a _repr_pretty_ methods to use for pretty printing. |
|
606 | 606 | print_method = ObjectName('_repr_pretty_') |
|
607 | 607 | |
|
608 | 608 | # Whether to pretty-print or not. |
|
609 | 609 | pprint = Bool(True).tag(config=True) |
|
610 | 610 | |
|
611 | 611 | # Whether to be verbose or not. |
|
612 | 612 | verbose = Bool(False).tag(config=True) |
|
613 | 613 | |
|
614 | 614 | # The maximum width. |
|
615 | 615 | max_width = Integer(79).tag(config=True) |
|
616 | 616 | |
|
617 | 617 | # The newline character. |
|
618 | 618 | newline = Unicode('\n').tag(config=True) |
|
619 | 619 | |
|
620 | 620 | # format-string for pprinting floats |
|
621 | 621 | float_format = Unicode('%r') |
|
622 | 622 | # setter for float precision, either int or direct format-string |
|
623 | 623 | float_precision = CUnicode('').tag(config=True) |
|
624 | 624 | |
|
625 | 625 | @observe('float_precision') |
|
626 | 626 | def _float_precision_changed(self, change): |
|
627 | 627 | """float_precision changed, set float_format accordingly. |
|
628 | 628 | |
|
629 | 629 | float_precision can be set by int or str. |
|
630 | 630 | This will set float_format, after interpreting input. |
|
631 | 631 | If numpy has been imported, numpy print precision will also be set. |
|
632 | 632 | |
|
633 | 633 | integer `n` sets format to '%.nf', otherwise, format set directly. |
|
634 | 634 | |
|
635 | 635 | An empty string returns to defaults (repr for float, 8 for numpy). |
|
636 | 636 | |
|
637 | 637 | This parameter can be set via the '%precision' magic. |
|
638 | 638 | """ |
|
639 | 639 | |
|
640 | 640 | new = change['new'] |
|
641 | 641 | if '%' in new: |
|
642 | 642 | # got explicit format string |
|
643 | 643 | fmt = new |
|
644 | 644 | try: |
|
645 | 645 | fmt%3.14159 |
|
646 | except Exception: | |
|
647 | raise ValueError("Precision must be int or format string, not %r"%new) | |
|
646 | except Exception as e: | |
|
647 | raise ValueError("Precision must be int or format string, not %r"%new) from e | |
|
648 | 648 | elif new: |
|
649 | 649 | # otherwise, should be an int |
|
650 | 650 | try: |
|
651 | 651 | i = int(new) |
|
652 | 652 | assert i >= 0 |
|
653 | except ValueError: | |
|
654 | raise ValueError("Precision must be int or format string, not %r"%new) | |
|
655 | except AssertionError: | |
|
656 | raise ValueError("int precision must be non-negative, not %r"%i) | |
|
653 | except ValueError as e: | |
|
654 | raise ValueError("Precision must be int or format string, not %r"%new) from e | |
|
655 | except AssertionError as e: | |
|
656 | raise ValueError("int precision must be non-negative, not %r"%i) from e | |
|
657 | 657 | |
|
658 | 658 | fmt = '%%.%if'%i |
|
659 | 659 | if 'numpy' in sys.modules: |
|
660 | 660 | # set numpy precision if it has been imported |
|
661 | 661 | import numpy |
|
662 | 662 | numpy.set_printoptions(precision=i) |
|
663 | 663 | else: |
|
664 | 664 | # default back to repr |
|
665 | 665 | fmt = '%r' |
|
666 | 666 | if 'numpy' in sys.modules: |
|
667 | 667 | import numpy |
|
668 | 668 | # numpy default is 8 |
|
669 | 669 | numpy.set_printoptions(precision=8) |
|
670 | 670 | self.float_format = fmt |
|
671 | 671 | |
|
672 | 672 | # Use the default pretty printers from IPython.lib.pretty. |
|
673 | 673 | @default('singleton_printers') |
|
674 | 674 | def _singleton_printers_default(self): |
|
675 | 675 | return pretty._singleton_pprinters.copy() |
|
676 | 676 | |
|
677 | 677 | @default('type_printers') |
|
678 | 678 | def _type_printers_default(self): |
|
679 | 679 | d = pretty._type_pprinters.copy() |
|
680 | 680 | d[float] = lambda obj,p,cycle: p.text(self.float_format%obj) |
|
681 | 681 | return d |
|
682 | 682 | |
|
683 | 683 | @default('deferred_printers') |
|
684 | 684 | def _deferred_printers_default(self): |
|
685 | 685 | return pretty._deferred_type_pprinters.copy() |
|
686 | 686 | |
|
687 | 687 | #### FormatterABC interface #### |
|
688 | 688 | |
|
689 | 689 | @catch_format_error |
|
690 | 690 | def __call__(self, obj): |
|
691 | 691 | """Compute the pretty representation of the object.""" |
|
692 | 692 | if not self.pprint: |
|
693 | 693 | return repr(obj) |
|
694 | 694 | else: |
|
695 | 695 | stream = StringIO() |
|
696 | 696 | printer = pretty.RepresentationPrinter(stream, self.verbose, |
|
697 | 697 | self.max_width, self.newline, |
|
698 | 698 | max_seq_length=self.max_seq_length, |
|
699 | 699 | singleton_pprinters=self.singleton_printers, |
|
700 | 700 | type_pprinters=self.type_printers, |
|
701 | 701 | deferred_pprinters=self.deferred_printers) |
|
702 | 702 | printer.pretty(obj) |
|
703 | 703 | printer.flush() |
|
704 | 704 | return stream.getvalue() |
|
705 | 705 | |
|
706 | 706 | |
|
707 | 707 | class HTMLFormatter(BaseFormatter): |
|
708 | 708 | """An HTML formatter. |
|
709 | 709 | |
|
710 | 710 | To define the callables that compute the HTML representation of your |
|
711 | 711 | objects, define a :meth:`_repr_html_` method or use the :meth:`for_type` |
|
712 | 712 | or :meth:`for_type_by_name` methods to register functions that handle |
|
713 | 713 | this. |
|
714 | 714 | |
|
715 | 715 | The return value of this formatter should be a valid HTML snippet that |
|
716 | 716 | could be injected into an existing DOM. It should *not* include the |
|
717 | 717 | ```<html>`` or ```<body>`` tags. |
|
718 | 718 | """ |
|
719 | 719 | format_type = Unicode('text/html') |
|
720 | 720 | |
|
721 | 721 | print_method = ObjectName('_repr_html_') |
|
722 | 722 | |
|
723 | 723 | |
|
724 | 724 | class MarkdownFormatter(BaseFormatter): |
|
725 | 725 | """A Markdown formatter. |
|
726 | 726 | |
|
727 | 727 | To define the callables that compute the Markdown representation of your |
|
728 | 728 | objects, define a :meth:`_repr_markdown_` method or use the :meth:`for_type` |
|
729 | 729 | or :meth:`for_type_by_name` methods to register functions that handle |
|
730 | 730 | this. |
|
731 | 731 | |
|
732 | 732 | The return value of this formatter should be a valid Markdown. |
|
733 | 733 | """ |
|
734 | 734 | format_type = Unicode('text/markdown') |
|
735 | 735 | |
|
736 | 736 | print_method = ObjectName('_repr_markdown_') |
|
737 | 737 | |
|
738 | 738 | class SVGFormatter(BaseFormatter): |
|
739 | 739 | """An SVG formatter. |
|
740 | 740 | |
|
741 | 741 | To define the callables that compute the SVG representation of your |
|
742 | 742 | objects, define a :meth:`_repr_svg_` method or use the :meth:`for_type` |
|
743 | 743 | or :meth:`for_type_by_name` methods to register functions that handle |
|
744 | 744 | this. |
|
745 | 745 | |
|
746 | 746 | The return value of this formatter should be valid SVG enclosed in |
|
747 | 747 | ```<svg>``` tags, that could be injected into an existing DOM. It should |
|
748 | 748 | *not* include the ```<html>`` or ```<body>`` tags. |
|
749 | 749 | """ |
|
750 | 750 | format_type = Unicode('image/svg+xml') |
|
751 | 751 | |
|
752 | 752 | print_method = ObjectName('_repr_svg_') |
|
753 | 753 | |
|
754 | 754 | |
|
755 | 755 | class PNGFormatter(BaseFormatter): |
|
756 | 756 | """A PNG formatter. |
|
757 | 757 | |
|
758 | 758 | To define the callables that compute the PNG representation of your |
|
759 | 759 | objects, define a :meth:`_repr_png_` method or use the :meth:`for_type` |
|
760 | 760 | or :meth:`for_type_by_name` methods to register functions that handle |
|
761 | 761 | this. |
|
762 | 762 | |
|
763 | 763 | The return value of this formatter should be raw PNG data, *not* |
|
764 | 764 | base64 encoded. |
|
765 | 765 | """ |
|
766 | 766 | format_type = Unicode('image/png') |
|
767 | 767 | |
|
768 | 768 | print_method = ObjectName('_repr_png_') |
|
769 | 769 | |
|
770 | 770 | _return_type = (bytes, str) |
|
771 | 771 | |
|
772 | 772 | |
|
773 | 773 | class JPEGFormatter(BaseFormatter): |
|
774 | 774 | """A JPEG formatter. |
|
775 | 775 | |
|
776 | 776 | To define the callables that compute the JPEG representation of your |
|
777 | 777 | objects, define a :meth:`_repr_jpeg_` method or use the :meth:`for_type` |
|
778 | 778 | or :meth:`for_type_by_name` methods to register functions that handle |
|
779 | 779 | this. |
|
780 | 780 | |
|
781 | 781 | The return value of this formatter should be raw JPEG data, *not* |
|
782 | 782 | base64 encoded. |
|
783 | 783 | """ |
|
784 | 784 | format_type = Unicode('image/jpeg') |
|
785 | 785 | |
|
786 | 786 | print_method = ObjectName('_repr_jpeg_') |
|
787 | 787 | |
|
788 | 788 | _return_type = (bytes, str) |
|
789 | 789 | |
|
790 | 790 | |
|
791 | 791 | class LatexFormatter(BaseFormatter): |
|
792 | 792 | """A LaTeX formatter. |
|
793 | 793 | |
|
794 | 794 | To define the callables that compute the LaTeX representation of your |
|
795 | 795 | objects, define a :meth:`_repr_latex_` method or use the :meth:`for_type` |
|
796 | 796 | or :meth:`for_type_by_name` methods to register functions that handle |
|
797 | 797 | this. |
|
798 | 798 | |
|
799 | 799 | The return value of this formatter should be a valid LaTeX equation, |
|
800 | 800 | enclosed in either ```$```, ```$$``` or another LaTeX equation |
|
801 | 801 | environment. |
|
802 | 802 | """ |
|
803 | 803 | format_type = Unicode('text/latex') |
|
804 | 804 | |
|
805 | 805 | print_method = ObjectName('_repr_latex_') |
|
806 | 806 | |
|
807 | 807 | |
|
808 | 808 | class JSONFormatter(BaseFormatter): |
|
809 | 809 | """A JSON string formatter. |
|
810 | 810 | |
|
811 | 811 | To define the callables that compute the JSONable representation of |
|
812 | 812 | your objects, define a :meth:`_repr_json_` method or use the :meth:`for_type` |
|
813 | 813 | or :meth:`for_type_by_name` methods to register functions that handle |
|
814 | 814 | this. |
|
815 | 815 | |
|
816 | 816 | The return value of this formatter should be a JSONable list or dict. |
|
817 | 817 | JSON scalars (None, number, string) are not allowed, only dict or list containers. |
|
818 | 818 | """ |
|
819 | 819 | format_type = Unicode('application/json') |
|
820 | 820 | _return_type = (list, dict) |
|
821 | 821 | |
|
822 | 822 | print_method = ObjectName('_repr_json_') |
|
823 | 823 | |
|
824 | 824 | def _check_return(self, r, obj): |
|
825 | 825 | """Check that a return value is appropriate |
|
826 | 826 | |
|
827 | 827 | Return the value if so, None otherwise, warning if invalid. |
|
828 | 828 | """ |
|
829 | 829 | if r is None: |
|
830 | 830 | return |
|
831 | 831 | md = None |
|
832 | 832 | if isinstance(r, tuple): |
|
833 | 833 | # unpack data, metadata tuple for type checking on first element |
|
834 | 834 | r, md = r |
|
835 | 835 | |
|
836 | 836 | # handle deprecated JSON-as-string form from IPython < 3 |
|
837 | 837 | if isinstance(r, str): |
|
838 | 838 | warnings.warn("JSON expects JSONable list/dict containers, not JSON strings", |
|
839 | 839 | FormatterWarning) |
|
840 | 840 | r = json.loads(r) |
|
841 | 841 | |
|
842 | 842 | if md is not None: |
|
843 | 843 | # put the tuple back together |
|
844 | 844 | r = (r, md) |
|
845 | 845 | return super(JSONFormatter, self)._check_return(r, obj) |
|
846 | 846 | |
|
847 | 847 | |
|
848 | 848 | class JavascriptFormatter(BaseFormatter): |
|
849 | 849 | """A Javascript formatter. |
|
850 | 850 | |
|
851 | 851 | To define the callables that compute the Javascript representation of |
|
852 | 852 | your objects, define a :meth:`_repr_javascript_` method or use the |
|
853 | 853 | :meth:`for_type` or :meth:`for_type_by_name` methods to register functions |
|
854 | 854 | that handle this. |
|
855 | 855 | |
|
856 | 856 | The return value of this formatter should be valid Javascript code and |
|
857 | 857 | should *not* be enclosed in ```<script>``` tags. |
|
858 | 858 | """ |
|
859 | 859 | format_type = Unicode('application/javascript') |
|
860 | 860 | |
|
861 | 861 | print_method = ObjectName('_repr_javascript_') |
|
862 | 862 | |
|
863 | 863 | |
|
864 | 864 | class PDFFormatter(BaseFormatter): |
|
865 | 865 | """A PDF formatter. |
|
866 | 866 | |
|
867 | 867 | To define the callables that compute the PDF representation of your |
|
868 | 868 | objects, define a :meth:`_repr_pdf_` method or use the :meth:`for_type` |
|
869 | 869 | or :meth:`for_type_by_name` methods to register functions that handle |
|
870 | 870 | this. |
|
871 | 871 | |
|
872 | 872 | The return value of this formatter should be raw PDF data, *not* |
|
873 | 873 | base64 encoded. |
|
874 | 874 | """ |
|
875 | 875 | format_type = Unicode('application/pdf') |
|
876 | 876 | |
|
877 | 877 | print_method = ObjectName('_repr_pdf_') |
|
878 | 878 | |
|
879 | 879 | _return_type = (bytes, str) |
|
880 | 880 | |
|
881 | 881 | class IPythonDisplayFormatter(BaseFormatter): |
|
882 | 882 | """An escape-hatch Formatter for objects that know how to display themselves. |
|
883 | 883 | |
|
884 | 884 | To define the callables that compute the representation of your |
|
885 | 885 | objects, define a :meth:`_ipython_display_` method or use the :meth:`for_type` |
|
886 | 886 | or :meth:`for_type_by_name` methods to register functions that handle |
|
887 | 887 | this. Unlike mime-type displays, this method should not return anything, |
|
888 | 888 | instead calling any appropriate display methods itself. |
|
889 | 889 | |
|
890 | 890 | This display formatter has highest priority. |
|
891 | 891 | If it fires, no other display formatter will be called. |
|
892 | 892 | |
|
893 | 893 | Prior to IPython 6.1, `_ipython_display_` was the only way to display custom mime-types |
|
894 | 894 | without registering a new Formatter. |
|
895 | 895 | |
|
896 | 896 | IPython 6.1 introduces `_repr_mimebundle_` for displaying custom mime-types, |
|
897 | 897 | so `_ipython_display_` should only be used for objects that require unusual |
|
898 | 898 | display patterns, such as multiple display calls. |
|
899 | 899 | """ |
|
900 | 900 | print_method = ObjectName('_ipython_display_') |
|
901 | 901 | _return_type = (type(None), bool) |
|
902 | 902 | |
|
903 | 903 | @catch_format_error |
|
904 | 904 | def __call__(self, obj): |
|
905 | 905 | """Compute the format for an object.""" |
|
906 | 906 | if self.enabled: |
|
907 | 907 | # lookup registered printer |
|
908 | 908 | try: |
|
909 | 909 | printer = self.lookup(obj) |
|
910 | 910 | except KeyError: |
|
911 | 911 | pass |
|
912 | 912 | else: |
|
913 | 913 | printer(obj) |
|
914 | 914 | return True |
|
915 | 915 | # Finally look for special method names |
|
916 | 916 | method = get_real_method(obj, self.print_method) |
|
917 | 917 | if method is not None: |
|
918 | 918 | method() |
|
919 | 919 | return True |
|
920 | 920 | |
|
921 | 921 | |
|
922 | 922 | class MimeBundleFormatter(BaseFormatter): |
|
923 | 923 | """A Formatter for arbitrary mime-types. |
|
924 | 924 | |
|
925 | 925 | Unlike other `_repr_<mimetype>_` methods, |
|
926 | 926 | `_repr_mimebundle_` should return mime-bundle data, |
|
927 | 927 | either the mime-keyed `data` dictionary or the tuple `(data, metadata)`. |
|
928 | 928 | Any mime-type is valid. |
|
929 | 929 | |
|
930 | 930 | To define the callables that compute the mime-bundle representation of your |
|
931 | 931 | objects, define a :meth:`_repr_mimebundle_` method or use the :meth:`for_type` |
|
932 | 932 | or :meth:`for_type_by_name` methods to register functions that handle |
|
933 | 933 | this. |
|
934 | 934 | |
|
935 | 935 | .. versionadded:: 6.1 |
|
936 | 936 | """ |
|
937 | 937 | print_method = ObjectName('_repr_mimebundle_') |
|
938 | 938 | _return_type = dict |
|
939 | 939 | |
|
940 | 940 | def _check_return(self, r, obj): |
|
941 | 941 | r = super(MimeBundleFormatter, self)._check_return(r, obj) |
|
942 | 942 | # always return (data, metadata): |
|
943 | 943 | if r is None: |
|
944 | 944 | return {}, {} |
|
945 | 945 | if not isinstance(r, tuple): |
|
946 | 946 | return r, {} |
|
947 | 947 | return r |
|
948 | 948 | |
|
949 | 949 | @catch_format_error |
|
950 | 950 | def __call__(self, obj, include=None, exclude=None): |
|
951 | 951 | """Compute the format for an object. |
|
952 | 952 | |
|
953 | 953 | Identical to parent's method but we pass extra parameters to the method. |
|
954 | 954 | |
|
955 | 955 | Unlike other _repr_*_ `_repr_mimebundle_` should allow extra kwargs, in |
|
956 | 956 | particular `include` and `exclude`. |
|
957 | 957 | """ |
|
958 | 958 | if self.enabled: |
|
959 | 959 | # lookup registered printer |
|
960 | 960 | try: |
|
961 | 961 | printer = self.lookup(obj) |
|
962 | 962 | except KeyError: |
|
963 | 963 | pass |
|
964 | 964 | else: |
|
965 | 965 | return printer(obj) |
|
966 | 966 | # Finally look for special method names |
|
967 | 967 | method = get_real_method(obj, self.print_method) |
|
968 | 968 | |
|
969 | 969 | if method is not None: |
|
970 | 970 | return method(include=include, exclude=exclude) |
|
971 | 971 | return None |
|
972 | 972 | else: |
|
973 | 973 | return None |
|
974 | 974 | |
|
975 | 975 | |
|
976 | 976 | FormatterABC.register(BaseFormatter) |
|
977 | 977 | FormatterABC.register(PlainTextFormatter) |
|
978 | 978 | FormatterABC.register(HTMLFormatter) |
|
979 | 979 | FormatterABC.register(MarkdownFormatter) |
|
980 | 980 | FormatterABC.register(SVGFormatter) |
|
981 | 981 | FormatterABC.register(PNGFormatter) |
|
982 | 982 | FormatterABC.register(PDFFormatter) |
|
983 | 983 | FormatterABC.register(JPEGFormatter) |
|
984 | 984 | FormatterABC.register(LatexFormatter) |
|
985 | 985 | FormatterABC.register(JSONFormatter) |
|
986 | 986 | FormatterABC.register(JavascriptFormatter) |
|
987 | 987 | FormatterABC.register(IPythonDisplayFormatter) |
|
988 | 988 | FormatterABC.register(MimeBundleFormatter) |
|
989 | 989 | |
|
990 | 990 | |
|
991 | 991 | def format_display_data(obj, include=None, exclude=None): |
|
992 | 992 | """Return a format data dict for an object. |
|
993 | 993 | |
|
994 | 994 | By default all format types will be computed. |
|
995 | 995 | |
|
996 | 996 | Parameters |
|
997 | 997 | ---------- |
|
998 | 998 | obj : object |
|
999 | 999 | The Python object whose format data will be computed. |
|
1000 | 1000 | |
|
1001 | 1001 | Returns |
|
1002 | 1002 | ------- |
|
1003 | 1003 | format_dict : dict |
|
1004 | 1004 | A dictionary of key/value pairs, one or each format that was |
|
1005 | 1005 | generated for the object. The keys are the format types, which |
|
1006 | 1006 | will usually be MIME type strings and the values and JSON'able |
|
1007 | 1007 | data structure containing the raw data for the representation in |
|
1008 | 1008 | that format. |
|
1009 | 1009 | include : list or tuple, optional |
|
1010 | 1010 | A list of format type strings (MIME types) to include in the |
|
1011 | 1011 | format data dict. If this is set *only* the format types included |
|
1012 | 1012 | in this list will be computed. |
|
1013 | 1013 | exclude : list or tuple, optional |
|
1014 | 1014 | A list of format type string (MIME types) to exclude in the format |
|
1015 | 1015 | data dict. If this is set all format types will be computed, |
|
1016 | 1016 | except for those included in this argument. |
|
1017 | 1017 | """ |
|
1018 | 1018 | from .interactiveshell import InteractiveShell |
|
1019 | 1019 | |
|
1020 | 1020 | return InteractiveShell.instance().display_formatter.format( |
|
1021 | 1021 | obj, |
|
1022 | 1022 | include, |
|
1023 | 1023 | exclude |
|
1024 | 1024 | ) |
@@ -1,3713 +1,3713 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 pickleshare import PickleShareDB |
|
32 | 32 | |
|
33 | 33 | from traitlets.config.configurable import SingletonConfigurable |
|
34 | 34 | from traitlets.utils.importstring import import_item |
|
35 | 35 | from IPython.core import oinspect |
|
36 | 36 | from IPython.core import magic |
|
37 | 37 | from IPython.core import page |
|
38 | 38 | from IPython.core import prefilter |
|
39 | 39 | from IPython.core import ultratb |
|
40 | 40 | from IPython.core.alias import Alias, AliasManager |
|
41 | 41 | from IPython.core.autocall import ExitAutocall |
|
42 | 42 | from IPython.core.builtin_trap import BuiltinTrap |
|
43 | 43 | from IPython.core.events import EventManager, available_events |
|
44 | 44 | from IPython.core.compilerop import CachingCompiler, check_linecache_ipython |
|
45 | 45 | from IPython.core.debugger import Pdb |
|
46 | 46 | from IPython.core.display_trap import DisplayTrap |
|
47 | 47 | from IPython.core.displayhook import DisplayHook |
|
48 | 48 | from IPython.core.displaypub import DisplayPublisher |
|
49 | 49 | from IPython.core.error import InputRejected, UsageError |
|
50 | 50 | from IPython.core.extensions import ExtensionManager |
|
51 | 51 | from IPython.core.formatters import DisplayFormatter |
|
52 | 52 | from IPython.core.history import HistoryManager |
|
53 | 53 | from IPython.core.inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
54 | 54 | from IPython.core.logger import Logger |
|
55 | 55 | from IPython.core.macro import Macro |
|
56 | 56 | from IPython.core.payload import PayloadManager |
|
57 | 57 | from IPython.core.prefilter import PrefilterManager |
|
58 | 58 | from IPython.core.profiledir import ProfileDir |
|
59 | 59 | from IPython.core.usage import default_banner |
|
60 | 60 | from IPython.display import display |
|
61 | 61 | from IPython.testing.skipdoctest import skip_doctest |
|
62 | 62 | from IPython.utils import PyColorize |
|
63 | 63 | from IPython.utils import io |
|
64 | 64 | from IPython.utils import py3compat |
|
65 | 65 | from IPython.utils import openpy |
|
66 | 66 | from IPython.utils.decorators import undoc |
|
67 | 67 | from IPython.utils.io import ask_yes_no |
|
68 | 68 | from IPython.utils.ipstruct import Struct |
|
69 | 69 | from IPython.paths import get_ipython_dir |
|
70 | 70 | from IPython.utils.path import get_home_dir, get_py_filename, ensure_dir_exists |
|
71 | 71 | from IPython.utils.process import system, getoutput |
|
72 | 72 | from IPython.utils.strdispatch import StrDispatch |
|
73 | 73 | from IPython.utils.syspathcontext import prepended_to_syspath |
|
74 | 74 | from IPython.utils.text import format_screen, LSString, SList, DollarFormatter |
|
75 | 75 | from IPython.utils.tempdir import TemporaryDirectory |
|
76 | 76 | from traitlets import ( |
|
77 | 77 | Integer, Bool, CaselessStrEnum, Enum, List, Dict, Unicode, Instance, Type, |
|
78 | 78 | observe, default, validate, Any |
|
79 | 79 | ) |
|
80 | 80 | from warnings import warn |
|
81 | 81 | from logging import error |
|
82 | 82 | import IPython.core.hooks |
|
83 | 83 | |
|
84 | 84 | from typing import List as ListType, Tuple |
|
85 | 85 | from ast import AST |
|
86 | 86 | |
|
87 | 87 | # NoOpContext is deprecated, but ipykernel imports it from here. |
|
88 | 88 | # See https://github.com/ipython/ipykernel/issues/157 |
|
89 | 89 | # (2016, let's try to remove than in IPython 8.0) |
|
90 | 90 | from IPython.utils.contexts import NoOpContext |
|
91 | 91 | |
|
92 | 92 | try: |
|
93 | 93 | import docrepr.sphinxify as sphx |
|
94 | 94 | |
|
95 | 95 | def sphinxify(doc): |
|
96 | 96 | with TemporaryDirectory() as dirname: |
|
97 | 97 | return { |
|
98 | 98 | 'text/html': sphx.sphinxify(doc, dirname), |
|
99 | 99 | 'text/plain': doc |
|
100 | 100 | } |
|
101 | 101 | except ImportError: |
|
102 | 102 | sphinxify = None |
|
103 | 103 | |
|
104 | 104 | |
|
105 | 105 | class ProvisionalWarning(DeprecationWarning): |
|
106 | 106 | """ |
|
107 | 107 | Warning class for unstable features |
|
108 | 108 | """ |
|
109 | 109 | pass |
|
110 | 110 | |
|
111 | 111 | if sys.version_info > (3,8): |
|
112 | 112 | from ast import Module |
|
113 | 113 | else : |
|
114 | 114 | # mock the new API, ignore second argument |
|
115 | 115 | # see https://github.com/ipython/ipython/issues/11590 |
|
116 | 116 | from ast import Module as OriginalModule |
|
117 | 117 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
118 | 118 | |
|
119 | 119 | if sys.version_info > (3,6): |
|
120 | 120 | _assign_nodes = (ast.AugAssign, ast.AnnAssign, ast.Assign) |
|
121 | 121 | _single_targets_nodes = (ast.AugAssign, ast.AnnAssign) |
|
122 | 122 | else: |
|
123 | 123 | _assign_nodes = (ast.AugAssign, ast.Assign ) |
|
124 | 124 | _single_targets_nodes = (ast.AugAssign, ) |
|
125 | 125 | |
|
126 | 126 | #----------------------------------------------------------------------------- |
|
127 | 127 | # Await Helpers |
|
128 | 128 | #----------------------------------------------------------------------------- |
|
129 | 129 | |
|
130 | 130 | def removed_co_newlocals(function:types.FunctionType) -> types.FunctionType: |
|
131 | 131 | """Return a function that do not create a new local scope. |
|
132 | 132 | |
|
133 | 133 | Given a function, create a clone of this function where the co_newlocal flag |
|
134 | 134 | has been removed, making this function code actually run in the sourounding |
|
135 | 135 | scope. |
|
136 | 136 | |
|
137 | 137 | We need this in order to run asynchronous code in user level namespace. |
|
138 | 138 | """ |
|
139 | 139 | from types import CodeType, FunctionType |
|
140 | 140 | CO_NEWLOCALS = 0x0002 |
|
141 | 141 | code = function.__code__ |
|
142 | 142 | new_co_flags = code.co_flags & ~CO_NEWLOCALS |
|
143 | 143 | if sys.version_info > (3, 8, 0, 'alpha', 3): |
|
144 | 144 | new_code = code.replace(co_flags=new_co_flags) |
|
145 | 145 | else: |
|
146 | 146 | new_code = CodeType( |
|
147 | 147 | code.co_argcount, |
|
148 | 148 | code.co_kwonlyargcount, |
|
149 | 149 | code.co_nlocals, |
|
150 | 150 | code.co_stacksize, |
|
151 | 151 | new_co_flags, |
|
152 | 152 | code.co_code, |
|
153 | 153 | code.co_consts, |
|
154 | 154 | code.co_names, |
|
155 | 155 | code.co_varnames, |
|
156 | 156 | code.co_filename, |
|
157 | 157 | code.co_name, |
|
158 | 158 | code.co_firstlineno, |
|
159 | 159 | code.co_lnotab, |
|
160 | 160 | code.co_freevars, |
|
161 | 161 | code.co_cellvars |
|
162 | 162 | ) |
|
163 | 163 | return FunctionType(new_code, globals(), function.__name__, function.__defaults__) |
|
164 | 164 | |
|
165 | 165 | |
|
166 | 166 | # we still need to run things using the asyncio eventloop, but there is no |
|
167 | 167 | # async integration |
|
168 | 168 | from .async_helpers import (_asyncio_runner, _asyncify, _pseudo_sync_runner) |
|
169 | 169 | from .async_helpers import _curio_runner, _trio_runner, _should_be_async |
|
170 | 170 | |
|
171 | 171 | |
|
172 | 172 | def _ast_asyncify(cell:str, wrapper_name:str) -> ast.Module: |
|
173 | 173 | """ |
|
174 | 174 | Parse a cell with top-level await and modify the AST to be able to run it later. |
|
175 | 175 | |
|
176 | 176 | Parameter |
|
177 | 177 | --------- |
|
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 | Return |
|
187 | 187 | ------ |
|
188 | 188 | |
|
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 | |
|
447 | 447 | sphinxify_docstring = Bool(False, help= |
|
448 | 448 | """ |
|
449 | 449 | Enables rich html representation of docstrings. (This requires the |
|
450 | 450 | docrepr module). |
|
451 | 451 | """).tag(config=True) |
|
452 | 452 | |
|
453 | 453 | @observe("sphinxify_docstring") |
|
454 | 454 | def _sphinxify_docstring_changed(self, change): |
|
455 | 455 | if change['new']: |
|
456 | 456 | warn("`sphinxify_docstring` is provisional since IPython 5.0 and might change in future versions." , ProvisionalWarning) |
|
457 | 457 | |
|
458 | 458 | enable_html_pager = Bool(False, help= |
|
459 | 459 | """ |
|
460 | 460 | (Provisional API) enables html representation in mime bundles sent |
|
461 | 461 | to pagers. |
|
462 | 462 | """).tag(config=True) |
|
463 | 463 | |
|
464 | 464 | @observe("enable_html_pager") |
|
465 | 465 | def _enable_html_pager_changed(self, change): |
|
466 | 466 | if change['new']: |
|
467 | 467 | warn("`enable_html_pager` is provisional since IPython 5.0 and might change in future versions.", ProvisionalWarning) |
|
468 | 468 | |
|
469 | 469 | data_pub_class = None |
|
470 | 470 | |
|
471 | 471 | exit_now = Bool(False) |
|
472 | 472 | exiter = Instance(ExitAutocall) |
|
473 | 473 | @default('exiter') |
|
474 | 474 | def _exiter_default(self): |
|
475 | 475 | return ExitAutocall(self) |
|
476 | 476 | # Monotonically increasing execution counter |
|
477 | 477 | execution_count = Integer(1) |
|
478 | 478 | filename = Unicode("<ipython console>") |
|
479 | 479 | ipython_dir= Unicode('').tag(config=True) # Set to get_ipython_dir() in __init__ |
|
480 | 480 | |
|
481 | 481 | # Used to transform cells before running them, and check whether code is complete |
|
482 | 482 | input_transformer_manager = Instance('IPython.core.inputtransformer2.TransformerManager', |
|
483 | 483 | ()) |
|
484 | 484 | |
|
485 | 485 | @property |
|
486 | 486 | def input_transformers_cleanup(self): |
|
487 | 487 | return self.input_transformer_manager.cleanup_transforms |
|
488 | 488 | |
|
489 | 489 | input_transformers_post = List([], |
|
490 | 490 | help="A list of string input transformers, to be applied after IPython's " |
|
491 | 491 | "own input transformations." |
|
492 | 492 | ) |
|
493 | 493 | |
|
494 | 494 | @property |
|
495 | 495 | def input_splitter(self): |
|
496 | 496 | """Make this available for backward compatibility (pre-7.0 release) with existing code. |
|
497 | 497 | |
|
498 | 498 | For example, ipykernel ipykernel currently uses |
|
499 | 499 | `shell.input_splitter.check_complete` |
|
500 | 500 | """ |
|
501 | 501 | from warnings import warn |
|
502 | 502 | warn("`input_splitter` is deprecated since IPython 7.0, prefer `input_transformer_manager`.", |
|
503 | 503 | DeprecationWarning, stacklevel=2 |
|
504 | 504 | ) |
|
505 | 505 | return self.input_transformer_manager |
|
506 | 506 | |
|
507 | 507 | logstart = Bool(False, help= |
|
508 | 508 | """ |
|
509 | 509 | Start logging to the default log file in overwrite mode. |
|
510 | 510 | Use `logappend` to specify a log file to **append** logs to. |
|
511 | 511 | """ |
|
512 | 512 | ).tag(config=True) |
|
513 | 513 | logfile = Unicode('', help= |
|
514 | 514 | """ |
|
515 | 515 | The name of the logfile to use. |
|
516 | 516 | """ |
|
517 | 517 | ).tag(config=True) |
|
518 | 518 | logappend = Unicode('', help= |
|
519 | 519 | """ |
|
520 | 520 | Start logging to the given file in append mode. |
|
521 | 521 | Use `logfile` to specify a log file to **overwrite** logs to. |
|
522 | 522 | """ |
|
523 | 523 | ).tag(config=True) |
|
524 | 524 | object_info_string_level = Enum((0,1,2), default_value=0, |
|
525 | 525 | ).tag(config=True) |
|
526 | 526 | pdb = Bool(False, help= |
|
527 | 527 | """ |
|
528 | 528 | Automatically call the pdb debugger after every exception. |
|
529 | 529 | """ |
|
530 | 530 | ).tag(config=True) |
|
531 | 531 | display_page = Bool(False, |
|
532 | 532 | help="""If True, anything that would be passed to the pager |
|
533 | 533 | will be displayed as regular output instead.""" |
|
534 | 534 | ).tag(config=True) |
|
535 | 535 | |
|
536 | 536 | # deprecated prompt traits: |
|
537 | 537 | |
|
538 | 538 | prompt_in1 = Unicode('In [\\#]: ', |
|
539 | 539 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
540 | 540 | ).tag(config=True) |
|
541 | 541 | prompt_in2 = Unicode(' .\\D.: ', |
|
542 | 542 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
543 | 543 | ).tag(config=True) |
|
544 | 544 | prompt_out = Unicode('Out[\\#]: ', |
|
545 | 545 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
546 | 546 | ).tag(config=True) |
|
547 | 547 | prompts_pad_left = Bool(True, |
|
548 | 548 | help="Deprecated since IPython 4.0 and ignored since 5.0, set TerminalInteractiveShell.prompts object directly." |
|
549 | 549 | ).tag(config=True) |
|
550 | 550 | |
|
551 | 551 | @observe('prompt_in1', 'prompt_in2', 'prompt_out', 'prompt_pad_left') |
|
552 | 552 | def _prompt_trait_changed(self, change): |
|
553 | 553 | name = change['name'] |
|
554 | 554 | warn("InteractiveShell.{name} is deprecated since IPython 4.0" |
|
555 | 555 | " and ignored since 5.0, set TerminalInteractiveShell.prompts" |
|
556 | 556 | " object directly.".format(name=name)) |
|
557 | 557 | |
|
558 | 558 | # protect against weird cases where self.config may not exist: |
|
559 | 559 | |
|
560 | 560 | show_rewritten_input = Bool(True, |
|
561 | 561 | help="Show rewritten input, e.g. for autocall." |
|
562 | 562 | ).tag(config=True) |
|
563 | 563 | |
|
564 | 564 | quiet = Bool(False).tag(config=True) |
|
565 | 565 | |
|
566 | 566 | history_length = Integer(10000, |
|
567 | 567 | help='Total length of command history' |
|
568 | 568 | ).tag(config=True) |
|
569 | 569 | |
|
570 | 570 | history_load_length = Integer(1000, help= |
|
571 | 571 | """ |
|
572 | 572 | The number of saved history entries to be loaded |
|
573 | 573 | into the history buffer at startup. |
|
574 | 574 | """ |
|
575 | 575 | ).tag(config=True) |
|
576 | 576 | |
|
577 | 577 | ast_node_interactivity = Enum(['all', 'last', 'last_expr', 'none', 'last_expr_or_assign'], |
|
578 | 578 | default_value='last_expr', |
|
579 | 579 | help=""" |
|
580 | 580 | 'all', 'last', 'last_expr' or 'none', 'last_expr_or_assign' specifying |
|
581 | 581 | which nodes should be run interactively (displaying output from expressions). |
|
582 | 582 | """ |
|
583 | 583 | ).tag(config=True) |
|
584 | 584 | |
|
585 | 585 | # TODO: this part of prompt management should be moved to the frontends. |
|
586 | 586 | # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n' |
|
587 | 587 | separate_in = SeparateUnicode('\n').tag(config=True) |
|
588 | 588 | separate_out = SeparateUnicode('').tag(config=True) |
|
589 | 589 | separate_out2 = SeparateUnicode('').tag(config=True) |
|
590 | 590 | wildcards_case_sensitive = Bool(True).tag(config=True) |
|
591 | 591 | xmode = CaselessStrEnum(('Context', 'Plain', 'Verbose', 'Minimal'), |
|
592 | 592 | default_value='Context', |
|
593 | 593 | help="Switch modes for the IPython exception handlers." |
|
594 | 594 | ).tag(config=True) |
|
595 | 595 | |
|
596 | 596 | # Subcomponents of InteractiveShell |
|
597 | 597 | alias_manager = Instance('IPython.core.alias.AliasManager', allow_none=True) |
|
598 | 598 | prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager', allow_none=True) |
|
599 | 599 | builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap', allow_none=True) |
|
600 | 600 | display_trap = Instance('IPython.core.display_trap.DisplayTrap', allow_none=True) |
|
601 | 601 | extension_manager = Instance('IPython.core.extensions.ExtensionManager', allow_none=True) |
|
602 | 602 | payload_manager = Instance('IPython.core.payload.PayloadManager', allow_none=True) |
|
603 | 603 | history_manager = Instance('IPython.core.history.HistoryAccessorBase', allow_none=True) |
|
604 | 604 | magics_manager = Instance('IPython.core.magic.MagicsManager', allow_none=True) |
|
605 | 605 | |
|
606 | 606 | profile_dir = Instance('IPython.core.application.ProfileDir', allow_none=True) |
|
607 | 607 | @property |
|
608 | 608 | def profile(self): |
|
609 | 609 | if self.profile_dir is not None: |
|
610 | 610 | name = os.path.basename(self.profile_dir.location) |
|
611 | 611 | return name.replace('profile_','') |
|
612 | 612 | |
|
613 | 613 | |
|
614 | 614 | # Private interface |
|
615 | 615 | _post_execute = Dict() |
|
616 | 616 | |
|
617 | 617 | # Tracks any GUI loop loaded for pylab |
|
618 | 618 | pylab_gui_select = None |
|
619 | 619 | |
|
620 | 620 | last_execution_succeeded = Bool(True, help='Did last executed command succeeded') |
|
621 | 621 | |
|
622 | 622 | last_execution_result = Instance('IPython.core.interactiveshell.ExecutionResult', help='Result of executing the last command', allow_none=True) |
|
623 | 623 | |
|
624 | 624 | def __init__(self, ipython_dir=None, profile_dir=None, |
|
625 | 625 | user_module=None, user_ns=None, |
|
626 | 626 | custom_exceptions=((), None), **kwargs): |
|
627 | 627 | |
|
628 | 628 | # This is where traits with a config_key argument are updated |
|
629 | 629 | # from the values on config. |
|
630 | 630 | super(InteractiveShell, self).__init__(**kwargs) |
|
631 | 631 | if 'PromptManager' in self.config: |
|
632 | 632 | warn('As of IPython 5.0 `PromptManager` config will have no effect' |
|
633 | 633 | ' and has been replaced by TerminalInteractiveShell.prompts_class') |
|
634 | 634 | self.configurables = [self] |
|
635 | 635 | |
|
636 | 636 | # These are relatively independent and stateless |
|
637 | 637 | self.init_ipython_dir(ipython_dir) |
|
638 | 638 | self.init_profile_dir(profile_dir) |
|
639 | 639 | self.init_instance_attrs() |
|
640 | 640 | self.init_environment() |
|
641 | 641 | |
|
642 | 642 | # Check if we're in a virtualenv, and set up sys.path. |
|
643 | 643 | self.init_virtualenv() |
|
644 | 644 | |
|
645 | 645 | # Create namespaces (user_ns, user_global_ns, etc.) |
|
646 | 646 | self.init_create_namespaces(user_module, user_ns) |
|
647 | 647 | # This has to be done after init_create_namespaces because it uses |
|
648 | 648 | # something in self.user_ns, but before init_sys_modules, which |
|
649 | 649 | # is the first thing to modify sys. |
|
650 | 650 | # TODO: When we override sys.stdout and sys.stderr before this class |
|
651 | 651 | # is created, we are saving the overridden ones here. Not sure if this |
|
652 | 652 | # is what we want to do. |
|
653 | 653 | self.save_sys_module_state() |
|
654 | 654 | self.init_sys_modules() |
|
655 | 655 | |
|
656 | 656 | # While we're trying to have each part of the code directly access what |
|
657 | 657 | # it needs without keeping redundant references to objects, we have too |
|
658 | 658 | # much legacy code that expects ip.db to exist. |
|
659 | 659 | self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db')) |
|
660 | 660 | |
|
661 | 661 | self.init_history() |
|
662 | 662 | self.init_encoding() |
|
663 | 663 | self.init_prefilter() |
|
664 | 664 | |
|
665 | 665 | self.init_syntax_highlighting() |
|
666 | 666 | self.init_hooks() |
|
667 | 667 | self.init_events() |
|
668 | 668 | self.init_pushd_popd_magic() |
|
669 | 669 | self.init_user_ns() |
|
670 | 670 | self.init_logger() |
|
671 | 671 | self.init_builtins() |
|
672 | 672 | |
|
673 | 673 | # The following was in post_config_initialization |
|
674 | 674 | self.init_inspector() |
|
675 | 675 | self.raw_input_original = input |
|
676 | 676 | self.init_completer() |
|
677 | 677 | # TODO: init_io() needs to happen before init_traceback handlers |
|
678 | 678 | # because the traceback handlers hardcode the stdout/stderr streams. |
|
679 | 679 | # This logic in in debugger.Pdb and should eventually be changed. |
|
680 | 680 | self.init_io() |
|
681 | 681 | self.init_traceback_handlers(custom_exceptions) |
|
682 | 682 | self.init_prompts() |
|
683 | 683 | self.init_display_formatter() |
|
684 | 684 | self.init_display_pub() |
|
685 | 685 | self.init_data_pub() |
|
686 | 686 | self.init_displayhook() |
|
687 | 687 | self.init_magics() |
|
688 | 688 | self.init_alias() |
|
689 | 689 | self.init_logstart() |
|
690 | 690 | self.init_pdb() |
|
691 | 691 | self.init_extension_manager() |
|
692 | 692 | self.init_payload() |
|
693 | 693 | self.init_deprecation_warnings() |
|
694 | 694 | self.hooks.late_startup_hook() |
|
695 | 695 | self.events.trigger('shell_initialized', self) |
|
696 | 696 | atexit.register(self.atexit_operations) |
|
697 | 697 | |
|
698 | 698 | # The trio runner is used for running Trio in the foreground thread. It |
|
699 | 699 | # is different from `_trio_runner(async_fn)` in `async_helpers.py` |
|
700 | 700 | # which calls `trio.run()` for every cell. This runner runs all cells |
|
701 | 701 | # inside a single Trio event loop. If used, it is set from |
|
702 | 702 | # `ipykernel.kernelapp`. |
|
703 | 703 | self.trio_runner = None |
|
704 | 704 | |
|
705 | 705 | def get_ipython(self): |
|
706 | 706 | """Return the currently running IPython instance.""" |
|
707 | 707 | return self |
|
708 | 708 | |
|
709 | 709 | #------------------------------------------------------------------------- |
|
710 | 710 | # Trait changed handlers |
|
711 | 711 | #------------------------------------------------------------------------- |
|
712 | 712 | @observe('ipython_dir') |
|
713 | 713 | def _ipython_dir_changed(self, change): |
|
714 | 714 | ensure_dir_exists(change['new']) |
|
715 | 715 | |
|
716 | 716 | def set_autoindent(self,value=None): |
|
717 | 717 | """Set the autoindent flag. |
|
718 | 718 | |
|
719 | 719 | If called with no arguments, it acts as a toggle.""" |
|
720 | 720 | if value is None: |
|
721 | 721 | self.autoindent = not self.autoindent |
|
722 | 722 | else: |
|
723 | 723 | self.autoindent = value |
|
724 | 724 | |
|
725 | 725 | def set_trio_runner(self, tr): |
|
726 | 726 | self.trio_runner = tr |
|
727 | 727 | |
|
728 | 728 | #------------------------------------------------------------------------- |
|
729 | 729 | # init_* methods called by __init__ |
|
730 | 730 | #------------------------------------------------------------------------- |
|
731 | 731 | |
|
732 | 732 | def init_ipython_dir(self, ipython_dir): |
|
733 | 733 | if ipython_dir is not None: |
|
734 | 734 | self.ipython_dir = ipython_dir |
|
735 | 735 | return |
|
736 | 736 | |
|
737 | 737 | self.ipython_dir = get_ipython_dir() |
|
738 | 738 | |
|
739 | 739 | def init_profile_dir(self, profile_dir): |
|
740 | 740 | if profile_dir is not None: |
|
741 | 741 | self.profile_dir = profile_dir |
|
742 | 742 | return |
|
743 | 743 | self.profile_dir =\ |
|
744 | 744 | ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default') |
|
745 | 745 | |
|
746 | 746 | def init_instance_attrs(self): |
|
747 | 747 | self.more = False |
|
748 | 748 | |
|
749 | 749 | # command compiler |
|
750 | 750 | self.compile = CachingCompiler() |
|
751 | 751 | |
|
752 | 752 | # Make an empty namespace, which extension writers can rely on both |
|
753 | 753 | # existing and NEVER being used by ipython itself. This gives them a |
|
754 | 754 | # convenient location for storing additional information and state |
|
755 | 755 | # their extensions may require, without fear of collisions with other |
|
756 | 756 | # ipython names that may develop later. |
|
757 | 757 | self.meta = Struct() |
|
758 | 758 | |
|
759 | 759 | # Temporary files used for various purposes. Deleted at exit. |
|
760 | 760 | self.tempfiles = [] |
|
761 | 761 | self.tempdirs = [] |
|
762 | 762 | |
|
763 | 763 | # keep track of where we started running (mainly for crash post-mortem) |
|
764 | 764 | # This is not being used anywhere currently. |
|
765 | 765 | self.starting_dir = os.getcwd() |
|
766 | 766 | |
|
767 | 767 | # Indentation management |
|
768 | 768 | self.indent_current_nsp = 0 |
|
769 | 769 | |
|
770 | 770 | # Dict to track post-execution functions that have been registered |
|
771 | 771 | self._post_execute = {} |
|
772 | 772 | |
|
773 | 773 | def init_environment(self): |
|
774 | 774 | """Any changes we need to make to the user's environment.""" |
|
775 | 775 | pass |
|
776 | 776 | |
|
777 | 777 | def init_encoding(self): |
|
778 | 778 | # Get system encoding at startup time. Certain terminals (like Emacs |
|
779 | 779 | # under Win32 have it set to None, and we need to have a known valid |
|
780 | 780 | # encoding to use in the raw_input() method |
|
781 | 781 | try: |
|
782 | 782 | self.stdin_encoding = sys.stdin.encoding or 'ascii' |
|
783 | 783 | except AttributeError: |
|
784 | 784 | self.stdin_encoding = 'ascii' |
|
785 | 785 | |
|
786 | 786 | |
|
787 | 787 | @observe('colors') |
|
788 | 788 | def init_syntax_highlighting(self, changes=None): |
|
789 | 789 | # Python source parser/formatter for syntax highlighting |
|
790 | 790 | pyformat = PyColorize.Parser(style=self.colors, parent=self).format |
|
791 | 791 | self.pycolorize = lambda src: pyformat(src,'str') |
|
792 | 792 | |
|
793 | 793 | def refresh_style(self): |
|
794 | 794 | # No-op here, used in subclass |
|
795 | 795 | pass |
|
796 | 796 | |
|
797 | 797 | def init_pushd_popd_magic(self): |
|
798 | 798 | # for pushd/popd management |
|
799 | 799 | self.home_dir = get_home_dir() |
|
800 | 800 | |
|
801 | 801 | self.dir_stack = [] |
|
802 | 802 | |
|
803 | 803 | def init_logger(self): |
|
804 | 804 | self.logger = Logger(self.home_dir, logfname='ipython_log.py', |
|
805 | 805 | logmode='rotate') |
|
806 | 806 | |
|
807 | 807 | def init_logstart(self): |
|
808 | 808 | """Initialize logging in case it was requested at the command line. |
|
809 | 809 | """ |
|
810 | 810 | if self.logappend: |
|
811 | 811 | self.magic('logstart %s append' % self.logappend) |
|
812 | 812 | elif self.logfile: |
|
813 | 813 | self.magic('logstart %s' % self.logfile) |
|
814 | 814 | elif self.logstart: |
|
815 | 815 | self.magic('logstart') |
|
816 | 816 | |
|
817 | 817 | def init_deprecation_warnings(self): |
|
818 | 818 | """ |
|
819 | 819 | register default filter for deprecation warning. |
|
820 | 820 | |
|
821 | 821 | This will allow deprecation warning of function used interactively to show |
|
822 | 822 | warning to users, and still hide deprecation warning from libraries import. |
|
823 | 823 | """ |
|
824 | 824 | if sys.version_info < (3,7): |
|
825 | 825 | warnings.filterwarnings("default", category=DeprecationWarning, module=self.user_ns.get("__name__")) |
|
826 | 826 | |
|
827 | 827 | |
|
828 | 828 | def init_builtins(self): |
|
829 | 829 | # A single, static flag that we set to True. Its presence indicates |
|
830 | 830 | # that an IPython shell has been created, and we make no attempts at |
|
831 | 831 | # removing on exit or representing the existence of more than one |
|
832 | 832 | # IPython at a time. |
|
833 | 833 | builtin_mod.__dict__['__IPYTHON__'] = True |
|
834 | 834 | builtin_mod.__dict__['display'] = display |
|
835 | 835 | |
|
836 | 836 | self.builtin_trap = BuiltinTrap(shell=self) |
|
837 | 837 | |
|
838 | 838 | @observe('colors') |
|
839 | 839 | def init_inspector(self, changes=None): |
|
840 | 840 | # Object inspector |
|
841 | 841 | self.inspector = oinspect.Inspector(oinspect.InspectColors, |
|
842 | 842 | PyColorize.ANSICodeColors, |
|
843 | 843 | self.colors, |
|
844 | 844 | self.object_info_string_level) |
|
845 | 845 | |
|
846 | 846 | def init_io(self): |
|
847 | 847 | # This will just use sys.stdout and sys.stderr. If you want to |
|
848 | 848 | # override sys.stdout and sys.stderr themselves, you need to do that |
|
849 | 849 | # *before* instantiating this class, because io holds onto |
|
850 | 850 | # references to the underlying streams. |
|
851 | 851 | # io.std* are deprecated, but don't show our own deprecation warnings |
|
852 | 852 | # during initialization of the deprecated API. |
|
853 | 853 | with warnings.catch_warnings(): |
|
854 | 854 | warnings.simplefilter('ignore', DeprecationWarning) |
|
855 | 855 | io.stdout = io.IOStream(sys.stdout) |
|
856 | 856 | io.stderr = io.IOStream(sys.stderr) |
|
857 | 857 | |
|
858 | 858 | def init_prompts(self): |
|
859 | 859 | # Set system prompts, so that scripts can decide if they are running |
|
860 | 860 | # interactively. |
|
861 | 861 | sys.ps1 = 'In : ' |
|
862 | 862 | sys.ps2 = '...: ' |
|
863 | 863 | sys.ps3 = 'Out: ' |
|
864 | 864 | |
|
865 | 865 | def init_display_formatter(self): |
|
866 | 866 | self.display_formatter = DisplayFormatter(parent=self) |
|
867 | 867 | self.configurables.append(self.display_formatter) |
|
868 | 868 | |
|
869 | 869 | def init_display_pub(self): |
|
870 | 870 | self.display_pub = self.display_pub_class(parent=self, shell=self) |
|
871 | 871 | self.configurables.append(self.display_pub) |
|
872 | 872 | |
|
873 | 873 | def init_data_pub(self): |
|
874 | 874 | if not self.data_pub_class: |
|
875 | 875 | self.data_pub = None |
|
876 | 876 | return |
|
877 | 877 | self.data_pub = self.data_pub_class(parent=self) |
|
878 | 878 | self.configurables.append(self.data_pub) |
|
879 | 879 | |
|
880 | 880 | def init_displayhook(self): |
|
881 | 881 | # Initialize displayhook, set in/out prompts and printing system |
|
882 | 882 | self.displayhook = self.displayhook_class( |
|
883 | 883 | parent=self, |
|
884 | 884 | shell=self, |
|
885 | 885 | cache_size=self.cache_size, |
|
886 | 886 | ) |
|
887 | 887 | self.configurables.append(self.displayhook) |
|
888 | 888 | # This is a context manager that installs/revmoes the displayhook at |
|
889 | 889 | # the appropriate time. |
|
890 | 890 | self.display_trap = DisplayTrap(hook=self.displayhook) |
|
891 | 891 | |
|
892 | 892 | def init_virtualenv(self): |
|
893 | 893 | """Add a virtualenv to sys.path so the user can import modules from it. |
|
894 | 894 | This isn't perfect: it doesn't use the Python interpreter with which the |
|
895 | 895 | virtualenv was built, and it ignores the --no-site-packages option. A |
|
896 | 896 | warning will appear suggesting the user installs IPython in the |
|
897 | 897 | virtualenv, but for many cases, it probably works well enough. |
|
898 | 898 | |
|
899 | 899 | Adapted from code snippets online. |
|
900 | 900 | |
|
901 | 901 | http://blog.ufsoft.org/2009/1/29/ipython-and-virtualenv |
|
902 | 902 | """ |
|
903 | 903 | if 'VIRTUAL_ENV' not in os.environ: |
|
904 | 904 | # Not in a virtualenv |
|
905 | 905 | return |
|
906 | 906 | |
|
907 | 907 | p = os.path.normcase(sys.executable) |
|
908 | 908 | p_venv = os.path.normcase(os.environ['VIRTUAL_ENV']) |
|
909 | 909 | |
|
910 | 910 | # executable path should end like /bin/python or \\scripts\\python.exe |
|
911 | 911 | p_exe_up2 = os.path.dirname(os.path.dirname(p)) |
|
912 | 912 | if p_exe_up2 and os.path.exists(p_venv) and os.path.samefile(p_exe_up2, p_venv): |
|
913 | 913 | # Our exe is inside the virtualenv, don't need to do anything. |
|
914 | 914 | return |
|
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 os.path.islink(p): |
|
922 | 922 | p = os.path.normcase(os.path.join(os.path.dirname(p), os.readlink(p))) |
|
923 | 923 | paths.append(p) |
|
924 | 924 | |
|
925 | 925 | # In Cygwin paths like "c:\..." and '\cygdrive\c\...' are possible |
|
926 | 926 | if p_venv.startswith('\\cygdrive'): |
|
927 | 927 | p_venv = p_venv[11:] |
|
928 | 928 | elif len(p_venv) >= 2 and p_venv[1] == ':': |
|
929 | 929 | p_venv = p_venv[2:] |
|
930 | 930 | |
|
931 | 931 | if any(p_venv in p for p in paths): |
|
932 | 932 | # Running properly in the virtualenv, don't need to do anything |
|
933 | 933 | return |
|
934 | 934 | |
|
935 | 935 | warn("Attempting to work in a virtualenv. If you encounter problems, please " |
|
936 | 936 | "install IPython inside the virtualenv.") |
|
937 | 937 | if sys.platform == "win32": |
|
938 | 938 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'Lib', 'site-packages') |
|
939 | 939 | else: |
|
940 | 940 | virtual_env = os.path.join(os.environ['VIRTUAL_ENV'], 'lib', |
|
941 | 941 | 'python%d.%d' % sys.version_info[:2], 'site-packages') |
|
942 | 942 | |
|
943 | 943 | import site |
|
944 | 944 | sys.path.insert(0, virtual_env) |
|
945 | 945 | site.addsitedir(virtual_env) |
|
946 | 946 | |
|
947 | 947 | #------------------------------------------------------------------------- |
|
948 | 948 | # Things related to injections into the sys module |
|
949 | 949 | #------------------------------------------------------------------------- |
|
950 | 950 | |
|
951 | 951 | def save_sys_module_state(self): |
|
952 | 952 | """Save the state of hooks in the sys module. |
|
953 | 953 | |
|
954 | 954 | This has to be called after self.user_module is created. |
|
955 | 955 | """ |
|
956 | 956 | self._orig_sys_module_state = {'stdin': sys.stdin, |
|
957 | 957 | 'stdout': sys.stdout, |
|
958 | 958 | 'stderr': sys.stderr, |
|
959 | 959 | 'excepthook': sys.excepthook} |
|
960 | 960 | self._orig_sys_modules_main_name = self.user_module.__name__ |
|
961 | 961 | self._orig_sys_modules_main_mod = sys.modules.get(self.user_module.__name__) |
|
962 | 962 | |
|
963 | 963 | def restore_sys_module_state(self): |
|
964 | 964 | """Restore the state of the sys module.""" |
|
965 | 965 | try: |
|
966 | 966 | for k, v in self._orig_sys_module_state.items(): |
|
967 | 967 | setattr(sys, k, v) |
|
968 | 968 | except AttributeError: |
|
969 | 969 | pass |
|
970 | 970 | # Reset what what done in self.init_sys_modules |
|
971 | 971 | if self._orig_sys_modules_main_mod is not None: |
|
972 | 972 | sys.modules[self._orig_sys_modules_main_name] = self._orig_sys_modules_main_mod |
|
973 | 973 | |
|
974 | 974 | #------------------------------------------------------------------------- |
|
975 | 975 | # Things related to the banner |
|
976 | 976 | #------------------------------------------------------------------------- |
|
977 | 977 | |
|
978 | 978 | @property |
|
979 | 979 | def banner(self): |
|
980 | 980 | banner = self.banner1 |
|
981 | 981 | if self.profile and self.profile != 'default': |
|
982 | 982 | banner += '\nIPython profile: %s\n' % self.profile |
|
983 | 983 | if self.banner2: |
|
984 | 984 | banner += '\n' + self.banner2 |
|
985 | 985 | return banner |
|
986 | 986 | |
|
987 | 987 | def show_banner(self, banner=None): |
|
988 | 988 | if banner is None: |
|
989 | 989 | banner = self.banner |
|
990 | 990 | sys.stdout.write(banner) |
|
991 | 991 | |
|
992 | 992 | #------------------------------------------------------------------------- |
|
993 | 993 | # Things related to hooks |
|
994 | 994 | #------------------------------------------------------------------------- |
|
995 | 995 | |
|
996 | 996 | def init_hooks(self): |
|
997 | 997 | # hooks holds pointers used for user-side customizations |
|
998 | 998 | self.hooks = Struct() |
|
999 | 999 | |
|
1000 | 1000 | self.strdispatchers = {} |
|
1001 | 1001 | |
|
1002 | 1002 | # Set all default hooks, defined in the IPython.hooks module. |
|
1003 | 1003 | hooks = IPython.core.hooks |
|
1004 | 1004 | for hook_name in hooks.__all__: |
|
1005 | 1005 | # default hooks have priority 100, i.e. low; user hooks should have |
|
1006 | 1006 | # 0-100 priority |
|
1007 | 1007 | self.set_hook(hook_name,getattr(hooks,hook_name), 100, _warn_deprecated=False) |
|
1008 | 1008 | |
|
1009 | 1009 | if self.display_page: |
|
1010 | 1010 | self.set_hook('show_in_pager', page.as_hook(page.display_page), 90) |
|
1011 | 1011 | |
|
1012 | 1012 | def set_hook(self,name,hook, priority=50, str_key=None, re_key=None, |
|
1013 | 1013 | _warn_deprecated=True): |
|
1014 | 1014 | """set_hook(name,hook) -> sets an internal IPython hook. |
|
1015 | 1015 | |
|
1016 | 1016 | IPython exposes some of its internal API as user-modifiable hooks. By |
|
1017 | 1017 | adding your function to one of these hooks, you can modify IPython's |
|
1018 | 1018 | behavior to call at runtime your own routines.""" |
|
1019 | 1019 | |
|
1020 | 1020 | # At some point in the future, this should validate the hook before it |
|
1021 | 1021 | # accepts it. Probably at least check that the hook takes the number |
|
1022 | 1022 | # of args it's supposed to. |
|
1023 | 1023 | |
|
1024 | 1024 | f = types.MethodType(hook,self) |
|
1025 | 1025 | |
|
1026 | 1026 | # check if the hook is for strdispatcher first |
|
1027 | 1027 | if str_key is not None: |
|
1028 | 1028 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1029 | 1029 | sdp.add_s(str_key, f, priority ) |
|
1030 | 1030 | self.strdispatchers[name] = sdp |
|
1031 | 1031 | return |
|
1032 | 1032 | if re_key is not None: |
|
1033 | 1033 | sdp = self.strdispatchers.get(name, StrDispatch()) |
|
1034 | 1034 | sdp.add_re(re.compile(re_key), f, priority ) |
|
1035 | 1035 | self.strdispatchers[name] = sdp |
|
1036 | 1036 | return |
|
1037 | 1037 | |
|
1038 | 1038 | dp = getattr(self.hooks, name, None) |
|
1039 | 1039 | if name not in IPython.core.hooks.__all__: |
|
1040 | 1040 | print("Warning! Hook '%s' is not one of %s" % \ |
|
1041 | 1041 | (name, IPython.core.hooks.__all__ )) |
|
1042 | 1042 | |
|
1043 | 1043 | if _warn_deprecated and (name in IPython.core.hooks.deprecated): |
|
1044 | 1044 | alternative = IPython.core.hooks.deprecated[name] |
|
1045 | 1045 | warn("Hook {} is deprecated. Use {} instead.".format(name, alternative), stacklevel=2) |
|
1046 | 1046 | |
|
1047 | 1047 | if not dp: |
|
1048 | 1048 | dp = IPython.core.hooks.CommandChainDispatcher() |
|
1049 | 1049 | |
|
1050 | 1050 | try: |
|
1051 | 1051 | dp.add(f,priority) |
|
1052 | 1052 | except AttributeError: |
|
1053 | 1053 | # it was not commandchain, plain old func - replace |
|
1054 | 1054 | dp = f |
|
1055 | 1055 | |
|
1056 | 1056 | setattr(self.hooks,name, dp) |
|
1057 | 1057 | |
|
1058 | 1058 | #------------------------------------------------------------------------- |
|
1059 | 1059 | # Things related to events |
|
1060 | 1060 | #------------------------------------------------------------------------- |
|
1061 | 1061 | |
|
1062 | 1062 | def init_events(self): |
|
1063 | 1063 | self.events = EventManager(self, available_events) |
|
1064 | 1064 | |
|
1065 | 1065 | self.events.register("pre_execute", self._clear_warning_registry) |
|
1066 | 1066 | |
|
1067 | 1067 | def register_post_execute(self, func): |
|
1068 | 1068 | """DEPRECATED: Use ip.events.register('post_run_cell', func) |
|
1069 | 1069 | |
|
1070 | 1070 | Register a function for calling after code execution. |
|
1071 | 1071 | """ |
|
1072 | 1072 | warn("ip.register_post_execute is deprecated, use " |
|
1073 | 1073 | "ip.events.register('post_run_cell', func) instead.", stacklevel=2) |
|
1074 | 1074 | self.events.register('post_run_cell', func) |
|
1075 | 1075 | |
|
1076 | 1076 | def _clear_warning_registry(self): |
|
1077 | 1077 | # clear the warning registry, so that different code blocks with |
|
1078 | 1078 | # overlapping line number ranges don't cause spurious suppression of |
|
1079 | 1079 | # warnings (see gh-6611 for details) |
|
1080 | 1080 | if "__warningregistry__" in self.user_global_ns: |
|
1081 | 1081 | del self.user_global_ns["__warningregistry__"] |
|
1082 | 1082 | |
|
1083 | 1083 | #------------------------------------------------------------------------- |
|
1084 | 1084 | # Things related to the "main" module |
|
1085 | 1085 | #------------------------------------------------------------------------- |
|
1086 | 1086 | |
|
1087 | 1087 | def new_main_mod(self, filename, modname): |
|
1088 | 1088 | """Return a new 'main' module object for user code execution. |
|
1089 | 1089 | |
|
1090 | 1090 | ``filename`` should be the path of the script which will be run in the |
|
1091 | 1091 | module. Requests with the same filename will get the same module, with |
|
1092 | 1092 | its namespace cleared. |
|
1093 | 1093 | |
|
1094 | 1094 | ``modname`` should be the module name - normally either '__main__' or |
|
1095 | 1095 | the basename of the file without the extension. |
|
1096 | 1096 | |
|
1097 | 1097 | When scripts are executed via %run, we must keep a reference to their |
|
1098 | 1098 | __main__ module around so that Python doesn't |
|
1099 | 1099 | clear it, rendering references to module globals useless. |
|
1100 | 1100 | |
|
1101 | 1101 | This method keeps said reference in a private dict, keyed by the |
|
1102 | 1102 | absolute path of the script. This way, for multiple executions of the |
|
1103 | 1103 | same script we only keep one copy of the namespace (the last one), |
|
1104 | 1104 | thus preventing memory leaks from old references while allowing the |
|
1105 | 1105 | objects from the last execution to be accessible. |
|
1106 | 1106 | """ |
|
1107 | 1107 | filename = os.path.abspath(filename) |
|
1108 | 1108 | try: |
|
1109 | 1109 | main_mod = self._main_mod_cache[filename] |
|
1110 | 1110 | except KeyError: |
|
1111 | 1111 | main_mod = self._main_mod_cache[filename] = types.ModuleType( |
|
1112 | 1112 | modname, |
|
1113 | 1113 | doc="Module created for script run in IPython") |
|
1114 | 1114 | else: |
|
1115 | 1115 | main_mod.__dict__.clear() |
|
1116 | 1116 | main_mod.__name__ = modname |
|
1117 | 1117 | |
|
1118 | 1118 | main_mod.__file__ = filename |
|
1119 | 1119 | # It seems pydoc (and perhaps others) needs any module instance to |
|
1120 | 1120 | # implement a __nonzero__ method |
|
1121 | 1121 | main_mod.__nonzero__ = lambda : True |
|
1122 | 1122 | |
|
1123 | 1123 | return main_mod |
|
1124 | 1124 | |
|
1125 | 1125 | def clear_main_mod_cache(self): |
|
1126 | 1126 | """Clear the cache of main modules. |
|
1127 | 1127 | |
|
1128 | 1128 | Mainly for use by utilities like %reset. |
|
1129 | 1129 | |
|
1130 | 1130 | Examples |
|
1131 | 1131 | -------- |
|
1132 | 1132 | |
|
1133 | 1133 | In [15]: import IPython |
|
1134 | 1134 | |
|
1135 | 1135 | In [16]: m = _ip.new_main_mod(IPython.__file__, 'IPython') |
|
1136 | 1136 | |
|
1137 | 1137 | In [17]: len(_ip._main_mod_cache) > 0 |
|
1138 | 1138 | Out[17]: True |
|
1139 | 1139 | |
|
1140 | 1140 | In [18]: _ip.clear_main_mod_cache() |
|
1141 | 1141 | |
|
1142 | 1142 | In [19]: len(_ip._main_mod_cache) == 0 |
|
1143 | 1143 | Out[19]: True |
|
1144 | 1144 | """ |
|
1145 | 1145 | self._main_mod_cache.clear() |
|
1146 | 1146 | |
|
1147 | 1147 | #------------------------------------------------------------------------- |
|
1148 | 1148 | # Things related to debugging |
|
1149 | 1149 | #------------------------------------------------------------------------- |
|
1150 | 1150 | |
|
1151 | 1151 | def init_pdb(self): |
|
1152 | 1152 | # Set calling of pdb on exceptions |
|
1153 | 1153 | # self.call_pdb is a property |
|
1154 | 1154 | self.call_pdb = self.pdb |
|
1155 | 1155 | |
|
1156 | 1156 | def _get_call_pdb(self): |
|
1157 | 1157 | return self._call_pdb |
|
1158 | 1158 | |
|
1159 | 1159 | def _set_call_pdb(self,val): |
|
1160 | 1160 | |
|
1161 | 1161 | if val not in (0,1,False,True): |
|
1162 | 1162 | raise ValueError('new call_pdb value must be boolean') |
|
1163 | 1163 | |
|
1164 | 1164 | # store value in instance |
|
1165 | 1165 | self._call_pdb = val |
|
1166 | 1166 | |
|
1167 | 1167 | # notify the actual exception handlers |
|
1168 | 1168 | self.InteractiveTB.call_pdb = val |
|
1169 | 1169 | |
|
1170 | 1170 | call_pdb = property(_get_call_pdb,_set_call_pdb,None, |
|
1171 | 1171 | 'Control auto-activation of pdb at exceptions') |
|
1172 | 1172 | |
|
1173 | 1173 | def debugger(self,force=False): |
|
1174 | 1174 | """Call the pdb debugger. |
|
1175 | 1175 | |
|
1176 | 1176 | Keywords: |
|
1177 | 1177 | |
|
1178 | 1178 | - force(False): by default, this routine checks the instance call_pdb |
|
1179 | 1179 | flag and does not actually invoke the debugger if the flag is false. |
|
1180 | 1180 | The 'force' option forces the debugger to activate even if the flag |
|
1181 | 1181 | is false. |
|
1182 | 1182 | """ |
|
1183 | 1183 | |
|
1184 | 1184 | if not (force or self.call_pdb): |
|
1185 | 1185 | return |
|
1186 | 1186 | |
|
1187 | 1187 | if not hasattr(sys,'last_traceback'): |
|
1188 | 1188 | error('No traceback has been produced, nothing to debug.') |
|
1189 | 1189 | return |
|
1190 | 1190 | |
|
1191 | 1191 | self.InteractiveTB.debugger(force=True) |
|
1192 | 1192 | |
|
1193 | 1193 | #------------------------------------------------------------------------- |
|
1194 | 1194 | # Things related to IPython's various namespaces |
|
1195 | 1195 | #------------------------------------------------------------------------- |
|
1196 | 1196 | default_user_namespaces = True |
|
1197 | 1197 | |
|
1198 | 1198 | def init_create_namespaces(self, user_module=None, user_ns=None): |
|
1199 | 1199 | # Create the namespace where the user will operate. user_ns is |
|
1200 | 1200 | # normally the only one used, and it is passed to the exec calls as |
|
1201 | 1201 | # the locals argument. But we do carry a user_global_ns namespace |
|
1202 | 1202 | # given as the exec 'globals' argument, This is useful in embedding |
|
1203 | 1203 | # situations where the ipython shell opens in a context where the |
|
1204 | 1204 | # distinction between locals and globals is meaningful. For |
|
1205 | 1205 | # non-embedded contexts, it is just the same object as the user_ns dict. |
|
1206 | 1206 | |
|
1207 | 1207 | # FIXME. For some strange reason, __builtins__ is showing up at user |
|
1208 | 1208 | # level as a dict instead of a module. This is a manual fix, but I |
|
1209 | 1209 | # should really track down where the problem is coming from. Alex |
|
1210 | 1210 | # Schmolck reported this problem first. |
|
1211 | 1211 | |
|
1212 | 1212 | # A useful post by Alex Martelli on this topic: |
|
1213 | 1213 | # Re: inconsistent value from __builtins__ |
|
1214 | 1214 | # Von: Alex Martelli <aleaxit@yahoo.com> |
|
1215 | 1215 | # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends |
|
1216 | 1216 | # Gruppen: comp.lang.python |
|
1217 | 1217 | |
|
1218 | 1218 | # Michael Hohn <hohn@hooknose.lbl.gov> wrote: |
|
1219 | 1219 | # > >>> print type(builtin_check.get_global_binding('__builtins__')) |
|
1220 | 1220 | # > <type 'dict'> |
|
1221 | 1221 | # > >>> print type(__builtins__) |
|
1222 | 1222 | # > <type 'module'> |
|
1223 | 1223 | # > Is this difference in return value intentional? |
|
1224 | 1224 | |
|
1225 | 1225 | # Well, it's documented that '__builtins__' can be either a dictionary |
|
1226 | 1226 | # or a module, and it's been that way for a long time. Whether it's |
|
1227 | 1227 | # intentional (or sensible), I don't know. In any case, the idea is |
|
1228 | 1228 | # that if you need to access the built-in namespace directly, you |
|
1229 | 1229 | # should start with "import __builtin__" (note, no 's') which will |
|
1230 | 1230 | # definitely give you a module. Yeah, it's somewhat confusing:-(. |
|
1231 | 1231 | |
|
1232 | 1232 | # These routines return a properly built module and dict as needed by |
|
1233 | 1233 | # the rest of the code, and can also be used by extension writers to |
|
1234 | 1234 | # generate properly initialized namespaces. |
|
1235 | 1235 | if (user_ns is not None) or (user_module is not None): |
|
1236 | 1236 | self.default_user_namespaces = False |
|
1237 | 1237 | self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns) |
|
1238 | 1238 | |
|
1239 | 1239 | # A record of hidden variables we have added to the user namespace, so |
|
1240 | 1240 | # we can list later only variables defined in actual interactive use. |
|
1241 | 1241 | self.user_ns_hidden = {} |
|
1242 | 1242 | |
|
1243 | 1243 | # Now that FakeModule produces a real module, we've run into a nasty |
|
1244 | 1244 | # problem: after script execution (via %run), the module where the user |
|
1245 | 1245 | # code ran is deleted. Now that this object is a true module (needed |
|
1246 | 1246 | # so doctest and other tools work correctly), the Python module |
|
1247 | 1247 | # teardown mechanism runs over it, and sets to None every variable |
|
1248 | 1248 | # present in that module. Top-level references to objects from the |
|
1249 | 1249 | # script survive, because the user_ns is updated with them. However, |
|
1250 | 1250 | # calling functions defined in the script that use other things from |
|
1251 | 1251 | # the script will fail, because the function's closure had references |
|
1252 | 1252 | # to the original objects, which are now all None. So we must protect |
|
1253 | 1253 | # these modules from deletion by keeping a cache. |
|
1254 | 1254 | # |
|
1255 | 1255 | # To avoid keeping stale modules around (we only need the one from the |
|
1256 | 1256 | # last run), we use a dict keyed with the full path to the script, so |
|
1257 | 1257 | # only the last version of the module is held in the cache. Note, |
|
1258 | 1258 | # however, that we must cache the module *namespace contents* (their |
|
1259 | 1259 | # __dict__). Because if we try to cache the actual modules, old ones |
|
1260 | 1260 | # (uncached) could be destroyed while still holding references (such as |
|
1261 | 1261 | # those held by GUI objects that tend to be long-lived)> |
|
1262 | 1262 | # |
|
1263 | 1263 | # The %reset command will flush this cache. See the cache_main_mod() |
|
1264 | 1264 | # and clear_main_mod_cache() methods for details on use. |
|
1265 | 1265 | |
|
1266 | 1266 | # This is the cache used for 'main' namespaces |
|
1267 | 1267 | self._main_mod_cache = {} |
|
1268 | 1268 | |
|
1269 | 1269 | # A table holding all the namespaces IPython deals with, so that |
|
1270 | 1270 | # introspection facilities can search easily. |
|
1271 | 1271 | self.ns_table = {'user_global':self.user_module.__dict__, |
|
1272 | 1272 | 'user_local':self.user_ns, |
|
1273 | 1273 | 'builtin':builtin_mod.__dict__ |
|
1274 | 1274 | } |
|
1275 | 1275 | |
|
1276 | 1276 | @property |
|
1277 | 1277 | def user_global_ns(self): |
|
1278 | 1278 | return self.user_module.__dict__ |
|
1279 | 1279 | |
|
1280 | 1280 | def prepare_user_module(self, user_module=None, user_ns=None): |
|
1281 | 1281 | """Prepare the module and namespace in which user code will be run. |
|
1282 | 1282 | |
|
1283 | 1283 | When IPython is started normally, both parameters are None: a new module |
|
1284 | 1284 | is created automatically, and its __dict__ used as the namespace. |
|
1285 | 1285 | |
|
1286 | 1286 | If only user_module is provided, its __dict__ is used as the namespace. |
|
1287 | 1287 | If only user_ns is provided, a dummy module is created, and user_ns |
|
1288 | 1288 | becomes the global namespace. If both are provided (as they may be |
|
1289 | 1289 | when embedding), user_ns is the local namespace, and user_module |
|
1290 | 1290 | provides the global namespace. |
|
1291 | 1291 | |
|
1292 | 1292 | Parameters |
|
1293 | 1293 | ---------- |
|
1294 | 1294 | user_module : module, optional |
|
1295 | 1295 | The current user module in which IPython is being run. If None, |
|
1296 | 1296 | a clean module will be created. |
|
1297 | 1297 | user_ns : dict, optional |
|
1298 | 1298 | A namespace in which to run interactive commands. |
|
1299 | 1299 | |
|
1300 | 1300 | Returns |
|
1301 | 1301 | ------- |
|
1302 | 1302 | A tuple of user_module and user_ns, each properly initialised. |
|
1303 | 1303 | """ |
|
1304 | 1304 | if user_module is None and user_ns is not None: |
|
1305 | 1305 | user_ns.setdefault("__name__", "__main__") |
|
1306 | 1306 | user_module = DummyMod() |
|
1307 | 1307 | user_module.__dict__ = user_ns |
|
1308 | 1308 | |
|
1309 | 1309 | if user_module is None: |
|
1310 | 1310 | user_module = types.ModuleType("__main__", |
|
1311 | 1311 | doc="Automatically created module for IPython interactive environment") |
|
1312 | 1312 | |
|
1313 | 1313 | # We must ensure that __builtin__ (without the final 's') is always |
|
1314 | 1314 | # available and pointing to the __builtin__ *module*. For more details: |
|
1315 | 1315 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1316 | 1316 | user_module.__dict__.setdefault('__builtin__', builtin_mod) |
|
1317 | 1317 | user_module.__dict__.setdefault('__builtins__', builtin_mod) |
|
1318 | 1318 | |
|
1319 | 1319 | if user_ns is None: |
|
1320 | 1320 | user_ns = user_module.__dict__ |
|
1321 | 1321 | |
|
1322 | 1322 | return user_module, user_ns |
|
1323 | 1323 | |
|
1324 | 1324 | def init_sys_modules(self): |
|
1325 | 1325 | # We need to insert into sys.modules something that looks like a |
|
1326 | 1326 | # module but which accesses the IPython namespace, for shelve and |
|
1327 | 1327 | # pickle to work interactively. Normally they rely on getting |
|
1328 | 1328 | # everything out of __main__, but for embedding purposes each IPython |
|
1329 | 1329 | # instance has its own private namespace, so we can't go shoving |
|
1330 | 1330 | # everything into __main__. |
|
1331 | 1331 | |
|
1332 | 1332 | # note, however, that we should only do this for non-embedded |
|
1333 | 1333 | # ipythons, which really mimic the __main__.__dict__ with their own |
|
1334 | 1334 | # namespace. Embedded instances, on the other hand, should not do |
|
1335 | 1335 | # this because they need to manage the user local/global namespaces |
|
1336 | 1336 | # only, but they live within a 'normal' __main__ (meaning, they |
|
1337 | 1337 | # shouldn't overtake the execution environment of the script they're |
|
1338 | 1338 | # embedded in). |
|
1339 | 1339 | |
|
1340 | 1340 | # This is overridden in the InteractiveShellEmbed subclass to a no-op. |
|
1341 | 1341 | main_name = self.user_module.__name__ |
|
1342 | 1342 | sys.modules[main_name] = self.user_module |
|
1343 | 1343 | |
|
1344 | 1344 | def init_user_ns(self): |
|
1345 | 1345 | """Initialize all user-visible namespaces to their minimum defaults. |
|
1346 | 1346 | |
|
1347 | 1347 | Certain history lists are also initialized here, as they effectively |
|
1348 | 1348 | act as user namespaces. |
|
1349 | 1349 | |
|
1350 | 1350 | Notes |
|
1351 | 1351 | ----- |
|
1352 | 1352 | All data structures here are only filled in, they are NOT reset by this |
|
1353 | 1353 | method. If they were not empty before, data will simply be added to |
|
1354 | 1354 | them. |
|
1355 | 1355 | """ |
|
1356 | 1356 | # This function works in two parts: first we put a few things in |
|
1357 | 1357 | # user_ns, and we sync that contents into user_ns_hidden so that these |
|
1358 | 1358 | # initial variables aren't shown by %who. After the sync, we add the |
|
1359 | 1359 | # rest of what we *do* want the user to see with %who even on a new |
|
1360 | 1360 | # session (probably nothing, so they really only see their own stuff) |
|
1361 | 1361 | |
|
1362 | 1362 | # The user dict must *always* have a __builtin__ reference to the |
|
1363 | 1363 | # Python standard __builtin__ namespace, which must be imported. |
|
1364 | 1364 | # This is so that certain operations in prompt evaluation can be |
|
1365 | 1365 | # reliably executed with builtins. Note that we can NOT use |
|
1366 | 1366 | # __builtins__ (note the 's'), because that can either be a dict or a |
|
1367 | 1367 | # module, and can even mutate at runtime, depending on the context |
|
1368 | 1368 | # (Python makes no guarantees on it). In contrast, __builtin__ is |
|
1369 | 1369 | # always a module object, though it must be explicitly imported. |
|
1370 | 1370 | |
|
1371 | 1371 | # For more details: |
|
1372 | 1372 | # http://mail.python.org/pipermail/python-dev/2001-April/014068.html |
|
1373 | 1373 | ns = {} |
|
1374 | 1374 | |
|
1375 | 1375 | # make global variables for user access to the histories |
|
1376 | 1376 | ns['_ih'] = self.history_manager.input_hist_parsed |
|
1377 | 1377 | ns['_oh'] = self.history_manager.output_hist |
|
1378 | 1378 | ns['_dh'] = self.history_manager.dir_hist |
|
1379 | 1379 | |
|
1380 | 1380 | # user aliases to input and output histories. These shouldn't show up |
|
1381 | 1381 | # in %who, as they can have very large reprs. |
|
1382 | 1382 | ns['In'] = self.history_manager.input_hist_parsed |
|
1383 | 1383 | ns['Out'] = self.history_manager.output_hist |
|
1384 | 1384 | |
|
1385 | 1385 | # Store myself as the public api!!! |
|
1386 | 1386 | ns['get_ipython'] = self.get_ipython |
|
1387 | 1387 | |
|
1388 | 1388 | ns['exit'] = self.exiter |
|
1389 | 1389 | ns['quit'] = self.exiter |
|
1390 | 1390 | |
|
1391 | 1391 | # Sync what we've added so far to user_ns_hidden so these aren't seen |
|
1392 | 1392 | # by %who |
|
1393 | 1393 | self.user_ns_hidden.update(ns) |
|
1394 | 1394 | |
|
1395 | 1395 | # Anything put into ns now would show up in %who. Think twice before |
|
1396 | 1396 | # putting anything here, as we really want %who to show the user their |
|
1397 | 1397 | # stuff, not our variables. |
|
1398 | 1398 | |
|
1399 | 1399 | # Finally, update the real user's namespace |
|
1400 | 1400 | self.user_ns.update(ns) |
|
1401 | 1401 | |
|
1402 | 1402 | @property |
|
1403 | 1403 | def all_ns_refs(self): |
|
1404 | 1404 | """Get a list of references to all the namespace dictionaries in which |
|
1405 | 1405 | IPython might store a user-created object. |
|
1406 | 1406 | |
|
1407 | 1407 | Note that this does not include the displayhook, which also caches |
|
1408 | 1408 | objects from the output.""" |
|
1409 | 1409 | return [self.user_ns, self.user_global_ns, self.user_ns_hidden] + \ |
|
1410 | 1410 | [m.__dict__ for m in self._main_mod_cache.values()] |
|
1411 | 1411 | |
|
1412 | 1412 | def reset(self, new_session=True): |
|
1413 | 1413 | """Clear all internal namespaces, and attempt to release references to |
|
1414 | 1414 | user objects. |
|
1415 | 1415 | |
|
1416 | 1416 | If new_session is True, a new history session will be opened. |
|
1417 | 1417 | """ |
|
1418 | 1418 | # Clear histories |
|
1419 | 1419 | self.history_manager.reset(new_session) |
|
1420 | 1420 | # Reset counter used to index all histories |
|
1421 | 1421 | if new_session: |
|
1422 | 1422 | self.execution_count = 1 |
|
1423 | 1423 | |
|
1424 | 1424 | # Reset last execution result |
|
1425 | 1425 | self.last_execution_succeeded = True |
|
1426 | 1426 | self.last_execution_result = None |
|
1427 | 1427 | |
|
1428 | 1428 | # Flush cached output items |
|
1429 | 1429 | if self.displayhook.do_full_cache: |
|
1430 | 1430 | self.displayhook.flush() |
|
1431 | 1431 | |
|
1432 | 1432 | # The main execution namespaces must be cleared very carefully, |
|
1433 | 1433 | # skipping the deletion of the builtin-related keys, because doing so |
|
1434 | 1434 | # would cause errors in many object's __del__ methods. |
|
1435 | 1435 | if self.user_ns is not self.user_global_ns: |
|
1436 | 1436 | self.user_ns.clear() |
|
1437 | 1437 | ns = self.user_global_ns |
|
1438 | 1438 | drop_keys = set(ns.keys()) |
|
1439 | 1439 | drop_keys.discard('__builtin__') |
|
1440 | 1440 | drop_keys.discard('__builtins__') |
|
1441 | 1441 | drop_keys.discard('__name__') |
|
1442 | 1442 | for k in drop_keys: |
|
1443 | 1443 | del ns[k] |
|
1444 | 1444 | |
|
1445 | 1445 | self.user_ns_hidden.clear() |
|
1446 | 1446 | |
|
1447 | 1447 | # Restore the user namespaces to minimal usability |
|
1448 | 1448 | self.init_user_ns() |
|
1449 | 1449 | |
|
1450 | 1450 | # Restore the default and user aliases |
|
1451 | 1451 | self.alias_manager.clear_aliases() |
|
1452 | 1452 | self.alias_manager.init_aliases() |
|
1453 | 1453 | |
|
1454 | 1454 | # Now define aliases that only make sense on the terminal, because they |
|
1455 | 1455 | # need direct access to the console in a way that we can't emulate in |
|
1456 | 1456 | # GUI or web frontend |
|
1457 | 1457 | if os.name == 'posix': |
|
1458 | 1458 | for cmd in ('clear', 'more', 'less', 'man'): |
|
1459 | 1459 | if cmd not in self.magics_manager.magics['line']: |
|
1460 | 1460 | self.alias_manager.soft_define_alias(cmd, cmd) |
|
1461 | 1461 | |
|
1462 | 1462 | # Flush the private list of module references kept for script |
|
1463 | 1463 | # execution protection |
|
1464 | 1464 | self.clear_main_mod_cache() |
|
1465 | 1465 | |
|
1466 | 1466 | def del_var(self, varname, by_name=False): |
|
1467 | 1467 | """Delete a variable from the various namespaces, so that, as |
|
1468 | 1468 | far as possible, we're not keeping any hidden references to it. |
|
1469 | 1469 | |
|
1470 | 1470 | Parameters |
|
1471 | 1471 | ---------- |
|
1472 | 1472 | varname : str |
|
1473 | 1473 | The name of the variable to delete. |
|
1474 | 1474 | by_name : bool |
|
1475 | 1475 | If True, delete variables with the given name in each |
|
1476 | 1476 | namespace. If False (default), find the variable in the user |
|
1477 | 1477 | namespace, and delete references to it. |
|
1478 | 1478 | """ |
|
1479 | 1479 | if varname in ('__builtin__', '__builtins__'): |
|
1480 | 1480 | raise ValueError("Refusing to delete %s" % varname) |
|
1481 | 1481 | |
|
1482 | 1482 | ns_refs = self.all_ns_refs |
|
1483 | 1483 | |
|
1484 | 1484 | if by_name: # Delete by name |
|
1485 | 1485 | for ns in ns_refs: |
|
1486 | 1486 | try: |
|
1487 | 1487 | del ns[varname] |
|
1488 | 1488 | except KeyError: |
|
1489 | 1489 | pass |
|
1490 | 1490 | else: # Delete by object |
|
1491 | 1491 | try: |
|
1492 | 1492 | obj = self.user_ns[varname] |
|
1493 | except KeyError: | |
|
1494 | raise NameError("name '%s' is not defined" % varname) | |
|
1493 | except KeyError as e: | |
|
1494 | raise NameError("name '%s' is not defined" % varname) from e | |
|
1495 | 1495 | # Also check in output history |
|
1496 | 1496 | ns_refs.append(self.history_manager.output_hist) |
|
1497 | 1497 | for ns in ns_refs: |
|
1498 | 1498 | to_delete = [n for n, o in ns.items() if o is obj] |
|
1499 | 1499 | for name in to_delete: |
|
1500 | 1500 | del ns[name] |
|
1501 | 1501 | |
|
1502 | 1502 | # Ensure it is removed from the last execution result |
|
1503 | 1503 | if self.last_execution_result.result is obj: |
|
1504 | 1504 | self.last_execution_result = None |
|
1505 | 1505 | |
|
1506 | 1506 | # displayhook keeps extra references, but not in a dictionary |
|
1507 | 1507 | for name in ('_', '__', '___'): |
|
1508 | 1508 | if getattr(self.displayhook, name) is obj: |
|
1509 | 1509 | setattr(self.displayhook, name, None) |
|
1510 | 1510 | |
|
1511 | 1511 | def reset_selective(self, regex=None): |
|
1512 | 1512 | """Clear selective variables from internal namespaces based on a |
|
1513 | 1513 | specified regular expression. |
|
1514 | 1514 | |
|
1515 | 1515 | Parameters |
|
1516 | 1516 | ---------- |
|
1517 | 1517 | regex : string or compiled pattern, optional |
|
1518 | 1518 | A regular expression pattern that will be used in searching |
|
1519 | 1519 | variable names in the users namespaces. |
|
1520 | 1520 | """ |
|
1521 | 1521 | if regex is not None: |
|
1522 | 1522 | try: |
|
1523 | 1523 | m = re.compile(regex) |
|
1524 | except TypeError: | |
|
1525 | raise TypeError('regex must be a string or compiled pattern') | |
|
1524 | except TypeError as e: | |
|
1525 | raise TypeError('regex must be a string or compiled pattern') from e | |
|
1526 | 1526 | # Search for keys in each namespace that match the given regex |
|
1527 | 1527 | # If a match is found, delete the key/value pair. |
|
1528 | 1528 | for ns in self.all_ns_refs: |
|
1529 | 1529 | for var in ns: |
|
1530 | 1530 | if m.search(var): |
|
1531 | 1531 | del ns[var] |
|
1532 | 1532 | |
|
1533 | 1533 | def push(self, variables, interactive=True): |
|
1534 | 1534 | """Inject a group of variables into the IPython user namespace. |
|
1535 | 1535 | |
|
1536 | 1536 | Parameters |
|
1537 | 1537 | ---------- |
|
1538 | 1538 | variables : dict, str or list/tuple of str |
|
1539 | 1539 | The variables to inject into the user's namespace. If a dict, a |
|
1540 | 1540 | simple update is done. If a str, the string is assumed to have |
|
1541 | 1541 | variable names separated by spaces. A list/tuple of str can also |
|
1542 | 1542 | be used to give the variable names. If just the variable names are |
|
1543 | 1543 | give (list/tuple/str) then the variable values looked up in the |
|
1544 | 1544 | callers frame. |
|
1545 | 1545 | interactive : bool |
|
1546 | 1546 | If True (default), the variables will be listed with the ``who`` |
|
1547 | 1547 | magic. |
|
1548 | 1548 | """ |
|
1549 | 1549 | vdict = None |
|
1550 | 1550 | |
|
1551 | 1551 | # We need a dict of name/value pairs to do namespace updates. |
|
1552 | 1552 | if isinstance(variables, dict): |
|
1553 | 1553 | vdict = variables |
|
1554 | 1554 | elif isinstance(variables, (str, list, tuple)): |
|
1555 | 1555 | if isinstance(variables, str): |
|
1556 | 1556 | vlist = variables.split() |
|
1557 | 1557 | else: |
|
1558 | 1558 | vlist = variables |
|
1559 | 1559 | vdict = {} |
|
1560 | 1560 | cf = sys._getframe(1) |
|
1561 | 1561 | for name in vlist: |
|
1562 | 1562 | try: |
|
1563 | 1563 | vdict[name] = eval(name, cf.f_globals, cf.f_locals) |
|
1564 | 1564 | except: |
|
1565 | 1565 | print('Could not get variable %s from %s' % |
|
1566 | 1566 | (name,cf.f_code.co_name)) |
|
1567 | 1567 | else: |
|
1568 | 1568 | raise ValueError('variables must be a dict/str/list/tuple') |
|
1569 | 1569 | |
|
1570 | 1570 | # Propagate variables to user namespace |
|
1571 | 1571 | self.user_ns.update(vdict) |
|
1572 | 1572 | |
|
1573 | 1573 | # And configure interactive visibility |
|
1574 | 1574 | user_ns_hidden = self.user_ns_hidden |
|
1575 | 1575 | if interactive: |
|
1576 | 1576 | for name in vdict: |
|
1577 | 1577 | user_ns_hidden.pop(name, None) |
|
1578 | 1578 | else: |
|
1579 | 1579 | user_ns_hidden.update(vdict) |
|
1580 | 1580 | |
|
1581 | 1581 | def drop_by_id(self, variables): |
|
1582 | 1582 | """Remove a dict of variables from the user namespace, if they are the |
|
1583 | 1583 | same as the values in the dictionary. |
|
1584 | 1584 | |
|
1585 | 1585 | This is intended for use by extensions: variables that they've added can |
|
1586 | 1586 | be taken back out if they are unloaded, without removing any that the |
|
1587 | 1587 | user has overwritten. |
|
1588 | 1588 | |
|
1589 | 1589 | Parameters |
|
1590 | 1590 | ---------- |
|
1591 | 1591 | variables : dict |
|
1592 | 1592 | A dictionary mapping object names (as strings) to the objects. |
|
1593 | 1593 | """ |
|
1594 | 1594 | for name, obj in variables.items(): |
|
1595 | 1595 | if name in self.user_ns and self.user_ns[name] is obj: |
|
1596 | 1596 | del self.user_ns[name] |
|
1597 | 1597 | self.user_ns_hidden.pop(name, None) |
|
1598 | 1598 | |
|
1599 | 1599 | #------------------------------------------------------------------------- |
|
1600 | 1600 | # Things related to object introspection |
|
1601 | 1601 | #------------------------------------------------------------------------- |
|
1602 | 1602 | |
|
1603 | 1603 | def _ofind(self, oname, namespaces=None): |
|
1604 | 1604 | """Find an object in the available namespaces. |
|
1605 | 1605 | |
|
1606 | 1606 | self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic |
|
1607 | 1607 | |
|
1608 | 1608 | Has special code to detect magic functions. |
|
1609 | 1609 | """ |
|
1610 | 1610 | oname = oname.strip() |
|
1611 | 1611 | if not oname.startswith(ESC_MAGIC) and \ |
|
1612 | 1612 | not oname.startswith(ESC_MAGIC2) and \ |
|
1613 | 1613 | not all(a.isidentifier() for a in oname.split(".")): |
|
1614 | 1614 | return {'found': False} |
|
1615 | 1615 | |
|
1616 | 1616 | if namespaces is None: |
|
1617 | 1617 | # Namespaces to search in: |
|
1618 | 1618 | # Put them in a list. The order is important so that we |
|
1619 | 1619 | # find things in the same order that Python finds them. |
|
1620 | 1620 | namespaces = [ ('Interactive', self.user_ns), |
|
1621 | 1621 | ('Interactive (global)', self.user_global_ns), |
|
1622 | 1622 | ('Python builtin', builtin_mod.__dict__), |
|
1623 | 1623 | ] |
|
1624 | 1624 | |
|
1625 | 1625 | ismagic = False |
|
1626 | 1626 | isalias = False |
|
1627 | 1627 | found = False |
|
1628 | 1628 | ospace = None |
|
1629 | 1629 | parent = None |
|
1630 | 1630 | obj = None |
|
1631 | 1631 | |
|
1632 | 1632 | |
|
1633 | 1633 | # Look for the given name by splitting it in parts. If the head is |
|
1634 | 1634 | # found, then we look for all the remaining parts as members, and only |
|
1635 | 1635 | # declare success if we can find them all. |
|
1636 | 1636 | oname_parts = oname.split('.') |
|
1637 | 1637 | oname_head, oname_rest = oname_parts[0],oname_parts[1:] |
|
1638 | 1638 | for nsname,ns in namespaces: |
|
1639 | 1639 | try: |
|
1640 | 1640 | obj = ns[oname_head] |
|
1641 | 1641 | except KeyError: |
|
1642 | 1642 | continue |
|
1643 | 1643 | else: |
|
1644 | 1644 | for idx, part in enumerate(oname_rest): |
|
1645 | 1645 | try: |
|
1646 | 1646 | parent = obj |
|
1647 | 1647 | # The last part is looked up in a special way to avoid |
|
1648 | 1648 | # descriptor invocation as it may raise or have side |
|
1649 | 1649 | # effects. |
|
1650 | 1650 | if idx == len(oname_rest) - 1: |
|
1651 | 1651 | obj = self._getattr_property(obj, part) |
|
1652 | 1652 | else: |
|
1653 | 1653 | obj = getattr(obj, part) |
|
1654 | 1654 | except: |
|
1655 | 1655 | # Blanket except b/c some badly implemented objects |
|
1656 | 1656 | # allow __getattr__ to raise exceptions other than |
|
1657 | 1657 | # AttributeError, which then crashes IPython. |
|
1658 | 1658 | break |
|
1659 | 1659 | else: |
|
1660 | 1660 | # If we finish the for loop (no break), we got all members |
|
1661 | 1661 | found = True |
|
1662 | 1662 | ospace = nsname |
|
1663 | 1663 | break # namespace loop |
|
1664 | 1664 | |
|
1665 | 1665 | # Try to see if it's magic |
|
1666 | 1666 | if not found: |
|
1667 | 1667 | obj = None |
|
1668 | 1668 | if oname.startswith(ESC_MAGIC2): |
|
1669 | 1669 | oname = oname.lstrip(ESC_MAGIC2) |
|
1670 | 1670 | obj = self.find_cell_magic(oname) |
|
1671 | 1671 | elif oname.startswith(ESC_MAGIC): |
|
1672 | 1672 | oname = oname.lstrip(ESC_MAGIC) |
|
1673 | 1673 | obj = self.find_line_magic(oname) |
|
1674 | 1674 | else: |
|
1675 | 1675 | # search without prefix, so run? will find %run? |
|
1676 | 1676 | obj = self.find_line_magic(oname) |
|
1677 | 1677 | if obj is None: |
|
1678 | 1678 | obj = self.find_cell_magic(oname) |
|
1679 | 1679 | if obj is not None: |
|
1680 | 1680 | found = True |
|
1681 | 1681 | ospace = 'IPython internal' |
|
1682 | 1682 | ismagic = True |
|
1683 | 1683 | isalias = isinstance(obj, Alias) |
|
1684 | 1684 | |
|
1685 | 1685 | # Last try: special-case some literals like '', [], {}, etc: |
|
1686 | 1686 | if not found and oname_head in ["''",'""','[]','{}','()']: |
|
1687 | 1687 | obj = eval(oname_head) |
|
1688 | 1688 | found = True |
|
1689 | 1689 | ospace = 'Interactive' |
|
1690 | 1690 | |
|
1691 | 1691 | return { |
|
1692 | 1692 | 'obj':obj, |
|
1693 | 1693 | 'found':found, |
|
1694 | 1694 | 'parent':parent, |
|
1695 | 1695 | 'ismagic':ismagic, |
|
1696 | 1696 | 'isalias':isalias, |
|
1697 | 1697 | 'namespace':ospace |
|
1698 | 1698 | } |
|
1699 | 1699 | |
|
1700 | 1700 | @staticmethod |
|
1701 | 1701 | def _getattr_property(obj, attrname): |
|
1702 | 1702 | """Property-aware getattr to use in object finding. |
|
1703 | 1703 | |
|
1704 | 1704 | If attrname represents a property, return it unevaluated (in case it has |
|
1705 | 1705 | side effects or raises an error. |
|
1706 | 1706 | |
|
1707 | 1707 | """ |
|
1708 | 1708 | if not isinstance(obj, type): |
|
1709 | 1709 | try: |
|
1710 | 1710 | # `getattr(type(obj), attrname)` is not guaranteed to return |
|
1711 | 1711 | # `obj`, but does so for property: |
|
1712 | 1712 | # |
|
1713 | 1713 | # property.__get__(self, None, cls) -> self |
|
1714 | 1714 | # |
|
1715 | 1715 | # The universal alternative is to traverse the mro manually |
|
1716 | 1716 | # searching for attrname in class dicts. |
|
1717 | 1717 | attr = getattr(type(obj), attrname) |
|
1718 | 1718 | except AttributeError: |
|
1719 | 1719 | pass |
|
1720 | 1720 | else: |
|
1721 | 1721 | # This relies on the fact that data descriptors (with both |
|
1722 | 1722 | # __get__ & __set__ magic methods) take precedence over |
|
1723 | 1723 | # instance-level attributes: |
|
1724 | 1724 | # |
|
1725 | 1725 | # class A(object): |
|
1726 | 1726 | # @property |
|
1727 | 1727 | # def foobar(self): return 123 |
|
1728 | 1728 | # a = A() |
|
1729 | 1729 | # a.__dict__['foobar'] = 345 |
|
1730 | 1730 | # a.foobar # == 123 |
|
1731 | 1731 | # |
|
1732 | 1732 | # So, a property may be returned right away. |
|
1733 | 1733 | if isinstance(attr, property): |
|
1734 | 1734 | return attr |
|
1735 | 1735 | |
|
1736 | 1736 | # Nothing helped, fall back. |
|
1737 | 1737 | return getattr(obj, attrname) |
|
1738 | 1738 | |
|
1739 | 1739 | def _object_find(self, oname, namespaces=None): |
|
1740 | 1740 | """Find an object and return a struct with info about it.""" |
|
1741 | 1741 | return Struct(self._ofind(oname, namespaces)) |
|
1742 | 1742 | |
|
1743 | 1743 | def _inspect(self, meth, oname, namespaces=None, **kw): |
|
1744 | 1744 | """Generic interface to the inspector system. |
|
1745 | 1745 | |
|
1746 | 1746 | This function is meant to be called by pdef, pdoc & friends. |
|
1747 | 1747 | """ |
|
1748 | 1748 | info = self._object_find(oname, namespaces) |
|
1749 | 1749 | docformat = sphinxify if self.sphinxify_docstring else None |
|
1750 | 1750 | if info.found: |
|
1751 | 1751 | pmethod = getattr(self.inspector, meth) |
|
1752 | 1752 | # TODO: only apply format_screen to the plain/text repr of the mime |
|
1753 | 1753 | # bundle. |
|
1754 | 1754 | formatter = format_screen if info.ismagic else docformat |
|
1755 | 1755 | if meth == 'pdoc': |
|
1756 | 1756 | pmethod(info.obj, oname, formatter) |
|
1757 | 1757 | elif meth == 'pinfo': |
|
1758 | 1758 | pmethod(info.obj, oname, formatter, info, |
|
1759 | 1759 | enable_html_pager=self.enable_html_pager, **kw) |
|
1760 | 1760 | else: |
|
1761 | 1761 | pmethod(info.obj, oname) |
|
1762 | 1762 | else: |
|
1763 | 1763 | print('Object `%s` not found.' % oname) |
|
1764 | 1764 | return 'not found' # so callers can take other action |
|
1765 | 1765 | |
|
1766 | 1766 | def object_inspect(self, oname, detail_level=0): |
|
1767 | 1767 | """Get object info about oname""" |
|
1768 | 1768 | with self.builtin_trap: |
|
1769 | 1769 | info = self._object_find(oname) |
|
1770 | 1770 | if info.found: |
|
1771 | 1771 | return self.inspector.info(info.obj, oname, info=info, |
|
1772 | 1772 | detail_level=detail_level |
|
1773 | 1773 | ) |
|
1774 | 1774 | else: |
|
1775 | 1775 | return oinspect.object_info(name=oname, found=False) |
|
1776 | 1776 | |
|
1777 | 1777 | def object_inspect_text(self, oname, detail_level=0): |
|
1778 | 1778 | """Get object info as formatted text""" |
|
1779 | 1779 | return self.object_inspect_mime(oname, detail_level)['text/plain'] |
|
1780 | 1780 | |
|
1781 | 1781 | def object_inspect_mime(self, oname, detail_level=0): |
|
1782 | 1782 | """Get object info as a mimebundle of formatted representations. |
|
1783 | 1783 | |
|
1784 | 1784 | A mimebundle is a dictionary, keyed by mime-type. |
|
1785 | 1785 | It must always have the key `'text/plain'`. |
|
1786 | 1786 | """ |
|
1787 | 1787 | with self.builtin_trap: |
|
1788 | 1788 | info = self._object_find(oname) |
|
1789 | 1789 | if info.found: |
|
1790 | 1790 | return self.inspector._get_info(info.obj, oname, info=info, |
|
1791 | 1791 | detail_level=detail_level |
|
1792 | 1792 | ) |
|
1793 | 1793 | else: |
|
1794 | 1794 | raise KeyError(oname) |
|
1795 | 1795 | |
|
1796 | 1796 | #------------------------------------------------------------------------- |
|
1797 | 1797 | # Things related to history management |
|
1798 | 1798 | #------------------------------------------------------------------------- |
|
1799 | 1799 | |
|
1800 | 1800 | def init_history(self): |
|
1801 | 1801 | """Sets up the command history, and starts regular autosaves.""" |
|
1802 | 1802 | self.history_manager = HistoryManager(shell=self, parent=self) |
|
1803 | 1803 | self.configurables.append(self.history_manager) |
|
1804 | 1804 | |
|
1805 | 1805 | #------------------------------------------------------------------------- |
|
1806 | 1806 | # Things related to exception handling and tracebacks (not debugging) |
|
1807 | 1807 | #------------------------------------------------------------------------- |
|
1808 | 1808 | |
|
1809 | 1809 | debugger_cls = Pdb |
|
1810 | 1810 | |
|
1811 | 1811 | def init_traceback_handlers(self, custom_exceptions): |
|
1812 | 1812 | # Syntax error handler. |
|
1813 | 1813 | self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor', parent=self) |
|
1814 | 1814 | |
|
1815 | 1815 | # The interactive one is initialized with an offset, meaning we always |
|
1816 | 1816 | # want to remove the topmost item in the traceback, which is our own |
|
1817 | 1817 | # internal code. Valid modes: ['Plain','Context','Verbose','Minimal'] |
|
1818 | 1818 | self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain', |
|
1819 | 1819 | color_scheme='NoColor', |
|
1820 | 1820 | tb_offset = 1, |
|
1821 | 1821 | check_cache=check_linecache_ipython, |
|
1822 | 1822 | debugger_cls=self.debugger_cls, parent=self) |
|
1823 | 1823 | |
|
1824 | 1824 | # The instance will store a pointer to the system-wide exception hook, |
|
1825 | 1825 | # so that runtime code (such as magics) can access it. This is because |
|
1826 | 1826 | # during the read-eval loop, it may get temporarily overwritten. |
|
1827 | 1827 | self.sys_excepthook = sys.excepthook |
|
1828 | 1828 | |
|
1829 | 1829 | # and add any custom exception handlers the user may have specified |
|
1830 | 1830 | self.set_custom_exc(*custom_exceptions) |
|
1831 | 1831 | |
|
1832 | 1832 | # Set the exception mode |
|
1833 | 1833 | self.InteractiveTB.set_mode(mode=self.xmode) |
|
1834 | 1834 | |
|
1835 | 1835 | def set_custom_exc(self, exc_tuple, handler): |
|
1836 | 1836 | """set_custom_exc(exc_tuple, handler) |
|
1837 | 1837 | |
|
1838 | 1838 | Set a custom exception handler, which will be called if any of the |
|
1839 | 1839 | exceptions in exc_tuple occur in the mainloop (specifically, in the |
|
1840 | 1840 | run_code() method). |
|
1841 | 1841 | |
|
1842 | 1842 | Parameters |
|
1843 | 1843 | ---------- |
|
1844 | 1844 | |
|
1845 | 1845 | exc_tuple : tuple of exception classes |
|
1846 | 1846 | A *tuple* of exception classes, for which to call the defined |
|
1847 | 1847 | handler. It is very important that you use a tuple, and NOT A |
|
1848 | 1848 | LIST here, because of the way Python's except statement works. If |
|
1849 | 1849 | you only want to trap a single exception, use a singleton tuple:: |
|
1850 | 1850 | |
|
1851 | 1851 | exc_tuple == (MyCustomException,) |
|
1852 | 1852 | |
|
1853 | 1853 | handler : callable |
|
1854 | 1854 | handler must have the following signature:: |
|
1855 | 1855 | |
|
1856 | 1856 | def my_handler(self, etype, value, tb, tb_offset=None): |
|
1857 | 1857 | ... |
|
1858 | 1858 | return structured_traceback |
|
1859 | 1859 | |
|
1860 | 1860 | Your handler must return a structured traceback (a list of strings), |
|
1861 | 1861 | or None. |
|
1862 | 1862 | |
|
1863 | 1863 | This will be made into an instance method (via types.MethodType) |
|
1864 | 1864 | of IPython itself, and it will be called if any of the exceptions |
|
1865 | 1865 | listed in the exc_tuple are caught. If the handler is None, an |
|
1866 | 1866 | internal basic one is used, which just prints basic info. |
|
1867 | 1867 | |
|
1868 | 1868 | To protect IPython from crashes, if your handler ever raises an |
|
1869 | 1869 | exception or returns an invalid result, it will be immediately |
|
1870 | 1870 | disabled. |
|
1871 | 1871 | |
|
1872 | 1872 | WARNING: by putting in your own exception handler into IPython's main |
|
1873 | 1873 | execution loop, you run a very good chance of nasty crashes. This |
|
1874 | 1874 | facility should only be used if you really know what you are doing.""" |
|
1875 | 1875 | if not isinstance(exc_tuple, tuple): |
|
1876 | 1876 | raise TypeError("The custom exceptions must be given as a tuple.") |
|
1877 | 1877 | |
|
1878 | 1878 | def dummy_handler(self, etype, value, tb, tb_offset=None): |
|
1879 | 1879 | print('*** Simple custom exception handler ***') |
|
1880 | 1880 | print('Exception type :', etype) |
|
1881 | 1881 | print('Exception value:', value) |
|
1882 | 1882 | print('Traceback :', tb) |
|
1883 | 1883 | |
|
1884 | 1884 | def validate_stb(stb): |
|
1885 | 1885 | """validate structured traceback return type |
|
1886 | 1886 | |
|
1887 | 1887 | return type of CustomTB *should* be a list of strings, but allow |
|
1888 | 1888 | single strings or None, which are harmless. |
|
1889 | 1889 | |
|
1890 | 1890 | This function will *always* return a list of strings, |
|
1891 | 1891 | and will raise a TypeError if stb is inappropriate. |
|
1892 | 1892 | """ |
|
1893 | 1893 | msg = "CustomTB must return list of strings, not %r" % stb |
|
1894 | 1894 | if stb is None: |
|
1895 | 1895 | return [] |
|
1896 | 1896 | elif isinstance(stb, str): |
|
1897 | 1897 | return [stb] |
|
1898 | 1898 | elif not isinstance(stb, list): |
|
1899 | 1899 | raise TypeError(msg) |
|
1900 | 1900 | # it's a list |
|
1901 | 1901 | for line in stb: |
|
1902 | 1902 | # check every element |
|
1903 | 1903 | if not isinstance(line, str): |
|
1904 | 1904 | raise TypeError(msg) |
|
1905 | 1905 | return stb |
|
1906 | 1906 | |
|
1907 | 1907 | if handler is None: |
|
1908 | 1908 | wrapped = dummy_handler |
|
1909 | 1909 | else: |
|
1910 | 1910 | def wrapped(self,etype,value,tb,tb_offset=None): |
|
1911 | 1911 | """wrap CustomTB handler, to protect IPython from user code |
|
1912 | 1912 | |
|
1913 | 1913 | This makes it harder (but not impossible) for custom exception |
|
1914 | 1914 | handlers to crash IPython. |
|
1915 | 1915 | """ |
|
1916 | 1916 | try: |
|
1917 | 1917 | stb = handler(self,etype,value,tb,tb_offset=tb_offset) |
|
1918 | 1918 | return validate_stb(stb) |
|
1919 | 1919 | except: |
|
1920 | 1920 | # clear custom handler immediately |
|
1921 | 1921 | self.set_custom_exc((), None) |
|
1922 | 1922 | print("Custom TB Handler failed, unregistering", file=sys.stderr) |
|
1923 | 1923 | # show the exception in handler first |
|
1924 | 1924 | stb = self.InteractiveTB.structured_traceback(*sys.exc_info()) |
|
1925 | 1925 | print(self.InteractiveTB.stb2text(stb)) |
|
1926 | 1926 | print("The original exception:") |
|
1927 | 1927 | stb = self.InteractiveTB.structured_traceback( |
|
1928 | 1928 | (etype,value,tb), tb_offset=tb_offset |
|
1929 | 1929 | ) |
|
1930 | 1930 | return stb |
|
1931 | 1931 | |
|
1932 | 1932 | self.CustomTB = types.MethodType(wrapped,self) |
|
1933 | 1933 | self.custom_exceptions = exc_tuple |
|
1934 | 1934 | |
|
1935 | 1935 | def excepthook(self, etype, value, tb): |
|
1936 | 1936 | """One more defense for GUI apps that call sys.excepthook. |
|
1937 | 1937 | |
|
1938 | 1938 | GUI frameworks like wxPython trap exceptions and call |
|
1939 | 1939 | sys.excepthook themselves. I guess this is a feature that |
|
1940 | 1940 | enables them to keep running after exceptions that would |
|
1941 | 1941 | otherwise kill their mainloop. This is a bother for IPython |
|
1942 | 1942 | which excepts to catch all of the program exceptions with a try: |
|
1943 | 1943 | except: statement. |
|
1944 | 1944 | |
|
1945 | 1945 | Normally, IPython sets sys.excepthook to a CrashHandler instance, so if |
|
1946 | 1946 | any app directly invokes sys.excepthook, it will look to the user like |
|
1947 | 1947 | IPython crashed. In order to work around this, we can disable the |
|
1948 | 1948 | CrashHandler and replace it with this excepthook instead, which prints a |
|
1949 | 1949 | regular traceback using our InteractiveTB. In this fashion, apps which |
|
1950 | 1950 | call sys.excepthook will generate a regular-looking exception from |
|
1951 | 1951 | IPython, and the CrashHandler will only be triggered by real IPython |
|
1952 | 1952 | crashes. |
|
1953 | 1953 | |
|
1954 | 1954 | This hook should be used sparingly, only in places which are not likely |
|
1955 | 1955 | to be true IPython errors. |
|
1956 | 1956 | """ |
|
1957 | 1957 | self.showtraceback((etype, value, tb), tb_offset=0) |
|
1958 | 1958 | |
|
1959 | 1959 | def _get_exc_info(self, exc_tuple=None): |
|
1960 | 1960 | """get exc_info from a given tuple, sys.exc_info() or sys.last_type etc. |
|
1961 | 1961 | |
|
1962 | 1962 | Ensures sys.last_type,value,traceback hold the exc_info we found, |
|
1963 | 1963 | from whichever source. |
|
1964 | 1964 | |
|
1965 | 1965 | raises ValueError if none of these contain any information |
|
1966 | 1966 | """ |
|
1967 | 1967 | if exc_tuple is None: |
|
1968 | 1968 | etype, value, tb = sys.exc_info() |
|
1969 | 1969 | else: |
|
1970 | 1970 | etype, value, tb = exc_tuple |
|
1971 | 1971 | |
|
1972 | 1972 | if etype is None: |
|
1973 | 1973 | if hasattr(sys, 'last_type'): |
|
1974 | 1974 | etype, value, tb = sys.last_type, sys.last_value, \ |
|
1975 | 1975 | sys.last_traceback |
|
1976 | 1976 | |
|
1977 | 1977 | if etype is None: |
|
1978 | 1978 | raise ValueError("No exception to find") |
|
1979 | 1979 | |
|
1980 | 1980 | # Now store the exception info in sys.last_type etc. |
|
1981 | 1981 | # WARNING: these variables are somewhat deprecated and not |
|
1982 | 1982 | # necessarily safe to use in a threaded environment, but tools |
|
1983 | 1983 | # like pdb depend on their existence, so let's set them. If we |
|
1984 | 1984 | # find problems in the field, we'll need to revisit their use. |
|
1985 | 1985 | sys.last_type = etype |
|
1986 | 1986 | sys.last_value = value |
|
1987 | 1987 | sys.last_traceback = tb |
|
1988 | 1988 | |
|
1989 | 1989 | return etype, value, tb |
|
1990 | 1990 | |
|
1991 | 1991 | def show_usage_error(self, exc): |
|
1992 | 1992 | """Show a short message for UsageErrors |
|
1993 | 1993 | |
|
1994 | 1994 | These are special exceptions that shouldn't show a traceback. |
|
1995 | 1995 | """ |
|
1996 | 1996 | print("UsageError: %s" % exc, file=sys.stderr) |
|
1997 | 1997 | |
|
1998 | 1998 | def get_exception_only(self, exc_tuple=None): |
|
1999 | 1999 | """ |
|
2000 | 2000 | Return as a string (ending with a newline) the exception that |
|
2001 | 2001 | just occurred, without any traceback. |
|
2002 | 2002 | """ |
|
2003 | 2003 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2004 | 2004 | msg = traceback.format_exception_only(etype, value) |
|
2005 | 2005 | return ''.join(msg) |
|
2006 | 2006 | |
|
2007 | 2007 | def showtraceback(self, exc_tuple=None, filename=None, tb_offset=None, |
|
2008 | 2008 | exception_only=False, running_compiled_code=False): |
|
2009 | 2009 | """Display the exception that just occurred. |
|
2010 | 2010 | |
|
2011 | 2011 | If nothing is known about the exception, this is the method which |
|
2012 | 2012 | should be used throughout the code for presenting user tracebacks, |
|
2013 | 2013 | rather than directly invoking the InteractiveTB object. |
|
2014 | 2014 | |
|
2015 | 2015 | A specific showsyntaxerror() also exists, but this method can take |
|
2016 | 2016 | care of calling it if needed, so unless you are explicitly catching a |
|
2017 | 2017 | SyntaxError exception, don't try to analyze the stack manually and |
|
2018 | 2018 | simply call this method.""" |
|
2019 | 2019 | |
|
2020 | 2020 | try: |
|
2021 | 2021 | try: |
|
2022 | 2022 | etype, value, tb = self._get_exc_info(exc_tuple) |
|
2023 | 2023 | except ValueError: |
|
2024 | 2024 | print('No traceback available to show.', file=sys.stderr) |
|
2025 | 2025 | return |
|
2026 | 2026 | |
|
2027 | 2027 | if issubclass(etype, SyntaxError): |
|
2028 | 2028 | # Though this won't be called by syntax errors in the input |
|
2029 | 2029 | # line, there may be SyntaxError cases with imported code. |
|
2030 | 2030 | self.showsyntaxerror(filename, running_compiled_code) |
|
2031 | 2031 | elif etype is UsageError: |
|
2032 | 2032 | self.show_usage_error(value) |
|
2033 | 2033 | else: |
|
2034 | 2034 | if exception_only: |
|
2035 | 2035 | stb = ['An exception has occurred, use %tb to see ' |
|
2036 | 2036 | 'the full traceback.\n'] |
|
2037 | 2037 | stb.extend(self.InteractiveTB.get_exception_only(etype, |
|
2038 | 2038 | value)) |
|
2039 | 2039 | else: |
|
2040 | 2040 | try: |
|
2041 | 2041 | # Exception classes can customise their traceback - we |
|
2042 | 2042 | # use this in IPython.parallel for exceptions occurring |
|
2043 | 2043 | # in the engines. This should return a list of strings. |
|
2044 | 2044 | stb = value._render_traceback_() |
|
2045 | 2045 | except Exception: |
|
2046 | 2046 | stb = self.InteractiveTB.structured_traceback(etype, |
|
2047 | 2047 | value, tb, tb_offset=tb_offset) |
|
2048 | 2048 | |
|
2049 | 2049 | self._showtraceback(etype, value, stb) |
|
2050 | 2050 | if self.call_pdb: |
|
2051 | 2051 | # drop into debugger |
|
2052 | 2052 | self.debugger(force=True) |
|
2053 | 2053 | return |
|
2054 | 2054 | |
|
2055 | 2055 | # Actually show the traceback |
|
2056 | 2056 | self._showtraceback(etype, value, stb) |
|
2057 | 2057 | |
|
2058 | 2058 | except KeyboardInterrupt: |
|
2059 | 2059 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2060 | 2060 | |
|
2061 | 2061 | def _showtraceback(self, etype, evalue, stb): |
|
2062 | 2062 | """Actually show a traceback. |
|
2063 | 2063 | |
|
2064 | 2064 | Subclasses may override this method to put the traceback on a different |
|
2065 | 2065 | place, like a side channel. |
|
2066 | 2066 | """ |
|
2067 | 2067 | print(self.InteractiveTB.stb2text(stb)) |
|
2068 | 2068 | |
|
2069 | 2069 | def showsyntaxerror(self, filename=None, running_compiled_code=False): |
|
2070 | 2070 | """Display the syntax error that just occurred. |
|
2071 | 2071 | |
|
2072 | 2072 | This doesn't display a stack trace because there isn't one. |
|
2073 | 2073 | |
|
2074 | 2074 | If a filename is given, it is stuffed in the exception instead |
|
2075 | 2075 | of what was there before (because Python's parser always uses |
|
2076 | 2076 | "<string>" when reading from a string). |
|
2077 | 2077 | |
|
2078 | 2078 | If the syntax error occurred when running a compiled code (i.e. running_compile_code=True), |
|
2079 | 2079 | longer stack trace will be displayed. |
|
2080 | 2080 | """ |
|
2081 | 2081 | etype, value, last_traceback = self._get_exc_info() |
|
2082 | 2082 | |
|
2083 | 2083 | if filename and issubclass(etype, SyntaxError): |
|
2084 | 2084 | try: |
|
2085 | 2085 | value.filename = filename |
|
2086 | 2086 | except: |
|
2087 | 2087 | # Not the format we expect; leave it alone |
|
2088 | 2088 | pass |
|
2089 | 2089 | |
|
2090 | 2090 | # If the error occurred when executing compiled code, we should provide full stacktrace. |
|
2091 | 2091 | elist = traceback.extract_tb(last_traceback) if running_compiled_code else [] |
|
2092 | 2092 | stb = self.SyntaxTB.structured_traceback(etype, value, elist) |
|
2093 | 2093 | self._showtraceback(etype, value, stb) |
|
2094 | 2094 | |
|
2095 | 2095 | # This is overridden in TerminalInteractiveShell to show a message about |
|
2096 | 2096 | # the %paste magic. |
|
2097 | 2097 | def showindentationerror(self): |
|
2098 | 2098 | """Called by _run_cell when there's an IndentationError in code entered |
|
2099 | 2099 | at the prompt. |
|
2100 | 2100 | |
|
2101 | 2101 | This is overridden in TerminalInteractiveShell to show a message about |
|
2102 | 2102 | the %paste magic.""" |
|
2103 | 2103 | self.showsyntaxerror() |
|
2104 | 2104 | |
|
2105 | 2105 | #------------------------------------------------------------------------- |
|
2106 | 2106 | # Things related to readline |
|
2107 | 2107 | #------------------------------------------------------------------------- |
|
2108 | 2108 | |
|
2109 | 2109 | def init_readline(self): |
|
2110 | 2110 | """DEPRECATED |
|
2111 | 2111 | |
|
2112 | 2112 | Moved to terminal subclass, here only to simplify the init logic.""" |
|
2113 | 2113 | # Set a number of methods that depend on readline to be no-op |
|
2114 | 2114 | warnings.warn('`init_readline` is no-op since IPython 5.0 and is Deprecated', |
|
2115 | 2115 | DeprecationWarning, stacklevel=2) |
|
2116 | 2116 | self.set_custom_completer = no_op |
|
2117 | 2117 | |
|
2118 | 2118 | @skip_doctest |
|
2119 | 2119 | def set_next_input(self, s, replace=False): |
|
2120 | 2120 | """ Sets the 'default' input string for the next command line. |
|
2121 | 2121 | |
|
2122 | 2122 | Example:: |
|
2123 | 2123 | |
|
2124 | 2124 | In [1]: _ip.set_next_input("Hello Word") |
|
2125 | 2125 | In [2]: Hello Word_ # cursor is here |
|
2126 | 2126 | """ |
|
2127 | 2127 | self.rl_next_input = s |
|
2128 | 2128 | |
|
2129 | 2129 | def _indent_current_str(self): |
|
2130 | 2130 | """return the current level of indentation as a string""" |
|
2131 | 2131 | return self.input_splitter.get_indent_spaces() * ' ' |
|
2132 | 2132 | |
|
2133 | 2133 | #------------------------------------------------------------------------- |
|
2134 | 2134 | # Things related to text completion |
|
2135 | 2135 | #------------------------------------------------------------------------- |
|
2136 | 2136 | |
|
2137 | 2137 | def init_completer(self): |
|
2138 | 2138 | """Initialize the completion machinery. |
|
2139 | 2139 | |
|
2140 | 2140 | This creates completion machinery that can be used by client code, |
|
2141 | 2141 | either interactively in-process (typically triggered by the readline |
|
2142 | 2142 | library), programmatically (such as in test suites) or out-of-process |
|
2143 | 2143 | (typically over the network by remote frontends). |
|
2144 | 2144 | """ |
|
2145 | 2145 | from IPython.core.completer import IPCompleter |
|
2146 | 2146 | from IPython.core.completerlib import (module_completer, |
|
2147 | 2147 | magic_run_completer, cd_completer, reset_completer) |
|
2148 | 2148 | |
|
2149 | 2149 | self.Completer = IPCompleter(shell=self, |
|
2150 | 2150 | namespace=self.user_ns, |
|
2151 | 2151 | global_namespace=self.user_global_ns, |
|
2152 | 2152 | parent=self, |
|
2153 | 2153 | ) |
|
2154 | 2154 | self.configurables.append(self.Completer) |
|
2155 | 2155 | |
|
2156 | 2156 | # Add custom completers to the basic ones built into IPCompleter |
|
2157 | 2157 | sdisp = self.strdispatchers.get('complete_command', StrDispatch()) |
|
2158 | 2158 | self.strdispatchers['complete_command'] = sdisp |
|
2159 | 2159 | self.Completer.custom_completers = sdisp |
|
2160 | 2160 | |
|
2161 | 2161 | self.set_hook('complete_command', module_completer, str_key = 'import') |
|
2162 | 2162 | self.set_hook('complete_command', module_completer, str_key = 'from') |
|
2163 | 2163 | self.set_hook('complete_command', module_completer, str_key = '%aimport') |
|
2164 | 2164 | self.set_hook('complete_command', magic_run_completer, str_key = '%run') |
|
2165 | 2165 | self.set_hook('complete_command', cd_completer, str_key = '%cd') |
|
2166 | 2166 | self.set_hook('complete_command', reset_completer, str_key = '%reset') |
|
2167 | 2167 | |
|
2168 | 2168 | @skip_doctest |
|
2169 | 2169 | def complete(self, text, line=None, cursor_pos=None): |
|
2170 | 2170 | """Return the completed text and a list of completions. |
|
2171 | 2171 | |
|
2172 | 2172 | Parameters |
|
2173 | 2173 | ---------- |
|
2174 | 2174 | |
|
2175 | 2175 | text : string |
|
2176 | 2176 | A string of text to be completed on. It can be given as empty and |
|
2177 | 2177 | instead a line/position pair are given. In this case, the |
|
2178 | 2178 | completer itself will split the line like readline does. |
|
2179 | 2179 | |
|
2180 | 2180 | line : string, optional |
|
2181 | 2181 | The complete line that text is part of. |
|
2182 | 2182 | |
|
2183 | 2183 | cursor_pos : int, optional |
|
2184 | 2184 | The position of the cursor on the input line. |
|
2185 | 2185 | |
|
2186 | 2186 | Returns |
|
2187 | 2187 | ------- |
|
2188 | 2188 | text : string |
|
2189 | 2189 | The actual text that was completed. |
|
2190 | 2190 | |
|
2191 | 2191 | matches : list |
|
2192 | 2192 | A sorted list with all possible completions. |
|
2193 | 2193 | |
|
2194 | 2194 | The optional arguments allow the completion to take more context into |
|
2195 | 2195 | account, and are part of the low-level completion API. |
|
2196 | 2196 | |
|
2197 | 2197 | This is a wrapper around the completion mechanism, similar to what |
|
2198 | 2198 | readline does at the command line when the TAB key is hit. By |
|
2199 | 2199 | exposing it as a method, it can be used by other non-readline |
|
2200 | 2200 | environments (such as GUIs) for text completion. |
|
2201 | 2201 | |
|
2202 | 2202 | Simple usage example: |
|
2203 | 2203 | |
|
2204 | 2204 | In [1]: x = 'hello' |
|
2205 | 2205 | |
|
2206 | 2206 | In [2]: _ip.complete('x.l') |
|
2207 | 2207 | Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip']) |
|
2208 | 2208 | """ |
|
2209 | 2209 | |
|
2210 | 2210 | # Inject names into __builtin__ so we can complete on the added names. |
|
2211 | 2211 | with self.builtin_trap: |
|
2212 | 2212 | return self.Completer.complete(text, line, cursor_pos) |
|
2213 | 2213 | |
|
2214 | 2214 | def set_custom_completer(self, completer, pos=0): |
|
2215 | 2215 | """Adds a new custom completer function. |
|
2216 | 2216 | |
|
2217 | 2217 | The position argument (defaults to 0) is the index in the completers |
|
2218 | 2218 | list where you want the completer to be inserted.""" |
|
2219 | 2219 | |
|
2220 | 2220 | newcomp = types.MethodType(completer, self.Completer) |
|
2221 | 2221 | self.Completer.custom_matchers.insert(pos,newcomp) |
|
2222 | 2222 | |
|
2223 | 2223 | def set_completer_frame(self, frame=None): |
|
2224 | 2224 | """Set the frame of the completer.""" |
|
2225 | 2225 | if frame: |
|
2226 | 2226 | self.Completer.namespace = frame.f_locals |
|
2227 | 2227 | self.Completer.global_namespace = frame.f_globals |
|
2228 | 2228 | else: |
|
2229 | 2229 | self.Completer.namespace = self.user_ns |
|
2230 | 2230 | self.Completer.global_namespace = self.user_global_ns |
|
2231 | 2231 | |
|
2232 | 2232 | #------------------------------------------------------------------------- |
|
2233 | 2233 | # Things related to magics |
|
2234 | 2234 | #------------------------------------------------------------------------- |
|
2235 | 2235 | |
|
2236 | 2236 | def init_magics(self): |
|
2237 | 2237 | from IPython.core import magics as m |
|
2238 | 2238 | self.magics_manager = magic.MagicsManager(shell=self, |
|
2239 | 2239 | parent=self, |
|
2240 | 2240 | user_magics=m.UserMagics(self)) |
|
2241 | 2241 | self.configurables.append(self.magics_manager) |
|
2242 | 2242 | |
|
2243 | 2243 | # Expose as public API from the magics manager |
|
2244 | 2244 | self.register_magics = self.magics_manager.register |
|
2245 | 2245 | |
|
2246 | 2246 | self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics, |
|
2247 | 2247 | m.ConfigMagics, m.DisplayMagics, m.ExecutionMagics, |
|
2248 | 2248 | m.ExtensionMagics, m.HistoryMagics, m.LoggingMagics, |
|
2249 | 2249 | m.NamespaceMagics, m.OSMagics, m.PackagingMagics, |
|
2250 | 2250 | m.PylabMagics, m.ScriptMagics, |
|
2251 | 2251 | ) |
|
2252 | 2252 | self.register_magics(m.AsyncMagics) |
|
2253 | 2253 | |
|
2254 | 2254 | # Register Magic Aliases |
|
2255 | 2255 | mman = self.magics_manager |
|
2256 | 2256 | # FIXME: magic aliases should be defined by the Magics classes |
|
2257 | 2257 | # or in MagicsManager, not here |
|
2258 | 2258 | mman.register_alias('ed', 'edit') |
|
2259 | 2259 | mman.register_alias('hist', 'history') |
|
2260 | 2260 | mman.register_alias('rep', 'recall') |
|
2261 | 2261 | mman.register_alias('SVG', 'svg', 'cell') |
|
2262 | 2262 | mman.register_alias('HTML', 'html', 'cell') |
|
2263 | 2263 | mman.register_alias('file', 'writefile', 'cell') |
|
2264 | 2264 | |
|
2265 | 2265 | # FIXME: Move the color initialization to the DisplayHook, which |
|
2266 | 2266 | # should be split into a prompt manager and displayhook. We probably |
|
2267 | 2267 | # even need a centralize colors management object. |
|
2268 | 2268 | self.run_line_magic('colors', self.colors) |
|
2269 | 2269 | |
|
2270 | 2270 | # Defined here so that it's included in the documentation |
|
2271 | 2271 | @functools.wraps(magic.MagicsManager.register_function) |
|
2272 | 2272 | def register_magic_function(self, func, magic_kind='line', magic_name=None): |
|
2273 | 2273 | self.magics_manager.register_function(func, |
|
2274 | 2274 | magic_kind=magic_kind, magic_name=magic_name) |
|
2275 | 2275 | |
|
2276 | 2276 | def run_line_magic(self, magic_name, line, _stack_depth=1): |
|
2277 | 2277 | """Execute the given line magic. |
|
2278 | 2278 | |
|
2279 | 2279 | Parameters |
|
2280 | 2280 | ---------- |
|
2281 | 2281 | magic_name : str |
|
2282 | 2282 | Name of the desired magic function, without '%' prefix. |
|
2283 | 2283 | |
|
2284 | 2284 | line : str |
|
2285 | 2285 | The rest of the input line as a single string. |
|
2286 | 2286 | |
|
2287 | 2287 | _stack_depth : int |
|
2288 | 2288 | If run_line_magic() is called from magic() then _stack_depth=2. |
|
2289 | 2289 | This is added to ensure backward compatibility for use of 'get_ipython().magic()' |
|
2290 | 2290 | """ |
|
2291 | 2291 | fn = self.find_line_magic(magic_name) |
|
2292 | 2292 | if fn is None: |
|
2293 | 2293 | cm = self.find_cell_magic(magic_name) |
|
2294 | 2294 | etpl = "Line magic function `%%%s` not found%s." |
|
2295 | 2295 | extra = '' if cm is None else (' (But cell magic `%%%%%s` exists, ' |
|
2296 | 2296 | 'did you mean that instead?)' % magic_name ) |
|
2297 | 2297 | raise UsageError(etpl % (magic_name, extra)) |
|
2298 | 2298 | else: |
|
2299 | 2299 | # Note: this is the distance in the stack to the user's frame. |
|
2300 | 2300 | # This will need to be updated if the internal calling logic gets |
|
2301 | 2301 | # refactored, or else we'll be expanding the wrong variables. |
|
2302 | 2302 | |
|
2303 | 2303 | # Determine stack_depth depending on where run_line_magic() has been called |
|
2304 | 2304 | stack_depth = _stack_depth |
|
2305 | 2305 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2306 | 2306 | # magic has opted out of var_expand |
|
2307 | 2307 | magic_arg_s = line |
|
2308 | 2308 | else: |
|
2309 | 2309 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2310 | 2310 | # Put magic args in a list so we can call with f(*a) syntax |
|
2311 | 2311 | args = [magic_arg_s] |
|
2312 | 2312 | kwargs = {} |
|
2313 | 2313 | # Grab local namespace if we need it: |
|
2314 | 2314 | if getattr(fn, "needs_local_scope", False): |
|
2315 | 2315 | kwargs['local_ns'] = sys._getframe(stack_depth).f_locals |
|
2316 | 2316 | with self.builtin_trap: |
|
2317 | 2317 | result = fn(*args, **kwargs) |
|
2318 | 2318 | return result |
|
2319 | 2319 | |
|
2320 | 2320 | def run_cell_magic(self, magic_name, line, cell): |
|
2321 | 2321 | """Execute the given cell magic. |
|
2322 | 2322 | |
|
2323 | 2323 | Parameters |
|
2324 | 2324 | ---------- |
|
2325 | 2325 | magic_name : str |
|
2326 | 2326 | Name of the desired magic function, without '%' prefix. |
|
2327 | 2327 | |
|
2328 | 2328 | line : str |
|
2329 | 2329 | The rest of the first input line as a single string. |
|
2330 | 2330 | |
|
2331 | 2331 | cell : str |
|
2332 | 2332 | The body of the cell as a (possibly multiline) string. |
|
2333 | 2333 | """ |
|
2334 | 2334 | fn = self.find_cell_magic(magic_name) |
|
2335 | 2335 | if fn is None: |
|
2336 | 2336 | lm = self.find_line_magic(magic_name) |
|
2337 | 2337 | etpl = "Cell magic `%%{0}` not found{1}." |
|
2338 | 2338 | extra = '' if lm is None else (' (But line magic `%{0}` exists, ' |
|
2339 | 2339 | 'did you mean that instead?)'.format(magic_name)) |
|
2340 | 2340 | raise UsageError(etpl.format(magic_name, extra)) |
|
2341 | 2341 | elif cell == '': |
|
2342 | 2342 | message = '%%{0} is a cell magic, but the cell body is empty.'.format(magic_name) |
|
2343 | 2343 | if self.find_line_magic(magic_name) is not None: |
|
2344 | 2344 | message += ' Did you mean the line magic %{0} (single %)?'.format(magic_name) |
|
2345 | 2345 | raise UsageError(message) |
|
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 | stack_depth = 2 |
|
2351 | 2351 | if getattr(fn, magic.MAGIC_NO_VAR_EXPAND_ATTR, False): |
|
2352 | 2352 | # magic has opted out of var_expand |
|
2353 | 2353 | magic_arg_s = line |
|
2354 | 2354 | else: |
|
2355 | 2355 | magic_arg_s = self.var_expand(line, stack_depth) |
|
2356 | 2356 | kwargs = {} |
|
2357 | 2357 | if getattr(fn, "needs_local_scope", False): |
|
2358 | 2358 | kwargs['local_ns'] = self.user_ns |
|
2359 | 2359 | |
|
2360 | 2360 | with self.builtin_trap: |
|
2361 | 2361 | args = (magic_arg_s, cell) |
|
2362 | 2362 | result = fn(*args, **kwargs) |
|
2363 | 2363 | return result |
|
2364 | 2364 | |
|
2365 | 2365 | def find_line_magic(self, magic_name): |
|
2366 | 2366 | """Find and return a line magic by name. |
|
2367 | 2367 | |
|
2368 | 2368 | Returns None if the magic isn't found.""" |
|
2369 | 2369 | return self.magics_manager.magics['line'].get(magic_name) |
|
2370 | 2370 | |
|
2371 | 2371 | def find_cell_magic(self, magic_name): |
|
2372 | 2372 | """Find and return a cell magic by name. |
|
2373 | 2373 | |
|
2374 | 2374 | Returns None if the magic isn't found.""" |
|
2375 | 2375 | return self.magics_manager.magics['cell'].get(magic_name) |
|
2376 | 2376 | |
|
2377 | 2377 | def find_magic(self, magic_name, magic_kind='line'): |
|
2378 | 2378 | """Find and return a magic of the given type by name. |
|
2379 | 2379 | |
|
2380 | 2380 | Returns None if the magic isn't found.""" |
|
2381 | 2381 | return self.magics_manager.magics[magic_kind].get(magic_name) |
|
2382 | 2382 | |
|
2383 | 2383 | def magic(self, arg_s): |
|
2384 | 2384 | """DEPRECATED. Use run_line_magic() instead. |
|
2385 | 2385 | |
|
2386 | 2386 | Call a magic function by name. |
|
2387 | 2387 | |
|
2388 | 2388 | Input: a string containing the name of the magic function to call and |
|
2389 | 2389 | any additional arguments to be passed to the magic. |
|
2390 | 2390 | |
|
2391 | 2391 | magic('name -opt foo bar') is equivalent to typing at the ipython |
|
2392 | 2392 | prompt: |
|
2393 | 2393 | |
|
2394 | 2394 | In[1]: %name -opt foo bar |
|
2395 | 2395 | |
|
2396 | 2396 | To call a magic without arguments, simply use magic('name'). |
|
2397 | 2397 | |
|
2398 | 2398 | This provides a proper Python function to call IPython's magics in any |
|
2399 | 2399 | valid Python code you can type at the interpreter, including loops and |
|
2400 | 2400 | compound statements. |
|
2401 | 2401 | """ |
|
2402 | 2402 | # TODO: should we issue a loud deprecation warning here? |
|
2403 | 2403 | magic_name, _, magic_arg_s = arg_s.partition(' ') |
|
2404 | 2404 | magic_name = magic_name.lstrip(prefilter.ESC_MAGIC) |
|
2405 | 2405 | return self.run_line_magic(magic_name, magic_arg_s, _stack_depth=2) |
|
2406 | 2406 | |
|
2407 | 2407 | #------------------------------------------------------------------------- |
|
2408 | 2408 | # Things related to macros |
|
2409 | 2409 | #------------------------------------------------------------------------- |
|
2410 | 2410 | |
|
2411 | 2411 | def define_macro(self, name, themacro): |
|
2412 | 2412 | """Define a new macro |
|
2413 | 2413 | |
|
2414 | 2414 | Parameters |
|
2415 | 2415 | ---------- |
|
2416 | 2416 | name : str |
|
2417 | 2417 | The name of the macro. |
|
2418 | 2418 | themacro : str or Macro |
|
2419 | 2419 | The action to do upon invoking the macro. If a string, a new |
|
2420 | 2420 | Macro object is created by passing the string to it. |
|
2421 | 2421 | """ |
|
2422 | 2422 | |
|
2423 | 2423 | from IPython.core import macro |
|
2424 | 2424 | |
|
2425 | 2425 | if isinstance(themacro, str): |
|
2426 | 2426 | themacro = macro.Macro(themacro) |
|
2427 | 2427 | if not isinstance(themacro, macro.Macro): |
|
2428 | 2428 | raise ValueError('A macro must be a string or a Macro instance.') |
|
2429 | 2429 | self.user_ns[name] = themacro |
|
2430 | 2430 | |
|
2431 | 2431 | #------------------------------------------------------------------------- |
|
2432 | 2432 | # Things related to the running of system commands |
|
2433 | 2433 | #------------------------------------------------------------------------- |
|
2434 | 2434 | |
|
2435 | 2435 | def system_piped(self, cmd): |
|
2436 | 2436 | """Call the given cmd in a subprocess, piping stdout/err |
|
2437 | 2437 | |
|
2438 | 2438 | Parameters |
|
2439 | 2439 | ---------- |
|
2440 | 2440 | cmd : str |
|
2441 | 2441 | Command to execute (can not end in '&', as background processes are |
|
2442 | 2442 | not supported. Should not be a command that expects input |
|
2443 | 2443 | other than simple text. |
|
2444 | 2444 | """ |
|
2445 | 2445 | if cmd.rstrip().endswith('&'): |
|
2446 | 2446 | # this is *far* from a rigorous test |
|
2447 | 2447 | # We do not support backgrounding processes because we either use |
|
2448 | 2448 | # pexpect or pipes to read from. Users can always just call |
|
2449 | 2449 | # os.system() or use ip.system=ip.system_raw |
|
2450 | 2450 | # if they really want a background process. |
|
2451 | 2451 | raise OSError("Background processes not supported.") |
|
2452 | 2452 | |
|
2453 | 2453 | # we explicitly do NOT return the subprocess status code, because |
|
2454 | 2454 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2455 | 2455 | # Instead, we store the exit_code in user_ns. |
|
2456 | 2456 | self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=1)) |
|
2457 | 2457 | |
|
2458 | 2458 | def system_raw(self, cmd): |
|
2459 | 2459 | """Call the given cmd in a subprocess using os.system on Windows or |
|
2460 | 2460 | subprocess.call using the system shell on other platforms. |
|
2461 | 2461 | |
|
2462 | 2462 | Parameters |
|
2463 | 2463 | ---------- |
|
2464 | 2464 | cmd : str |
|
2465 | 2465 | Command to execute. |
|
2466 | 2466 | """ |
|
2467 | 2467 | cmd = self.var_expand(cmd, depth=1) |
|
2468 | 2468 | # protect os.system from UNC paths on Windows, which it can't handle: |
|
2469 | 2469 | if sys.platform == 'win32': |
|
2470 | 2470 | from IPython.utils._process_win32 import AvoidUNCPath |
|
2471 | 2471 | with AvoidUNCPath() as path: |
|
2472 | 2472 | if path is not None: |
|
2473 | 2473 | cmd = '"pushd %s &&"%s' % (path, cmd) |
|
2474 | 2474 | try: |
|
2475 | 2475 | ec = os.system(cmd) |
|
2476 | 2476 | except KeyboardInterrupt: |
|
2477 | 2477 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2478 | 2478 | ec = -2 |
|
2479 | 2479 | else: |
|
2480 | 2480 | # For posix the result of the subprocess.call() below is an exit |
|
2481 | 2481 | # code, which by convention is zero for success, positive for |
|
2482 | 2482 | # program failure. Exit codes above 128 are reserved for signals, |
|
2483 | 2483 | # and the formula for converting a signal to an exit code is usually |
|
2484 | 2484 | # signal_number+128. To more easily differentiate between exit |
|
2485 | 2485 | # codes and signals, ipython uses negative numbers. For instance |
|
2486 | 2486 | # since control-c is signal 2 but exit code 130, ipython's |
|
2487 | 2487 | # _exit_code variable will read -2. Note that some shells like |
|
2488 | 2488 | # csh and fish don't follow sh/bash conventions for exit codes. |
|
2489 | 2489 | executable = os.environ.get('SHELL', None) |
|
2490 | 2490 | try: |
|
2491 | 2491 | # Use env shell instead of default /bin/sh |
|
2492 | 2492 | ec = subprocess.call(cmd, shell=True, executable=executable) |
|
2493 | 2493 | except KeyboardInterrupt: |
|
2494 | 2494 | # intercept control-C; a long traceback is not useful here |
|
2495 | 2495 | print('\n' + self.get_exception_only(), file=sys.stderr) |
|
2496 | 2496 | ec = 130 |
|
2497 | 2497 | if ec > 128: |
|
2498 | 2498 | ec = -(ec - 128) |
|
2499 | 2499 | |
|
2500 | 2500 | # We explicitly do NOT return the subprocess status code, because |
|
2501 | 2501 | # a non-None value would trigger :func:`sys.displayhook` calls. |
|
2502 | 2502 | # Instead, we store the exit_code in user_ns. Note the semantics |
|
2503 | 2503 | # of _exit_code: for control-c, _exit_code == -signal.SIGNIT, |
|
2504 | 2504 | # but raising SystemExit(_exit_code) will give status 254! |
|
2505 | 2505 | self.user_ns['_exit_code'] = ec |
|
2506 | 2506 | |
|
2507 | 2507 | # use piped system by default, because it is better behaved |
|
2508 | 2508 | system = system_piped |
|
2509 | 2509 | |
|
2510 | 2510 | def getoutput(self, cmd, split=True, depth=0): |
|
2511 | 2511 | """Get output (possibly including stderr) from a subprocess. |
|
2512 | 2512 | |
|
2513 | 2513 | Parameters |
|
2514 | 2514 | ---------- |
|
2515 | 2515 | cmd : str |
|
2516 | 2516 | Command to execute (can not end in '&', as background processes are |
|
2517 | 2517 | not supported. |
|
2518 | 2518 | split : bool, optional |
|
2519 | 2519 | If True, split the output into an IPython SList. Otherwise, an |
|
2520 | 2520 | IPython LSString is returned. These are objects similar to normal |
|
2521 | 2521 | lists and strings, with a few convenience attributes for easier |
|
2522 | 2522 | manipulation of line-based output. You can use '?' on them for |
|
2523 | 2523 | details. |
|
2524 | 2524 | depth : int, optional |
|
2525 | 2525 | How many frames above the caller are the local variables which should |
|
2526 | 2526 | be expanded in the command string? The default (0) assumes that the |
|
2527 | 2527 | expansion variables are in the stack frame calling this function. |
|
2528 | 2528 | """ |
|
2529 | 2529 | if cmd.rstrip().endswith('&'): |
|
2530 | 2530 | # this is *far* from a rigorous test |
|
2531 | 2531 | raise OSError("Background processes not supported.") |
|
2532 | 2532 | out = getoutput(self.var_expand(cmd, depth=depth+1)) |
|
2533 | 2533 | if split: |
|
2534 | 2534 | out = SList(out.splitlines()) |
|
2535 | 2535 | else: |
|
2536 | 2536 | out = LSString(out) |
|
2537 | 2537 | return out |
|
2538 | 2538 | |
|
2539 | 2539 | #------------------------------------------------------------------------- |
|
2540 | 2540 | # Things related to aliases |
|
2541 | 2541 | #------------------------------------------------------------------------- |
|
2542 | 2542 | |
|
2543 | 2543 | def init_alias(self): |
|
2544 | 2544 | self.alias_manager = AliasManager(shell=self, parent=self) |
|
2545 | 2545 | self.configurables.append(self.alias_manager) |
|
2546 | 2546 | |
|
2547 | 2547 | #------------------------------------------------------------------------- |
|
2548 | 2548 | # Things related to extensions |
|
2549 | 2549 | #------------------------------------------------------------------------- |
|
2550 | 2550 | |
|
2551 | 2551 | def init_extension_manager(self): |
|
2552 | 2552 | self.extension_manager = ExtensionManager(shell=self, parent=self) |
|
2553 | 2553 | self.configurables.append(self.extension_manager) |
|
2554 | 2554 | |
|
2555 | 2555 | #------------------------------------------------------------------------- |
|
2556 | 2556 | # Things related to payloads |
|
2557 | 2557 | #------------------------------------------------------------------------- |
|
2558 | 2558 | |
|
2559 | 2559 | def init_payload(self): |
|
2560 | 2560 | self.payload_manager = PayloadManager(parent=self) |
|
2561 | 2561 | self.configurables.append(self.payload_manager) |
|
2562 | 2562 | |
|
2563 | 2563 | #------------------------------------------------------------------------- |
|
2564 | 2564 | # Things related to the prefilter |
|
2565 | 2565 | #------------------------------------------------------------------------- |
|
2566 | 2566 | |
|
2567 | 2567 | def init_prefilter(self): |
|
2568 | 2568 | self.prefilter_manager = PrefilterManager(shell=self, parent=self) |
|
2569 | 2569 | self.configurables.append(self.prefilter_manager) |
|
2570 | 2570 | # Ultimately this will be refactored in the new interpreter code, but |
|
2571 | 2571 | # for now, we should expose the main prefilter method (there's legacy |
|
2572 | 2572 | # code out there that may rely on this). |
|
2573 | 2573 | self.prefilter = self.prefilter_manager.prefilter_lines |
|
2574 | 2574 | |
|
2575 | 2575 | def auto_rewrite_input(self, cmd): |
|
2576 | 2576 | """Print to the screen the rewritten form of the user's command. |
|
2577 | 2577 | |
|
2578 | 2578 | This shows visual feedback by rewriting input lines that cause |
|
2579 | 2579 | automatic calling to kick in, like:: |
|
2580 | 2580 | |
|
2581 | 2581 | /f x |
|
2582 | 2582 | |
|
2583 | 2583 | into:: |
|
2584 | 2584 | |
|
2585 | 2585 | ------> f(x) |
|
2586 | 2586 | |
|
2587 | 2587 | after the user's input prompt. This helps the user understand that the |
|
2588 | 2588 | input line was transformed automatically by IPython. |
|
2589 | 2589 | """ |
|
2590 | 2590 | if not self.show_rewritten_input: |
|
2591 | 2591 | return |
|
2592 | 2592 | |
|
2593 | 2593 | # This is overridden in TerminalInteractiveShell to use fancy prompts |
|
2594 | 2594 | print("------> " + cmd) |
|
2595 | 2595 | |
|
2596 | 2596 | #------------------------------------------------------------------------- |
|
2597 | 2597 | # Things related to extracting values/expressions from kernel and user_ns |
|
2598 | 2598 | #------------------------------------------------------------------------- |
|
2599 | 2599 | |
|
2600 | 2600 | def _user_obj_error(self): |
|
2601 | 2601 | """return simple exception dict |
|
2602 | 2602 | |
|
2603 | 2603 | for use in user_expressions |
|
2604 | 2604 | """ |
|
2605 | 2605 | |
|
2606 | 2606 | etype, evalue, tb = self._get_exc_info() |
|
2607 | 2607 | stb = self.InteractiveTB.get_exception_only(etype, evalue) |
|
2608 | 2608 | |
|
2609 | 2609 | exc_info = { |
|
2610 | 2610 | u'status' : 'error', |
|
2611 | 2611 | u'traceback' : stb, |
|
2612 | 2612 | u'ename' : etype.__name__, |
|
2613 | 2613 | u'evalue' : py3compat.safe_unicode(evalue), |
|
2614 | 2614 | } |
|
2615 | 2615 | |
|
2616 | 2616 | return exc_info |
|
2617 | 2617 | |
|
2618 | 2618 | def _format_user_obj(self, obj): |
|
2619 | 2619 | """format a user object to display dict |
|
2620 | 2620 | |
|
2621 | 2621 | for use in user_expressions |
|
2622 | 2622 | """ |
|
2623 | 2623 | |
|
2624 | 2624 | data, md = self.display_formatter.format(obj) |
|
2625 | 2625 | value = { |
|
2626 | 2626 | 'status' : 'ok', |
|
2627 | 2627 | 'data' : data, |
|
2628 | 2628 | 'metadata' : md, |
|
2629 | 2629 | } |
|
2630 | 2630 | return value |
|
2631 | 2631 | |
|
2632 | 2632 | def user_expressions(self, expressions): |
|
2633 | 2633 | """Evaluate a dict of expressions in the user's namespace. |
|
2634 | 2634 | |
|
2635 | 2635 | Parameters |
|
2636 | 2636 | ---------- |
|
2637 | 2637 | expressions : dict |
|
2638 | 2638 | A dict with string keys and string values. The expression values |
|
2639 | 2639 | should be valid Python expressions, each of which will be evaluated |
|
2640 | 2640 | in the user namespace. |
|
2641 | 2641 | |
|
2642 | 2642 | Returns |
|
2643 | 2643 | ------- |
|
2644 | 2644 | A dict, keyed like the input expressions dict, with the rich mime-typed |
|
2645 | 2645 | display_data of each value. |
|
2646 | 2646 | """ |
|
2647 | 2647 | out = {} |
|
2648 | 2648 | user_ns = self.user_ns |
|
2649 | 2649 | global_ns = self.user_global_ns |
|
2650 | 2650 | |
|
2651 | 2651 | for key, expr in expressions.items(): |
|
2652 | 2652 | try: |
|
2653 | 2653 | value = self._format_user_obj(eval(expr, global_ns, user_ns)) |
|
2654 | 2654 | except: |
|
2655 | 2655 | value = self._user_obj_error() |
|
2656 | 2656 | out[key] = value |
|
2657 | 2657 | return out |
|
2658 | 2658 | |
|
2659 | 2659 | #------------------------------------------------------------------------- |
|
2660 | 2660 | # Things related to the running of code |
|
2661 | 2661 | #------------------------------------------------------------------------- |
|
2662 | 2662 | |
|
2663 | 2663 | def ex(self, cmd): |
|
2664 | 2664 | """Execute a normal python statement in user namespace.""" |
|
2665 | 2665 | with self.builtin_trap: |
|
2666 | 2666 | exec(cmd, self.user_global_ns, self.user_ns) |
|
2667 | 2667 | |
|
2668 | 2668 | def ev(self, expr): |
|
2669 | 2669 | """Evaluate python expression expr in user namespace. |
|
2670 | 2670 | |
|
2671 | 2671 | Returns the result of evaluation |
|
2672 | 2672 | """ |
|
2673 | 2673 | with self.builtin_trap: |
|
2674 | 2674 | return eval(expr, self.user_global_ns, self.user_ns) |
|
2675 | 2675 | |
|
2676 | 2676 | def safe_execfile(self, fname, *where, exit_ignore=False, raise_exceptions=False, shell_futures=False): |
|
2677 | 2677 | """A safe version of the builtin execfile(). |
|
2678 | 2678 | |
|
2679 | 2679 | This version will never throw an exception, but instead print |
|
2680 | 2680 | helpful error messages to the screen. This only works on pure |
|
2681 | 2681 | Python files with the .py extension. |
|
2682 | 2682 | |
|
2683 | 2683 | Parameters |
|
2684 | 2684 | ---------- |
|
2685 | 2685 | fname : string |
|
2686 | 2686 | The name of the file to be executed. |
|
2687 | 2687 | where : tuple |
|
2688 | 2688 | One or two namespaces, passed to execfile() as (globals,locals). |
|
2689 | 2689 | If only one is given, it is passed as both. |
|
2690 | 2690 | exit_ignore : bool (False) |
|
2691 | 2691 | If True, then silence SystemExit for non-zero status (it is always |
|
2692 | 2692 | silenced for zero status, as it is so common). |
|
2693 | 2693 | raise_exceptions : bool (False) |
|
2694 | 2694 | If True raise exceptions everywhere. Meant for testing. |
|
2695 | 2695 | shell_futures : bool (False) |
|
2696 | 2696 | If True, the code will share future statements with the interactive |
|
2697 | 2697 | shell. It will both be affected by previous __future__ imports, and |
|
2698 | 2698 | any __future__ imports in the code will affect the shell. If False, |
|
2699 | 2699 | __future__ imports are not shared in either direction. |
|
2700 | 2700 | |
|
2701 | 2701 | """ |
|
2702 | 2702 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2703 | 2703 | |
|
2704 | 2704 | # Make sure we can open the file |
|
2705 | 2705 | try: |
|
2706 | 2706 | with open(fname): |
|
2707 | 2707 | pass |
|
2708 | 2708 | except: |
|
2709 | 2709 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2710 | 2710 | return |
|
2711 | 2711 | |
|
2712 | 2712 | # Find things also in current directory. This is needed to mimic the |
|
2713 | 2713 | # behavior of running a script from the system command line, where |
|
2714 | 2714 | # Python inserts the script's directory into sys.path |
|
2715 | 2715 | dname = os.path.dirname(fname) |
|
2716 | 2716 | |
|
2717 | 2717 | with prepended_to_syspath(dname), self.builtin_trap: |
|
2718 | 2718 | try: |
|
2719 | 2719 | glob, loc = (where + (None, ))[:2] |
|
2720 | 2720 | py3compat.execfile( |
|
2721 | 2721 | fname, glob, loc, |
|
2722 | 2722 | self.compile if shell_futures else None) |
|
2723 | 2723 | except SystemExit as status: |
|
2724 | 2724 | # If the call was made with 0 or None exit status (sys.exit(0) |
|
2725 | 2725 | # or sys.exit() ), don't bother showing a traceback, as both of |
|
2726 | 2726 | # these are considered normal by the OS: |
|
2727 | 2727 | # > python -c'import sys;sys.exit(0)'; echo $? |
|
2728 | 2728 | # 0 |
|
2729 | 2729 | # > python -c'import sys;sys.exit()'; echo $? |
|
2730 | 2730 | # 0 |
|
2731 | 2731 | # For other exit status, we show the exception unless |
|
2732 | 2732 | # explicitly silenced, but only in short form. |
|
2733 | 2733 | if status.code: |
|
2734 | 2734 | if raise_exceptions: |
|
2735 | 2735 | raise |
|
2736 | 2736 | if not exit_ignore: |
|
2737 | 2737 | self.showtraceback(exception_only=True) |
|
2738 | 2738 | except: |
|
2739 | 2739 | if raise_exceptions: |
|
2740 | 2740 | raise |
|
2741 | 2741 | # tb offset is 2 because we wrap execfile |
|
2742 | 2742 | self.showtraceback(tb_offset=2) |
|
2743 | 2743 | |
|
2744 | 2744 | def safe_execfile_ipy(self, fname, shell_futures=False, raise_exceptions=False): |
|
2745 | 2745 | """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax. |
|
2746 | 2746 | |
|
2747 | 2747 | Parameters |
|
2748 | 2748 | ---------- |
|
2749 | 2749 | fname : str |
|
2750 | 2750 | The name of the file to execute. The filename must have a |
|
2751 | 2751 | .ipy or .ipynb extension. |
|
2752 | 2752 | shell_futures : bool (False) |
|
2753 | 2753 | If True, the code will share future statements with the interactive |
|
2754 | 2754 | shell. It will both be affected by previous __future__ imports, and |
|
2755 | 2755 | any __future__ imports in the code will affect the shell. If False, |
|
2756 | 2756 | __future__ imports are not shared in either direction. |
|
2757 | 2757 | raise_exceptions : bool (False) |
|
2758 | 2758 | If True raise exceptions everywhere. Meant for testing. |
|
2759 | 2759 | """ |
|
2760 | 2760 | fname = os.path.abspath(os.path.expanduser(fname)) |
|
2761 | 2761 | |
|
2762 | 2762 | # Make sure we can open the file |
|
2763 | 2763 | try: |
|
2764 | 2764 | with open(fname): |
|
2765 | 2765 | pass |
|
2766 | 2766 | except: |
|
2767 | 2767 | warn('Could not open file <%s> for safe execution.' % fname) |
|
2768 | 2768 | return |
|
2769 | 2769 | |
|
2770 | 2770 | # Find things also in current directory. This is needed to mimic the |
|
2771 | 2771 | # behavior of running a script from the system command line, where |
|
2772 | 2772 | # Python inserts the script's directory into sys.path |
|
2773 | 2773 | dname = os.path.dirname(fname) |
|
2774 | 2774 | |
|
2775 | 2775 | def get_cells(): |
|
2776 | 2776 | """generator for sequence of code blocks to run""" |
|
2777 | 2777 | if fname.endswith('.ipynb'): |
|
2778 | 2778 | from nbformat import read |
|
2779 | 2779 | nb = read(fname, as_version=4) |
|
2780 | 2780 | if not nb.cells: |
|
2781 | 2781 | return |
|
2782 | 2782 | for cell in nb.cells: |
|
2783 | 2783 | if cell.cell_type == 'code': |
|
2784 | 2784 | yield cell.source |
|
2785 | 2785 | else: |
|
2786 | 2786 | with open(fname) as f: |
|
2787 | 2787 | yield f.read() |
|
2788 | 2788 | |
|
2789 | 2789 | with prepended_to_syspath(dname): |
|
2790 | 2790 | try: |
|
2791 | 2791 | for cell in get_cells(): |
|
2792 | 2792 | result = self.run_cell(cell, silent=True, shell_futures=shell_futures) |
|
2793 | 2793 | if raise_exceptions: |
|
2794 | 2794 | result.raise_error() |
|
2795 | 2795 | elif not result.success: |
|
2796 | 2796 | break |
|
2797 | 2797 | except: |
|
2798 | 2798 | if raise_exceptions: |
|
2799 | 2799 | raise |
|
2800 | 2800 | self.showtraceback() |
|
2801 | 2801 | warn('Unknown failure executing file: <%s>' % fname) |
|
2802 | 2802 | |
|
2803 | 2803 | def safe_run_module(self, mod_name, where): |
|
2804 | 2804 | """A safe version of runpy.run_module(). |
|
2805 | 2805 | |
|
2806 | 2806 | This version will never throw an exception, but instead print |
|
2807 | 2807 | helpful error messages to the screen. |
|
2808 | 2808 | |
|
2809 | 2809 | `SystemExit` exceptions with status code 0 or None are ignored. |
|
2810 | 2810 | |
|
2811 | 2811 | Parameters |
|
2812 | 2812 | ---------- |
|
2813 | 2813 | mod_name : string |
|
2814 | 2814 | The name of the module to be executed. |
|
2815 | 2815 | where : dict |
|
2816 | 2816 | The globals namespace. |
|
2817 | 2817 | """ |
|
2818 | 2818 | try: |
|
2819 | 2819 | try: |
|
2820 | 2820 | where.update( |
|
2821 | 2821 | runpy.run_module(str(mod_name), run_name="__main__", |
|
2822 | 2822 | alter_sys=True) |
|
2823 | 2823 | ) |
|
2824 | 2824 | except SystemExit as status: |
|
2825 | 2825 | if status.code: |
|
2826 | 2826 | raise |
|
2827 | 2827 | except: |
|
2828 | 2828 | self.showtraceback() |
|
2829 | 2829 | warn('Unknown failure executing module: <%s>' % mod_name) |
|
2830 | 2830 | |
|
2831 | 2831 | def run_cell(self, raw_cell, store_history=False, silent=False, shell_futures=True): |
|
2832 | 2832 | """Run a complete IPython cell. |
|
2833 | 2833 | |
|
2834 | 2834 | Parameters |
|
2835 | 2835 | ---------- |
|
2836 | 2836 | raw_cell : str |
|
2837 | 2837 | The code (including IPython code such as %magic functions) to run. |
|
2838 | 2838 | store_history : bool |
|
2839 | 2839 | If True, the raw and translated cell will be stored in IPython's |
|
2840 | 2840 | history. For user code calling back into IPython's machinery, this |
|
2841 | 2841 | should be set to False. |
|
2842 | 2842 | silent : bool |
|
2843 | 2843 | If True, avoid side-effects, such as implicit displayhooks and |
|
2844 | 2844 | and logging. silent=True forces store_history=False. |
|
2845 | 2845 | shell_futures : bool |
|
2846 | 2846 | If True, the code will share future statements with the interactive |
|
2847 | 2847 | shell. It will both be affected by previous __future__ imports, and |
|
2848 | 2848 | any __future__ imports in the code will affect the shell. If False, |
|
2849 | 2849 | __future__ imports are not shared in either direction. |
|
2850 | 2850 | |
|
2851 | 2851 | Returns |
|
2852 | 2852 | ------- |
|
2853 | 2853 | result : :class:`ExecutionResult` |
|
2854 | 2854 | """ |
|
2855 | 2855 | result = None |
|
2856 | 2856 | try: |
|
2857 | 2857 | result = self._run_cell( |
|
2858 | 2858 | raw_cell, store_history, silent, shell_futures) |
|
2859 | 2859 | finally: |
|
2860 | 2860 | self.events.trigger('post_execute') |
|
2861 | 2861 | if not silent: |
|
2862 | 2862 | self.events.trigger('post_run_cell', result) |
|
2863 | 2863 | return result |
|
2864 | 2864 | |
|
2865 | 2865 | def _run_cell(self, raw_cell:str, store_history:bool, silent:bool, shell_futures:bool): |
|
2866 | 2866 | """Internal method to run a complete IPython cell.""" |
|
2867 | 2867 | coro = self.run_cell_async( |
|
2868 | 2868 | raw_cell, |
|
2869 | 2869 | store_history=store_history, |
|
2870 | 2870 | silent=silent, |
|
2871 | 2871 | shell_futures=shell_futures, |
|
2872 | 2872 | ) |
|
2873 | 2873 | |
|
2874 | 2874 | # run_cell_async is async, but may not actually need an eventloop. |
|
2875 | 2875 | # when this is the case, we want to run it using the pseudo_sync_runner |
|
2876 | 2876 | # so that code can invoke eventloops (for example via the %run , and |
|
2877 | 2877 | # `%paste` magic. |
|
2878 | 2878 | if self.trio_runner: |
|
2879 | 2879 | runner = self.trio_runner |
|
2880 | 2880 | elif self.should_run_async(raw_cell): |
|
2881 | 2881 | runner = self.loop_runner |
|
2882 | 2882 | else: |
|
2883 | 2883 | runner = _pseudo_sync_runner |
|
2884 | 2884 | |
|
2885 | 2885 | try: |
|
2886 | 2886 | return runner(coro) |
|
2887 | 2887 | except BaseException as e: |
|
2888 | 2888 | info = ExecutionInfo(raw_cell, store_history, silent, shell_futures) |
|
2889 | 2889 | result = ExecutionResult(info) |
|
2890 | 2890 | result.error_in_exec = e |
|
2891 | 2891 | self.showtraceback(running_compiled_code=True) |
|
2892 | 2892 | return result |
|
2893 | 2893 | return |
|
2894 | 2894 | |
|
2895 | 2895 | def should_run_async(self, raw_cell: str) -> bool: |
|
2896 | 2896 | """Return whether a cell should be run asynchronously via a coroutine runner |
|
2897 | 2897 | |
|
2898 | 2898 | Parameters |
|
2899 | 2899 | ---------- |
|
2900 | 2900 | raw_cell: str |
|
2901 | 2901 | The code to be executed |
|
2902 | 2902 | |
|
2903 | 2903 | Returns |
|
2904 | 2904 | ------- |
|
2905 | 2905 | result: bool |
|
2906 | 2906 | Whether the code needs to be run with a coroutine runner or not |
|
2907 | 2907 | |
|
2908 | 2908 | .. versionadded: 7.0 |
|
2909 | 2909 | """ |
|
2910 | 2910 | if not self.autoawait: |
|
2911 | 2911 | return False |
|
2912 | 2912 | try: |
|
2913 | 2913 | cell = self.transform_cell(raw_cell) |
|
2914 | 2914 | except Exception: |
|
2915 | 2915 | # any exception during transform will be raised |
|
2916 | 2916 | # prior to execution |
|
2917 | 2917 | return False |
|
2918 | 2918 | return _should_be_async(cell) |
|
2919 | 2919 | |
|
2920 | 2920 | async def run_cell_async(self, raw_cell: str, store_history=False, silent=False, shell_futures=True) -> ExecutionResult: |
|
2921 | 2921 | """Run a complete IPython cell asynchronously. |
|
2922 | 2922 | |
|
2923 | 2923 | Parameters |
|
2924 | 2924 | ---------- |
|
2925 | 2925 | raw_cell : str |
|
2926 | 2926 | The code (including IPython code such as %magic functions) to run. |
|
2927 | 2927 | store_history : bool |
|
2928 | 2928 | If True, the raw and translated cell will be stored in IPython's |
|
2929 | 2929 | history. For user code calling back into IPython's machinery, this |
|
2930 | 2930 | should be set to False. |
|
2931 | 2931 | silent : bool |
|
2932 | 2932 | If True, avoid side-effects, such as implicit displayhooks and |
|
2933 | 2933 | and logging. silent=True forces store_history=False. |
|
2934 | 2934 | shell_futures : bool |
|
2935 | 2935 | If True, the code will share future statements with the interactive |
|
2936 | 2936 | shell. It will both be affected by previous __future__ imports, and |
|
2937 | 2937 | any __future__ imports in the code will affect the shell. If False, |
|
2938 | 2938 | __future__ imports are not shared in either direction. |
|
2939 | 2939 | |
|
2940 | 2940 | Returns |
|
2941 | 2941 | ------- |
|
2942 | 2942 | result : :class:`ExecutionResult` |
|
2943 | 2943 | |
|
2944 | 2944 | .. versionadded: 7.0 |
|
2945 | 2945 | """ |
|
2946 | 2946 | info = ExecutionInfo( |
|
2947 | 2947 | raw_cell, store_history, silent, shell_futures) |
|
2948 | 2948 | result = ExecutionResult(info) |
|
2949 | 2949 | |
|
2950 | 2950 | if (not raw_cell) or raw_cell.isspace(): |
|
2951 | 2951 | self.last_execution_succeeded = True |
|
2952 | 2952 | self.last_execution_result = result |
|
2953 | 2953 | return result |
|
2954 | 2954 | |
|
2955 | 2955 | if silent: |
|
2956 | 2956 | store_history = False |
|
2957 | 2957 | |
|
2958 | 2958 | if store_history: |
|
2959 | 2959 | result.execution_count = self.execution_count |
|
2960 | 2960 | |
|
2961 | 2961 | def error_before_exec(value): |
|
2962 | 2962 | if store_history: |
|
2963 | 2963 | self.execution_count += 1 |
|
2964 | 2964 | result.error_before_exec = value |
|
2965 | 2965 | self.last_execution_succeeded = False |
|
2966 | 2966 | self.last_execution_result = result |
|
2967 | 2967 | return result |
|
2968 | 2968 | |
|
2969 | 2969 | self.events.trigger('pre_execute') |
|
2970 | 2970 | if not silent: |
|
2971 | 2971 | self.events.trigger('pre_run_cell', info) |
|
2972 | 2972 | |
|
2973 | 2973 | # If any of our input transformation (input_transformer_manager or |
|
2974 | 2974 | # prefilter_manager) raises an exception, we store it in this variable |
|
2975 | 2975 | # so that we can display the error after logging the input and storing |
|
2976 | 2976 | # it in the history. |
|
2977 | 2977 | try: |
|
2978 | 2978 | cell = self.transform_cell(raw_cell) |
|
2979 | 2979 | except Exception: |
|
2980 | 2980 | preprocessing_exc_tuple = sys.exc_info() |
|
2981 | 2981 | cell = raw_cell # cell has to exist so it can be stored/logged |
|
2982 | 2982 | else: |
|
2983 | 2983 | preprocessing_exc_tuple = None |
|
2984 | 2984 | |
|
2985 | 2985 | # Store raw and processed history |
|
2986 | 2986 | if store_history: |
|
2987 | 2987 | self.history_manager.store_inputs(self.execution_count, |
|
2988 | 2988 | cell, raw_cell) |
|
2989 | 2989 | if not silent: |
|
2990 | 2990 | self.logger.log(cell, raw_cell) |
|
2991 | 2991 | |
|
2992 | 2992 | # Display the exception if input processing failed. |
|
2993 | 2993 | if preprocessing_exc_tuple is not None: |
|
2994 | 2994 | self.showtraceback(preprocessing_exc_tuple) |
|
2995 | 2995 | if store_history: |
|
2996 | 2996 | self.execution_count += 1 |
|
2997 | 2997 | return error_before_exec(preprocessing_exc_tuple[1]) |
|
2998 | 2998 | |
|
2999 | 2999 | # Our own compiler remembers the __future__ environment. If we want to |
|
3000 | 3000 | # run code with a separate __future__ environment, use the default |
|
3001 | 3001 | # compiler |
|
3002 | 3002 | compiler = self.compile if shell_futures else CachingCompiler() |
|
3003 | 3003 | |
|
3004 | 3004 | _run_async = False |
|
3005 | 3005 | |
|
3006 | 3006 | with self.builtin_trap: |
|
3007 | 3007 | cell_name = self.compile.cache(cell, self.execution_count) |
|
3008 | 3008 | |
|
3009 | 3009 | with self.display_trap: |
|
3010 | 3010 | # Compile to bytecode |
|
3011 | 3011 | try: |
|
3012 | 3012 | if sys.version_info < (3,8) and self.autoawait: |
|
3013 | 3013 | if _should_be_async(cell): |
|
3014 | 3014 | # the code AST below will not be user code: we wrap it |
|
3015 | 3015 | # in an `async def`. This will likely make some AST |
|
3016 | 3016 | # transformer below miss some transform opportunity and |
|
3017 | 3017 | # introduce a small coupling to run_code (in which we |
|
3018 | 3018 | # bake some assumptions of what _ast_asyncify returns. |
|
3019 | 3019 | # they are ways around (like grafting part of the ast |
|
3020 | 3020 | # later: |
|
3021 | 3021 | # - Here, return code_ast.body[0].body[1:-1], as well |
|
3022 | 3022 | # as last expression in return statement which is |
|
3023 | 3023 | # the user code part. |
|
3024 | 3024 | # - Let it go through the AST transformers, and graft |
|
3025 | 3025 | # - it back after the AST transform |
|
3026 | 3026 | # But that seem unreasonable, at least while we |
|
3027 | 3027 | # do not need it. |
|
3028 | 3028 | code_ast = _ast_asyncify(cell, 'async-def-wrapper') |
|
3029 | 3029 | _run_async = True |
|
3030 | 3030 | else: |
|
3031 | 3031 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3032 | 3032 | else: |
|
3033 | 3033 | code_ast = compiler.ast_parse(cell, filename=cell_name) |
|
3034 | 3034 | except self.custom_exceptions as e: |
|
3035 | 3035 | etype, value, tb = sys.exc_info() |
|
3036 | 3036 | self.CustomTB(etype, value, tb) |
|
3037 | 3037 | return error_before_exec(e) |
|
3038 | 3038 | except IndentationError as e: |
|
3039 | 3039 | self.showindentationerror() |
|
3040 | 3040 | return error_before_exec(e) |
|
3041 | 3041 | except (OverflowError, SyntaxError, ValueError, TypeError, |
|
3042 | 3042 | MemoryError) as e: |
|
3043 | 3043 | self.showsyntaxerror() |
|
3044 | 3044 | return error_before_exec(e) |
|
3045 | 3045 | |
|
3046 | 3046 | # Apply AST transformations |
|
3047 | 3047 | try: |
|
3048 | 3048 | code_ast = self.transform_ast(code_ast) |
|
3049 | 3049 | except InputRejected as e: |
|
3050 | 3050 | self.showtraceback() |
|
3051 | 3051 | return error_before_exec(e) |
|
3052 | 3052 | |
|
3053 | 3053 | # Give the displayhook a reference to our ExecutionResult so it |
|
3054 | 3054 | # can fill in the output value. |
|
3055 | 3055 | self.displayhook.exec_result = result |
|
3056 | 3056 | |
|
3057 | 3057 | # Execute the user code |
|
3058 | 3058 | interactivity = "none" if silent else self.ast_node_interactivity |
|
3059 | 3059 | if _run_async: |
|
3060 | 3060 | interactivity = 'async' |
|
3061 | 3061 | |
|
3062 | 3062 | has_raised = await self.run_ast_nodes(code_ast.body, cell_name, |
|
3063 | 3063 | interactivity=interactivity, compiler=compiler, result=result) |
|
3064 | 3064 | |
|
3065 | 3065 | self.last_execution_succeeded = not has_raised |
|
3066 | 3066 | self.last_execution_result = result |
|
3067 | 3067 | |
|
3068 | 3068 | # Reset this so later displayed values do not modify the |
|
3069 | 3069 | # ExecutionResult |
|
3070 | 3070 | self.displayhook.exec_result = None |
|
3071 | 3071 | |
|
3072 | 3072 | if store_history: |
|
3073 | 3073 | # Write output to the database. Does nothing unless |
|
3074 | 3074 | # history output logging is enabled. |
|
3075 | 3075 | self.history_manager.store_output(self.execution_count) |
|
3076 | 3076 | # Each cell is a *single* input, regardless of how many lines it has |
|
3077 | 3077 | self.execution_count += 1 |
|
3078 | 3078 | |
|
3079 | 3079 | return result |
|
3080 | 3080 | |
|
3081 | 3081 | def transform_cell(self, raw_cell): |
|
3082 | 3082 | """Transform an input cell before parsing it. |
|
3083 | 3083 | |
|
3084 | 3084 | Static transformations, implemented in IPython.core.inputtransformer2, |
|
3085 | 3085 | deal with things like ``%magic`` and ``!system`` commands. |
|
3086 | 3086 | These run on all input. |
|
3087 | 3087 | Dynamic transformations, for things like unescaped magics and the exit |
|
3088 | 3088 | autocall, depend on the state of the interpreter. |
|
3089 | 3089 | These only apply to single line inputs. |
|
3090 | 3090 | |
|
3091 | 3091 | These string-based transformations are followed by AST transformations; |
|
3092 | 3092 | see :meth:`transform_ast`. |
|
3093 | 3093 | """ |
|
3094 | 3094 | # Static input transformations |
|
3095 | 3095 | cell = self.input_transformer_manager.transform_cell(raw_cell) |
|
3096 | 3096 | |
|
3097 | 3097 | if len(cell.splitlines()) == 1: |
|
3098 | 3098 | # Dynamic transformations - only applied for single line commands |
|
3099 | 3099 | with self.builtin_trap: |
|
3100 | 3100 | # use prefilter_lines to handle trailing newlines |
|
3101 | 3101 | # restore trailing newline for ast.parse |
|
3102 | 3102 | cell = self.prefilter_manager.prefilter_lines(cell) + '\n' |
|
3103 | 3103 | |
|
3104 | 3104 | lines = cell.splitlines(keepends=True) |
|
3105 | 3105 | for transform in self.input_transformers_post: |
|
3106 | 3106 | lines = transform(lines) |
|
3107 | 3107 | cell = ''.join(lines) |
|
3108 | 3108 | |
|
3109 | 3109 | return cell |
|
3110 | 3110 | |
|
3111 | 3111 | def transform_ast(self, node): |
|
3112 | 3112 | """Apply the AST transformations from self.ast_transformers |
|
3113 | 3113 | |
|
3114 | 3114 | Parameters |
|
3115 | 3115 | ---------- |
|
3116 | 3116 | node : ast.Node |
|
3117 | 3117 | The root node to be transformed. Typically called with the ast.Module |
|
3118 | 3118 | produced by parsing user input. |
|
3119 | 3119 | |
|
3120 | 3120 | Returns |
|
3121 | 3121 | ------- |
|
3122 | 3122 | An ast.Node corresponding to the node it was called with. Note that it |
|
3123 | 3123 | may also modify the passed object, so don't rely on references to the |
|
3124 | 3124 | original AST. |
|
3125 | 3125 | """ |
|
3126 | 3126 | for transformer in self.ast_transformers: |
|
3127 | 3127 | try: |
|
3128 | 3128 | node = transformer.visit(node) |
|
3129 | 3129 | except InputRejected: |
|
3130 | 3130 | # User-supplied AST transformers can reject an input by raising |
|
3131 | 3131 | # an InputRejected. Short-circuit in this case so that we |
|
3132 | 3132 | # don't unregister the transform. |
|
3133 | 3133 | raise |
|
3134 | 3134 | except Exception: |
|
3135 | 3135 | warn("AST transformer %r threw an error. It will be unregistered." % transformer) |
|
3136 | 3136 | self.ast_transformers.remove(transformer) |
|
3137 | 3137 | |
|
3138 | 3138 | if self.ast_transformers: |
|
3139 | 3139 | ast.fix_missing_locations(node) |
|
3140 | 3140 | return node |
|
3141 | 3141 | |
|
3142 | 3142 | async def run_ast_nodes(self, nodelist:ListType[AST], cell_name:str, interactivity='last_expr', |
|
3143 | 3143 | compiler=compile, result=None): |
|
3144 | 3144 | """Run a sequence of AST nodes. The execution mode depends on the |
|
3145 | 3145 | interactivity parameter. |
|
3146 | 3146 | |
|
3147 | 3147 | Parameters |
|
3148 | 3148 | ---------- |
|
3149 | 3149 | nodelist : list |
|
3150 | 3150 | A sequence of AST nodes to run. |
|
3151 | 3151 | cell_name : str |
|
3152 | 3152 | Will be passed to the compiler as the filename of the cell. Typically |
|
3153 | 3153 | the value returned by ip.compile.cache(cell). |
|
3154 | 3154 | interactivity : str |
|
3155 | 3155 | 'all', 'last', 'last_expr' , 'last_expr_or_assign' or 'none', |
|
3156 | 3156 | specifying which nodes should be run interactively (displaying output |
|
3157 | 3157 | from expressions). 'last_expr' will run the last node interactively |
|
3158 | 3158 | only if it is an expression (i.e. expressions in loops or other blocks |
|
3159 | 3159 | are not displayed) 'last_expr_or_assign' will run the last expression |
|
3160 | 3160 | or the last assignment. Other values for this parameter will raise a |
|
3161 | 3161 | ValueError. |
|
3162 | 3162 | |
|
3163 | 3163 | Experimental value: 'async' Will try to run top level interactive |
|
3164 | 3164 | async/await code in default runner, this will not respect the |
|
3165 | 3165 | interactivity setting and will only run the last node if it is an |
|
3166 | 3166 | expression. |
|
3167 | 3167 | |
|
3168 | 3168 | compiler : callable |
|
3169 | 3169 | A function with the same interface as the built-in compile(), to turn |
|
3170 | 3170 | the AST nodes into code objects. Default is the built-in compile(). |
|
3171 | 3171 | result : ExecutionResult, optional |
|
3172 | 3172 | An object to store exceptions that occur during execution. |
|
3173 | 3173 | |
|
3174 | 3174 | Returns |
|
3175 | 3175 | ------- |
|
3176 | 3176 | True if an exception occurred while running code, False if it finished |
|
3177 | 3177 | running. |
|
3178 | 3178 | """ |
|
3179 | 3179 | if not nodelist: |
|
3180 | 3180 | return |
|
3181 | 3181 | |
|
3182 | 3182 | if interactivity == 'last_expr_or_assign': |
|
3183 | 3183 | if isinstance(nodelist[-1], _assign_nodes): |
|
3184 | 3184 | asg = nodelist[-1] |
|
3185 | 3185 | if isinstance(asg, ast.Assign) and len(asg.targets) == 1: |
|
3186 | 3186 | target = asg.targets[0] |
|
3187 | 3187 | elif isinstance(asg, _single_targets_nodes): |
|
3188 | 3188 | target = asg.target |
|
3189 | 3189 | else: |
|
3190 | 3190 | target = None |
|
3191 | 3191 | if isinstance(target, ast.Name): |
|
3192 | 3192 | nnode = ast.Expr(ast.Name(target.id, ast.Load())) |
|
3193 | 3193 | ast.fix_missing_locations(nnode) |
|
3194 | 3194 | nodelist.append(nnode) |
|
3195 | 3195 | interactivity = 'last_expr' |
|
3196 | 3196 | |
|
3197 | 3197 | _async = False |
|
3198 | 3198 | if interactivity == 'last_expr': |
|
3199 | 3199 | if isinstance(nodelist[-1], ast.Expr): |
|
3200 | 3200 | interactivity = "last" |
|
3201 | 3201 | else: |
|
3202 | 3202 | interactivity = "none" |
|
3203 | 3203 | |
|
3204 | 3204 | if interactivity == 'none': |
|
3205 | 3205 | to_run_exec, to_run_interactive = nodelist, [] |
|
3206 | 3206 | elif interactivity == 'last': |
|
3207 | 3207 | to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:] |
|
3208 | 3208 | elif interactivity == 'all': |
|
3209 | 3209 | to_run_exec, to_run_interactive = [], nodelist |
|
3210 | 3210 | elif interactivity == 'async': |
|
3211 | 3211 | to_run_exec, to_run_interactive = [], nodelist |
|
3212 | 3212 | _async = True |
|
3213 | 3213 | else: |
|
3214 | 3214 | raise ValueError("Interactivity was %r" % interactivity) |
|
3215 | 3215 | |
|
3216 | 3216 | try: |
|
3217 | 3217 | if _async and sys.version_info > (3,8): |
|
3218 | 3218 | raise ValueError("This branch should never happen on Python 3.8 and above, " |
|
3219 | 3219 | "please try to upgrade IPython and open a bug report with your case.") |
|
3220 | 3220 | if _async: |
|
3221 | 3221 | # If interactivity is async the semantics of run_code are |
|
3222 | 3222 | # completely different Skip usual machinery. |
|
3223 | 3223 | mod = Module(nodelist, []) |
|
3224 | 3224 | async_wrapper_code = compiler(mod, cell_name, 'exec') |
|
3225 | 3225 | exec(async_wrapper_code, self.user_global_ns, self.user_ns) |
|
3226 | 3226 | async_code = removed_co_newlocals(self.user_ns.pop('async-def-wrapper')).__code__ |
|
3227 | 3227 | if (await self.run_code(async_code, result, async_=True)): |
|
3228 | 3228 | return True |
|
3229 | 3229 | else: |
|
3230 | 3230 | if sys.version_info > (3, 8): |
|
3231 | 3231 | def compare(code): |
|
3232 | 3232 | is_async = (inspect.CO_COROUTINE & code.co_flags == inspect.CO_COROUTINE) |
|
3233 | 3233 | return is_async |
|
3234 | 3234 | else: |
|
3235 | 3235 | def compare(code): |
|
3236 | 3236 | return _async |
|
3237 | 3237 | |
|
3238 | 3238 | # refactor that to just change the mod constructor. |
|
3239 | 3239 | to_run = [] |
|
3240 | 3240 | for node in to_run_exec: |
|
3241 | 3241 | to_run.append((node, 'exec')) |
|
3242 | 3242 | |
|
3243 | 3243 | for node in to_run_interactive: |
|
3244 | 3244 | to_run.append((node, 'single')) |
|
3245 | 3245 | |
|
3246 | 3246 | for node,mode in to_run: |
|
3247 | 3247 | if mode == 'exec': |
|
3248 | 3248 | mod = Module([node], []) |
|
3249 | 3249 | elif mode == 'single': |
|
3250 | 3250 | mod = ast.Interactive([node]) |
|
3251 | 3251 | with compiler.extra_flags(getattr(ast, 'PyCF_ALLOW_TOP_LEVEL_AWAIT', 0x0) if self.autoawait else 0x0): |
|
3252 | 3252 | code = compiler(mod, cell_name, mode) |
|
3253 | 3253 | asy = compare(code) |
|
3254 | 3254 | if (await self.run_code(code, result, async_=asy)): |
|
3255 | 3255 | return True |
|
3256 | 3256 | |
|
3257 | 3257 | # Flush softspace |
|
3258 | 3258 | if softspace(sys.stdout, 0): |
|
3259 | 3259 | print() |
|
3260 | 3260 | |
|
3261 | 3261 | except: |
|
3262 | 3262 | # It's possible to have exceptions raised here, typically by |
|
3263 | 3263 | # compilation of odd code (such as a naked 'return' outside a |
|
3264 | 3264 | # function) that did parse but isn't valid. Typically the exception |
|
3265 | 3265 | # is a SyntaxError, but it's safest just to catch anything and show |
|
3266 | 3266 | # the user a traceback. |
|
3267 | 3267 | |
|
3268 | 3268 | # We do only one try/except outside the loop to minimize the impact |
|
3269 | 3269 | # on runtime, and also because if any node in the node list is |
|
3270 | 3270 | # broken, we should stop execution completely. |
|
3271 | 3271 | if result: |
|
3272 | 3272 | result.error_before_exec = sys.exc_info()[1] |
|
3273 | 3273 | self.showtraceback() |
|
3274 | 3274 | return True |
|
3275 | 3275 | |
|
3276 | 3276 | return False |
|
3277 | 3277 | |
|
3278 | 3278 | def _async_exec(self, code_obj: types.CodeType, user_ns: dict): |
|
3279 | 3279 | """ |
|
3280 | 3280 | Evaluate an asynchronous code object using a code runner |
|
3281 | 3281 | |
|
3282 | 3282 | Fake asynchronous execution of code_object in a namespace via a proxy namespace. |
|
3283 | 3283 | |
|
3284 | 3284 | Returns coroutine object, which can be executed via async loop runner |
|
3285 | 3285 | |
|
3286 | 3286 | WARNING: The semantics of `async_exec` are quite different from `exec`, |
|
3287 | 3287 | in particular you can only pass a single namespace. It also return a |
|
3288 | 3288 | handle to the value of the last things returned by code_object. |
|
3289 | 3289 | """ |
|
3290 | 3290 | |
|
3291 | 3291 | return eval(code_obj, user_ns) |
|
3292 | 3292 | |
|
3293 | 3293 | async def run_code(self, code_obj, result=None, *, async_=False): |
|
3294 | 3294 | """Execute a code object. |
|
3295 | 3295 | |
|
3296 | 3296 | When an exception occurs, self.showtraceback() is called to display a |
|
3297 | 3297 | traceback. |
|
3298 | 3298 | |
|
3299 | 3299 | Parameters |
|
3300 | 3300 | ---------- |
|
3301 | 3301 | code_obj : code object |
|
3302 | 3302 | A compiled code object, to be executed |
|
3303 | 3303 | result : ExecutionResult, optional |
|
3304 | 3304 | An object to store exceptions that occur during execution. |
|
3305 | 3305 | async_ : Bool (Experimental) |
|
3306 | 3306 | Attempt to run top-level asynchronous code in a default loop. |
|
3307 | 3307 | |
|
3308 | 3308 | Returns |
|
3309 | 3309 | ------- |
|
3310 | 3310 | False : successful execution. |
|
3311 | 3311 | True : an error occurred. |
|
3312 | 3312 | """ |
|
3313 | 3313 | # Set our own excepthook in case the user code tries to call it |
|
3314 | 3314 | # directly, so that the IPython crash handler doesn't get triggered |
|
3315 | 3315 | old_excepthook, sys.excepthook = sys.excepthook, self.excepthook |
|
3316 | 3316 | |
|
3317 | 3317 | # we save the original sys.excepthook in the instance, in case config |
|
3318 | 3318 | # code (such as magics) needs access to it. |
|
3319 | 3319 | self.sys_excepthook = old_excepthook |
|
3320 | 3320 | outflag = True # happens in more places, so it's easier as default |
|
3321 | 3321 | try: |
|
3322 | 3322 | try: |
|
3323 | 3323 | self.hooks.pre_run_code_hook() |
|
3324 | 3324 | if async_ and sys.version_info < (3,8): |
|
3325 | 3325 | last_expr = (await self._async_exec(code_obj, self.user_ns)) |
|
3326 | 3326 | code = compile('last_expr', 'fake', "single") |
|
3327 | 3327 | exec(code, {'last_expr': last_expr}) |
|
3328 | 3328 | elif async_ : |
|
3329 | 3329 | await eval(code_obj, self.user_global_ns, self.user_ns) |
|
3330 | 3330 | else: |
|
3331 | 3331 | exec(code_obj, self.user_global_ns, self.user_ns) |
|
3332 | 3332 | finally: |
|
3333 | 3333 | # Reset our crash handler in place |
|
3334 | 3334 | sys.excepthook = old_excepthook |
|
3335 | 3335 | except SystemExit as e: |
|
3336 | 3336 | if result is not None: |
|
3337 | 3337 | result.error_in_exec = e |
|
3338 | 3338 | self.showtraceback(exception_only=True) |
|
3339 | 3339 | warn("To exit: use 'exit', 'quit', or Ctrl-D.", stacklevel=1) |
|
3340 | 3340 | except self.custom_exceptions: |
|
3341 | 3341 | etype, value, tb = sys.exc_info() |
|
3342 | 3342 | if result is not None: |
|
3343 | 3343 | result.error_in_exec = value |
|
3344 | 3344 | self.CustomTB(etype, value, tb) |
|
3345 | 3345 | except: |
|
3346 | 3346 | if result is not None: |
|
3347 | 3347 | result.error_in_exec = sys.exc_info()[1] |
|
3348 | 3348 | self.showtraceback(running_compiled_code=True) |
|
3349 | 3349 | else: |
|
3350 | 3350 | outflag = False |
|
3351 | 3351 | return outflag |
|
3352 | 3352 | |
|
3353 | 3353 | # For backwards compatibility |
|
3354 | 3354 | runcode = run_code |
|
3355 | 3355 | |
|
3356 | 3356 | def check_complete(self, code: str) -> Tuple[str, str]: |
|
3357 | 3357 | """Return whether a block of code is ready to execute, or should be continued |
|
3358 | 3358 | |
|
3359 | 3359 | Parameters |
|
3360 | 3360 | ---------- |
|
3361 | 3361 | source : string |
|
3362 | 3362 | Python input code, which can be multiline. |
|
3363 | 3363 | |
|
3364 | 3364 | Returns |
|
3365 | 3365 | ------- |
|
3366 | 3366 | status : str |
|
3367 | 3367 | One of 'complete', 'incomplete', or 'invalid' if source is not a |
|
3368 | 3368 | prefix of valid code. |
|
3369 | 3369 | indent : str |
|
3370 | 3370 | When status is 'incomplete', this is some whitespace to insert on |
|
3371 | 3371 | the next line of the prompt. |
|
3372 | 3372 | """ |
|
3373 | 3373 | status, nspaces = self.input_transformer_manager.check_complete(code) |
|
3374 | 3374 | return status, ' ' * (nspaces or 0) |
|
3375 | 3375 | |
|
3376 | 3376 | #------------------------------------------------------------------------- |
|
3377 | 3377 | # Things related to GUI support and pylab |
|
3378 | 3378 | #------------------------------------------------------------------------- |
|
3379 | 3379 | |
|
3380 | 3380 | active_eventloop = None |
|
3381 | 3381 | |
|
3382 | 3382 | def enable_gui(self, gui=None): |
|
3383 | 3383 | raise NotImplementedError('Implement enable_gui in a subclass') |
|
3384 | 3384 | |
|
3385 | 3385 | def enable_matplotlib(self, gui=None): |
|
3386 | 3386 | """Enable interactive matplotlib and inline figure support. |
|
3387 | 3387 | |
|
3388 | 3388 | This takes the following steps: |
|
3389 | 3389 | |
|
3390 | 3390 | 1. select the appropriate eventloop and matplotlib backend |
|
3391 | 3391 | 2. set up matplotlib for interactive use with that backend |
|
3392 | 3392 | 3. configure formatters for inline figure display |
|
3393 | 3393 | 4. enable the selected gui eventloop |
|
3394 | 3394 | |
|
3395 | 3395 | Parameters |
|
3396 | 3396 | ---------- |
|
3397 | 3397 | gui : optional, string |
|
3398 | 3398 | If given, dictates the choice of matplotlib GUI backend to use |
|
3399 | 3399 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3400 | 3400 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3401 | 3401 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3402 | 3402 | user's matplotlibrc configuration file). Note that not all backends |
|
3403 | 3403 | make sense in all contexts, for example a terminal ipython can't |
|
3404 | 3404 | display figures inline. |
|
3405 | 3405 | """ |
|
3406 | 3406 | from IPython.core import pylabtools as pt |
|
3407 | 3407 | gui, backend = pt.find_gui_and_backend(gui, self.pylab_gui_select) |
|
3408 | 3408 | |
|
3409 | 3409 | if gui != 'inline': |
|
3410 | 3410 | # If we have our first gui selection, store it |
|
3411 | 3411 | if self.pylab_gui_select is None: |
|
3412 | 3412 | self.pylab_gui_select = gui |
|
3413 | 3413 | # Otherwise if they are different |
|
3414 | 3414 | elif gui != self.pylab_gui_select: |
|
3415 | 3415 | print('Warning: Cannot change to a different GUI toolkit: %s.' |
|
3416 | 3416 | ' Using %s instead.' % (gui, self.pylab_gui_select)) |
|
3417 | 3417 | gui, backend = pt.find_gui_and_backend(self.pylab_gui_select) |
|
3418 | 3418 | |
|
3419 | 3419 | pt.activate_matplotlib(backend) |
|
3420 | 3420 | pt.configure_inline_support(self, backend) |
|
3421 | 3421 | |
|
3422 | 3422 | # Now we must activate the gui pylab wants to use, and fix %run to take |
|
3423 | 3423 | # plot updates into account |
|
3424 | 3424 | self.enable_gui(gui) |
|
3425 | 3425 | self.magics_manager.registry['ExecutionMagics'].default_runner = \ |
|
3426 | 3426 | pt.mpl_runner(self.safe_execfile) |
|
3427 | 3427 | |
|
3428 | 3428 | return gui, backend |
|
3429 | 3429 | |
|
3430 | 3430 | def enable_pylab(self, gui=None, import_all=True, welcome_message=False): |
|
3431 | 3431 | """Activate pylab support at runtime. |
|
3432 | 3432 | |
|
3433 | 3433 | This turns on support for matplotlib, preloads into the interactive |
|
3434 | 3434 | namespace all of numpy and pylab, and configures IPython to correctly |
|
3435 | 3435 | interact with the GUI event loop. The GUI backend to be used can be |
|
3436 | 3436 | optionally selected with the optional ``gui`` argument. |
|
3437 | 3437 | |
|
3438 | 3438 | This method only adds preloading the namespace to InteractiveShell.enable_matplotlib. |
|
3439 | 3439 | |
|
3440 | 3440 | Parameters |
|
3441 | 3441 | ---------- |
|
3442 | 3442 | gui : optional, string |
|
3443 | 3443 | If given, dictates the choice of matplotlib GUI backend to use |
|
3444 | 3444 | (should be one of IPython's supported backends, 'qt', 'osx', 'tk', |
|
3445 | 3445 | 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by |
|
3446 | 3446 | matplotlib (as dictated by the matplotlib build-time options plus the |
|
3447 | 3447 | user's matplotlibrc configuration file). Note that not all backends |
|
3448 | 3448 | make sense in all contexts, for example a terminal ipython can't |
|
3449 | 3449 | display figures inline. |
|
3450 | 3450 | import_all : optional, bool, default: True |
|
3451 | 3451 | Whether to do `from numpy import *` and `from pylab import *` |
|
3452 | 3452 | in addition to module imports. |
|
3453 | 3453 | welcome_message : deprecated |
|
3454 | 3454 | This argument is ignored, no welcome message will be displayed. |
|
3455 | 3455 | """ |
|
3456 | 3456 | from IPython.core.pylabtools import import_pylab |
|
3457 | 3457 | |
|
3458 | 3458 | gui, backend = self.enable_matplotlib(gui) |
|
3459 | 3459 | |
|
3460 | 3460 | # We want to prevent the loading of pylab to pollute the user's |
|
3461 | 3461 | # namespace as shown by the %who* magics, so we execute the activation |
|
3462 | 3462 | # code in an empty namespace, and we update *both* user_ns and |
|
3463 | 3463 | # user_ns_hidden with this information. |
|
3464 | 3464 | ns = {} |
|
3465 | 3465 | import_pylab(ns, import_all) |
|
3466 | 3466 | # warn about clobbered names |
|
3467 | 3467 | ignored = {"__builtins__"} |
|
3468 | 3468 | both = set(ns).intersection(self.user_ns).difference(ignored) |
|
3469 | 3469 | clobbered = [ name for name in both if self.user_ns[name] is not ns[name] ] |
|
3470 | 3470 | self.user_ns.update(ns) |
|
3471 | 3471 | self.user_ns_hidden.update(ns) |
|
3472 | 3472 | return gui, backend, clobbered |
|
3473 | 3473 | |
|
3474 | 3474 | #------------------------------------------------------------------------- |
|
3475 | 3475 | # Utilities |
|
3476 | 3476 | #------------------------------------------------------------------------- |
|
3477 | 3477 | |
|
3478 | 3478 | def var_expand(self, cmd, depth=0, formatter=DollarFormatter()): |
|
3479 | 3479 | """Expand python variables in a string. |
|
3480 | 3480 | |
|
3481 | 3481 | The depth argument indicates how many frames above the caller should |
|
3482 | 3482 | be walked to look for the local namespace where to expand variables. |
|
3483 | 3483 | |
|
3484 | 3484 | The global namespace for expansion is always the user's interactive |
|
3485 | 3485 | namespace. |
|
3486 | 3486 | """ |
|
3487 | 3487 | ns = self.user_ns.copy() |
|
3488 | 3488 | try: |
|
3489 | 3489 | frame = sys._getframe(depth+1) |
|
3490 | 3490 | except ValueError: |
|
3491 | 3491 | # This is thrown if there aren't that many frames on the stack, |
|
3492 | 3492 | # e.g. if a script called run_line_magic() directly. |
|
3493 | 3493 | pass |
|
3494 | 3494 | else: |
|
3495 | 3495 | ns.update(frame.f_locals) |
|
3496 | 3496 | |
|
3497 | 3497 | try: |
|
3498 | 3498 | # We have to use .vformat() here, because 'self' is a valid and common |
|
3499 | 3499 | # name, and expanding **ns for .format() would make it collide with |
|
3500 | 3500 | # the 'self' argument of the method. |
|
3501 | 3501 | cmd = formatter.vformat(cmd, args=[], kwargs=ns) |
|
3502 | 3502 | except Exception: |
|
3503 | 3503 | # if formatter couldn't format, just let it go untransformed |
|
3504 | 3504 | pass |
|
3505 | 3505 | return cmd |
|
3506 | 3506 | |
|
3507 | 3507 | def mktempfile(self, data=None, prefix='ipython_edit_'): |
|
3508 | 3508 | """Make a new tempfile and return its filename. |
|
3509 | 3509 | |
|
3510 | 3510 | This makes a call to tempfile.mkstemp (created in a tempfile.mkdtemp), |
|
3511 | 3511 | but it registers the created filename internally so ipython cleans it up |
|
3512 | 3512 | at exit time. |
|
3513 | 3513 | |
|
3514 | 3514 | Optional inputs: |
|
3515 | 3515 | |
|
3516 | 3516 | - data(None): if data is given, it gets written out to the temp file |
|
3517 | 3517 | immediately, and the file is closed again.""" |
|
3518 | 3518 | |
|
3519 | 3519 | dirname = tempfile.mkdtemp(prefix=prefix) |
|
3520 | 3520 | self.tempdirs.append(dirname) |
|
3521 | 3521 | |
|
3522 | 3522 | handle, filename = tempfile.mkstemp('.py', prefix, dir=dirname) |
|
3523 | 3523 | os.close(handle) # On Windows, there can only be one open handle on a file |
|
3524 | 3524 | self.tempfiles.append(filename) |
|
3525 | 3525 | |
|
3526 | 3526 | if data: |
|
3527 | 3527 | with open(filename, 'w') as tmp_file: |
|
3528 | 3528 | tmp_file.write(data) |
|
3529 | 3529 | return filename |
|
3530 | 3530 | |
|
3531 | 3531 | @undoc |
|
3532 | 3532 | def write(self,data): |
|
3533 | 3533 | """DEPRECATED: Write a string to the default output""" |
|
3534 | 3534 | warn('InteractiveShell.write() is deprecated, use sys.stdout instead', |
|
3535 | 3535 | DeprecationWarning, stacklevel=2) |
|
3536 | 3536 | sys.stdout.write(data) |
|
3537 | 3537 | |
|
3538 | 3538 | @undoc |
|
3539 | 3539 | def write_err(self,data): |
|
3540 | 3540 | """DEPRECATED: Write a string to the default error output""" |
|
3541 | 3541 | warn('InteractiveShell.write_err() is deprecated, use sys.stderr instead', |
|
3542 | 3542 | DeprecationWarning, stacklevel=2) |
|
3543 | 3543 | sys.stderr.write(data) |
|
3544 | 3544 | |
|
3545 | 3545 | def ask_yes_no(self, prompt, default=None, interrupt=None): |
|
3546 | 3546 | if self.quiet: |
|
3547 | 3547 | return True |
|
3548 | 3548 | return ask_yes_no(prompt,default,interrupt) |
|
3549 | 3549 | |
|
3550 | 3550 | def show_usage(self): |
|
3551 | 3551 | """Show a usage message""" |
|
3552 | 3552 | page.page(IPython.core.usage.interactive_usage) |
|
3553 | 3553 | |
|
3554 | 3554 | def extract_input_lines(self, range_str, raw=False): |
|
3555 | 3555 | """Return as a string a set of input history slices. |
|
3556 | 3556 | |
|
3557 | 3557 | Parameters |
|
3558 | 3558 | ---------- |
|
3559 | 3559 | range_str : string |
|
3560 | 3560 | The set of slices is given as a string, like "~5/6-~4/2 4:8 9", |
|
3561 | 3561 | since this function is for use by magic functions which get their |
|
3562 | 3562 | arguments as strings. The number before the / is the session |
|
3563 | 3563 | number: ~n goes n back from the current session. |
|
3564 | 3564 | |
|
3565 | 3565 | raw : bool, optional |
|
3566 | 3566 | By default, the processed input is used. If this is true, the raw |
|
3567 | 3567 | input history is used instead. |
|
3568 | 3568 | |
|
3569 | 3569 | Notes |
|
3570 | 3570 | ----- |
|
3571 | 3571 | |
|
3572 | 3572 | Slices can be described with two notations: |
|
3573 | 3573 | |
|
3574 | 3574 | * ``N:M`` -> standard python form, means including items N...(M-1). |
|
3575 | 3575 | * ``N-M`` -> include items N..M (closed endpoint). |
|
3576 | 3576 | """ |
|
3577 | 3577 | lines = self.history_manager.get_range_by_str(range_str, raw=raw) |
|
3578 | 3578 | return "\n".join(x for _, _, x in lines) |
|
3579 | 3579 | |
|
3580 | 3580 | def find_user_code(self, target, raw=True, py_only=False, skip_encoding_cookie=True, search_ns=False): |
|
3581 | 3581 | """Get a code string from history, file, url, or a string or macro. |
|
3582 | 3582 | |
|
3583 | 3583 | This is mainly used by magic functions. |
|
3584 | 3584 | |
|
3585 | 3585 | Parameters |
|
3586 | 3586 | ---------- |
|
3587 | 3587 | |
|
3588 | 3588 | target : str |
|
3589 | 3589 | |
|
3590 | 3590 | A string specifying code to retrieve. This will be tried respectively |
|
3591 | 3591 | as: ranges of input history (see %history for syntax), url, |
|
3592 | 3592 | corresponding .py file, filename, or an expression evaluating to a |
|
3593 | 3593 | string or Macro in the user namespace. |
|
3594 | 3594 | |
|
3595 | 3595 | raw : bool |
|
3596 | 3596 | If true (default), retrieve raw history. Has no effect on the other |
|
3597 | 3597 | retrieval mechanisms. |
|
3598 | 3598 | |
|
3599 | 3599 | py_only : bool (default False) |
|
3600 | 3600 | Only try to fetch python code, do not try alternative methods to decode file |
|
3601 | 3601 | if unicode fails. |
|
3602 | 3602 | |
|
3603 | 3603 | Returns |
|
3604 | 3604 | ------- |
|
3605 | 3605 | A string of code. |
|
3606 | 3606 | |
|
3607 | 3607 | ValueError is raised if nothing is found, and TypeError if it evaluates |
|
3608 | 3608 | to an object of another type. In each case, .args[0] is a printable |
|
3609 | 3609 | message. |
|
3610 | 3610 | """ |
|
3611 | 3611 | code = self.extract_input_lines(target, raw=raw) # Grab history |
|
3612 | 3612 | if code: |
|
3613 | 3613 | return code |
|
3614 | 3614 | try: |
|
3615 | 3615 | if target.startswith(('http://', 'https://')): |
|
3616 | 3616 | return openpy.read_py_url(target, skip_encoding_cookie=skip_encoding_cookie) |
|
3617 | except UnicodeDecodeError: | |
|
3617 | except UnicodeDecodeError as e: | |
|
3618 | 3618 | if not py_only : |
|
3619 | 3619 | # Deferred import |
|
3620 | 3620 | from urllib.request import urlopen |
|
3621 | 3621 | response = urlopen(target) |
|
3622 | 3622 | return response.read().decode('latin1') |
|
3623 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
|
3623 | raise ValueError(("'%s' seem to be unreadable.") % target) from e | |
|
3624 | 3624 | |
|
3625 | 3625 | potential_target = [target] |
|
3626 | 3626 | try : |
|
3627 | 3627 | potential_target.insert(0,get_py_filename(target)) |
|
3628 | 3628 | except IOError: |
|
3629 | 3629 | pass |
|
3630 | 3630 | |
|
3631 | 3631 | for tgt in potential_target : |
|
3632 | 3632 | if os.path.isfile(tgt): # Read file |
|
3633 | 3633 | try : |
|
3634 | 3634 | return openpy.read_py_file(tgt, skip_encoding_cookie=skip_encoding_cookie) |
|
3635 | except UnicodeDecodeError : | |
|
3635 | except UnicodeDecodeError as e: | |
|
3636 | 3636 | if not py_only : |
|
3637 | 3637 | with io_open(tgt,'r', encoding='latin1') as f : |
|
3638 | 3638 | return f.read() |
|
3639 | raise ValueError(("'%s' seem to be unreadable.") % target) | |
|
3639 | raise ValueError(("'%s' seem to be unreadable.") % target) from e | |
|
3640 | 3640 | elif os.path.isdir(os.path.expanduser(tgt)): |
|
3641 | 3641 | raise ValueError("'%s' is a directory, not a regular file." % target) |
|
3642 | 3642 | |
|
3643 | 3643 | if search_ns: |
|
3644 | 3644 | # Inspect namespace to load object source |
|
3645 | 3645 | object_info = self.object_inspect(target, detail_level=1) |
|
3646 | 3646 | if object_info['found'] and object_info['source']: |
|
3647 | 3647 | return object_info['source'] |
|
3648 | 3648 | |
|
3649 | 3649 | try: # User namespace |
|
3650 | 3650 | codeobj = eval(target, self.user_ns) |
|
3651 | except Exception: | |
|
3651 | except Exception as e: | |
|
3652 | 3652 | raise ValueError(("'%s' was not found in history, as a file, url, " |
|
3653 | "nor in the user namespace.") % target) | |
|
3653 | "nor in the user namespace.") % target) from e | |
|
3654 | 3654 | |
|
3655 | 3655 | if isinstance(codeobj, str): |
|
3656 | 3656 | return codeobj |
|
3657 | 3657 | elif isinstance(codeobj, Macro): |
|
3658 | 3658 | return codeobj.value |
|
3659 | 3659 | |
|
3660 | 3660 | raise TypeError("%s is neither a string nor a macro." % target, |
|
3661 | 3661 | codeobj) |
|
3662 | 3662 | |
|
3663 | 3663 | #------------------------------------------------------------------------- |
|
3664 | 3664 | # Things related to IPython exiting |
|
3665 | 3665 | #------------------------------------------------------------------------- |
|
3666 | 3666 | def atexit_operations(self): |
|
3667 | 3667 | """This will be executed at the time of exit. |
|
3668 | 3668 | |
|
3669 | 3669 | Cleanup operations and saving of persistent data that is done |
|
3670 | 3670 | unconditionally by IPython should be performed here. |
|
3671 | 3671 | |
|
3672 | 3672 | For things that may depend on startup flags or platform specifics (such |
|
3673 | 3673 | as having readline or not), register a separate atexit function in the |
|
3674 | 3674 | code that has the appropriate information, rather than trying to |
|
3675 | 3675 | clutter |
|
3676 | 3676 | """ |
|
3677 | 3677 | # Close the history session (this stores the end time and line count) |
|
3678 | 3678 | # this must be *before* the tempfile cleanup, in case of temporary |
|
3679 | 3679 | # history db |
|
3680 | 3680 | self.history_manager.end_session() |
|
3681 | 3681 | |
|
3682 | 3682 | # Cleanup all tempfiles and folders left around |
|
3683 | 3683 | for tfile in self.tempfiles: |
|
3684 | 3684 | try: |
|
3685 | 3685 | os.unlink(tfile) |
|
3686 | 3686 | except OSError: |
|
3687 | 3687 | pass |
|
3688 | 3688 | |
|
3689 | 3689 | for tdir in self.tempdirs: |
|
3690 | 3690 | try: |
|
3691 | 3691 | os.rmdir(tdir) |
|
3692 | 3692 | except OSError: |
|
3693 | 3693 | pass |
|
3694 | 3694 | |
|
3695 | 3695 | # Clear all user namespaces to release all references cleanly. |
|
3696 | 3696 | self.reset(new_session=False) |
|
3697 | 3697 | |
|
3698 | 3698 | # Run user hooks |
|
3699 | 3699 | self.hooks.shutdown_hook() |
|
3700 | 3700 | |
|
3701 | 3701 | def cleanup(self): |
|
3702 | 3702 | self.restore_sys_module_state() |
|
3703 | 3703 | |
|
3704 | 3704 | |
|
3705 | 3705 | # Overridden in terminal subclass to change prompts |
|
3706 | 3706 | def switch_doctest_mode(self, mode): |
|
3707 | 3707 | pass |
|
3708 | 3708 | |
|
3709 | 3709 | |
|
3710 | 3710 | class InteractiveShellABC(metaclass=abc.ABCMeta): |
|
3711 | 3711 | """An abstract base class for InteractiveShell.""" |
|
3712 | 3712 | |
|
3713 | 3713 | InteractiveShellABC.register(InteractiveShell) |
@@ -1,703 +1,703 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """Magic functions for InteractiveShell. |
|
3 | 3 | """ |
|
4 | 4 | |
|
5 | 5 | #----------------------------------------------------------------------------- |
|
6 | 6 | # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and |
|
7 | 7 | # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu> |
|
8 | 8 | # Copyright (C) 2008 The IPython Development Team |
|
9 | 9 | |
|
10 | 10 | # Distributed under the terms of the BSD License. The full license is in |
|
11 | 11 | # the file COPYING, distributed as part of this software. |
|
12 | 12 | #----------------------------------------------------------------------------- |
|
13 | 13 | |
|
14 | 14 | import os |
|
15 | 15 | import re |
|
16 | 16 | import sys |
|
17 | 17 | from getopt import getopt, GetoptError |
|
18 | 18 | |
|
19 | 19 | from traitlets.config.configurable import Configurable |
|
20 | 20 | from . import oinspect |
|
21 | 21 | from .error import UsageError |
|
22 | 22 | from .inputtransformer2 import ESC_MAGIC, ESC_MAGIC2 |
|
23 | 23 | from decorator import decorator |
|
24 | 24 | from ..utils.ipstruct import Struct |
|
25 | 25 | from ..utils.process import arg_split |
|
26 | 26 | from ..utils.text import dedent |
|
27 | 27 | from traitlets import Bool, Dict, Instance, observe |
|
28 | 28 | from logging import error |
|
29 | 29 | |
|
30 | 30 | #----------------------------------------------------------------------------- |
|
31 | 31 | # Globals |
|
32 | 32 | #----------------------------------------------------------------------------- |
|
33 | 33 | |
|
34 | 34 | # A dict we'll use for each class that has magics, used as temporary storage to |
|
35 | 35 | # pass information between the @line/cell_magic method decorators and the |
|
36 | 36 | # @magics_class class decorator, because the method decorators have no |
|
37 | 37 | # access to the class when they run. See for more details: |
|
38 | 38 | # http://stackoverflow.com/questions/2366713/can-a-python-decorator-of-an-instance-method-access-the-class |
|
39 | 39 | |
|
40 | 40 | magics = dict(line={}, cell={}) |
|
41 | 41 | |
|
42 | 42 | magic_kinds = ('line', 'cell') |
|
43 | 43 | magic_spec = ('line', 'cell', 'line_cell') |
|
44 | 44 | magic_escapes = dict(line=ESC_MAGIC, cell=ESC_MAGIC2) |
|
45 | 45 | |
|
46 | 46 | #----------------------------------------------------------------------------- |
|
47 | 47 | # Utility classes and functions |
|
48 | 48 | #----------------------------------------------------------------------------- |
|
49 | 49 | |
|
50 | 50 | class Bunch: pass |
|
51 | 51 | |
|
52 | 52 | |
|
53 | 53 | def on_off(tag): |
|
54 | 54 | """Return an ON/OFF string for a 1/0 input. Simple utility function.""" |
|
55 | 55 | return ['OFF','ON'][tag] |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | def compress_dhist(dh): |
|
59 | 59 | """Compress a directory history into a new one with at most 20 entries. |
|
60 | 60 | |
|
61 | 61 | Return a new list made from the first and last 10 elements of dhist after |
|
62 | 62 | removal of duplicates. |
|
63 | 63 | """ |
|
64 | 64 | head, tail = dh[:-10], dh[-10:] |
|
65 | 65 | |
|
66 | 66 | newhead = [] |
|
67 | 67 | done = set() |
|
68 | 68 | for h in head: |
|
69 | 69 | if h in done: |
|
70 | 70 | continue |
|
71 | 71 | newhead.append(h) |
|
72 | 72 | done.add(h) |
|
73 | 73 | |
|
74 | 74 | return newhead + tail |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | def needs_local_scope(func): |
|
78 | 78 | """Decorator to mark magic functions which need to local scope to run.""" |
|
79 | 79 | func.needs_local_scope = True |
|
80 | 80 | return func |
|
81 | 81 | |
|
82 | 82 | #----------------------------------------------------------------------------- |
|
83 | 83 | # Class and method decorators for registering magics |
|
84 | 84 | #----------------------------------------------------------------------------- |
|
85 | 85 | |
|
86 | 86 | def magics_class(cls): |
|
87 | 87 | """Class decorator for all subclasses of the main Magics class. |
|
88 | 88 | |
|
89 | 89 | Any class that subclasses Magics *must* also apply this decorator, to |
|
90 | 90 | ensure that all the methods that have been decorated as line/cell magics |
|
91 | 91 | get correctly registered in the class instance. This is necessary because |
|
92 | 92 | when method decorators run, the class does not exist yet, so they |
|
93 | 93 | temporarily store their information into a module global. Application of |
|
94 | 94 | this class decorator copies that global data to the class instance and |
|
95 | 95 | clears the global. |
|
96 | 96 | |
|
97 | 97 | Obviously, this mechanism is not thread-safe, which means that the |
|
98 | 98 | *creation* of subclasses of Magic should only be done in a single-thread |
|
99 | 99 | context. Instantiation of the classes has no restrictions. Given that |
|
100 | 100 | these classes are typically created at IPython startup time and before user |
|
101 | 101 | application code becomes active, in practice this should not pose any |
|
102 | 102 | problems. |
|
103 | 103 | """ |
|
104 | 104 | cls.registered = True |
|
105 | 105 | cls.magics = dict(line = magics['line'], |
|
106 | 106 | cell = magics['cell']) |
|
107 | 107 | magics['line'] = {} |
|
108 | 108 | magics['cell'] = {} |
|
109 | 109 | return cls |
|
110 | 110 | |
|
111 | 111 | |
|
112 | 112 | def record_magic(dct, magic_kind, magic_name, func): |
|
113 | 113 | """Utility function to store a function as a magic of a specific kind. |
|
114 | 114 | |
|
115 | 115 | Parameters |
|
116 | 116 | ---------- |
|
117 | 117 | dct : dict |
|
118 | 118 | A dictionary with 'line' and 'cell' subdicts. |
|
119 | 119 | |
|
120 | 120 | magic_kind : str |
|
121 | 121 | Kind of magic to be stored. |
|
122 | 122 | |
|
123 | 123 | magic_name : str |
|
124 | 124 | Key to store the magic as. |
|
125 | 125 | |
|
126 | 126 | func : function |
|
127 | 127 | Callable object to store. |
|
128 | 128 | """ |
|
129 | 129 | if magic_kind == 'line_cell': |
|
130 | 130 | dct['line'][magic_name] = dct['cell'][magic_name] = func |
|
131 | 131 | else: |
|
132 | 132 | dct[magic_kind][magic_name] = func |
|
133 | 133 | |
|
134 | 134 | |
|
135 | 135 | def validate_type(magic_kind): |
|
136 | 136 | """Ensure that the given magic_kind is valid. |
|
137 | 137 | |
|
138 | 138 | Check that the given magic_kind is one of the accepted spec types (stored |
|
139 | 139 | in the global `magic_spec`), raise ValueError otherwise. |
|
140 | 140 | """ |
|
141 | 141 | if magic_kind not in magic_spec: |
|
142 | 142 | raise ValueError('magic_kind must be one of %s, %s given' % |
|
143 | 143 | magic_kinds, magic_kind) |
|
144 | 144 | |
|
145 | 145 | |
|
146 | 146 | # The docstrings for the decorator below will be fairly similar for the two |
|
147 | 147 | # types (method and function), so we generate them here once and reuse the |
|
148 | 148 | # templates below. |
|
149 | 149 | _docstring_template = \ |
|
150 | 150 | """Decorate the given {0} as {1} magic. |
|
151 | 151 | |
|
152 | 152 | The decorator can be used with or without arguments, as follows. |
|
153 | 153 | |
|
154 | 154 | i) without arguments: it will create a {1} magic named as the {0} being |
|
155 | 155 | decorated:: |
|
156 | 156 | |
|
157 | 157 | @deco |
|
158 | 158 | def foo(...) |
|
159 | 159 | |
|
160 | 160 | will create a {1} magic named `foo`. |
|
161 | 161 | |
|
162 | 162 | ii) with one string argument: which will be used as the actual name of the |
|
163 | 163 | resulting magic:: |
|
164 | 164 | |
|
165 | 165 | @deco('bar') |
|
166 | 166 | def foo(...) |
|
167 | 167 | |
|
168 | 168 | will create a {1} magic named `bar`. |
|
169 | 169 | |
|
170 | 170 | To register a class magic use ``Interactiveshell.register_magic(class or instance)``. |
|
171 | 171 | """ |
|
172 | 172 | |
|
173 | 173 | # These two are decorator factories. While they are conceptually very similar, |
|
174 | 174 | # there are enough differences in the details that it's simpler to have them |
|
175 | 175 | # written as completely standalone functions rather than trying to share code |
|
176 | 176 | # and make a single one with convoluted logic. |
|
177 | 177 | |
|
178 | 178 | def _method_magic_marker(magic_kind): |
|
179 | 179 | """Decorator factory for methods in Magics subclasses. |
|
180 | 180 | """ |
|
181 | 181 | |
|
182 | 182 | validate_type(magic_kind) |
|
183 | 183 | |
|
184 | 184 | # This is a closure to capture the magic_kind. We could also use a class, |
|
185 | 185 | # but it's overkill for just that one bit of state. |
|
186 | 186 | def magic_deco(arg): |
|
187 | 187 | call = lambda f, *a, **k: f(*a, **k) |
|
188 | 188 | |
|
189 | 189 | if callable(arg): |
|
190 | 190 | # "Naked" decorator call (just @foo, no args) |
|
191 | 191 | func = arg |
|
192 | 192 | name = func.__name__ |
|
193 | 193 | retval = decorator(call, func) |
|
194 | 194 | record_magic(magics, magic_kind, name, name) |
|
195 | 195 | elif isinstance(arg, str): |
|
196 | 196 | # Decorator called with arguments (@foo('bar')) |
|
197 | 197 | name = arg |
|
198 | 198 | def mark(func, *a, **kw): |
|
199 | 199 | record_magic(magics, magic_kind, name, func.__name__) |
|
200 | 200 | return decorator(call, func) |
|
201 | 201 | retval = mark |
|
202 | 202 | else: |
|
203 | 203 | raise TypeError("Decorator can only be called with " |
|
204 | 204 | "string or function") |
|
205 | 205 | return retval |
|
206 | 206 | |
|
207 | 207 | # Ensure the resulting decorator has a usable docstring |
|
208 | 208 | magic_deco.__doc__ = _docstring_template.format('method', magic_kind) |
|
209 | 209 | return magic_deco |
|
210 | 210 | |
|
211 | 211 | |
|
212 | 212 | def _function_magic_marker(magic_kind): |
|
213 | 213 | """Decorator factory for standalone functions. |
|
214 | 214 | """ |
|
215 | 215 | validate_type(magic_kind) |
|
216 | 216 | |
|
217 | 217 | # This is a closure to capture the magic_kind. We could also use a class, |
|
218 | 218 | # but it's overkill for just that one bit of state. |
|
219 | 219 | def magic_deco(arg): |
|
220 | 220 | call = lambda f, *a, **k: f(*a, **k) |
|
221 | 221 | |
|
222 | 222 | # Find get_ipython() in the caller's namespace |
|
223 | 223 | caller = sys._getframe(1) |
|
224 | 224 | for ns in ['f_locals', 'f_globals', 'f_builtins']: |
|
225 | 225 | get_ipython = getattr(caller, ns).get('get_ipython') |
|
226 | 226 | if get_ipython is not None: |
|
227 | 227 | break |
|
228 | 228 | else: |
|
229 | 229 | raise NameError('Decorator can only run in context where ' |
|
230 | 230 | '`get_ipython` exists') |
|
231 | 231 | |
|
232 | 232 | ip = get_ipython() |
|
233 | 233 | |
|
234 | 234 | if callable(arg): |
|
235 | 235 | # "Naked" decorator call (just @foo, no args) |
|
236 | 236 | func = arg |
|
237 | 237 | name = func.__name__ |
|
238 | 238 | ip.register_magic_function(func, magic_kind, name) |
|
239 | 239 | retval = decorator(call, func) |
|
240 | 240 | elif isinstance(arg, str): |
|
241 | 241 | # Decorator called with arguments (@foo('bar')) |
|
242 | 242 | name = arg |
|
243 | 243 | def mark(func, *a, **kw): |
|
244 | 244 | ip.register_magic_function(func, magic_kind, name) |
|
245 | 245 | return decorator(call, func) |
|
246 | 246 | retval = mark |
|
247 | 247 | else: |
|
248 | 248 | raise TypeError("Decorator can only be called with " |
|
249 | 249 | "string or function") |
|
250 | 250 | return retval |
|
251 | 251 | |
|
252 | 252 | # Ensure the resulting decorator has a usable docstring |
|
253 | 253 | ds = _docstring_template.format('function', magic_kind) |
|
254 | 254 | |
|
255 | 255 | ds += dedent(""" |
|
256 | 256 | Note: this decorator can only be used in a context where IPython is already |
|
257 | 257 | active, so that the `get_ipython()` call succeeds. You can therefore use |
|
258 | 258 | it in your startup files loaded after IPython initializes, but *not* in the |
|
259 | 259 | IPython configuration file itself, which is executed before IPython is |
|
260 | 260 | fully up and running. Any file located in the `startup` subdirectory of |
|
261 | 261 | your configuration profile will be OK in this sense. |
|
262 | 262 | """) |
|
263 | 263 | |
|
264 | 264 | magic_deco.__doc__ = ds |
|
265 | 265 | return magic_deco |
|
266 | 266 | |
|
267 | 267 | |
|
268 | 268 | MAGIC_NO_VAR_EXPAND_ATTR = '_ipython_magic_no_var_expand' |
|
269 | 269 | |
|
270 | 270 | |
|
271 | 271 | def no_var_expand(magic_func): |
|
272 | 272 | """Mark a magic function as not needing variable expansion |
|
273 | 273 | |
|
274 | 274 | By default, IPython interprets `{a}` or `$a` in the line passed to magics |
|
275 | 275 | as variables that should be interpolated from the interactive namespace |
|
276 | 276 | before passing the line to the magic function. |
|
277 | 277 | This is not always desirable, e.g. when the magic executes Python code |
|
278 | 278 | (%timeit, %time, etc.). |
|
279 | 279 | Decorate magics with `@no_var_expand` to opt-out of variable expansion. |
|
280 | 280 | |
|
281 | 281 | .. versionadded:: 7.3 |
|
282 | 282 | """ |
|
283 | 283 | setattr(magic_func, MAGIC_NO_VAR_EXPAND_ATTR, True) |
|
284 | 284 | return magic_func |
|
285 | 285 | |
|
286 | 286 | |
|
287 | 287 | # Create the actual decorators for public use |
|
288 | 288 | |
|
289 | 289 | # These three are used to decorate methods in class definitions |
|
290 | 290 | line_magic = _method_magic_marker('line') |
|
291 | 291 | cell_magic = _method_magic_marker('cell') |
|
292 | 292 | line_cell_magic = _method_magic_marker('line_cell') |
|
293 | 293 | |
|
294 | 294 | # These three decorate standalone functions and perform the decoration |
|
295 | 295 | # immediately. They can only run where get_ipython() works |
|
296 | 296 | register_line_magic = _function_magic_marker('line') |
|
297 | 297 | register_cell_magic = _function_magic_marker('cell') |
|
298 | 298 | register_line_cell_magic = _function_magic_marker('line_cell') |
|
299 | 299 | |
|
300 | 300 | #----------------------------------------------------------------------------- |
|
301 | 301 | # Core Magic classes |
|
302 | 302 | #----------------------------------------------------------------------------- |
|
303 | 303 | |
|
304 | 304 | class MagicsManager(Configurable): |
|
305 | 305 | """Object that handles all magic-related functionality for IPython. |
|
306 | 306 | """ |
|
307 | 307 | # Non-configurable class attributes |
|
308 | 308 | |
|
309 | 309 | # A two-level dict, first keyed by magic type, then by magic function, and |
|
310 | 310 | # holding the actual callable object as value. This is the dict used for |
|
311 | 311 | # magic function dispatch |
|
312 | 312 | magics = Dict() |
|
313 | 313 | |
|
314 | 314 | # A registry of the original objects that we've been given holding magics. |
|
315 | 315 | registry = Dict() |
|
316 | 316 | |
|
317 | 317 | shell = Instance('IPython.core.interactiveshell.InteractiveShellABC', allow_none=True) |
|
318 | 318 | |
|
319 | 319 | auto_magic = Bool(True, help= |
|
320 | 320 | "Automatically call line magics without requiring explicit % prefix" |
|
321 | 321 | ).tag(config=True) |
|
322 | 322 | @observe('auto_magic') |
|
323 | 323 | def _auto_magic_changed(self, change): |
|
324 | 324 | self.shell.automagic = change['new'] |
|
325 | 325 | |
|
326 | 326 | _auto_status = [ |
|
327 | 327 | 'Automagic is OFF, % prefix IS needed for line magics.', |
|
328 | 328 | 'Automagic is ON, % prefix IS NOT needed for line magics.'] |
|
329 | 329 | |
|
330 | 330 | user_magics = Instance('IPython.core.magics.UserMagics', allow_none=True) |
|
331 | 331 | |
|
332 | 332 | def __init__(self, shell=None, config=None, user_magics=None, **traits): |
|
333 | 333 | |
|
334 | 334 | super(MagicsManager, self).__init__(shell=shell, config=config, |
|
335 | 335 | user_magics=user_magics, **traits) |
|
336 | 336 | self.magics = dict(line={}, cell={}) |
|
337 | 337 | # Let's add the user_magics to the registry for uniformity, so *all* |
|
338 | 338 | # registered magic containers can be found there. |
|
339 | 339 | self.registry[user_magics.__class__.__name__] = user_magics |
|
340 | 340 | |
|
341 | 341 | def auto_status(self): |
|
342 | 342 | """Return descriptive string with automagic status.""" |
|
343 | 343 | return self._auto_status[self.auto_magic] |
|
344 | 344 | |
|
345 | 345 | def lsmagic(self): |
|
346 | 346 | """Return a dict of currently available magic functions. |
|
347 | 347 | |
|
348 | 348 | The return dict has the keys 'line' and 'cell', corresponding to the |
|
349 | 349 | two types of magics we support. Each value is a list of names. |
|
350 | 350 | """ |
|
351 | 351 | return self.magics |
|
352 | 352 | |
|
353 | 353 | def lsmagic_docs(self, brief=False, missing=''): |
|
354 | 354 | """Return dict of documentation of magic functions. |
|
355 | 355 | |
|
356 | 356 | The return dict has the keys 'line' and 'cell', corresponding to the |
|
357 | 357 | two types of magics we support. Each value is a dict keyed by magic |
|
358 | 358 | name whose value is the function docstring. If a docstring is |
|
359 | 359 | unavailable, the value of `missing` is used instead. |
|
360 | 360 | |
|
361 | 361 | If brief is True, only the first line of each docstring will be returned. |
|
362 | 362 | """ |
|
363 | 363 | docs = {} |
|
364 | 364 | for m_type in self.magics: |
|
365 | 365 | m_docs = {} |
|
366 | 366 | for m_name, m_func in self.magics[m_type].items(): |
|
367 | 367 | if m_func.__doc__: |
|
368 | 368 | if brief: |
|
369 | 369 | m_docs[m_name] = m_func.__doc__.split('\n', 1)[0] |
|
370 | 370 | else: |
|
371 | 371 | m_docs[m_name] = m_func.__doc__.rstrip() |
|
372 | 372 | else: |
|
373 | 373 | m_docs[m_name] = missing |
|
374 | 374 | docs[m_type] = m_docs |
|
375 | 375 | return docs |
|
376 | 376 | |
|
377 | 377 | def register(self, *magic_objects): |
|
378 | 378 | """Register one or more instances of Magics. |
|
379 | 379 | |
|
380 | 380 | Take one or more classes or instances of classes that subclass the main |
|
381 | 381 | `core.Magic` class, and register them with IPython to use the magic |
|
382 | 382 | functions they provide. The registration process will then ensure that |
|
383 | 383 | any methods that have decorated to provide line and/or cell magics will |
|
384 | 384 | be recognized with the `%x`/`%%x` syntax as a line/cell magic |
|
385 | 385 | respectively. |
|
386 | 386 | |
|
387 | 387 | If classes are given, they will be instantiated with the default |
|
388 | 388 | constructor. If your classes need a custom constructor, you should |
|
389 | 389 | instanitate them first and pass the instance. |
|
390 | 390 | |
|
391 | 391 | The provided arguments can be an arbitrary mix of classes and instances. |
|
392 | 392 | |
|
393 | 393 | Parameters |
|
394 | 394 | ---------- |
|
395 | 395 | magic_objects : one or more classes or instances |
|
396 | 396 | """ |
|
397 | 397 | # Start by validating them to ensure they have all had their magic |
|
398 | 398 | # methods registered at the instance level |
|
399 | 399 | for m in magic_objects: |
|
400 | 400 | if not m.registered: |
|
401 | 401 | raise ValueError("Class of magics %r was constructed without " |
|
402 | 402 | "the @register_magics class decorator") |
|
403 | 403 | if isinstance(m, type): |
|
404 | 404 | # If we're given an uninstantiated class |
|
405 | 405 | m = m(shell=self.shell) |
|
406 | 406 | |
|
407 | 407 | # Now that we have an instance, we can register it and update the |
|
408 | 408 | # table of callables |
|
409 | 409 | self.registry[m.__class__.__name__] = m |
|
410 | 410 | for mtype in magic_kinds: |
|
411 | 411 | self.magics[mtype].update(m.magics[mtype]) |
|
412 | 412 | |
|
413 | 413 | def register_function(self, func, magic_kind='line', magic_name=None): |
|
414 | 414 | """Expose a standalone function as magic function for IPython. |
|
415 | 415 | |
|
416 | 416 | This will create an IPython magic (line, cell or both) from a |
|
417 | 417 | standalone function. The functions should have the following |
|
418 | 418 | signatures: |
|
419 | 419 | |
|
420 | 420 | * For line magics: `def f(line)` |
|
421 | 421 | * For cell magics: `def f(line, cell)` |
|
422 | 422 | * For a function that does both: `def f(line, cell=None)` |
|
423 | 423 | |
|
424 | 424 | In the latter case, the function will be called with `cell==None` when |
|
425 | 425 | invoked as `%f`, and with cell as a string when invoked as `%%f`. |
|
426 | 426 | |
|
427 | 427 | Parameters |
|
428 | 428 | ---------- |
|
429 | 429 | func : callable |
|
430 | 430 | Function to be registered as a magic. |
|
431 | 431 | |
|
432 | 432 | magic_kind : str |
|
433 | 433 | Kind of magic, one of 'line', 'cell' or 'line_cell' |
|
434 | 434 | |
|
435 | 435 | magic_name : optional str |
|
436 | 436 | If given, the name the magic will have in the IPython namespace. By |
|
437 | 437 | default, the name of the function itself is used. |
|
438 | 438 | """ |
|
439 | 439 | |
|
440 | 440 | # Create the new method in the user_magics and register it in the |
|
441 | 441 | # global table |
|
442 | 442 | validate_type(magic_kind) |
|
443 | 443 | magic_name = func.__name__ if magic_name is None else magic_name |
|
444 | 444 | setattr(self.user_magics, magic_name, func) |
|
445 | 445 | record_magic(self.magics, magic_kind, magic_name, func) |
|
446 | 446 | |
|
447 | 447 | def register_alias(self, alias_name, magic_name, magic_kind='line', magic_params=None): |
|
448 | 448 | """Register an alias to a magic function. |
|
449 | 449 | |
|
450 | 450 | The alias is an instance of :class:`MagicAlias`, which holds the |
|
451 | 451 | name and kind of the magic it should call. Binding is done at |
|
452 | 452 | call time, so if the underlying magic function is changed the alias |
|
453 | 453 | will call the new function. |
|
454 | 454 | |
|
455 | 455 | Parameters |
|
456 | 456 | ---------- |
|
457 | 457 | alias_name : str |
|
458 | 458 | The name of the magic to be registered. |
|
459 | 459 | |
|
460 | 460 | magic_name : str |
|
461 | 461 | The name of an existing magic. |
|
462 | 462 | |
|
463 | 463 | magic_kind : str |
|
464 | 464 | Kind of magic, one of 'line' or 'cell' |
|
465 | 465 | """ |
|
466 | 466 | |
|
467 | 467 | # `validate_type` is too permissive, as it allows 'line_cell' |
|
468 | 468 | # which we do not handle. |
|
469 | 469 | if magic_kind not in magic_kinds: |
|
470 | 470 | raise ValueError('magic_kind must be one of %s, %s given' % |
|
471 | 471 | magic_kinds, magic_kind) |
|
472 | 472 | |
|
473 | 473 | alias = MagicAlias(self.shell, magic_name, magic_kind, magic_params) |
|
474 | 474 | setattr(self.user_magics, alias_name, alias) |
|
475 | 475 | record_magic(self.magics, magic_kind, alias_name, alias) |
|
476 | 476 | |
|
477 | 477 | # Key base class that provides the central functionality for magics. |
|
478 | 478 | |
|
479 | 479 | |
|
480 | 480 | class Magics(Configurable): |
|
481 | 481 | """Base class for implementing magic functions. |
|
482 | 482 | |
|
483 | 483 | Shell functions which can be reached as %function_name. All magic |
|
484 | 484 | functions should accept a string, which they can parse for their own |
|
485 | 485 | needs. This can make some functions easier to type, eg `%cd ../` |
|
486 | 486 | vs. `%cd("../")` |
|
487 | 487 | |
|
488 | 488 | Classes providing magic functions need to subclass this class, and they |
|
489 | 489 | MUST: |
|
490 | 490 | |
|
491 | 491 | - Use the method decorators `@line_magic` and `@cell_magic` to decorate |
|
492 | 492 | individual methods as magic functions, AND |
|
493 | 493 | |
|
494 | 494 | - Use the class decorator `@magics_class` to ensure that the magic |
|
495 | 495 | methods are properly registered at the instance level upon instance |
|
496 | 496 | initialization. |
|
497 | 497 | |
|
498 | 498 | See :mod:`magic_functions` for examples of actual implementation classes. |
|
499 | 499 | """ |
|
500 | 500 | # Dict holding all command-line options for each magic. |
|
501 | 501 | options_table = None |
|
502 | 502 | # Dict for the mapping of magic names to methods, set by class decorator |
|
503 | 503 | magics = None |
|
504 | 504 | # Flag to check that the class decorator was properly applied |
|
505 | 505 | registered = False |
|
506 | 506 | # Instance of IPython shell |
|
507 | 507 | shell = None |
|
508 | 508 | |
|
509 | 509 | def __init__(self, shell=None, **kwargs): |
|
510 | 510 | if not(self.__class__.registered): |
|
511 | 511 | raise ValueError('Magics subclass without registration - ' |
|
512 | 512 | 'did you forget to apply @magics_class?') |
|
513 | 513 | if shell is not None: |
|
514 | 514 | if hasattr(shell, 'configurables'): |
|
515 | 515 | shell.configurables.append(self) |
|
516 | 516 | if hasattr(shell, 'config'): |
|
517 | 517 | kwargs.setdefault('parent', shell) |
|
518 | 518 | |
|
519 | 519 | self.shell = shell |
|
520 | 520 | self.options_table = {} |
|
521 | 521 | # The method decorators are run when the instance doesn't exist yet, so |
|
522 | 522 | # they can only record the names of the methods they are supposed to |
|
523 | 523 | # grab. Only now, that the instance exists, can we create the proper |
|
524 | 524 | # mapping to bound methods. So we read the info off the original names |
|
525 | 525 | # table and replace each method name by the actual bound method. |
|
526 | 526 | # But we mustn't clobber the *class* mapping, in case of multiple instances. |
|
527 | 527 | class_magics = self.magics |
|
528 | 528 | self.magics = {} |
|
529 | 529 | for mtype in magic_kinds: |
|
530 | 530 | tab = self.magics[mtype] = {} |
|
531 | 531 | cls_tab = class_magics[mtype] |
|
532 | 532 | for magic_name, meth_name in cls_tab.items(): |
|
533 | 533 | if isinstance(meth_name, str): |
|
534 | 534 | # it's a method name, grab it |
|
535 | 535 | tab[magic_name] = getattr(self, meth_name) |
|
536 | 536 | else: |
|
537 | 537 | # it's the real thing |
|
538 | 538 | tab[magic_name] = meth_name |
|
539 | 539 | # Configurable **needs** to be initiated at the end or the config |
|
540 | 540 | # magics get screwed up. |
|
541 | 541 | super(Magics, self).__init__(**kwargs) |
|
542 | 542 | |
|
543 | 543 | def arg_err(self,func): |
|
544 | 544 | """Print docstring if incorrect arguments were passed""" |
|
545 | 545 | print('Error in arguments:') |
|
546 | 546 | print(oinspect.getdoc(func)) |
|
547 | 547 | |
|
548 | 548 | def format_latex(self, strng): |
|
549 | 549 | """Format a string for latex inclusion.""" |
|
550 | 550 | |
|
551 | 551 | # Characters that need to be escaped for latex: |
|
552 | 552 | escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE) |
|
553 | 553 | # Magic command names as headers: |
|
554 | 554 | cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC, |
|
555 | 555 | re.MULTILINE) |
|
556 | 556 | # Magic commands |
|
557 | 557 | cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC, |
|
558 | 558 | re.MULTILINE) |
|
559 | 559 | # Paragraph continue |
|
560 | 560 | par_re = re.compile(r'\\$',re.MULTILINE) |
|
561 | 561 | |
|
562 | 562 | # The "\n" symbol |
|
563 | 563 | newline_re = re.compile(r'\\n') |
|
564 | 564 | |
|
565 | 565 | # Now build the string for output: |
|
566 | 566 | #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng) |
|
567 | 567 | strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:', |
|
568 | 568 | strng) |
|
569 | 569 | strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng) |
|
570 | 570 | strng = par_re.sub(r'\\\\',strng) |
|
571 | 571 | strng = escape_re.sub(r'\\\1',strng) |
|
572 | 572 | strng = newline_re.sub(r'\\textbackslash{}n',strng) |
|
573 | 573 | return strng |
|
574 | 574 | |
|
575 | 575 | def parse_options(self, arg_str, opt_str, *long_opts, **kw): |
|
576 | 576 | """Parse options passed to an argument string. |
|
577 | 577 | |
|
578 | 578 | The interface is similar to that of :func:`getopt.getopt`, but it |
|
579 | 579 | returns a :class:`~IPython.utils.struct.Struct` with the options as keys |
|
580 | 580 | and the stripped argument string still as a string. |
|
581 | 581 | |
|
582 | 582 | arg_str is quoted as a true sys.argv vector by using shlex.split. |
|
583 | 583 | This allows us to easily expand variables, glob files, quote |
|
584 | 584 | arguments, etc. |
|
585 | 585 | |
|
586 | 586 | Parameters |
|
587 | 587 | ---------- |
|
588 | 588 | |
|
589 | 589 | arg_str : str |
|
590 | 590 | The arguments to parse. |
|
591 | 591 | |
|
592 | 592 | opt_str : str |
|
593 | 593 | The options specification. |
|
594 | 594 | |
|
595 | 595 | mode : str, default 'string' |
|
596 | 596 | If given as 'list', the argument string is returned as a list (split |
|
597 | 597 | on whitespace) instead of a string. |
|
598 | 598 | |
|
599 | 599 | list_all : bool, default False |
|
600 | 600 | Put all option values in lists. Normally only options |
|
601 | 601 | appearing more than once are put in a list. |
|
602 | 602 | |
|
603 | 603 | posix : bool, default True |
|
604 | 604 | Whether to split the input line in POSIX mode or not, as per the |
|
605 | 605 | conventions outlined in the :mod:`shlex` module from the standard |
|
606 | 606 | library. |
|
607 | 607 | """ |
|
608 | 608 | |
|
609 | 609 | # inject default options at the beginning of the input line |
|
610 | 610 | caller = sys._getframe(1).f_code.co_name |
|
611 | 611 | arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str) |
|
612 | 612 | |
|
613 | 613 | mode = kw.get('mode','string') |
|
614 | 614 | if mode not in ['string','list']: |
|
615 | 615 | raise ValueError('incorrect mode given: %s' % mode) |
|
616 | 616 | # Get options |
|
617 | 617 | list_all = kw.get('list_all',0) |
|
618 | 618 | posix = kw.get('posix', os.name == 'posix') |
|
619 | 619 | strict = kw.get('strict', True) |
|
620 | 620 | |
|
621 | 621 | # Check if we have more than one argument to warrant extra processing: |
|
622 | 622 | odict = {} # Dictionary with options |
|
623 | 623 | args = arg_str.split() |
|
624 | 624 | if len(args) >= 1: |
|
625 | 625 | # If the list of inputs only has 0 or 1 thing in it, there's no |
|
626 | 626 | # need to look for options |
|
627 | 627 | argv = arg_split(arg_str, posix, strict) |
|
628 | 628 | # Do regular option processing |
|
629 | 629 | try: |
|
630 | 630 | opts,args = getopt(argv, opt_str, long_opts) |
|
631 | 631 | except GetoptError as e: |
|
632 | 632 | raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str, |
|
633 | " ".join(long_opts))) | |
|
633 | " ".join(long_opts))) from e | |
|
634 | 634 | for o,a in opts: |
|
635 | 635 | if o.startswith('--'): |
|
636 | 636 | o = o[2:] |
|
637 | 637 | else: |
|
638 | 638 | o = o[1:] |
|
639 | 639 | try: |
|
640 | 640 | odict[o].append(a) |
|
641 | 641 | except AttributeError: |
|
642 | 642 | odict[o] = [odict[o],a] |
|
643 | 643 | except KeyError: |
|
644 | 644 | if list_all: |
|
645 | 645 | odict[o] = [a] |
|
646 | 646 | else: |
|
647 | 647 | odict[o] = a |
|
648 | 648 | |
|
649 | 649 | # Prepare opts,args for return |
|
650 | 650 | opts = Struct(odict) |
|
651 | 651 | if mode == 'string': |
|
652 | 652 | args = ' '.join(args) |
|
653 | 653 | |
|
654 | 654 | return opts,args |
|
655 | 655 | |
|
656 | 656 | def default_option(self, fn, optstr): |
|
657 | 657 | """Make an entry in the options_table for fn, with value optstr""" |
|
658 | 658 | |
|
659 | 659 | if fn not in self.lsmagic(): |
|
660 | 660 | error("%s is not a magic function" % fn) |
|
661 | 661 | self.options_table[fn] = optstr |
|
662 | 662 | |
|
663 | 663 | |
|
664 | 664 | class MagicAlias(object): |
|
665 | 665 | """An alias to another magic function. |
|
666 | 666 | |
|
667 | 667 | An alias is determined by its magic name and magic kind. Lookup |
|
668 | 668 | is done at call time, so if the underlying magic changes the alias |
|
669 | 669 | will call the new function. |
|
670 | 670 | |
|
671 | 671 | Use the :meth:`MagicsManager.register_alias` method or the |
|
672 | 672 | `%alias_magic` magic function to create and register a new alias. |
|
673 | 673 | """ |
|
674 | 674 | def __init__(self, shell, magic_name, magic_kind, magic_params=None): |
|
675 | 675 | self.shell = shell |
|
676 | 676 | self.magic_name = magic_name |
|
677 | 677 | self.magic_params = magic_params |
|
678 | 678 | self.magic_kind = magic_kind |
|
679 | 679 | |
|
680 | 680 | self.pretty_target = '%s%s' % (magic_escapes[self.magic_kind], self.magic_name) |
|
681 | 681 | self.__doc__ = "Alias for `%s`." % self.pretty_target |
|
682 | 682 | |
|
683 | 683 | self._in_call = False |
|
684 | 684 | |
|
685 | 685 | def __call__(self, *args, **kwargs): |
|
686 | 686 | """Call the magic alias.""" |
|
687 | 687 | fn = self.shell.find_magic(self.magic_name, self.magic_kind) |
|
688 | 688 | if fn is None: |
|
689 | 689 | raise UsageError("Magic `%s` not found." % self.pretty_target) |
|
690 | 690 | |
|
691 | 691 | # Protect against infinite recursion. |
|
692 | 692 | if self._in_call: |
|
693 | 693 | raise UsageError("Infinite recursion detected; " |
|
694 | 694 | "magic aliases cannot call themselves.") |
|
695 | 695 | self._in_call = True |
|
696 | 696 | try: |
|
697 | 697 | if self.magic_params: |
|
698 | 698 | args_list = list(args) |
|
699 | 699 | args_list[0] = self.magic_params + " " + args[0] |
|
700 | 700 | args = tuple(args_list) |
|
701 | 701 | return fn(*args, **kwargs) |
|
702 | 702 | finally: |
|
703 | 703 | self._in_call = False |
@@ -1,730 +1,730 b'' | |||
|
1 | 1 | """Implementation of code management magic functions. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2012 The IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | # Stdlib |
|
16 | 16 | import inspect |
|
17 | 17 | import io |
|
18 | 18 | import os |
|
19 | 19 | import re |
|
20 | 20 | import sys |
|
21 | 21 | import ast |
|
22 | 22 | from itertools import chain |
|
23 | 23 | from urllib.request import urlopen |
|
24 | 24 | from urllib.parse import urlencode |
|
25 | 25 | |
|
26 | 26 | # Our own packages |
|
27 | 27 | from IPython.core.error import TryNext, StdinNotImplementedError, UsageError |
|
28 | 28 | from IPython.core.macro import Macro |
|
29 | 29 | from IPython.core.magic import Magics, magics_class, line_magic |
|
30 | 30 | from IPython.core.oinspect import find_file, find_source_lines |
|
31 | 31 | from IPython.testing.skipdoctest import skip_doctest |
|
32 | 32 | from IPython.utils.contexts import preserve_keys |
|
33 | 33 | from IPython.utils.path import get_py_filename |
|
34 | 34 | from warnings import warn |
|
35 | 35 | from logging import error |
|
36 | 36 | from IPython.utils.text import get_text_list |
|
37 | 37 | |
|
38 | 38 | #----------------------------------------------------------------------------- |
|
39 | 39 | # Magic implementation classes |
|
40 | 40 | #----------------------------------------------------------------------------- |
|
41 | 41 | |
|
42 | 42 | # Used for exception handling in magic_edit |
|
43 | 43 | class MacroToEdit(ValueError): pass |
|
44 | 44 | |
|
45 | 45 | ipython_input_pat = re.compile(r"<ipython\-input\-(\d+)-[a-z\d]+>$") |
|
46 | 46 | |
|
47 | 47 | # To match, e.g. 8-10 1:5 :10 3- |
|
48 | 48 | range_re = re.compile(r""" |
|
49 | 49 | (?P<start>\d+)? |
|
50 | 50 | ((?P<sep>[\-:]) |
|
51 | 51 | (?P<end>\d+)?)? |
|
52 | 52 | $""", re.VERBOSE) |
|
53 | 53 | |
|
54 | 54 | |
|
55 | 55 | def extract_code_ranges(ranges_str): |
|
56 | 56 | """Turn a string of range for %%load into 2-tuples of (start, stop) |
|
57 | 57 | ready to use as a slice of the content split by lines. |
|
58 | 58 | |
|
59 | 59 | Examples |
|
60 | 60 | -------- |
|
61 | 61 | list(extract_input_ranges("5-10 2")) |
|
62 | 62 | [(4, 10), (1, 2)] |
|
63 | 63 | """ |
|
64 | 64 | for range_str in ranges_str.split(): |
|
65 | 65 | rmatch = range_re.match(range_str) |
|
66 | 66 | if not rmatch: |
|
67 | 67 | continue |
|
68 | 68 | sep = rmatch.group("sep") |
|
69 | 69 | start = rmatch.group("start") |
|
70 | 70 | end = rmatch.group("end") |
|
71 | 71 | |
|
72 | 72 | if sep == '-': |
|
73 | 73 | start = int(start) - 1 if start else None |
|
74 | 74 | end = int(end) if end else None |
|
75 | 75 | elif sep == ':': |
|
76 | 76 | start = int(start) - 1 if start else None |
|
77 | 77 | end = int(end) - 1 if end else None |
|
78 | 78 | else: |
|
79 | 79 | end = int(start) |
|
80 | 80 | start = int(start) - 1 |
|
81 | 81 | yield (start, end) |
|
82 | 82 | |
|
83 | 83 | |
|
84 | 84 | def extract_symbols(code, symbols): |
|
85 | 85 | """ |
|
86 | 86 | Return a tuple (blocks, not_found) |
|
87 | 87 | where ``blocks`` is a list of code fragments |
|
88 | 88 | for each symbol parsed from code, and ``not_found`` are |
|
89 | 89 | symbols not found in the code. |
|
90 | 90 | |
|
91 | 91 | For example:: |
|
92 | 92 | |
|
93 | 93 | In [1]: code = '''a = 10 |
|
94 | 94 | ...: def b(): return 42 |
|
95 | 95 | ...: class A: pass''' |
|
96 | 96 | |
|
97 | 97 | In [2]: extract_symbols(code, 'A,b,z') |
|
98 | 98 | Out[2]: (['class A: pass\\n', 'def b(): return 42\\n'], ['z']) |
|
99 | 99 | """ |
|
100 | 100 | symbols = symbols.split(',') |
|
101 | 101 | |
|
102 | 102 | # this will raise SyntaxError if code isn't valid Python |
|
103 | 103 | py_code = ast.parse(code) |
|
104 | 104 | |
|
105 | 105 | marks = [(getattr(s, 'name', None), s.lineno) for s in py_code.body] |
|
106 | 106 | code = code.split('\n') |
|
107 | 107 | |
|
108 | 108 | symbols_lines = {} |
|
109 | 109 | |
|
110 | 110 | # we already know the start_lineno of each symbol (marks). |
|
111 | 111 | # To find each end_lineno, we traverse in reverse order until each |
|
112 | 112 | # non-blank line |
|
113 | 113 | end = len(code) |
|
114 | 114 | for name, start in reversed(marks): |
|
115 | 115 | while not code[end - 1].strip(): |
|
116 | 116 | end -= 1 |
|
117 | 117 | if name: |
|
118 | 118 | symbols_lines[name] = (start - 1, end) |
|
119 | 119 | end = start - 1 |
|
120 | 120 | |
|
121 | 121 | # Now symbols_lines is a map |
|
122 | 122 | # {'symbol_name': (start_lineno, end_lineno), ...} |
|
123 | 123 | |
|
124 | 124 | # fill a list with chunks of codes for each requested symbol |
|
125 | 125 | blocks = [] |
|
126 | 126 | not_found = [] |
|
127 | 127 | for symbol in symbols: |
|
128 | 128 | if symbol in symbols_lines: |
|
129 | 129 | start, end = symbols_lines[symbol] |
|
130 | 130 | blocks.append('\n'.join(code[start:end]) + '\n') |
|
131 | 131 | else: |
|
132 | 132 | not_found.append(symbol) |
|
133 | 133 | |
|
134 | 134 | return blocks, not_found |
|
135 | 135 | |
|
136 | 136 | def strip_initial_indent(lines): |
|
137 | 137 | """For %load, strip indent from lines until finding an unindented line. |
|
138 | 138 | |
|
139 | 139 | https://github.com/ipython/ipython/issues/9775 |
|
140 | 140 | """ |
|
141 | 141 | indent_re = re.compile(r'\s+') |
|
142 | 142 | |
|
143 | 143 | it = iter(lines) |
|
144 | 144 | first_line = next(it) |
|
145 | 145 | indent_match = indent_re.match(first_line) |
|
146 | 146 | |
|
147 | 147 | if indent_match: |
|
148 | 148 | # First line was indented |
|
149 | 149 | indent = indent_match.group() |
|
150 | 150 | yield first_line[len(indent):] |
|
151 | 151 | |
|
152 | 152 | for line in it: |
|
153 | 153 | if line.startswith(indent): |
|
154 | 154 | yield line[len(indent):] |
|
155 | 155 | else: |
|
156 | 156 | # Less indented than the first line - stop dedenting |
|
157 | 157 | yield line |
|
158 | 158 | break |
|
159 | 159 | else: |
|
160 | 160 | yield first_line |
|
161 | 161 | |
|
162 | 162 | # Pass the remaining lines through without dedenting |
|
163 | 163 | for line in it: |
|
164 | 164 | yield line |
|
165 | 165 | |
|
166 | 166 | |
|
167 | 167 | class InteractivelyDefined(Exception): |
|
168 | 168 | """Exception for interactively defined variable in magic_edit""" |
|
169 | 169 | def __init__(self, index): |
|
170 | 170 | self.index = index |
|
171 | 171 | |
|
172 | 172 | |
|
173 | 173 | @magics_class |
|
174 | 174 | class CodeMagics(Magics): |
|
175 | 175 | """Magics related to code management (loading, saving, editing, ...).""" |
|
176 | 176 | |
|
177 | 177 | def __init__(self, *args, **kwargs): |
|
178 | 178 | self._knowntemps = set() |
|
179 | 179 | super(CodeMagics, self).__init__(*args, **kwargs) |
|
180 | 180 | |
|
181 | 181 | @line_magic |
|
182 | 182 | def save(self, parameter_s=''): |
|
183 | 183 | """Save a set of lines or a macro to a given filename. |
|
184 | 184 | |
|
185 | 185 | Usage:\\ |
|
186 | 186 | %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ... |
|
187 | 187 | |
|
188 | 188 | Options: |
|
189 | 189 | |
|
190 | 190 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
191 | 191 | so that magics are loaded in their transformed version to valid |
|
192 | 192 | Python. If this option is given, the raw input as typed as the |
|
193 | 193 | command line is used instead. |
|
194 | 194 | |
|
195 | 195 | -f: force overwrite. If file exists, %save will prompt for overwrite |
|
196 | 196 | unless -f is given. |
|
197 | 197 | |
|
198 | 198 | -a: append to the file instead of overwriting it. |
|
199 | 199 | |
|
200 | 200 | This function uses the same syntax as %history for input ranges, |
|
201 | 201 | then saves the lines to the filename you specify. |
|
202 | 202 | |
|
203 | 203 | It adds a '.py' extension to the file if you don't do so yourself, and |
|
204 | 204 | it asks for confirmation before overwriting existing files. |
|
205 | 205 | |
|
206 | 206 | If `-r` option is used, the default extension is `.ipy`. |
|
207 | 207 | """ |
|
208 | 208 | |
|
209 | 209 | opts,args = self.parse_options(parameter_s,'fra',mode='list') |
|
210 | 210 | if not args: |
|
211 | 211 | raise UsageError('Missing filename.') |
|
212 | 212 | raw = 'r' in opts |
|
213 | 213 | force = 'f' in opts |
|
214 | 214 | append = 'a' in opts |
|
215 | 215 | mode = 'a' if append else 'w' |
|
216 | 216 | ext = '.ipy' if raw else '.py' |
|
217 | 217 | fname, codefrom = args[0], " ".join(args[1:]) |
|
218 | 218 | if not fname.endswith(('.py','.ipy')): |
|
219 | 219 | fname += ext |
|
220 | 220 | file_exists = os.path.isfile(fname) |
|
221 | 221 | if file_exists and not force and not append: |
|
222 | 222 | try: |
|
223 | 223 | overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n') |
|
224 | 224 | except StdinNotImplementedError: |
|
225 | 225 | print("File `%s` exists. Use `%%save -f %s` to force overwrite" % (fname, parameter_s)) |
|
226 | 226 | return |
|
227 | 227 | if not overwrite : |
|
228 | 228 | print('Operation cancelled.') |
|
229 | 229 | return |
|
230 | 230 | try: |
|
231 | 231 | cmds = self.shell.find_user_code(codefrom,raw) |
|
232 | 232 | except (TypeError, ValueError) as e: |
|
233 | 233 | print(e.args[0]) |
|
234 | 234 | return |
|
235 | 235 | with io.open(fname, mode, encoding="utf-8") as f: |
|
236 | 236 | if not file_exists or not append: |
|
237 | 237 | f.write("# coding: utf-8\n") |
|
238 | 238 | f.write(cmds) |
|
239 | 239 | # make sure we end on a newline |
|
240 | 240 | if not cmds.endswith('\n'): |
|
241 | 241 | f.write('\n') |
|
242 | 242 | print('The following commands were written to file `%s`:' % fname) |
|
243 | 243 | print(cmds) |
|
244 | 244 | |
|
245 | 245 | @line_magic |
|
246 | 246 | def pastebin(self, parameter_s=''): |
|
247 | 247 | """Upload code to dpaste's paste bin, returning the URL. |
|
248 | 248 | |
|
249 | 249 | Usage:\\ |
|
250 | 250 | %pastebin [-d "Custom description"] 1-7 |
|
251 | 251 | |
|
252 | 252 | The argument can be an input history range, a filename, or the name of a |
|
253 | 253 | string or macro. |
|
254 | 254 | |
|
255 | 255 | Options: |
|
256 | 256 | |
|
257 | 257 | -d: Pass a custom description for the gist. The default will say |
|
258 | 258 | "Pasted from IPython". |
|
259 | 259 | """ |
|
260 | 260 | opts, args = self.parse_options(parameter_s, 'd:') |
|
261 | 261 | |
|
262 | 262 | try: |
|
263 | 263 | code = self.shell.find_user_code(args) |
|
264 | 264 | except (ValueError, TypeError) as e: |
|
265 | 265 | print(e.args[0]) |
|
266 | 266 | return |
|
267 | 267 | |
|
268 | 268 | post_data = urlencode({ |
|
269 | 269 | "title": opts.get('d', "Pasted from IPython"), |
|
270 | 270 | "syntax": "python3", |
|
271 | 271 | "content": code |
|
272 | 272 | }).encode('utf-8') |
|
273 | 273 | |
|
274 | 274 | response = urlopen("http://dpaste.com/api/v2/", post_data) |
|
275 | 275 | return response.headers.get('Location') |
|
276 | 276 | |
|
277 | 277 | @line_magic |
|
278 | 278 | def loadpy(self, arg_s): |
|
279 | 279 | """Alias of `%load` |
|
280 | 280 | |
|
281 | 281 | `%loadpy` has gained some flexibility and dropped the requirement of a `.py` |
|
282 | 282 | extension. So it has been renamed simply into %load. You can look at |
|
283 | 283 | `%load`'s docstring for more info. |
|
284 | 284 | """ |
|
285 | 285 | self.load(arg_s) |
|
286 | 286 | |
|
287 | 287 | @line_magic |
|
288 | 288 | def load(self, arg_s): |
|
289 | 289 | """Load code into the current frontend. |
|
290 | 290 | |
|
291 | 291 | Usage:\\ |
|
292 | 292 | %load [options] source |
|
293 | 293 | |
|
294 | 294 | where source can be a filename, URL, input history range, macro, or |
|
295 | 295 | element in the user namespace |
|
296 | 296 | |
|
297 | 297 | Options: |
|
298 | 298 | |
|
299 | 299 | -r <lines>: Specify lines or ranges of lines to load from the source. |
|
300 | 300 | Ranges could be specified as x-y (x..y) or in python-style x:y |
|
301 | 301 | (x..(y-1)). Both limits x and y can be left blank (meaning the |
|
302 | 302 | beginning and end of the file, respectively). |
|
303 | 303 | |
|
304 | 304 | -s <symbols>: Specify function or classes to load from python source. |
|
305 | 305 | |
|
306 | 306 | -y : Don't ask confirmation for loading source above 200 000 characters. |
|
307 | 307 | |
|
308 | 308 | -n : Include the user's namespace when searching for source code. |
|
309 | 309 | |
|
310 | 310 | This magic command can either take a local filename, a URL, an history |
|
311 | 311 | range (see %history) or a macro as argument, it will prompt for |
|
312 | 312 | confirmation before loading source with more than 200 000 characters, unless |
|
313 | 313 | -y flag is passed or if the frontend does not support raw_input:: |
|
314 | 314 | |
|
315 | 315 | %load myscript.py |
|
316 | 316 | %load 7-27 |
|
317 | 317 | %load myMacro |
|
318 | 318 | %load http://www.example.com/myscript.py |
|
319 | 319 | %load -r 5-10 myscript.py |
|
320 | 320 | %load -r 10-20,30,40: foo.py |
|
321 | 321 | %load -s MyClass,wonder_function myscript.py |
|
322 | 322 | %load -n MyClass |
|
323 | 323 | %load -n my_module.wonder_function |
|
324 | 324 | """ |
|
325 | 325 | opts,args = self.parse_options(arg_s,'yns:r:') |
|
326 | 326 | |
|
327 | 327 | if not args: |
|
328 | 328 | raise UsageError('Missing filename, URL, input history range, ' |
|
329 | 329 | 'macro, or element in the user namespace.') |
|
330 | 330 | |
|
331 | 331 | search_ns = 'n' in opts |
|
332 | 332 | |
|
333 | 333 | contents = self.shell.find_user_code(args, search_ns=search_ns) |
|
334 | 334 | |
|
335 | 335 | if 's' in opts: |
|
336 | 336 | try: |
|
337 | 337 | blocks, not_found = extract_symbols(contents, opts['s']) |
|
338 | 338 | except SyntaxError: |
|
339 | 339 | # non python code |
|
340 | 340 | error("Unable to parse the input as valid Python code") |
|
341 | 341 | return |
|
342 | 342 | |
|
343 | 343 | if len(not_found) == 1: |
|
344 | 344 | warn('The symbol `%s` was not found' % not_found[0]) |
|
345 | 345 | elif len(not_found) > 1: |
|
346 | 346 | warn('The symbols %s were not found' % get_text_list(not_found, |
|
347 | 347 | wrap_item_with='`') |
|
348 | 348 | ) |
|
349 | 349 | |
|
350 | 350 | contents = '\n'.join(blocks) |
|
351 | 351 | |
|
352 | 352 | if 'r' in opts: |
|
353 | 353 | ranges = opts['r'].replace(',', ' ') |
|
354 | 354 | lines = contents.split('\n') |
|
355 | 355 | slices = extract_code_ranges(ranges) |
|
356 | 356 | contents = [lines[slice(*slc)] for slc in slices] |
|
357 | 357 | contents = '\n'.join(strip_initial_indent(chain.from_iterable(contents))) |
|
358 | 358 | |
|
359 | 359 | l = len(contents) |
|
360 | 360 | |
|
361 | 361 | # 200 000 is ~ 2500 full 80 character lines |
|
362 | 362 | # so in average, more than 5000 lines |
|
363 | 363 | if l > 200000 and 'y' not in opts: |
|
364 | 364 | try: |
|
365 | 365 | ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\ |
|
366 | 366 | " (%d characters). Continue (y/[N]) ?" % l), default='n' ) |
|
367 | 367 | except StdinNotImplementedError: |
|
368 | 368 | #assume yes if raw input not implemented |
|
369 | 369 | ans = True |
|
370 | 370 | |
|
371 | 371 | if ans is False : |
|
372 | 372 | print('Operation cancelled.') |
|
373 | 373 | return |
|
374 | 374 | |
|
375 | 375 | contents = "# %load {}\n".format(arg_s) + contents |
|
376 | 376 | |
|
377 | 377 | self.shell.set_next_input(contents, replace=True) |
|
378 | 378 | |
|
379 | 379 | @staticmethod |
|
380 | 380 | def _find_edit_target(shell, args, opts, last_call): |
|
381 | 381 | """Utility method used by magic_edit to find what to edit.""" |
|
382 | 382 | |
|
383 | 383 | def make_filename(arg): |
|
384 | 384 | "Make a filename from the given args" |
|
385 | 385 | try: |
|
386 | 386 | filename = get_py_filename(arg) |
|
387 | 387 | except IOError: |
|
388 | 388 | # If it ends with .py but doesn't already exist, assume we want |
|
389 | 389 | # a new file. |
|
390 | 390 | if arg.endswith('.py'): |
|
391 | 391 | filename = arg |
|
392 | 392 | else: |
|
393 | 393 | filename = None |
|
394 | 394 | return filename |
|
395 | 395 | |
|
396 | 396 | # Set a few locals from the options for convenience: |
|
397 | 397 | opts_prev = 'p' in opts |
|
398 | 398 | opts_raw = 'r' in opts |
|
399 | 399 | |
|
400 | 400 | # custom exceptions |
|
401 | 401 | class DataIsObject(Exception): pass |
|
402 | 402 | |
|
403 | 403 | # Default line number value |
|
404 | 404 | lineno = opts.get('n',None) |
|
405 | 405 | |
|
406 | 406 | if opts_prev: |
|
407 | 407 | args = '_%s' % last_call[0] |
|
408 | 408 | if args not in shell.user_ns: |
|
409 | 409 | args = last_call[1] |
|
410 | 410 | |
|
411 | 411 | # by default this is done with temp files, except when the given |
|
412 | 412 | # arg is a filename |
|
413 | 413 | use_temp = True |
|
414 | 414 | |
|
415 | 415 | data = '' |
|
416 | 416 | |
|
417 | 417 | # First, see if the arguments should be a filename. |
|
418 | 418 | filename = make_filename(args) |
|
419 | 419 | if filename: |
|
420 | 420 | use_temp = False |
|
421 | 421 | elif args: |
|
422 | 422 | # Mode where user specifies ranges of lines, like in %macro. |
|
423 | 423 | data = shell.extract_input_lines(args, opts_raw) |
|
424 | 424 | if not data: |
|
425 | 425 | try: |
|
426 | 426 | # Load the parameter given as a variable. If not a string, |
|
427 | 427 | # process it as an object instead (below) |
|
428 | 428 | |
|
429 | 429 | #print '*** args',args,'type',type(args) # dbg |
|
430 | 430 | data = eval(args, shell.user_ns) |
|
431 | 431 | if not isinstance(data, str): |
|
432 | 432 | raise DataIsObject |
|
433 | 433 | |
|
434 | 434 | except (NameError,SyntaxError): |
|
435 | 435 | # given argument is not a variable, try as a filename |
|
436 | 436 | filename = make_filename(args) |
|
437 | 437 | if filename is None: |
|
438 | 438 | warn("Argument given (%s) can't be found as a variable " |
|
439 | 439 | "or as a filename." % args) |
|
440 | 440 | return (None, None, None) |
|
441 | 441 | use_temp = False |
|
442 | 442 | |
|
443 | except DataIsObject: | |
|
443 | except DataIsObject as e: | |
|
444 | 444 | # macros have a special edit function |
|
445 | 445 | if isinstance(data, Macro): |
|
446 | raise MacroToEdit(data) | |
|
446 | raise MacroToEdit(data) from e | |
|
447 | 447 | |
|
448 | 448 | # For objects, try to edit the file where they are defined |
|
449 | 449 | filename = find_file(data) |
|
450 | 450 | if filename: |
|
451 | 451 | if 'fakemodule' in filename.lower() and \ |
|
452 | 452 | inspect.isclass(data): |
|
453 | 453 | # class created by %edit? Try to find source |
|
454 | 454 | # by looking for method definitions instead, the |
|
455 | 455 | # __module__ in those classes is FakeModule. |
|
456 | 456 | attrs = [getattr(data, aname) for aname in dir(data)] |
|
457 | 457 | for attr in attrs: |
|
458 | 458 | if not inspect.ismethod(attr): |
|
459 | 459 | continue |
|
460 | 460 | filename = find_file(attr) |
|
461 | 461 | if filename and \ |
|
462 | 462 | 'fakemodule' not in filename.lower(): |
|
463 | 463 | # change the attribute to be the edit |
|
464 | 464 | # target instead |
|
465 | 465 | data = attr |
|
466 | 466 | break |
|
467 | 467 | |
|
468 | 468 | m = ipython_input_pat.match(os.path.basename(filename)) |
|
469 | 469 | if m: |
|
470 | raise InteractivelyDefined(int(m.groups()[0])) | |
|
470 | raise InteractivelyDefined(int(m.groups()[0])) from e | |
|
471 | 471 | |
|
472 | 472 | datafile = 1 |
|
473 | 473 | if filename is None: |
|
474 | 474 | filename = make_filename(args) |
|
475 | 475 | datafile = 1 |
|
476 | 476 | if filename is not None: |
|
477 | 477 | # only warn about this if we get a real name |
|
478 | 478 | warn('Could not find file where `%s` is defined.\n' |
|
479 | 479 | 'Opening a file named `%s`' % (args, filename)) |
|
480 | 480 | # Now, make sure we can actually read the source (if it was |
|
481 | 481 | # in a temp file it's gone by now). |
|
482 | 482 | if datafile: |
|
483 | 483 | if lineno is None: |
|
484 | 484 | lineno = find_source_lines(data) |
|
485 | 485 | if lineno is None: |
|
486 | 486 | filename = make_filename(args) |
|
487 | 487 | if filename is None: |
|
488 | 488 | warn('The file where `%s` was defined ' |
|
489 | 489 | 'cannot be read or found.' % data) |
|
490 | 490 | return (None, None, None) |
|
491 | 491 | use_temp = False |
|
492 | 492 | |
|
493 | 493 | if use_temp: |
|
494 | 494 | filename = shell.mktempfile(data) |
|
495 | 495 | print('IPython will make a temporary file named:',filename) |
|
496 | 496 | |
|
497 | 497 | # use last_call to remember the state of the previous call, but don't |
|
498 | 498 | # let it be clobbered by successive '-p' calls. |
|
499 | 499 | try: |
|
500 | 500 | last_call[0] = shell.displayhook.prompt_count |
|
501 | 501 | if not opts_prev: |
|
502 | 502 | last_call[1] = args |
|
503 | 503 | except: |
|
504 | 504 | pass |
|
505 | 505 | |
|
506 | 506 | |
|
507 | 507 | return filename, lineno, use_temp |
|
508 | 508 | |
|
509 | 509 | def _edit_macro(self,mname,macro): |
|
510 | 510 | """open an editor with the macro data in a file""" |
|
511 | 511 | filename = self.shell.mktempfile(macro.value) |
|
512 | 512 | self.shell.hooks.editor(filename) |
|
513 | 513 | |
|
514 | 514 | # and make a new macro object, to replace the old one |
|
515 | 515 | with open(filename) as mfile: |
|
516 | 516 | mvalue = mfile.read() |
|
517 | 517 | self.shell.user_ns[mname] = Macro(mvalue) |
|
518 | 518 | |
|
519 | 519 | @skip_doctest |
|
520 | 520 | @line_magic |
|
521 | 521 | def edit(self, parameter_s='',last_call=['','']): |
|
522 | 522 | """Bring up an editor and execute the resulting code. |
|
523 | 523 | |
|
524 | 524 | Usage: |
|
525 | 525 | %edit [options] [args] |
|
526 | 526 | |
|
527 | 527 | %edit runs IPython's editor hook. The default version of this hook is |
|
528 | 528 | set to call the editor specified by your $EDITOR environment variable. |
|
529 | 529 | If this isn't found, it will default to vi under Linux/Unix and to |
|
530 | 530 | notepad under Windows. See the end of this docstring for how to change |
|
531 | 531 | the editor hook. |
|
532 | 532 | |
|
533 | 533 | You can also set the value of this editor via the |
|
534 | 534 | ``TerminalInteractiveShell.editor`` option in your configuration file. |
|
535 | 535 | This is useful if you wish to use a different editor from your typical |
|
536 | 536 | default with IPython (and for Windows users who typically don't set |
|
537 | 537 | environment variables). |
|
538 | 538 | |
|
539 | 539 | This command allows you to conveniently edit multi-line code right in |
|
540 | 540 | your IPython session. |
|
541 | 541 | |
|
542 | 542 | If called without arguments, %edit opens up an empty editor with a |
|
543 | 543 | temporary file and will execute the contents of this file when you |
|
544 | 544 | close it (don't forget to save it!). |
|
545 | 545 | |
|
546 | 546 | |
|
547 | 547 | Options: |
|
548 | 548 | |
|
549 | 549 | -n <number>: open the editor at a specified line number. By default, |
|
550 | 550 | the IPython editor hook uses the unix syntax 'editor +N filename', but |
|
551 | 551 | you can configure this by providing your own modified hook if your |
|
552 | 552 | favorite editor supports line-number specifications with a different |
|
553 | 553 | syntax. |
|
554 | 554 | |
|
555 | 555 | -p: this will call the editor with the same data as the previous time |
|
556 | 556 | it was used, regardless of how long ago (in your current session) it |
|
557 | 557 | was. |
|
558 | 558 | |
|
559 | 559 | -r: use 'raw' input. This option only applies to input taken from the |
|
560 | 560 | user's history. By default, the 'processed' history is used, so that |
|
561 | 561 | magics are loaded in their transformed version to valid Python. If |
|
562 | 562 | this option is given, the raw input as typed as the command line is |
|
563 | 563 | used instead. When you exit the editor, it will be executed by |
|
564 | 564 | IPython's own processor. |
|
565 | 565 | |
|
566 | 566 | -x: do not execute the edited code immediately upon exit. This is |
|
567 | 567 | mainly useful if you are editing programs which need to be called with |
|
568 | 568 | command line arguments, which you can then do using %run. |
|
569 | 569 | |
|
570 | 570 | |
|
571 | 571 | Arguments: |
|
572 | 572 | |
|
573 | 573 | If arguments are given, the following possibilities exist: |
|
574 | 574 | |
|
575 | 575 | - If the argument is a filename, IPython will load that into the |
|
576 | 576 | editor. It will execute its contents with execfile() when you exit, |
|
577 | 577 | loading any code in the file into your interactive namespace. |
|
578 | 578 | |
|
579 | 579 | - The arguments are ranges of input history, e.g. "7 ~1/4-6". |
|
580 | 580 | The syntax is the same as in the %history magic. |
|
581 | 581 | |
|
582 | 582 | - If the argument is a string variable, its contents are loaded |
|
583 | 583 | into the editor. You can thus edit any string which contains |
|
584 | 584 | python code (including the result of previous edits). |
|
585 | 585 | |
|
586 | 586 | - If the argument is the name of an object (other than a string), |
|
587 | 587 | IPython will try to locate the file where it was defined and open the |
|
588 | 588 | editor at the point where it is defined. You can use `%edit function` |
|
589 | 589 | to load an editor exactly at the point where 'function' is defined, |
|
590 | 590 | edit it and have the file be executed automatically. |
|
591 | 591 | |
|
592 | 592 | - If the object is a macro (see %macro for details), this opens up your |
|
593 | 593 | specified editor with a temporary file containing the macro's data. |
|
594 | 594 | Upon exit, the macro is reloaded with the contents of the file. |
|
595 | 595 | |
|
596 | 596 | Note: opening at an exact line is only supported under Unix, and some |
|
597 | 597 | editors (like kedit and gedit up to Gnome 2.8) do not understand the |
|
598 | 598 | '+NUMBER' parameter necessary for this feature. Good editors like |
|
599 | 599 | (X)Emacs, vi, jed, pico and joe all do. |
|
600 | 600 | |
|
601 | 601 | After executing your code, %edit will return as output the code you |
|
602 | 602 | typed in the editor (except when it was an existing file). This way |
|
603 | 603 | you can reload the code in further invocations of %edit as a variable, |
|
604 | 604 | via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of |
|
605 | 605 | the output. |
|
606 | 606 | |
|
607 | 607 | Note that %edit is also available through the alias %ed. |
|
608 | 608 | |
|
609 | 609 | This is an example of creating a simple function inside the editor and |
|
610 | 610 | then modifying it. First, start up the editor:: |
|
611 | 611 | |
|
612 | 612 | In [1]: edit |
|
613 | 613 | Editing... done. Executing edited code... |
|
614 | 614 | Out[1]: 'def foo():\\n print "foo() was defined in an editing |
|
615 | 615 | session"\\n' |
|
616 | 616 | |
|
617 | 617 | We can then call the function foo():: |
|
618 | 618 | |
|
619 | 619 | In [2]: foo() |
|
620 | 620 | foo() was defined in an editing session |
|
621 | 621 | |
|
622 | 622 | Now we edit foo. IPython automatically loads the editor with the |
|
623 | 623 | (temporary) file where foo() was previously defined:: |
|
624 | 624 | |
|
625 | 625 | In [3]: edit foo |
|
626 | 626 | Editing... done. Executing edited code... |
|
627 | 627 | |
|
628 | 628 | And if we call foo() again we get the modified version:: |
|
629 | 629 | |
|
630 | 630 | In [4]: foo() |
|
631 | 631 | foo() has now been changed! |
|
632 | 632 | |
|
633 | 633 | Here is an example of how to edit a code snippet successive |
|
634 | 634 | times. First we call the editor:: |
|
635 | 635 | |
|
636 | 636 | In [5]: edit |
|
637 | 637 | Editing... done. Executing edited code... |
|
638 | 638 | hello |
|
639 | 639 | Out[5]: "print 'hello'\\n" |
|
640 | 640 | |
|
641 | 641 | Now we call it again with the previous output (stored in _):: |
|
642 | 642 | |
|
643 | 643 | In [6]: edit _ |
|
644 | 644 | Editing... done. Executing edited code... |
|
645 | 645 | hello world |
|
646 | 646 | Out[6]: "print 'hello world'\\n" |
|
647 | 647 | |
|
648 | 648 | Now we call it with the output #8 (stored in _8, also as Out[8]):: |
|
649 | 649 | |
|
650 | 650 | In [7]: edit _8 |
|
651 | 651 | Editing... done. Executing edited code... |
|
652 | 652 | hello again |
|
653 | 653 | Out[7]: "print 'hello again'\\n" |
|
654 | 654 | |
|
655 | 655 | |
|
656 | 656 | Changing the default editor hook: |
|
657 | 657 | |
|
658 | 658 | If you wish to write your own editor hook, you can put it in a |
|
659 | 659 | configuration file which you load at startup time. The default hook |
|
660 | 660 | is defined in the IPython.core.hooks module, and you can use that as a |
|
661 | 661 | starting example for further modifications. That file also has |
|
662 | 662 | general instructions on how to set a new hook for use once you've |
|
663 | 663 | defined it.""" |
|
664 | 664 | opts,args = self.parse_options(parameter_s,'prxn:') |
|
665 | 665 | |
|
666 | 666 | try: |
|
667 | 667 | filename, lineno, is_temp = self._find_edit_target(self.shell, |
|
668 | 668 | args, opts, last_call) |
|
669 | 669 | except MacroToEdit as e: |
|
670 | 670 | self._edit_macro(args, e.args[0]) |
|
671 | 671 | return |
|
672 | 672 | except InteractivelyDefined as e: |
|
673 | 673 | print("Editing In[%i]" % e.index) |
|
674 | 674 | args = str(e.index) |
|
675 | 675 | filename, lineno, is_temp = self._find_edit_target(self.shell, |
|
676 | 676 | args, opts, last_call) |
|
677 | 677 | if filename is None: |
|
678 | 678 | # nothing was found, warnings have already been issued, |
|
679 | 679 | # just give up. |
|
680 | 680 | return |
|
681 | 681 | |
|
682 | 682 | if is_temp: |
|
683 | 683 | self._knowntemps.add(filename) |
|
684 | 684 | elif (filename in self._knowntemps): |
|
685 | 685 | is_temp = True |
|
686 | 686 | |
|
687 | 687 | |
|
688 | 688 | # do actual editing here |
|
689 | 689 | print('Editing...', end=' ') |
|
690 | 690 | sys.stdout.flush() |
|
691 | 691 | try: |
|
692 | 692 | # Quote filenames that may have spaces in them |
|
693 | 693 | if ' ' in filename: |
|
694 | 694 | filename = "'%s'" % filename |
|
695 | 695 | self.shell.hooks.editor(filename,lineno) |
|
696 | 696 | except TryNext: |
|
697 | 697 | warn('Could not open editor') |
|
698 | 698 | return |
|
699 | 699 | |
|
700 | 700 | # XXX TODO: should this be generalized for all string vars? |
|
701 | 701 | # For now, this is special-cased to blocks created by cpaste |
|
702 | 702 | if args.strip() == 'pasted_block': |
|
703 | 703 | with open(filename, 'r') as f: |
|
704 | 704 | self.shell.user_ns['pasted_block'] = f.read() |
|
705 | 705 | |
|
706 | 706 | if 'x' in opts: # -x prevents actual execution |
|
707 | 707 | print() |
|
708 | 708 | else: |
|
709 | 709 | print('done. Executing edited code...') |
|
710 | 710 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
711 | 711 | if not is_temp: |
|
712 | 712 | self.shell.user_ns['__file__'] = filename |
|
713 | 713 | if 'r' in opts: # Untranslated IPython code |
|
714 | 714 | with open(filename, 'r') as f: |
|
715 | 715 | source = f.read() |
|
716 | 716 | self.shell.run_cell(source, store_history=False) |
|
717 | 717 | else: |
|
718 | 718 | self.shell.safe_execfile(filename, self.shell.user_ns, |
|
719 | 719 | self.shell.user_ns) |
|
720 | 720 | |
|
721 | 721 | if is_temp: |
|
722 | 722 | try: |
|
723 | 723 | with open(filename) as f: |
|
724 | 724 | return f.read() |
|
725 | 725 | except IOError as msg: |
|
726 | 726 | if msg.filename == filename: |
|
727 | 727 | warn('File not found. Did you forget to save?') |
|
728 | 728 | return |
|
729 | 729 | else: |
|
730 | 730 | self.shell.showtraceback() |
@@ -1,1490 +1,1490 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | """Implementation of execution-related magic functions.""" |
|
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 | import ast |
|
9 | 9 | import bdb |
|
10 | 10 | import builtins as builtin_mod |
|
11 | 11 | import gc |
|
12 | 12 | import itertools |
|
13 | 13 | import os |
|
14 | 14 | import shlex |
|
15 | 15 | import sys |
|
16 | 16 | import time |
|
17 | 17 | import timeit |
|
18 | 18 | import math |
|
19 | 19 | import re |
|
20 | 20 | from pdb import Restart |
|
21 | 21 | |
|
22 | 22 | import cProfile as profile |
|
23 | 23 | import pstats |
|
24 | 24 | |
|
25 | 25 | from IPython.core import oinspect |
|
26 | 26 | from IPython.core import magic_arguments |
|
27 | 27 | from IPython.core import page |
|
28 | 28 | from IPython.core.error import UsageError |
|
29 | 29 | from IPython.core.macro import Macro |
|
30 | 30 | from IPython.core.magic import (Magics, magics_class, line_magic, cell_magic, |
|
31 | 31 | line_cell_magic, on_off, needs_local_scope, |
|
32 | 32 | no_var_expand) |
|
33 | 33 | from IPython.testing.skipdoctest import skip_doctest |
|
34 | 34 | from IPython.utils.contexts import preserve_keys |
|
35 | 35 | from IPython.utils.capture import capture_output |
|
36 | 36 | from IPython.utils.ipstruct import Struct |
|
37 | 37 | from IPython.utils.module_paths import find_mod |
|
38 | 38 | from IPython.utils.path import get_py_filename, shellglob |
|
39 | 39 | from IPython.utils.timing import clock, clock2 |
|
40 | 40 | from warnings import warn |
|
41 | 41 | from logging import error |
|
42 | 42 | from io import StringIO |
|
43 | 43 | |
|
44 | 44 | if sys.version_info > (3,8): |
|
45 | 45 | from ast import Module |
|
46 | 46 | else : |
|
47 | 47 | # mock the new API, ignore second argument |
|
48 | 48 | # see https://github.com/ipython/ipython/issues/11590 |
|
49 | 49 | from ast import Module as OriginalModule |
|
50 | 50 | Module = lambda nodelist, type_ignores: OriginalModule(nodelist) |
|
51 | 51 | |
|
52 | 52 | |
|
53 | 53 | #----------------------------------------------------------------------------- |
|
54 | 54 | # Magic implementation classes |
|
55 | 55 | #----------------------------------------------------------------------------- |
|
56 | 56 | |
|
57 | 57 | |
|
58 | 58 | class TimeitResult(object): |
|
59 | 59 | """ |
|
60 | 60 | Object returned by the timeit magic with info about the run. |
|
61 | 61 | |
|
62 | 62 | Contains the following attributes : |
|
63 | 63 | |
|
64 | 64 | loops: (int) number of loops done per measurement |
|
65 | 65 | repeat: (int) number of times the measurement has been repeated |
|
66 | 66 | best: (float) best execution time / number |
|
67 | 67 | all_runs: (list of float) execution time of each run (in s) |
|
68 | 68 | compile_time: (float) time of statement compilation (s) |
|
69 | 69 | |
|
70 | 70 | """ |
|
71 | 71 | def __init__(self, loops, repeat, best, worst, all_runs, compile_time, precision): |
|
72 | 72 | self.loops = loops |
|
73 | 73 | self.repeat = repeat |
|
74 | 74 | self.best = best |
|
75 | 75 | self.worst = worst |
|
76 | 76 | self.all_runs = all_runs |
|
77 | 77 | self.compile_time = compile_time |
|
78 | 78 | self._precision = precision |
|
79 | 79 | self.timings = [ dt / self.loops for dt in all_runs] |
|
80 | 80 | |
|
81 | 81 | @property |
|
82 | 82 | def average(self): |
|
83 | 83 | return math.fsum(self.timings) / len(self.timings) |
|
84 | 84 | |
|
85 | 85 | @property |
|
86 | 86 | def stdev(self): |
|
87 | 87 | mean = self.average |
|
88 | 88 | return (math.fsum([(x - mean) ** 2 for x in self.timings]) / len(self.timings)) ** 0.5 |
|
89 | 89 | |
|
90 | 90 | def __str__(self): |
|
91 | 91 | pm = '+-' |
|
92 | 92 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
93 | 93 | try: |
|
94 | 94 | u'\xb1'.encode(sys.stdout.encoding) |
|
95 | 95 | pm = u'\xb1' |
|
96 | 96 | except: |
|
97 | 97 | pass |
|
98 | 98 | return ( |
|
99 | 99 | u"{mean} {pm} {std} per loop (mean {pm} std. dev. of {runs} run{run_plural}, {loops} loop{loop_plural} each)" |
|
100 | 100 | .format( |
|
101 | 101 | pm = pm, |
|
102 | 102 | runs = self.repeat, |
|
103 | 103 | loops = self.loops, |
|
104 | 104 | loop_plural = "" if self.loops == 1 else "s", |
|
105 | 105 | run_plural = "" if self.repeat == 1 else "s", |
|
106 | 106 | mean = _format_time(self.average, self._precision), |
|
107 | 107 | std = _format_time(self.stdev, self._precision)) |
|
108 | 108 | ) |
|
109 | 109 | |
|
110 | 110 | def _repr_pretty_(self, p , cycle): |
|
111 | 111 | unic = self.__str__() |
|
112 | 112 | p.text(u'<TimeitResult : '+unic+u'>') |
|
113 | 113 | |
|
114 | 114 | |
|
115 | 115 | class TimeitTemplateFiller(ast.NodeTransformer): |
|
116 | 116 | """Fill in the AST template for timing execution. |
|
117 | 117 | |
|
118 | 118 | This is quite closely tied to the template definition, which is in |
|
119 | 119 | :meth:`ExecutionMagics.timeit`. |
|
120 | 120 | """ |
|
121 | 121 | def __init__(self, ast_setup, ast_stmt): |
|
122 | 122 | self.ast_setup = ast_setup |
|
123 | 123 | self.ast_stmt = ast_stmt |
|
124 | 124 | |
|
125 | 125 | def visit_FunctionDef(self, node): |
|
126 | 126 | "Fill in the setup statement" |
|
127 | 127 | self.generic_visit(node) |
|
128 | 128 | if node.name == "inner": |
|
129 | 129 | node.body[:1] = self.ast_setup.body |
|
130 | 130 | |
|
131 | 131 | return node |
|
132 | 132 | |
|
133 | 133 | def visit_For(self, node): |
|
134 | 134 | "Fill in the statement to be timed" |
|
135 | 135 | if getattr(getattr(node.body[0], 'value', None), 'id', None) == 'stmt': |
|
136 | 136 | node.body = self.ast_stmt.body |
|
137 | 137 | return node |
|
138 | 138 | |
|
139 | 139 | |
|
140 | 140 | class Timer(timeit.Timer): |
|
141 | 141 | """Timer class that explicitly uses self.inner |
|
142 | 142 | |
|
143 | 143 | which is an undocumented implementation detail of CPython, |
|
144 | 144 | not shared by PyPy. |
|
145 | 145 | """ |
|
146 | 146 | # Timer.timeit copied from CPython 3.4.2 |
|
147 | 147 | def timeit(self, number=timeit.default_number): |
|
148 | 148 | """Time 'number' executions of the main statement. |
|
149 | 149 | |
|
150 | 150 | To be precise, this executes the setup statement once, and |
|
151 | 151 | then returns the time it takes to execute the main statement |
|
152 | 152 | a number of times, as a float measured in seconds. The |
|
153 | 153 | argument is the number of times through the loop, defaulting |
|
154 | 154 | to one million. The main statement, the setup statement and |
|
155 | 155 | the timer function to be used are passed to the constructor. |
|
156 | 156 | """ |
|
157 | 157 | it = itertools.repeat(None, number) |
|
158 | 158 | gcold = gc.isenabled() |
|
159 | 159 | gc.disable() |
|
160 | 160 | try: |
|
161 | 161 | timing = self.inner(it, self.timer) |
|
162 | 162 | finally: |
|
163 | 163 | if gcold: |
|
164 | 164 | gc.enable() |
|
165 | 165 | return timing |
|
166 | 166 | |
|
167 | 167 | |
|
168 | 168 | @magics_class |
|
169 | 169 | class ExecutionMagics(Magics): |
|
170 | 170 | """Magics related to code execution, debugging, profiling, etc. |
|
171 | 171 | |
|
172 | 172 | """ |
|
173 | 173 | |
|
174 | 174 | def __init__(self, shell): |
|
175 | 175 | super(ExecutionMagics, self).__init__(shell) |
|
176 | 176 | # Default execution function used to actually run user code. |
|
177 | 177 | self.default_runner = None |
|
178 | 178 | |
|
179 | 179 | @skip_doctest |
|
180 | 180 | @no_var_expand |
|
181 | 181 | @line_cell_magic |
|
182 | 182 | def prun(self, parameter_s='', cell=None): |
|
183 | 183 | |
|
184 | 184 | """Run a statement through the python code profiler. |
|
185 | 185 | |
|
186 | 186 | Usage, in line mode: |
|
187 | 187 | %prun [options] statement |
|
188 | 188 | |
|
189 | 189 | Usage, in cell mode: |
|
190 | 190 | %%prun [options] [statement] |
|
191 | 191 | code... |
|
192 | 192 | code... |
|
193 | 193 | |
|
194 | 194 | In cell mode, the additional code lines are appended to the (possibly |
|
195 | 195 | empty) statement in the first line. Cell mode allows you to easily |
|
196 | 196 | profile multiline blocks without having to put them in a separate |
|
197 | 197 | function. |
|
198 | 198 | |
|
199 | 199 | The given statement (which doesn't require quote marks) is run via the |
|
200 | 200 | python profiler in a manner similar to the profile.run() function. |
|
201 | 201 | Namespaces are internally managed to work correctly; profile.run |
|
202 | 202 | cannot be used in IPython because it makes certain assumptions about |
|
203 | 203 | namespaces which do not hold under IPython. |
|
204 | 204 | |
|
205 | 205 | Options: |
|
206 | 206 | |
|
207 | 207 | -l <limit> |
|
208 | 208 | you can place restrictions on what or how much of the |
|
209 | 209 | profile gets printed. The limit value can be: |
|
210 | 210 | |
|
211 | 211 | * A string: only information for function names containing this string |
|
212 | 212 | is printed. |
|
213 | 213 | |
|
214 | 214 | * An integer: only these many lines are printed. |
|
215 | 215 | |
|
216 | 216 | * A float (between 0 and 1): this fraction of the report is printed |
|
217 | 217 | (for example, use a limit of 0.4 to see the topmost 40% only). |
|
218 | 218 | |
|
219 | 219 | You can combine several limits with repeated use of the option. For |
|
220 | 220 | example, ``-l __init__ -l 5`` will print only the topmost 5 lines of |
|
221 | 221 | information about class constructors. |
|
222 | 222 | |
|
223 | 223 | -r |
|
224 | 224 | return the pstats.Stats object generated by the profiling. This |
|
225 | 225 | object has all the information about the profile in it, and you can |
|
226 | 226 | later use it for further analysis or in other functions. |
|
227 | 227 | |
|
228 | 228 | -s <key> |
|
229 | 229 | sort profile by given key. You can provide more than one key |
|
230 | 230 | by using the option several times: '-s key1 -s key2 -s key3...'. The |
|
231 | 231 | default sorting key is 'time'. |
|
232 | 232 | |
|
233 | 233 | The following is copied verbatim from the profile documentation |
|
234 | 234 | referenced below: |
|
235 | 235 | |
|
236 | 236 | When more than one key is provided, additional keys are used as |
|
237 | 237 | secondary criteria when the there is equality in all keys selected |
|
238 | 238 | before them. |
|
239 | 239 | |
|
240 | 240 | Abbreviations can be used for any key names, as long as the |
|
241 | 241 | abbreviation is unambiguous. The following are the keys currently |
|
242 | 242 | defined: |
|
243 | 243 | |
|
244 | 244 | ============ ===================== |
|
245 | 245 | Valid Arg Meaning |
|
246 | 246 | ============ ===================== |
|
247 | 247 | "calls" call count |
|
248 | 248 | "cumulative" cumulative time |
|
249 | 249 | "file" file name |
|
250 | 250 | "module" file name |
|
251 | 251 | "pcalls" primitive call count |
|
252 | 252 | "line" line number |
|
253 | 253 | "name" function name |
|
254 | 254 | "nfl" name/file/line |
|
255 | 255 | "stdname" standard name |
|
256 | 256 | "time" internal time |
|
257 | 257 | ============ ===================== |
|
258 | 258 | |
|
259 | 259 | Note that all sorts on statistics are in descending order (placing |
|
260 | 260 | most time consuming items first), where as name, file, and line number |
|
261 | 261 | searches are in ascending order (i.e., alphabetical). The subtle |
|
262 | 262 | distinction between "nfl" and "stdname" is that the standard name is a |
|
263 | 263 | sort of the name as printed, which means that the embedded line |
|
264 | 264 | numbers get compared in an odd way. For example, lines 3, 20, and 40 |
|
265 | 265 | would (if the file names were the same) appear in the string order |
|
266 | 266 | "20" "3" and "40". In contrast, "nfl" does a numeric compare of the |
|
267 | 267 | line numbers. In fact, sort_stats("nfl") is the same as |
|
268 | 268 | sort_stats("name", "file", "line"). |
|
269 | 269 | |
|
270 | 270 | -T <filename> |
|
271 | 271 | save profile results as shown on screen to a text |
|
272 | 272 | file. The profile is still shown on screen. |
|
273 | 273 | |
|
274 | 274 | -D <filename> |
|
275 | 275 | save (via dump_stats) profile statistics to given |
|
276 | 276 | filename. This data is in a format understood by the pstats module, and |
|
277 | 277 | is generated by a call to the dump_stats() method of profile |
|
278 | 278 | objects. The profile is still shown on screen. |
|
279 | 279 | |
|
280 | 280 | -q |
|
281 | 281 | suppress output to the pager. Best used with -T and/or -D above. |
|
282 | 282 | |
|
283 | 283 | If you want to run complete programs under the profiler's control, use |
|
284 | 284 | ``%run -p [prof_opts] filename.py [args to program]`` where prof_opts |
|
285 | 285 | contains profiler specific options as described here. |
|
286 | 286 | |
|
287 | 287 | You can read the complete documentation for the profile module with:: |
|
288 | 288 | |
|
289 | 289 | In [1]: import profile; profile.help() |
|
290 | 290 | |
|
291 | 291 | .. versionchanged:: 7.3 |
|
292 | 292 | User variables are no longer expanded, |
|
293 | 293 | the magic line is always left unmodified. |
|
294 | 294 | |
|
295 | 295 | """ |
|
296 | 296 | opts, arg_str = self.parse_options(parameter_s, 'D:l:rs:T:q', |
|
297 | 297 | list_all=True, posix=False) |
|
298 | 298 | if cell is not None: |
|
299 | 299 | arg_str += '\n' + cell |
|
300 | 300 | arg_str = self.shell.transform_cell(arg_str) |
|
301 | 301 | return self._run_with_profiler(arg_str, opts, self.shell.user_ns) |
|
302 | 302 | |
|
303 | 303 | def _run_with_profiler(self, code, opts, namespace): |
|
304 | 304 | """ |
|
305 | 305 | Run `code` with profiler. Used by ``%prun`` and ``%run -p``. |
|
306 | 306 | |
|
307 | 307 | Parameters |
|
308 | 308 | ---------- |
|
309 | 309 | code : str |
|
310 | 310 | Code to be executed. |
|
311 | 311 | opts : Struct |
|
312 | 312 | Options parsed by `self.parse_options`. |
|
313 | 313 | namespace : dict |
|
314 | 314 | A dictionary for Python namespace (e.g., `self.shell.user_ns`). |
|
315 | 315 | |
|
316 | 316 | """ |
|
317 | 317 | |
|
318 | 318 | # Fill default values for unspecified options: |
|
319 | 319 | opts.merge(Struct(D=[''], l=[], s=['time'], T=[''])) |
|
320 | 320 | |
|
321 | 321 | prof = profile.Profile() |
|
322 | 322 | try: |
|
323 | 323 | prof = prof.runctx(code, namespace, namespace) |
|
324 | 324 | sys_exit = '' |
|
325 | 325 | except SystemExit: |
|
326 | 326 | sys_exit = """*** SystemExit exception caught in code being profiled.""" |
|
327 | 327 | |
|
328 | 328 | stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s) |
|
329 | 329 | |
|
330 | 330 | lims = opts.l |
|
331 | 331 | if lims: |
|
332 | 332 | lims = [] # rebuild lims with ints/floats/strings |
|
333 | 333 | for lim in opts.l: |
|
334 | 334 | try: |
|
335 | 335 | lims.append(int(lim)) |
|
336 | 336 | except ValueError: |
|
337 | 337 | try: |
|
338 | 338 | lims.append(float(lim)) |
|
339 | 339 | except ValueError: |
|
340 | 340 | lims.append(lim) |
|
341 | 341 | |
|
342 | 342 | # Trap output. |
|
343 | 343 | stdout_trap = StringIO() |
|
344 | 344 | stats_stream = stats.stream |
|
345 | 345 | try: |
|
346 | 346 | stats.stream = stdout_trap |
|
347 | 347 | stats.print_stats(*lims) |
|
348 | 348 | finally: |
|
349 | 349 | stats.stream = stats_stream |
|
350 | 350 | |
|
351 | 351 | output = stdout_trap.getvalue() |
|
352 | 352 | output = output.rstrip() |
|
353 | 353 | |
|
354 | 354 | if 'q' not in opts: |
|
355 | 355 | page.page(output) |
|
356 | 356 | print(sys_exit, end=' ') |
|
357 | 357 | |
|
358 | 358 | dump_file = opts.D[0] |
|
359 | 359 | text_file = opts.T[0] |
|
360 | 360 | if dump_file: |
|
361 | 361 | prof.dump_stats(dump_file) |
|
362 | 362 | print('\n*** Profile stats marshalled to file',\ |
|
363 | 363 | repr(dump_file)+'.',sys_exit) |
|
364 | 364 | if text_file: |
|
365 | 365 | with open(text_file, 'w') as pfile: |
|
366 | 366 | pfile.write(output) |
|
367 | 367 | print('\n*** Profile printout saved to text file',\ |
|
368 | 368 | repr(text_file)+'.',sys_exit) |
|
369 | 369 | |
|
370 | 370 | if 'r' in opts: |
|
371 | 371 | return stats |
|
372 | 372 | else: |
|
373 | 373 | return None |
|
374 | 374 | |
|
375 | 375 | @line_magic |
|
376 | 376 | def pdb(self, parameter_s=''): |
|
377 | 377 | """Control the automatic calling of the pdb interactive debugger. |
|
378 | 378 | |
|
379 | 379 | Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without |
|
380 | 380 | argument it works as a toggle. |
|
381 | 381 | |
|
382 | 382 | When an exception is triggered, IPython can optionally call the |
|
383 | 383 | interactive pdb debugger after the traceback printout. %pdb toggles |
|
384 | 384 | this feature on and off. |
|
385 | 385 | |
|
386 | 386 | The initial state of this feature is set in your configuration |
|
387 | 387 | file (the option is ``InteractiveShell.pdb``). |
|
388 | 388 | |
|
389 | 389 | If you want to just activate the debugger AFTER an exception has fired, |
|
390 | 390 | without having to type '%pdb on' and rerunning your code, you can use |
|
391 | 391 | the %debug magic.""" |
|
392 | 392 | |
|
393 | 393 | par = parameter_s.strip().lower() |
|
394 | 394 | |
|
395 | 395 | if par: |
|
396 | 396 | try: |
|
397 | 397 | new_pdb = {'off':0,'0':0,'on':1,'1':1}[par] |
|
398 | 398 | except KeyError: |
|
399 | 399 | print ('Incorrect argument. Use on/1, off/0, ' |
|
400 | 400 | 'or nothing for a toggle.') |
|
401 | 401 | return |
|
402 | 402 | else: |
|
403 | 403 | # toggle |
|
404 | 404 | new_pdb = not self.shell.call_pdb |
|
405 | 405 | |
|
406 | 406 | # set on the shell |
|
407 | 407 | self.shell.call_pdb = new_pdb |
|
408 | 408 | print('Automatic pdb calling has been turned',on_off(new_pdb)) |
|
409 | 409 | |
|
410 | 410 | @skip_doctest |
|
411 | 411 | @magic_arguments.magic_arguments() |
|
412 | 412 | @magic_arguments.argument('--breakpoint', '-b', metavar='FILE:LINE', |
|
413 | 413 | help=""" |
|
414 | 414 | Set break point at LINE in FILE. |
|
415 | 415 | """ |
|
416 | 416 | ) |
|
417 | 417 | @magic_arguments.argument('statement', nargs='*', |
|
418 | 418 | help=""" |
|
419 | 419 | Code to run in debugger. |
|
420 | 420 | You can omit this in cell magic mode. |
|
421 | 421 | """ |
|
422 | 422 | ) |
|
423 | 423 | @no_var_expand |
|
424 | 424 | @line_cell_magic |
|
425 | 425 | def debug(self, line='', cell=None): |
|
426 | 426 | """Activate the interactive debugger. |
|
427 | 427 | |
|
428 | 428 | This magic command support two ways of activating debugger. |
|
429 | 429 | One is to activate debugger before executing code. This way, you |
|
430 | 430 | can set a break point, to step through the code from the point. |
|
431 | 431 | You can use this mode by giving statements to execute and optionally |
|
432 | 432 | a breakpoint. |
|
433 | 433 | |
|
434 | 434 | The other one is to activate debugger in post-mortem mode. You can |
|
435 | 435 | activate this mode simply running %debug without any argument. |
|
436 | 436 | If an exception has just occurred, this lets you inspect its stack |
|
437 | 437 | frames interactively. Note that this will always work only on the last |
|
438 | 438 | traceback that occurred, so you must call this quickly after an |
|
439 | 439 | exception that you wish to inspect has fired, because if another one |
|
440 | 440 | occurs, it clobbers the previous one. |
|
441 | 441 | |
|
442 | 442 | If you want IPython to automatically do this on every exception, see |
|
443 | 443 | the %pdb magic for more details. |
|
444 | 444 | |
|
445 | 445 | .. versionchanged:: 7.3 |
|
446 | 446 | When running code, user variables are no longer expanded, |
|
447 | 447 | the magic line is always left unmodified. |
|
448 | 448 | |
|
449 | 449 | """ |
|
450 | 450 | args = magic_arguments.parse_argstring(self.debug, line) |
|
451 | 451 | |
|
452 | 452 | if not (args.breakpoint or args.statement or cell): |
|
453 | 453 | self._debug_post_mortem() |
|
454 | 454 | else: |
|
455 | 455 | code = "\n".join(args.statement) |
|
456 | 456 | if cell: |
|
457 | 457 | code += "\n" + cell |
|
458 | 458 | self._debug_exec(code, args.breakpoint) |
|
459 | 459 | |
|
460 | 460 | def _debug_post_mortem(self): |
|
461 | 461 | self.shell.debugger(force=True) |
|
462 | 462 | |
|
463 | 463 | def _debug_exec(self, code, breakpoint): |
|
464 | 464 | if breakpoint: |
|
465 | 465 | (filename, bp_line) = breakpoint.rsplit(':', 1) |
|
466 | 466 | bp_line = int(bp_line) |
|
467 | 467 | else: |
|
468 | 468 | (filename, bp_line) = (None, None) |
|
469 | 469 | self._run_with_debugger(code, self.shell.user_ns, filename, bp_line) |
|
470 | 470 | |
|
471 | 471 | @line_magic |
|
472 | 472 | def tb(self, s): |
|
473 | 473 | """Print the last traceback. |
|
474 | 474 | |
|
475 | 475 | Optionally, specify an exception reporting mode, tuning the |
|
476 | 476 | verbosity of the traceback. By default the currently-active exception |
|
477 | 477 | mode is used. See %xmode for changing exception reporting modes. |
|
478 | 478 | |
|
479 | 479 | Valid modes: Plain, Context, Verbose, and Minimal. |
|
480 | 480 | """ |
|
481 | 481 | interactive_tb = self.shell.InteractiveTB |
|
482 | 482 | if s: |
|
483 | 483 | # Switch exception reporting mode for this one call. |
|
484 | 484 | # Ensure it is switched back. |
|
485 | 485 | def xmode_switch_err(name): |
|
486 | 486 | warn('Error changing %s exception modes.\n%s' % |
|
487 | 487 | (name,sys.exc_info()[1])) |
|
488 | 488 | |
|
489 | 489 | new_mode = s.strip().capitalize() |
|
490 | 490 | original_mode = interactive_tb.mode |
|
491 | 491 | try: |
|
492 | 492 | try: |
|
493 | 493 | interactive_tb.set_mode(mode=new_mode) |
|
494 | 494 | except Exception: |
|
495 | 495 | xmode_switch_err('user') |
|
496 | 496 | else: |
|
497 | 497 | self.shell.showtraceback() |
|
498 | 498 | finally: |
|
499 | 499 | interactive_tb.set_mode(mode=original_mode) |
|
500 | 500 | else: |
|
501 | 501 | self.shell.showtraceback() |
|
502 | 502 | |
|
503 | 503 | @skip_doctest |
|
504 | 504 | @line_magic |
|
505 | 505 | def run(self, parameter_s='', runner=None, |
|
506 | 506 | file_finder=get_py_filename): |
|
507 | 507 | """Run the named file inside IPython as a program. |
|
508 | 508 | |
|
509 | 509 | Usage:: |
|
510 | 510 | |
|
511 | 511 | %run [-n -i -e -G] |
|
512 | 512 | [( -t [-N<N>] | -d [-b<N>] | -p [profile options] )] |
|
513 | 513 | ( -m mod | file ) [args] |
|
514 | 514 | |
|
515 | 515 | Parameters after the filename are passed as command-line arguments to |
|
516 | 516 | the program (put in sys.argv). Then, control returns to IPython's |
|
517 | 517 | prompt. |
|
518 | 518 | |
|
519 | 519 | This is similar to running at a system prompt ``python file args``, |
|
520 | 520 | but with the advantage of giving you IPython's tracebacks, and of |
|
521 | 521 | loading all variables into your interactive namespace for further use |
|
522 | 522 | (unless -p is used, see below). |
|
523 | 523 | |
|
524 | 524 | The file is executed in a namespace initially consisting only of |
|
525 | 525 | ``__name__=='__main__'`` and sys.argv constructed as indicated. It thus |
|
526 | 526 | sees its environment as if it were being run as a stand-alone program |
|
527 | 527 | (except for sharing global objects such as previously imported |
|
528 | 528 | modules). But after execution, the IPython interactive namespace gets |
|
529 | 529 | updated with all variables defined in the program (except for __name__ |
|
530 | 530 | and sys.argv). This allows for very convenient loading of code for |
|
531 | 531 | interactive work, while giving each program a 'clean sheet' to run in. |
|
532 | 532 | |
|
533 | 533 | Arguments are expanded using shell-like glob match. Patterns |
|
534 | 534 | '*', '?', '[seq]' and '[!seq]' can be used. Additionally, |
|
535 | 535 | tilde '~' will be expanded into user's home directory. Unlike |
|
536 | 536 | real shells, quotation does not suppress expansions. Use |
|
537 | 537 | *two* back slashes (e.g. ``\\\\*``) to suppress expansions. |
|
538 | 538 | To completely disable these expansions, you can use -G flag. |
|
539 | 539 | |
|
540 | 540 | On Windows systems, the use of single quotes `'` when specifying |
|
541 | 541 | a file is not supported. Use double quotes `"`. |
|
542 | 542 | |
|
543 | 543 | Options: |
|
544 | 544 | |
|
545 | 545 | -n |
|
546 | 546 | __name__ is NOT set to '__main__', but to the running file's name |
|
547 | 547 | without extension (as python does under import). This allows running |
|
548 | 548 | scripts and reloading the definitions in them without calling code |
|
549 | 549 | protected by an ``if __name__ == "__main__"`` clause. |
|
550 | 550 | |
|
551 | 551 | -i |
|
552 | 552 | run the file in IPython's namespace instead of an empty one. This |
|
553 | 553 | is useful if you are experimenting with code written in a text editor |
|
554 | 554 | which depends on variables defined interactively. |
|
555 | 555 | |
|
556 | 556 | -e |
|
557 | 557 | ignore sys.exit() calls or SystemExit exceptions in the script |
|
558 | 558 | being run. This is particularly useful if IPython is being used to |
|
559 | 559 | run unittests, which always exit with a sys.exit() call. In such |
|
560 | 560 | cases you are interested in the output of the test results, not in |
|
561 | 561 | seeing a traceback of the unittest module. |
|
562 | 562 | |
|
563 | 563 | -t |
|
564 | 564 | print timing information at the end of the run. IPython will give |
|
565 | 565 | you an estimated CPU time consumption for your script, which under |
|
566 | 566 | Unix uses the resource module to avoid the wraparound problems of |
|
567 | 567 | time.clock(). Under Unix, an estimate of time spent on system tasks |
|
568 | 568 | is also given (for Windows platforms this is reported as 0.0). |
|
569 | 569 | |
|
570 | 570 | If -t is given, an additional ``-N<N>`` option can be given, where <N> |
|
571 | 571 | must be an integer indicating how many times you want the script to |
|
572 | 572 | run. The final timing report will include total and per run results. |
|
573 | 573 | |
|
574 | 574 | For example (testing the script uniq_stable.py):: |
|
575 | 575 | |
|
576 | 576 | In [1]: run -t uniq_stable |
|
577 | 577 | |
|
578 | 578 | IPython CPU timings (estimated): |
|
579 | 579 | User : 0.19597 s. |
|
580 | 580 | System: 0.0 s. |
|
581 | 581 | |
|
582 | 582 | In [2]: run -t -N5 uniq_stable |
|
583 | 583 | |
|
584 | 584 | IPython CPU timings (estimated): |
|
585 | 585 | Total runs performed: 5 |
|
586 | 586 | Times : Total Per run |
|
587 | 587 | User : 0.910862 s, 0.1821724 s. |
|
588 | 588 | System: 0.0 s, 0.0 s. |
|
589 | 589 | |
|
590 | 590 | -d |
|
591 | 591 | run your program under the control of pdb, the Python debugger. |
|
592 | 592 | This allows you to execute your program step by step, watch variables, |
|
593 | 593 | etc. Internally, what IPython does is similar to calling:: |
|
594 | 594 | |
|
595 | 595 | pdb.run('execfile("YOURFILENAME")') |
|
596 | 596 | |
|
597 | 597 | with a breakpoint set on line 1 of your file. You can change the line |
|
598 | 598 | number for this automatic breakpoint to be <N> by using the -bN option |
|
599 | 599 | (where N must be an integer). For example:: |
|
600 | 600 | |
|
601 | 601 | %run -d -b40 myscript |
|
602 | 602 | |
|
603 | 603 | will set the first breakpoint at line 40 in myscript.py. Note that |
|
604 | 604 | the first breakpoint must be set on a line which actually does |
|
605 | 605 | something (not a comment or docstring) for it to stop execution. |
|
606 | 606 | |
|
607 | 607 | Or you can specify a breakpoint in a different file:: |
|
608 | 608 | |
|
609 | 609 | %run -d -b myotherfile.py:20 myscript |
|
610 | 610 | |
|
611 | 611 | When the pdb debugger starts, you will see a (Pdb) prompt. You must |
|
612 | 612 | first enter 'c' (without quotes) to start execution up to the first |
|
613 | 613 | breakpoint. |
|
614 | 614 | |
|
615 | 615 | Entering 'help' gives information about the use of the debugger. You |
|
616 | 616 | can easily see pdb's full documentation with "import pdb;pdb.help()" |
|
617 | 617 | at a prompt. |
|
618 | 618 | |
|
619 | 619 | -p |
|
620 | 620 | run program under the control of the Python profiler module (which |
|
621 | 621 | prints a detailed report of execution times, function calls, etc). |
|
622 | 622 | |
|
623 | 623 | You can pass other options after -p which affect the behavior of the |
|
624 | 624 | profiler itself. See the docs for %prun for details. |
|
625 | 625 | |
|
626 | 626 | In this mode, the program's variables do NOT propagate back to the |
|
627 | 627 | IPython interactive namespace (because they remain in the namespace |
|
628 | 628 | where the profiler executes them). |
|
629 | 629 | |
|
630 | 630 | Internally this triggers a call to %prun, see its documentation for |
|
631 | 631 | details on the options available specifically for profiling. |
|
632 | 632 | |
|
633 | 633 | There is one special usage for which the text above doesn't apply: |
|
634 | 634 | if the filename ends with .ipy[nb], the file is run as ipython script, |
|
635 | 635 | just as if the commands were written on IPython prompt. |
|
636 | 636 | |
|
637 | 637 | -m |
|
638 | 638 | specify module name to load instead of script path. Similar to |
|
639 | 639 | the -m option for the python interpreter. Use this option last if you |
|
640 | 640 | want to combine with other %run options. Unlike the python interpreter |
|
641 | 641 | only source modules are allowed no .pyc or .pyo files. |
|
642 | 642 | For example:: |
|
643 | 643 | |
|
644 | 644 | %run -m example |
|
645 | 645 | |
|
646 | 646 | will run the example module. |
|
647 | 647 | |
|
648 | 648 | -G |
|
649 | 649 | disable shell-like glob expansion of arguments. |
|
650 | 650 | |
|
651 | 651 | """ |
|
652 | 652 | |
|
653 | 653 | # Logic to handle issue #3664 |
|
654 | 654 | # Add '--' after '-m <module_name>' to ignore additional args passed to a module. |
|
655 | 655 | if '-m' in parameter_s and '--' not in parameter_s: |
|
656 | 656 | argv = shlex.split(parameter_s, posix=(os.name == 'posix')) |
|
657 | 657 | for idx, arg in enumerate(argv): |
|
658 | 658 | if arg and arg.startswith('-') and arg != '-': |
|
659 | 659 | if arg == '-m': |
|
660 | 660 | argv.insert(idx + 2, '--') |
|
661 | 661 | break |
|
662 | 662 | else: |
|
663 | 663 | # Positional arg, break |
|
664 | 664 | break |
|
665 | 665 | parameter_s = ' '.join(shlex.quote(arg) for arg in argv) |
|
666 | 666 | |
|
667 | 667 | # get arguments and set sys.argv for program to be run. |
|
668 | 668 | opts, arg_lst = self.parse_options(parameter_s, |
|
669 | 669 | 'nidtN:b:pD:l:rs:T:em:G', |
|
670 | 670 | mode='list', list_all=1) |
|
671 | 671 | if "m" in opts: |
|
672 | 672 | modulename = opts["m"][0] |
|
673 | 673 | modpath = find_mod(modulename) |
|
674 | 674 | if modpath is None: |
|
675 | 675 | msg = '%r is not a valid modulename on sys.path'%modulename |
|
676 | 676 | raise Exception(msg) |
|
677 | 677 | arg_lst = [modpath] + arg_lst |
|
678 | 678 | try: |
|
679 | 679 | fpath = None # initialize to make sure fpath is in scope later |
|
680 | 680 | fpath = arg_lst[0] |
|
681 | 681 | filename = file_finder(fpath) |
|
682 | except IndexError: | |
|
682 | except IndexError as e: | |
|
683 | 683 | msg = 'you must provide at least a filename.' |
|
684 | raise Exception(msg) | |
|
684 | raise Exception(msg) from e | |
|
685 | 685 | except IOError as e: |
|
686 | 686 | try: |
|
687 | 687 | msg = str(e) |
|
688 | 688 | except UnicodeError: |
|
689 | 689 | msg = e.message |
|
690 | 690 | if os.name == 'nt' and re.match(r"^'.*'$",fpath): |
|
691 | 691 | warn('For Windows, use double quotes to wrap a filename: %run "mypath\\myfile.py"') |
|
692 | raise Exception(msg) | |
|
692 | raise Exception(msg) from e | |
|
693 | 693 | except TypeError: |
|
694 | 694 | if fpath in sys.meta_path: |
|
695 | 695 | filename = "" |
|
696 | 696 | else: |
|
697 | 697 | raise |
|
698 | 698 | |
|
699 | 699 | if filename.lower().endswith(('.ipy', '.ipynb')): |
|
700 | 700 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
701 | 701 | self.shell.user_ns['__file__'] = filename |
|
702 | 702 | self.shell.safe_execfile_ipy(filename, raise_exceptions=True) |
|
703 | 703 | return |
|
704 | 704 | |
|
705 | 705 | # Control the response to exit() calls made by the script being run |
|
706 | 706 | exit_ignore = 'e' in opts |
|
707 | 707 | |
|
708 | 708 | # Make sure that the running script gets a proper sys.argv as if it |
|
709 | 709 | # were run from a system shell. |
|
710 | 710 | save_argv = sys.argv # save it for later restoring |
|
711 | 711 | |
|
712 | 712 | if 'G' in opts: |
|
713 | 713 | args = arg_lst[1:] |
|
714 | 714 | else: |
|
715 | 715 | # tilde and glob expansion |
|
716 | 716 | args = shellglob(map(os.path.expanduser, arg_lst[1:])) |
|
717 | 717 | |
|
718 | 718 | sys.argv = [filename] + args # put in the proper filename |
|
719 | 719 | |
|
720 | 720 | if 'n' in opts: |
|
721 | 721 | name = os.path.splitext(os.path.basename(filename))[0] |
|
722 | 722 | else: |
|
723 | 723 | name = '__main__' |
|
724 | 724 | |
|
725 | 725 | if 'i' in opts: |
|
726 | 726 | # Run in user's interactive namespace |
|
727 | 727 | prog_ns = self.shell.user_ns |
|
728 | 728 | __name__save = self.shell.user_ns['__name__'] |
|
729 | 729 | prog_ns['__name__'] = name |
|
730 | 730 | main_mod = self.shell.user_module |
|
731 | 731 | |
|
732 | 732 | # Since '%run foo' emulates 'python foo.py' at the cmd line, we must |
|
733 | 733 | # set the __file__ global in the script's namespace |
|
734 | 734 | # TK: Is this necessary in interactive mode? |
|
735 | 735 | prog_ns['__file__'] = filename |
|
736 | 736 | else: |
|
737 | 737 | # Run in a fresh, empty namespace |
|
738 | 738 | |
|
739 | 739 | # The shell MUST hold a reference to prog_ns so after %run |
|
740 | 740 | # exits, the python deletion mechanism doesn't zero it out |
|
741 | 741 | # (leaving dangling references). See interactiveshell for details |
|
742 | 742 | main_mod = self.shell.new_main_mod(filename, name) |
|
743 | 743 | prog_ns = main_mod.__dict__ |
|
744 | 744 | |
|
745 | 745 | # pickle fix. See interactiveshell for an explanation. But we need to |
|
746 | 746 | # make sure that, if we overwrite __main__, we replace it at the end |
|
747 | 747 | main_mod_name = prog_ns['__name__'] |
|
748 | 748 | |
|
749 | 749 | if main_mod_name == '__main__': |
|
750 | 750 | restore_main = sys.modules['__main__'] |
|
751 | 751 | else: |
|
752 | 752 | restore_main = False |
|
753 | 753 | |
|
754 | 754 | # This needs to be undone at the end to prevent holding references to |
|
755 | 755 | # every single object ever created. |
|
756 | 756 | sys.modules[main_mod_name] = main_mod |
|
757 | 757 | |
|
758 | 758 | if 'p' in opts or 'd' in opts: |
|
759 | 759 | if 'm' in opts: |
|
760 | 760 | code = 'run_module(modulename, prog_ns)' |
|
761 | 761 | code_ns = { |
|
762 | 762 | 'run_module': self.shell.safe_run_module, |
|
763 | 763 | 'prog_ns': prog_ns, |
|
764 | 764 | 'modulename': modulename, |
|
765 | 765 | } |
|
766 | 766 | else: |
|
767 | 767 | if 'd' in opts: |
|
768 | 768 | # allow exceptions to raise in debug mode |
|
769 | 769 | code = 'execfile(filename, prog_ns, raise_exceptions=True)' |
|
770 | 770 | else: |
|
771 | 771 | code = 'execfile(filename, prog_ns)' |
|
772 | 772 | code_ns = { |
|
773 | 773 | 'execfile': self.shell.safe_execfile, |
|
774 | 774 | 'prog_ns': prog_ns, |
|
775 | 775 | 'filename': get_py_filename(filename), |
|
776 | 776 | } |
|
777 | 777 | |
|
778 | 778 | try: |
|
779 | 779 | stats = None |
|
780 | 780 | if 'p' in opts: |
|
781 | 781 | stats = self._run_with_profiler(code, opts, code_ns) |
|
782 | 782 | else: |
|
783 | 783 | if 'd' in opts: |
|
784 | 784 | bp_file, bp_line = parse_breakpoint( |
|
785 | 785 | opts.get('b', ['1'])[0], filename) |
|
786 | 786 | self._run_with_debugger( |
|
787 | 787 | code, code_ns, filename, bp_line, bp_file) |
|
788 | 788 | else: |
|
789 | 789 | if 'm' in opts: |
|
790 | 790 | def run(): |
|
791 | 791 | self.shell.safe_run_module(modulename, prog_ns) |
|
792 | 792 | else: |
|
793 | 793 | if runner is None: |
|
794 | 794 | runner = self.default_runner |
|
795 | 795 | if runner is None: |
|
796 | 796 | runner = self.shell.safe_execfile |
|
797 | 797 | |
|
798 | 798 | def run(): |
|
799 | 799 | runner(filename, prog_ns, prog_ns, |
|
800 | 800 | exit_ignore=exit_ignore) |
|
801 | 801 | |
|
802 | 802 | if 't' in opts: |
|
803 | 803 | # timed execution |
|
804 | 804 | try: |
|
805 | 805 | nruns = int(opts['N'][0]) |
|
806 | 806 | if nruns < 1: |
|
807 | 807 | error('Number of runs must be >=1') |
|
808 | 808 | return |
|
809 | 809 | except (KeyError): |
|
810 | 810 | nruns = 1 |
|
811 | 811 | self._run_with_timing(run, nruns) |
|
812 | 812 | else: |
|
813 | 813 | # regular execution |
|
814 | 814 | run() |
|
815 | 815 | |
|
816 | 816 | if 'i' in opts: |
|
817 | 817 | self.shell.user_ns['__name__'] = __name__save |
|
818 | 818 | else: |
|
819 | 819 | # update IPython interactive namespace |
|
820 | 820 | |
|
821 | 821 | # Some forms of read errors on the file may mean the |
|
822 | 822 | # __name__ key was never set; using pop we don't have to |
|
823 | 823 | # worry about a possible KeyError. |
|
824 | 824 | prog_ns.pop('__name__', None) |
|
825 | 825 | |
|
826 | 826 | with preserve_keys(self.shell.user_ns, '__file__'): |
|
827 | 827 | self.shell.user_ns.update(prog_ns) |
|
828 | 828 | finally: |
|
829 | 829 | # It's a bit of a mystery why, but __builtins__ can change from |
|
830 | 830 | # being a module to becoming a dict missing some key data after |
|
831 | 831 | # %run. As best I can see, this is NOT something IPython is doing |
|
832 | 832 | # at all, and similar problems have been reported before: |
|
833 | 833 | # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html |
|
834 | 834 | # Since this seems to be done by the interpreter itself, the best |
|
835 | 835 | # we can do is to at least restore __builtins__ for the user on |
|
836 | 836 | # exit. |
|
837 | 837 | self.shell.user_ns['__builtins__'] = builtin_mod |
|
838 | 838 | |
|
839 | 839 | # Ensure key global structures are restored |
|
840 | 840 | sys.argv = save_argv |
|
841 | 841 | if restore_main: |
|
842 | 842 | sys.modules['__main__'] = restore_main |
|
843 | 843 | if '__mp_main__' in sys.modules: |
|
844 | 844 | sys.modules['__mp_main__'] = restore_main |
|
845 | 845 | else: |
|
846 | 846 | # Remove from sys.modules the reference to main_mod we'd |
|
847 | 847 | # added. Otherwise it will trap references to objects |
|
848 | 848 | # contained therein. |
|
849 | 849 | del sys.modules[main_mod_name] |
|
850 | 850 | |
|
851 | 851 | return stats |
|
852 | 852 | |
|
853 | 853 | def _run_with_debugger(self, code, code_ns, filename=None, |
|
854 | 854 | bp_line=None, bp_file=None): |
|
855 | 855 | """ |
|
856 | 856 | Run `code` in debugger with a break point. |
|
857 | 857 | |
|
858 | 858 | Parameters |
|
859 | 859 | ---------- |
|
860 | 860 | code : str |
|
861 | 861 | Code to execute. |
|
862 | 862 | code_ns : dict |
|
863 | 863 | A namespace in which `code` is executed. |
|
864 | 864 | filename : str |
|
865 | 865 | `code` is ran as if it is in `filename`. |
|
866 | 866 | bp_line : int, optional |
|
867 | 867 | Line number of the break point. |
|
868 | 868 | bp_file : str, optional |
|
869 | 869 | Path to the file in which break point is specified. |
|
870 | 870 | `filename` is used if not given. |
|
871 | 871 | |
|
872 | 872 | Raises |
|
873 | 873 | ------ |
|
874 | 874 | UsageError |
|
875 | 875 | If the break point given by `bp_line` is not valid. |
|
876 | 876 | |
|
877 | 877 | """ |
|
878 | 878 | deb = self.shell.InteractiveTB.pdb |
|
879 | 879 | if not deb: |
|
880 | 880 | self.shell.InteractiveTB.pdb = self.shell.InteractiveTB.debugger_cls() |
|
881 | 881 | deb = self.shell.InteractiveTB.pdb |
|
882 | 882 | |
|
883 | 883 | # deb.checkline() fails if deb.curframe exists but is None; it can |
|
884 | 884 | # handle it not existing. https://github.com/ipython/ipython/issues/10028 |
|
885 | 885 | if hasattr(deb, 'curframe'): |
|
886 | 886 | del deb.curframe |
|
887 | 887 | |
|
888 | 888 | # reset Breakpoint state, which is moronically kept |
|
889 | 889 | # in a class |
|
890 | 890 | bdb.Breakpoint.next = 1 |
|
891 | 891 | bdb.Breakpoint.bplist = {} |
|
892 | 892 | bdb.Breakpoint.bpbynumber = [None] |
|
893 | 893 | deb.clear_all_breaks() |
|
894 | 894 | if bp_line is not None: |
|
895 | 895 | # Set an initial breakpoint to stop execution |
|
896 | 896 | maxtries = 10 |
|
897 | 897 | bp_file = bp_file or filename |
|
898 | 898 | checkline = deb.checkline(bp_file, bp_line) |
|
899 | 899 | if not checkline: |
|
900 | 900 | for bp in range(bp_line + 1, bp_line + maxtries + 1): |
|
901 | 901 | if deb.checkline(bp_file, bp): |
|
902 | 902 | break |
|
903 | 903 | else: |
|
904 | 904 | msg = ("\nI failed to find a valid line to set " |
|
905 | 905 | "a breakpoint\n" |
|
906 | 906 | "after trying up to line: %s.\n" |
|
907 | 907 | "Please set a valid breakpoint manually " |
|
908 | 908 | "with the -b option." % bp) |
|
909 | 909 | raise UsageError(msg) |
|
910 | 910 | # if we find a good linenumber, set the breakpoint |
|
911 | 911 | deb.do_break('%s:%s' % (bp_file, bp_line)) |
|
912 | 912 | |
|
913 | 913 | if filename: |
|
914 | 914 | # Mimic Pdb._runscript(...) |
|
915 | 915 | deb._wait_for_mainpyfile = True |
|
916 | 916 | deb.mainpyfile = deb.canonic(filename) |
|
917 | 917 | |
|
918 | 918 | # Start file run |
|
919 | 919 | print("NOTE: Enter 'c' at the %s prompt to continue execution." % deb.prompt) |
|
920 | 920 | try: |
|
921 | 921 | if filename: |
|
922 | 922 | # save filename so it can be used by methods on the deb object |
|
923 | 923 | deb._exec_filename = filename |
|
924 | 924 | while True: |
|
925 | 925 | try: |
|
926 | 926 | trace = sys.gettrace() |
|
927 | 927 | deb.run(code, code_ns) |
|
928 | 928 | except Restart: |
|
929 | 929 | print("Restarting") |
|
930 | 930 | if filename: |
|
931 | 931 | deb._wait_for_mainpyfile = True |
|
932 | 932 | deb.mainpyfile = deb.canonic(filename) |
|
933 | 933 | continue |
|
934 | 934 | else: |
|
935 | 935 | break |
|
936 | 936 | finally: |
|
937 | 937 | sys.settrace(trace) |
|
938 | 938 | |
|
939 | 939 | |
|
940 | 940 | except: |
|
941 | 941 | etype, value, tb = sys.exc_info() |
|
942 | 942 | # Skip three frames in the traceback: the %run one, |
|
943 | 943 | # one inside bdb.py, and the command-line typed by the |
|
944 | 944 | # user (run by exec in pdb itself). |
|
945 | 945 | self.shell.InteractiveTB(etype, value, tb, tb_offset=3) |
|
946 | 946 | |
|
947 | 947 | @staticmethod |
|
948 | 948 | def _run_with_timing(run, nruns): |
|
949 | 949 | """ |
|
950 | 950 | Run function `run` and print timing information. |
|
951 | 951 | |
|
952 | 952 | Parameters |
|
953 | 953 | ---------- |
|
954 | 954 | run : callable |
|
955 | 955 | Any callable object which takes no argument. |
|
956 | 956 | nruns : int |
|
957 | 957 | Number of times to execute `run`. |
|
958 | 958 | |
|
959 | 959 | """ |
|
960 | 960 | twall0 = time.perf_counter() |
|
961 | 961 | if nruns == 1: |
|
962 | 962 | t0 = clock2() |
|
963 | 963 | run() |
|
964 | 964 | t1 = clock2() |
|
965 | 965 | t_usr = t1[0] - t0[0] |
|
966 | 966 | t_sys = t1[1] - t0[1] |
|
967 | 967 | print("\nIPython CPU timings (estimated):") |
|
968 | 968 | print(" User : %10.2f s." % t_usr) |
|
969 | 969 | print(" System : %10.2f s." % t_sys) |
|
970 | 970 | else: |
|
971 | 971 | runs = range(nruns) |
|
972 | 972 | t0 = clock2() |
|
973 | 973 | for nr in runs: |
|
974 | 974 | run() |
|
975 | 975 | t1 = clock2() |
|
976 | 976 | t_usr = t1[0] - t0[0] |
|
977 | 977 | t_sys = t1[1] - t0[1] |
|
978 | 978 | print("\nIPython CPU timings (estimated):") |
|
979 | 979 | print("Total runs performed:", nruns) |
|
980 | 980 | print(" Times : %10s %10s" % ('Total', 'Per run')) |
|
981 | 981 | print(" User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)) |
|
982 | 982 | print(" System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)) |
|
983 | 983 | twall1 = time.perf_counter() |
|
984 | 984 | print("Wall time: %10.2f s." % (twall1 - twall0)) |
|
985 | 985 | |
|
986 | 986 | @skip_doctest |
|
987 | 987 | @no_var_expand |
|
988 | 988 | @line_cell_magic |
|
989 | 989 | @needs_local_scope |
|
990 | 990 | def timeit(self, line='', cell=None, local_ns=None): |
|
991 | 991 | """Time execution of a Python statement or expression |
|
992 | 992 | |
|
993 | 993 | Usage, in line mode: |
|
994 | 994 | %timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] statement |
|
995 | 995 | or in cell mode: |
|
996 | 996 | %%timeit [-n<N> -r<R> [-t|-c] -q -p<P> -o] setup_code |
|
997 | 997 | code |
|
998 | 998 | code... |
|
999 | 999 | |
|
1000 | 1000 | Time execution of a Python statement or expression using the timeit |
|
1001 | 1001 | module. This function can be used both as a line and cell magic: |
|
1002 | 1002 | |
|
1003 | 1003 | - In line mode you can time a single-line statement (though multiple |
|
1004 | 1004 | ones can be chained with using semicolons). |
|
1005 | 1005 | |
|
1006 | 1006 | - In cell mode, the statement in the first line is used as setup code |
|
1007 | 1007 | (executed but not timed) and the body of the cell is timed. The cell |
|
1008 | 1008 | body has access to any variables created in the setup code. |
|
1009 | 1009 | |
|
1010 | 1010 | Options: |
|
1011 | 1011 | -n<N>: execute the given statement <N> times in a loop. If <N> is not |
|
1012 | 1012 | provided, <N> is determined so as to get sufficient accuracy. |
|
1013 | 1013 | |
|
1014 | 1014 | -r<R>: number of repeats <R>, each consisting of <N> loops, and take the |
|
1015 | 1015 | best result. |
|
1016 | 1016 | Default: 7 |
|
1017 | 1017 | |
|
1018 | 1018 | -t: use time.time to measure the time, which is the default on Unix. |
|
1019 | 1019 | This function measures wall time. |
|
1020 | 1020 | |
|
1021 | 1021 | -c: use time.clock to measure the time, which is the default on |
|
1022 | 1022 | Windows and measures wall time. On Unix, resource.getrusage is used |
|
1023 | 1023 | instead and returns the CPU user time. |
|
1024 | 1024 | |
|
1025 | 1025 | -p<P>: use a precision of <P> digits to display the timing result. |
|
1026 | 1026 | Default: 3 |
|
1027 | 1027 | |
|
1028 | 1028 | -q: Quiet, do not print result. |
|
1029 | 1029 | |
|
1030 | 1030 | -o: return a TimeitResult that can be stored in a variable to inspect |
|
1031 | 1031 | the result in more details. |
|
1032 | 1032 | |
|
1033 | 1033 | .. versionchanged:: 7.3 |
|
1034 | 1034 | User variables are no longer expanded, |
|
1035 | 1035 | the magic line is always left unmodified. |
|
1036 | 1036 | |
|
1037 | 1037 | Examples |
|
1038 | 1038 | -------- |
|
1039 | 1039 | :: |
|
1040 | 1040 | |
|
1041 | 1041 | In [1]: %timeit pass |
|
1042 | 1042 | 8.26 ns Β± 0.12 ns per loop (mean Β± std. dev. of 7 runs, 100000000 loops each) |
|
1043 | 1043 | |
|
1044 | 1044 | In [2]: u = None |
|
1045 | 1045 | |
|
1046 | 1046 | In [3]: %timeit u is None |
|
1047 | 1047 | 29.9 ns Β± 0.643 ns per loop (mean Β± std. dev. of 7 runs, 10000000 loops each) |
|
1048 | 1048 | |
|
1049 | 1049 | In [4]: %timeit -r 4 u == None |
|
1050 | 1050 | |
|
1051 | 1051 | In [5]: import time |
|
1052 | 1052 | |
|
1053 | 1053 | In [6]: %timeit -n1 time.sleep(2) |
|
1054 | 1054 | |
|
1055 | 1055 | |
|
1056 | 1056 | The times reported by %timeit will be slightly higher than those |
|
1057 | 1057 | reported by the timeit.py script when variables are accessed. This is |
|
1058 | 1058 | due to the fact that %timeit executes the statement in the namespace |
|
1059 | 1059 | of the shell, compared with timeit.py, which uses a single setup |
|
1060 | 1060 | statement to import function or create variables. Generally, the bias |
|
1061 | 1061 | does not matter as long as results from timeit.py are not mixed with |
|
1062 | 1062 | those from %timeit.""" |
|
1063 | 1063 | |
|
1064 | 1064 | opts, stmt = self.parse_options(line,'n:r:tcp:qo', |
|
1065 | 1065 | posix=False, strict=False) |
|
1066 | 1066 | if stmt == "" and cell is None: |
|
1067 | 1067 | return |
|
1068 | 1068 | |
|
1069 | 1069 | timefunc = timeit.default_timer |
|
1070 | 1070 | number = int(getattr(opts, "n", 0)) |
|
1071 | 1071 | default_repeat = 7 if timeit.default_repeat < 7 else timeit.default_repeat |
|
1072 | 1072 | repeat = int(getattr(opts, "r", default_repeat)) |
|
1073 | 1073 | precision = int(getattr(opts, "p", 3)) |
|
1074 | 1074 | quiet = 'q' in opts |
|
1075 | 1075 | return_result = 'o' in opts |
|
1076 | 1076 | if hasattr(opts, "t"): |
|
1077 | 1077 | timefunc = time.time |
|
1078 | 1078 | if hasattr(opts, "c"): |
|
1079 | 1079 | timefunc = clock |
|
1080 | 1080 | |
|
1081 | 1081 | timer = Timer(timer=timefunc) |
|
1082 | 1082 | # this code has tight coupling to the inner workings of timeit.Timer, |
|
1083 | 1083 | # but is there a better way to achieve that the code stmt has access |
|
1084 | 1084 | # to the shell namespace? |
|
1085 | 1085 | transform = self.shell.transform_cell |
|
1086 | 1086 | |
|
1087 | 1087 | if cell is None: |
|
1088 | 1088 | # called as line magic |
|
1089 | 1089 | ast_setup = self.shell.compile.ast_parse("pass") |
|
1090 | 1090 | ast_stmt = self.shell.compile.ast_parse(transform(stmt)) |
|
1091 | 1091 | else: |
|
1092 | 1092 | ast_setup = self.shell.compile.ast_parse(transform(stmt)) |
|
1093 | 1093 | ast_stmt = self.shell.compile.ast_parse(transform(cell)) |
|
1094 | 1094 | |
|
1095 | 1095 | ast_setup = self.shell.transform_ast(ast_setup) |
|
1096 | 1096 | ast_stmt = self.shell.transform_ast(ast_stmt) |
|
1097 | 1097 | |
|
1098 | 1098 | # Check that these compile to valid Python code *outside* the timer func |
|
1099 | 1099 | # Invalid code may become valid when put inside the function & loop, |
|
1100 | 1100 | # which messes up error messages. |
|
1101 | 1101 | # https://github.com/ipython/ipython/issues/10636 |
|
1102 | 1102 | self.shell.compile(ast_setup, "<magic-timeit-setup>", "exec") |
|
1103 | 1103 | self.shell.compile(ast_stmt, "<magic-timeit-stmt>", "exec") |
|
1104 | 1104 | |
|
1105 | 1105 | # This codestring is taken from timeit.template - we fill it in as an |
|
1106 | 1106 | # AST, so that we can apply our AST transformations to the user code |
|
1107 | 1107 | # without affecting the timing code. |
|
1108 | 1108 | timeit_ast_template = ast.parse('def inner(_it, _timer):\n' |
|
1109 | 1109 | ' setup\n' |
|
1110 | 1110 | ' _t0 = _timer()\n' |
|
1111 | 1111 | ' for _i in _it:\n' |
|
1112 | 1112 | ' stmt\n' |
|
1113 | 1113 | ' _t1 = _timer()\n' |
|
1114 | 1114 | ' return _t1 - _t0\n') |
|
1115 | 1115 | |
|
1116 | 1116 | timeit_ast = TimeitTemplateFiller(ast_setup, ast_stmt).visit(timeit_ast_template) |
|
1117 | 1117 | timeit_ast = ast.fix_missing_locations(timeit_ast) |
|
1118 | 1118 | |
|
1119 | 1119 | # Track compilation time so it can be reported if too long |
|
1120 | 1120 | # Minimum time above which compilation time will be reported |
|
1121 | 1121 | tc_min = 0.1 |
|
1122 | 1122 | |
|
1123 | 1123 | t0 = clock() |
|
1124 | 1124 | code = self.shell.compile(timeit_ast, "<magic-timeit>", "exec") |
|
1125 | 1125 | tc = clock()-t0 |
|
1126 | 1126 | |
|
1127 | 1127 | ns = {} |
|
1128 | 1128 | glob = self.shell.user_ns |
|
1129 | 1129 | # handles global vars with same name as local vars. We store them in conflict_globs. |
|
1130 | 1130 | conflict_globs = {} |
|
1131 | 1131 | if local_ns and cell is None: |
|
1132 | 1132 | for var_name, var_val in glob.items(): |
|
1133 | 1133 | if var_name in local_ns: |
|
1134 | 1134 | conflict_globs[var_name] = var_val |
|
1135 | 1135 | glob.update(local_ns) |
|
1136 | 1136 | |
|
1137 | 1137 | exec(code, glob, ns) |
|
1138 | 1138 | timer.inner = ns["inner"] |
|
1139 | 1139 | |
|
1140 | 1140 | # This is used to check if there is a huge difference between the |
|
1141 | 1141 | # best and worst timings. |
|
1142 | 1142 | # Issue: https://github.com/ipython/ipython/issues/6471 |
|
1143 | 1143 | if number == 0: |
|
1144 | 1144 | # determine number so that 0.2 <= total time < 2.0 |
|
1145 | 1145 | for index in range(0, 10): |
|
1146 | 1146 | number = 10 ** index |
|
1147 | 1147 | time_number = timer.timeit(number) |
|
1148 | 1148 | if time_number >= 0.2: |
|
1149 | 1149 | break |
|
1150 | 1150 | |
|
1151 | 1151 | all_runs = timer.repeat(repeat, number) |
|
1152 | 1152 | best = min(all_runs) / number |
|
1153 | 1153 | worst = max(all_runs) / number |
|
1154 | 1154 | timeit_result = TimeitResult(number, repeat, best, worst, all_runs, tc, precision) |
|
1155 | 1155 | |
|
1156 | 1156 | # Restore global vars from conflict_globs |
|
1157 | 1157 | if conflict_globs: |
|
1158 | 1158 | glob.update(conflict_globs) |
|
1159 | 1159 | |
|
1160 | 1160 | if not quiet : |
|
1161 | 1161 | # Check best timing is greater than zero to avoid a |
|
1162 | 1162 | # ZeroDivisionError. |
|
1163 | 1163 | # In cases where the slowest timing is lesser than a microsecond |
|
1164 | 1164 | # we assume that it does not really matter if the fastest |
|
1165 | 1165 | # timing is 4 times faster than the slowest timing or not. |
|
1166 | 1166 | if worst > 4 * best and best > 0 and worst > 1e-6: |
|
1167 | 1167 | print("The slowest run took %0.2f times longer than the " |
|
1168 | 1168 | "fastest. This could mean that an intermediate result " |
|
1169 | 1169 | "is being cached." % (worst / best)) |
|
1170 | 1170 | |
|
1171 | 1171 | print( timeit_result ) |
|
1172 | 1172 | |
|
1173 | 1173 | if tc > tc_min: |
|
1174 | 1174 | print("Compiler time: %.2f s" % tc) |
|
1175 | 1175 | if return_result: |
|
1176 | 1176 | return timeit_result |
|
1177 | 1177 | |
|
1178 | 1178 | @skip_doctest |
|
1179 | 1179 | @no_var_expand |
|
1180 | 1180 | @needs_local_scope |
|
1181 | 1181 | @line_cell_magic |
|
1182 | 1182 | def time(self,line='', cell=None, local_ns=None): |
|
1183 | 1183 | """Time execution of a Python statement or expression. |
|
1184 | 1184 | |
|
1185 | 1185 | The CPU and wall clock times are printed, and the value of the |
|
1186 | 1186 | expression (if any) is returned. Note that under Win32, system time |
|
1187 | 1187 | is always reported as 0, since it can not be measured. |
|
1188 | 1188 | |
|
1189 | 1189 | This function can be used both as a line and cell magic: |
|
1190 | 1190 | |
|
1191 | 1191 | - In line mode you can time a single-line statement (though multiple |
|
1192 | 1192 | ones can be chained with using semicolons). |
|
1193 | 1193 | |
|
1194 | 1194 | - In cell mode, you can time the cell body (a directly |
|
1195 | 1195 | following statement raises an error). |
|
1196 | 1196 | |
|
1197 | 1197 | This function provides very basic timing functionality. Use the timeit |
|
1198 | 1198 | magic for more control over the measurement. |
|
1199 | 1199 | |
|
1200 | 1200 | .. versionchanged:: 7.3 |
|
1201 | 1201 | User variables are no longer expanded, |
|
1202 | 1202 | the magic line is always left unmodified. |
|
1203 | 1203 | |
|
1204 | 1204 | Examples |
|
1205 | 1205 | -------- |
|
1206 | 1206 | :: |
|
1207 | 1207 | |
|
1208 | 1208 | In [1]: %time 2**128 |
|
1209 | 1209 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1210 | 1210 | Wall time: 0.00 |
|
1211 | 1211 | Out[1]: 340282366920938463463374607431768211456L |
|
1212 | 1212 | |
|
1213 | 1213 | In [2]: n = 1000000 |
|
1214 | 1214 | |
|
1215 | 1215 | In [3]: %time sum(range(n)) |
|
1216 | 1216 | CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s |
|
1217 | 1217 | Wall time: 1.37 |
|
1218 | 1218 | Out[3]: 499999500000L |
|
1219 | 1219 | |
|
1220 | 1220 | In [4]: %time print 'hello world' |
|
1221 | 1221 | hello world |
|
1222 | 1222 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1223 | 1223 | Wall time: 0.00 |
|
1224 | 1224 | |
|
1225 | 1225 | Note that the time needed by Python to compile the given expression |
|
1226 | 1226 | will be reported if it is more than 0.1s. In this example, the |
|
1227 | 1227 | actual exponentiation is done by Python at compilation time, so while |
|
1228 | 1228 | the expression can take a noticeable amount of time to compute, that |
|
1229 | 1229 | time is purely due to the compilation: |
|
1230 | 1230 | |
|
1231 | 1231 | In [5]: %time 3**9999; |
|
1232 | 1232 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1233 | 1233 | Wall time: 0.00 s |
|
1234 | 1234 | |
|
1235 | 1235 | In [6]: %time 3**999999; |
|
1236 | 1236 | CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s |
|
1237 | 1237 | Wall time: 0.00 s |
|
1238 | 1238 | Compiler : 0.78 s |
|
1239 | 1239 | """ |
|
1240 | 1240 | |
|
1241 | 1241 | # fail immediately if the given expression can't be compiled |
|
1242 | 1242 | |
|
1243 | 1243 | if line and cell: |
|
1244 | 1244 | raise UsageError("Can't use statement directly after '%%time'!") |
|
1245 | 1245 | |
|
1246 | 1246 | if cell: |
|
1247 | 1247 | expr = self.shell.transform_cell(cell) |
|
1248 | 1248 | else: |
|
1249 | 1249 | expr = self.shell.transform_cell(line) |
|
1250 | 1250 | |
|
1251 | 1251 | # Minimum time above which parse time will be reported |
|
1252 | 1252 | tp_min = 0.1 |
|
1253 | 1253 | |
|
1254 | 1254 | t0 = clock() |
|
1255 | 1255 | expr_ast = self.shell.compile.ast_parse(expr) |
|
1256 | 1256 | tp = clock()-t0 |
|
1257 | 1257 | |
|
1258 | 1258 | # Apply AST transformations |
|
1259 | 1259 | expr_ast = self.shell.transform_ast(expr_ast) |
|
1260 | 1260 | |
|
1261 | 1261 | # Minimum time above which compilation time will be reported |
|
1262 | 1262 | tc_min = 0.1 |
|
1263 | 1263 | |
|
1264 | 1264 | expr_val=None |
|
1265 | 1265 | if len(expr_ast.body)==1 and isinstance(expr_ast.body[0], ast.Expr): |
|
1266 | 1266 | mode = 'eval' |
|
1267 | 1267 | source = '<timed eval>' |
|
1268 | 1268 | expr_ast = ast.Expression(expr_ast.body[0].value) |
|
1269 | 1269 | else: |
|
1270 | 1270 | mode = 'exec' |
|
1271 | 1271 | source = '<timed exec>' |
|
1272 | 1272 | # multi-line %%time case |
|
1273 | 1273 | if len(expr_ast.body) > 1 and isinstance(expr_ast.body[-1], ast.Expr): |
|
1274 | 1274 | expr_val= expr_ast.body[-1] |
|
1275 | 1275 | expr_ast = expr_ast.body[:-1] |
|
1276 | 1276 | expr_ast = Module(expr_ast, []) |
|
1277 | 1277 | expr_val = ast.Expression(expr_val.value) |
|
1278 | 1278 | |
|
1279 | 1279 | t0 = clock() |
|
1280 | 1280 | code = self.shell.compile(expr_ast, source, mode) |
|
1281 | 1281 | tc = clock()-t0 |
|
1282 | 1282 | |
|
1283 | 1283 | # skew measurement as little as possible |
|
1284 | 1284 | glob = self.shell.user_ns |
|
1285 | 1285 | wtime = time.time |
|
1286 | 1286 | # time execution |
|
1287 | 1287 | wall_st = wtime() |
|
1288 | 1288 | if mode=='eval': |
|
1289 | 1289 | st = clock2() |
|
1290 | 1290 | try: |
|
1291 | 1291 | out = eval(code, glob, local_ns) |
|
1292 | 1292 | except: |
|
1293 | 1293 | self.shell.showtraceback() |
|
1294 | 1294 | return |
|
1295 | 1295 | end = clock2() |
|
1296 | 1296 | else: |
|
1297 | 1297 | st = clock2() |
|
1298 | 1298 | try: |
|
1299 | 1299 | exec(code, glob, local_ns) |
|
1300 | 1300 | out=None |
|
1301 | 1301 | # multi-line %%time case |
|
1302 | 1302 | if expr_val is not None: |
|
1303 | 1303 | code_2 = self.shell.compile(expr_val, source, 'eval') |
|
1304 | 1304 | out = eval(code_2, glob, local_ns) |
|
1305 | 1305 | except: |
|
1306 | 1306 | self.shell.showtraceback() |
|
1307 | 1307 | return |
|
1308 | 1308 | end = clock2() |
|
1309 | 1309 | |
|
1310 | 1310 | wall_end = wtime() |
|
1311 | 1311 | # Compute actual times and report |
|
1312 | 1312 | wall_time = wall_end-wall_st |
|
1313 | 1313 | cpu_user = end[0]-st[0] |
|
1314 | 1314 | cpu_sys = end[1]-st[1] |
|
1315 | 1315 | cpu_tot = cpu_user+cpu_sys |
|
1316 | 1316 | # On windows cpu_sys is always zero, so no new information to the next print |
|
1317 | 1317 | if sys.platform != 'win32': |
|
1318 | 1318 | print("CPU times: user %s, sys: %s, total: %s" % \ |
|
1319 | 1319 | (_format_time(cpu_user),_format_time(cpu_sys),_format_time(cpu_tot))) |
|
1320 | 1320 | print("Wall time: %s" % _format_time(wall_time)) |
|
1321 | 1321 | if tc > tc_min: |
|
1322 | 1322 | print("Compiler : %s" % _format_time(tc)) |
|
1323 | 1323 | if tp > tp_min: |
|
1324 | 1324 | print("Parser : %s" % _format_time(tp)) |
|
1325 | 1325 | return out |
|
1326 | 1326 | |
|
1327 | 1327 | @skip_doctest |
|
1328 | 1328 | @line_magic |
|
1329 | 1329 | def macro(self, parameter_s=''): |
|
1330 | 1330 | """Define a macro for future re-execution. It accepts ranges of history, |
|
1331 | 1331 | filenames or string objects. |
|
1332 | 1332 | |
|
1333 | 1333 | Usage:\\ |
|
1334 | 1334 | %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ... |
|
1335 | 1335 | |
|
1336 | 1336 | Options: |
|
1337 | 1337 | |
|
1338 | 1338 | -r: use 'raw' input. By default, the 'processed' history is used, |
|
1339 | 1339 | so that magics are loaded in their transformed version to valid |
|
1340 | 1340 | Python. If this option is given, the raw input as typed at the |
|
1341 | 1341 | command line is used instead. |
|
1342 | 1342 | |
|
1343 | 1343 | -q: quiet macro definition. By default, a tag line is printed |
|
1344 | 1344 | to indicate the macro has been created, and then the contents of |
|
1345 | 1345 | the macro are printed. If this option is given, then no printout |
|
1346 | 1346 | is produced once the macro is created. |
|
1347 | 1347 | |
|
1348 | 1348 | This will define a global variable called `name` which is a string |
|
1349 | 1349 | made of joining the slices and lines you specify (n1,n2,... numbers |
|
1350 | 1350 | above) from your input history into a single string. This variable |
|
1351 | 1351 | acts like an automatic function which re-executes those lines as if |
|
1352 | 1352 | you had typed them. You just type 'name' at the prompt and the code |
|
1353 | 1353 | executes. |
|
1354 | 1354 | |
|
1355 | 1355 | The syntax for indicating input ranges is described in %history. |
|
1356 | 1356 | |
|
1357 | 1357 | Note: as a 'hidden' feature, you can also use traditional python slice |
|
1358 | 1358 | notation, where N:M means numbers N through M-1. |
|
1359 | 1359 | |
|
1360 | 1360 | For example, if your history contains (print using %hist -n ):: |
|
1361 | 1361 | |
|
1362 | 1362 | 44: x=1 |
|
1363 | 1363 | 45: y=3 |
|
1364 | 1364 | 46: z=x+y |
|
1365 | 1365 | 47: print x |
|
1366 | 1366 | 48: a=5 |
|
1367 | 1367 | 49: print 'x',x,'y',y |
|
1368 | 1368 | |
|
1369 | 1369 | you can create a macro with lines 44 through 47 (included) and line 49 |
|
1370 | 1370 | called my_macro with:: |
|
1371 | 1371 | |
|
1372 | 1372 | In [55]: %macro my_macro 44-47 49 |
|
1373 | 1373 | |
|
1374 | 1374 | Now, typing `my_macro` (without quotes) will re-execute all this code |
|
1375 | 1375 | in one pass. |
|
1376 | 1376 | |
|
1377 | 1377 | You don't need to give the line-numbers in order, and any given line |
|
1378 | 1378 | number can appear multiple times. You can assemble macros with any |
|
1379 | 1379 | lines from your input history in any order. |
|
1380 | 1380 | |
|
1381 | 1381 | The macro is a simple object which holds its value in an attribute, |
|
1382 | 1382 | but IPython's display system checks for macros and executes them as |
|
1383 | 1383 | code instead of printing them when you type their name. |
|
1384 | 1384 | |
|
1385 | 1385 | You can view a macro's contents by explicitly printing it with:: |
|
1386 | 1386 | |
|
1387 | 1387 | print macro_name |
|
1388 | 1388 | |
|
1389 | 1389 | """ |
|
1390 | 1390 | opts,args = self.parse_options(parameter_s,'rq',mode='list') |
|
1391 | 1391 | if not args: # List existing macros |
|
1392 | 1392 | return sorted(k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)) |
|
1393 | 1393 | if len(args) == 1: |
|
1394 | 1394 | raise UsageError( |
|
1395 | 1395 | "%macro insufficient args; usage '%macro name n1-n2 n3-4...") |
|
1396 | 1396 | name, codefrom = args[0], " ".join(args[1:]) |
|
1397 | 1397 | |
|
1398 | 1398 | #print 'rng',ranges # dbg |
|
1399 | 1399 | try: |
|
1400 | 1400 | lines = self.shell.find_user_code(codefrom, 'r' in opts) |
|
1401 | 1401 | except (ValueError, TypeError) as e: |
|
1402 | 1402 | print(e.args[0]) |
|
1403 | 1403 | return |
|
1404 | 1404 | macro = Macro(lines) |
|
1405 | 1405 | self.shell.define_macro(name, macro) |
|
1406 | 1406 | if not ( 'q' in opts) : |
|
1407 | 1407 | print('Macro `%s` created. To execute, type its name (without quotes).' % name) |
|
1408 | 1408 | print('=== Macro contents: ===') |
|
1409 | 1409 | print(macro, end=' ') |
|
1410 | 1410 | |
|
1411 | 1411 | @magic_arguments.magic_arguments() |
|
1412 | 1412 | @magic_arguments.argument('output', type=str, default='', nargs='?', |
|
1413 | 1413 | help="""The name of the variable in which to store output. |
|
1414 | 1414 | This is a utils.io.CapturedIO object with stdout/err attributes |
|
1415 | 1415 | for the text of the captured output. |
|
1416 | 1416 | |
|
1417 | 1417 | CapturedOutput also has a show() method for displaying the output, |
|
1418 | 1418 | and __call__ as well, so you can use that to quickly display the |
|
1419 | 1419 | output. |
|
1420 | 1420 | |
|
1421 | 1421 | If unspecified, captured output is discarded. |
|
1422 | 1422 | """ |
|
1423 | 1423 | ) |
|
1424 | 1424 | @magic_arguments.argument('--no-stderr', action="store_true", |
|
1425 | 1425 | help="""Don't capture stderr.""" |
|
1426 | 1426 | ) |
|
1427 | 1427 | @magic_arguments.argument('--no-stdout', action="store_true", |
|
1428 | 1428 | help="""Don't capture stdout.""" |
|
1429 | 1429 | ) |
|
1430 | 1430 | @magic_arguments.argument('--no-display', action="store_true", |
|
1431 | 1431 | help="""Don't capture IPython's rich display.""" |
|
1432 | 1432 | ) |
|
1433 | 1433 | @cell_magic |
|
1434 | 1434 | def capture(self, line, cell): |
|
1435 | 1435 | """run the cell, capturing stdout, stderr, and IPython's rich display() calls.""" |
|
1436 | 1436 | args = magic_arguments.parse_argstring(self.capture, line) |
|
1437 | 1437 | out = not args.no_stdout |
|
1438 | 1438 | err = not args.no_stderr |
|
1439 | 1439 | disp = not args.no_display |
|
1440 | 1440 | with capture_output(out, err, disp) as io: |
|
1441 | 1441 | self.shell.run_cell(cell) |
|
1442 | 1442 | if args.output: |
|
1443 | 1443 | self.shell.user_ns[args.output] = io |
|
1444 | 1444 | |
|
1445 | 1445 | def parse_breakpoint(text, current_file): |
|
1446 | 1446 | '''Returns (file, line) for file:line and (current_file, line) for line''' |
|
1447 | 1447 | colon = text.find(':') |
|
1448 | 1448 | if colon == -1: |
|
1449 | 1449 | return current_file, int(text) |
|
1450 | 1450 | else: |
|
1451 | 1451 | return text[:colon], int(text[colon+1:]) |
|
1452 | 1452 | |
|
1453 | 1453 | def _format_time(timespan, precision=3): |
|
1454 | 1454 | """Formats the timespan in a human readable form""" |
|
1455 | 1455 | |
|
1456 | 1456 | if timespan >= 60.0: |
|
1457 | 1457 | # we have more than a minute, format that in a human readable form |
|
1458 | 1458 | # Idea from http://snipplr.com/view/5713/ |
|
1459 | 1459 | parts = [("d", 60*60*24),("h", 60*60),("min", 60), ("s", 1)] |
|
1460 | 1460 | time = [] |
|
1461 | 1461 | leftover = timespan |
|
1462 | 1462 | for suffix, length in parts: |
|
1463 | 1463 | value = int(leftover / length) |
|
1464 | 1464 | if value > 0: |
|
1465 | 1465 | leftover = leftover % length |
|
1466 | 1466 | time.append(u'%s%s' % (str(value), suffix)) |
|
1467 | 1467 | if leftover < 1: |
|
1468 | 1468 | break |
|
1469 | 1469 | return " ".join(time) |
|
1470 | 1470 | |
|
1471 | 1471 | |
|
1472 | 1472 | # Unfortunately the unicode 'micro' symbol can cause problems in |
|
1473 | 1473 | # certain terminals. |
|
1474 | 1474 | # See bug: https://bugs.launchpad.net/ipython/+bug/348466 |
|
1475 | 1475 | # Try to prevent crashes by being more secure than it needs to |
|
1476 | 1476 | # E.g. eclipse is able to print a Β΅, but has no sys.stdout.encoding set. |
|
1477 | 1477 | units = [u"s", u"ms",u'us',"ns"] # the save value |
|
1478 | 1478 | if hasattr(sys.stdout, 'encoding') and sys.stdout.encoding: |
|
1479 | 1479 | try: |
|
1480 | 1480 | u'\xb5'.encode(sys.stdout.encoding) |
|
1481 | 1481 | units = [u"s", u"ms",u'\xb5s',"ns"] |
|
1482 | 1482 | except: |
|
1483 | 1483 | pass |
|
1484 | 1484 | scaling = [1, 1e3, 1e6, 1e9] |
|
1485 | 1485 | |
|
1486 | 1486 | if timespan > 0.0: |
|
1487 | 1487 | order = min(-int(math.floor(math.log10(timespan)) // 3), 3) |
|
1488 | 1488 | else: |
|
1489 | 1489 | order = 3 |
|
1490 | 1490 | return u"%.*g %s" % (precision, timespan * scaling[order], units[order]) |
@@ -1,708 +1,708 b'' | |||
|
1 | 1 | """Implementation of namespace-related magic functions. |
|
2 | 2 | """ |
|
3 | 3 | #----------------------------------------------------------------------------- |
|
4 | 4 | # Copyright (c) 2012 The IPython Development Team. |
|
5 | 5 | # |
|
6 | 6 | # Distributed under the terms of the Modified BSD License. |
|
7 | 7 | # |
|
8 | 8 | # The full license is in the file COPYING.txt, distributed with this software. |
|
9 | 9 | #----------------------------------------------------------------------------- |
|
10 | 10 | |
|
11 | 11 | #----------------------------------------------------------------------------- |
|
12 | 12 | # Imports |
|
13 | 13 | #----------------------------------------------------------------------------- |
|
14 | 14 | |
|
15 | 15 | # Stdlib |
|
16 | 16 | import gc |
|
17 | 17 | import re |
|
18 | 18 | import sys |
|
19 | 19 | |
|
20 | 20 | # Our own packages |
|
21 | 21 | from IPython.core import page |
|
22 | 22 | from IPython.core.error import StdinNotImplementedError, UsageError |
|
23 | 23 | from IPython.core.magic import Magics, magics_class, line_magic |
|
24 | 24 | from IPython.testing.skipdoctest import skip_doctest |
|
25 | 25 | from IPython.utils.encoding import DEFAULT_ENCODING |
|
26 | 26 | from IPython.utils.openpy import read_py_file |
|
27 | 27 | from IPython.utils.path import get_py_filename |
|
28 | 28 | |
|
29 | 29 | #----------------------------------------------------------------------------- |
|
30 | 30 | # Magic implementation classes |
|
31 | 31 | #----------------------------------------------------------------------------- |
|
32 | 32 | |
|
33 | 33 | @magics_class |
|
34 | 34 | class NamespaceMagics(Magics): |
|
35 | 35 | """Magics to manage various aspects of the user's namespace. |
|
36 | 36 | |
|
37 | 37 | These include listing variables, introspecting into them, etc. |
|
38 | 38 | """ |
|
39 | 39 | |
|
40 | 40 | @line_magic |
|
41 | 41 | def pinfo(self, parameter_s='', namespaces=None): |
|
42 | 42 | """Provide detailed information about an object. |
|
43 | 43 | |
|
44 | 44 | '%pinfo object' is just a synonym for object? or ?object.""" |
|
45 | 45 | |
|
46 | 46 | #print 'pinfo par: <%s>' % parameter_s # dbg |
|
47 | 47 | # detail_level: 0 -> obj? , 1 -> obj?? |
|
48 | 48 | detail_level = 0 |
|
49 | 49 | # We need to detect if we got called as 'pinfo pinfo foo', which can |
|
50 | 50 | # happen if the user types 'pinfo foo?' at the cmd line. |
|
51 | 51 | pinfo,qmark1,oname,qmark2 = \ |
|
52 | 52 | re.match(r'(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups() |
|
53 | 53 | if pinfo or qmark1 or qmark2: |
|
54 | 54 | detail_level = 1 |
|
55 | 55 | if "*" in oname: |
|
56 | 56 | self.psearch(oname) |
|
57 | 57 | else: |
|
58 | 58 | self.shell._inspect('pinfo', oname, detail_level=detail_level, |
|
59 | 59 | namespaces=namespaces) |
|
60 | 60 | |
|
61 | 61 | @line_magic |
|
62 | 62 | def pinfo2(self, parameter_s='', namespaces=None): |
|
63 | 63 | """Provide extra detailed information about an object. |
|
64 | 64 | |
|
65 | 65 | '%pinfo2 object' is just a synonym for object?? or ??object.""" |
|
66 | 66 | self.shell._inspect('pinfo', parameter_s, detail_level=1, |
|
67 | 67 | namespaces=namespaces) |
|
68 | 68 | |
|
69 | 69 | @skip_doctest |
|
70 | 70 | @line_magic |
|
71 | 71 | def pdef(self, parameter_s='', namespaces=None): |
|
72 | 72 | """Print the call signature for any callable object. |
|
73 | 73 | |
|
74 | 74 | If the object is a class, print the constructor information. |
|
75 | 75 | |
|
76 | 76 | Examples |
|
77 | 77 | -------- |
|
78 | 78 | :: |
|
79 | 79 | |
|
80 | 80 | In [3]: %pdef urllib.urlopen |
|
81 | 81 | urllib.urlopen(url, data=None, proxies=None) |
|
82 | 82 | """ |
|
83 | 83 | self.shell._inspect('pdef',parameter_s, namespaces) |
|
84 | 84 | |
|
85 | 85 | @line_magic |
|
86 | 86 | def pdoc(self, parameter_s='', namespaces=None): |
|
87 | 87 | """Print the docstring for an object. |
|
88 | 88 | |
|
89 | 89 | If the given object is a class, it will print both the class and the |
|
90 | 90 | constructor docstrings.""" |
|
91 | 91 | self.shell._inspect('pdoc',parameter_s, namespaces) |
|
92 | 92 | |
|
93 | 93 | @line_magic |
|
94 | 94 | def psource(self, parameter_s='', namespaces=None): |
|
95 | 95 | """Print (or run through pager) the source code for an object.""" |
|
96 | 96 | if not parameter_s: |
|
97 | 97 | raise UsageError('Missing object name.') |
|
98 | 98 | self.shell._inspect('psource',parameter_s, namespaces) |
|
99 | 99 | |
|
100 | 100 | @line_magic |
|
101 | 101 | def pfile(self, parameter_s='', namespaces=None): |
|
102 | 102 | """Print (or run through pager) the file where an object is defined. |
|
103 | 103 | |
|
104 | 104 | The file opens at the line where the object definition begins. IPython |
|
105 | 105 | will honor the environment variable PAGER if set, and otherwise will |
|
106 | 106 | do its best to print the file in a convenient form. |
|
107 | 107 | |
|
108 | 108 | If the given argument is not an object currently defined, IPython will |
|
109 | 109 | try to interpret it as a filename (automatically adding a .py extension |
|
110 | 110 | if needed). You can thus use %pfile as a syntax highlighting code |
|
111 | 111 | viewer.""" |
|
112 | 112 | |
|
113 | 113 | # first interpret argument as an object name |
|
114 | 114 | out = self.shell._inspect('pfile',parameter_s, namespaces) |
|
115 | 115 | # if not, try the input as a filename |
|
116 | 116 | if out == 'not found': |
|
117 | 117 | try: |
|
118 | 118 | filename = get_py_filename(parameter_s) |
|
119 | 119 | except IOError as msg: |
|
120 | 120 | print(msg) |
|
121 | 121 | return |
|
122 | 122 | page.page(self.shell.pycolorize(read_py_file(filename, skip_encoding_cookie=False))) |
|
123 | 123 | |
|
124 | 124 | @line_magic |
|
125 | 125 | def psearch(self, parameter_s=''): |
|
126 | 126 | """Search for object in namespaces by wildcard. |
|
127 | 127 | |
|
128 | 128 | %psearch [options] PATTERN [OBJECT TYPE] |
|
129 | 129 | |
|
130 | 130 | Note: ? can be used as a synonym for %psearch, at the beginning or at |
|
131 | 131 | the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the |
|
132 | 132 | rest of the command line must be unchanged (options come first), so |
|
133 | 133 | for example the following forms are equivalent |
|
134 | 134 | |
|
135 | 135 | %psearch -i a* function |
|
136 | 136 | -i a* function? |
|
137 | 137 | ?-i a* function |
|
138 | 138 | |
|
139 | 139 | Arguments: |
|
140 | 140 | |
|
141 | 141 | PATTERN |
|
142 | 142 | |
|
143 | 143 | where PATTERN is a string containing * as a wildcard similar to its |
|
144 | 144 | use in a shell. The pattern is matched in all namespaces on the |
|
145 | 145 | search path. By default objects starting with a single _ are not |
|
146 | 146 | matched, many IPython generated objects have a single |
|
147 | 147 | underscore. The default is case insensitive matching. Matching is |
|
148 | 148 | also done on the attributes of objects and not only on the objects |
|
149 | 149 | in a module. |
|
150 | 150 | |
|
151 | 151 | [OBJECT TYPE] |
|
152 | 152 | |
|
153 | 153 | Is the name of a python type from the types module. The name is |
|
154 | 154 | given in lowercase without the ending type, ex. StringType is |
|
155 | 155 | written string. By adding a type here only objects matching the |
|
156 | 156 | given type are matched. Using all here makes the pattern match all |
|
157 | 157 | types (this is the default). |
|
158 | 158 | |
|
159 | 159 | Options: |
|
160 | 160 | |
|
161 | 161 | -a: makes the pattern match even objects whose names start with a |
|
162 | 162 | single underscore. These names are normally omitted from the |
|
163 | 163 | search. |
|
164 | 164 | |
|
165 | 165 | -i/-c: make the pattern case insensitive/sensitive. If neither of |
|
166 | 166 | these options are given, the default is read from your configuration |
|
167 | 167 | file, with the option ``InteractiveShell.wildcards_case_sensitive``. |
|
168 | 168 | If this option is not specified in your configuration file, IPython's |
|
169 | 169 | internal default is to do a case sensitive search. |
|
170 | 170 | |
|
171 | 171 | -e/-s NAMESPACE: exclude/search a given namespace. The pattern you |
|
172 | 172 | specify can be searched in any of the following namespaces: |
|
173 | 173 | 'builtin', 'user', 'user_global','internal', 'alias', where |
|
174 | 174 | 'builtin' and 'user' are the search defaults. Note that you should |
|
175 | 175 | not use quotes when specifying namespaces. |
|
176 | 176 | |
|
177 | 177 | -l: List all available object types for object matching. This function |
|
178 | 178 | can be used without arguments. |
|
179 | 179 | |
|
180 | 180 | 'Builtin' contains the python module builtin, 'user' contains all |
|
181 | 181 | user data, 'alias' only contain the shell aliases and no python |
|
182 | 182 | objects, 'internal' contains objects used by IPython. The |
|
183 | 183 | 'user_global' namespace is only used by embedded IPython instances, |
|
184 | 184 | and it contains module-level globals. You can add namespaces to the |
|
185 | 185 | search with -s or exclude them with -e (these options can be given |
|
186 | 186 | more than once). |
|
187 | 187 | |
|
188 | 188 | Examples |
|
189 | 189 | -------- |
|
190 | 190 | :: |
|
191 | 191 | |
|
192 | 192 | %psearch a* -> objects beginning with an a |
|
193 | 193 | %psearch -e builtin a* -> objects NOT in the builtin space starting in a |
|
194 | 194 | %psearch a* function -> all functions beginning with an a |
|
195 | 195 | %psearch re.e* -> objects beginning with an e in module re |
|
196 | 196 | %psearch r*.e* -> objects that start with e in modules starting in r |
|
197 | 197 | %psearch r*.* string -> all strings in modules beginning with r |
|
198 | 198 | |
|
199 | 199 | Case sensitive search:: |
|
200 | 200 | |
|
201 | 201 | %psearch -c a* list all object beginning with lower case a |
|
202 | 202 | |
|
203 | 203 | Show objects beginning with a single _:: |
|
204 | 204 | |
|
205 | 205 | %psearch -a _* list objects beginning with a single underscore |
|
206 | 206 | |
|
207 | 207 | List available objects:: |
|
208 | 208 | |
|
209 | 209 | %psearch -l list all available object types |
|
210 | 210 | """ |
|
211 | 211 | # default namespaces to be searched |
|
212 | 212 | def_search = ['user_local', 'user_global', 'builtin'] |
|
213 | 213 | |
|
214 | 214 | # Process options/args |
|
215 | 215 | opts,args = self.parse_options(parameter_s,'cias:e:l',list_all=True) |
|
216 | 216 | opt = opts.get |
|
217 | 217 | shell = self.shell |
|
218 | 218 | psearch = shell.inspector.psearch |
|
219 | 219 | |
|
220 | 220 | # select list object types |
|
221 | 221 | list_types = False |
|
222 | 222 | if 'l' in opts: |
|
223 | 223 | list_types = True |
|
224 | 224 | |
|
225 | 225 | # select case options |
|
226 | 226 | if 'i' in opts: |
|
227 | 227 | ignore_case = True |
|
228 | 228 | elif 'c' in opts: |
|
229 | 229 | ignore_case = False |
|
230 | 230 | else: |
|
231 | 231 | ignore_case = not shell.wildcards_case_sensitive |
|
232 | 232 | |
|
233 | 233 | # Build list of namespaces to search from user options |
|
234 | 234 | def_search.extend(opt('s',[])) |
|
235 | 235 | ns_exclude = ns_exclude=opt('e',[]) |
|
236 | 236 | ns_search = [nm for nm in def_search if nm not in ns_exclude] |
|
237 | 237 | |
|
238 | 238 | # Call the actual search |
|
239 | 239 | try: |
|
240 | 240 | psearch(args,shell.ns_table,ns_search, |
|
241 | 241 | show_all=opt('a'),ignore_case=ignore_case, list_types=list_types) |
|
242 | 242 | except: |
|
243 | 243 | shell.showtraceback() |
|
244 | 244 | |
|
245 | 245 | @skip_doctest |
|
246 | 246 | @line_magic |
|
247 | 247 | def who_ls(self, parameter_s=''): |
|
248 | 248 | """Return a sorted list of all interactive variables. |
|
249 | 249 | |
|
250 | 250 | If arguments are given, only variables of types matching these |
|
251 | 251 | arguments are returned. |
|
252 | 252 | |
|
253 | 253 | Examples |
|
254 | 254 | -------- |
|
255 | 255 | |
|
256 | 256 | Define two variables and list them with who_ls:: |
|
257 | 257 | |
|
258 | 258 | In [1]: alpha = 123 |
|
259 | 259 | |
|
260 | 260 | In [2]: beta = 'test' |
|
261 | 261 | |
|
262 | 262 | In [3]: %who_ls |
|
263 | 263 | Out[3]: ['alpha', 'beta'] |
|
264 | 264 | |
|
265 | 265 | In [4]: %who_ls int |
|
266 | 266 | Out[4]: ['alpha'] |
|
267 | 267 | |
|
268 | 268 | In [5]: %who_ls str |
|
269 | 269 | Out[5]: ['beta'] |
|
270 | 270 | """ |
|
271 | 271 | |
|
272 | 272 | user_ns = self.shell.user_ns |
|
273 | 273 | user_ns_hidden = self.shell.user_ns_hidden |
|
274 | 274 | nonmatching = object() # This can never be in user_ns |
|
275 | 275 | out = [ i for i in user_ns |
|
276 | 276 | if not i.startswith('_') \ |
|
277 | 277 | and (user_ns[i] is not user_ns_hidden.get(i, nonmatching)) ] |
|
278 | 278 | |
|
279 | 279 | typelist = parameter_s.split() |
|
280 | 280 | if typelist: |
|
281 | 281 | typeset = set(typelist) |
|
282 | 282 | out = [i for i in out if type(user_ns[i]).__name__ in typeset] |
|
283 | 283 | |
|
284 | 284 | out.sort() |
|
285 | 285 | return out |
|
286 | 286 | |
|
287 | 287 | @skip_doctest |
|
288 | 288 | @line_magic |
|
289 | 289 | def who(self, parameter_s=''): |
|
290 | 290 | """Print all interactive variables, with some minimal formatting. |
|
291 | 291 | |
|
292 | 292 | If any arguments are given, only variables whose type matches one of |
|
293 | 293 | these are printed. For example:: |
|
294 | 294 | |
|
295 | 295 | %who function str |
|
296 | 296 | |
|
297 | 297 | will only list functions and strings, excluding all other types of |
|
298 | 298 | variables. To find the proper type names, simply use type(var) at a |
|
299 | 299 | command line to see how python prints type names. For example: |
|
300 | 300 | |
|
301 | 301 | :: |
|
302 | 302 | |
|
303 | 303 | In [1]: type('hello')\\ |
|
304 | 304 | Out[1]: <type 'str'> |
|
305 | 305 | |
|
306 | 306 | indicates that the type name for strings is 'str'. |
|
307 | 307 | |
|
308 | 308 | ``%who`` always excludes executed names loaded through your configuration |
|
309 | 309 | file and things which are internal to IPython. |
|
310 | 310 | |
|
311 | 311 | This is deliberate, as typically you may load many modules and the |
|
312 | 312 | purpose of %who is to show you only what you've manually defined. |
|
313 | 313 | |
|
314 | 314 | Examples |
|
315 | 315 | -------- |
|
316 | 316 | |
|
317 | 317 | Define two variables and list them with who:: |
|
318 | 318 | |
|
319 | 319 | In [1]: alpha = 123 |
|
320 | 320 | |
|
321 | 321 | In [2]: beta = 'test' |
|
322 | 322 | |
|
323 | 323 | In [3]: %who |
|
324 | 324 | alpha beta |
|
325 | 325 | |
|
326 | 326 | In [4]: %who int |
|
327 | 327 | alpha |
|
328 | 328 | |
|
329 | 329 | In [5]: %who str |
|
330 | 330 | beta |
|
331 | 331 | """ |
|
332 | 332 | |
|
333 | 333 | varlist = self.who_ls(parameter_s) |
|
334 | 334 | if not varlist: |
|
335 | 335 | if parameter_s: |
|
336 | 336 | print('No variables match your requested type.') |
|
337 | 337 | else: |
|
338 | 338 | print('Interactive namespace is empty.') |
|
339 | 339 | return |
|
340 | 340 | |
|
341 | 341 | # if we have variables, move on... |
|
342 | 342 | count = 0 |
|
343 | 343 | for i in varlist: |
|
344 | 344 | print(i+'\t', end=' ') |
|
345 | 345 | count += 1 |
|
346 | 346 | if count > 8: |
|
347 | 347 | count = 0 |
|
348 | 348 | print() |
|
349 | 349 | print() |
|
350 | 350 | |
|
351 | 351 | @skip_doctest |
|
352 | 352 | @line_magic |
|
353 | 353 | def whos(self, parameter_s=''): |
|
354 | 354 | """Like %who, but gives some extra information about each variable. |
|
355 | 355 | |
|
356 | 356 | The same type filtering of %who can be applied here. |
|
357 | 357 | |
|
358 | 358 | For all variables, the type is printed. Additionally it prints: |
|
359 | 359 | |
|
360 | 360 | - For {},[],(): their length. |
|
361 | 361 | |
|
362 | 362 | - For numpy arrays, a summary with shape, number of |
|
363 | 363 | elements, typecode and size in memory. |
|
364 | 364 | |
|
365 | 365 | - Everything else: a string representation, snipping their middle if |
|
366 | 366 | too long. |
|
367 | 367 | |
|
368 | 368 | Examples |
|
369 | 369 | -------- |
|
370 | 370 | |
|
371 | 371 | Define two variables and list them with whos:: |
|
372 | 372 | |
|
373 | 373 | In [1]: alpha = 123 |
|
374 | 374 | |
|
375 | 375 | In [2]: beta = 'test' |
|
376 | 376 | |
|
377 | 377 | In [3]: %whos |
|
378 | 378 | Variable Type Data/Info |
|
379 | 379 | -------------------------------- |
|
380 | 380 | alpha int 123 |
|
381 | 381 | beta str test |
|
382 | 382 | """ |
|
383 | 383 | |
|
384 | 384 | varnames = self.who_ls(parameter_s) |
|
385 | 385 | if not varnames: |
|
386 | 386 | if parameter_s: |
|
387 | 387 | print('No variables match your requested type.') |
|
388 | 388 | else: |
|
389 | 389 | print('Interactive namespace is empty.') |
|
390 | 390 | return |
|
391 | 391 | |
|
392 | 392 | # if we have variables, move on... |
|
393 | 393 | |
|
394 | 394 | # for these types, show len() instead of data: |
|
395 | 395 | seq_types = ['dict', 'list', 'tuple'] |
|
396 | 396 | |
|
397 | 397 | # for numpy arrays, display summary info |
|
398 | 398 | ndarray_type = None |
|
399 | 399 | if 'numpy' in sys.modules: |
|
400 | 400 | try: |
|
401 | 401 | from numpy import ndarray |
|
402 | 402 | except ImportError: |
|
403 | 403 | pass |
|
404 | 404 | else: |
|
405 | 405 | ndarray_type = ndarray.__name__ |
|
406 | 406 | |
|
407 | 407 | # Find all variable names and types so we can figure out column sizes |
|
408 | 408 | |
|
409 | 409 | # some types are well known and can be shorter |
|
410 | 410 | abbrevs = {'IPython.core.macro.Macro' : 'Macro'} |
|
411 | 411 | def type_name(v): |
|
412 | 412 | tn = type(v).__name__ |
|
413 | 413 | return abbrevs.get(tn,tn) |
|
414 | 414 | |
|
415 | 415 | varlist = [self.shell.user_ns[n] for n in varnames] |
|
416 | 416 | |
|
417 | 417 | typelist = [] |
|
418 | 418 | for vv in varlist: |
|
419 | 419 | tt = type_name(vv) |
|
420 | 420 | |
|
421 | 421 | if tt=='instance': |
|
422 | 422 | typelist.append( abbrevs.get(str(vv.__class__), |
|
423 | 423 | str(vv.__class__))) |
|
424 | 424 | else: |
|
425 | 425 | typelist.append(tt) |
|
426 | 426 | |
|
427 | 427 | # column labels and # of spaces as separator |
|
428 | 428 | varlabel = 'Variable' |
|
429 | 429 | typelabel = 'Type' |
|
430 | 430 | datalabel = 'Data/Info' |
|
431 | 431 | colsep = 3 |
|
432 | 432 | # variable format strings |
|
433 | 433 | vformat = "{0:<{varwidth}}{1:<{typewidth}}" |
|
434 | 434 | aformat = "%s: %s elems, type `%s`, %s bytes" |
|
435 | 435 | # find the size of the columns to format the output nicely |
|
436 | 436 | varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep |
|
437 | 437 | typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep |
|
438 | 438 | # table header |
|
439 | 439 | print(varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \ |
|
440 | 440 | ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)) |
|
441 | 441 | # and the table itself |
|
442 | 442 | kb = 1024 |
|
443 | 443 | Mb = 1048576 # kb**2 |
|
444 | 444 | for vname,var,vtype in zip(varnames,varlist,typelist): |
|
445 | 445 | print(vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth), end=' ') |
|
446 | 446 | if vtype in seq_types: |
|
447 | 447 | print("n="+str(len(var))) |
|
448 | 448 | elif vtype == ndarray_type: |
|
449 | 449 | vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1] |
|
450 | 450 | if vtype==ndarray_type: |
|
451 | 451 | # numpy |
|
452 | 452 | vsize = var.size |
|
453 | 453 | vbytes = vsize*var.itemsize |
|
454 | 454 | vdtype = var.dtype |
|
455 | 455 | |
|
456 | 456 | if vbytes < 100000: |
|
457 | 457 | print(aformat % (vshape, vsize, vdtype, vbytes)) |
|
458 | 458 | else: |
|
459 | 459 | print(aformat % (vshape, vsize, vdtype, vbytes), end=' ') |
|
460 | 460 | if vbytes < Mb: |
|
461 | 461 | print('(%s kb)' % (vbytes/kb,)) |
|
462 | 462 | else: |
|
463 | 463 | print('(%s Mb)' % (vbytes/Mb,)) |
|
464 | 464 | else: |
|
465 | 465 | try: |
|
466 | 466 | vstr = str(var) |
|
467 | 467 | except UnicodeEncodeError: |
|
468 | 468 | vstr = var.encode(DEFAULT_ENCODING, |
|
469 | 469 | 'backslashreplace') |
|
470 | 470 | except: |
|
471 | 471 | vstr = "<object with id %d (str() failed)>" % id(var) |
|
472 | 472 | vstr = vstr.replace('\n', '\\n') |
|
473 | 473 | if len(vstr) < 50: |
|
474 | 474 | print(vstr) |
|
475 | 475 | else: |
|
476 | 476 | print(vstr[:25] + "<...>" + vstr[-25:]) |
|
477 | 477 | |
|
478 | 478 | @line_magic |
|
479 | 479 | def reset(self, parameter_s=''): |
|
480 | 480 | """Resets the namespace by removing all names defined by the user, if |
|
481 | 481 | called without arguments, or by removing some types of objects, such |
|
482 | 482 | as everything currently in IPython's In[] and Out[] containers (see |
|
483 | 483 | the parameters for details). |
|
484 | 484 | |
|
485 | 485 | Parameters |
|
486 | 486 | ---------- |
|
487 | 487 | -f : force reset without asking for confirmation. |
|
488 | 488 | |
|
489 | 489 | -s : 'Soft' reset: Only clears your namespace, leaving history intact. |
|
490 | 490 | References to objects may be kept. By default (without this option), |
|
491 | 491 | we do a 'hard' reset, giving you a new session and removing all |
|
492 | 492 | references to objects from the current session. |
|
493 | 493 | |
|
494 | 494 | in : reset input history |
|
495 | 495 | |
|
496 | 496 | out : reset output history |
|
497 | 497 | |
|
498 | 498 | dhist : reset directory history |
|
499 | 499 | |
|
500 | 500 | array : reset only variables that are NumPy arrays |
|
501 | 501 | |
|
502 | 502 | See Also |
|
503 | 503 | -------- |
|
504 | 504 | reset_selective : invoked as ``%reset_selective`` |
|
505 | 505 | |
|
506 | 506 | Examples |
|
507 | 507 | -------- |
|
508 | 508 | :: |
|
509 | 509 | |
|
510 | 510 | In [6]: a = 1 |
|
511 | 511 | |
|
512 | 512 | In [7]: a |
|
513 | 513 | Out[7]: 1 |
|
514 | 514 | |
|
515 | 515 | In [8]: 'a' in get_ipython().user_ns |
|
516 | 516 | Out[8]: True |
|
517 | 517 | |
|
518 | 518 | In [9]: %reset -f |
|
519 | 519 | |
|
520 | 520 | In [1]: 'a' in get_ipython().user_ns |
|
521 | 521 | Out[1]: False |
|
522 | 522 | |
|
523 | 523 | In [2]: %reset -f in |
|
524 | 524 | Flushing input history |
|
525 | 525 | |
|
526 | 526 | In [3]: %reset -f dhist in |
|
527 | 527 | Flushing directory history |
|
528 | 528 | Flushing input history |
|
529 | 529 | |
|
530 | 530 | Notes |
|
531 | 531 | ----- |
|
532 | 532 | Calling this magic from clients that do not implement standard input, |
|
533 | 533 | such as the ipython notebook interface, will reset the namespace |
|
534 | 534 | without confirmation. |
|
535 | 535 | """ |
|
536 | 536 | opts, args = self.parse_options(parameter_s,'sf', mode='list') |
|
537 | 537 | if 'f' in opts: |
|
538 | 538 | ans = True |
|
539 | 539 | else: |
|
540 | 540 | try: |
|
541 | 541 | ans = self.shell.ask_yes_no( |
|
542 | 542 | "Once deleted, variables cannot be recovered. Proceed (y/[n])?", |
|
543 | 543 | default='n') |
|
544 | 544 | except StdinNotImplementedError: |
|
545 | 545 | ans = True |
|
546 | 546 | if not ans: |
|
547 | 547 | print('Nothing done.') |
|
548 | 548 | return |
|
549 | 549 | |
|
550 | 550 | if 's' in opts: # Soft reset |
|
551 | 551 | user_ns = self.shell.user_ns |
|
552 | 552 | for i in self.who_ls(): |
|
553 | 553 | del(user_ns[i]) |
|
554 | 554 | elif len(args) == 0: # Hard reset |
|
555 | 555 | self.shell.reset(new_session = False) |
|
556 | 556 | |
|
557 | 557 | # reset in/out/dhist/array: previously extensinions/clearcmd.py |
|
558 | 558 | ip = self.shell |
|
559 | 559 | user_ns = self.shell.user_ns # local lookup, heavily used |
|
560 | 560 | |
|
561 | 561 | for target in args: |
|
562 | 562 | target = target.lower() # make matches case insensitive |
|
563 | 563 | if target == 'out': |
|
564 | 564 | print("Flushing output cache (%d entries)" % len(user_ns['_oh'])) |
|
565 | 565 | self.shell.displayhook.flush() |
|
566 | 566 | |
|
567 | 567 | elif target == 'in': |
|
568 | 568 | print("Flushing input history") |
|
569 | 569 | pc = self.shell.displayhook.prompt_count + 1 |
|
570 | 570 | for n in range(1, pc): |
|
571 | 571 | key = '_i'+repr(n) |
|
572 | 572 | user_ns.pop(key,None) |
|
573 | 573 | user_ns.update(dict(_i=u'',_ii=u'',_iii=u'')) |
|
574 | 574 | hm = ip.history_manager |
|
575 | 575 | # don't delete these, as %save and %macro depending on the |
|
576 | 576 | # length of these lists to be preserved |
|
577 | 577 | hm.input_hist_parsed[:] = [''] * pc |
|
578 | 578 | hm.input_hist_raw[:] = [''] * pc |
|
579 | 579 | # hm has internal machinery for _i,_ii,_iii, clear it out |
|
580 | 580 | hm._i = hm._ii = hm._iii = hm._i00 = u'' |
|
581 | 581 | |
|
582 | 582 | elif target == 'array': |
|
583 | 583 | # Support cleaning up numpy arrays |
|
584 | 584 | try: |
|
585 | 585 | from numpy import ndarray |
|
586 | 586 | # This must be done with items and not iteritems because |
|
587 | 587 | # we're going to modify the dict in-place. |
|
588 | 588 | for x,val in list(user_ns.items()): |
|
589 | 589 | if isinstance(val,ndarray): |
|
590 | 590 | del user_ns[x] |
|
591 | 591 | except ImportError: |
|
592 | 592 | print("reset array only works if Numpy is available.") |
|
593 | 593 | |
|
594 | 594 | elif target == 'dhist': |
|
595 | 595 | print("Flushing directory history") |
|
596 | 596 | del user_ns['_dh'][:] |
|
597 | 597 | |
|
598 | 598 | else: |
|
599 | 599 | print("Don't know how to reset ", end=' ') |
|
600 | 600 | print(target + ", please run `%reset?` for details") |
|
601 | 601 | |
|
602 | 602 | gc.collect() |
|
603 | 603 | |
|
604 | 604 | @line_magic |
|
605 | 605 | def reset_selective(self, parameter_s=''): |
|
606 | 606 | """Resets the namespace by removing names defined by the user. |
|
607 | 607 | |
|
608 | 608 | Input/Output history are left around in case you need them. |
|
609 | 609 | |
|
610 | 610 | %reset_selective [-f] regex |
|
611 | 611 | |
|
612 | 612 | No action is taken if regex is not included |
|
613 | 613 | |
|
614 | 614 | Options |
|
615 | 615 | -f : force reset without asking for confirmation. |
|
616 | 616 | |
|
617 | 617 | See Also |
|
618 | 618 | -------- |
|
619 | 619 | reset : invoked as ``%reset`` |
|
620 | 620 | |
|
621 | 621 | Examples |
|
622 | 622 | -------- |
|
623 | 623 | |
|
624 | 624 | We first fully reset the namespace so your output looks identical to |
|
625 | 625 | this example for pedagogical reasons; in practice you do not need a |
|
626 | 626 | full reset:: |
|
627 | 627 | |
|
628 | 628 | In [1]: %reset -f |
|
629 | 629 | |
|
630 | 630 | Now, with a clean namespace we can make a few variables and use |
|
631 | 631 | ``%reset_selective`` to only delete names that match our regexp:: |
|
632 | 632 | |
|
633 | 633 | In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8 |
|
634 | 634 | |
|
635 | 635 | In [3]: who_ls |
|
636 | 636 | Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c'] |
|
637 | 637 | |
|
638 | 638 | In [4]: %reset_selective -f b[2-3]m |
|
639 | 639 | |
|
640 | 640 | In [5]: who_ls |
|
641 | 641 | Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
642 | 642 | |
|
643 | 643 | In [6]: %reset_selective -f d |
|
644 | 644 | |
|
645 | 645 | In [7]: who_ls |
|
646 | 646 | Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c'] |
|
647 | 647 | |
|
648 | 648 | In [8]: %reset_selective -f c |
|
649 | 649 | |
|
650 | 650 | In [9]: who_ls |
|
651 | 651 | Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m'] |
|
652 | 652 | |
|
653 | 653 | In [10]: %reset_selective -f b |
|
654 | 654 | |
|
655 | 655 | In [11]: who_ls |
|
656 | 656 | Out[11]: ['a'] |
|
657 | 657 | |
|
658 | 658 | Notes |
|
659 | 659 | ----- |
|
660 | 660 | Calling this magic from clients that do not implement standard input, |
|
661 | 661 | such as the ipython notebook interface, will reset the namespace |
|
662 | 662 | without confirmation. |
|
663 | 663 | """ |
|
664 | 664 | |
|
665 | 665 | opts, regex = self.parse_options(parameter_s,'f') |
|
666 | 666 | |
|
667 | 667 | if 'f' in opts: |
|
668 | 668 | ans = True |
|
669 | 669 | else: |
|
670 | 670 | try: |
|
671 | 671 | ans = self.shell.ask_yes_no( |
|
672 | 672 | "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", |
|
673 | 673 | default='n') |
|
674 | 674 | except StdinNotImplementedError: |
|
675 | 675 | ans = True |
|
676 | 676 | if not ans: |
|
677 | 677 | print('Nothing done.') |
|
678 | 678 | return |
|
679 | 679 | user_ns = self.shell.user_ns |
|
680 | 680 | if not regex: |
|
681 | 681 | print('No regex pattern specified. Nothing done.') |
|
682 | 682 | return |
|
683 | 683 | else: |
|
684 | 684 | try: |
|
685 | 685 | m = re.compile(regex) |
|
686 | except TypeError: | |
|
687 | raise TypeError('regex must be a string or compiled pattern') | |
|
686 | except TypeError as e: | |
|
687 | raise TypeError('regex must be a string or compiled pattern') from e | |
|
688 | 688 | for i in self.who_ls(): |
|
689 | 689 | if m.search(i): |
|
690 | 690 | del(user_ns[i]) |
|
691 | 691 | |
|
692 | 692 | @line_magic |
|
693 | 693 | def xdel(self, parameter_s=''): |
|
694 | 694 | """Delete a variable, trying to clear it from anywhere that |
|
695 | 695 | IPython's machinery has references to it. By default, this uses |
|
696 | 696 | the identity of the named object in the user namespace to remove |
|
697 | 697 | references held under other names. The object is also removed |
|
698 | 698 | from the output history. |
|
699 | 699 | |
|
700 | 700 | Options |
|
701 | 701 | -n : Delete the specified name from all namespaces, without |
|
702 | 702 | checking their identity. |
|
703 | 703 | """ |
|
704 | 704 | opts, varname = self.parse_options(parameter_s,'n') |
|
705 | 705 | try: |
|
706 | 706 | self.shell.del_var(varname, ('n' in opts)) |
|
707 | 707 | except (NameError, ValueError) as e: |
|
708 | 708 | print(type(e).__name__ +": "+ str(e)) |
@@ -1,857 +1,857 b'' | |||
|
1 | 1 | """Implementation of magic functions for interaction with the OS. |
|
2 | 2 | |
|
3 | 3 | Note: this module is named 'osm' instead of 'os' to avoid a collision with the |
|
4 | 4 | builtin. |
|
5 | 5 | """ |
|
6 | 6 | # Copyright (c) IPython Development Team. |
|
7 | 7 | # Distributed under the terms of the Modified BSD License. |
|
8 | 8 | |
|
9 | 9 | import io |
|
10 | 10 | import os |
|
11 | 11 | import re |
|
12 | 12 | import sys |
|
13 | 13 | from pprint import pformat |
|
14 | 14 | |
|
15 | 15 | from IPython.core import magic_arguments |
|
16 | 16 | from IPython.core import oinspect |
|
17 | 17 | from IPython.core import page |
|
18 | 18 | from IPython.core.alias import AliasError, Alias |
|
19 | 19 | from IPython.core.error import UsageError |
|
20 | 20 | from IPython.core.magic import ( |
|
21 | 21 | Magics, compress_dhist, magics_class, line_magic, cell_magic, line_cell_magic |
|
22 | 22 | ) |
|
23 | 23 | from IPython.testing.skipdoctest import skip_doctest |
|
24 | 24 | from IPython.utils.openpy import source_to_unicode |
|
25 | 25 | from IPython.utils.process import abbrev_cwd |
|
26 | 26 | from IPython.utils.terminal import set_term_title |
|
27 | 27 | from traitlets import Bool |
|
28 | 28 | from warnings import warn |
|
29 | 29 | |
|
30 | 30 | |
|
31 | 31 | @magics_class |
|
32 | 32 | class OSMagics(Magics): |
|
33 | 33 | """Magics to interact with the underlying OS (shell-type functionality). |
|
34 | 34 | """ |
|
35 | 35 | |
|
36 | 36 | cd_force_quiet = Bool(False, |
|
37 | 37 | help="Force %cd magic to be quiet even if -q is not passed." |
|
38 | 38 | ).tag(config=True) |
|
39 | 39 | |
|
40 | 40 | def __init__(self, shell=None, **kwargs): |
|
41 | 41 | |
|
42 | 42 | # Now define isexec in a cross platform manner. |
|
43 | 43 | self.is_posix = False |
|
44 | 44 | self.execre = None |
|
45 | 45 | if os.name == 'posix': |
|
46 | 46 | self.is_posix = True |
|
47 | 47 | else: |
|
48 | 48 | try: |
|
49 | 49 | winext = os.environ['pathext'].replace(';','|').replace('.','') |
|
50 | 50 | except KeyError: |
|
51 | 51 | winext = 'exe|com|bat|py' |
|
52 | 52 | try: |
|
53 | 53 | self.execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
54 | 54 | except re.error: |
|
55 | 55 | warn("Seems like your pathext environmental " |
|
56 | 56 | "variable is malformed. Please check it to " |
|
57 | 57 | "enable a proper handle of file extensions " |
|
58 | 58 | "managed for your system") |
|
59 | 59 | winext = 'exe|com|bat|py' |
|
60 | 60 | self.execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE) |
|
61 | 61 | |
|
62 | 62 | # call up the chain |
|
63 | 63 | super().__init__(shell=shell, **kwargs) |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | @skip_doctest |
|
67 | 67 | def _isexec_POSIX(self, file): |
|
68 | 68 | """ |
|
69 | 69 | Test for executable on a POSIX system |
|
70 | 70 | """ |
|
71 | 71 | if os.access(file.path, os.X_OK): |
|
72 | 72 | # will fail on maxOS if access is not X_OK |
|
73 | 73 | return file.is_file() |
|
74 | 74 | return False |
|
75 | 75 | |
|
76 | 76 | |
|
77 | 77 | |
|
78 | 78 | @skip_doctest |
|
79 | 79 | def _isexec_WIN(self, file): |
|
80 | 80 | """ |
|
81 | 81 | Test for executable file on non POSIX system |
|
82 | 82 | """ |
|
83 | 83 | return file.is_file() and self.execre.match(file.name) is not None |
|
84 | 84 | |
|
85 | 85 | @skip_doctest |
|
86 | 86 | def isexec(self, file): |
|
87 | 87 | """ |
|
88 | 88 | Test for executable file on non POSIX system |
|
89 | 89 | """ |
|
90 | 90 | if self.is_posix: |
|
91 | 91 | return self._isexec_POSIX(file) |
|
92 | 92 | else: |
|
93 | 93 | return self._isexec_WIN(file) |
|
94 | 94 | |
|
95 | 95 | |
|
96 | 96 | @skip_doctest |
|
97 | 97 | @line_magic |
|
98 | 98 | def alias(self, parameter_s=''): |
|
99 | 99 | """Define an alias for a system command. |
|
100 | 100 | |
|
101 | 101 | '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd' |
|
102 | 102 | |
|
103 | 103 | Then, typing 'alias_name params' will execute the system command 'cmd |
|
104 | 104 | params' (from your underlying operating system). |
|
105 | 105 | |
|
106 | 106 | Aliases have lower precedence than magic functions and Python normal |
|
107 | 107 | variables, so if 'foo' is both a Python variable and an alias, the |
|
108 | 108 | alias can not be executed until 'del foo' removes the Python variable. |
|
109 | 109 | |
|
110 | 110 | You can use the %l specifier in an alias definition to represent the |
|
111 | 111 | whole line when the alias is called. For example:: |
|
112 | 112 | |
|
113 | 113 | In [2]: alias bracket echo "Input in brackets: <%l>" |
|
114 | 114 | In [3]: bracket hello world |
|
115 | 115 | Input in brackets: <hello world> |
|
116 | 116 | |
|
117 | 117 | You can also define aliases with parameters using %s specifiers (one |
|
118 | 118 | per parameter):: |
|
119 | 119 | |
|
120 | 120 | In [1]: alias parts echo first %s second %s |
|
121 | 121 | In [2]: %parts A B |
|
122 | 122 | first A second B |
|
123 | 123 | In [3]: %parts A |
|
124 | 124 | Incorrect number of arguments: 2 expected. |
|
125 | 125 | parts is an alias to: 'echo first %s second %s' |
|
126 | 126 | |
|
127 | 127 | Note that %l and %s are mutually exclusive. You can only use one or |
|
128 | 128 | the other in your aliases. |
|
129 | 129 | |
|
130 | 130 | Aliases expand Python variables just like system calls using ! or !! |
|
131 | 131 | do: all expressions prefixed with '$' get expanded. For details of |
|
132 | 132 | the semantic rules, see PEP-215: |
|
133 | 133 | http://www.python.org/peps/pep-0215.html. This is the library used by |
|
134 | 134 | IPython for variable expansion. If you want to access a true shell |
|
135 | 135 | variable, an extra $ is necessary to prevent its expansion by |
|
136 | 136 | IPython:: |
|
137 | 137 | |
|
138 | 138 | In [6]: alias show echo |
|
139 | 139 | In [7]: PATH='A Python string' |
|
140 | 140 | In [8]: show $PATH |
|
141 | 141 | A Python string |
|
142 | 142 | In [9]: show $$PATH |
|
143 | 143 | /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:... |
|
144 | 144 | |
|
145 | 145 | You can use the alias facility to access all of $PATH. See the %rehashx |
|
146 | 146 | function, which automatically creates aliases for the contents of your |
|
147 | 147 | $PATH. |
|
148 | 148 | |
|
149 | 149 | If called with no parameters, %alias prints the current alias table |
|
150 | 150 | for your system. For posix systems, the default aliases are 'cat', |
|
151 | 151 | 'cp', 'mv', 'rm', 'rmdir', and 'mkdir', and other platform-specific |
|
152 | 152 | aliases are added. For windows-based systems, the default aliases are |
|
153 | 153 | 'copy', 'ddir', 'echo', 'ls', 'ldir', 'mkdir', 'ren', and 'rmdir'. |
|
154 | 154 | |
|
155 | 155 | You can see the definition of alias by adding a question mark in the |
|
156 | 156 | end:: |
|
157 | 157 | |
|
158 | 158 | In [1]: cat? |
|
159 | 159 | Repr: <alias cat for 'cat'>""" |
|
160 | 160 | |
|
161 | 161 | par = parameter_s.strip() |
|
162 | 162 | if not par: |
|
163 | 163 | aliases = sorted(self.shell.alias_manager.aliases) |
|
164 | 164 | # stored = self.shell.db.get('stored_aliases', {} ) |
|
165 | 165 | # for k, v in stored: |
|
166 | 166 | # atab.append(k, v[0]) |
|
167 | 167 | |
|
168 | 168 | print("Total number of aliases:", len(aliases)) |
|
169 | 169 | sys.stdout.flush() |
|
170 | 170 | return aliases |
|
171 | 171 | |
|
172 | 172 | # Now try to define a new one |
|
173 | 173 | try: |
|
174 | 174 | alias,cmd = par.split(None, 1) |
|
175 | 175 | except TypeError: |
|
176 | 176 | print(oinspect.getdoc(self.alias)) |
|
177 | 177 | return |
|
178 | 178 | |
|
179 | 179 | try: |
|
180 | 180 | self.shell.alias_manager.define_alias(alias, cmd) |
|
181 | 181 | except AliasError as e: |
|
182 | 182 | print(e) |
|
183 | 183 | # end magic_alias |
|
184 | 184 | |
|
185 | 185 | @line_magic |
|
186 | 186 | def unalias(self, parameter_s=''): |
|
187 | 187 | """Remove an alias""" |
|
188 | 188 | |
|
189 | 189 | aname = parameter_s.strip() |
|
190 | 190 | try: |
|
191 | 191 | self.shell.alias_manager.undefine_alias(aname) |
|
192 | 192 | except ValueError as e: |
|
193 | 193 | print(e) |
|
194 | 194 | return |
|
195 | 195 | |
|
196 | 196 | stored = self.shell.db.get('stored_aliases', {} ) |
|
197 | 197 | if aname in stored: |
|
198 | 198 | print("Removing %stored alias",aname) |
|
199 | 199 | del stored[aname] |
|
200 | 200 | self.shell.db['stored_aliases'] = stored |
|
201 | 201 | |
|
202 | 202 | @line_magic |
|
203 | 203 | def rehashx(self, parameter_s=''): |
|
204 | 204 | """Update the alias table with all executable files in $PATH. |
|
205 | 205 | |
|
206 | 206 | rehashx explicitly checks that every entry in $PATH is a file |
|
207 | 207 | with execute access (os.X_OK). |
|
208 | 208 | |
|
209 | 209 | Under Windows, it checks executability as a match against a |
|
210 | 210 | '|'-separated string of extensions, stored in the IPython config |
|
211 | 211 | variable win_exec_ext. This defaults to 'exe|com|bat'. |
|
212 | 212 | |
|
213 | 213 | This function also resets the root module cache of module completer, |
|
214 | 214 | used on slow filesystems. |
|
215 | 215 | """ |
|
216 | 216 | from IPython.core.alias import InvalidAliasError |
|
217 | 217 | |
|
218 | 218 | # for the benefit of module completer in ipy_completers.py |
|
219 | 219 | del self.shell.db['rootmodules_cache'] |
|
220 | 220 | |
|
221 | 221 | path = [os.path.abspath(os.path.expanduser(p)) for p in |
|
222 | 222 | os.environ.get('PATH','').split(os.pathsep)] |
|
223 | 223 | |
|
224 | 224 | syscmdlist = [] |
|
225 | 225 | savedir = os.getcwd() |
|
226 | 226 | |
|
227 | 227 | # Now walk the paths looking for executables to alias. |
|
228 | 228 | try: |
|
229 | 229 | # write the whole loop for posix/Windows so we don't have an if in |
|
230 | 230 | # the innermost part |
|
231 | 231 | if self.is_posix: |
|
232 | 232 | for pdir in path: |
|
233 | 233 | try: |
|
234 | 234 | os.chdir(pdir) |
|
235 | 235 | except OSError: |
|
236 | 236 | continue |
|
237 | 237 | |
|
238 | 238 | # for python 3.6+ rewrite to: with os.scandir(pdir) as dirlist: |
|
239 | 239 | dirlist = os.scandir(path=pdir) |
|
240 | 240 | for ff in dirlist: |
|
241 | 241 | if self.isexec(ff): |
|
242 | 242 | fname = ff.name |
|
243 | 243 | try: |
|
244 | 244 | # Removes dots from the name since ipython |
|
245 | 245 | # will assume names with dots to be python. |
|
246 | 246 | if not self.shell.alias_manager.is_alias(fname): |
|
247 | 247 | self.shell.alias_manager.define_alias( |
|
248 | 248 | fname.replace('.',''), fname) |
|
249 | 249 | except InvalidAliasError: |
|
250 | 250 | pass |
|
251 | 251 | else: |
|
252 | 252 | syscmdlist.append(fname) |
|
253 | 253 | else: |
|
254 | 254 | no_alias = Alias.blacklist |
|
255 | 255 | for pdir in path: |
|
256 | 256 | try: |
|
257 | 257 | os.chdir(pdir) |
|
258 | 258 | except OSError: |
|
259 | 259 | continue |
|
260 | 260 | |
|
261 | 261 | # for python 3.6+ rewrite to: with os.scandir(pdir) as dirlist: |
|
262 | 262 | dirlist = os.scandir(pdir) |
|
263 | 263 | for ff in dirlist: |
|
264 | 264 | fname = ff.name |
|
265 | 265 | base, ext = os.path.splitext(fname) |
|
266 | 266 | if self.isexec(ff) and base.lower() not in no_alias: |
|
267 | 267 | if ext.lower() == '.exe': |
|
268 | 268 | fname = base |
|
269 | 269 | try: |
|
270 | 270 | # Removes dots from the name since ipython |
|
271 | 271 | # will assume names with dots to be python. |
|
272 | 272 | self.shell.alias_manager.define_alias( |
|
273 | 273 | base.lower().replace('.',''), fname) |
|
274 | 274 | except InvalidAliasError: |
|
275 | 275 | pass |
|
276 | 276 | syscmdlist.append(fname) |
|
277 | 277 | |
|
278 | 278 | self.shell.db['syscmdlist'] = syscmdlist |
|
279 | 279 | finally: |
|
280 | 280 | os.chdir(savedir) |
|
281 | 281 | |
|
282 | 282 | @skip_doctest |
|
283 | 283 | @line_magic |
|
284 | 284 | def pwd(self, parameter_s=''): |
|
285 | 285 | """Return the current working directory path. |
|
286 | 286 | |
|
287 | 287 | Examples |
|
288 | 288 | -------- |
|
289 | 289 | :: |
|
290 | 290 | |
|
291 | 291 | In [9]: pwd |
|
292 | 292 | Out[9]: '/home/tsuser/sprint/ipython' |
|
293 | 293 | """ |
|
294 | 294 | try: |
|
295 | 295 | return os.getcwd() |
|
296 | except FileNotFoundError: | |
|
297 | raise UsageError("CWD no longer exists - please use %cd to change directory.") | |
|
296 | except FileNotFoundError as e: | |
|
297 | raise UsageError("CWD no longer exists - please use %cd to change directory.") from e | |
|
298 | 298 | |
|
299 | 299 | @skip_doctest |
|
300 | 300 | @line_magic |
|
301 | 301 | def cd(self, parameter_s=''): |
|
302 | 302 | """Change the current working directory. |
|
303 | 303 | |
|
304 | 304 | This command automatically maintains an internal list of directories |
|
305 | 305 | you visit during your IPython session, in the variable _dh. The |
|
306 | 306 | command %dhist shows this history nicely formatted. You can also |
|
307 | 307 | do 'cd -<tab>' to see directory history conveniently. |
|
308 | 308 | |
|
309 | 309 | Usage: |
|
310 | 310 | |
|
311 | 311 | cd 'dir': changes to directory 'dir'. |
|
312 | 312 | |
|
313 | 313 | cd -: changes to the last visited directory. |
|
314 | 314 | |
|
315 | 315 | cd -<n>: changes to the n-th directory in the directory history. |
|
316 | 316 | |
|
317 | 317 | cd --foo: change to directory that matches 'foo' in history |
|
318 | 318 | |
|
319 | 319 | cd -b <bookmark_name>: jump to a bookmark set by %bookmark |
|
320 | 320 | (note: cd <bookmark_name> is enough if there is no |
|
321 | 321 | directory <bookmark_name>, but a bookmark with the name exists.) |
|
322 | 322 | 'cd -b <tab>' allows you to tab-complete bookmark names. |
|
323 | 323 | |
|
324 | 324 | Options: |
|
325 | 325 | |
|
326 | 326 | -q: quiet. Do not print the working directory after the cd command is |
|
327 | 327 | executed. By default IPython's cd command does print this directory, |
|
328 | 328 | since the default prompts do not display path information. |
|
329 | 329 | |
|
330 | 330 | Note that !cd doesn't work for this purpose because the shell where |
|
331 | 331 | !command runs is immediately discarded after executing 'command'. |
|
332 | 332 | |
|
333 | 333 | Examples |
|
334 | 334 | -------- |
|
335 | 335 | :: |
|
336 | 336 | |
|
337 | 337 | In [10]: cd parent/child |
|
338 | 338 | /home/tsuser/parent/child |
|
339 | 339 | """ |
|
340 | 340 | |
|
341 | 341 | try: |
|
342 | 342 | oldcwd = os.getcwd() |
|
343 | 343 | except FileNotFoundError: |
|
344 | 344 | # Happens if the CWD has been deleted. |
|
345 | 345 | oldcwd = None |
|
346 | 346 | |
|
347 | 347 | numcd = re.match(r'(-)(\d+)$',parameter_s) |
|
348 | 348 | # jump in directory history by number |
|
349 | 349 | if numcd: |
|
350 | 350 | nn = int(numcd.group(2)) |
|
351 | 351 | try: |
|
352 | 352 | ps = self.shell.user_ns['_dh'][nn] |
|
353 | 353 | except IndexError: |
|
354 | 354 | print('The requested directory does not exist in history.') |
|
355 | 355 | return |
|
356 | 356 | else: |
|
357 | 357 | opts = {} |
|
358 | 358 | elif parameter_s.startswith('--'): |
|
359 | 359 | ps = None |
|
360 | 360 | fallback = None |
|
361 | 361 | pat = parameter_s[2:] |
|
362 | 362 | dh = self.shell.user_ns['_dh'] |
|
363 | 363 | # first search only by basename (last component) |
|
364 | 364 | for ent in reversed(dh): |
|
365 | 365 | if pat in os.path.basename(ent) and os.path.isdir(ent): |
|
366 | 366 | ps = ent |
|
367 | 367 | break |
|
368 | 368 | |
|
369 | 369 | if fallback is None and pat in ent and os.path.isdir(ent): |
|
370 | 370 | fallback = ent |
|
371 | 371 | |
|
372 | 372 | # if we have no last part match, pick the first full path match |
|
373 | 373 | if ps is None: |
|
374 | 374 | ps = fallback |
|
375 | 375 | |
|
376 | 376 | if ps is None: |
|
377 | 377 | print("No matching entry in directory history") |
|
378 | 378 | return |
|
379 | 379 | else: |
|
380 | 380 | opts = {} |
|
381 | 381 | |
|
382 | 382 | |
|
383 | 383 | else: |
|
384 | 384 | opts, ps = self.parse_options(parameter_s, 'qb', mode='string') |
|
385 | 385 | # jump to previous |
|
386 | 386 | if ps == '-': |
|
387 | 387 | try: |
|
388 | 388 | ps = self.shell.user_ns['_dh'][-2] |
|
389 | except IndexError: | |
|
390 | raise UsageError('%cd -: No previous directory to change to.') | |
|
389 | except IndexError as e: | |
|
390 | raise UsageError('%cd -: No previous directory to change to.') from e | |
|
391 | 391 | # jump to bookmark if needed |
|
392 | 392 | else: |
|
393 | 393 | if not os.path.isdir(ps) or 'b' in opts: |
|
394 | 394 | bkms = self.shell.db.get('bookmarks', {}) |
|
395 | 395 | |
|
396 | 396 | if ps in bkms: |
|
397 | 397 | target = bkms[ps] |
|
398 | 398 | print('(bookmark:%s) -> %s' % (ps, target)) |
|
399 | 399 | ps = target |
|
400 | 400 | else: |
|
401 | 401 | if 'b' in opts: |
|
402 | 402 | raise UsageError("Bookmark '%s' not found. " |
|
403 | 403 | "Use '%%bookmark -l' to see your bookmarks." % ps) |
|
404 | 404 | |
|
405 | 405 | # at this point ps should point to the target dir |
|
406 | 406 | if ps: |
|
407 | 407 | try: |
|
408 | 408 | os.chdir(os.path.expanduser(ps)) |
|
409 | 409 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
410 | 410 | set_term_title(self.shell.term_title_format.format(cwd=abbrev_cwd())) |
|
411 | 411 | except OSError: |
|
412 | 412 | print(sys.exc_info()[1]) |
|
413 | 413 | else: |
|
414 | 414 | cwd = os.getcwd() |
|
415 | 415 | dhist = self.shell.user_ns['_dh'] |
|
416 | 416 | if oldcwd != cwd: |
|
417 | 417 | dhist.append(cwd) |
|
418 | 418 | self.shell.db['dhist'] = compress_dhist(dhist)[-100:] |
|
419 | 419 | |
|
420 | 420 | else: |
|
421 | 421 | os.chdir(self.shell.home_dir) |
|
422 | 422 | if hasattr(self.shell, 'term_title') and self.shell.term_title: |
|
423 | 423 | set_term_title(self.shell.term_title_format.format(cwd="~")) |
|
424 | 424 | cwd = os.getcwd() |
|
425 | 425 | dhist = self.shell.user_ns['_dh'] |
|
426 | 426 | |
|
427 | 427 | if oldcwd != cwd: |
|
428 | 428 | dhist.append(cwd) |
|
429 | 429 | self.shell.db['dhist'] = compress_dhist(dhist)[-100:] |
|
430 | 430 | if not 'q' in opts and not self.cd_force_quiet and self.shell.user_ns['_dh']: |
|
431 | 431 | print(self.shell.user_ns['_dh'][-1]) |
|
432 | 432 | |
|
433 | 433 | @line_magic |
|
434 | 434 | def env(self, parameter_s=''): |
|
435 | 435 | """Get, set, or list environment variables. |
|
436 | 436 | |
|
437 | 437 | Usage:\\ |
|
438 | 438 | |
|
439 | 439 | %env: lists all environment variables/values |
|
440 | 440 | %env var: get value for var |
|
441 | 441 | %env var val: set value for var |
|
442 | 442 | %env var=val: set value for var |
|
443 | 443 | %env var=$val: set value for var, using python expansion if possible |
|
444 | 444 | """ |
|
445 | 445 | if parameter_s.strip(): |
|
446 | 446 | split = '=' if '=' in parameter_s else ' ' |
|
447 | 447 | bits = parameter_s.split(split) |
|
448 | 448 | if len(bits) == 1: |
|
449 | 449 | key = parameter_s.strip() |
|
450 | 450 | if key in os.environ: |
|
451 | 451 | return os.environ[key] |
|
452 | 452 | else: |
|
453 | 453 | err = "Environment does not have key: {0}".format(key) |
|
454 | 454 | raise UsageError(err) |
|
455 | 455 | if len(bits) > 1: |
|
456 | 456 | return self.set_env(parameter_s) |
|
457 | 457 | env = dict(os.environ) |
|
458 | 458 | # hide likely secrets when printing the whole environment |
|
459 | 459 | for key in list(env): |
|
460 | 460 | if any(s in key.lower() for s in ('key', 'token', 'secret')): |
|
461 | 461 | env[key] = '<hidden>' |
|
462 | 462 | |
|
463 | 463 | return env |
|
464 | 464 | |
|
465 | 465 | @line_magic |
|
466 | 466 | def set_env(self, parameter_s): |
|
467 | 467 | """Set environment variables. Assumptions are that either "val" is a |
|
468 | 468 | name in the user namespace, or val is something that evaluates to a |
|
469 | 469 | string. |
|
470 | 470 | |
|
471 | 471 | Usage:\\ |
|
472 | 472 | %set_env var val: set value for var |
|
473 | 473 | %set_env var=val: set value for var |
|
474 | 474 | %set_env var=$val: set value for var, using python expansion if possible |
|
475 | 475 | """ |
|
476 | 476 | split = '=' if '=' in parameter_s else ' ' |
|
477 | 477 | bits = parameter_s.split(split, 1) |
|
478 | 478 | if not parameter_s.strip() or len(bits)<2: |
|
479 | 479 | raise UsageError("usage is 'set_env var=val'") |
|
480 | 480 | var = bits[0].strip() |
|
481 | 481 | val = bits[1].strip() |
|
482 | 482 | if re.match(r'.*\s.*', var): |
|
483 | 483 | # an environment variable with whitespace is almost certainly |
|
484 | 484 | # not what the user intended. what's more likely is the wrong |
|
485 | 485 | # split was chosen, ie for "set_env cmd_args A=B", we chose |
|
486 | 486 | # '=' for the split and should have chosen ' '. to get around |
|
487 | 487 | # this, users should just assign directly to os.environ or use |
|
488 | 488 | # standard magic {var} expansion. |
|
489 | 489 | err = "refusing to set env var with whitespace: '{0}'" |
|
490 | 490 | err = err.format(val) |
|
491 | 491 | raise UsageError(err) |
|
492 | 492 | os.environ[var] = val |
|
493 | 493 | print('env: {0}={1}'.format(var,val)) |
|
494 | 494 | |
|
495 | 495 | @line_magic |
|
496 | 496 | def pushd(self, parameter_s=''): |
|
497 | 497 | """Place the current dir on stack and change directory. |
|
498 | 498 | |
|
499 | 499 | Usage:\\ |
|
500 | 500 | %pushd ['dirname'] |
|
501 | 501 | """ |
|
502 | 502 | |
|
503 | 503 | dir_s = self.shell.dir_stack |
|
504 | 504 | tgt = os.path.expanduser(parameter_s) |
|
505 | 505 | cwd = os.getcwd().replace(self.shell.home_dir,'~') |
|
506 | 506 | if tgt: |
|
507 | 507 | self.cd(parameter_s) |
|
508 | 508 | dir_s.insert(0,cwd) |
|
509 | 509 | return self.shell.run_line_magic('dirs', '') |
|
510 | 510 | |
|
511 | 511 | @line_magic |
|
512 | 512 | def popd(self, parameter_s=''): |
|
513 | 513 | """Change to directory popped off the top of the stack. |
|
514 | 514 | """ |
|
515 | 515 | if not self.shell.dir_stack: |
|
516 | 516 | raise UsageError("%popd on empty stack") |
|
517 | 517 | top = self.shell.dir_stack.pop(0) |
|
518 | 518 | self.cd(top) |
|
519 | 519 | print("popd ->",top) |
|
520 | 520 | |
|
521 | 521 | @line_magic |
|
522 | 522 | def dirs(self, parameter_s=''): |
|
523 | 523 | """Return the current directory stack.""" |
|
524 | 524 | |
|
525 | 525 | return self.shell.dir_stack |
|
526 | 526 | |
|
527 | 527 | @line_magic |
|
528 | 528 | def dhist(self, parameter_s=''): |
|
529 | 529 | """Print your history of visited directories. |
|
530 | 530 | |
|
531 | 531 | %dhist -> print full history\\ |
|
532 | 532 | %dhist n -> print last n entries only\\ |
|
533 | 533 | %dhist n1 n2 -> print entries between n1 and n2 (n2 not included)\\ |
|
534 | 534 | |
|
535 | 535 | This history is automatically maintained by the %cd command, and |
|
536 | 536 | always available as the global list variable _dh. You can use %cd -<n> |
|
537 | 537 | to go to directory number <n>. |
|
538 | 538 | |
|
539 | 539 | Note that most of time, you should view directory history by entering |
|
540 | 540 | cd -<TAB>. |
|
541 | 541 | |
|
542 | 542 | """ |
|
543 | 543 | |
|
544 | 544 | dh = self.shell.user_ns['_dh'] |
|
545 | 545 | if parameter_s: |
|
546 | 546 | try: |
|
547 | 547 | args = map(int,parameter_s.split()) |
|
548 | 548 | except: |
|
549 | 549 | self.arg_err(self.dhist) |
|
550 | 550 | return |
|
551 | 551 | if len(args) == 1: |
|
552 | 552 | ini,fin = max(len(dh)-(args[0]),0),len(dh) |
|
553 | 553 | elif len(args) == 2: |
|
554 | 554 | ini,fin = args |
|
555 | 555 | fin = min(fin, len(dh)) |
|
556 | 556 | else: |
|
557 | 557 | self.arg_err(self.dhist) |
|
558 | 558 | return |
|
559 | 559 | else: |
|
560 | 560 | ini,fin = 0,len(dh) |
|
561 | 561 | print('Directory history (kept in _dh)') |
|
562 | 562 | for i in range(ini, fin): |
|
563 | 563 | print("%d: %s" % (i, dh[i])) |
|
564 | 564 | |
|
565 | 565 | @skip_doctest |
|
566 | 566 | @line_magic |
|
567 | 567 | def sc(self, parameter_s=''): |
|
568 | 568 | """Shell capture - run shell command and capture output (DEPRECATED use !). |
|
569 | 569 | |
|
570 | 570 | DEPRECATED. Suboptimal, retained for backwards compatibility. |
|
571 | 571 | |
|
572 | 572 | You should use the form 'var = !command' instead. Example: |
|
573 | 573 | |
|
574 | 574 | "%sc -l myfiles = ls ~" should now be written as |
|
575 | 575 | |
|
576 | 576 | "myfiles = !ls ~" |
|
577 | 577 | |
|
578 | 578 | myfiles.s, myfiles.l and myfiles.n still apply as documented |
|
579 | 579 | below. |
|
580 | 580 | |
|
581 | 581 | -- |
|
582 | 582 | %sc [options] varname=command |
|
583 | 583 | |
|
584 | 584 | IPython will run the given command using commands.getoutput(), and |
|
585 | 585 | will then update the user's interactive namespace with a variable |
|
586 | 586 | called varname, containing the value of the call. Your command can |
|
587 | 587 | contain shell wildcards, pipes, etc. |
|
588 | 588 | |
|
589 | 589 | The '=' sign in the syntax is mandatory, and the variable name you |
|
590 | 590 | supply must follow Python's standard conventions for valid names. |
|
591 | 591 | |
|
592 | 592 | (A special format without variable name exists for internal use) |
|
593 | 593 | |
|
594 | 594 | Options: |
|
595 | 595 | |
|
596 | 596 | -l: list output. Split the output on newlines into a list before |
|
597 | 597 | assigning it to the given variable. By default the output is stored |
|
598 | 598 | as a single string. |
|
599 | 599 | |
|
600 | 600 | -v: verbose. Print the contents of the variable. |
|
601 | 601 | |
|
602 | 602 | In most cases you should not need to split as a list, because the |
|
603 | 603 | returned value is a special type of string which can automatically |
|
604 | 604 | provide its contents either as a list (split on newlines) or as a |
|
605 | 605 | space-separated string. These are convenient, respectively, either |
|
606 | 606 | for sequential processing or to be passed to a shell command. |
|
607 | 607 | |
|
608 | 608 | For example:: |
|
609 | 609 | |
|
610 | 610 | # Capture into variable a |
|
611 | 611 | In [1]: sc a=ls *py |
|
612 | 612 | |
|
613 | 613 | # a is a string with embedded newlines |
|
614 | 614 | In [2]: a |
|
615 | 615 | Out[2]: 'setup.py\\nwin32_manual_post_install.py' |
|
616 | 616 | |
|
617 | 617 | # which can be seen as a list: |
|
618 | 618 | In [3]: a.l |
|
619 | 619 | Out[3]: ['setup.py', 'win32_manual_post_install.py'] |
|
620 | 620 | |
|
621 | 621 | # or as a whitespace-separated string: |
|
622 | 622 | In [4]: a.s |
|
623 | 623 | Out[4]: 'setup.py win32_manual_post_install.py' |
|
624 | 624 | |
|
625 | 625 | # a.s is useful to pass as a single command line: |
|
626 | 626 | In [5]: !wc -l $a.s |
|
627 | 627 | 146 setup.py |
|
628 | 628 | 130 win32_manual_post_install.py |
|
629 | 629 | 276 total |
|
630 | 630 | |
|
631 | 631 | # while the list form is useful to loop over: |
|
632 | 632 | In [6]: for f in a.l: |
|
633 | 633 | ...: !wc -l $f |
|
634 | 634 | ...: |
|
635 | 635 | 146 setup.py |
|
636 | 636 | 130 win32_manual_post_install.py |
|
637 | 637 | |
|
638 | 638 | Similarly, the lists returned by the -l option are also special, in |
|
639 | 639 | the sense that you can equally invoke the .s attribute on them to |
|
640 | 640 | automatically get a whitespace-separated string from their contents:: |
|
641 | 641 | |
|
642 | 642 | In [7]: sc -l b=ls *py |
|
643 | 643 | |
|
644 | 644 | In [8]: b |
|
645 | 645 | Out[8]: ['setup.py', 'win32_manual_post_install.py'] |
|
646 | 646 | |
|
647 | 647 | In [9]: b.s |
|
648 | 648 | Out[9]: 'setup.py win32_manual_post_install.py' |
|
649 | 649 | |
|
650 | 650 | In summary, both the lists and strings used for output capture have |
|
651 | 651 | the following special attributes:: |
|
652 | 652 | |
|
653 | 653 | .l (or .list) : value as list. |
|
654 | 654 | .n (or .nlstr): value as newline-separated string. |
|
655 | 655 | .s (or .spstr): value as space-separated string. |
|
656 | 656 | """ |
|
657 | 657 | |
|
658 | 658 | opts,args = self.parse_options(parameter_s, 'lv') |
|
659 | 659 | # Try to get a variable name and command to run |
|
660 | 660 | try: |
|
661 | 661 | # the variable name must be obtained from the parse_options |
|
662 | 662 | # output, which uses shlex.split to strip options out. |
|
663 | 663 | var,_ = args.split('=', 1) |
|
664 | 664 | var = var.strip() |
|
665 | 665 | # But the command has to be extracted from the original input |
|
666 | 666 | # parameter_s, not on what parse_options returns, to avoid the |
|
667 | 667 | # quote stripping which shlex.split performs on it. |
|
668 | 668 | _,cmd = parameter_s.split('=', 1) |
|
669 | 669 | except ValueError: |
|
670 | 670 | var,cmd = '','' |
|
671 | 671 | # If all looks ok, proceed |
|
672 | 672 | split = 'l' in opts |
|
673 | 673 | out = self.shell.getoutput(cmd, split=split) |
|
674 | 674 | if 'v' in opts: |
|
675 | 675 | print('%s ==\n%s' % (var, pformat(out))) |
|
676 | 676 | if var: |
|
677 | 677 | self.shell.user_ns.update({var:out}) |
|
678 | 678 | else: |
|
679 | 679 | return out |
|
680 | 680 | |
|
681 | 681 | @line_cell_magic |
|
682 | 682 | def sx(self, line='', cell=None): |
|
683 | 683 | """Shell execute - run shell command and capture output (!! is short-hand). |
|
684 | 684 | |
|
685 | 685 | %sx command |
|
686 | 686 | |
|
687 | 687 | IPython will run the given command using commands.getoutput(), and |
|
688 | 688 | return the result formatted as a list (split on '\\n'). Since the |
|
689 | 689 | output is _returned_, it will be stored in ipython's regular output |
|
690 | 690 | cache Out[N] and in the '_N' automatic variables. |
|
691 | 691 | |
|
692 | 692 | Notes: |
|
693 | 693 | |
|
694 | 694 | 1) If an input line begins with '!!', then %sx is automatically |
|
695 | 695 | invoked. That is, while:: |
|
696 | 696 | |
|
697 | 697 | !ls |
|
698 | 698 | |
|
699 | 699 | causes ipython to simply issue system('ls'), typing:: |
|
700 | 700 | |
|
701 | 701 | !!ls |
|
702 | 702 | |
|
703 | 703 | is a shorthand equivalent to:: |
|
704 | 704 | |
|
705 | 705 | %sx ls |
|
706 | 706 | |
|
707 | 707 | 2) %sx differs from %sc in that %sx automatically splits into a list, |
|
708 | 708 | like '%sc -l'. The reason for this is to make it as easy as possible |
|
709 | 709 | to process line-oriented shell output via further python commands. |
|
710 | 710 | %sc is meant to provide much finer control, but requires more |
|
711 | 711 | typing. |
|
712 | 712 | |
|
713 | 713 | 3) Just like %sc -l, this is a list with special attributes: |
|
714 | 714 | :: |
|
715 | 715 | |
|
716 | 716 | .l (or .list) : value as list. |
|
717 | 717 | .n (or .nlstr): value as newline-separated string. |
|
718 | 718 | .s (or .spstr): value as whitespace-separated string. |
|
719 | 719 | |
|
720 | 720 | This is very useful when trying to use such lists as arguments to |
|
721 | 721 | system commands.""" |
|
722 | 722 | |
|
723 | 723 | if cell is None: |
|
724 | 724 | # line magic |
|
725 | 725 | return self.shell.getoutput(line) |
|
726 | 726 | else: |
|
727 | 727 | opts,args = self.parse_options(line, '', 'out=') |
|
728 | 728 | output = self.shell.getoutput(cell) |
|
729 | 729 | out_name = opts.get('out', opts.get('o')) |
|
730 | 730 | if out_name: |
|
731 | 731 | self.shell.user_ns[out_name] = output |
|
732 | 732 | else: |
|
733 | 733 | return output |
|
734 | 734 | |
|
735 | 735 | system = line_cell_magic('system')(sx) |
|
736 | 736 | bang = cell_magic('!')(sx) |
|
737 | 737 | |
|
738 | 738 | @line_magic |
|
739 | 739 | def bookmark(self, parameter_s=''): |
|
740 | 740 | """Manage IPython's bookmark system. |
|
741 | 741 | |
|
742 | 742 | %bookmark <name> - set bookmark to current dir |
|
743 | 743 | %bookmark <name> <dir> - set bookmark to <dir> |
|
744 | 744 | %bookmark -l - list all bookmarks |
|
745 | 745 | %bookmark -d <name> - remove bookmark |
|
746 | 746 | %bookmark -r - remove all bookmarks |
|
747 | 747 | |
|
748 | 748 | You can later on access a bookmarked folder with:: |
|
749 | 749 | |
|
750 | 750 | %cd -b <name> |
|
751 | 751 | |
|
752 | 752 | or simply '%cd <name>' if there is no directory called <name> AND |
|
753 | 753 | there is such a bookmark defined. |
|
754 | 754 | |
|
755 | 755 | Your bookmarks persist through IPython sessions, but they are |
|
756 | 756 | associated with each profile.""" |
|
757 | 757 | |
|
758 | 758 | opts,args = self.parse_options(parameter_s,'drl',mode='list') |
|
759 | 759 | if len(args) > 2: |
|
760 | 760 | raise UsageError("%bookmark: too many arguments") |
|
761 | 761 | |
|
762 | 762 | bkms = self.shell.db.get('bookmarks',{}) |
|
763 | 763 | |
|
764 | 764 | if 'd' in opts: |
|
765 | 765 | try: |
|
766 | 766 | todel = args[0] |
|
767 | except IndexError: | |
|
767 | except IndexError as e: | |
|
768 | 768 | raise UsageError( |
|
769 | "%bookmark -d: must provide a bookmark to delete") | |
|
769 | "%bookmark -d: must provide a bookmark to delete") from e | |
|
770 | 770 | else: |
|
771 | 771 | try: |
|
772 | 772 | del bkms[todel] |
|
773 | except KeyError: | |
|
773 | except KeyError as e: | |
|
774 | 774 | raise UsageError( |
|
775 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) | |
|
775 | "%%bookmark -d: Can't delete bookmark '%s'" % todel) from e | |
|
776 | 776 | |
|
777 | 777 | elif 'r' in opts: |
|
778 | 778 | bkms = {} |
|
779 | 779 | elif 'l' in opts: |
|
780 | 780 | bks = sorted(bkms) |
|
781 | 781 | if bks: |
|
782 | 782 | size = max(map(len, bks)) |
|
783 | 783 | else: |
|
784 | 784 | size = 0 |
|
785 | 785 | fmt = '%-'+str(size)+'s -> %s' |
|
786 | 786 | print('Current bookmarks:') |
|
787 | 787 | for bk in bks: |
|
788 | 788 | print(fmt % (bk, bkms[bk])) |
|
789 | 789 | else: |
|
790 | 790 | if not args: |
|
791 | 791 | raise UsageError("%bookmark: You must specify the bookmark name") |
|
792 | 792 | elif len(args)==1: |
|
793 | 793 | bkms[args[0]] = os.getcwd() |
|
794 | 794 | elif len(args)==2: |
|
795 | 795 | bkms[args[0]] = args[1] |
|
796 | 796 | self.shell.db['bookmarks'] = bkms |
|
797 | 797 | |
|
798 | 798 | @line_magic |
|
799 | 799 | def pycat(self, parameter_s=''): |
|
800 | 800 | """Show a syntax-highlighted file through a pager. |
|
801 | 801 | |
|
802 | 802 | This magic is similar to the cat utility, but it will assume the file |
|
803 | 803 | to be Python source and will show it with syntax highlighting. |
|
804 | 804 | |
|
805 | 805 | This magic command can either take a local filename, an url, |
|
806 | 806 | an history range (see %history) or a macro as argument :: |
|
807 | 807 | |
|
808 | 808 | %pycat myscript.py |
|
809 | 809 | %pycat 7-27 |
|
810 | 810 | %pycat myMacro |
|
811 | 811 | %pycat http://www.example.com/myscript.py |
|
812 | 812 | """ |
|
813 | 813 | if not parameter_s: |
|
814 | 814 | raise UsageError('Missing filename, URL, input history range, ' |
|
815 | 815 | 'or macro.') |
|
816 | 816 | |
|
817 | 817 | try : |
|
818 | 818 | cont = self.shell.find_user_code(parameter_s, skip_encoding_cookie=False) |
|
819 | 819 | except (ValueError, IOError): |
|
820 | 820 | print("Error: no such file, variable, URL, history range or macro") |
|
821 | 821 | return |
|
822 | 822 | |
|
823 | 823 | page.page(self.shell.pycolorize(source_to_unicode(cont))) |
|
824 | 824 | |
|
825 | 825 | @magic_arguments.magic_arguments() |
|
826 | 826 | @magic_arguments.argument( |
|
827 | 827 | '-a', '--append', action='store_true', default=False, |
|
828 | 828 | help='Append contents of the cell to an existing file. ' |
|
829 | 829 | 'The file will be created if it does not exist.' |
|
830 | 830 | ) |
|
831 | 831 | @magic_arguments.argument( |
|
832 | 832 | 'filename', type=str, |
|
833 | 833 | help='file to write' |
|
834 | 834 | ) |
|
835 | 835 | @cell_magic |
|
836 | 836 | def writefile(self, line, cell): |
|
837 | 837 | """Write the contents of the cell to a file. |
|
838 | 838 | |
|
839 | 839 | The file will be overwritten unless the -a (--append) flag is specified. |
|
840 | 840 | """ |
|
841 | 841 | args = magic_arguments.parse_argstring(self.writefile, line) |
|
842 | 842 | if re.match(r'^(\'.*\')|(".*")$', args.filename): |
|
843 | 843 | filename = os.path.expanduser(args.filename[1:-1]) |
|
844 | 844 | else: |
|
845 | 845 | filename = os.path.expanduser(args.filename) |
|
846 | 846 | |
|
847 | 847 | if os.path.exists(filename): |
|
848 | 848 | if args.append: |
|
849 | 849 | print("Appending to %s" % filename) |
|
850 | 850 | else: |
|
851 | 851 | print("Overwriting %s" % filename) |
|
852 | 852 | else: |
|
853 | 853 | print("Writing %s" % filename) |
|
854 | 854 | |
|
855 | 855 | mode = 'a' if args.append else 'w' |
|
856 | 856 | with io.open(filename, mode, encoding='utf-8') as f: |
|
857 | 857 | f.write(cell) |
General Comments 0
You need to be logged in to leave comments.
Login now