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