##// END OF EJS Templates
Fixed broken coloring on Windows....
Fernando Perez -
Show More
@@ -1,2463 +1,2463 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """Main IPython class."""
2 """Main IPython class."""
3
3
4 #-----------------------------------------------------------------------------
4 #-----------------------------------------------------------------------------
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
5 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
6 # Copyright (C) 2001-2007 Fernando Perez. <fperez@colorado.edu>
7 # Copyright (C) 2008-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 # This will just use sys.stdout and sys.stderr. If you want to
443 # override sys.stdout and sys.stderr themselves, you need to do that
444 # *before* instantiating this class, because Term holds onto
445 # references to the underlying streams.
443 if sys.platform == 'win32' and self.has_readline:
446 if sys.platform == 'win32' and self.has_readline:
444 Term = io.IOTerm(
447 Term = io.IOTerm(cout=self.readline._outputfile,
445 cout=self.readline._outputfile,cerr=self.readline._outputfile
448 cerr=self.readline._outputfile)
446 )
447 else:
449 else:
448 Term = io.IOTerm()
450 Term = io.IOTerm()
449 io.Term = Term
451 io.Term = Term
450
452
451 def init_prompts(self):
453 def init_prompts(self):
452 # TODO: This is a pass for now because the prompts are managed inside
454 # TODO: This is a pass for now because the prompts are managed inside
453 # the DisplayHook. Once there is a separate prompt manager, this
455 # the DisplayHook. Once there is a separate prompt manager, this
454 # will initialize that object and all prompt related information.
456 # will initialize that object and all prompt related information.
455 pass
457 pass
456
458
457 def init_displayhook(self):
459 def init_displayhook(self):
458 # Initialize displayhook, set in/out prompts and printing system
460 # Initialize displayhook, set in/out prompts and printing system
459 self.displayhook = self.displayhook_class(
461 self.displayhook = self.displayhook_class(
460 shell=self,
462 shell=self,
461 cache_size=self.cache_size,
463 cache_size=self.cache_size,
462 input_sep = self.separate_in,
464 input_sep = self.separate_in,
463 output_sep = self.separate_out,
465 output_sep = self.separate_out,
464 output_sep2 = self.separate_out2,
466 output_sep2 = self.separate_out2,
465 ps1 = self.prompt_in1,
467 ps1 = self.prompt_in1,
466 ps2 = self.prompt_in2,
468 ps2 = self.prompt_in2,
467 ps_out = self.prompt_out,
469 ps_out = self.prompt_out,
468 pad_left = self.prompts_pad_left
470 pad_left = self.prompts_pad_left
469 )
471 )
470 # This is a context manager that installs/revmoes the displayhook at
472 # This is a context manager that installs/revmoes the displayhook at
471 # the appropriate time.
473 # the appropriate time.
472 self.display_trap = DisplayTrap(hook=self.displayhook)
474 self.display_trap = DisplayTrap(hook=self.displayhook)
473
475
474 def init_reload_doctest(self):
476 def init_reload_doctest(self):
475 # Do a proper resetting of doctest, including the necessary displayhook
477 # Do a proper resetting of doctest, including the necessary displayhook
476 # monkeypatching
478 # monkeypatching
477 try:
479 try:
478 doctest_reload()
480 doctest_reload()
479 except ImportError:
481 except ImportError:
480 warn("doctest module does not exist.")
482 warn("doctest module does not exist.")
481
483
482 #-------------------------------------------------------------------------
484 #-------------------------------------------------------------------------
483 # Things related to injections into the sys module
485 # Things related to injections into the sys module
484 #-------------------------------------------------------------------------
486 #-------------------------------------------------------------------------
485
487
486 def save_sys_module_state(self):
488 def save_sys_module_state(self):
487 """Save the state of hooks in the sys module.
489 """Save the state of hooks in the sys module.
488
490
489 This has to be called after self.user_ns is created.
491 This has to be called after self.user_ns is created.
490 """
492 """
491 self._orig_sys_module_state = {}
493 self._orig_sys_module_state = {}
492 self._orig_sys_module_state['stdin'] = sys.stdin
494 self._orig_sys_module_state['stdin'] = sys.stdin
493 self._orig_sys_module_state['stdout'] = sys.stdout
495 self._orig_sys_module_state['stdout'] = sys.stdout
494 self._orig_sys_module_state['stderr'] = sys.stderr
496 self._orig_sys_module_state['stderr'] = sys.stderr
495 self._orig_sys_module_state['excepthook'] = sys.excepthook
497 self._orig_sys_module_state['excepthook'] = sys.excepthook
496 try:
498 try:
497 self._orig_sys_modules_main_name = self.user_ns['__name__']
499 self._orig_sys_modules_main_name = self.user_ns['__name__']
498 except KeyError:
500 except KeyError:
499 pass
501 pass
500
502
501 def restore_sys_module_state(self):
503 def restore_sys_module_state(self):
502 """Restore the state of the sys module."""
504 """Restore the state of the sys module."""
503 try:
505 try:
504 for k, v in self._orig_sys_module_state.items():
506 for k, v in self._orig_sys_module_state.items():
505 setattr(sys, k, v)
507 setattr(sys, k, v)
506 except AttributeError:
508 except AttributeError:
507 pass
509 pass
508 # Reset what what done in self.init_sys_modules
510 # Reset what what done in self.init_sys_modules
509 try:
511 try:
510 sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
512 sys.modules[self.user_ns['__name__']] = self._orig_sys_modules_main_name
511 except (AttributeError, KeyError):
513 except (AttributeError, KeyError):
512 pass
514 pass
513
515
514 #-------------------------------------------------------------------------
516 #-------------------------------------------------------------------------
515 # Things related to hooks
517 # Things related to hooks
516 #-------------------------------------------------------------------------
518 #-------------------------------------------------------------------------
517
519
518 def init_hooks(self):
520 def init_hooks(self):
519 # hooks holds pointers used for user-side customizations
521 # hooks holds pointers used for user-side customizations
520 self.hooks = Struct()
522 self.hooks = Struct()
521
523
522 self.strdispatchers = {}
524 self.strdispatchers = {}
523
525
524 # Set all default hooks, defined in the IPython.hooks module.
526 # Set all default hooks, defined in the IPython.hooks module.
525 hooks = IPython.core.hooks
527 hooks = IPython.core.hooks
526 for hook_name in hooks.__all__:
528 for hook_name in hooks.__all__:
527 # default hooks have priority 100, i.e. low; user hooks should have
529 # default hooks have priority 100, i.e. low; user hooks should have
528 # 0-100 priority
530 # 0-100 priority
529 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
531 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
530
532
531 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
533 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
532 """set_hook(name,hook) -> sets an internal IPython hook.
534 """set_hook(name,hook) -> sets an internal IPython hook.
533
535
534 IPython exposes some of its internal API as user-modifiable hooks. By
536 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
537 adding your function to one of these hooks, you can modify IPython's
536 behavior to call at runtime your own routines."""
538 behavior to call at runtime your own routines."""
537
539
538 # At some point in the future, this should validate the hook before it
540 # 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
541 # accepts it. Probably at least check that the hook takes the number
540 # of args it's supposed to.
542 # of args it's supposed to.
541
543
542 f = new.instancemethod(hook,self,self.__class__)
544 f = new.instancemethod(hook,self,self.__class__)
543
545
544 # check if the hook is for strdispatcher first
546 # check if the hook is for strdispatcher first
545 if str_key is not None:
547 if str_key is not None:
546 sdp = self.strdispatchers.get(name, StrDispatch())
548 sdp = self.strdispatchers.get(name, StrDispatch())
547 sdp.add_s(str_key, f, priority )
549 sdp.add_s(str_key, f, priority )
548 self.strdispatchers[name] = sdp
550 self.strdispatchers[name] = sdp
549 return
551 return
550 if re_key is not None:
552 if re_key is not None:
551 sdp = self.strdispatchers.get(name, StrDispatch())
553 sdp = self.strdispatchers.get(name, StrDispatch())
552 sdp.add_re(re.compile(re_key), f, priority )
554 sdp.add_re(re.compile(re_key), f, priority )
553 self.strdispatchers[name] = sdp
555 self.strdispatchers[name] = sdp
554 return
556 return
555
557
556 dp = getattr(self.hooks, name, None)
558 dp = getattr(self.hooks, name, None)
557 if name not in IPython.core.hooks.__all__:
559 if name not in IPython.core.hooks.__all__:
558 print "Warning! Hook '%s' is not one of %s" % \
560 print "Warning! Hook '%s' is not one of %s" % \
559 (name, IPython.core.hooks.__all__ )
561 (name, IPython.core.hooks.__all__ )
560 if not dp:
562 if not dp:
561 dp = IPython.core.hooks.CommandChainDispatcher()
563 dp = IPython.core.hooks.CommandChainDispatcher()
562
564
563 try:
565 try:
564 dp.add(f,priority)
566 dp.add(f,priority)
565 except AttributeError:
567 except AttributeError:
566 # it was not commandchain, plain old func - replace
568 # it was not commandchain, plain old func - replace
567 dp = f
569 dp = f
568
570
569 setattr(self.hooks,name, dp)
571 setattr(self.hooks,name, dp)
570
572
571 #-------------------------------------------------------------------------
573 #-------------------------------------------------------------------------
572 # Things related to the "main" module
574 # Things related to the "main" module
573 #-------------------------------------------------------------------------
575 #-------------------------------------------------------------------------
574
576
575 def new_main_mod(self,ns=None):
577 def new_main_mod(self,ns=None):
576 """Return a new 'main' module object for user code execution.
578 """Return a new 'main' module object for user code execution.
577 """
579 """
578 main_mod = self._user_main_module
580 main_mod = self._user_main_module
579 init_fakemod_dict(main_mod,ns)
581 init_fakemod_dict(main_mod,ns)
580 return main_mod
582 return main_mod
581
583
582 def cache_main_mod(self,ns,fname):
584 def cache_main_mod(self,ns,fname):
583 """Cache a main module's namespace.
585 """Cache a main module's namespace.
584
586
585 When scripts are executed via %run, we must keep a reference to the
587 When scripts are executed via %run, we must keep a reference to the
586 namespace of their __main__ module (a FakeModule instance) around so
588 namespace of their __main__ module (a FakeModule instance) around so
587 that Python doesn't clear it, rendering objects defined therein
589 that Python doesn't clear it, rendering objects defined therein
588 useless.
590 useless.
589
591
590 This method keeps said reference in a private dict, keyed by the
592 This method keeps said reference in a private dict, keyed by the
591 absolute path of the module object (which corresponds to the script
593 absolute path of the module object (which corresponds to the script
592 path). This way, for multiple executions of the same script we only
594 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
595 keep one copy of the namespace (the last one), thus preventing memory
594 leaks from old references while allowing the objects from the last
596 leaks from old references while allowing the objects from the last
595 execution to be accessible.
597 execution to be accessible.
596
598
597 Note: we can not allow the actual FakeModule instances to be deleted,
599 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
600 because of how Python tears down modules (it hard-sets all their
599 references to None without regard for reference counts). This method
601 references to None without regard for reference counts). This method
600 must therefore make a *copy* of the given namespace, to allow the
602 must therefore make a *copy* of the given namespace, to allow the
601 original module's __dict__ to be cleared and reused.
603 original module's __dict__ to be cleared and reused.
602
604
603
605
604 Parameters
606 Parameters
605 ----------
607 ----------
606 ns : a namespace (a dict, typically)
608 ns : a namespace (a dict, typically)
607
609
608 fname : str
610 fname : str
609 Filename associated with the namespace.
611 Filename associated with the namespace.
610
612
611 Examples
613 Examples
612 --------
614 --------
613
615
614 In [10]: import IPython
616 In [10]: import IPython
615
617
616 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
618 In [11]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
617
619
618 In [12]: IPython.__file__ in _ip._main_ns_cache
620 In [12]: IPython.__file__ in _ip._main_ns_cache
619 Out[12]: True
621 Out[12]: True
620 """
622 """
621 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
623 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
622
624
623 def clear_main_mod_cache(self):
625 def clear_main_mod_cache(self):
624 """Clear the cache of main modules.
626 """Clear the cache of main modules.
625
627
626 Mainly for use by utilities like %reset.
628 Mainly for use by utilities like %reset.
627
629
628 Examples
630 Examples
629 --------
631 --------
630
632
631 In [15]: import IPython
633 In [15]: import IPython
632
634
633 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
635 In [16]: _ip.cache_main_mod(IPython.__dict__,IPython.__file__)
634
636
635 In [17]: len(_ip._main_ns_cache) > 0
637 In [17]: len(_ip._main_ns_cache) > 0
636 Out[17]: True
638 Out[17]: True
637
639
638 In [18]: _ip.clear_main_mod_cache()
640 In [18]: _ip.clear_main_mod_cache()
639
641
640 In [19]: len(_ip._main_ns_cache) == 0
642 In [19]: len(_ip._main_ns_cache) == 0
641 Out[19]: True
643 Out[19]: True
642 """
644 """
643 self._main_ns_cache.clear()
645 self._main_ns_cache.clear()
644
646
645 #-------------------------------------------------------------------------
647 #-------------------------------------------------------------------------
646 # Things related to debugging
648 # Things related to debugging
647 #-------------------------------------------------------------------------
649 #-------------------------------------------------------------------------
648
650
649 def init_pdb(self):
651 def init_pdb(self):
650 # Set calling of pdb on exceptions
652 # Set calling of pdb on exceptions
651 # self.call_pdb is a property
653 # self.call_pdb is a property
652 self.call_pdb = self.pdb
654 self.call_pdb = self.pdb
653
655
654 def _get_call_pdb(self):
656 def _get_call_pdb(self):
655 return self._call_pdb
657 return self._call_pdb
656
658
657 def _set_call_pdb(self,val):
659 def _set_call_pdb(self,val):
658
660
659 if val not in (0,1,False,True):
661 if val not in (0,1,False,True):
660 raise ValueError,'new call_pdb value must be boolean'
662 raise ValueError,'new call_pdb value must be boolean'
661
663
662 # store value in instance
664 # store value in instance
663 self._call_pdb = val
665 self._call_pdb = val
664
666
665 # notify the actual exception handlers
667 # notify the actual exception handlers
666 self.InteractiveTB.call_pdb = val
668 self.InteractiveTB.call_pdb = val
667
669
668 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
670 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
669 'Control auto-activation of pdb at exceptions')
671 'Control auto-activation of pdb at exceptions')
670
672
671 def debugger(self,force=False):
673 def debugger(self,force=False):
672 """Call the pydb/pdb debugger.
674 """Call the pydb/pdb debugger.
673
675
674 Keywords:
676 Keywords:
675
677
676 - force(False): by default, this routine checks the instance call_pdb
678 - 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.
679 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
680 The 'force' option forces the debugger to activate even if the flag
679 is false.
681 is false.
680 """
682 """
681
683
682 if not (force or self.call_pdb):
684 if not (force or self.call_pdb):
683 return
685 return
684
686
685 if not hasattr(sys,'last_traceback'):
687 if not hasattr(sys,'last_traceback'):
686 error('No traceback has been produced, nothing to debug.')
688 error('No traceback has been produced, nothing to debug.')
687 return
689 return
688
690
689 # use pydb if available
691 # use pydb if available
690 if debugger.has_pydb:
692 if debugger.has_pydb:
691 from pydb import pm
693 from pydb import pm
692 else:
694 else:
693 # fallback to our internal debugger
695 # fallback to our internal debugger
694 pm = lambda : self.InteractiveTB.debugger(force=True)
696 pm = lambda : self.InteractiveTB.debugger(force=True)
695 self.history_saving_wrapper(pm)()
697 self.history_saving_wrapper(pm)()
696
698
697 #-------------------------------------------------------------------------
699 #-------------------------------------------------------------------------
698 # Things related to IPython's various namespaces
700 # Things related to IPython's various namespaces
699 #-------------------------------------------------------------------------
701 #-------------------------------------------------------------------------
700
702
701 def init_create_namespaces(self, user_ns=None, user_global_ns=None):
703 def init_create_namespaces(self, user_ns=None, user_global_ns=None):
702 # Create the namespace where the user will operate. user_ns is
704 # 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
705 # 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
706 # the locals argument. But we do carry a user_global_ns namespace
705 # given as the exec 'globals' argument, This is useful in embedding
707 # given as the exec 'globals' argument, This is useful in embedding
706 # situations where the ipython shell opens in a context where the
708 # situations where the ipython shell opens in a context where the
707 # distinction between locals and globals is meaningful. For
709 # distinction between locals and globals is meaningful. For
708 # non-embedded contexts, it is just the same object as the user_ns dict.
710 # non-embedded contexts, it is just the same object as the user_ns dict.
709
711
710 # FIXME. For some strange reason, __builtins__ is showing up at user
712 # 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
713 # 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
714 # should really track down where the problem is coming from. Alex
713 # Schmolck reported this problem first.
715 # Schmolck reported this problem first.
714
716
715 # A useful post by Alex Martelli on this topic:
717 # A useful post by Alex Martelli on this topic:
716 # Re: inconsistent value from __builtins__
718 # Re: inconsistent value from __builtins__
717 # Von: Alex Martelli <aleaxit@yahoo.com>
719 # Von: Alex Martelli <aleaxit@yahoo.com>
718 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
720 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
719 # Gruppen: comp.lang.python
721 # Gruppen: comp.lang.python
720
722
721 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
723 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
722 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
724 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
723 # > <type 'dict'>
725 # > <type 'dict'>
724 # > >>> print type(__builtins__)
726 # > >>> print type(__builtins__)
725 # > <type 'module'>
727 # > <type 'module'>
726 # > Is this difference in return value intentional?
728 # > Is this difference in return value intentional?
727
729
728 # Well, it's documented that '__builtins__' can be either a dictionary
730 # 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
731 # 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
732 # 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
733 # that if you need to access the built-in namespace directly, you
732 # should start with "import __builtin__" (note, no 's') which will
734 # should start with "import __builtin__" (note, no 's') which will
733 # definitely give you a module. Yeah, it's somewhat confusing:-(.
735 # definitely give you a module. Yeah, it's somewhat confusing:-(.
734
736
735 # These routines return properly built dicts as needed by the rest of
737 # 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
738 # the code, and can also be used by extension writers to generate
737 # properly initialized namespaces.
739 # properly initialized namespaces.
738 user_ns, user_global_ns = self.make_user_namespaces(user_ns,
740 user_ns, user_global_ns = self.make_user_namespaces(user_ns,
739 user_global_ns)
741 user_global_ns)
740
742
741 # Assign namespaces
743 # Assign namespaces
742 # This is the namespace where all normal user variables live
744 # This is the namespace where all normal user variables live
743 self.user_ns = user_ns
745 self.user_ns = user_ns
744 self.user_global_ns = user_global_ns
746 self.user_global_ns = user_global_ns
745
747
746 # An auxiliary namespace that checks what parts of the user_ns were
748 # 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
749 # 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
750 # 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.
751 # doesn't need to be separately tracked in the ns_table.
750 self.user_ns_hidden = {}
752 self.user_ns_hidden = {}
751
753
752 # A namespace to keep track of internal data structures to prevent
754 # A namespace to keep track of internal data structures to prevent
753 # them from cluttering user-visible stuff. Will be updated later
755 # them from cluttering user-visible stuff. Will be updated later
754 self.internal_ns = {}
756 self.internal_ns = {}
755
757
756 # Now that FakeModule produces a real module, we've run into a nasty
758 # 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
759 # 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
760 # code ran is deleted. Now that this object is a true module (needed
759 # so docetst and other tools work correctly), the Python module
761 # so docetst and other tools work correctly), the Python module
760 # teardown mechanism runs over it, and sets to None every variable
762 # teardown mechanism runs over it, and sets to None every variable
761 # present in that module. Top-level references to objects from the
763 # present in that module. Top-level references to objects from the
762 # script survive, because the user_ns is updated with them. However,
764 # script survive, because the user_ns is updated with them. However,
763 # calling functions defined in the script that use other things from
765 # calling functions defined in the script that use other things from
764 # the script will fail, because the function's closure had references
766 # 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
767 # to the original objects, which are now all None. So we must protect
766 # these modules from deletion by keeping a cache.
768 # these modules from deletion by keeping a cache.
767 #
769 #
768 # To avoid keeping stale modules around (we only need the one from the
770 # 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
771 # 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,
772 # only the last version of the module is held in the cache. Note,
771 # however, that we must cache the module *namespace contents* (their
773 # however, that we must cache the module *namespace contents* (their
772 # __dict__). Because if we try to cache the actual modules, old ones
774 # __dict__). Because if we try to cache the actual modules, old ones
773 # (uncached) could be destroyed while still holding references (such as
775 # (uncached) could be destroyed while still holding references (such as
774 # those held by GUI objects that tend to be long-lived)>
776 # those held by GUI objects that tend to be long-lived)>
775 #
777 #
776 # The %reset command will flush this cache. See the cache_main_mod()
778 # The %reset command will flush this cache. See the cache_main_mod()
777 # and clear_main_mod_cache() methods for details on use.
779 # and clear_main_mod_cache() methods for details on use.
778
780
779 # This is the cache used for 'main' namespaces
781 # This is the cache used for 'main' namespaces
780 self._main_ns_cache = {}
782 self._main_ns_cache = {}
781 # And this is the single instance of FakeModule whose __dict__ we keep
783 # And this is the single instance of FakeModule whose __dict__ we keep
782 # copying and clearing for reuse on each %run
784 # copying and clearing for reuse on each %run
783 self._user_main_module = FakeModule()
785 self._user_main_module = FakeModule()
784
786
785 # A table holding all the namespaces IPython deals with, so that
787 # A table holding all the namespaces IPython deals with, so that
786 # introspection facilities can search easily.
788 # introspection facilities can search easily.
787 self.ns_table = {'user':user_ns,
789 self.ns_table = {'user':user_ns,
788 'user_global':user_global_ns,
790 'user_global':user_global_ns,
789 'internal':self.internal_ns,
791 'internal':self.internal_ns,
790 'builtin':__builtin__.__dict__
792 'builtin':__builtin__.__dict__
791 }
793 }
792
794
793 # Similarly, track all namespaces where references can be held and that
795 # 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
796 # we can safely clear (so it can NOT include builtin). This one can be
795 # a simple list.
797 # a simple list.
796 self.ns_refs_table = [ user_ns, user_global_ns, self.user_ns_hidden,
798 self.ns_refs_table = [ user_ns, user_global_ns, self.user_ns_hidden,
797 self.internal_ns, self._main_ns_cache ]
799 self.internal_ns, self._main_ns_cache ]
798
800
799 def make_user_namespaces(self, user_ns=None, user_global_ns=None):
801 def make_user_namespaces(self, user_ns=None, user_global_ns=None):
800 """Return a valid local and global user interactive namespaces.
802 """Return a valid local and global user interactive namespaces.
801
803
802 This builds a dict with the minimal information needed to operate as a
804 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
805 valid IPython user namespace, which you can pass to the various
804 embedding classes in ipython. The default implementation returns the
806 embedding classes in ipython. The default implementation returns the
805 same dict for both the locals and the globals to allow functions to
807 same dict for both the locals and the globals to allow functions to
806 refer to variables in the namespace. Customized implementations can
808 refer to variables in the namespace. Customized implementations can
807 return different dicts. The locals dictionary can actually be anything
809 return different dicts. The locals dictionary can actually be anything
808 following the basic mapping protocol of a dict, but the globals dict
810 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
811 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
812 custom object for the locals namespace synchronize with the globals
811 dict somehow.
813 dict somehow.
812
814
813 Raises TypeError if the provided globals namespace is not a true dict.
815 Raises TypeError if the provided globals namespace is not a true dict.
814
816
815 Parameters
817 Parameters
816 ----------
818 ----------
817 user_ns : dict-like, optional
819 user_ns : dict-like, optional
818 The current user namespace. The items in this namespace should
820 The current user namespace. The items in this namespace should
819 be included in the output. If None, an appropriate blank
821 be included in the output. If None, an appropriate blank
820 namespace should be created.
822 namespace should be created.
821 user_global_ns : dict, optional
823 user_global_ns : dict, optional
822 The current user global namespace. The items in this namespace
824 The current user global namespace. The items in this namespace
823 should be included in the output. If None, an appropriate
825 should be included in the output. If None, an appropriate
824 blank namespace should be created.
826 blank namespace should be created.
825
827
826 Returns
828 Returns
827 -------
829 -------
828 A pair of dictionary-like object to be used as the local namespace
830 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.
831 of the interpreter and a dict to be used as the global namespace.
830 """
832 """
831
833
832
834
833 # We must ensure that __builtin__ (without the final 's') is always
835 # We must ensure that __builtin__ (without the final 's') is always
834 # available and pointing to the __builtin__ *module*. For more details:
836 # available and pointing to the __builtin__ *module*. For more details:
835 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
837 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
836
838
837 if user_ns is None:
839 if user_ns is None:
838 # Set __name__ to __main__ to better match the behavior of the
840 # Set __name__ to __main__ to better match the behavior of the
839 # normal interpreter.
841 # normal interpreter.
840 user_ns = {'__name__' :'__main__',
842 user_ns = {'__name__' :'__main__',
841 '__builtin__' : __builtin__,
843 '__builtin__' : __builtin__,
842 '__builtins__' : __builtin__,
844 '__builtins__' : __builtin__,
843 }
845 }
844 else:
846 else:
845 user_ns.setdefault('__name__','__main__')
847 user_ns.setdefault('__name__','__main__')
846 user_ns.setdefault('__builtin__',__builtin__)
848 user_ns.setdefault('__builtin__',__builtin__)
847 user_ns.setdefault('__builtins__',__builtin__)
849 user_ns.setdefault('__builtins__',__builtin__)
848
850
849 if user_global_ns is None:
851 if user_global_ns is None:
850 user_global_ns = user_ns
852 user_global_ns = user_ns
851 if type(user_global_ns) is not dict:
853 if type(user_global_ns) is not dict:
852 raise TypeError("user_global_ns must be a true dict; got %r"
854 raise TypeError("user_global_ns must be a true dict; got %r"
853 % type(user_global_ns))
855 % type(user_global_ns))
854
856
855 return user_ns, user_global_ns
857 return user_ns, user_global_ns
856
858
857 def init_sys_modules(self):
859 def init_sys_modules(self):
858 # We need to insert into sys.modules something that looks like a
860 # We need to insert into sys.modules something that looks like a
859 # module but which accesses the IPython namespace, for shelve and
861 # module but which accesses the IPython namespace, for shelve and
860 # pickle to work interactively. Normally they rely on getting
862 # pickle to work interactively. Normally they rely on getting
861 # everything out of __main__, but for embedding purposes each IPython
863 # everything out of __main__, but for embedding purposes each IPython
862 # instance has its own private namespace, so we can't go shoving
864 # instance has its own private namespace, so we can't go shoving
863 # everything into __main__.
865 # everything into __main__.
864
866
865 # note, however, that we should only do this for non-embedded
867 # note, however, that we should only do this for non-embedded
866 # ipythons, which really mimic the __main__.__dict__ with their own
868 # ipythons, which really mimic the __main__.__dict__ with their own
867 # namespace. Embedded instances, on the other hand, should not do
869 # namespace. Embedded instances, on the other hand, should not do
868 # this because they need to manage the user local/global namespaces
870 # this because they need to manage the user local/global namespaces
869 # only, but they live within a 'normal' __main__ (meaning, they
871 # only, but they live within a 'normal' __main__ (meaning, they
870 # shouldn't overtake the execution environment of the script they're
872 # shouldn't overtake the execution environment of the script they're
871 # embedded in).
873 # embedded in).
872
874
873 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
875 # This is overridden in the InteractiveShellEmbed subclass to a no-op.
874
876
875 try:
877 try:
876 main_name = self.user_ns['__name__']
878 main_name = self.user_ns['__name__']
877 except KeyError:
879 except KeyError:
878 raise KeyError('user_ns dictionary MUST have a "__name__" key')
880 raise KeyError('user_ns dictionary MUST have a "__name__" key')
879 else:
881 else:
880 sys.modules[main_name] = FakeModule(self.user_ns)
882 sys.modules[main_name] = FakeModule(self.user_ns)
881
883
882 def init_user_ns(self):
884 def init_user_ns(self):
883 """Initialize all user-visible namespaces to their minimum defaults.
885 """Initialize all user-visible namespaces to their minimum defaults.
884
886
885 Certain history lists are also initialized here, as they effectively
887 Certain history lists are also initialized here, as they effectively
886 act as user namespaces.
888 act as user namespaces.
887
889
888 Notes
890 Notes
889 -----
891 -----
890 All data structures here are only filled in, they are NOT reset by this
892 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
893 method. If they were not empty before, data will simply be added to
892 therm.
894 therm.
893 """
895 """
894 # This function works in two parts: first we put a few things in
896 # 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
897 # 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
898 # 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
899 # 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)
900 # session (probably nothing, so theye really only see their own stuff)
899
901
900 # The user dict must *always* have a __builtin__ reference to the
902 # The user dict must *always* have a __builtin__ reference to the
901 # Python standard __builtin__ namespace, which must be imported.
903 # Python standard __builtin__ namespace, which must be imported.
902 # This is so that certain operations in prompt evaluation can be
904 # This is so that certain operations in prompt evaluation can be
903 # reliably executed with builtins. Note that we can NOT use
905 # reliably executed with builtins. Note that we can NOT use
904 # __builtins__ (note the 's'), because that can either be a dict or a
906 # __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
907 # module, and can even mutate at runtime, depending on the context
906 # (Python makes no guarantees on it). In contrast, __builtin__ is
908 # (Python makes no guarantees on it). In contrast, __builtin__ is
907 # always a module object, though it must be explicitly imported.
909 # always a module object, though it must be explicitly imported.
908
910
909 # For more details:
911 # For more details:
910 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
912 # http://mail.python.org/pipermail/python-dev/2001-April/014068.html
911 ns = dict(__builtin__ = __builtin__)
913 ns = dict(__builtin__ = __builtin__)
912
914
913 # Put 'help' in the user namespace
915 # Put 'help' in the user namespace
914 try:
916 try:
915 from site import _Helper
917 from site import _Helper
916 ns['help'] = _Helper()
918 ns['help'] = _Helper()
917 except ImportError:
919 except ImportError:
918 warn('help() not available - check site.py')
920 warn('help() not available - check site.py')
919
921
920 # make global variables for user access to the histories
922 # make global variables for user access to the histories
921 ns['_ih'] = self.input_hist
923 ns['_ih'] = self.input_hist
922 ns['_oh'] = self.output_hist
924 ns['_oh'] = self.output_hist
923 ns['_dh'] = self.dir_hist
925 ns['_dh'] = self.dir_hist
924
926
925 ns['_sh'] = shadowns
927 ns['_sh'] = shadowns
926
928
927 # user aliases to input and output histories. These shouldn't show up
929 # user aliases to input and output histories. These shouldn't show up
928 # in %who, as they can have very large reprs.
930 # in %who, as they can have very large reprs.
929 ns['In'] = self.input_hist
931 ns['In'] = self.input_hist
930 ns['Out'] = self.output_hist
932 ns['Out'] = self.output_hist
931
933
932 # Store myself as the public api!!!
934 # Store myself as the public api!!!
933 ns['get_ipython'] = self.get_ipython
935 ns['get_ipython'] = self.get_ipython
934
936
935 # Sync what we've added so far to user_ns_hidden so these aren't seen
937 # Sync what we've added so far to user_ns_hidden so these aren't seen
936 # by %who
938 # by %who
937 self.user_ns_hidden.update(ns)
939 self.user_ns_hidden.update(ns)
938
940
939 # Anything put into ns now would show up in %who. Think twice before
941 # 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
942 # putting anything here, as we really want %who to show the user their
941 # stuff, not our variables.
943 # stuff, not our variables.
942
944
943 # Finally, update the real user's namespace
945 # Finally, update the real user's namespace
944 self.user_ns.update(ns)
946 self.user_ns.update(ns)
945
947
946
948
947 def reset(self):
949 def reset(self):
948 """Clear all internal namespaces.
950 """Clear all internal namespaces.
949
951
950 Note that this is much more aggressive than %reset, since it clears
952 Note that this is much more aggressive than %reset, since it clears
951 fully all namespaces, as well as all input/output lists.
953 fully all namespaces, as well as all input/output lists.
952 """
954 """
953 for ns in self.ns_refs_table:
955 for ns in self.ns_refs_table:
954 ns.clear()
956 ns.clear()
955
957
956 self.alias_manager.clear_aliases()
958 self.alias_manager.clear_aliases()
957
959
958 # Clear input and output histories
960 # Clear input and output histories
959 self.input_hist[:] = []
961 self.input_hist[:] = []
960 self.input_hist_raw[:] = []
962 self.input_hist_raw[:] = []
961 self.output_hist.clear()
963 self.output_hist.clear()
962
964
963 # Restore the user namespaces to minimal usability
965 # Restore the user namespaces to minimal usability
964 self.init_user_ns()
966 self.init_user_ns()
965
967
966 # Restore the default and user aliases
968 # Restore the default and user aliases
967 self.alias_manager.init_aliases()
969 self.alias_manager.init_aliases()
968
970
969 def reset_selective(self, regex=None):
971 def reset_selective(self, regex=None):
970 """Clear selective variables from internal namespaces based on a
972 """Clear selective variables from internal namespaces based on a
971 specified regular expression.
973 specified regular expression.
972
974
973 Parameters
975 Parameters
974 ----------
976 ----------
975 regex : string or compiled pattern, optional
977 regex : string or compiled pattern, optional
976 A regular expression pattern that will be used in searching
978 A regular expression pattern that will be used in searching
977 variable names in the users namespaces.
979 variable names in the users namespaces.
978 """
980 """
979 if regex is not None:
981 if regex is not None:
980 try:
982 try:
981 m = re.compile(regex)
983 m = re.compile(regex)
982 except TypeError:
984 except TypeError:
983 raise TypeError('regex must be a string or compiled pattern')
985 raise TypeError('regex must be a string or compiled pattern')
984 # Search for keys in each namespace that match the given regex
986 # Search for keys in each namespace that match the given regex
985 # If a match is found, delete the key/value pair.
987 # If a match is found, delete the key/value pair.
986 for ns in self.ns_refs_table:
988 for ns in self.ns_refs_table:
987 for var in ns:
989 for var in ns:
988 if m.search(var):
990 if m.search(var):
989 del ns[var]
991 del ns[var]
990
992
991 def push(self, variables, interactive=True):
993 def push(self, variables, interactive=True):
992 """Inject a group of variables into the IPython user namespace.
994 """Inject a group of variables into the IPython user namespace.
993
995
994 Parameters
996 Parameters
995 ----------
997 ----------
996 variables : dict, str or list/tuple of str
998 variables : dict, str or list/tuple of str
997 The variables to inject into the user's namespace. If a dict, a
999 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
1000 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
1001 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
1002 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
1003 give (list/tuple/str) then the variable values looked up in the
1002 callers frame.
1004 callers frame.
1003 interactive : bool
1005 interactive : bool
1004 If True (default), the variables will be listed with the ``who``
1006 If True (default), the variables will be listed with the ``who``
1005 magic.
1007 magic.
1006 """
1008 """
1007 vdict = None
1009 vdict = None
1008
1010
1009 # We need a dict of name/value pairs to do namespace updates.
1011 # We need a dict of name/value pairs to do namespace updates.
1010 if isinstance(variables, dict):
1012 if isinstance(variables, dict):
1011 vdict = variables
1013 vdict = variables
1012 elif isinstance(variables, (basestring, list, tuple)):
1014 elif isinstance(variables, (basestring, list, tuple)):
1013 if isinstance(variables, basestring):
1015 if isinstance(variables, basestring):
1014 vlist = variables.split()
1016 vlist = variables.split()
1015 else:
1017 else:
1016 vlist = variables
1018 vlist = variables
1017 vdict = {}
1019 vdict = {}
1018 cf = sys._getframe(1)
1020 cf = sys._getframe(1)
1019 for name in vlist:
1021 for name in vlist:
1020 try:
1022 try:
1021 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1023 vdict[name] = eval(name, cf.f_globals, cf.f_locals)
1022 except:
1024 except:
1023 print ('Could not get variable %s from %s' %
1025 print ('Could not get variable %s from %s' %
1024 (name,cf.f_code.co_name))
1026 (name,cf.f_code.co_name))
1025 else:
1027 else:
1026 raise ValueError('variables must be a dict/str/list/tuple')
1028 raise ValueError('variables must be a dict/str/list/tuple')
1027
1029
1028 # Propagate variables to user namespace
1030 # Propagate variables to user namespace
1029 self.user_ns.update(vdict)
1031 self.user_ns.update(vdict)
1030
1032
1031 # And configure interactive visibility
1033 # And configure interactive visibility
1032 config_ns = self.user_ns_hidden
1034 config_ns = self.user_ns_hidden
1033 if interactive:
1035 if interactive:
1034 for name, val in vdict.iteritems():
1036 for name, val in vdict.iteritems():
1035 config_ns.pop(name, None)
1037 config_ns.pop(name, None)
1036 else:
1038 else:
1037 for name,val in vdict.iteritems():
1039 for name,val in vdict.iteritems():
1038 config_ns[name] = val
1040 config_ns[name] = val
1039
1041
1040 #-------------------------------------------------------------------------
1042 #-------------------------------------------------------------------------
1041 # Things related to object introspection
1043 # Things related to object introspection
1042 #-------------------------------------------------------------------------
1044 #-------------------------------------------------------------------------
1043 def _ofind(self, oname, namespaces=None):
1045 def _ofind(self, oname, namespaces=None):
1044 """Find an object in the available namespaces.
1046 """Find an object in the available namespaces.
1045
1047
1046 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1048 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
1047
1049
1048 Has special code to detect magic functions.
1050 Has special code to detect magic functions.
1049 """
1051 """
1050 #oname = oname.strip()
1052 #oname = oname.strip()
1051 #print '1- oname: <%r>' % oname # dbg
1053 #print '1- oname: <%r>' % oname # dbg
1052 try:
1054 try:
1053 oname = oname.strip().encode('ascii')
1055 oname = oname.strip().encode('ascii')
1054 #print '2- oname: <%r>' % oname # dbg
1056 #print '2- oname: <%r>' % oname # dbg
1055 except UnicodeEncodeError:
1057 except UnicodeEncodeError:
1056 print 'Python identifiers can only contain ascii characters.'
1058 print 'Python identifiers can only contain ascii characters.'
1057 return dict(found=False)
1059 return dict(found=False)
1058
1060
1059 alias_ns = None
1061 alias_ns = None
1060 if namespaces is None:
1062 if namespaces is None:
1061 # Namespaces to search in:
1063 # Namespaces to search in:
1062 # Put them in a list. The order is important so that we
1064 # Put them in a list. The order is important so that we
1063 # find things in the same order that Python finds them.
1065 # find things in the same order that Python finds them.
1064 namespaces = [ ('Interactive', self.user_ns),
1066 namespaces = [ ('Interactive', self.user_ns),
1065 ('IPython internal', self.internal_ns),
1067 ('IPython internal', self.internal_ns),
1066 ('Python builtin', __builtin__.__dict__),
1068 ('Python builtin', __builtin__.__dict__),
1067 ('Alias', self.alias_manager.alias_table),
1069 ('Alias', self.alias_manager.alias_table),
1068 ]
1070 ]
1069 alias_ns = self.alias_manager.alias_table
1071 alias_ns = self.alias_manager.alias_table
1070
1072
1071 # initialize results to 'null'
1073 # initialize results to 'null'
1072 found = False; obj = None; ospace = None; ds = None;
1074 found = False; obj = None; ospace = None; ds = None;
1073 ismagic = False; isalias = False; parent = None
1075 ismagic = False; isalias = False; parent = None
1074
1076
1075 # We need to special-case 'print', which as of python2.6 registers as a
1077 # 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
1078 # function but should only be treated as one if print_function was
1077 # loaded with a future import. In this case, just bail.
1079 # loaded with a future import. In this case, just bail.
1078 if (oname == 'print' and not (self.compile.compiler.flags &
1080 if (oname == 'print' and not (self.compile.compiler.flags &
1079 __future__.CO_FUTURE_PRINT_FUNCTION)):
1081 __future__.CO_FUTURE_PRINT_FUNCTION)):
1080 return {'found':found, 'obj':obj, 'namespace':ospace,
1082 return {'found':found, 'obj':obj, 'namespace':ospace,
1081 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1083 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1082
1084
1083 # Look for the given name by splitting it in parts. If the head is
1085 # 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
1086 # found, then we look for all the remaining parts as members, and only
1085 # declare success if we can find them all.
1087 # declare success if we can find them all.
1086 oname_parts = oname.split('.')
1088 oname_parts = oname.split('.')
1087 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1089 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
1088 for nsname,ns in namespaces:
1090 for nsname,ns in namespaces:
1089 try:
1091 try:
1090 obj = ns[oname_head]
1092 obj = ns[oname_head]
1091 except KeyError:
1093 except KeyError:
1092 continue
1094 continue
1093 else:
1095 else:
1094 #print 'oname_rest:', oname_rest # dbg
1096 #print 'oname_rest:', oname_rest # dbg
1095 for part in oname_rest:
1097 for part in oname_rest:
1096 try:
1098 try:
1097 parent = obj
1099 parent = obj
1098 obj = getattr(obj,part)
1100 obj = getattr(obj,part)
1099 except:
1101 except:
1100 # Blanket except b/c some badly implemented objects
1102 # Blanket except b/c some badly implemented objects
1101 # allow __getattr__ to raise exceptions other than
1103 # allow __getattr__ to raise exceptions other than
1102 # AttributeError, which then crashes IPython.
1104 # AttributeError, which then crashes IPython.
1103 break
1105 break
1104 else:
1106 else:
1105 # If we finish the for loop (no break), we got all members
1107 # If we finish the for loop (no break), we got all members
1106 found = True
1108 found = True
1107 ospace = nsname
1109 ospace = nsname
1108 if ns == alias_ns:
1110 if ns == alias_ns:
1109 isalias = True
1111 isalias = True
1110 break # namespace loop
1112 break # namespace loop
1111
1113
1112 # Try to see if it's magic
1114 # Try to see if it's magic
1113 if not found:
1115 if not found:
1114 if oname.startswith(ESC_MAGIC):
1116 if oname.startswith(ESC_MAGIC):
1115 oname = oname[1:]
1117 oname = oname[1:]
1116 obj = getattr(self,'magic_'+oname,None)
1118 obj = getattr(self,'magic_'+oname,None)
1117 if obj is not None:
1119 if obj is not None:
1118 found = True
1120 found = True
1119 ospace = 'IPython internal'
1121 ospace = 'IPython internal'
1120 ismagic = True
1122 ismagic = True
1121
1123
1122 # Last try: special-case some literals like '', [], {}, etc:
1124 # Last try: special-case some literals like '', [], {}, etc:
1123 if not found and oname_head in ["''",'""','[]','{}','()']:
1125 if not found and oname_head in ["''",'""','[]','{}','()']:
1124 obj = eval(oname_head)
1126 obj = eval(oname_head)
1125 found = True
1127 found = True
1126 ospace = 'Interactive'
1128 ospace = 'Interactive'
1127
1129
1128 return {'found':found, 'obj':obj, 'namespace':ospace,
1130 return {'found':found, 'obj':obj, 'namespace':ospace,
1129 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1131 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
1130
1132
1131 def _ofind_property(self, oname, info):
1133 def _ofind_property(self, oname, info):
1132 """Second part of object finding, to look for property details."""
1134 """Second part of object finding, to look for property details."""
1133 if info.found:
1135 if info.found:
1134 # Get the docstring of the class property if it exists.
1136 # Get the docstring of the class property if it exists.
1135 path = oname.split('.')
1137 path = oname.split('.')
1136 root = '.'.join(path[:-1])
1138 root = '.'.join(path[:-1])
1137 if info.parent is not None:
1139 if info.parent is not None:
1138 try:
1140 try:
1139 target = getattr(info.parent, '__class__')
1141 target = getattr(info.parent, '__class__')
1140 # The object belongs to a class instance.
1142 # The object belongs to a class instance.
1141 try:
1143 try:
1142 target = getattr(target, path[-1])
1144 target = getattr(target, path[-1])
1143 # The class defines the object.
1145 # The class defines the object.
1144 if isinstance(target, property):
1146 if isinstance(target, property):
1145 oname = root + '.__class__.' + path[-1]
1147 oname = root + '.__class__.' + path[-1]
1146 info = Struct(self._ofind(oname))
1148 info = Struct(self._ofind(oname))
1147 except AttributeError: pass
1149 except AttributeError: pass
1148 except AttributeError: pass
1150 except AttributeError: pass
1149
1151
1150 # We return either the new info or the unmodified input if the object
1152 # We return either the new info or the unmodified input if the object
1151 # hadn't been found
1153 # hadn't been found
1152 return info
1154 return info
1153
1155
1154 def _object_find(self, oname, namespaces=None):
1156 def _object_find(self, oname, namespaces=None):
1155 """Find an object and return a struct with info about it."""
1157 """Find an object and return a struct with info about it."""
1156 inf = Struct(self._ofind(oname, namespaces))
1158 inf = Struct(self._ofind(oname, namespaces))
1157 return Struct(self._ofind_property(oname, inf))
1159 return Struct(self._ofind_property(oname, inf))
1158
1160
1159 def _inspect(self, meth, oname, namespaces=None, **kw):
1161 def _inspect(self, meth, oname, namespaces=None, **kw):
1160 """Generic interface to the inspector system.
1162 """Generic interface to the inspector system.
1161
1163
1162 This function is meant to be called by pdef, pdoc & friends."""
1164 This function is meant to be called by pdef, pdoc & friends."""
1163 info = self._object_find(oname)
1165 info = self._object_find(oname)
1164 if info.found:
1166 if info.found:
1165 pmethod = getattr(self.inspector, meth)
1167 pmethod = getattr(self.inspector, meth)
1166 formatter = format_screen if info.ismagic else None
1168 formatter = format_screen if info.ismagic else None
1167 if meth == 'pdoc':
1169 if meth == 'pdoc':
1168 pmethod(info.obj, oname, formatter)
1170 pmethod(info.obj, oname, formatter)
1169 elif meth == 'pinfo':
1171 elif meth == 'pinfo':
1170 pmethod(info.obj, oname, formatter, info, **kw)
1172 pmethod(info.obj, oname, formatter, info, **kw)
1171 else:
1173 else:
1172 pmethod(info.obj, oname)
1174 pmethod(info.obj, oname)
1173 else:
1175 else:
1174 print 'Object `%s` not found.' % oname
1176 print 'Object `%s` not found.' % oname
1175 return 'not found' # so callers can take other action
1177 return 'not found' # so callers can take other action
1176
1178
1177 def object_inspect(self, oname):
1179 def object_inspect(self, oname):
1178 info = self._object_find(oname)
1180 info = self._object_find(oname)
1179 if info.found:
1181 if info.found:
1180 return self.inspector.info(info.obj, info=info)
1182 return self.inspector.info(info.obj, info=info)
1181 else:
1183 else:
1182 return oinspect.mk_object_info({'found' : False})
1184 return oinspect.mk_object_info({'found' : False})
1183
1185
1184 #-------------------------------------------------------------------------
1186 #-------------------------------------------------------------------------
1185 # Things related to history management
1187 # Things related to history management
1186 #-------------------------------------------------------------------------
1188 #-------------------------------------------------------------------------
1187
1189
1188 def init_history(self):
1190 def init_history(self):
1189 # List of input with multi-line handling.
1191 # List of input with multi-line handling.
1190 self.input_hist = InputList()
1192 self.input_hist = InputList()
1191 # This one will hold the 'raw' input history, without any
1193 # This one will hold the 'raw' input history, without any
1192 # pre-processing. This will allow users to retrieve the input just as
1194 # pre-processing. This will allow users to retrieve the input just as
1193 # it was exactly typed in by the user, with %hist -r.
1195 # it was exactly typed in by the user, with %hist -r.
1194 self.input_hist_raw = InputList()
1196 self.input_hist_raw = InputList()
1195
1197
1196 # list of visited directories
1198 # list of visited directories
1197 try:
1199 try:
1198 self.dir_hist = [os.getcwd()]
1200 self.dir_hist = [os.getcwd()]
1199 except OSError:
1201 except OSError:
1200 self.dir_hist = []
1202 self.dir_hist = []
1201
1203
1202 # dict of output history
1204 # dict of output history
1203 self.output_hist = {}
1205 self.output_hist = {}
1204
1206
1205 # Now the history file
1207 # Now the history file
1206 if self.profile:
1208 if self.profile:
1207 histfname = 'history-%s' % self.profile
1209 histfname = 'history-%s' % self.profile
1208 else:
1210 else:
1209 histfname = 'history'
1211 histfname = 'history'
1210 self.histfile = os.path.join(self.ipython_dir, histfname)
1212 self.histfile = os.path.join(self.ipython_dir, histfname)
1211
1213
1212 # Fill the history zero entry, user counter starts at 1
1214 # Fill the history zero entry, user counter starts at 1
1213 self.input_hist.append('\n')
1215 self.input_hist.append('\n')
1214 self.input_hist_raw.append('\n')
1216 self.input_hist_raw.append('\n')
1215
1217
1216 def init_shadow_hist(self):
1218 def init_shadow_hist(self):
1217 try:
1219 try:
1218 self.db = pickleshare.PickleShareDB(self.ipython_dir + "/db")
1220 self.db = pickleshare.PickleShareDB(self.ipython_dir + "/db")
1219 except exceptions.UnicodeDecodeError:
1221 except exceptions.UnicodeDecodeError:
1220 print "Your ipython_dir can't be decoded to unicode!"
1222 print "Your ipython_dir can't be decoded to unicode!"
1221 print "Please set HOME environment variable to something that"
1223 print "Please set HOME environment variable to something that"
1222 print r"only has ASCII characters, e.g. c:\home"
1224 print r"only has ASCII characters, e.g. c:\home"
1223 print "Now it is", self.ipython_dir
1225 print "Now it is", self.ipython_dir
1224 sys.exit()
1226 sys.exit()
1225 self.shadowhist = ipcorehist.ShadowHist(self.db)
1227 self.shadowhist = ipcorehist.ShadowHist(self.db)
1226
1228
1227 def savehist(self):
1229 def savehist(self):
1228 """Save input history to a file (via readline library)."""
1230 """Save input history to a file (via readline library)."""
1229
1231
1230 try:
1232 try:
1231 self.readline.write_history_file(self.histfile)
1233 self.readline.write_history_file(self.histfile)
1232 except:
1234 except:
1233 print 'Unable to save IPython command history to file: ' + \
1235 print 'Unable to save IPython command history to file: ' + \
1234 `self.histfile`
1236 `self.histfile`
1235
1237
1236 def reloadhist(self):
1238 def reloadhist(self):
1237 """Reload the input history from disk file."""
1239 """Reload the input history from disk file."""
1238
1240
1239 try:
1241 try:
1240 self.readline.clear_history()
1242 self.readline.clear_history()
1241 self.readline.read_history_file(self.shell.histfile)
1243 self.readline.read_history_file(self.shell.histfile)
1242 except AttributeError:
1244 except AttributeError:
1243 pass
1245 pass
1244
1246
1245 def history_saving_wrapper(self, func):
1247 def history_saving_wrapper(self, func):
1246 """ Wrap func for readline history saving
1248 """ Wrap func for readline history saving
1247
1249
1248 Convert func into callable that saves & restores
1250 Convert func into callable that saves & restores
1249 history around the call """
1251 history around the call """
1250
1252
1251 if self.has_readline:
1253 if self.has_readline:
1252 from IPython.utils import rlineimpl as readline
1254 from IPython.utils import rlineimpl as readline
1253 else:
1255 else:
1254 return func
1256 return func
1255
1257
1256 def wrapper():
1258 def wrapper():
1257 self.savehist()
1259 self.savehist()
1258 try:
1260 try:
1259 func()
1261 func()
1260 finally:
1262 finally:
1261 readline.read_history_file(self.histfile)
1263 readline.read_history_file(self.histfile)
1262 return wrapper
1264 return wrapper
1263
1265
1264 def get_history(self, index=None, raw=False, output=True):
1266 def get_history(self, index=None, raw=False, output=True):
1265 """Get the history list.
1267 """Get the history list.
1266
1268
1267 Get the input and output history.
1269 Get the input and output history.
1268
1270
1269 Parameters
1271 Parameters
1270 ----------
1272 ----------
1271 index : n or (n1, n2) or None
1273 index : n or (n1, n2) or None
1272 If n, then the last entries. If a tuple, then all in
1274 If n, then the last entries. If a tuple, then all in
1273 range(n1, n2). If None, then all entries. Raises IndexError if
1275 range(n1, n2). If None, then all entries. Raises IndexError if
1274 the format of index is incorrect.
1276 the format of index is incorrect.
1275 raw : bool
1277 raw : bool
1276 If True, return the raw input.
1278 If True, return the raw input.
1277 output : bool
1279 output : bool
1278 If True, then return the output as well.
1280 If True, then return the output as well.
1279
1281
1280 Returns
1282 Returns
1281 -------
1283 -------
1282 If output is True, then return a dict of tuples, keyed by the prompt
1284 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
1285 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
1286 a dict, keyed by the prompt number with the values of input. Raises
1285 IndexError if no history is found.
1287 IndexError if no history is found.
1286 """
1288 """
1287 if raw:
1289 if raw:
1288 input_hist = self.input_hist_raw
1290 input_hist = self.input_hist_raw
1289 else:
1291 else:
1290 input_hist = self.input_hist
1292 input_hist = self.input_hist
1291 if output:
1293 if output:
1292 output_hist = self.user_ns['Out']
1294 output_hist = self.user_ns['Out']
1293 n = len(input_hist)
1295 n = len(input_hist)
1294 if index is None:
1296 if index is None:
1295 start=0; stop=n
1297 start=0; stop=n
1296 elif isinstance(index, int):
1298 elif isinstance(index, int):
1297 start=n-index; stop=n
1299 start=n-index; stop=n
1298 elif isinstance(index, tuple) and len(index) == 2:
1300 elif isinstance(index, tuple) and len(index) == 2:
1299 start=index[0]; stop=index[1]
1301 start=index[0]; stop=index[1]
1300 else:
1302 else:
1301 raise IndexError('Not a valid index for the input history: %r'
1303 raise IndexError('Not a valid index for the input history: %r'
1302 % index)
1304 % index)
1303 hist = {}
1305 hist = {}
1304 for i in range(start, stop):
1306 for i in range(start, stop):
1305 if output:
1307 if output:
1306 hist[i] = (input_hist[i], output_hist.get(i))
1308 hist[i] = (input_hist[i], output_hist.get(i))
1307 else:
1309 else:
1308 hist[i] = input_hist[i]
1310 hist[i] = input_hist[i]
1309 if len(hist)==0:
1311 if len(hist)==0:
1310 raise IndexError('No history for range of indices: %r' % index)
1312 raise IndexError('No history for range of indices: %r' % index)
1311 return hist
1313 return hist
1312
1314
1313 #-------------------------------------------------------------------------
1315 #-------------------------------------------------------------------------
1314 # Things related to exception handling and tracebacks (not debugging)
1316 # Things related to exception handling and tracebacks (not debugging)
1315 #-------------------------------------------------------------------------
1317 #-------------------------------------------------------------------------
1316
1318
1317 def init_traceback_handlers(self, custom_exceptions):
1319 def init_traceback_handlers(self, custom_exceptions):
1318 # Syntax error handler.
1320 # Syntax error handler.
1319 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1321 self.SyntaxTB = ultratb.SyntaxTB(color_scheme='NoColor')
1320
1322
1321 # The interactive one is initialized with an offset, meaning we always
1323 # 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
1324 # want to remove the topmost item in the traceback, which is our own
1323 # internal code. Valid modes: ['Plain','Context','Verbose']
1325 # internal code. Valid modes: ['Plain','Context','Verbose']
1324 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1326 self.InteractiveTB = ultratb.AutoFormattedTB(mode = 'Plain',
1325 color_scheme='NoColor',
1327 color_scheme='NoColor',
1326 tb_offset = 1)
1328 tb_offset = 1)
1327
1329
1328 # The instance will store a pointer to the system-wide exception hook,
1330 # 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
1331 # so that runtime code (such as magics) can access it. This is because
1330 # during the read-eval loop, it may get temporarily overwritten.
1332 # during the read-eval loop, it may get temporarily overwritten.
1331 self.sys_excepthook = sys.excepthook
1333 self.sys_excepthook = sys.excepthook
1332
1334
1333 # and add any custom exception handlers the user may have specified
1335 # and add any custom exception handlers the user may have specified
1334 self.set_custom_exc(*custom_exceptions)
1336 self.set_custom_exc(*custom_exceptions)
1335
1337
1336 # Set the exception mode
1338 # Set the exception mode
1337 self.InteractiveTB.set_mode(mode=self.xmode)
1339 self.InteractiveTB.set_mode(mode=self.xmode)
1338
1340
1339 def set_custom_exc(self, exc_tuple, handler):
1341 def set_custom_exc(self, exc_tuple, handler):
1340 """set_custom_exc(exc_tuple,handler)
1342 """set_custom_exc(exc_tuple,handler)
1341
1343
1342 Set a custom exception handler, which will be called if any of the
1344 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
1345 exceptions in exc_tuple occur in the mainloop (specifically, in the
1344 runcode() method.
1346 runcode() method.
1345
1347
1346 Inputs:
1348 Inputs:
1347
1349
1348 - exc_tuple: a *tuple* of valid exceptions to call the defined
1350 - 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
1351 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
1352 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:
1353 you only want to trap a single exception, use a singleton tuple:
1352
1354
1353 exc_tuple == (MyCustomException,)
1355 exc_tuple == (MyCustomException,)
1354
1356
1355 - handler: this must be defined as a function with the following
1357 - handler: this must be defined as a function with the following
1356 basic interface::
1358 basic interface::
1357
1359
1358 def my_handler(self, etype, value, tb, tb_offset=None)
1360 def my_handler(self, etype, value, tb, tb_offset=None)
1359 ...
1361 ...
1360 # The return value must be
1362 # The return value must be
1361 return structured_traceback
1363 return structured_traceback
1362
1364
1363 This will be made into an instance method (via new.instancemethod)
1365 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
1366 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
1367 listed in the exc_tuple are caught. If the handler is None, an
1366 internal basic one is used, which just prints basic info.
1368 internal basic one is used, which just prints basic info.
1367
1369
1368 WARNING: by putting in your own exception handler into IPython's main
1370 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
1371 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."""
1372 facility should only be used if you really know what you are doing."""
1371
1373
1372 assert type(exc_tuple)==type(()) , \
1374 assert type(exc_tuple)==type(()) , \
1373 "The custom exceptions must be given AS A TUPLE."
1375 "The custom exceptions must be given AS A TUPLE."
1374
1376
1375 def dummy_handler(self,etype,value,tb):
1377 def dummy_handler(self,etype,value,tb):
1376 print '*** Simple custom exception handler ***'
1378 print '*** Simple custom exception handler ***'
1377 print 'Exception type :',etype
1379 print 'Exception type :',etype
1378 print 'Exception value:',value
1380 print 'Exception value:',value
1379 print 'Traceback :',tb
1381 print 'Traceback :',tb
1380 print 'Source code :','\n'.join(self.buffer)
1382 print 'Source code :','\n'.join(self.buffer)
1381
1383
1382 if handler is None: handler = dummy_handler
1384 if handler is None: handler = dummy_handler
1383
1385
1384 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1386 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1385 self.custom_exceptions = exc_tuple
1387 self.custom_exceptions = exc_tuple
1386
1388
1387 def excepthook(self, etype, value, tb):
1389 def excepthook(self, etype, value, tb):
1388 """One more defense for GUI apps that call sys.excepthook.
1390 """One more defense for GUI apps that call sys.excepthook.
1389
1391
1390 GUI frameworks like wxPython trap exceptions and call
1392 GUI frameworks like wxPython trap exceptions and call
1391 sys.excepthook themselves. I guess this is a feature that
1393 sys.excepthook themselves. I guess this is a feature that
1392 enables them to keep running after exceptions that would
1394 enables them to keep running after exceptions that would
1393 otherwise kill their mainloop. This is a bother for IPython
1395 otherwise kill their mainloop. This is a bother for IPython
1394 which excepts to catch all of the program exceptions with a try:
1396 which excepts to catch all of the program exceptions with a try:
1395 except: statement.
1397 except: statement.
1396
1398
1397 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1399 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
1400 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
1401 IPython crashed. In order to work around this, we can disable the
1400 CrashHandler and replace it with this excepthook instead, which prints a
1402 CrashHandler and replace it with this excepthook instead, which prints a
1401 regular traceback using our InteractiveTB. In this fashion, apps which
1403 regular traceback using our InteractiveTB. In this fashion, apps which
1402 call sys.excepthook will generate a regular-looking exception from
1404 call sys.excepthook will generate a regular-looking exception from
1403 IPython, and the CrashHandler will only be triggered by real IPython
1405 IPython, and the CrashHandler will only be triggered by real IPython
1404 crashes.
1406 crashes.
1405
1407
1406 This hook should be used sparingly, only in places which are not likely
1408 This hook should be used sparingly, only in places which are not likely
1407 to be true IPython errors.
1409 to be true IPython errors.
1408 """
1410 """
1409 self.showtraceback((etype,value,tb),tb_offset=0)
1411 self.showtraceback((etype,value,tb),tb_offset=0)
1410
1412
1411 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1413 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None,
1412 exception_only=False):
1414 exception_only=False):
1413 """Display the exception that just occurred.
1415 """Display the exception that just occurred.
1414
1416
1415 If nothing is known about the exception, this is the method which
1417 If nothing is known about the exception, this is the method which
1416 should be used throughout the code for presenting user tracebacks,
1418 should be used throughout the code for presenting user tracebacks,
1417 rather than directly invoking the InteractiveTB object.
1419 rather than directly invoking the InteractiveTB object.
1418
1420
1419 A specific showsyntaxerror() also exists, but this method can take
1421 A specific showsyntaxerror() also exists, but this method can take
1420 care of calling it if needed, so unless you are explicitly catching a
1422 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
1423 SyntaxError exception, don't try to analyze the stack manually and
1422 simply call this method."""
1424 simply call this method."""
1423
1425
1424 try:
1426 try:
1425 if exc_tuple is None:
1427 if exc_tuple is None:
1426 etype, value, tb = sys.exc_info()
1428 etype, value, tb = sys.exc_info()
1427 else:
1429 else:
1428 etype, value, tb = exc_tuple
1430 etype, value, tb = exc_tuple
1429
1431
1430 if etype is None:
1432 if etype is None:
1431 if hasattr(sys, 'last_type'):
1433 if hasattr(sys, 'last_type'):
1432 etype, value, tb = sys.last_type, sys.last_value, \
1434 etype, value, tb = sys.last_type, sys.last_value, \
1433 sys.last_traceback
1435 sys.last_traceback
1434 else:
1436 else:
1435 self.write_err('No traceback available to show.\n')
1437 self.write_err('No traceback available to show.\n')
1436 return
1438 return
1437
1439
1438 if etype is SyntaxError:
1440 if etype is SyntaxError:
1439 # Though this won't be called by syntax errors in the input
1441 # Though this won't be called by syntax errors in the input
1440 # line, there may be SyntaxError cases whith imported code.
1442 # line, there may be SyntaxError cases whith imported code.
1441 self.showsyntaxerror(filename)
1443 self.showsyntaxerror(filename)
1442 elif etype is UsageError:
1444 elif etype is UsageError:
1443 print "UsageError:", value
1445 print "UsageError:", value
1444 else:
1446 else:
1445 # WARNING: these variables are somewhat deprecated and not
1447 # WARNING: these variables are somewhat deprecated and not
1446 # necessarily safe to use in a threaded environment, but tools
1448 # necessarily safe to use in a threaded environment, but tools
1447 # like pdb depend on their existence, so let's set them. If we
1449 # 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.
1450 # find problems in the field, we'll need to revisit their use.
1449 sys.last_type = etype
1451 sys.last_type = etype
1450 sys.last_value = value
1452 sys.last_value = value
1451 sys.last_traceback = tb
1453 sys.last_traceback = tb
1452
1454
1453 if etype in self.custom_exceptions:
1455 if etype in self.custom_exceptions:
1454 # FIXME: Old custom traceback objects may just return a
1456 # FIXME: Old custom traceback objects may just return a
1455 # string, in that case we just put it into a list
1457 # string, in that case we just put it into a list
1456 stb = self.CustomTB(etype, value, tb, tb_offset)
1458 stb = self.CustomTB(etype, value, tb, tb_offset)
1457 if isinstance(ctb, basestring):
1459 if isinstance(ctb, basestring):
1458 stb = [stb]
1460 stb = [stb]
1459 else:
1461 else:
1460 if exception_only:
1462 if exception_only:
1461 stb = ['An exception has occurred, use %tb to see '
1463 stb = ['An exception has occurred, use %tb to see '
1462 'the full traceback.\n']
1464 'the full traceback.\n']
1463 stb.extend(self.InteractiveTB.get_exception_only(etype,
1465 stb.extend(self.InteractiveTB.get_exception_only(etype,
1464 value))
1466 value))
1465 else:
1467 else:
1466 stb = self.InteractiveTB.structured_traceback(etype,
1468 stb = self.InteractiveTB.structured_traceback(etype,
1467 value, tb, tb_offset=tb_offset)
1469 value, tb, tb_offset=tb_offset)
1468 # FIXME: the pdb calling should be done by us, not by
1470 # FIXME: the pdb calling should be done by us, not by
1469 # the code computing the traceback.
1471 # the code computing the traceback.
1470 if self.InteractiveTB.call_pdb:
1472 if self.InteractiveTB.call_pdb:
1471 # pdb mucks up readline, fix it back
1473 # pdb mucks up readline, fix it back
1472 self.set_readline_completer()
1474 self.set_readline_completer()
1473
1475
1474 # Actually show the traceback
1476 # Actually show the traceback
1475 self._showtraceback(etype, value, stb)
1477 self._showtraceback(etype, value, stb)
1476
1478
1477 except KeyboardInterrupt:
1479 except KeyboardInterrupt:
1478 self.write_err("\nKeyboardInterrupt\n")
1480 self.write_err("\nKeyboardInterrupt\n")
1479
1481
1480 def _showtraceback(self, etype, evalue, stb):
1482 def _showtraceback(self, etype, evalue, stb):
1481 """Actually show a traceback.
1483 """Actually show a traceback.
1482
1484
1483 Subclasses may override this method to put the traceback on a different
1485 Subclasses may override this method to put the traceback on a different
1484 place, like a side channel.
1486 place, like a side channel.
1485 """
1487 """
1486 # FIXME: this should use the proper write channels, but our test suite
1488 print >> io.Term.cout, self.InteractiveTB.stb2text(stb)
1487 # relies on it coming out of stdout...
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
2096 # We need to break up the input into executable blocks that can be run
2097 # in 'single' mode, to provide comfortable user behavior.
2097 # in 'single' mode, to provide comfortable user behavior.
2098 blocks = self.input_splitter.split_blocks(cell)
2098 blocks = self.input_splitter.split_blocks(cell)
2099
2099
2100 if not blocks:
2100 if not blocks:
2101 return
2101 return
2102
2102
2103 # Single-block input should behave like an interactive prompt
2103 # Single-block input should behave like an interactive prompt
2104 if len(blocks) == 1:
2104 if len(blocks) == 1:
2105 self.runlines(blocks[0])
2105 self.runlines(blocks[0])
2106 return
2106 return
2107
2107
2108 # In multi-block input, if the last block is a simple (one-two lines)
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
2109 # expression, run it in single mode so it produces output. Otherwise
2110 # just feed the whole thing to runcode.
2110 # just feed the whole thing to runcode.
2111 # This seems like a reasonable usability design.
2111 # This seems like a reasonable usability design.
2112 last = blocks[-1]
2112 last = blocks[-1]
2113 if len(last.splitlines()) < 2:
2113 if len(last.splitlines()) < 2:
2114 self.runcode('\n'.join(blocks[:-1]))
2114 self.runcode('\n'.join(blocks[:-1]))
2115 self.runlines(last)
2115 self.runlines(last)
2116 else:
2116 else:
2117 self.runcode(cell)
2117 self.runcode(cell)
2118
2118
2119 def runlines(self, lines, clean=False):
2119 def runlines(self, lines, clean=False):
2120 """Run a string of one or more lines of source.
2120 """Run a string of one or more lines of source.
2121
2121
2122 This method is capable of running a string containing multiple source
2122 This method is capable of running a string containing multiple source
2123 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
2124 exposes IPython's processing machinery, the given strings can contain
2124 exposes IPython's processing machinery, the given strings can contain
2125 magic calls (%magic), special shell access (!cmd), etc.
2125 magic calls (%magic), special shell access (!cmd), etc.
2126 """
2126 """
2127
2127
2128 if isinstance(lines, (list, tuple)):
2128 if isinstance(lines, (list, tuple)):
2129 lines = '\n'.join(lines)
2129 lines = '\n'.join(lines)
2130
2130
2131 if clean:
2131 if clean:
2132 lines = self._cleanup_ipy_script(lines)
2132 lines = self._cleanup_ipy_script(lines)
2133
2133
2134 # 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
2135 # interactive IPython session (via a magic, for example).
2135 # interactive IPython session (via a magic, for example).
2136 self.resetbuffer()
2136 self.resetbuffer()
2137 lines = lines.splitlines()
2137 lines = lines.splitlines()
2138 more = 0
2138 more = 0
2139 with nested(self.builtin_trap, self.display_trap):
2139 with nested(self.builtin_trap, self.display_trap):
2140 for line in lines:
2140 for line in lines:
2141 # 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
2142 # 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
2143 # is true)
2143 # is true)
2144
2144
2145 if line or more:
2145 if line or more:
2146 # push to raw history, so hist line numbers stay in sync
2146 # push to raw history, so hist line numbers stay in sync
2147 self.input_hist_raw.append(line + '\n')
2147 self.input_hist_raw.append(line + '\n')
2148 prefiltered = self.prefilter_manager.prefilter_lines(line,
2148 prefiltered = self.prefilter_manager.prefilter_lines(line,
2149 more)
2149 more)
2150 more = self.push_line(prefiltered)
2150 more = self.push_line(prefiltered)
2151 # IPython's runsource returns None if there was an error
2151 # IPython's runsource returns None if there was an error
2152 # compiling the code. This allows us to stop processing
2152 # compiling the code. This allows us to stop processing
2153 # right away, so the user gets the error message at the
2153 # right away, so the user gets the error message at the
2154 # right place.
2154 # right place.
2155 if more is None:
2155 if more is None:
2156 break
2156 break
2157 else:
2157 else:
2158 self.input_hist_raw.append("\n")
2158 self.input_hist_raw.append("\n")
2159 # 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
2160 # actually does get executed
2160 # actually does get executed
2161 if more:
2161 if more:
2162 self.push_line('\n')
2162 self.push_line('\n')
2163
2163
2164 def runsource(self, source, filename='<input>', symbol='single'):
2164 def runsource(self, source, filename='<input>', symbol='single'):
2165 """Compile and run some source in the interpreter.
2165 """Compile and run some source in the interpreter.
2166
2166
2167 Arguments are as for compile_command().
2167 Arguments are as for compile_command().
2168
2168
2169 One several things can happen:
2169 One several things can happen:
2170
2170
2171 1) The input is incorrect; compile_command() raised an
2171 1) The input is incorrect; compile_command() raised an
2172 exception (SyntaxError or OverflowError). A syntax traceback
2172 exception (SyntaxError or OverflowError). A syntax traceback
2173 will be printed by calling the showsyntaxerror() method.
2173 will be printed by calling the showsyntaxerror() method.
2174
2174
2175 2) The input is incomplete, and more input is required;
2175 2) The input is incomplete, and more input is required;
2176 compile_command() returned None. Nothing happens.
2176 compile_command() returned None. Nothing happens.
2177
2177
2178 3) The input is complete; compile_command() returned a code
2178 3) The input is complete; compile_command() returned a code
2179 object. The code is executed by calling self.runcode() (which
2179 object. The code is executed by calling self.runcode() (which
2180 also handles run-time exceptions, except for SystemExit).
2180 also handles run-time exceptions, except for SystemExit).
2181
2181
2182 The return value is:
2182 The return value is:
2183
2183
2184 - True in case 2
2184 - True in case 2
2185
2185
2186 - False in the other cases, unless an exception is raised, where
2186 - False in the other cases, unless an exception is raised, where
2187 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
2188 know whether to continue feeding input or not.
2188 know whether to continue feeding input or not.
2189
2189
2190 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
2191 sys.ps2 to prompt the next line."""
2191 sys.ps2 to prompt the next line."""
2192
2192
2193 # 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
2194 # this allows execution of indented pasted code. It is tempting
2194 # this allows execution of indented pasted code. It is tempting
2195 # 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'
2196 # directly, but this fails for more complicated scenarios
2196 # directly, but this fails for more complicated scenarios
2197 source=source.encode(self.stdin_encoding)
2197 source=source.encode(self.stdin_encoding)
2198 if source[:1] in [' ', '\t']:
2198 if source[:1] in [' ', '\t']:
2199 source = 'if 1:\n%s' % source
2199 source = 'if 1:\n%s' % source
2200
2200
2201 try:
2201 try:
2202 code = self.compile(source,filename,symbol)
2202 code = self.compile(source,filename,symbol)
2203 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2203 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2204 # Case 1
2204 # Case 1
2205 self.showsyntaxerror(filename)
2205 self.showsyntaxerror(filename)
2206 return None
2206 return None
2207
2207
2208 if code is None:
2208 if code is None:
2209 # Case 2
2209 # Case 2
2210 return True
2210 return True
2211
2211
2212 # Case 3
2212 # Case 3
2213 # We store the code object so that threaded shells and
2213 # We store the code object so that threaded shells and
2214 # custom exception handlers can access all this info if needed.
2214 # custom exception handlers can access all this info if needed.
2215 # The source corresponding to this can be obtained from the
2215 # The source corresponding to this can be obtained from the
2216 # buffer attribute as '\n'.join(self.buffer).
2216 # buffer attribute as '\n'.join(self.buffer).
2217 self.code_to_run = code
2217 self.code_to_run = code
2218 # now actually execute the code object
2218 # now actually execute the code object
2219 if self.runcode(code) == 0:
2219 if self.runcode(code) == 0:
2220 return False
2220 return False
2221 else:
2221 else:
2222 return None
2222 return None
2223
2223
2224 def runcode(self, code_obj):
2224 def runcode(self, code_obj):
2225 """Execute a code object.
2225 """Execute a code object.
2226
2226
2227 When an exception occurs, self.showtraceback() is called to display a
2227 When an exception occurs, self.showtraceback() is called to display a
2228 traceback.
2228 traceback.
2229
2229
2230 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
2231 successfully:
2231 successfully:
2232
2232
2233 - 0: successful execution.
2233 - 0: successful execution.
2234 - 1: an error occurred.
2234 - 1: an error occurred.
2235 """
2235 """
2236
2236
2237 # It's also possible that we've been fed a plain string. In that case,
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.
2238 # we must store it in the input history.
2239 if isinstance(code_obj, basestring):
2239 if isinstance(code_obj, basestring):
2240 self.input_hist_raw.append(code_obj)
2240 self.input_hist_raw.append(code_obj)
2241
2241
2242 # 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
2243 # directly, so that the IPython crash handler doesn't get triggered
2243 # directly, so that the IPython crash handler doesn't get triggered
2244 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2244 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2245
2245
2246 # 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
2247 # code (such as magics) needs access to it.
2247 # code (such as magics) needs access to it.
2248 self.sys_excepthook = old_excepthook
2248 self.sys_excepthook = old_excepthook
2249 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
2250 try:
2250 try:
2251 try:
2251 try:
2252 self.hooks.pre_runcode_hook()
2252 self.hooks.pre_runcode_hook()
2253 #rprint('Running code') # dbg
2253 #rprint('Running code') # dbg
2254 exec code_obj in self.user_global_ns, self.user_ns
2254 exec code_obj in self.user_global_ns, self.user_ns
2255 finally:
2255 finally:
2256 # Reset our crash handler in place
2256 # Reset our crash handler in place
2257 sys.excepthook = old_excepthook
2257 sys.excepthook = old_excepthook
2258 except SystemExit:
2258 except SystemExit:
2259 self.resetbuffer()
2259 self.resetbuffer()
2260 self.showtraceback(exception_only=True)
2260 self.showtraceback(exception_only=True)
2261 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)
2262 except self.custom_exceptions:
2262 except self.custom_exceptions:
2263 etype,value,tb = sys.exc_info()
2263 etype,value,tb = sys.exc_info()
2264 self.CustomTB(etype,value,tb)
2264 self.CustomTB(etype,value,tb)
2265 except:
2265 except:
2266 self.showtraceback()
2266 self.showtraceback()
2267 else:
2267 else:
2268 outflag = 0
2268 outflag = 0
2269 if softspace(sys.stdout, 0):
2269 if softspace(sys.stdout, 0):
2270 print
2270 print
2271 # Flush out code object which has been run (and source)
2271 # Flush out code object which has been run (and source)
2272 self.code_to_run = None
2272 self.code_to_run = None
2273 return outflag
2273 return outflag
2274
2274
2275 def push_line(self, line):
2275 def push_line(self, line):
2276 """Push a line to the interpreter.
2276 """Push a line to the interpreter.
2277
2277
2278 The line should not have a trailing newline; it may have
2278 The line should not have a trailing newline; it may have
2279 internal newlines. The line is appended to a buffer and the
2279 internal newlines. The line is appended to a buffer and the
2280 interpreter's runsource() method is called with the
2280 interpreter's runsource() method is called with the
2281 concatenated contents of the buffer as source. If this
2281 concatenated contents of the buffer as source. If this
2282 indicates that the command was executed or invalid, the buffer
2282 indicates that the command was executed or invalid, the buffer
2283 is reset; otherwise, the command is incomplete, and the buffer
2283 is reset; otherwise, the command is incomplete, and the buffer
2284 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
2285 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
2286 with in some way (this is the same as runsource()).
2286 with in some way (this is the same as runsource()).
2287 """
2287 """
2288
2288
2289 # autoindent management should be done here, and not in the
2289 # autoindent management should be done here, and not in the
2290 # 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
2291 # 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
2292 # push).
2292 # push).
2293
2293
2294 #print 'push line: <%s>' % line # dbg
2294 #print 'push line: <%s>' % line # dbg
2295 for subline in line.splitlines():
2295 for subline in line.splitlines():
2296 self._autoindent_update(subline)
2296 self._autoindent_update(subline)
2297 self.buffer.append(line)
2297 self.buffer.append(line)
2298 more = self.runsource('\n'.join(self.buffer), self.filename)
2298 more = self.runsource('\n'.join(self.buffer), self.filename)
2299 if not more:
2299 if not more:
2300 self.resetbuffer()
2300 self.resetbuffer()
2301 return more
2301 return more
2302
2302
2303 def resetbuffer(self):
2303 def resetbuffer(self):
2304 """Reset the input buffer."""
2304 """Reset the input buffer."""
2305 self.buffer[:] = []
2305 self.buffer[:] = []
2306
2306
2307 def _is_secondary_block_start(self, s):
2307 def _is_secondary_block_start(self, s):
2308 if not s.endswith(':'):
2308 if not s.endswith(':'):
2309 return False
2309 return False
2310 if (s.startswith('elif') or
2310 if (s.startswith('elif') or
2311 s.startswith('else') or
2311 s.startswith('else') or
2312 s.startswith('except') or
2312 s.startswith('except') or
2313 s.startswith('finally')):
2313 s.startswith('finally')):
2314 return True
2314 return True
2315
2315
2316 def _cleanup_ipy_script(self, script):
2316 def _cleanup_ipy_script(self, script):
2317 """Make a script safe for self.runlines()
2317 """Make a script safe for self.runlines()
2318
2318
2319 Currently, IPython is lines based, with blocks being detected by
2319 Currently, IPython is lines based, with blocks being detected by
2320 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
2321 not have empty lines after blocks. This script adds those empty
2321 not have empty lines after blocks. This script adds those empty
2322 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
2323 IPython.
2323 IPython.
2324 """
2324 """
2325 res = []
2325 res = []
2326 lines = script.splitlines()
2326 lines = script.splitlines()
2327 level = 0
2327 level = 0
2328
2328
2329 for l in lines:
2329 for l in lines:
2330 lstripped = l.lstrip()
2330 lstripped = l.lstrip()
2331 stripped = l.strip()
2331 stripped = l.strip()
2332 if not stripped:
2332 if not stripped:
2333 continue
2333 continue
2334 newlevel = len(l) - len(lstripped)
2334 newlevel = len(l) - len(lstripped)
2335 if level > 0 and newlevel == 0 and \
2335 if level > 0 and newlevel == 0 and \
2336 not self._is_secondary_block_start(stripped):
2336 not self._is_secondary_block_start(stripped):
2337 # add empty line
2337 # add empty line
2338 res.append('')
2338 res.append('')
2339 res.append(l)
2339 res.append(l)
2340 level = newlevel
2340 level = newlevel
2341
2341
2342 return '\n'.join(res) + '\n'
2342 return '\n'.join(res) + '\n'
2343
2343
2344 def _autoindent_update(self,line):
2344 def _autoindent_update(self,line):
2345 """Keep track of the indent level."""
2345 """Keep track of the indent level."""
2346
2346
2347 #debugx('line')
2347 #debugx('line')
2348 #debugx('self.indent_current_nsp')
2348 #debugx('self.indent_current_nsp')
2349 if self.autoindent:
2349 if self.autoindent:
2350 if line:
2350 if line:
2351 inisp = num_ini_spaces(line)
2351 inisp = num_ini_spaces(line)
2352 if inisp < self.indent_current_nsp:
2352 if inisp < self.indent_current_nsp:
2353 self.indent_current_nsp = inisp
2353 self.indent_current_nsp = inisp
2354
2354
2355 if line[-1] == ':':
2355 if line[-1] == ':':
2356 self.indent_current_nsp += 4
2356 self.indent_current_nsp += 4
2357 elif dedent_re.match(line):
2357 elif dedent_re.match(line):
2358 self.indent_current_nsp -= 4
2358 self.indent_current_nsp -= 4
2359 else:
2359 else:
2360 self.indent_current_nsp = 0
2360 self.indent_current_nsp = 0
2361
2361
2362 #-------------------------------------------------------------------------
2362 #-------------------------------------------------------------------------
2363 # Things related to GUI support and pylab
2363 # Things related to GUI support and pylab
2364 #-------------------------------------------------------------------------
2364 #-------------------------------------------------------------------------
2365
2365
2366 def enable_pylab(self, gui=None):
2366 def enable_pylab(self, gui=None):
2367 raise NotImplementedError('Implement enable_pylab in a subclass')
2367 raise NotImplementedError('Implement enable_pylab in a subclass')
2368
2368
2369 #-------------------------------------------------------------------------
2369 #-------------------------------------------------------------------------
2370 # Utilities
2370 # Utilities
2371 #-------------------------------------------------------------------------
2371 #-------------------------------------------------------------------------
2372
2372
2373 def var_expand(self,cmd,depth=0):
2373 def var_expand(self,cmd,depth=0):
2374 """Expand python variables in a string.
2374 """Expand python variables in a string.
2375
2375
2376 The depth argument indicates how many frames above the caller should
2376 The depth argument indicates how many frames above the caller should
2377 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.
2378
2378
2379 The global namespace for expansion is always the user's interactive
2379 The global namespace for expansion is always the user's interactive
2380 namespace.
2380 namespace.
2381 """
2381 """
2382
2382
2383 return str(ItplNS(cmd,
2383 return str(ItplNS(cmd,
2384 self.user_ns, # globals
2384 self.user_ns, # globals
2385 # Skip our own frame in searching for locals:
2385 # Skip our own frame in searching for locals:
2386 sys._getframe(depth+1).f_locals # locals
2386 sys._getframe(depth+1).f_locals # locals
2387 ))
2387 ))
2388
2388
2389 def mktempfile(self,data=None):
2389 def mktempfile(self,data=None):
2390 """Make a new tempfile and return its filename.
2390 """Make a new tempfile and return its filename.
2391
2391
2392 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
2393 filename internally so ipython cleans it up at exit time.
2393 filename internally so ipython cleans it up at exit time.
2394
2394
2395 Optional inputs:
2395 Optional inputs:
2396
2396
2397 - 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
2398 immediately, and the file is closed again."""
2398 immediately, and the file is closed again."""
2399
2399
2400 filename = tempfile.mktemp('.py','ipython_edit_')
2400 filename = tempfile.mktemp('.py','ipython_edit_')
2401 self.tempfiles.append(filename)
2401 self.tempfiles.append(filename)
2402
2402
2403 if data:
2403 if data:
2404 tmp_file = open(filename,'w')
2404 tmp_file = open(filename,'w')
2405 tmp_file.write(data)
2405 tmp_file.write(data)
2406 tmp_file.close()
2406 tmp_file.close()
2407 return filename
2407 return filename
2408
2408
2409 # TODO: This should be removed when Term is refactored.
2409 # TODO: This should be removed when Term is refactored.
2410 def write(self,data):
2410 def write(self,data):
2411 """Write a string to the default output"""
2411 """Write a string to the default output"""
2412 io.Term.cout.write(data)
2412 io.Term.cout.write(data)
2413
2413
2414 # TODO: This should be removed when Term is refactored.
2414 # TODO: This should be removed when Term is refactored.
2415 def write_err(self,data):
2415 def write_err(self,data):
2416 """Write a string to the default error output"""
2416 """Write a string to the default error output"""
2417 io.Term.cerr.write(data)
2417 io.Term.cerr.write(data)
2418
2418
2419 def ask_yes_no(self,prompt,default=True):
2419 def ask_yes_no(self,prompt,default=True):
2420 if self.quiet:
2420 if self.quiet:
2421 return True
2421 return True
2422 return ask_yes_no(prompt,default)
2422 return ask_yes_no(prompt,default)
2423
2423
2424 def show_usage(self):
2424 def show_usage(self):
2425 """Show a usage message"""
2425 """Show a usage message"""
2426 page.page(IPython.core.usage.interactive_usage)
2426 page.page(IPython.core.usage.interactive_usage)
2427
2427
2428 #-------------------------------------------------------------------------
2428 #-------------------------------------------------------------------------
2429 # Things related to IPython exiting
2429 # Things related to IPython exiting
2430 #-------------------------------------------------------------------------
2430 #-------------------------------------------------------------------------
2431 def atexit_operations(self):
2431 def atexit_operations(self):
2432 """This will be executed at the time of exit.
2432 """This will be executed at the time of exit.
2433
2433
2434 Cleanup operations and saving of persistent data that is done
2434 Cleanup operations and saving of persistent data that is done
2435 unconditionally by IPython should be performed here.
2435 unconditionally by IPython should be performed here.
2436
2436
2437 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
2438 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
2439 code that has the appropriate information, rather than trying to
2439 code that has the appropriate information, rather than trying to
2440 clutter
2440 clutter
2441 """
2441 """
2442 # Cleanup all tempfiles left around
2442 # Cleanup all tempfiles left around
2443 for tfile in self.tempfiles:
2443 for tfile in self.tempfiles:
2444 try:
2444 try:
2445 os.unlink(tfile)
2445 os.unlink(tfile)
2446 except OSError:
2446 except OSError:
2447 pass
2447 pass
2448
2448
2449 # Clear all user namespaces to release all references cleanly.
2449 # Clear all user namespaces to release all references cleanly.
2450 self.reset()
2450 self.reset()
2451
2451
2452 # Run user hooks
2452 # Run user hooks
2453 self.hooks.shutdown_hook()
2453 self.hooks.shutdown_hook()
2454
2454
2455 def cleanup(self):
2455 def cleanup(self):
2456 self.restore_sys_module_state()
2456 self.restore_sys_module_state()
2457
2457
2458
2458
2459 class InteractiveShellABC(object):
2459 class InteractiveShellABC(object):
2460 """An abstract base class for InteractiveShell."""
2460 """An abstract base class for InteractiveShell."""
2461 __metaclass__ = abc.ABCMeta
2461 __metaclass__ = abc.ABCMeta
2462
2462
2463 InteractiveShellABC.register(InteractiveShell)
2463 InteractiveShellABC.register(InteractiveShell)
@@ -1,170 +1,182 b''
1 """Global IPython app to support test running.
1 """Global IPython app to support test running.
2
2
3 We must start our own ipython object and heavily muck with it so that all the
3 We must start our own ipython object and heavily muck with it so that all the
4 modifications IPython makes to system behavior don't send the doctest machinery
4 modifications IPython makes to system behavior don't send the doctest machinery
5 into a fit. This code should be considered a gross hack, but it gets the job
5 into a fit. This code should be considered a gross hack, but it gets the job
6 done.
6 done.
7 """
7 """
8
9 from __future__ import absolute_import
8 from __future__ import absolute_import
9 from __future__ import print_function
10
10
11 #-----------------------------------------------------------------------------
11 #-----------------------------------------------------------------------------
12 # Copyright (C) 2009 The IPython Development Team
12 # Copyright (C) 2009-2010 The IPython Development Team
13 #
13 #
14 # Distributed under the terms of the BSD License. The full license is in
14 # Distributed under the terms of the BSD License. The full license is in
15 # the file COPYING, distributed as part of this software.
15 # the file COPYING, distributed as part of this software.
16 #-----------------------------------------------------------------------------
16 #-----------------------------------------------------------------------------
17
17
18 #-----------------------------------------------------------------------------
18 #-----------------------------------------------------------------------------
19 # Imports
19 # Imports
20 #-----------------------------------------------------------------------------
20 #-----------------------------------------------------------------------------
21
21
22 # stdlib
22 import __builtin__
23 import __builtin__
23 import commands
24 import os
24 import os
25 import sys
25 import sys
26 from types import MethodType
26
27
28 # our own
27 from . import tools
29 from . import tools
28
30
31 from IPython.frontend.terminal.interactiveshell import TerminalInteractiveShell
32
29 #-----------------------------------------------------------------------------
33 #-----------------------------------------------------------------------------
30 # Functions
34 # Functions
31 #-----------------------------------------------------------------------------
35 #-----------------------------------------------------------------------------
32
36
33 # Hack to modify the %run command so we can sync the user's namespace with the
37 # Hack to modify the %run command so we can sync the user's namespace with the
34 # test globals. Once we move over to a clean magic system, this will be done
38 # test globals. Once we move over to a clean magic system, this will be done
35 # with much less ugliness.
39 # with much less ugliness.
36
40
37 class py_file_finder(object):
41 class py_file_finder(object):
38 def __init__(self,test_filename):
42 def __init__(self,test_filename):
39 self.test_filename = test_filename
43 self.test_filename = test_filename
40
44
41 def __call__(self,name):
45 def __call__(self,name):
42 from IPython.utils.path import get_py_filename
46 from IPython.utils.path import get_py_filename
43 try:
47 try:
44 return get_py_filename(name)
48 return get_py_filename(name)
45 except IOError:
49 except IOError:
46 test_dir = os.path.dirname(self.test_filename)
50 test_dir = os.path.dirname(self.test_filename)
47 new_path = os.path.join(test_dir,name)
51 new_path = os.path.join(test_dir,name)
48 return get_py_filename(new_path)
52 return get_py_filename(new_path)
49
53
50
54
51 def _run_ns_sync(self,arg_s,runner=None):
55 def _run_ns_sync(self,arg_s,runner=None):
52 """Modified version of %run that syncs testing namespaces.
56 """Modified version of %run that syncs testing namespaces.
53
57
54 This is strictly needed for running doctests that call %run.
58 This is strictly needed for running doctests that call %run.
55 """
59 """
56 #print >> sys.stderr, 'in run_ns_sync', arg_s # dbg
60 #print('in run_ns_sync', arg_s, file=sys.stderr) # dbg
57
58 _ip = get_ipython()
59 finder = py_file_finder(arg_s)
61 finder = py_file_finder(arg_s)
60 out = _ip.magic_run_ori(arg_s,runner,finder)
62 return get_ipython().magic_run_ori(arg_s, runner, finder)
61 return out
62
63
63
64
64 class ipnsdict(dict):
65 class ipnsdict(dict):
65 """A special subclass of dict for use as an IPython namespace in doctests.
66 """A special subclass of dict for use as an IPython namespace in doctests.
66
67
67 This subclass adds a simple checkpointing capability so that when testing
68 This subclass adds a simple checkpointing capability so that when testing
68 machinery clears it (we use it as the test execution context), it doesn't
69 machinery clears it (we use it as the test execution context), it doesn't
69 get completely destroyed.
70 get completely destroyed.
70 """
71 """
71
72
72 def __init__(self,*a):
73 def __init__(self,*a):
73 dict.__init__(self,*a)
74 dict.__init__(self,*a)
74 self._savedict = {}
75 self._savedict = {}
75
76
76 def clear(self):
77 def clear(self):
77 dict.clear(self)
78 dict.clear(self)
78 self.update(self._savedict)
79 self.update(self._savedict)
79
80
80 def _checkpoint(self):
81 def _checkpoint(self):
81 self._savedict.clear()
82 self._savedict.clear()
82 self._savedict.update(self)
83 self._savedict.update(self)
83
84
84 def update(self,other):
85 def update(self,other):
85 self._checkpoint()
86 self._checkpoint()
86 dict.update(self,other)
87 dict.update(self,other)
87
88
88 # If '_' is in the namespace, python won't set it when executing code,
89 # If '_' is in the namespace, python won't set it when executing code,
89 # and we have examples that test it. So we ensure that the namespace
90 # and we have examples that test it. So we ensure that the namespace
90 # is always 'clean' of it before it's used for test code execution.
91 # is always 'clean' of it before it's used for test code execution.
91 self.pop('_',None)
92 self.pop('_',None)
92
93
93 # The builtins namespace must *always* be the real __builtin__ module,
94 # The builtins namespace must *always* be the real __builtin__ module,
94 # else weird stuff happens. The main ipython code does have provisions
95 # else weird stuff happens. The main ipython code does have provisions
95 # to ensure this after %run, but since in this class we do some
96 # to ensure this after %run, but since in this class we do some
96 # aggressive low-level cleaning of the execution namespace, we need to
97 # aggressive low-level cleaning of the execution namespace, we need to
97 # correct for that ourselves, to ensure consitency with the 'real'
98 # correct for that ourselves, to ensure consitency with the 'real'
98 # ipython.
99 # ipython.
99 self['__builtins__'] = __builtin__
100 self['__builtins__'] = __builtin__
100
101
101
102
102 def get_ipython():
103 def get_ipython():
103 # This will get replaced by the real thing once we start IPython below
104 # This will get replaced by the real thing once we start IPython below
104 return start_ipython()
105 return start_ipython()
105
106
106
107
108 # A couple of methods to override those in the running IPython to interact
109 # better with doctest (doctest captures on raw stdout, so we need to direct
110 # various types of output there otherwise it will miss them).
111
112 def xsys(self, cmd):
113 """Replace the default system call with a capturing one for doctest.
114 """
115 # We use getoutput, but we need to strip it because pexpect captures
116 # the trailing newline differently from commands.getoutput
117 print(self.getoutput(cmd).rstrip(), end='', file=sys.stdout)
118 sys.stdout.flush()
119
120
121 def _showtraceback(self, etype, evalue, stb):
122 """Print the traceback purely on stdout for doctest to capture it.
123 """
124 print(self.InteractiveTB.stb2text(stb), file=sys.stdout)
125
126
107 def start_ipython():
127 def start_ipython():
108 """Start a global IPython shell, which we need for IPython-specific syntax.
128 """Start a global IPython shell, which we need for IPython-specific syntax.
109 """
129 """
110 global get_ipython
130 global get_ipython
111
131
112 # This function should only ever run once!
132 # This function should only ever run once!
113 if hasattr(start_ipython, 'already_called'):
133 if hasattr(start_ipython, 'already_called'):
114 return
134 return
115 start_ipython.already_called = True
135 start_ipython.already_called = True
116
117 from IPython.frontend.terminal import interactiveshell
118
136
119 def xsys(cmd):
120 """Execute a command and print its output.
121
122 This is just a convenience function to replace the IPython system call
123 with one that is more doctest-friendly.
124 """
125 cmd = _ip.var_expand(cmd,depth=1)
126 sys.stdout.write(commands.getoutput(cmd))
127 sys.stdout.flush()
128
129 # Store certain global objects that IPython modifies
137 # Store certain global objects that IPython modifies
130 _displayhook = sys.displayhook
138 _displayhook = sys.displayhook
131 _excepthook = sys.excepthook
139 _excepthook = sys.excepthook
132 _main = sys.modules.get('__main__')
140 _main = sys.modules.get('__main__')
133
141
134 # Create custom argv and namespaces for our IPython to be test-friendly
142 # Create custom argv and namespaces for our IPython to be test-friendly
135 config = tools.default_config()
143 config = tools.default_config()
136
144
137 # Create and initialize our test-friendly IPython instance.
145 # Create and initialize our test-friendly IPython instance.
138 shell = interactiveshell.TerminalInteractiveShell.instance(
146 shell = TerminalInteractiveShell.instance(config=config,
139 config=config,
147 user_ns=ipnsdict(),
140 user_ns=ipnsdict(), user_global_ns={}
148 user_global_ns={}
141 )
149 )
142
150
143 # A few more tweaks needed for playing nicely with doctests...
151 # A few more tweaks needed for playing nicely with doctests...
144
152
145 # These traps are normally only active for interactive use, set them
153 # These traps are normally only active for interactive use, set them
146 # permanently since we'll be mocking interactive sessions.
154 # permanently since we'll be mocking interactive sessions.
147 shell.builtin_trap.activate()
155 shell.builtin_trap.activate()
148
156
149 # Modify the IPython system call with one that uses getoutput, so that we
157 # Modify the IPython system call with one that uses getoutput, so that we
150 # can capture subcommands and print them to Python's stdout, otherwise the
158 # can capture subcommands and print them to Python's stdout, otherwise the
151 # doctest machinery would miss them.
159 # doctest machinery would miss them.
152 shell.system = xsys
160 shell.system = MethodType(xsys, shell, TerminalInteractiveShell)
161
162
163 shell._showtraceback = MethodType(_showtraceback, shell,
164 TerminalInteractiveShell)
153
165
154 # IPython is ready, now clean up some global state...
166 # IPython is ready, now clean up some global state...
155
167
156 # Deactivate the various python system hooks added by ipython for
168 # Deactivate the various python system hooks added by ipython for
157 # interactive convenience so we don't confuse the doctest system
169 # interactive convenience so we don't confuse the doctest system
158 sys.modules['__main__'] = _main
170 sys.modules['__main__'] = _main
159 sys.displayhook = _displayhook
171 sys.displayhook = _displayhook
160 sys.excepthook = _excepthook
172 sys.excepthook = _excepthook
161
173
162 # So that ipython magics and aliases can be doctested (they work by making
174 # So that ipython magics and aliases can be doctested (they work by making
163 # a call into a global _ip object). Also make the top-level get_ipython
175 # a call into a global _ip object). Also make the top-level get_ipython
164 # now return this without recursively calling here again.
176 # now return this without recursively calling here again.
165 _ip = shell
177 _ip = shell
166 get_ipython = _ip.get_ipython
178 get_ipython = _ip.get_ipython
167 __builtin__._ip = _ip
179 __builtin__._ip = _ip
168 __builtin__.get_ipython = get_ipython
180 __builtin__.get_ipython = get_ipython
169
181
170 return _ip
182 return _ip
@@ -1,485 +1,477 b''
1 """A ZMQ-based subclass of InteractiveShell.
1 """A ZMQ-based subclass of InteractiveShell.
2
2
3 This code is meant to ease the refactoring of the base InteractiveShell into
3 This code is meant to ease the refactoring of the base InteractiveShell into
4 something with a cleaner architecture for 2-process use, without actually
4 something with a cleaner architecture for 2-process use, without actually
5 breaking InteractiveShell itself. So we're doing something a bit ugly, where
5 breaking InteractiveShell itself. So we're doing something a bit ugly, where
6 we subclass and override what we want to fix. Once this is working well, we
6 we subclass and override what we want to fix. Once this is working well, we
7 can go back to the base class and refactor the code for a cleaner inheritance
7 can go back to the base class and refactor the code for a cleaner inheritance
8 implementation that doesn't rely on so much monkeypatching.
8 implementation that doesn't rely on so much monkeypatching.
9
9
10 But this lets us maintain a fully working IPython as we develop the new
10 But this lets us maintain a fully working IPython as we develop the new
11 machinery. This should thus be thought of as scaffolding.
11 machinery. This should thus be thought of as scaffolding.
12 """
12 """
13 #-----------------------------------------------------------------------------
13 #-----------------------------------------------------------------------------
14 # Imports
14 # Imports
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16 from __future__ import print_function
16 from __future__ import print_function
17
17
18 # Stdlib
18 # Stdlib
19 import inspect
19 import inspect
20 import os
20 import os
21 import re
21 import re
22
22
23 # Our own
23 # Our own
24 from IPython.core.interactiveshell import (
24 from IPython.core.interactiveshell import (
25 InteractiveShell, InteractiveShellABC
25 InteractiveShell, InteractiveShellABC
26 )
26 )
27 from IPython.core.displayhook import DisplayHook
27 from IPython.core.displayhook import DisplayHook
28 from IPython.core.macro import Macro
28 from IPython.core.macro import Macro
29 from IPython.core.payloadpage import install_payload_page
29 from IPython.core.payloadpage import install_payload_page
30 from IPython.utils import io
30 from IPython.utils.path import get_py_filename
31 from IPython.utils.path import get_py_filename
31 from IPython.utils.text import StringTypes
32 from IPython.utils.text import StringTypes
32 from IPython.utils.traitlets import Instance, Type, Dict
33 from IPython.utils.traitlets import Instance, Type, Dict
33 from IPython.utils.warn import warn
34 from IPython.utils.warn import warn
34 from IPython.zmq.session import extract_header
35 from IPython.zmq.session import extract_header
35 from session import Session
36 from session import Session
36
37
37 #-----------------------------------------------------------------------------
38 #-----------------------------------------------------------------------------
38 # Globals and side-effects
39 # Globals and side-effects
39 #-----------------------------------------------------------------------------
40 #-----------------------------------------------------------------------------
40
41
41 # Install the payload version of page.
42 # Install the payload version of page.
42 install_payload_page()
43 install_payload_page()
43
44
44 #-----------------------------------------------------------------------------
45 #-----------------------------------------------------------------------------
45 # Functions and classes
46 # Functions and classes
46 #-----------------------------------------------------------------------------
47 #-----------------------------------------------------------------------------
47
48
48 class ZMQDisplayHook(DisplayHook):
49 class ZMQDisplayHook(DisplayHook):
49
50
50 session = Instance(Session)
51 session = Instance(Session)
51 pub_socket = Instance('zmq.Socket')
52 pub_socket = Instance('zmq.Socket')
52 parent_header = Dict({})
53 parent_header = Dict({})
53
54
54 def set_parent(self, parent):
55 def set_parent(self, parent):
55 """Set the parent for outbound messages."""
56 """Set the parent for outbound messages."""
56 self.parent_header = extract_header(parent)
57 self.parent_header = extract_header(parent)
57
58
58 def start_displayhook(self):
59 def start_displayhook(self):
59 self.msg = self.session.msg(u'pyout', {}, parent=self.parent_header)
60 self.msg = self.session.msg(u'pyout', {}, parent=self.parent_header)
60
61
61 def write_output_prompt(self):
62 def write_output_prompt(self):
62 """Write the output prompt."""
63 """Write the output prompt."""
63 if self.do_full_cache:
64 if self.do_full_cache:
64 self.msg['content']['execution_count'] = self.prompt_count
65 self.msg['content']['execution_count'] = self.prompt_count
65
66
66 def write_result_repr(self, result_repr):
67 def write_result_repr(self, result_repr):
67 self.msg['content']['data'] = result_repr
68 self.msg['content']['data'] = result_repr
68
69
69 def finish_displayhook(self):
70 def finish_displayhook(self):
70 """Finish up all displayhook activities."""
71 """Finish up all displayhook activities."""
71 self.pub_socket.send_json(self.msg)
72 self.pub_socket.send_json(self.msg)
72 self.msg = None
73 self.msg = None
73
74
74
75
75 class ZMQInteractiveShell(InteractiveShell):
76 class ZMQInteractiveShell(InteractiveShell):
76 """A subclass of InteractiveShell for ZMQ."""
77 """A subclass of InteractiveShell for ZMQ."""
77
78
78 displayhook_class = Type(ZMQDisplayHook)
79 displayhook_class = Type(ZMQDisplayHook)
79
80
80 def init_io(self):
81 # This will just use sys.stdout and sys.stderr. If you want to
82 # override sys.stdout and sys.stderr themselves, you need to do that
83 # *before* instantiating this class, because Term holds onto
84 # references to the underlying streams.
85 import IPython.utils.io
86 Term = IPython.utils.io.IOTerm()
87 IPython.utils.io.Term = Term
88
89 def magic_doctest_mode(self,parameter_s=''):
81 def magic_doctest_mode(self,parameter_s=''):
90 """Toggle doctest mode on and off.
82 """Toggle doctest mode on and off.
91
83
92 This mode is intended to make IPython behave as much as possible like a
84 This mode is intended to make IPython behave as much as possible like a
93 plain Python shell, from the perspective of how its prompts, exceptions
85 plain Python shell, from the perspective of how its prompts, exceptions
94 and output look. This makes it easy to copy and paste parts of a
86 and output look. This makes it easy to copy and paste parts of a
95 session into doctests. It does so by:
87 session into doctests. It does so by:
96
88
97 - Changing the prompts to the classic ``>>>`` ones.
89 - Changing the prompts to the classic ``>>>`` ones.
98 - Changing the exception reporting mode to 'Plain'.
90 - Changing the exception reporting mode to 'Plain'.
99 - Disabling pretty-printing of output.
91 - Disabling pretty-printing of output.
100
92
101 Note that IPython also supports the pasting of code snippets that have
93 Note that IPython also supports the pasting of code snippets that have
102 leading '>>>' and '...' prompts in them. This means that you can paste
94 leading '>>>' and '...' prompts in them. This means that you can paste
103 doctests from files or docstrings (even if they have leading
95 doctests from files or docstrings (even if they have leading
104 whitespace), and the code will execute correctly. You can then use
96 whitespace), and the code will execute correctly. You can then use
105 '%history -t' to see the translated history; this will give you the
97 '%history -t' to see the translated history; this will give you the
106 input after removal of all the leading prompts and whitespace, which
98 input after removal of all the leading prompts and whitespace, which
107 can be pasted back into an editor.
99 can be pasted back into an editor.
108
100
109 With these features, you can switch into this mode easily whenever you
101 With these features, you can switch into this mode easily whenever you
110 need to do testing and changes to doctests, without having to leave
102 need to do testing and changes to doctests, without having to leave
111 your existing IPython session.
103 your existing IPython session.
112 """
104 """
113
105
114 from IPython.utils.ipstruct import Struct
106 from IPython.utils.ipstruct import Struct
115
107
116 # Shorthands
108 # Shorthands
117 shell = self.shell
109 shell = self.shell
118 # dstore is a data store kept in the instance metadata bag to track any
110 # dstore is a data store kept in the instance metadata bag to track any
119 # changes we make, so we can undo them later.
111 # changes we make, so we can undo them later.
120 dstore = shell.meta.setdefault('doctest_mode', Struct())
112 dstore = shell.meta.setdefault('doctest_mode', Struct())
121 save_dstore = dstore.setdefault
113 save_dstore = dstore.setdefault
122
114
123 # save a few values we'll need to recover later
115 # save a few values we'll need to recover later
124 mode = save_dstore('mode', False)
116 mode = save_dstore('mode', False)
125 save_dstore('rc_pprint', shell.pprint)
117 save_dstore('rc_pprint', shell.pprint)
126 save_dstore('xmode', shell.InteractiveTB.mode)
118 save_dstore('xmode', shell.InteractiveTB.mode)
127
119
128 if mode == False:
120 if mode == False:
129 # turn on
121 # turn on
130 shell.pprint = False
122 shell.pprint = False
131 shell.magic_xmode('Plain')
123 shell.magic_xmode('Plain')
132 else:
124 else:
133 # turn off
125 # turn off
134 shell.pprint = dstore.rc_pprint
126 shell.pprint = dstore.rc_pprint
135 shell.magic_xmode(dstore.xmode)
127 shell.magic_xmode(dstore.xmode)
136
128
137 # Store new mode and inform on console
129 # Store new mode and inform on console
138 dstore.mode = bool(1-int(mode))
130 dstore.mode = bool(1-int(mode))
139 mode_label = ['OFF','ON'][dstore.mode]
131 mode_label = ['OFF','ON'][dstore.mode]
140 print('Doctest mode is:', mode_label)
132 print('Doctest mode is:', mode_label)
141
133
142 # Send the payload back so that clients can modify their prompt display
134 # Send the payload back so that clients can modify their prompt display
143 payload = dict(
135 payload = dict(
144 source='IPython.zmq.zmqshell.ZMQInteractiveShell.magic_doctest_mode',
136 source='IPython.zmq.zmqshell.ZMQInteractiveShell.magic_doctest_mode',
145 mode=dstore.mode)
137 mode=dstore.mode)
146 self.payload_manager.write_payload(payload)
138 self.payload_manager.write_payload(payload)
147
139
148 def magic_edit(self,parameter_s='',last_call=['','']):
140 def magic_edit(self,parameter_s='',last_call=['','']):
149 """Bring up an editor and execute the resulting code.
141 """Bring up an editor and execute the resulting code.
150
142
151 Usage:
143 Usage:
152 %edit [options] [args]
144 %edit [options] [args]
153
145
154 %edit runs IPython's editor hook. The default version of this hook is
146 %edit runs IPython's editor hook. The default version of this hook is
155 set to call the __IPYTHON__.rc.editor command. This is read from your
147 set to call the __IPYTHON__.rc.editor command. This is read from your
156 environment variable $EDITOR. If this isn't found, it will default to
148 environment variable $EDITOR. If this isn't found, it will default to
157 vi under Linux/Unix and to notepad under Windows. See the end of this
149 vi under Linux/Unix and to notepad under Windows. See the end of this
158 docstring for how to change the editor hook.
150 docstring for how to change the editor hook.
159
151
160 You can also set the value of this editor via the command line option
152 You can also set the value of this editor via the command line option
161 '-editor' or in your ipythonrc file. This is useful if you wish to use
153 '-editor' or in your ipythonrc file. This is useful if you wish to use
162 specifically for IPython an editor different from your typical default
154 specifically for IPython an editor different from your typical default
163 (and for Windows users who typically don't set environment variables).
155 (and for Windows users who typically don't set environment variables).
164
156
165 This command allows you to conveniently edit multi-line code right in
157 This command allows you to conveniently edit multi-line code right in
166 your IPython session.
158 your IPython session.
167
159
168 If called without arguments, %edit opens up an empty editor with a
160 If called without arguments, %edit opens up an empty editor with a
169 temporary file and will execute the contents of this file when you
161 temporary file and will execute the contents of this file when you
170 close it (don't forget to save it!).
162 close it (don't forget to save it!).
171
163
172
164
173 Options:
165 Options:
174
166
175 -n <number>: open the editor at a specified line number. By default,
167 -n <number>: open the editor at a specified line number. By default,
176 the IPython editor hook uses the unix syntax 'editor +N filename', but
168 the IPython editor hook uses the unix syntax 'editor +N filename', but
177 you can configure this by providing your own modified hook if your
169 you can configure this by providing your own modified hook if your
178 favorite editor supports line-number specifications with a different
170 favorite editor supports line-number specifications with a different
179 syntax.
171 syntax.
180
172
181 -p: this will call the editor with the same data as the previous time
173 -p: this will call the editor with the same data as the previous time
182 it was used, regardless of how long ago (in your current session) it
174 it was used, regardless of how long ago (in your current session) it
183 was.
175 was.
184
176
185 -r: use 'raw' input. This option only applies to input taken from the
177 -r: use 'raw' input. This option only applies to input taken from the
186 user's history. By default, the 'processed' history is used, so that
178 user's history. By default, the 'processed' history is used, so that
187 magics are loaded in their transformed version to valid Python. If
179 magics are loaded in their transformed version to valid Python. If
188 this option is given, the raw input as typed as the command line is
180 this option is given, the raw input as typed as the command line is
189 used instead. When you exit the editor, it will be executed by
181 used instead. When you exit the editor, it will be executed by
190 IPython's own processor.
182 IPython's own processor.
191
183
192 -x: do not execute the edited code immediately upon exit. This is
184 -x: do not execute the edited code immediately upon exit. This is
193 mainly useful if you are editing programs which need to be called with
185 mainly useful if you are editing programs which need to be called with
194 command line arguments, which you can then do using %run.
186 command line arguments, which you can then do using %run.
195
187
196
188
197 Arguments:
189 Arguments:
198
190
199 If arguments are given, the following possibilites exist:
191 If arguments are given, the following possibilites exist:
200
192
201 - The arguments are numbers or pairs of colon-separated numbers (like
193 - The arguments are numbers or pairs of colon-separated numbers (like
202 1 4:8 9). These are interpreted as lines of previous input to be
194 1 4:8 9). These are interpreted as lines of previous input to be
203 loaded into the editor. The syntax is the same of the %macro command.
195 loaded into the editor. The syntax is the same of the %macro command.
204
196
205 - If the argument doesn't start with a number, it is evaluated as a
197 - If the argument doesn't start with a number, it is evaluated as a
206 variable and its contents loaded into the editor. You can thus edit
198 variable and its contents loaded into the editor. You can thus edit
207 any string which contains python code (including the result of
199 any string which contains python code (including the result of
208 previous edits).
200 previous edits).
209
201
210 - If the argument is the name of an object (other than a string),
202 - If the argument is the name of an object (other than a string),
211 IPython will try to locate the file where it was defined and open the
203 IPython will try to locate the file where it was defined and open the
212 editor at the point where it is defined. You can use `%edit function`
204 editor at the point where it is defined. You can use `%edit function`
213 to load an editor exactly at the point where 'function' is defined,
205 to load an editor exactly at the point where 'function' is defined,
214 edit it and have the file be executed automatically.
206 edit it and have the file be executed automatically.
215
207
216 If the object is a macro (see %macro for details), this opens up your
208 If the object is a macro (see %macro for details), this opens up your
217 specified editor with a temporary file containing the macro's data.
209 specified editor with a temporary file containing the macro's data.
218 Upon exit, the macro is reloaded with the contents of the file.
210 Upon exit, the macro is reloaded with the contents of the file.
219
211
220 Note: opening at an exact line is only supported under Unix, and some
212 Note: opening at an exact line is only supported under Unix, and some
221 editors (like kedit and gedit up to Gnome 2.8) do not understand the
213 editors (like kedit and gedit up to Gnome 2.8) do not understand the
222 '+NUMBER' parameter necessary for this feature. Good editors like
214 '+NUMBER' parameter necessary for this feature. Good editors like
223 (X)Emacs, vi, jed, pico and joe all do.
215 (X)Emacs, vi, jed, pico and joe all do.
224
216
225 - If the argument is not found as a variable, IPython will look for a
217 - If the argument is not found as a variable, IPython will look for a
226 file with that name (adding .py if necessary) and load it into the
218 file with that name (adding .py if necessary) and load it into the
227 editor. It will execute its contents with execfile() when you exit,
219 editor. It will execute its contents with execfile() when you exit,
228 loading any code in the file into your interactive namespace.
220 loading any code in the file into your interactive namespace.
229
221
230 After executing your code, %edit will return as output the code you
222 After executing your code, %edit will return as output the code you
231 typed in the editor (except when it was an existing file). This way
223 typed in the editor (except when it was an existing file). This way
232 you can reload the code in further invocations of %edit as a variable,
224 you can reload the code in further invocations of %edit as a variable,
233 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
225 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
234 the output.
226 the output.
235
227
236 Note that %edit is also available through the alias %ed.
228 Note that %edit is also available through the alias %ed.
237
229
238 This is an example of creating a simple function inside the editor and
230 This is an example of creating a simple function inside the editor and
239 then modifying it. First, start up the editor:
231 then modifying it. First, start up the editor:
240
232
241 In [1]: ed
233 In [1]: ed
242 Editing... done. Executing edited code...
234 Editing... done. Executing edited code...
243 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
235 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
244
236
245 We can then call the function foo():
237 We can then call the function foo():
246
238
247 In [2]: foo()
239 In [2]: foo()
248 foo() was defined in an editing session
240 foo() was defined in an editing session
249
241
250 Now we edit foo. IPython automatically loads the editor with the
242 Now we edit foo. IPython automatically loads the editor with the
251 (temporary) file where foo() was previously defined:
243 (temporary) file where foo() was previously defined:
252
244
253 In [3]: ed foo
245 In [3]: ed foo
254 Editing... done. Executing edited code...
246 Editing... done. Executing edited code...
255
247
256 And if we call foo() again we get the modified version:
248 And if we call foo() again we get the modified version:
257
249
258 In [4]: foo()
250 In [4]: foo()
259 foo() has now been changed!
251 foo() has now been changed!
260
252
261 Here is an example of how to edit a code snippet successive
253 Here is an example of how to edit a code snippet successive
262 times. First we call the editor:
254 times. First we call the editor:
263
255
264 In [5]: ed
256 In [5]: ed
265 Editing... done. Executing edited code...
257 Editing... done. Executing edited code...
266 hello
258 hello
267 Out[5]: "print 'hello'n"
259 Out[5]: "print 'hello'n"
268
260
269 Now we call it again with the previous output (stored in _):
261 Now we call it again with the previous output (stored in _):
270
262
271 In [6]: ed _
263 In [6]: ed _
272 Editing... done. Executing edited code...
264 Editing... done. Executing edited code...
273 hello world
265 hello world
274 Out[6]: "print 'hello world'n"
266 Out[6]: "print 'hello world'n"
275
267
276 Now we call it with the output #8 (stored in _8, also as Out[8]):
268 Now we call it with the output #8 (stored in _8, also as Out[8]):
277
269
278 In [7]: ed _8
270 In [7]: ed _8
279 Editing... done. Executing edited code...
271 Editing... done. Executing edited code...
280 hello again
272 hello again
281 Out[7]: "print 'hello again'n"
273 Out[7]: "print 'hello again'n"
282
274
283
275
284 Changing the default editor hook:
276 Changing the default editor hook:
285
277
286 If you wish to write your own editor hook, you can put it in a
278 If you wish to write your own editor hook, you can put it in a
287 configuration file which you load at startup time. The default hook
279 configuration file which you load at startup time. The default hook
288 is defined in the IPython.core.hooks module, and you can use that as a
280 is defined in the IPython.core.hooks module, and you can use that as a
289 starting example for further modifications. That file also has
281 starting example for further modifications. That file also has
290 general instructions on how to set a new hook for use once you've
282 general instructions on how to set a new hook for use once you've
291 defined it."""
283 defined it."""
292
284
293 # FIXME: This function has become a convoluted mess. It needs a
285 # FIXME: This function has become a convoluted mess. It needs a
294 # ground-up rewrite with clean, simple logic.
286 # ground-up rewrite with clean, simple logic.
295
287
296 def make_filename(arg):
288 def make_filename(arg):
297 "Make a filename from the given args"
289 "Make a filename from the given args"
298 try:
290 try:
299 filename = get_py_filename(arg)
291 filename = get_py_filename(arg)
300 except IOError:
292 except IOError:
301 if args.endswith('.py'):
293 if args.endswith('.py'):
302 filename = arg
294 filename = arg
303 else:
295 else:
304 filename = None
296 filename = None
305 return filename
297 return filename
306
298
307 # custom exceptions
299 # custom exceptions
308 class DataIsObject(Exception): pass
300 class DataIsObject(Exception): pass
309
301
310 opts,args = self.parse_options(parameter_s,'prn:')
302 opts,args = self.parse_options(parameter_s,'prn:')
311 # Set a few locals from the options for convenience:
303 # Set a few locals from the options for convenience:
312 opts_p = opts.has_key('p')
304 opts_p = opts.has_key('p')
313 opts_r = opts.has_key('r')
305 opts_r = opts.has_key('r')
314
306
315 # Default line number value
307 # Default line number value
316 lineno = opts.get('n',None)
308 lineno = opts.get('n',None)
317 if lineno is not None:
309 if lineno is not None:
318 try:
310 try:
319 lineno = int(lineno)
311 lineno = int(lineno)
320 except:
312 except:
321 warn("The -n argument must be an integer.")
313 warn("The -n argument must be an integer.")
322 return
314 return
323
315
324 if opts_p:
316 if opts_p:
325 args = '_%s' % last_call[0]
317 args = '_%s' % last_call[0]
326 if not self.shell.user_ns.has_key(args):
318 if not self.shell.user_ns.has_key(args):
327 args = last_call[1]
319 args = last_call[1]
328
320
329 # use last_call to remember the state of the previous call, but don't
321 # use last_call to remember the state of the previous call, but don't
330 # let it be clobbered by successive '-p' calls.
322 # let it be clobbered by successive '-p' calls.
331 try:
323 try:
332 last_call[0] = self.shell.displayhook.prompt_count
324 last_call[0] = self.shell.displayhook.prompt_count
333 if not opts_p:
325 if not opts_p:
334 last_call[1] = parameter_s
326 last_call[1] = parameter_s
335 except:
327 except:
336 pass
328 pass
337
329
338 # by default this is done with temp files, except when the given
330 # by default this is done with temp files, except when the given
339 # arg is a filename
331 # arg is a filename
340 use_temp = 1
332 use_temp = 1
341
333
342 if re.match(r'\d',args):
334 if re.match(r'\d',args):
343 # Mode where user specifies ranges of lines, like in %macro.
335 # Mode where user specifies ranges of lines, like in %macro.
344 # This means that you can't edit files whose names begin with
336 # This means that you can't edit files whose names begin with
345 # numbers this way. Tough.
337 # numbers this way. Tough.
346 ranges = args.split()
338 ranges = args.split()
347 data = ''.join(self.extract_input_slices(ranges,opts_r))
339 data = ''.join(self.extract_input_slices(ranges,opts_r))
348 elif args.endswith('.py'):
340 elif args.endswith('.py'):
349 filename = make_filename(args)
341 filename = make_filename(args)
350 data = ''
342 data = ''
351 use_temp = 0
343 use_temp = 0
352 elif args:
344 elif args:
353 try:
345 try:
354 # Load the parameter given as a variable. If not a string,
346 # Load the parameter given as a variable. If not a string,
355 # process it as an object instead (below)
347 # process it as an object instead (below)
356
348
357 #print '*** args',args,'type',type(args) # dbg
349 #print '*** args',args,'type',type(args) # dbg
358 data = eval(args,self.shell.user_ns)
350 data = eval(args,self.shell.user_ns)
359 if not type(data) in StringTypes:
351 if not type(data) in StringTypes:
360 raise DataIsObject
352 raise DataIsObject
361
353
362 except (NameError,SyntaxError):
354 except (NameError,SyntaxError):
363 # given argument is not a variable, try as a filename
355 # given argument is not a variable, try as a filename
364 filename = make_filename(args)
356 filename = make_filename(args)
365 if filename is None:
357 if filename is None:
366 warn("Argument given (%s) can't be found as a variable "
358 warn("Argument given (%s) can't be found as a variable "
367 "or as a filename." % args)
359 "or as a filename." % args)
368 return
360 return
369
361
370 data = ''
362 data = ''
371 use_temp = 0
363 use_temp = 0
372 except DataIsObject:
364 except DataIsObject:
373
365
374 # macros have a special edit function
366 # macros have a special edit function
375 if isinstance(data,Macro):
367 if isinstance(data,Macro):
376 self._edit_macro(args,data)
368 self._edit_macro(args,data)
377 return
369 return
378
370
379 # For objects, try to edit the file where they are defined
371 # For objects, try to edit the file where they are defined
380 try:
372 try:
381 filename = inspect.getabsfile(data)
373 filename = inspect.getabsfile(data)
382 if 'fakemodule' in filename.lower() and inspect.isclass(data):
374 if 'fakemodule' in filename.lower() and inspect.isclass(data):
383 # class created by %edit? Try to find source
375 # class created by %edit? Try to find source
384 # by looking for method definitions instead, the
376 # by looking for method definitions instead, the
385 # __module__ in those classes is FakeModule.
377 # __module__ in those classes is FakeModule.
386 attrs = [getattr(data, aname) for aname in dir(data)]
378 attrs = [getattr(data, aname) for aname in dir(data)]
387 for attr in attrs:
379 for attr in attrs:
388 if not inspect.ismethod(attr):
380 if not inspect.ismethod(attr):
389 continue
381 continue
390 filename = inspect.getabsfile(attr)
382 filename = inspect.getabsfile(attr)
391 if filename and 'fakemodule' not in filename.lower():
383 if filename and 'fakemodule' not in filename.lower():
392 # change the attribute to be the edit target instead
384 # change the attribute to be the edit target instead
393 data = attr
385 data = attr
394 break
386 break
395
387
396 datafile = 1
388 datafile = 1
397 except TypeError:
389 except TypeError:
398 filename = make_filename(args)
390 filename = make_filename(args)
399 datafile = 1
391 datafile = 1
400 warn('Could not find file where `%s` is defined.\n'
392 warn('Could not find file where `%s` is defined.\n'
401 'Opening a file named `%s`' % (args,filename))
393 'Opening a file named `%s`' % (args,filename))
402 # Now, make sure we can actually read the source (if it was in
394 # Now, make sure we can actually read the source (if it was in
403 # a temp file it's gone by now).
395 # a temp file it's gone by now).
404 if datafile:
396 if datafile:
405 try:
397 try:
406 if lineno is None:
398 if lineno is None:
407 lineno = inspect.getsourcelines(data)[1]
399 lineno = inspect.getsourcelines(data)[1]
408 except IOError:
400 except IOError:
409 filename = make_filename(args)
401 filename = make_filename(args)
410 if filename is None:
402 if filename is None:
411 warn('The file `%s` where `%s` was defined cannot '
403 warn('The file `%s` where `%s` was defined cannot '
412 'be read.' % (filename,data))
404 'be read.' % (filename,data))
413 return
405 return
414 use_temp = 0
406 use_temp = 0
415 else:
407 else:
416 data = ''
408 data = ''
417
409
418 if use_temp:
410 if use_temp:
419 filename = self.shell.mktempfile(data)
411 filename = self.shell.mktempfile(data)
420 print('IPython will make a temporary file named:', filename)
412 print('IPython will make a temporary file named:', filename)
421
413
422 # Make sure we send to the client an absolute path, in case the working
414 # Make sure we send to the client an absolute path, in case the working
423 # directory of client and kernel don't match
415 # directory of client and kernel don't match
424 filename = os.path.abspath(filename)
416 filename = os.path.abspath(filename)
425
417
426 payload = {
418 payload = {
427 'source' : 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic',
419 'source' : 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic',
428 'filename' : filename,
420 'filename' : filename,
429 'line_number' : lineno
421 'line_number' : lineno
430 }
422 }
431 self.payload_manager.write_payload(payload)
423 self.payload_manager.write_payload(payload)
432
424
433 def magic_gui(self, *args, **kwargs):
425 def magic_gui(self, *args, **kwargs):
434 raise NotImplementedError('GUI support must be enabled in command line options.')
426 raise NotImplementedError('GUI support must be enabled in command line options.')
435
427
436 def magic_pylab(self, *args, **kwargs):
428 def magic_pylab(self, *args, **kwargs):
437 raise NotImplementedError('pylab support must be enabled in commandl in options.')
429 raise NotImplementedError('pylab support must be enabled in commandl in options.')
438
430
439 def auto_rewrite_input(self, cmd):
431 def auto_rewrite_input(self, cmd):
440 """Called to show the auto-rewritten input for autocall and friends.
432 """Called to show the auto-rewritten input for autocall and friends.
441
433
442 FIXME: this payload is currently not correctly processed by the
434 FIXME: this payload is currently not correctly processed by the
443 frontend.
435 frontend.
444 """
436 """
445 new = self.displayhook.prompt1.auto_rewrite() + cmd
437 new = self.displayhook.prompt1.auto_rewrite() + cmd
446 payload = dict(
438 payload = dict(
447 source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input',
439 source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input',
448 transformed_input=new,
440 transformed_input=new,
449 )
441 )
450 self.payload_manager.write_payload(payload)
442 self.payload_manager.write_payload(payload)
451
443
452 def ask_exit(self):
444 def ask_exit(self):
453 """Engage the exit actions."""
445 """Engage the exit actions."""
454 payload = dict(
446 payload = dict(
455 source='IPython.zmq.zmqshell.ZMQInteractiveShell.ask_exit',
447 source='IPython.zmq.zmqshell.ZMQInteractiveShell.ask_exit',
456 exit=True,
448 exit=True,
457 )
449 )
458 self.payload_manager.write_payload(payload)
450 self.payload_manager.write_payload(payload)
459
451
460 def _showtraceback(self, etype, evalue, stb):
452 def _showtraceback(self, etype, evalue, stb):
461
453
462 exc_content = {
454 exc_content = {
463 u'traceback' : stb,
455 u'traceback' : stb,
464 u'ename' : unicode(etype.__name__),
456 u'ename' : unicode(etype.__name__),
465 u'evalue' : unicode(evalue)
457 u'evalue' : unicode(evalue)
466 }
458 }
467
459
468 dh = self.displayhook
460 dh = self.displayhook
469 exc_msg = dh.session.msg(u'pyerr', exc_content, dh.parent_header)
461 exc_msg = dh.session.msg(u'pyerr', exc_content, dh.parent_header)
470 # Send exception info over pub socket for other clients than the caller
462 # Send exception info over pub socket for other clients than the caller
471 # to pick up
463 # to pick up
472 dh.pub_socket.send_json(exc_msg)
464 dh.pub_socket.send_json(exc_msg)
473
465
474 # FIXME - Hack: store exception info in shell object. Right now, the
466 # FIXME - Hack: store exception info in shell object. Right now, the
475 # caller is reading this info after the fact, we need to fix this logic
467 # caller is reading this info after the fact, we need to fix this logic
476 # to remove this hack. Even uglier, we need to store the error status
468 # to remove this hack. Even uglier, we need to store the error status
477 # here, because in the main loop, the logic that sets it is being
469 # here, because in the main loop, the logic that sets it is being
478 # skipped because runlines swallows the exceptions.
470 # skipped because runlines swallows the exceptions.
479 exc_content[u'status'] = u'error'
471 exc_content[u'status'] = u'error'
480 self._reply_content = exc_content
472 self._reply_content = exc_content
481 # /FIXME
473 # /FIXME
482
474
483 return exc_content
475 return exc_content
484
476
485 InteractiveShellABC.register(ZMQInteractiveShell)
477 InteractiveShellABC.register(ZMQInteractiveShell)
General Comments 0
You need to be logged in to leave comments. Login now