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