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