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