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