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