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