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