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