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