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