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