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