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