##// END OF EJS Templates
Don't unregister failing post-exec callbacks automatically...
MinRK -
Show More
@@ -1,2749 +1,2757
1 1 # -*- coding: utf-8 -*-
2 2 """Main IPython class."""
3 3
4 4 #-----------------------------------------------------------------------------
5 5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 7 # Copyright (C) 2008-2011 The IPython Development Team
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #-----------------------------------------------------------------------------
12 12
13 13 #-----------------------------------------------------------------------------
14 14 # Imports
15 15 #-----------------------------------------------------------------------------
16 16
17 17 from __future__ import with_statement
18 18 from __future__ import absolute_import
19 19
20 20 import __builtin__ as builtin_mod
21 21 import __future__
22 22 import abc
23 23 import ast
24 24 import atexit
25 25 import codeop
26 26 import inspect
27 27 import os
28 28 import re
29 29 import sys
30 30 import tempfile
31 31 import types
32 32
33 33 try:
34 34 from contextlib import nested
35 35 except:
36 36 from IPython.utils.nested_context import nested
37 37
38 38 from IPython.config.configurable import SingletonConfigurable
39 39 from IPython.core import debugger, oinspect
40 40 from IPython.core import history as ipcorehist
41 41 from IPython.core import page
42 42 from IPython.core import prefilter
43 43 from IPython.core import shadowns
44 44 from IPython.core import ultratb
45 45 from IPython.core.alias import AliasManager, AliasError
46 46 from IPython.core.autocall import ExitAutocall
47 47 from IPython.core.builtin_trap import BuiltinTrap
48 48 from IPython.core.compilerop import CachingCompiler
49 49 from IPython.core.display_trap import DisplayTrap
50 50 from IPython.core.displayhook import DisplayHook
51 51 from IPython.core.displaypub import DisplayPublisher
52 52 from IPython.core.error import TryNext, UsageError
53 53 from IPython.core.extensions import ExtensionManager
54 54 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
55 55 from IPython.core.formatters import DisplayFormatter
56 56 from IPython.core.history import HistoryManager
57 57 from IPython.core.inputsplitter import IPythonInputSplitter
58 58 from IPython.core.logger import Logger
59 59 from IPython.core.macro import Macro
60 60 from IPython.core.magic import Magic
61 61 from IPython.core.payload import PayloadManager
62 62 from IPython.core.plugin import PluginManager
63 63 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
64 64 from IPython.core.profiledir import ProfileDir
65 65 from IPython.core.pylabtools import pylab_activate
66 66 from IPython.core.prompts import PromptManager
67 67 from IPython.external.Itpl import ItplNS
68 68 from IPython.utils import PyColorize
69 69 from IPython.utils import io
70 70 from IPython.utils import py3compat
71 71 from IPython.utils.doctestreload import doctest_reload
72 72 from IPython.utils.io import ask_yes_no, rprint
73 73 from IPython.utils.ipstruct import Struct
74 74 from IPython.utils.path import get_home_dir, get_ipython_dir, HomeDirError
75 75 from IPython.utils.pickleshare import PickleShareDB
76 76 from IPython.utils.process import system, getoutput
77 77 from IPython.utils.strdispatch import StrDispatch
78 78 from IPython.utils.syspathcontext import prepended_to_syspath
79 79 from IPython.utils.text import (num_ini_spaces, format_screen, LSString, SList,
80 80 DollarFormatter)
81 81 from IPython.utils.traitlets import (Integer, CBool, CaselessStrEnum, Enum,
82 82 List, Unicode, Instance, Type)
83 83 from IPython.utils.warn import warn, error, fatal
84 84 import IPython.core.hooks
85 85
86 86 #-----------------------------------------------------------------------------
87 87 # Globals
88 88 #-----------------------------------------------------------------------------
89 89
90 90 # compiled regexps for autoindent management
91 91 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
92 92
93 93 #-----------------------------------------------------------------------------
94 94 # Utilities
95 95 #-----------------------------------------------------------------------------
96 96
97 97 def softspace(file, newvalue):
98 98 """Copied from code.py, to remove the dependency"""
99 99
100 100 oldvalue = 0
101 101 try:
102 102 oldvalue = file.softspace
103 103 except AttributeError:
104 104 pass
105 105 try:
106 106 file.softspace = newvalue
107 107 except (AttributeError, TypeError):
108 108 # "attribute-less object" or "read-only attributes"
109 109 pass
110 110 return oldvalue
111 111
112 112
113 113 def no_op(*a, **kw): pass
114 114
115 115 class NoOpContext(object):
116 116 def __enter__(self): pass
117 117 def __exit__(self, type, value, traceback): pass
118 118 no_op_context = NoOpContext()
119 119
120 120 class SpaceInInput(Exception): pass
121 121
122 122 class Bunch: pass
123 123
124 124
125 125 def get_default_colors():
126 126 if sys.platform=='darwin':
127 127 return "LightBG"
128 128 elif os.name=='nt':
129 129 return 'Linux'
130 130 else:
131 131 return 'Linux'
132 132
133 133
134 134 class SeparateUnicode(Unicode):
135 135 """A Unicode subclass to validate separate_in, separate_out, etc.
136 136
137 137 This is a Unicode based trait that converts '0'->'' and '\\n'->'\n'.
138 138 """
139 139
140 140 def validate(self, obj, value):
141 141 if value == '0': value = ''
142 142 value = value.replace('\\n','\n')
143 143 return super(SeparateUnicode, self).validate(obj, value)
144 144
145 145
146 146 class ReadlineNoRecord(object):
147 147 """Context manager to execute some code, then reload readline history
148 148 so that interactive input to the code doesn't appear when pressing up."""
149 149 def __init__(self, shell):
150 150 self.shell = shell
151 151 self._nested_level = 0
152 152
153 153 def __enter__(self):
154 154 if self._nested_level == 0:
155 155 try:
156 156 self.orig_length = self.current_length()
157 157 self.readline_tail = self.get_readline_tail()
158 158 except (AttributeError, IndexError): # Can fail with pyreadline
159 159 self.orig_length, self.readline_tail = 999999, []
160 160 self._nested_level += 1
161 161
162 162 def __exit__(self, type, value, traceback):
163 163 self._nested_level -= 1
164 164 if self._nested_level == 0:
165 165 # Try clipping the end if it's got longer
166 166 try:
167 167 e = self.current_length() - self.orig_length
168 168 if e > 0:
169 169 for _ in range(e):
170 170 self.shell.readline.remove_history_item(self.orig_length)
171 171
172 172 # If it still doesn't match, just reload readline history.
173 173 if self.current_length() != self.orig_length \
174 174 or self.get_readline_tail() != self.readline_tail:
175 175 self.shell.refill_readline_hist()
176 176 except (AttributeError, IndexError):
177 177 pass
178 178 # Returning False will cause exceptions to propagate
179 179 return False
180 180
181 181 def current_length(self):
182 182 return self.shell.readline.get_current_history_length()
183 183
184 184 def get_readline_tail(self, n=10):
185 185 """Get the last n items in readline history."""
186 186 end = self.shell.readline.get_current_history_length() + 1
187 187 start = max(end-n, 1)
188 188 ghi = self.shell.readline.get_history_item
189 189 return [ghi(x) for x in range(start, end)]
190 190
191 191 #-----------------------------------------------------------------------------
192 192 # Main IPython class
193 193 #-----------------------------------------------------------------------------
194 194
195 195 class InteractiveShell(SingletonConfigurable, Magic):
196 196 """An enhanced, interactive shell for Python."""
197 197
198 198 _instance = None
199 199
200 200 autocall = Enum((0,1,2), default_value=0, config=True, help=
201 201 """
202 202 Make IPython automatically call any callable object even if you didn't
203 203 type explicit parentheses. For example, 'str 43' becomes 'str(43)'
204 204 automatically. The value can be '0' to disable the feature, '1' for
205 205 'smart' autocall, where it is not applied if there are no more
206 206 arguments on the line, and '2' for 'full' autocall, where all callable
207 207 objects are automatically called (even if no arguments are present).
208 208 """
209 209 )
210 210 # TODO: remove all autoindent logic and put into frontends.
211 211 # We can't do this yet because even runlines uses the autoindent.
212 212 autoindent = CBool(True, config=True, help=
213 213 """
214 214 Autoindent IPython code entered interactively.
215 215 """
216 216 )
217 217 automagic = CBool(True, config=True, help=
218 218 """
219 219 Enable magic commands to be called without the leading %.
220 220 """
221 221 )
222 222 cache_size = Integer(1000, config=True, help=
223 223 """
224 224 Set the size of the output cache. The default is 1000, you can
225 225 change it permanently in your config file. Setting it to 0 completely
226 226 disables the caching system, and the minimum value accepted is 20 (if
227 227 you provide a value less than 20, it is reset to 0 and a warning is
228 228 issued). This limit is defined because otherwise you'll spend more
229 229 time re-flushing a too small cache than working
230 230 """
231 231 )
232 232 color_info = CBool(True, config=True, help=
233 233 """
234 234 Use colors for displaying information about objects. Because this
235 235 information is passed through a pager (like 'less'), and some pagers
236 236 get confused with color codes, this capability can be turned off.
237 237 """
238 238 )
239 239 colors = CaselessStrEnum(('NoColor','LightBG','Linux'),
240 240 default_value=get_default_colors(), config=True,
241 241 help="Set the color scheme (NoColor, Linux, or LightBG)."
242 242 )
243 243 colors_force = CBool(False, help=
244 244 """
245 245 Force use of ANSI color codes, regardless of OS and readline
246 246 availability.
247 247 """
248 248 # FIXME: This is essentially a hack to allow ZMQShell to show colors
249 249 # without readline on Win32. When the ZMQ formatting system is
250 250 # refactored, this should be removed.
251 251 )
252 252 debug = CBool(False, config=True)
253 253 deep_reload = CBool(False, config=True, help=
254 254 """
255 255 Enable deep (recursive) reloading by default. IPython can use the
256 256 deep_reload module which reloads changes in modules recursively (it
257 257 replaces the reload() function, so you don't need to change anything to
258 258 use it). deep_reload() forces a full reload of modules whose code may
259 259 have changed, which the default reload() function does not. When
260 260 deep_reload is off, IPython will use the normal reload(), but
261 261 deep_reload will still be available as dreload().
262 262 """
263 263 )
264 disable_failing_post_execute = CBool(False, config=True,
265 help="Don't call post-execute functions that have failed in the past."""
266 )
264 267 display_formatter = Instance(DisplayFormatter)
265 268 displayhook_class = Type(DisplayHook)
266 269 display_pub_class = Type(DisplayPublisher)
267 270
268 271 exit_now = CBool(False)
269 272 exiter = Instance(ExitAutocall)
270 273 def _exiter_default(self):
271 274 return ExitAutocall(self)
272 275 # Monotonically increasing execution counter
273 276 execution_count = Integer(1)
274 277 filename = Unicode("<ipython console>")
275 278 ipython_dir= Unicode('', config=True) # Set to get_ipython_dir() in __init__
276 279
277 280 # Input splitter, to split entire cells of input into either individual
278 281 # interactive statements or whole blocks.
279 282 input_splitter = Instance('IPython.core.inputsplitter.IPythonInputSplitter',
280 283 (), {})
281 284 logstart = CBool(False, config=True, help=
282 285 """
283 286 Start logging to the default log file.
284 287 """
285 288 )
286 289 logfile = Unicode('', config=True, help=
287 290 """
288 291 The name of the logfile to use.
289 292 """
290 293 )
291 294 logappend = Unicode('', config=True, help=
292 295 """
293 296 Start logging to the given file in append mode.
294 297 """
295 298 )
296 299 object_info_string_level = Enum((0,1,2), default_value=0,
297 300 config=True)
298 301 pdb = CBool(False, config=True, help=
299 302 """
300 303 Automatically call the pdb debugger after every exception.
301 304 """
302 305 )
303 306 multiline_history = CBool(sys.platform != 'win32', config=True,
304 307 help="Save multi-line entries as one entry in readline history"
305 308 )
306 309
307 310 # deprecated prompt traits:
308 311
309 312 prompt_in1 = Unicode('In [\\#]: ', config=True,
310 313 help="Deprecated, use PromptManager.in_template")
311 314 prompt_in2 = Unicode(' .\\D.: ', config=True,
312 315 help="Deprecated, use PromptManager.in2_template")
313 316 prompt_out = Unicode('Out[\\#]: ', config=True,
314 317 help="Deprecated, use PromptManager.out_template")
315 318 prompts_pad_left = CBool(True, config=True,
316 319 help="Deprecated, use PromptManager.justify")
317 320
318 321 def _prompt_trait_changed(self, name, old, new):
319 322 table = {
320 323 'prompt_in1' : 'in_template',
321 324 'prompt_in2' : 'in2_template',
322 325 'prompt_out' : 'out_template',
323 326 'prompts_pad_left' : 'justify',
324 327 }
325 328 warn("InteractiveShell.{name} is deprecated, use PromptManager.{newname}\n".format(
326 329 name=name, newname=table[name])
327 330 )
328 331 # protect against weird cases where self.config may not exist:
329 332 if self.config is not None:
330 333 # propagate to corresponding PromptManager trait
331 334 setattr(self.config.PromptManager, table[name], new)
332 335
333 336 _prompt_in1_changed = _prompt_trait_changed
334 337 _prompt_in2_changed = _prompt_trait_changed
335 338 _prompt_out_changed = _prompt_trait_changed
336 339 _prompt_pad_left_changed = _prompt_trait_changed
337 340
338 341 show_rewritten_input = CBool(True, config=True,
339 342 help="Show rewritten input, e.g. for autocall."
340 343 )
341 344
342 345 quiet = CBool(False, config=True)
343 346
344 347 history_length = Integer(10000, config=True)
345 348
346 349 # The readline stuff will eventually be moved to the terminal subclass
347 350 # but for now, we can't do that as readline is welded in everywhere.
348 351 readline_use = CBool(True, config=True)
349 352 readline_remove_delims = Unicode('-/~', config=True)
350 353 # don't use \M- bindings by default, because they
351 354 # conflict with 8-bit encodings. See gh-58,gh-88
352 355 readline_parse_and_bind = List([
353 356 'tab: complete',
354 357 '"\C-l": clear-screen',
355 358 'set show-all-if-ambiguous on',
356 359 '"\C-o": tab-insert',
357 360 '"\C-r": reverse-search-history',
358 361 '"\C-s": forward-search-history',
359 362 '"\C-p": history-search-backward',
360 363 '"\C-n": history-search-forward',
361 364 '"\e[A": history-search-backward',
362 365 '"\e[B": history-search-forward',
363 366 '"\C-k": kill-line',
364 367 '"\C-u": unix-line-discard',
365 368 ], allow_none=False, config=True)
366 369
367 370 # TODO: this part of prompt management should be moved to the frontends.
368 371 # Use custom TraitTypes that convert '0'->'' and '\\n'->'\n'
369 372 separate_in = SeparateUnicode('\n', config=True)
370 373 separate_out = SeparateUnicode('', config=True)
371 374 separate_out2 = SeparateUnicode('', config=True)
372 375 wildcards_case_sensitive = CBool(True, config=True)
373 376 xmode = CaselessStrEnum(('Context','Plain', 'Verbose'),
374 377 default_value='Context', config=True)
375 378
376 379 # Subcomponents of InteractiveShell
377 380 alias_manager = Instance('IPython.core.alias.AliasManager')
378 381 prefilter_manager = Instance('IPython.core.prefilter.PrefilterManager')
379 382 builtin_trap = Instance('IPython.core.builtin_trap.BuiltinTrap')
380 383 display_trap = Instance('IPython.core.display_trap.DisplayTrap')
381 384 extension_manager = Instance('IPython.core.extensions.ExtensionManager')
382 385 plugin_manager = Instance('IPython.core.plugin.PluginManager')
383 386 payload_manager = Instance('IPython.core.payload.PayloadManager')
384 387 history_manager = Instance('IPython.core.history.HistoryManager')
385 388
386 389 profile_dir = Instance('IPython.core.application.ProfileDir')
387 390 @property
388 391 def profile(self):
389 392 if self.profile_dir is not None:
390 393 name = os.path.basename(self.profile_dir.location)
391 394 return name.replace('profile_','')
392 395
393 396
394 397 # Private interface
395 398 _post_execute = Instance(dict)
396 399
397 400 def __init__(self, config=None, ipython_dir=None, profile_dir=None,
398 401 user_module=None, user_ns=None,
399 402 custom_exceptions=((), None)):
400 403
401 404 # This is where traits with a config_key argument are updated
402 405 # from the values on config.
403 406 super(InteractiveShell, self).__init__(config=config)
404 407 self.configurables = [self]
405 408
406 409 # These are relatively independent and stateless
407 410 self.init_ipython_dir(ipython_dir)
408 411 self.init_profile_dir(profile_dir)
409 412 self.init_instance_attrs()
410 413 self.init_environment()
411 414
412 415 # Create namespaces (user_ns, user_global_ns, etc.)
413 416 self.init_create_namespaces(user_module, user_ns)
414 417 # This has to be done after init_create_namespaces because it uses
415 418 # something in self.user_ns, but before init_sys_modules, which
416 419 # is the first thing to modify sys.
417 420 # TODO: When we override sys.stdout and sys.stderr before this class
418 421 # is created, we are saving the overridden ones here. Not sure if this
419 422 # is what we want to do.
420 423 self.save_sys_module_state()
421 424 self.init_sys_modules()
422 425
423 426 # While we're trying to have each part of the code directly access what
424 427 # it needs without keeping redundant references to objects, we have too
425 428 # much legacy code that expects ip.db to exist.
426 429 self.db = PickleShareDB(os.path.join(self.profile_dir.location, 'db'))
427 430
428 431 self.init_history()
429 432 self.init_encoding()
430 433 self.init_prefilter()
431 434
432 435 Magic.__init__(self, self)
433 436
434 437 self.init_syntax_highlighting()
435 438 self.init_hooks()
436 439 self.init_pushd_popd_magic()
437 440 # self.init_traceback_handlers use to be here, but we moved it below
438 441 # because it and init_io have to come after init_readline.
439 442 self.init_user_ns()
440 443 self.init_logger()
441 444 self.init_alias()
442 445 self.init_builtins()
443 446
444 447 # pre_config_initialization
445 448
446 449 # The next section should contain everything that was in ipmaker.
447 450 self.init_logstart()
448 451
449 452 # The following was in post_config_initialization
450 453 self.init_inspector()
451 454 # init_readline() must come before init_io(), because init_io uses
452 455 # readline related things.
453 456 self.init_readline()
454 457 # We save this here in case user code replaces raw_input, but it needs
455 458 # to be after init_readline(), because PyPy's readline works by replacing
456 459 # raw_input.
457 460 if py3compat.PY3:
458 461 self.raw_input_original = input
459 462 else:
460 463 self.raw_input_original = raw_input
461 464 # init_completer must come after init_readline, because it needs to
462 465 # know whether readline is present or not system-wide to configure the
463 466 # completers, since the completion machinery can now operate
464 467 # independently of readline (e.g. over the network)
465 468 self.init_completer()
466 469 # TODO: init_io() needs to happen before init_traceback handlers
467 470 # because the traceback handlers hardcode the stdout/stderr streams.
468 471 # This logic in in debugger.Pdb and should eventually be changed.
469 472 self.init_io()
470 473 self.init_traceback_handlers(custom_exceptions)
471 474 self.init_prompts()
472 475 self.init_display_formatter()
473 476 self.init_display_pub()
474 477 self.init_displayhook()
475 478 self.init_reload_doctest()
476 479 self.init_magics()
477 480 self.init_pdb()
478 481 self.init_extension_manager()
479 482 self.init_plugin_manager()
480 483 self.init_payload()
481 484 self.hooks.late_startup_hook()
482 485 atexit.register(self.atexit_operations)
483 486
484 487 def get_ipython(self):
485 488 """Return the currently running IPython instance."""
486 489 return self
487 490
488 491 #-------------------------------------------------------------------------
489 492 # Trait changed handlers
490 493 #-------------------------------------------------------------------------
491 494
492 495 def _ipython_dir_changed(self, name, new):
493 496 if not os.path.isdir(new):
494 497 os.makedirs(new, mode = 0777)
495 498
496 499 def set_autoindent(self,value=None):
497 500 """Set the autoindent flag, checking for readline support.
498 501
499 502 If called with no arguments, it acts as a toggle."""
500 503
501 504 if value != 0 and not self.has_readline:
502 505 if os.name == 'posix':
503 506 warn("The auto-indent feature requires the readline library")
504 507 self.autoindent = 0
505 508 return
506 509 if value is None:
507 510 self.autoindent = not self.autoindent
508 511 else:
509 512 self.autoindent = value
510 513
511 514 #-------------------------------------------------------------------------
512 515 # init_* methods called by __init__
513 516 #-------------------------------------------------------------------------
514 517
515 518 def init_ipython_dir(self, ipython_dir):
516 519 if ipython_dir is not None:
517 520 self.ipython_dir = ipython_dir
518 521 return
519 522
520 523 self.ipython_dir = get_ipython_dir()
521 524
522 525 def init_profile_dir(self, profile_dir):
523 526 if profile_dir is not None:
524 527 self.profile_dir = profile_dir
525 528 return
526 529 self.profile_dir =\
527 530 ProfileDir.create_profile_dir_by_name(self.ipython_dir, 'default')
528 531
529 532 def init_instance_attrs(self):
530 533 self.more = False
531 534
532 535 # command compiler
533 536 self.compile = CachingCompiler()
534 537
535 538 # Make an empty namespace, which extension writers can rely on both
536 539 # existing and NEVER being used by ipython itself. This gives them a
537 540 # convenient location for storing additional information and state
538 541 # their extensions may require, without fear of collisions with other
539 542 # ipython names that may develop later.
540 543 self.meta = Struct()
541 544
542 545 # Temporary files used for various purposes. Deleted at exit.
543 546 self.tempfiles = []
544 547
545 548 # Keep track of readline usage (later set by init_readline)
546 549 self.has_readline = False
547 550
548 551 # keep track of where we started running (mainly for crash post-mortem)
549 552 # This is not being used anywhere currently.
550 553 self.starting_dir = os.getcwdu()
551 554
552 555 # Indentation management
553 556 self.indent_current_nsp = 0
554 557
555 558 # Dict to track post-execution functions that have been registered
556 559 self._post_execute = {}
557 560
558 561 def init_environment(self):
559 562 """Any changes we need to make to the user's environment."""
560 563 pass
561 564
562 565 def init_encoding(self):
563 566 # Get system encoding at startup time. Certain terminals (like Emacs
564 567 # under Win32 have it set to None, and we need to have a known valid
565 568 # encoding to use in the raw_input() method
566 569 try:
567 570 self.stdin_encoding = sys.stdin.encoding or 'ascii'
568 571 except AttributeError:
569 572 self.stdin_encoding = 'ascii'
570 573
571 574 def init_syntax_highlighting(self):
572 575 # Python source parser/formatter for syntax highlighting
573 576 pyformat = PyColorize.Parser().format
574 577 self.pycolorize = lambda src: pyformat(src,'str',self.colors)
575 578
576 579 def init_pushd_popd_magic(self):
577 580 # for pushd/popd management
578 581 self.home_dir = get_home_dir()
579 582
580 583 self.dir_stack = []
581 584
582 585 def init_logger(self):
583 586 self.logger = Logger(self.home_dir, logfname='ipython_log.py',
584 587 logmode='rotate')
585 588
586 589 def init_logstart(self):
587 590 """Initialize logging in case it was requested at the command line.
588 591 """
589 592 if self.logappend:
590 593 self.magic_logstart(self.logappend + ' append')
591 594 elif self.logfile:
592 595 self.magic_logstart(self.logfile)
593 596 elif self.logstart:
594 597 self.magic_logstart()
595 598
596 599 def init_builtins(self):
597 600 # A single, static flag that we set to True. Its presence indicates
598 601 # that an IPython shell has been created, and we make no attempts at
599 602 # removing on exit or representing the existence of more than one
600 603 # IPython at a time.
601 604 builtin_mod.__dict__['__IPYTHON__'] = True
602 605
603 606 # In 0.11 we introduced '__IPYTHON__active' as an integer we'd try to
604 607 # manage on enter/exit, but with all our shells it's virtually
605 608 # impossible to get all the cases right. We're leaving the name in for
606 609 # those who adapted their codes to check for this flag, but will
607 610 # eventually remove it after a few more releases.
608 611 builtin_mod.__dict__['__IPYTHON__active'] = \
609 612 'Deprecated, check for __IPYTHON__'
610 613
611 614 self.builtin_trap = BuiltinTrap(shell=self)
612 615
613 616 def init_inspector(self):
614 617 # Object inspector
615 618 self.inspector = oinspect.Inspector(oinspect.InspectColors,
616 619 PyColorize.ANSICodeColors,
617 620 'NoColor',
618 621 self.object_info_string_level)
619 622
620 623 def init_io(self):
621 624 # This will just use sys.stdout and sys.stderr. If you want to
622 625 # override sys.stdout and sys.stderr themselves, you need to do that
623 626 # *before* instantiating this class, because io holds onto
624 627 # references to the underlying streams.
625 628 if sys.platform == 'win32' and self.has_readline:
626 629 io.stdout = io.stderr = io.IOStream(self.readline._outputfile)
627 630 else:
628 631 io.stdout = io.IOStream(sys.stdout)
629 632 io.stderr = io.IOStream(sys.stderr)
630 633
631 634 def init_prompts(self):
632 635 self.prompt_manager = PromptManager(shell=self, config=self.config)
633 636 self.configurables.append(self.prompt_manager)
634 637
635 638 def init_display_formatter(self):
636 639 self.display_formatter = DisplayFormatter(config=self.config)
637 640 self.configurables.append(self.display_formatter)
638 641
639 642 def init_display_pub(self):
640 643 self.display_pub = self.display_pub_class(config=self.config)
641 644 self.configurables.append(self.display_pub)
642 645
643 646 def init_displayhook(self):
644 647 # Initialize displayhook, set in/out prompts and printing system
645 648 self.displayhook = self.displayhook_class(
646 649 config=self.config,
647 650 shell=self,
648 651 cache_size=self.cache_size,
649 652 )
650 653 self.configurables.append(self.displayhook)
651 654 # This is a context manager that installs/revmoes the displayhook at
652 655 # the appropriate time.
653 656 self.display_trap = DisplayTrap(hook=self.displayhook)
654 657
655 658 def init_reload_doctest(self):
656 659 # Do a proper resetting of doctest, including the necessary displayhook
657 660 # monkeypatching
658 661 try:
659 662 doctest_reload()
660 663 except ImportError:
661 664 warn("doctest module does not exist.")
662 665
663 666 #-------------------------------------------------------------------------
664 667 # Things related to injections into the sys module
665 668 #-------------------------------------------------------------------------
666 669
667 670 def save_sys_module_state(self):
668 671 """Save the state of hooks in the sys module.
669 672
670 673 This has to be called after self.user_module is created.
671 674 """
672 675 self._orig_sys_module_state = {}
673 676 self._orig_sys_module_state['stdin'] = sys.stdin
674 677 self._orig_sys_module_state['stdout'] = sys.stdout
675 678 self._orig_sys_module_state['stderr'] = sys.stderr
676 679 self._orig_sys_module_state['excepthook'] = sys.excepthook
677 680 self._orig_sys_modules_main_name = self.user_module.__name__
678 681
679 682 def restore_sys_module_state(self):
680 683 """Restore the state of the sys module."""
681 684 try:
682 685 for k, v in self._orig_sys_module_state.iteritems():
683 686 setattr(sys, k, v)
684 687 except AttributeError:
685 688 pass
686 689 # Reset what what done in self.init_sys_modules
687 690 sys.modules[self.user_module.__name__] = self._orig_sys_modules_main_name
688 691
689 692 #-------------------------------------------------------------------------
690 693 # Things related to hooks
691 694 #-------------------------------------------------------------------------
692 695
693 696 def init_hooks(self):
694 697 # hooks holds pointers used for user-side customizations
695 698 self.hooks = Struct()
696 699
697 700 self.strdispatchers = {}
698 701
699 702 # Set all default hooks, defined in the IPython.hooks module.
700 703 hooks = IPython.core.hooks
701 704 for hook_name in hooks.__all__:
702 705 # default hooks have priority 100, i.e. low; user hooks should have
703 706 # 0-100 priority
704 707 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
705 708
706 709 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
707 710 """set_hook(name,hook) -> sets an internal IPython hook.
708 711
709 712 IPython exposes some of its internal API as user-modifiable hooks. By
710 713 adding your function to one of these hooks, you can modify IPython's
711 714 behavior to call at runtime your own routines."""
712 715
713 716 # At some point in the future, this should validate the hook before it
714 717 # accepts it. Probably at least check that the hook takes the number
715 718 # of args it's supposed to.
716 719
717 720 f = types.MethodType(hook,self)
718 721
719 722 # check if the hook is for strdispatcher first
720 723 if str_key is not None:
721 724 sdp = self.strdispatchers.get(name, StrDispatch())
722 725 sdp.add_s(str_key, f, priority )
723 726 self.strdispatchers[name] = sdp
724 727 return
725 728 if re_key is not None:
726 729 sdp = self.strdispatchers.get(name, StrDispatch())
727 730 sdp.add_re(re.compile(re_key), f, priority )
728 731 self.strdispatchers[name] = sdp
729 732 return
730 733
731 734 dp = getattr(self.hooks, name, None)
732 735 if name not in IPython.core.hooks.__all__:
733 736 print "Warning! Hook '%s' is not one of %s" % \
734 737 (name, IPython.core.hooks.__all__ )
735 738 if not dp:
736 739 dp = IPython.core.hooks.CommandChainDispatcher()
737 740
738 741 try:
739 742 dp.add(f,priority)
740 743 except AttributeError:
741 744 # it was not commandchain, plain old func - replace
742 745 dp = f
743 746
744 747 setattr(self.hooks,name, dp)
745 748
746 749 def register_post_execute(self, func):
747 750 """Register a function for calling after code execution.
748 751 """
749 752 if not callable(func):
750 753 raise ValueError('argument %s must be callable' % func)
751 754 self._post_execute[func] = True
752 755
753 756 #-------------------------------------------------------------------------
754 757 # Things related to the "main" module
755 758 #-------------------------------------------------------------------------
756 759
757 760 def new_main_mod(self,ns=None):
758 761 """Return a new 'main' module object for user code execution.
759 762 """
760 763 main_mod = self._user_main_module
761 764 init_fakemod_dict(main_mod,ns)
762 765 return main_mod
763 766
764 767 def cache_main_mod(self,ns,fname):
765 768 """Cache a main module's namespace.
766 769
767 770 When scripts are executed via %run, we must keep a reference to the
768 771 namespace of their __main__ module (a FakeModule instance) around so
769 772 that Python doesn't clear it, rendering objects defined therein
770 773 useless.
771 774
772 775 This method keeps said reference in a private dict, keyed by the
773 776 absolute path of the module object (which corresponds to the script
774 777 path). This way, for multiple executions of the same script we only
775 778 keep one copy of the namespace (the last one), thus preventing memory
776 779 leaks from old references while allowing the objects from the last
777 780 execution to be accessible.
778 781
779 782 Note: we can not allow the actual FakeModule instances to be deleted,
780 783 because of how Python tears down modules (it hard-sets all their
781 784 references to None without regard for reference counts). This method
782 785 must therefore make a *copy* of the given namespace, to allow the
783 786 original module's __dict__ to be cleared and reused.
784 787
785 788
786 789 Parameters
787 790 ----------
788 791 ns : a namespace (a dict, typically)
789 792
790 793 fname : str
791 794 Filename associated with the namespace.
792 795
793 796 Examples
794 797 --------
795 798
796 799 In [10]: import IPython
797 800
798 801 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
799 802
800 803 In [12]: IPython.__file__ in _ip._main_ns_cache
801 804 Out[12]: True
802 805 """
803 806 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
804 807
805 808 def clear_main_mod_cache(self):
806 809 """Clear the cache of main modules.
807 810
808 811 Mainly for use by utilities like %reset.
809 812
810 813 Examples
811 814 --------
812 815
813 816 In [15]: import IPython
814 817
815 818 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
816 819
817 820 In [17]: len(_ip._main_ns_cache) > 0
818 821 Out[17]: True
819 822
820 823 In [18]: _ip.clear_main_mod_cache()
821 824
822 825 In [19]: len(_ip._main_ns_cache) == 0
823 826 Out[19]: True
824 827 """
825 828 self._main_ns_cache.clear()
826 829
827 830 #-------------------------------------------------------------------------
828 831 # Things related to debugging
829 832 #-------------------------------------------------------------------------
830 833
831 834 def init_pdb(self):
832 835 # Set calling of pdb on exceptions
833 836 # self.call_pdb is a property
834 837 self.call_pdb = self.pdb
835 838
836 839 def _get_call_pdb(self):
837 840 return self._call_pdb
838 841
839 842 def _set_call_pdb(self,val):
840 843
841 844 if val not in (0,1,False,True):
842 845 raise ValueError,'new call_pdb value must be boolean'
843 846
844 847 # store value in instance
845 848 self._call_pdb = val
846 849
847 850 # notify the actual exception handlers
848 851 self.InteractiveTB.call_pdb = val
849 852
850 853 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
851 854 'Control auto-activation of pdb at exceptions')
852 855
853 856 def debugger(self,force=False):
854 857 """Call the pydb/pdb debugger.
855 858
856 859 Keywords:
857 860
858 861 - force(False): by default, this routine checks the instance call_pdb
859 862 flag and does not actually invoke the debugger if the flag is false.
860 863 The 'force' option forces the debugger to activate even if the flag
861 864 is false.
862 865 """
863 866
864 867 if not (force or self.call_pdb):
865 868 return
866 869
867 870 if not hasattr(sys,'last_traceback'):
868 871 error('No traceback has been produced, nothing to debug.')
869 872 return
870 873
871 874 # use pydb if available
872 875 if debugger.has_pydb:
873 876 from pydb import pm
874 877 else:
875 878 # fallback to our internal debugger
876 879 pm = lambda : self.InteractiveTB.debugger(force=True)
877 880
878 881 with self.readline_no_record:
879 882 pm()
880 883
881 884 #-------------------------------------------------------------------------
882 885 # Things related to IPython's various namespaces
883 886 #-------------------------------------------------------------------------
884 887 default_user_namespaces = True
885 888
886 889 def init_create_namespaces(self, user_module=None, user_ns=None):
887 890 # Create the namespace where the user will operate. user_ns is
888 891 # normally the only one used, and it is passed to the exec calls as
889 892 # the locals argument. But we do carry a user_global_ns namespace
890 893 # given as the exec 'globals' argument, This is useful in embedding
891 894 # situations where the ipython shell opens in a context where the
892 895 # distinction between locals and globals is meaningful. For
893 896 # non-embedded contexts, it is just the same object as the user_ns dict.
894 897
895 898 # FIXME. For some strange reason, __builtins__ is showing up at user
896 899 # level as a dict instead of a module. This is a manual fix, but I
897 900 # should really track down where the problem is coming from. Alex
898 901 # Schmolck reported this problem first.
899 902
900 903 # A useful post by Alex Martelli on this topic:
901 904 # Re: inconsistent value from __builtins__
902 905 # Von: Alex Martelli <aleaxit@yahoo.com>
903 906 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
904 907 # Gruppen: comp.lang.python
905 908
906 909 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
907 910 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
908 911 # > <type 'dict'>
909 912 # > >>> print type(__builtins__)
910 913 # > <type 'module'>
911 914 # > Is this difference in return value intentional?
912 915
913 916 # Well, it's documented that '__builtins__' can be either a dictionary
914 917 # or a module, and it's been that way for a long time. Whether it's
915 918 # intentional (or sensible), I don't know. In any case, the idea is
916 919 # that if you need to access the built-in namespace directly, you
917 920 # should start with "import __builtin__" (note, no 's') which will
918 921 # definitely give you a module. Yeah, it's somewhat confusing:-(.
919 922
920 923 # These routines return a properly built module and dict as needed by
921 924 # the rest of the code, and can also be used by extension writers to
922 925 # generate properly initialized namespaces.
923 926 if (user_ns is not None) or (user_module is not None):
924 927 self.default_user_namespaces = False
925 928 self.user_module, self.user_ns = self.prepare_user_module(user_module, user_ns)
926 929
927 930 # A record of hidden variables we have added to the user namespace, so
928 931 # we can list later only variables defined in actual interactive use.
929 932 self.user_ns_hidden = set()
930 933
931 934 # Now that FakeModule produces a real module, we've run into a nasty
932 935 # problem: after script execution (via %run), the module where the user
933 936 # code ran is deleted. Now that this object is a true module (needed
934 937 # so docetst and other tools work correctly), the Python module
935 938 # teardown mechanism runs over it, and sets to None every variable
936 939 # present in that module. Top-level references to objects from the
937 940 # script survive, because the user_ns is updated with them. However,
938 941 # calling functions defined in the script that use other things from
939 942 # the script will fail, because the function's closure had references
940 943 # to the original objects, which are now all None. So we must protect
941 944 # these modules from deletion by keeping a cache.
942 945 #
943 946 # To avoid keeping stale modules around (we only need the one from the
944 947 # last run), we use a dict keyed with the full path to the script, so
945 948 # only the last version of the module is held in the cache. Note,
946 949 # however, that we must cache the module *namespace contents* (their
947 950 # __dict__). Because if we try to cache the actual modules, old ones
948 951 # (uncached) could be destroyed while still holding references (such as
949 952 # those held by GUI objects that tend to be long-lived)>
950 953 #
951 954 # The %reset command will flush this cache. See the cache_main_mod()
952 955 # and clear_main_mod_cache() methods for details on use.
953 956
954 957 # This is the cache used for 'main' namespaces
955 958 self._main_ns_cache = {}
956 959 # And this is the single instance of FakeModule whose __dict__ we keep
957 960 # copying and clearing for reuse on each %run
958 961 self._user_main_module = FakeModule()
959 962
960 963 # A table holding all the namespaces IPython deals with, so that
961 964 # introspection facilities can search easily.
962 965 self.ns_table = {'user_global':self.user_module.__dict__,
963 966 'user_local':self.user_ns,
964 967 'builtin':builtin_mod.__dict__
965 968 }
966 969
967 970 @property
968 971 def user_global_ns(self):
969 972 return self.user_module.__dict__
970 973
971 974 def prepare_user_module(self, user_module=None, user_ns=None):
972 975 """Prepare the module and namespace in which user code will be run.
973 976
974 977 When IPython is started normally, both parameters are None: a new module
975 978 is created automatically, and its __dict__ used as the namespace.
976 979
977 980 If only user_module is provided, its __dict__ is used as the namespace.
978 981 If only user_ns is provided, a dummy module is created, and user_ns
979 982 becomes the global namespace. If both are provided (as they may be
980 983 when embedding), user_ns is the local namespace, and user_module
981 984 provides the global namespace.
982 985
983 986 Parameters
984 987 ----------
985 988 user_module : module, optional
986 989 The current user module in which IPython is being run. If None,
987 990 a clean module will be created.
988 991 user_ns : dict, optional
989 992 A namespace in which to run interactive commands.
990 993
991 994 Returns
992 995 -------
993 996 A tuple of user_module and user_ns, each properly initialised.
994 997 """
995 998 if user_module is None and user_ns is not None:
996 999 user_ns.setdefault("__name__", "__main__")
997 1000 class DummyMod(object):
998 1001 "A dummy module used for IPython's interactive namespace."
999 1002 pass
1000 1003 user_module = DummyMod()
1001 1004 user_module.__dict__ = user_ns
1002 1005
1003 1006 if user_module is None:
1004 1007 user_module = types.ModuleType("__main__",
1005 1008 doc="Automatically created module for IPython interactive environment")
1006 1009
1007 1010 # We must ensure that __builtin__ (without the final 's') is always
1008 1011 # available and pointing to the __builtin__ *module*. For more details:
1009 1012 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1010 1013 user_module.__dict__.setdefault('__builtin__', builtin_mod)
1011 1014 user_module.__dict__.setdefault('__builtins__', builtin_mod)
1012 1015
1013 1016 if user_ns is None:
1014 1017 user_ns = user_module.__dict__
1015 1018
1016 1019 return user_module, user_ns
1017 1020
1018 1021 def init_sys_modules(self):
1019 1022 # We need to insert into sys.modules something that looks like a
1020 1023 # module but which accesses the IPython namespace, for shelve and
1021 1024 # pickle to work interactively. Normally they rely on getting
1022 1025 # everything out of __main__, but for embedding purposes each IPython
1023 1026 # instance has its own private namespace, so we can't go shoving
1024 1027 # everything into __main__.
1025 1028
1026 1029 # note, however, that we should only do this for non-embedded
1027 1030 # ipythons, which really mimic the __main__.__dict__ with their own
1028 1031 # namespace. Embedded instances, on the other hand, should not do
1029 1032 # this because they need to manage the user local/global namespaces
1030 1033 # only, but they live within a 'normal' __main__ (meaning, they
1031 1034 # shouldn't overtake the execution environment of the script they're
1032 1035 # embedded in).
1033 1036
1034 1037 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
1035 1038 main_name = self.user_module.__name__
1036 1039 sys.modules[main_name] = self.user_module
1037 1040
1038 1041 def init_user_ns(self):
1039 1042 """Initialize all user-visible namespaces to their minimum defaults.
1040 1043
1041 1044 Certain history lists are also initialized here, as they effectively
1042 1045 act as user namespaces.
1043 1046
1044 1047 Notes
1045 1048 -----
1046 1049 All data structures here are only filled in, they are NOT reset by this
1047 1050 method. If they were not empty before, data will simply be added to
1048 1051 therm.
1049 1052 """
1050 1053 # This function works in two parts: first we put a few things in
1051 1054 # user_ns, and we sync that contents into user_ns_hidden so that these
1052 1055 # initial variables aren't shown by %who. After the sync, we add the
1053 1056 # rest of what we *do* want the user to see with %who even on a new
1054 1057 # session (probably nothing, so theye really only see their own stuff)
1055 1058
1056 1059 # The user dict must *always* have a __builtin__ reference to the
1057 1060 # Python standard __builtin__ namespace, which must be imported.
1058 1061 # This is so that certain operations in prompt evaluation can be
1059 1062 # reliably executed with builtins. Note that we can NOT use
1060 1063 # __builtins__ (note the 's'), because that can either be a dict or a
1061 1064 # module, and can even mutate at runtime, depending on the context
1062 1065 # (Python makes no guarantees on it). In contrast, __builtin__ is
1063 1066 # always a module object, though it must be explicitly imported.
1064 1067
1065 1068 # For more details:
1066 1069 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
1067 1070 ns = dict()
1068 1071
1069 1072 # Put 'help' in the user namespace
1070 1073 try:
1071 1074 from site import _Helper
1072 1075 ns['help'] = _Helper()
1073 1076 except ImportError:
1074 1077 warn('help() not available - check site.py')
1075 1078
1076 1079 # make global variables for user access to the histories
1077 1080 ns['_ih'] = self.history_manager.input_hist_parsed
1078 1081 ns['_oh'] = self.history_manager.output_hist
1079 1082 ns['_dh'] = self.history_manager.dir_hist
1080 1083
1081 1084 ns['_sh'] = shadowns
1082 1085
1083 1086 # user aliases to input and output histories. These shouldn't show up
1084 1087 # in %who, as they can have very large reprs.
1085 1088 ns['In'] = self.history_manager.input_hist_parsed
1086 1089 ns['Out'] = self.history_manager.output_hist
1087 1090
1088 1091 # Store myself as the public api!!!
1089 1092 ns['get_ipython'] = self.get_ipython
1090 1093
1091 1094 ns['exit'] = self.exiter
1092 1095 ns['quit'] = self.exiter
1093 1096
1094 1097 # Sync what we've added so far to user_ns_hidden so these aren't seen
1095 1098 # by %who
1096 1099 self.user_ns_hidden.update(ns)
1097 1100
1098 1101 # Anything put into ns now would show up in %who. Think twice before
1099 1102 # putting anything here, as we really want %who to show the user their
1100 1103 # stuff, not our variables.
1101 1104
1102 1105 # Finally, update the real user's namespace
1103 1106 self.user_ns.update(ns)
1104 1107
1105 1108 @property
1106 1109 def all_ns_refs(self):
1107 1110 """Get a list of references to all the namespace dictionaries in which
1108 1111 IPython might store a user-created object.
1109 1112
1110 1113 Note that this does not include the displayhook, which also caches
1111 1114 objects from the output."""
1112 1115 return [self.user_ns, self.user_global_ns,
1113 1116 self._user_main_module.__dict__] + self._main_ns_cache.values()
1114 1117
1115 1118 def reset(self, new_session=True):
1116 1119 """Clear all internal namespaces, and attempt to release references to
1117 1120 user objects.
1118 1121
1119 1122 If new_session is True, a new history session will be opened.
1120 1123 """
1121 1124 # Clear histories
1122 1125 self.history_manager.reset(new_session)
1123 1126 # Reset counter used to index all histories
1124 1127 if new_session:
1125 1128 self.execution_count = 1
1126 1129
1127 1130 # Flush cached output items
1128 1131 if self.displayhook.do_full_cache:
1129 1132 self.displayhook.flush()
1130 1133
1131 1134 # The main execution namespaces must be cleared very carefully,
1132 1135 # skipping the deletion of the builtin-related keys, because doing so
1133 1136 # would cause errors in many object's __del__ methods.
1134 1137 if self.user_ns is not self.user_global_ns:
1135 1138 self.user_ns.clear()
1136 1139 ns = self.user_global_ns
1137 1140 drop_keys = set(ns.keys())
1138 1141 drop_keys.discard('__builtin__')
1139 1142 drop_keys.discard('__builtins__')
1140 1143 drop_keys.discard('__name__')
1141 1144 for k in drop_keys:
1142 1145 del ns[k]
1143 1146
1144 1147 self.user_ns_hidden.clear()
1145 1148
1146 1149 # Restore the user namespaces to minimal usability
1147 1150 self.init_user_ns()
1148 1151
1149 1152 # Restore the default and user aliases
1150 1153 self.alias_manager.clear_aliases()
1151 1154 self.alias_manager.init_aliases()
1152 1155
1153 1156 # Flush the private list of module references kept for script
1154 1157 # execution protection
1155 1158 self.clear_main_mod_cache()
1156 1159
1157 1160 # Clear out the namespace from the last %run
1158 1161 self.new_main_mod()
1159 1162
1160 1163 def del_var(self, varname, by_name=False):
1161 1164 """Delete a variable from the various namespaces, so that, as
1162 1165 far as possible, we're not keeping any hidden references to it.
1163 1166
1164 1167 Parameters
1165 1168 ----------
1166 1169 varname : str
1167 1170 The name of the variable to delete.
1168 1171 by_name : bool
1169 1172 If True, delete variables with the given name in each
1170 1173 namespace. If False (default), find the variable in the user
1171 1174 namespace, and delete references to it.
1172 1175 """
1173 1176 if varname in ('__builtin__', '__builtins__'):
1174 1177 raise ValueError("Refusing to delete %s" % varname)
1175 1178
1176 1179 ns_refs = self.all_ns_refs
1177 1180
1178 1181 if by_name: # Delete by name
1179 1182 for ns in ns_refs:
1180 1183 try:
1181 1184 del ns[varname]
1182 1185 except KeyError:
1183 1186 pass
1184 1187 else: # Delete by object
1185 1188 try:
1186 1189 obj = self.user_ns[varname]
1187 1190 except KeyError:
1188 1191 raise NameError("name '%s' is not defined" % varname)
1189 1192 # Also check in output history
1190 1193 ns_refs.append(self.history_manager.output_hist)
1191 1194 for ns in ns_refs:
1192 1195 to_delete = [n for n, o in ns.iteritems() if o is obj]
1193 1196 for name in to_delete:
1194 1197 del ns[name]
1195 1198
1196 1199 # displayhook keeps extra references, but not in a dictionary
1197 1200 for name in ('_', '__', '___'):
1198 1201 if getattr(self.displayhook, name) is obj:
1199 1202 setattr(self.displayhook, name, None)
1200 1203
1201 1204 def reset_selective(self, regex=None):
1202 1205 """Clear selective variables from internal namespaces based on a
1203 1206 specified regular expression.
1204 1207
1205 1208 Parameters
1206 1209 ----------
1207 1210 regex : string or compiled pattern, optional
1208 1211 A regular expression pattern that will be used in searching
1209 1212 variable names in the users namespaces.
1210 1213 """
1211 1214 if regex is not None:
1212 1215 try:
1213 1216 m = re.compile(regex)
1214 1217 except TypeError:
1215 1218 raise TypeError('regex must be a string or compiled pattern')
1216 1219 # Search for keys in each namespace that match the given regex
1217 1220 # If a match is found, delete the key/value pair.
1218 1221 for ns in self.all_ns_refs:
1219 1222 for var in ns:
1220 1223 if m.search(var):
1221 1224 del ns[var]
1222 1225
1223 1226 def push(self, variables, interactive=True):
1224 1227 """Inject a group of variables into the IPython user namespace.
1225 1228
1226 1229 Parameters
1227 1230 ----------
1228 1231 variables : dict, str or list/tuple of str
1229 1232 The variables to inject into the user's namespace. If a dict, a
1230 1233 simple update is done. If a str, the string is assumed to have
1231 1234 variable names separated by spaces. A list/tuple of str can also
1232 1235 be used to give the variable names. If just the variable names are
1233 1236 give (list/tuple/str) then the variable values looked up in the
1234 1237 callers frame.
1235 1238 interactive : bool
1236 1239 If True (default), the variables will be listed with the ``who``
1237 1240 magic.
1238 1241 """
1239 1242 vdict = None
1240 1243
1241 1244 # We need a dict of name/value pairs to do namespace updates.
1242 1245 if isinstance(variables, dict):
1243 1246 vdict = variables
1244 1247 elif isinstance(variables, (basestring, list, tuple)):
1245 1248 if isinstance(variables, basestring):
1246 1249 vlist = variables.split()
1247 1250 else:
1248 1251 vlist = variables
1249 1252 vdict = {}
1250 1253 cf = sys._getframe(1)
1251 1254 for name in vlist:
1252 1255 try:
1253 1256 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1254 1257 except:
1255 1258 print ('Could not get variable %s from %s' %
1256 1259 (name,cf.f_code.co_name))
1257 1260 else:
1258 1261 raise ValueError('variables must be a dict/str/list/tuple')
1259 1262
1260 1263 # Propagate variables to user namespace
1261 1264 self.user_ns.update(vdict)
1262 1265
1263 1266 # And configure interactive visibility
1264 1267 user_ns_hidden = self.user_ns_hidden
1265 1268 if interactive:
1266 1269 user_ns_hidden.difference_update(vdict)
1267 1270 else:
1268 1271 user_ns_hidden.update(vdict)
1269 1272
1270 1273 def drop_by_id(self, variables):
1271 1274 """Remove a dict of variables from the user namespace, if they are the
1272 1275 same as the values in the dictionary.
1273 1276
1274 1277 This is intended for use by extensions: variables that they've added can
1275 1278 be taken back out if they are unloaded, without removing any that the
1276 1279 user has overwritten.
1277 1280
1278 1281 Parameters
1279 1282 ----------
1280 1283 variables : dict
1281 1284 A dictionary mapping object names (as strings) to the objects.
1282 1285 """
1283 1286 for name, obj in variables.iteritems():
1284 1287 if name in self.user_ns and self.user_ns[name] is obj:
1285 1288 del self.user_ns[name]
1286 1289 self.user_ns_hidden.discard(name)
1287 1290
1288 1291 #-------------------------------------------------------------------------
1289 1292 # Things related to object introspection
1290 1293 #-------------------------------------------------------------------------
1291 1294
1292 1295 def _ofind(self, oname, namespaces=None):
1293 1296 """Find an object in the available namespaces.
1294 1297
1295 1298 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1296 1299
1297 1300 Has special code to detect magic functions.
1298 1301 """
1299 1302 oname = oname.strip()
1300 1303 #print '1- oname: <%r>' % oname # dbg
1301 1304 if not py3compat.isidentifier(oname.lstrip(ESC_MAGIC), dotted=True):
1302 1305 return dict(found=False)
1303 1306
1304 1307 alias_ns = None
1305 1308 if namespaces is None:
1306 1309 # Namespaces to search in:
1307 1310 # Put them in a list. The order is important so that we
1308 1311 # find things in the same order that Python finds them.
1309 1312 namespaces = [ ('Interactive', self.user_ns),
1310 1313 ('Interactive (global)', self.user_global_ns),
1311 1314 ('Python builtin', builtin_mod.__dict__),
1312 1315 ('Alias', self.alias_manager.alias_table),
1313 1316 ]
1314 1317 alias_ns = self.alias_manager.alias_table
1315 1318
1316 1319 # initialize results to 'null'
1317 1320 found = False; obj = None; ospace = None; ds = None;
1318 1321 ismagic = False; isalias = False; parent = None
1319 1322
1320 1323 # We need to special-case 'print', which as of python2.6 registers as a
1321 1324 # function but should only be treated as one if print_function was
1322 1325 # loaded with a future import. In this case, just bail.
1323 1326 if (oname == 'print' and not py3compat.PY3 and not \
1324 1327 (self.compile.compiler_flags & __future__.CO_FUTURE_PRINT_FUNCTION)):
1325 1328 return {'found':found, 'obj':obj, 'namespace':ospace,
1326 1329 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1327 1330
1328 1331 # Look for the given name by splitting it in parts. If the head is
1329 1332 # found, then we look for all the remaining parts as members, and only
1330 1333 # declare success if we can find them all.
1331 1334 oname_parts = oname.split('.')
1332 1335 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1333 1336 for nsname,ns in namespaces:
1334 1337 try:
1335 1338 obj = ns[oname_head]
1336 1339 except KeyError:
1337 1340 continue
1338 1341 else:
1339 1342 #print 'oname_rest:', oname_rest # dbg
1340 1343 for part in oname_rest:
1341 1344 try:
1342 1345 parent = obj
1343 1346 obj = getattr(obj,part)
1344 1347 except:
1345 1348 # Blanket except b/c some badly implemented objects
1346 1349 # allow __getattr__ to raise exceptions other than
1347 1350 # AttributeError, which then crashes IPython.
1348 1351 break
1349 1352 else:
1350 1353 # If we finish the for loop (no break), we got all members
1351 1354 found = True
1352 1355 ospace = nsname
1353 1356 if ns == alias_ns:
1354 1357 isalias = True
1355 1358 break # namespace loop
1356 1359
1357 1360 # Try to see if it's magic
1358 1361 if not found:
1359 1362 if oname.startswith(ESC_MAGIC):
1360 1363 oname = oname[1:]
1361 1364 obj = getattr(self,'magic_'+oname,None)
1362 1365 if obj is not None:
1363 1366 found = True
1364 1367 ospace = 'IPython internal'
1365 1368 ismagic = True
1366 1369
1367 1370 # Last try: special-case some literals like '', [], {}, etc:
1368 1371 if not found and oname_head in ["''",'""','[]','{}','()']:
1369 1372 obj = eval(oname_head)
1370 1373 found = True
1371 1374 ospace = 'Interactive'
1372 1375
1373 1376 return {'found':found, 'obj':obj, 'namespace':ospace,
1374 1377 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1375 1378
1376 1379 def _ofind_property(self, oname, info):
1377 1380 """Second part of object finding, to look for property details."""
1378 1381 if info.found:
1379 1382 # Get the docstring of the class property if it exists.
1380 1383 path = oname.split('.')
1381 1384 root = '.'.join(path[:-1])
1382 1385 if info.parent is not None:
1383 1386 try:
1384 1387 target = getattr(info.parent, '__class__')
1385 1388 # The object belongs to a class instance.
1386 1389 try:
1387 1390 target = getattr(target, path[-1])
1388 1391 # The class defines the object.
1389 1392 if isinstance(target, property):
1390 1393 oname = root + '.__class__.' + path[-1]
1391 1394 info = Struct(self._ofind(oname))
1392 1395 except AttributeError: pass
1393 1396 except AttributeError: pass
1394 1397
1395 1398 # We return either the new info or the unmodified input if the object
1396 1399 # hadn't been found
1397 1400 return info
1398 1401
1399 1402 def _object_find(self, oname, namespaces=None):
1400 1403 """Find an object and return a struct with info about it."""
1401 1404 inf = Struct(self._ofind(oname, namespaces))
1402 1405 return Struct(self._ofind_property(oname, inf))
1403 1406
1404 1407 def _inspect(self, meth, oname, namespaces=None, **kw):
1405 1408 """Generic interface to the inspector system.
1406 1409
1407 1410 This function is meant to be called by pdef, pdoc & friends."""
1408 1411 info = self._object_find(oname)
1409 1412 if info.found:
1410 1413 pmethod = getattr(self.inspector, meth)
1411 1414 formatter = format_screen if info.ismagic else None
1412 1415 if meth == 'pdoc':
1413 1416 pmethod(info.obj, oname, formatter)
1414 1417 elif meth == 'pinfo':
1415 1418 pmethod(info.obj, oname, formatter, info, **kw)
1416 1419 else:
1417 1420 pmethod(info.obj, oname)
1418 1421 else:
1419 1422 print 'Object `%s` not found.' % oname
1420 1423 return 'not found' # so callers can take other action
1421 1424
1422 1425 def object_inspect(self, oname):
1423 1426 with self.builtin_trap:
1424 1427 info = self._object_find(oname)
1425 1428 if info.found:
1426 1429 return self.inspector.info(info.obj, oname, info=info)
1427 1430 else:
1428 1431 return oinspect.object_info(name=oname, found=False)
1429 1432
1430 1433 #-------------------------------------------------------------------------
1431 1434 # Things related to history management
1432 1435 #-------------------------------------------------------------------------
1433 1436
1434 1437 def init_history(self):
1435 1438 """Sets up the command history, and starts regular autosaves."""
1436 1439 self.history_manager = HistoryManager(shell=self, config=self.config)
1437 1440 self.configurables.append(self.history_manager)
1438 1441
1439 1442 #-------------------------------------------------------------------------
1440 1443 # Things related to exception handling and tracebacks (not debugging)
1441 1444 #-------------------------------------------------------------------------
1442 1445
1443 1446 def init_traceback_handlers(self, custom_exceptions):
1444 1447 # Syntax error handler.
1445 1448 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1446 1449
1447 1450 # The interactive one is initialized with an offset, meaning we always
1448 1451 # want to remove the topmost item in the traceback, which is our own
1449 1452 # internal code. Valid modes: ['Plain','Context','Verbose']
1450 1453 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1451 1454 color_scheme='NoColor',
1452 1455 tb_offset = 1,
1453 1456 check_cache=self.compile.check_cache)
1454 1457
1455 1458 # The instance will store a pointer to the system-wide exception hook,
1456 1459 # so that runtime code (such as magics) can access it. This is because
1457 1460 # during the read-eval loop, it may get temporarily overwritten.
1458 1461 self.sys_excepthook = sys.excepthook
1459 1462
1460 1463 # and add any custom exception handlers the user may have specified
1461 1464 self.set_custom_exc(*custom_exceptions)
1462 1465
1463 1466 # Set the exception mode
1464 1467 self.InteractiveTB.set_mode(mode=self.xmode)
1465 1468
1466 1469 def set_custom_exc(self, exc_tuple, handler):
1467 1470 """set_custom_exc(exc_tuple,handler)
1468 1471
1469 1472 Set a custom exception handler, which will be called if any of the
1470 1473 exceptions in exc_tuple occur in the mainloop (specifically, in the
1471 1474 run_code() method).
1472 1475
1473 1476 Parameters
1474 1477 ----------
1475 1478
1476 1479 exc_tuple : tuple of exception classes
1477 1480 A *tuple* of exception classes, for which to call the defined
1478 1481 handler. It is very important that you use a tuple, and NOT A
1479 1482 LIST here, because of the way Python's except statement works. If
1480 1483 you only want to trap a single exception, use a singleton tuple::
1481 1484
1482 1485 exc_tuple == (MyCustomException,)
1483 1486
1484 1487 handler : callable
1485 1488 handler must have the following signature::
1486 1489
1487 1490 def my_handler(self, etype, value, tb, tb_offset=None):
1488 1491 ...
1489 1492 return structured_traceback
1490 1493
1491 1494 Your handler must return a structured traceback (a list of strings),
1492 1495 or None.
1493 1496
1494 1497 This will be made into an instance method (via types.MethodType)
1495 1498 of IPython itself, and it will be called if any of the exceptions
1496 1499 listed in the exc_tuple are caught. If the handler is None, an
1497 1500 internal basic one is used, which just prints basic info.
1498 1501
1499 1502 To protect IPython from crashes, if your handler ever raises an
1500 1503 exception or returns an invalid result, it will be immediately
1501 1504 disabled.
1502 1505
1503 1506 WARNING: by putting in your own exception handler into IPython's main
1504 1507 execution loop, you run a very good chance of nasty crashes. This
1505 1508 facility should only be used if you really know what you are doing."""
1506 1509
1507 1510 assert type(exc_tuple)==type(()) , \
1508 1511 "The custom exceptions must be given AS A TUPLE."
1509 1512
1510 1513 def dummy_handler(self,etype,value,tb,tb_offset=None):
1511 1514 print '*** Simple custom exception handler ***'
1512 1515 print 'Exception type :',etype
1513 1516 print 'Exception value:',value
1514 1517 print 'Traceback :',tb
1515 1518 #print 'Source code :','\n'.join(self.buffer)
1516 1519
1517 1520 def validate_stb(stb):
1518 1521 """validate structured traceback return type
1519 1522
1520 1523 return type of CustomTB *should* be a list of strings, but allow
1521 1524 single strings or None, which are harmless.
1522 1525
1523 1526 This function will *always* return a list of strings,
1524 1527 and will raise a TypeError if stb is inappropriate.
1525 1528 """
1526 1529 msg = "CustomTB must return list of strings, not %r" % stb
1527 1530 if stb is None:
1528 1531 return []
1529 1532 elif isinstance(stb, basestring):
1530 1533 return [stb]
1531 1534 elif not isinstance(stb, list):
1532 1535 raise TypeError(msg)
1533 1536 # it's a list
1534 1537 for line in stb:
1535 1538 # check every element
1536 1539 if not isinstance(line, basestring):
1537 1540 raise TypeError(msg)
1538 1541 return stb
1539 1542
1540 1543 if handler is None:
1541 1544 wrapped = dummy_handler
1542 1545 else:
1543 1546 def wrapped(self,etype,value,tb,tb_offset=None):
1544 1547 """wrap CustomTB handler, to protect IPython from user code
1545 1548
1546 1549 This makes it harder (but not impossible) for custom exception
1547 1550 handlers to crash IPython.
1548 1551 """
1549 1552 try:
1550 1553 stb = handler(self,etype,value,tb,tb_offset=tb_offset)
1551 1554 return validate_stb(stb)
1552 1555 except:
1553 1556 # clear custom handler immediately
1554 1557 self.set_custom_exc((), None)
1555 1558 print >> io.stderr, "Custom TB Handler failed, unregistering"
1556 1559 # show the exception in handler first
1557 1560 stb = self.InteractiveTB.structured_traceback(*sys.exc_info())
1558 1561 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1559 1562 print >> io.stdout, "The original exception:"
1560 1563 stb = self.InteractiveTB.structured_traceback(
1561 1564 (etype,value,tb), tb_offset=tb_offset
1562 1565 )
1563 1566 return stb
1564 1567
1565 1568 self.CustomTB = types.MethodType(wrapped,self)
1566 1569 self.custom_exceptions = exc_tuple
1567 1570
1568 1571 def excepthook(self, etype, value, tb):
1569 1572 """One more defense for GUI apps that call sys.excepthook.
1570 1573
1571 1574 GUI frameworks like wxPython trap exceptions and call
1572 1575 sys.excepthook themselves. I guess this is a feature that
1573 1576 enables them to keep running after exceptions that would
1574 1577 otherwise kill their mainloop. This is a bother for IPython
1575 1578 which excepts to catch all of the program exceptions with a try:
1576 1579 except: statement.
1577 1580
1578 1581 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1579 1582 any app directly invokes sys.excepthook, it will look to the user like
1580 1583 IPython crashed. In order to work around this, we can disable the
1581 1584 CrashHandler and replace it with this excepthook instead, which prints a
1582 1585 regular traceback using our InteractiveTB. In this fashion, apps which
1583 1586 call sys.excepthook will generate a regular-looking exception from
1584 1587 IPython, and the CrashHandler will only be triggered by real IPython
1585 1588 crashes.
1586 1589
1587 1590 This hook should be used sparingly, only in places which are not likely
1588 1591 to be true IPython errors.
1589 1592 """
1590 1593 self.showtraceback((etype,value,tb),tb_offset=0)
1591 1594
1592 1595 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1593 1596 exception_only=False):
1594 1597 """Display the exception that just occurred.
1595 1598
1596 1599 If nothing is known about the exception, this is the method which
1597 1600 should be used throughout the code for presenting user tracebacks,
1598 1601 rather than directly invoking the InteractiveTB object.
1599 1602
1600 1603 A specific showsyntaxerror() also exists, but this method can take
1601 1604 care of calling it if needed, so unless you are explicitly catching a
1602 1605 SyntaxError exception, don't try to analyze the stack manually and
1603 1606 simply call this method."""
1604 1607
1605 1608 try:
1606 1609 if exc_tuple is None:
1607 1610 etype, value, tb = sys.exc_info()
1608 1611 else:
1609 1612 etype, value, tb = exc_tuple
1610 1613
1611 1614 if etype is None:
1612 1615 if hasattr(sys, 'last_type'):
1613 1616 etype, value, tb = sys.last_type, sys.last_value, \
1614 1617 sys.last_traceback
1615 1618 else:
1616 1619 self.write_err('No traceback available to show.\n')
1617 1620 return
1618 1621
1619 1622 if etype is SyntaxError:
1620 1623 # Though this won't be called by syntax errors in the input
1621 1624 # line, there may be SyntaxError cases with imported code.
1622 1625 self.showsyntaxerror(filename)
1623 1626 elif etype is UsageError:
1624 1627 self.write_err("UsageError: %s" % value)
1625 1628 else:
1626 1629 # WARNING: these variables are somewhat deprecated and not
1627 1630 # necessarily safe to use in a threaded environment, but tools
1628 1631 # like pdb depend on their existence, so let's set them. If we
1629 1632 # find problems in the field, we'll need to revisit their use.
1630 1633 sys.last_type = etype
1631 1634 sys.last_value = value
1632 1635 sys.last_traceback = tb
1633 1636 if etype in self.custom_exceptions:
1634 1637 stb = self.CustomTB(etype, value, tb, tb_offset)
1635 1638 else:
1636 1639 if exception_only:
1637 1640 stb = ['An exception has occurred, use %tb to see '
1638 1641 'the full traceback.\n']
1639 1642 stb.extend(self.InteractiveTB.get_exception_only(etype,
1640 1643 value))
1641 1644 else:
1642 1645 stb = self.InteractiveTB.structured_traceback(etype,
1643 1646 value, tb, tb_offset=tb_offset)
1644 1647
1645 1648 self._showtraceback(etype, value, stb)
1646 1649 if self.call_pdb:
1647 1650 # drop into debugger
1648 1651 self.debugger(force=True)
1649 1652 return
1650 1653
1651 1654 # Actually show the traceback
1652 1655 self._showtraceback(etype, value, stb)
1653 1656
1654 1657 except KeyboardInterrupt:
1655 1658 self.write_err("\nKeyboardInterrupt\n")
1656 1659
1657 1660 def _showtraceback(self, etype, evalue, stb):
1658 1661 """Actually show a traceback.
1659 1662
1660 1663 Subclasses may override this method to put the traceback on a different
1661 1664 place, like a side channel.
1662 1665 """
1663 1666 print >> io.stdout, self.InteractiveTB.stb2text(stb)
1664 1667
1665 1668 def showsyntaxerror(self, filename=None):
1666 1669 """Display the syntax error that just occurred.
1667 1670
1668 1671 This doesn't display a stack trace because there isn't one.
1669 1672
1670 1673 If a filename is given, it is stuffed in the exception instead
1671 1674 of what was there before (because Python's parser always uses
1672 1675 "<string>" when reading from a string).
1673 1676 """
1674 1677 etype, value, last_traceback = sys.exc_info()
1675 1678
1676 1679 # See note about these variables in showtraceback() above
1677 1680 sys.last_type = etype
1678 1681 sys.last_value = value
1679 1682 sys.last_traceback = last_traceback
1680 1683
1681 1684 if filename and etype is SyntaxError:
1682 1685 # Work hard to stuff the correct filename in the exception
1683 1686 try:
1684 1687 msg, (dummy_filename, lineno, offset, line) = value
1685 1688 except:
1686 1689 # Not the format we expect; leave it alone
1687 1690 pass
1688 1691 else:
1689 1692 # Stuff in the right filename
1690 1693 try:
1691 1694 # Assume SyntaxError is a class exception
1692 1695 value = SyntaxError(msg, (filename, lineno, offset, line))
1693 1696 except:
1694 1697 # If that failed, assume SyntaxError is a string
1695 1698 value = msg, (filename, lineno, offset, line)
1696 1699 stb = self.SyntaxTB.structured_traceback(etype, value, [])
1697 1700 self._showtraceback(etype, value, stb)
1698 1701
1699 1702 # This is overridden in TerminalInteractiveShell to show a message about
1700 1703 # the %paste magic.
1701 1704 def showindentationerror(self):
1702 1705 """Called by run_cell when there's an IndentationError in code entered
1703 1706 at the prompt.
1704 1707
1705 1708 This is overridden in TerminalInteractiveShell to show a message about
1706 1709 the %paste magic."""
1707 1710 self.showsyntaxerror()
1708 1711
1709 1712 #-------------------------------------------------------------------------
1710 1713 # Things related to readline
1711 1714 #-------------------------------------------------------------------------
1712 1715
1713 1716 def init_readline(self):
1714 1717 """Command history completion/saving/reloading."""
1715 1718
1716 1719 if self.readline_use:
1717 1720 import IPython.utils.rlineimpl as readline
1718 1721
1719 1722 self.rl_next_input = None
1720 1723 self.rl_do_indent = False
1721 1724
1722 1725 if not self.readline_use or not readline.have_readline:
1723 1726 self.has_readline = False
1724 1727 self.readline = None
1725 1728 # Set a number of methods that depend on readline to be no-op
1726 1729 self.readline_no_record = no_op_context
1727 1730 self.set_readline_completer = no_op
1728 1731 self.set_custom_completer = no_op
1729 1732 self.set_completer_frame = no_op
1730 1733 if self.readline_use:
1731 1734 warn('Readline services not available or not loaded.')
1732 1735 else:
1733 1736 self.has_readline = True
1734 1737 self.readline = readline
1735 1738 sys.modules['readline'] = readline
1736 1739
1737 1740 # Platform-specific configuration
1738 1741 if os.name == 'nt':
1739 1742 # FIXME - check with Frederick to see if we can harmonize
1740 1743 # naming conventions with pyreadline to avoid this
1741 1744 # platform-dependent check
1742 1745 self.readline_startup_hook = readline.set_pre_input_hook
1743 1746 else:
1744 1747 self.readline_startup_hook = readline.set_startup_hook
1745 1748
1746 1749 # Load user's initrc file (readline config)
1747 1750 # Or if libedit is used, load editrc.
1748 1751 inputrc_name = os.environ.get('INPUTRC')
1749 1752 if inputrc_name is None:
1750 1753 inputrc_name = '.inputrc'
1751 1754 if readline.uses_libedit:
1752 1755 inputrc_name = '.editrc'
1753 1756 inputrc_name = os.path.join(self.home_dir, inputrc_name)
1754 1757 if os.path.isfile(inputrc_name):
1755 1758 try:
1756 1759 readline.read_init_file(inputrc_name)
1757 1760 except:
1758 1761 warn('Problems reading readline initialization file <%s>'
1759 1762 % inputrc_name)
1760 1763
1761 1764 # Configure readline according to user's prefs
1762 1765 # This is only done if GNU readline is being used. If libedit
1763 1766 # is being used (as on Leopard) the readline config is
1764 1767 # not run as the syntax for libedit is different.
1765 1768 if not readline.uses_libedit:
1766 1769 for rlcommand in self.readline_parse_and_bind:
1767 1770 #print "loading rl:",rlcommand # dbg
1768 1771 readline.parse_and_bind(rlcommand)
1769 1772
1770 1773 # Remove some chars from the delimiters list. If we encounter
1771 1774 # unicode chars, discard them.
1772 1775 delims = readline.get_completer_delims()
1773 1776 if not py3compat.PY3:
1774 1777 delims = delims.encode("ascii", "ignore")
1775 1778 for d in self.readline_remove_delims:
1776 1779 delims = delims.replace(d, "")
1777 1780 delims = delims.replace(ESC_MAGIC, '')
1778 1781 readline.set_completer_delims(delims)
1779 1782 # otherwise we end up with a monster history after a while:
1780 1783 readline.set_history_length(self.history_length)
1781 1784
1782 1785 self.refill_readline_hist()
1783 1786 self.readline_no_record = ReadlineNoRecord(self)
1784 1787
1785 1788 # Configure auto-indent for all platforms
1786 1789 self.set_autoindent(self.autoindent)
1787 1790
1788 1791 def refill_readline_hist(self):
1789 1792 # Load the last 1000 lines from history
1790 1793 self.readline.clear_history()
1791 1794 stdin_encoding = sys.stdin.encoding or "utf-8"
1792 1795 last_cell = u""
1793 1796 for _, _, cell in self.history_manager.get_tail(1000,
1794 1797 include_latest=True):
1795 1798 # Ignore blank lines and consecutive duplicates
1796 1799 cell = cell.rstrip()
1797 1800 if cell and (cell != last_cell):
1798 1801 if self.multiline_history:
1799 1802 self.readline.add_history(py3compat.unicode_to_str(cell,
1800 1803 stdin_encoding))
1801 1804 else:
1802 1805 for line in cell.splitlines():
1803 1806 self.readline.add_history(py3compat.unicode_to_str(line,
1804 1807 stdin_encoding))
1805 1808 last_cell = cell
1806 1809
1807 1810 def set_next_input(self, s):
1808 1811 """ Sets the 'default' input string for the next command line.
1809 1812
1810 1813 Requires readline.
1811 1814
1812 1815 Example:
1813 1816
1814 1817 [D:\ipython]|1> _ip.set_next_input("Hello Word")
1815 1818 [D:\ipython]|2> Hello Word_ # cursor is here
1816 1819 """
1817 1820 self.rl_next_input = py3compat.cast_bytes_py2(s)
1818 1821
1819 1822 # Maybe move this to the terminal subclass?
1820 1823 def pre_readline(self):
1821 1824 """readline hook to be used at the start of each line.
1822 1825
1823 1826 Currently it handles auto-indent only."""
1824 1827
1825 1828 if self.rl_do_indent:
1826 1829 self.readline.insert_text(self._indent_current_str())
1827 1830 if self.rl_next_input is not None:
1828 1831 self.readline.insert_text(self.rl_next_input)
1829 1832 self.rl_next_input = None
1830 1833
1831 1834 def _indent_current_str(self):
1832 1835 """return the current level of indentation as a string"""
1833 1836 return self.input_splitter.indent_spaces * ' '
1834 1837
1835 1838 #-------------------------------------------------------------------------
1836 1839 # Things related to text completion
1837 1840 #-------------------------------------------------------------------------
1838 1841
1839 1842 def init_completer(self):
1840 1843 """Initialize the completion machinery.
1841 1844
1842 1845 This creates completion machinery that can be used by client code,
1843 1846 either interactively in-process (typically triggered by the readline
1844 1847 library), programatically (such as in test suites) or out-of-prcess
1845 1848 (typically over the network by remote frontends).
1846 1849 """
1847 1850 from IPython.core.completer import IPCompleter
1848 1851 from IPython.core.completerlib import (module_completer,
1849 1852 magic_run_completer, cd_completer)
1850 1853
1851 1854 self.Completer = IPCompleter(shell=self,
1852 1855 namespace=self.user_ns,
1853 1856 global_namespace=self.user_global_ns,
1854 1857 alias_table=self.alias_manager.alias_table,
1855 1858 use_readline=self.has_readline,
1856 1859 config=self.config,
1857 1860 )
1858 1861 self.configurables.append(self.Completer)
1859 1862
1860 1863 # Add custom completers to the basic ones built into IPCompleter
1861 1864 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1862 1865 self.strdispatchers['complete_command'] = sdisp
1863 1866 self.Completer.custom_completers = sdisp
1864 1867
1865 1868 self.set_hook('complete_command', module_completer, str_key = 'import')
1866 1869 self.set_hook('complete_command', module_completer, str_key = 'from')
1867 1870 self.set_hook('complete_command', magic_run_completer, str_key = '%run')
1868 1871 self.set_hook('complete_command', cd_completer, str_key = '%cd')
1869 1872
1870 1873 # Only configure readline if we truly are using readline. IPython can
1871 1874 # do tab-completion over the network, in GUIs, etc, where readline
1872 1875 # itself may be absent
1873 1876 if self.has_readline:
1874 1877 self.set_readline_completer()
1875 1878
1876 1879 def complete(self, text, line=None, cursor_pos=None):
1877 1880 """Return the completed text and a list of completions.
1878 1881
1879 1882 Parameters
1880 1883 ----------
1881 1884
1882 1885 text : string
1883 1886 A string of text to be completed on. It can be given as empty and
1884 1887 instead a line/position pair are given. In this case, the
1885 1888 completer itself will split the line like readline does.
1886 1889
1887 1890 line : string, optional
1888 1891 The complete line that text is part of.
1889 1892
1890 1893 cursor_pos : int, optional
1891 1894 The position of the cursor on the input line.
1892 1895
1893 1896 Returns
1894 1897 -------
1895 1898 text : string
1896 1899 The actual text that was completed.
1897 1900
1898 1901 matches : list
1899 1902 A sorted list with all possible completions.
1900 1903
1901 1904 The optional arguments allow the completion to take more context into
1902 1905 account, and are part of the low-level completion API.
1903 1906
1904 1907 This is a wrapper around the completion mechanism, similar to what
1905 1908 readline does at the command line when the TAB key is hit. By
1906 1909 exposing it as a method, it can be used by other non-readline
1907 1910 environments (such as GUIs) for text completion.
1908 1911
1909 1912 Simple usage example:
1910 1913
1911 1914 In [1]: x = 'hello'
1912 1915
1913 1916 In [2]: _ip.complete('x.l')
1914 1917 Out[2]: ('x.l', ['x.ljust', 'x.lower', 'x.lstrip'])
1915 1918 """
1916 1919
1917 1920 # Inject names into __builtin__ so we can complete on the added names.
1918 1921 with self.builtin_trap:
1919 1922 return self.Completer.complete(text, line, cursor_pos)
1920 1923
1921 1924 def set_custom_completer(self, completer, pos=0):
1922 1925 """Adds a new custom completer function.
1923 1926
1924 1927 The position argument (defaults to 0) is the index in the completers
1925 1928 list where you want the completer to be inserted."""
1926 1929
1927 1930 newcomp = types.MethodType(completer,self.Completer)
1928 1931 self.Completer.matchers.insert(pos,newcomp)
1929 1932
1930 1933 def set_readline_completer(self):
1931 1934 """Reset readline's completer to be our own."""
1932 1935 self.readline.set_completer(self.Completer.rlcomplete)
1933 1936
1934 1937 def set_completer_frame(self, frame=None):
1935 1938 """Set the frame of the completer."""
1936 1939 if frame:
1937 1940 self.Completer.namespace = frame.f_locals
1938 1941 self.Completer.global_namespace = frame.f_globals
1939 1942 else:
1940 1943 self.Completer.namespace = self.user_ns
1941 1944 self.Completer.global_namespace = self.user_global_ns
1942 1945
1943 1946 #-------------------------------------------------------------------------
1944 1947 # Things related to magics
1945 1948 #-------------------------------------------------------------------------
1946 1949
1947 1950 def init_magics(self):
1948 1951 # FIXME: Move the color initialization to the DisplayHook, which
1949 1952 # should be split into a prompt manager and displayhook. We probably
1950 1953 # even need a centralize colors management object.
1951 1954 self.magic_colors(self.colors)
1952 1955 # History was moved to a separate module
1953 1956 from . import history
1954 1957 history.init_ipython(self)
1955 1958
1956 1959 def magic(self, arg_s, next_input=None):
1957 1960 """Call a magic function by name.
1958 1961
1959 1962 Input: a string containing the name of the magic function to call and
1960 1963 any additional arguments to be passed to the magic.
1961 1964
1962 1965 magic('name -opt foo bar') is equivalent to typing at the ipython
1963 1966 prompt:
1964 1967
1965 1968 In[1]: %name -opt foo bar
1966 1969
1967 1970 To call a magic without arguments, simply use magic('name').
1968 1971
1969 1972 This provides a proper Python function to call IPython's magics in any
1970 1973 valid Python code you can type at the interpreter, including loops and
1971 1974 compound statements.
1972 1975 """
1973 1976 # Allow setting the next input - this is used if the user does `a=abs?`.
1974 1977 # We do this first so that magic functions can override it.
1975 1978 if next_input:
1976 1979 self.set_next_input(next_input)
1977 1980
1978 1981 args = arg_s.split(' ',1)
1979 1982 magic_name = args[0]
1980 1983 magic_name = magic_name.lstrip(prefilter.ESC_MAGIC)
1981 1984
1982 1985 try:
1983 1986 magic_args = args[1]
1984 1987 except IndexError:
1985 1988 magic_args = ''
1986 1989 fn = getattr(self,'magic_'+magic_name,None)
1987 1990 if fn is None:
1988 1991 error("Magic function `%s` not found." % magic_name)
1989 1992 else:
1990 1993 magic_args = self.var_expand(magic_args,1)
1991 1994 # Grab local namespace if we need it:
1992 1995 if getattr(fn, "needs_local_scope", False):
1993 1996 self._magic_locals = sys._getframe(1).f_locals
1994 1997 with self.builtin_trap:
1995 1998 result = fn(magic_args)
1996 1999 # Ensure we're not keeping object references around:
1997 2000 self._magic_locals = {}
1998 2001 return result
1999 2002
2000 2003 def define_magic(self, magicname, func):
2001 2004 """Expose own function as magic function for ipython
2002 2005
2003 2006 Example::
2004 2007
2005 2008 def foo_impl(self,parameter_s=''):
2006 2009 'My very own magic!. (Use docstrings, IPython reads them).'
2007 2010 print 'Magic function. Passed parameter is between < >:'
2008 2011 print '<%s>' % parameter_s
2009 2012 print 'The self object is:', self
2010 2013
2011 2014 ip.define_magic('foo',foo_impl)
2012 2015 """
2013 2016 im = types.MethodType(func,self)
2014 2017 old = getattr(self, "magic_" + magicname, None)
2015 2018 setattr(self, "magic_" + magicname, im)
2016 2019 return old
2017 2020
2018 2021 #-------------------------------------------------------------------------
2019 2022 # Things related to macros
2020 2023 #-------------------------------------------------------------------------
2021 2024
2022 2025 def define_macro(self, name, themacro):
2023 2026 """Define a new macro
2024 2027
2025 2028 Parameters
2026 2029 ----------
2027 2030 name : str
2028 2031 The name of the macro.
2029 2032 themacro : str or Macro
2030 2033 The action to do upon invoking the macro. If a string, a new
2031 2034 Macro object is created by passing the string to it.
2032 2035 """
2033 2036
2034 2037 from IPython.core import macro
2035 2038
2036 2039 if isinstance(themacro, basestring):
2037 2040 themacro = macro.Macro(themacro)
2038 2041 if not isinstance(themacro, macro.Macro):
2039 2042 raise ValueError('A macro must be a string or a Macro instance.')
2040 2043 self.user_ns[name] = themacro
2041 2044
2042 2045 #-------------------------------------------------------------------------
2043 2046 # Things related to the running of system commands
2044 2047 #-------------------------------------------------------------------------
2045 2048
2046 2049 def system_piped(self, cmd):
2047 2050 """Call the given cmd in a subprocess, piping stdout/err
2048 2051
2049 2052 Parameters
2050 2053 ----------
2051 2054 cmd : str
2052 2055 Command to execute (can not end in '&', as background processes are
2053 2056 not supported. Should not be a command that expects input
2054 2057 other than simple text.
2055 2058 """
2056 2059 if cmd.rstrip().endswith('&'):
2057 2060 # this is *far* from a rigorous test
2058 2061 # We do not support backgrounding processes because we either use
2059 2062 # pexpect or pipes to read from. Users can always just call
2060 2063 # os.system() or use ip.system=ip.system_raw
2061 2064 # if they really want a background process.
2062 2065 raise OSError("Background processes not supported.")
2063 2066
2064 2067 # we explicitly do NOT return the subprocess status code, because
2065 2068 # a non-None value would trigger :func:`sys.displayhook` calls.
2066 2069 # Instead, we store the exit_code in user_ns.
2067 2070 self.user_ns['_exit_code'] = system(self.var_expand(cmd, depth=2))
2068 2071
2069 2072 def system_raw(self, cmd):
2070 2073 """Call the given cmd in a subprocess using os.system
2071 2074
2072 2075 Parameters
2073 2076 ----------
2074 2077 cmd : str
2075 2078 Command to execute.
2076 2079 """
2077 2080 cmd = self.var_expand(cmd, depth=2)
2078 2081 # protect os.system from UNC paths on Windows, which it can't handle:
2079 2082 if sys.platform == 'win32':
2080 2083 from IPython.utils._process_win32 import AvoidUNCPath
2081 2084 with AvoidUNCPath() as path:
2082 2085 if path is not None:
2083 2086 cmd = '"pushd %s &&"%s' % (path, cmd)
2084 2087 cmd = py3compat.unicode_to_str(cmd)
2085 2088 ec = os.system(cmd)
2086 2089 else:
2087 2090 cmd = py3compat.unicode_to_str(cmd)
2088 2091 ec = os.system(cmd)
2089 2092
2090 2093 # We explicitly do NOT return the subprocess status code, because
2091 2094 # a non-None value would trigger :func:`sys.displayhook` calls.
2092 2095 # Instead, we store the exit_code in user_ns.
2093 2096 self.user_ns['_exit_code'] = ec
2094 2097
2095 2098 # use piped system by default, because it is better behaved
2096 2099 system = system_piped
2097 2100
2098 2101 def getoutput(self, cmd, split=True):
2099 2102 """Get output (possibly including stderr) from a subprocess.
2100 2103
2101 2104 Parameters
2102 2105 ----------
2103 2106 cmd : str
2104 2107 Command to execute (can not end in '&', as background processes are
2105 2108 not supported.
2106 2109 split : bool, optional
2107 2110
2108 2111 If True, split the output into an IPython SList. Otherwise, an
2109 2112 IPython LSString is returned. These are objects similar to normal
2110 2113 lists and strings, with a few convenience attributes for easier
2111 2114 manipulation of line-based output. You can use '?' on them for
2112 2115 details.
2113 2116 """
2114 2117 if cmd.rstrip().endswith('&'):
2115 2118 # this is *far* from a rigorous test
2116 2119 raise OSError("Background processes not supported.")
2117 2120 out = getoutput(self.var_expand(cmd, depth=2))
2118 2121 if split:
2119 2122 out = SList(out.splitlines())
2120 2123 else:
2121 2124 out = LSString(out)
2122 2125 return out
2123 2126
2124 2127 #-------------------------------------------------------------------------
2125 2128 # Things related to aliases
2126 2129 #-------------------------------------------------------------------------
2127 2130
2128 2131 def init_alias(self):
2129 2132 self.alias_manager = AliasManager(shell=self, config=self.config)
2130 2133 self.configurables.append(self.alias_manager)
2131 2134 self.ns_table['alias'] = self.alias_manager.alias_table,
2132 2135
2133 2136 #-------------------------------------------------------------------------
2134 2137 # Things related to extensions and plugins
2135 2138 #-------------------------------------------------------------------------
2136 2139
2137 2140 def init_extension_manager(self):
2138 2141 self.extension_manager = ExtensionManager(shell=self, config=self.config)
2139 2142 self.configurables.append(self.extension_manager)
2140 2143
2141 2144 def init_plugin_manager(self):
2142 2145 self.plugin_manager = PluginManager(config=self.config)
2143 2146 self.configurables.append(self.plugin_manager)
2144 2147
2145 2148
2146 2149 #-------------------------------------------------------------------------
2147 2150 # Things related to payloads
2148 2151 #-------------------------------------------------------------------------
2149 2152
2150 2153 def init_payload(self):
2151 2154 self.payload_manager = PayloadManager(config=self.config)
2152 2155 self.configurables.append(self.payload_manager)
2153 2156
2154 2157 #-------------------------------------------------------------------------
2155 2158 # Things related to the prefilter
2156 2159 #-------------------------------------------------------------------------
2157 2160
2158 2161 def init_prefilter(self):
2159 2162 self.prefilter_manager = PrefilterManager(shell=self, config=self.config)
2160 2163 self.configurables.append(self.prefilter_manager)
2161 2164 # Ultimately this will be refactored in the new interpreter code, but
2162 2165 # for now, we should expose the main prefilter method (there's legacy
2163 2166 # code out there that may rely on this).
2164 2167 self.prefilter = self.prefilter_manager.prefilter_lines
2165 2168
2166 2169 def auto_rewrite_input(self, cmd):
2167 2170 """Print to the screen the rewritten form of the user's command.
2168 2171
2169 2172 This shows visual feedback by rewriting input lines that cause
2170 2173 automatic calling to kick in, like::
2171 2174
2172 2175 /f x
2173 2176
2174 2177 into::
2175 2178
2176 2179 ------> f(x)
2177 2180
2178 2181 after the user's input prompt. This helps the user understand that the
2179 2182 input line was transformed automatically by IPython.
2180 2183 """
2181 2184 if not self.show_rewritten_input:
2182 2185 return
2183 2186
2184 2187 rw = self.prompt_manager.render('rewrite') + cmd
2185 2188
2186 2189 try:
2187 2190 # plain ascii works better w/ pyreadline, on some machines, so
2188 2191 # we use it and only print uncolored rewrite if we have unicode
2189 2192 rw = str(rw)
2190 2193 print >> io.stdout, rw
2191 2194 except UnicodeEncodeError:
2192 2195 print "------> " + cmd
2193 2196
2194 2197 #-------------------------------------------------------------------------
2195 2198 # Things related to extracting values/expressions from kernel and user_ns
2196 2199 #-------------------------------------------------------------------------
2197 2200
2198 2201 def _simple_error(self):
2199 2202 etype, value = sys.exc_info()[:2]
2200 2203 return u'[ERROR] {e.__name__}: {v}'.format(e=etype, v=value)
2201 2204
2202 2205 def user_variables(self, names):
2203 2206 """Get a list of variable names from the user's namespace.
2204 2207
2205 2208 Parameters
2206 2209 ----------
2207 2210 names : list of strings
2208 2211 A list of names of variables to be read from the user namespace.
2209 2212
2210 2213 Returns
2211 2214 -------
2212 2215 A dict, keyed by the input names and with the repr() of each value.
2213 2216 """
2214 2217 out = {}
2215 2218 user_ns = self.user_ns
2216 2219 for varname in names:
2217 2220 try:
2218 2221 value = repr(user_ns[varname])
2219 2222 except:
2220 2223 value = self._simple_error()
2221 2224 out[varname] = value
2222 2225 return out
2223 2226
2224 2227 def user_expressions(self, expressions):
2225 2228 """Evaluate a dict of expressions in the user's namespace.
2226 2229
2227 2230 Parameters
2228 2231 ----------
2229 2232 expressions : dict
2230 2233 A dict with string keys and string values. The expression values
2231 2234 should be valid Python expressions, each of which will be evaluated
2232 2235 in the user namespace.
2233 2236
2234 2237 Returns
2235 2238 -------
2236 2239 A dict, keyed like the input expressions dict, with the repr() of each
2237 2240 value.
2238 2241 """
2239 2242 out = {}
2240 2243 user_ns = self.user_ns
2241 2244 global_ns = self.user_global_ns
2242 2245 for key, expr in expressions.iteritems():
2243 2246 try:
2244 2247 value = repr(eval(expr, global_ns, user_ns))
2245 2248 except:
2246 2249 value = self._simple_error()
2247 2250 out[key] = value
2248 2251 return out
2249 2252
2250 2253 #-------------------------------------------------------------------------
2251 2254 # Things related to the running of code
2252 2255 #-------------------------------------------------------------------------
2253 2256
2254 2257 def ex(self, cmd):
2255 2258 """Execute a normal python statement in user namespace."""
2256 2259 with self.builtin_trap:
2257 2260 exec cmd in self.user_global_ns, self.user_ns
2258 2261
2259 2262 def ev(self, expr):
2260 2263 """Evaluate python expression expr in user namespace.
2261 2264
2262 2265 Returns the result of evaluation
2263 2266 """
2264 2267 with self.builtin_trap:
2265 2268 return eval(expr, self.user_global_ns, self.user_ns)
2266 2269
2267 2270 def safe_execfile(self, fname, *where, **kw):
2268 2271 """A safe version of the builtin execfile().
2269 2272
2270 2273 This version will never throw an exception, but instead print
2271 2274 helpful error messages to the screen. This only works on pure
2272 2275 Python files with the .py extension.
2273 2276
2274 2277 Parameters
2275 2278 ----------
2276 2279 fname : string
2277 2280 The name of the file to be executed.
2278 2281 where : tuple
2279 2282 One or two namespaces, passed to execfile() as (globals,locals).
2280 2283 If only one is given, it is passed as both.
2281 2284 exit_ignore : bool (False)
2282 2285 If True, then silence SystemExit for non-zero status (it is always
2283 2286 silenced for zero status, as it is so common).
2284 2287 raise_exceptions : bool (False)
2285 2288 If True raise exceptions everywhere. Meant for testing.
2286 2289
2287 2290 """
2288 2291 kw.setdefault('exit_ignore', False)
2289 2292 kw.setdefault('raise_exceptions', False)
2290 2293
2291 2294 fname = os.path.abspath(os.path.expanduser(fname))
2292 2295
2293 2296 # Make sure we can open the file
2294 2297 try:
2295 2298 with open(fname) as thefile:
2296 2299 pass
2297 2300 except:
2298 2301 warn('Could not open file <%s> for safe execution.' % fname)
2299 2302 return
2300 2303
2301 2304 # Find things also in current directory. This is needed to mimic the
2302 2305 # behavior of running a script from the system command line, where
2303 2306 # Python inserts the script's directory into sys.path
2304 2307 dname = os.path.dirname(fname)
2305 2308
2306 2309 with prepended_to_syspath(dname):
2307 2310 try:
2308 2311 py3compat.execfile(fname,*where)
2309 2312 except SystemExit, status:
2310 2313 # If the call was made with 0 or None exit status (sys.exit(0)
2311 2314 # or sys.exit() ), don't bother showing a traceback, as both of
2312 2315 # these are considered normal by the OS:
2313 2316 # > python -c'import sys;sys.exit(0)'; echo $?
2314 2317 # 0
2315 2318 # > python -c'import sys;sys.exit()'; echo $?
2316 2319 # 0
2317 2320 # For other exit status, we show the exception unless
2318 2321 # explicitly silenced, but only in short form.
2319 2322 if kw['raise_exceptions']:
2320 2323 raise
2321 2324 if status.code not in (0, None) and not kw['exit_ignore']:
2322 2325 self.showtraceback(exception_only=True)
2323 2326 except:
2324 2327 if kw['raise_exceptions']:
2325 2328 raise
2326 2329 self.showtraceback()
2327 2330
2328 2331 def safe_execfile_ipy(self, fname):
2329 2332 """Like safe_execfile, but for .ipy files with IPython syntax.
2330 2333
2331 2334 Parameters
2332 2335 ----------
2333 2336 fname : str
2334 2337 The name of the file to execute. The filename must have a
2335 2338 .ipy extension.
2336 2339 """
2337 2340 fname = os.path.abspath(os.path.expanduser(fname))
2338 2341
2339 2342 # Make sure we can open the file
2340 2343 try:
2341 2344 with open(fname) as thefile:
2342 2345 pass
2343 2346 except:
2344 2347 warn('Could not open file <%s> for safe execution.' % fname)
2345 2348 return
2346 2349
2347 2350 # Find things also in current directory. This is needed to mimic the
2348 2351 # behavior of running a script from the system command line, where
2349 2352 # Python inserts the script's directory into sys.path
2350 2353 dname = os.path.dirname(fname)
2351 2354
2352 2355 with prepended_to_syspath(dname):
2353 2356 try:
2354 2357 with open(fname) as thefile:
2355 2358 # self.run_cell currently captures all exceptions
2356 2359 # raised in user code. It would be nice if there were
2357 2360 # versions of runlines, execfile that did raise, so
2358 2361 # we could catch the errors.
2359 2362 self.run_cell(thefile.read(), store_history=False)
2360 2363 except:
2361 2364 self.showtraceback()
2362 2365 warn('Unknown failure executing file: <%s>' % fname)
2363 2366
2364 2367 def run_cell(self, raw_cell, store_history=False):
2365 2368 """Run a complete IPython cell.
2366 2369
2367 2370 Parameters
2368 2371 ----------
2369 2372 raw_cell : str
2370 2373 The code (including IPython code such as %magic functions) to run.
2371 2374 store_history : bool
2372 2375 If True, the raw and translated cell will be stored in IPython's
2373 2376 history. For user code calling back into IPython's machinery, this
2374 2377 should be set to False.
2375 2378 """
2376 2379 if (not raw_cell) or raw_cell.isspace():
2377 2380 return
2378 2381
2379 2382 for line in raw_cell.splitlines():
2380 2383 self.input_splitter.push(line)
2381 2384 cell = self.input_splitter.source_reset()
2382 2385
2383 2386 with self.builtin_trap:
2384 2387 prefilter_failed = False
2385 2388 if len(cell.splitlines()) == 1:
2386 2389 try:
2387 2390 # use prefilter_lines to handle trailing newlines
2388 2391 # restore trailing newline for ast.parse
2389 2392 cell = self.prefilter_manager.prefilter_lines(cell) + '\n'
2390 2393 except AliasError as e:
2391 2394 error(e)
2392 2395 prefilter_failed = True
2393 2396 except Exception:
2394 2397 # don't allow prefilter errors to crash IPython
2395 2398 self.showtraceback()
2396 2399 prefilter_failed = True
2397 2400
2398 2401 # Store raw and processed history
2399 2402 if store_history:
2400 2403 self.history_manager.store_inputs(self.execution_count,
2401 2404 cell, raw_cell)
2402 2405
2403 2406 self.logger.log(cell, raw_cell)
2404 2407
2405 2408 if not prefilter_failed:
2406 2409 # don't run if prefilter failed
2407 2410 cell_name = self.compile.cache(cell, self.execution_count)
2408 2411
2409 2412 with self.display_trap:
2410 2413 try:
2411 2414 code_ast = self.compile.ast_parse(cell, filename=cell_name)
2412 2415 except IndentationError:
2413 2416 self.showindentationerror()
2414 2417 if store_history:
2415 2418 self.execution_count += 1
2416 2419 return None
2417 2420 except (OverflowError, SyntaxError, ValueError, TypeError,
2418 2421 MemoryError):
2419 2422 self.showsyntaxerror()
2420 2423 if store_history:
2421 2424 self.execution_count += 1
2422 2425 return None
2423 2426
2424 2427 self.run_ast_nodes(code_ast.body, cell_name,
2425 2428 interactivity="last_expr")
2426 2429
2427 2430 # Execute any registered post-execution functions.
2428 2431 for func, status in self._post_execute.iteritems():
2429 if not status:
2432 if self.disable_failing_post_execute and not status:
2430 2433 continue
2431 2434 try:
2432 2435 func()
2433 2436 except KeyboardInterrupt:
2434 2437 print >> io.stderr, "\nKeyboardInterrupt"
2435 2438 except Exception:
2436 print >> io.stderr, "Disabling failed post-execution function: %s" % func
2437 self.showtraceback()
2438 # Deactivate failing function
2439 # register as failing:
2439 2440 self._post_execute[func] = False
2441 self.showtraceback()
2442 print >> io.stderr, '\n'.join([
2443 "post-execution function %r produced an error." % func,
2444 "If this problem persists, you can disable failing post-exec functions with:",
2445 "",
2446 " get_ipython().disable_failing_post_execute = True"
2447 ])
2440 2448
2441 2449 if store_history:
2442 2450 # Write output to the database. Does nothing unless
2443 2451 # history output logging is enabled.
2444 2452 self.history_manager.store_output(self.execution_count)
2445 2453 # Each cell is a *single* input, regardless of how many lines it has
2446 2454 self.execution_count += 1
2447 2455
2448 2456 def run_ast_nodes(self, nodelist, cell_name, interactivity='last_expr'):
2449 2457 """Run a sequence of AST nodes. The execution mode depends on the
2450 2458 interactivity parameter.
2451 2459
2452 2460 Parameters
2453 2461 ----------
2454 2462 nodelist : list
2455 2463 A sequence of AST nodes to run.
2456 2464 cell_name : str
2457 2465 Will be passed to the compiler as the filename of the cell. Typically
2458 2466 the value returned by ip.compile.cache(cell).
2459 2467 interactivity : str
2460 2468 'all', 'last', 'last_expr' or 'none', specifying which nodes should be
2461 2469 run interactively (displaying output from expressions). 'last_expr'
2462 2470 will run the last node interactively only if it is an expression (i.e.
2463 2471 expressions in loops or other blocks are not displayed. Other values
2464 2472 for this parameter will raise a ValueError.
2465 2473 """
2466 2474 if not nodelist:
2467 2475 return
2468 2476
2469 2477 if interactivity == 'last_expr':
2470 2478 if isinstance(nodelist[-1], ast.Expr):
2471 2479 interactivity = "last"
2472 2480 else:
2473 2481 interactivity = "none"
2474 2482
2475 2483 if interactivity == 'none':
2476 2484 to_run_exec, to_run_interactive = nodelist, []
2477 2485 elif interactivity == 'last':
2478 2486 to_run_exec, to_run_interactive = nodelist[:-1], nodelist[-1:]
2479 2487 elif interactivity == 'all':
2480 2488 to_run_exec, to_run_interactive = [], nodelist
2481 2489 else:
2482 2490 raise ValueError("Interactivity was %r" % interactivity)
2483 2491
2484 2492 exec_count = self.execution_count
2485 2493
2486 2494 try:
2487 2495 for i, node in enumerate(to_run_exec):
2488 2496 mod = ast.Module([node])
2489 2497 code = self.compile(mod, cell_name, "exec")
2490 2498 if self.run_code(code):
2491 2499 return True
2492 2500
2493 2501 for i, node in enumerate(to_run_interactive):
2494 2502 mod = ast.Interactive([node])
2495 2503 code = self.compile(mod, cell_name, "single")
2496 2504 if self.run_code(code):
2497 2505 return True
2498 2506 except:
2499 2507 # It's possible to have exceptions raised here, typically by
2500 2508 # compilation of odd code (such as a naked 'return' outside a
2501 2509 # function) that did parse but isn't valid. Typically the exception
2502 2510 # is a SyntaxError, but it's safest just to catch anything and show
2503 2511 # the user a traceback.
2504 2512
2505 2513 # We do only one try/except outside the loop to minimize the impact
2506 2514 # on runtime, and also because if any node in the node list is
2507 2515 # broken, we should stop execution completely.
2508 2516 self.showtraceback()
2509 2517
2510 2518 return False
2511 2519
2512 2520 def run_code(self, code_obj):
2513 2521 """Execute a code object.
2514 2522
2515 2523 When an exception occurs, self.showtraceback() is called to display a
2516 2524 traceback.
2517 2525
2518 2526 Parameters
2519 2527 ----------
2520 2528 code_obj : code object
2521 2529 A compiled code object, to be executed
2522 2530 post_execute : bool [default: True]
2523 2531 whether to call post_execute hooks after this particular execution.
2524 2532
2525 2533 Returns
2526 2534 -------
2527 2535 False : successful execution.
2528 2536 True : an error occurred.
2529 2537 """
2530 2538
2531 2539 # Set our own excepthook in case the user code tries to call it
2532 2540 # directly, so that the IPython crash handler doesn't get triggered
2533 2541 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2534 2542
2535 2543 # we save the original sys.excepthook in the instance, in case config
2536 2544 # code (such as magics) needs access to it.
2537 2545 self.sys_excepthook = old_excepthook
2538 2546 outflag = 1 # happens in more places, so it's easier as default
2539 2547 try:
2540 2548 try:
2541 2549 self.hooks.pre_run_code_hook()
2542 2550 #rprint('Running code', repr(code_obj)) # dbg
2543 2551 exec code_obj in self.user_global_ns, self.user_ns
2544 2552 finally:
2545 2553 # Reset our crash handler in place
2546 2554 sys.excepthook = old_excepthook
2547 2555 except SystemExit:
2548 2556 self.showtraceback(exception_only=True)
2549 2557 warn("To exit: use 'exit', 'quit', or Ctrl-D.", level=1)
2550 2558 except self.custom_exceptions:
2551 2559 etype,value,tb = sys.exc_info()
2552 2560 self.CustomTB(etype,value,tb)
2553 2561 except:
2554 2562 self.showtraceback()
2555 2563 else:
2556 2564 outflag = 0
2557 2565 if softspace(sys.stdout, 0):
2558 2566 print
2559 2567
2560 2568 return outflag
2561 2569
2562 2570 # For backwards compatibility
2563 2571 runcode = run_code
2564 2572
2565 2573 #-------------------------------------------------------------------------
2566 2574 # Things related to GUI support and pylab
2567 2575 #-------------------------------------------------------------------------
2568 2576
2569 2577 def enable_gui(self, gui=None):
2570 2578 raise NotImplementedError('Implement enable_gui in a subclass')
2571 2579
2572 2580 def enable_pylab(self, gui=None, import_all=True):
2573 2581 """Activate pylab support at runtime.
2574 2582
2575 2583 This turns on support for matplotlib, preloads into the interactive
2576 2584 namespace all of numpy and pylab, and configures IPython to correctly
2577 2585 interact with the GUI event loop. The GUI backend to be used can be
2578 2586 optionally selected with the optional :param:`gui` argument.
2579 2587
2580 2588 Parameters
2581 2589 ----------
2582 2590 gui : optional, string
2583 2591
2584 2592 If given, dictates the choice of matplotlib GUI backend to use
2585 2593 (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
2586 2594 'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
2587 2595 matplotlib (as dictated by the matplotlib build-time options plus the
2588 2596 user's matplotlibrc configuration file). Note that not all backends
2589 2597 make sense in all contexts, for example a terminal ipython can't
2590 2598 display figures inline.
2591 2599 """
2592 2600
2593 2601 # We want to prevent the loading of pylab to pollute the user's
2594 2602 # namespace as shown by the %who* magics, so we execute the activation
2595 2603 # code in an empty namespace, and we update *both* user_ns and
2596 2604 # user_ns_hidden with this information.
2597 2605 ns = {}
2598 2606 try:
2599 2607 gui = pylab_activate(ns, gui, import_all, self)
2600 2608 except KeyError:
2601 2609 error("Backend %r not supported" % gui)
2602 2610 return
2603 2611 self.user_ns.update(ns)
2604 2612 self.user_ns_hidden.update(ns)
2605 2613 # Now we must activate the gui pylab wants to use, and fix %run to take
2606 2614 # plot updates into account
2607 2615 self.enable_gui(gui)
2608 2616 self.magic_run = self._pylab_magic_run
2609 2617
2610 2618 #-------------------------------------------------------------------------
2611 2619 # Utilities
2612 2620 #-------------------------------------------------------------------------
2613 2621
2614 2622 def var_expand(self, cmd, depth=0, formatter=DollarFormatter()):
2615 2623 """Expand python variables in a string.
2616 2624
2617 2625 The depth argument indicates how many frames above the caller should
2618 2626 be walked to look for the local namespace where to expand variables.
2619 2627
2620 2628 The global namespace for expansion is always the user's interactive
2621 2629 namespace.
2622 2630 """
2623 2631 ns = self.user_ns.copy()
2624 2632 ns.update(sys._getframe(depth+1).f_locals)
2625 2633 ns.pop('self', None)
2626 2634 return formatter.format(cmd, **ns)
2627 2635
2628 2636 def mktempfile(self, data=None, prefix='ipython_edit_'):
2629 2637 """Make a new tempfile and return its filename.
2630 2638
2631 2639 This makes a call to tempfile.mktemp, but it registers the created
2632 2640 filename internally so ipython cleans it up at exit time.
2633 2641
2634 2642 Optional inputs:
2635 2643
2636 2644 - data(None): if data is given, it gets written out to the temp file
2637 2645 immediately, and the file is closed again."""
2638 2646
2639 2647 filename = tempfile.mktemp('.py', prefix)
2640 2648 self.tempfiles.append(filename)
2641 2649
2642 2650 if data:
2643 2651 tmp_file = open(filename,'w')
2644 2652 tmp_file.write(data)
2645 2653 tmp_file.close()
2646 2654 return filename
2647 2655
2648 2656 # TODO: This should be removed when Term is refactored.
2649 2657 def write(self,data):
2650 2658 """Write a string to the default output"""
2651 2659 io.stdout.write(data)
2652 2660
2653 2661 # TODO: This should be removed when Term is refactored.
2654 2662 def write_err(self,data):
2655 2663 """Write a string to the default error output"""
2656 2664 io.stderr.write(data)
2657 2665
2658 2666 def ask_yes_no(self, prompt, default=None):
2659 2667 if self.quiet:
2660 2668 return True
2661 2669 return ask_yes_no(prompt,default)
2662 2670
2663 2671 def show_usage(self):
2664 2672 """Show a usage message"""
2665 2673 page.page(IPython.core.usage.interactive_usage)
2666 2674
2667 2675 def find_user_code(self, target, raw=True):
2668 2676 """Get a code string from history, file, or a string or macro.
2669 2677
2670 2678 This is mainly used by magic functions.
2671 2679
2672 2680 Parameters
2673 2681 ----------
2674 2682 target : str
2675 2683 A string specifying code to retrieve. This will be tried respectively
2676 2684 as: ranges of input history (see %history for syntax), a filename, or
2677 2685 an expression evaluating to a string or Macro in the user namespace.
2678 2686 raw : bool
2679 2687 If true (default), retrieve raw history. Has no effect on the other
2680 2688 retrieval mechanisms.
2681 2689
2682 2690 Returns
2683 2691 -------
2684 2692 A string of code.
2685 2693
2686 2694 ValueError is raised if nothing is found, and TypeError if it evaluates
2687 2695 to an object of another type. In each case, .args[0] is a printable
2688 2696 message.
2689 2697 """
2690 2698 code = self.extract_input_lines(target, raw=raw) # Grab history
2691 2699 if code:
2692 2700 return code
2693 2701 if os.path.isfile(target): # Read file
2694 2702 return open(target, "r").read()
2695 2703
2696 2704 try: # User namespace
2697 2705 codeobj = eval(target, self.user_ns)
2698 2706 except Exception:
2699 2707 raise ValueError(("'%s' was not found in history, as a file, nor in"
2700 2708 " the user namespace.") % target)
2701 2709 if isinstance(codeobj, basestring):
2702 2710 return codeobj
2703 2711 elif isinstance(codeobj, Macro):
2704 2712 return codeobj.value
2705 2713
2706 2714 raise TypeError("%s is neither a string nor a macro." % target,
2707 2715 codeobj)
2708 2716
2709 2717 #-------------------------------------------------------------------------
2710 2718 # Things related to IPython exiting
2711 2719 #-------------------------------------------------------------------------
2712 2720 def atexit_operations(self):
2713 2721 """This will be executed at the time of exit.
2714 2722
2715 2723 Cleanup operations and saving of persistent data that is done
2716 2724 unconditionally by IPython should be performed here.
2717 2725
2718 2726 For things that may depend on startup flags or platform specifics (such
2719 2727 as having readline or not), register a separate atexit function in the
2720 2728 code that has the appropriate information, rather than trying to
2721 2729 clutter
2722 2730 """
2723 2731 # Close the history session (this stores the end time and line count)
2724 2732 # this must be *before* the tempfile cleanup, in case of temporary
2725 2733 # history db
2726 2734 self.history_manager.end_session()
2727 2735
2728 2736 # Cleanup all tempfiles left around
2729 2737 for tfile in self.tempfiles:
2730 2738 try:
2731 2739 os.unlink(tfile)
2732 2740 except OSError:
2733 2741 pass
2734 2742
2735 2743 # Clear all user namespaces to release all references cleanly.
2736 2744 self.reset(new_session=False)
2737 2745
2738 2746 # Run user hooks
2739 2747 self.hooks.shutdown_hook()
2740 2748
2741 2749 def cleanup(self):
2742 2750 self.restore_sys_module_state()
2743 2751
2744 2752
2745 2753 class InteractiveShellABC(object):
2746 2754 """An abstract base class for InteractiveShell."""
2747 2755 __metaclass__ = abc.ABCMeta
2748 2756
2749 2757 InteractiveShellABC.register(InteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now