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