##// END OF EJS Templates
Prompts.py => core/prompts.py and imports updated.
Brian Granger -
Show More
@@ -1,2864 +1,2864 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """
2 """
3 IPython -- An enhanced Interactive Python
3 IPython -- An enhanced Interactive Python
4
4
5 Requires Python 2.4 or newer.
5 Requires Python 2.4 or newer.
6
6
7 This file contains all the classes and helper functions specific to IPython.
7 This file contains all the classes and helper functions specific to IPython.
8 """
8 """
9
9
10 #*****************************************************************************
10 #*****************************************************************************
11 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
11 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
12 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
12 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
13 #
13 #
14 # Distributed under the terms of the BSD License. The full license is in
14 # Distributed under the terms of the BSD License. The full license is in
15 # the file COPYING, distributed as part of this software.
15 # the file COPYING, distributed as part of this software.
16 #
16 #
17 # Note: this code originally subclassed code.InteractiveConsole from the
17 # Note: this code originally subclassed code.InteractiveConsole from the
18 # Python standard library. Over time, all of that class has been copied
18 # Python standard library. Over time, all of that class has been copied
19 # verbatim here for modifications which could not be accomplished by
19 # verbatim here for modifications which could not be accomplished by
20 # subclassing. At this point, there are no dependencies at all on the code
20 # subclassing. At this point, there are no dependencies at all on the code
21 # module anymore (it is not even imported). The Python License (sec. 2)
21 # module anymore (it is not even imported). The Python License (sec. 2)
22 # allows for this, but it's always nice to acknowledge credit where credit is
22 # allows for this, but it's always nice to acknowledge credit where credit is
23 # due.
23 # due.
24 #*****************************************************************************
24 #*****************************************************************************
25
25
26 #****************************************************************************
26 #****************************************************************************
27 # Modules and globals
27 # Modules and globals
28
28
29 # Python standard modules
29 # Python standard modules
30 import __main__
30 import __main__
31 import __builtin__
31 import __builtin__
32 import StringIO
32 import StringIO
33 import bdb
33 import bdb
34 import codeop
34 import codeop
35 import exceptions
35 import exceptions
36 import glob
36 import glob
37 import keyword
37 import keyword
38 import new
38 import new
39 import os
39 import os
40 import re
40 import re
41 import shutil
41 import shutil
42 import string
42 import string
43 import sys
43 import sys
44 import tempfile
44 import tempfile
45
45
46 # IPython's own modules
46 # IPython's own modules
47 #import IPython
47 #import IPython
48 from IPython import PyColorize,ultraTB
48 from IPython import PyColorize,ultraTB
49 from IPython.core import debugger, oinspect
49 from IPython.core import debugger, oinspect
50 from IPython.Extensions import pickleshare
50 from IPython.Extensions import pickleshare
51 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
51 from IPython.core.fakemodule import FakeModule, init_fakemod_dict
52 from IPython.external.Itpl import ItplNS
52 from IPython.external.Itpl import ItplNS
53 from IPython.core.logger import Logger
53 from IPython.core.logger import Logger
54 from IPython.core.magic import Magic
54 from IPython.core.magic import Magic
55 from IPython.Prompts import CachedOutput
55 from IPython.core.prompts import CachedOutput
56 from IPython.utils.ipstruct import Struct
56 from IPython.utils.ipstruct import Struct
57 from IPython.lib.backgroundjobs import BackgroundJobManager
57 from IPython.lib.backgroundjobs import BackgroundJobManager
58 from IPython.utils.genutils import *
58 from IPython.utils.genutils import *
59 from IPython.strdispatch import StrDispatch
59 from IPython.strdispatch import StrDispatch
60 from IPython.core import ipapi
60 from IPython.core import ipapi
61 import IPython.core.history
61 import IPython.core.history
62 import IPython.prefilter as prefilter
62 import IPython.core.prefilter as prefilter
63 import IPython.shadowns
63 import IPython.shadowns
64 # Globals
64 # Globals
65
65
66 # store the builtin raw_input globally, and use this always, in case user code
66 # store the builtin raw_input globally, and use this always, in case user code
67 # overwrites it (like wx.py.PyShell does)
67 # overwrites it (like wx.py.PyShell does)
68 raw_input_original = raw_input
68 raw_input_original = raw_input
69
69
70 # compiled regexps for autoindent management
70 # compiled regexps for autoindent management
71 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
71 dedent_re = re.compile(r'^\s+raise|^\s+return|^\s+pass')
72
72
73
73
74 #****************************************************************************
74 #****************************************************************************
75 # Some utility function definitions
75 # Some utility function definitions
76
76
77 ini_spaces_re = re.compile(r'^(\s+)')
77 ini_spaces_re = re.compile(r'^(\s+)')
78
78
79 def num_ini_spaces(strng):
79 def num_ini_spaces(strng):
80 """Return the number of initial spaces in a string"""
80 """Return the number of initial spaces in a string"""
81
81
82 ini_spaces = ini_spaces_re.match(strng)
82 ini_spaces = ini_spaces_re.match(strng)
83 if ini_spaces:
83 if ini_spaces:
84 return ini_spaces.end()
84 return ini_spaces.end()
85 else:
85 else:
86 return 0
86 return 0
87
87
88 def softspace(file, newvalue):
88 def softspace(file, newvalue):
89 """Copied from code.py, to remove the dependency"""
89 """Copied from code.py, to remove the dependency"""
90
90
91 oldvalue = 0
91 oldvalue = 0
92 try:
92 try:
93 oldvalue = file.softspace
93 oldvalue = file.softspace
94 except AttributeError:
94 except AttributeError:
95 pass
95 pass
96 try:
96 try:
97 file.softspace = newvalue
97 file.softspace = newvalue
98 except (AttributeError, TypeError):
98 except (AttributeError, TypeError):
99 # "attribute-less object" or "read-only attributes"
99 # "attribute-less object" or "read-only attributes"
100 pass
100 pass
101 return oldvalue
101 return oldvalue
102
102
103
103
104 def user_setup(ipythondir,rc_suffix,mode='install',interactive=True):
104 def user_setup(ipythondir,rc_suffix,mode='install',interactive=True):
105 """Install or upgrade the user configuration directory.
105 """Install or upgrade the user configuration directory.
106
106
107 Can be called when running for the first time or to upgrade the user's
107 Can be called when running for the first time or to upgrade the user's
108 .ipython/ directory.
108 .ipython/ directory.
109
109
110 Parameters
110 Parameters
111 ----------
111 ----------
112 ipythondir : path
112 ipythondir : path
113 The directory to be used for installation/upgrade. In 'install' mode,
113 The directory to be used for installation/upgrade. In 'install' mode,
114 if this path already exists, the function exits immediately.
114 if this path already exists, the function exits immediately.
115
115
116 rc_suffix : str
116 rc_suffix : str
117 Extension for the config files. On *nix platforms it is typically the
117 Extension for the config files. On *nix platforms it is typically the
118 empty string, while Windows normally uses '.ini'.
118 empty string, while Windows normally uses '.ini'.
119
119
120 mode : str, optional
120 mode : str, optional
121 Valid modes are 'install' and 'upgrade'.
121 Valid modes are 'install' and 'upgrade'.
122
122
123 interactive : bool, optional
123 interactive : bool, optional
124 If False, do not wait for user input on any errors. Normally after
124 If False, do not wait for user input on any errors. Normally after
125 printing its status information, this function waits for the user to
125 printing its status information, this function waits for the user to
126 hit Return before proceeding. This is because the default use case is
126 hit Return before proceeding. This is because the default use case is
127 when first installing the IPython configuration, so we want the user to
127 when first installing the IPython configuration, so we want the user to
128 acknowledge the initial message, which contains some useful
128 acknowledge the initial message, which contains some useful
129 information.
129 information.
130 """
130 """
131
131
132 # For automatic use, deactivate all i/o
132 # For automatic use, deactivate all i/o
133 if interactive:
133 if interactive:
134 def wait():
134 def wait():
135 try:
135 try:
136 raw_input("Please press <RETURN> to start IPython.")
136 raw_input("Please press <RETURN> to start IPython.")
137 except EOFError:
137 except EOFError:
138 print >> Term.cout
138 print >> Term.cout
139 print '*'*70
139 print '*'*70
140
140
141 def printf(s):
141 def printf(s):
142 print s
142 print s
143 else:
143 else:
144 wait = lambda : None
144 wait = lambda : None
145 printf = lambda s : None
145 printf = lambda s : None
146
146
147 # Install mode should be re-entrant: if the install dir already exists,
147 # Install mode should be re-entrant: if the install dir already exists,
148 # bail out cleanly.
148 # bail out cleanly.
149 # XXX. This is too hasty to return. We need to check to make sure that
149 # XXX. This is too hasty to return. We need to check to make sure that
150 # all the expected config files and directories are actually there. We
150 # all the expected config files and directories are actually there. We
151 # currently have a failure mode if someone deletes a needed config file
151 # currently have a failure mode if someone deletes a needed config file
152 # but still has the ipythondir.
152 # but still has the ipythondir.
153 if mode == 'install' and os.path.isdir(ipythondir):
153 if mode == 'install' and os.path.isdir(ipythondir):
154 return
154 return
155
155
156 cwd = os.getcwd() # remember where we started
156 cwd = os.getcwd() # remember where we started
157 glb = glob.glob
157 glb = glob.glob
158
158
159 printf('*'*70)
159 printf('*'*70)
160 if mode == 'install':
160 if mode == 'install':
161 printf(
161 printf(
162 """Welcome to IPython. I will try to create a personal configuration directory
162 """Welcome to IPython. I will try to create a personal configuration directory
163 where you can customize many aspects of IPython's functionality in:\n""")
163 where you can customize many aspects of IPython's functionality in:\n""")
164 else:
164 else:
165 printf('I am going to upgrade your configuration in:')
165 printf('I am going to upgrade your configuration in:')
166
166
167 printf(ipythondir)
167 printf(ipythondir)
168
168
169 rcdirend = os.path.join('IPython','UserConfig')
169 rcdirend = os.path.join('IPython','UserConfig')
170 cfg = lambda d: os.path.join(d,rcdirend)
170 cfg = lambda d: os.path.join(d,rcdirend)
171 try:
171 try:
172 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
172 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
173 printf("Initializing from configuration: %s" % rcdir)
173 printf("Initializing from configuration: %s" % rcdir)
174 except IndexError:
174 except IndexError:
175 warning = """
175 warning = """
176 Installation error. IPython's directory was not found.
176 Installation error. IPython's directory was not found.
177
177
178 Check the following:
178 Check the following:
179
179
180 The ipython/IPython directory should be in a directory belonging to your
180 The ipython/IPython directory should be in a directory belonging to your
181 PYTHONPATH environment variable (that is, it should be in a directory
181 PYTHONPATH environment variable (that is, it should be in a directory
182 belonging to sys.path). You can copy it explicitly there or just link to it.
182 belonging to sys.path). You can copy it explicitly there or just link to it.
183
183
184 IPython will create a minimal default configuration for you.
184 IPython will create a minimal default configuration for you.
185
185
186 """
186 """
187 warn(warning)
187 warn(warning)
188 wait()
188 wait()
189
189
190 if sys.platform =='win32':
190 if sys.platform =='win32':
191 inif = 'ipythonrc.ini'
191 inif = 'ipythonrc.ini'
192 else:
192 else:
193 inif = 'ipythonrc'
193 inif = 'ipythonrc'
194 minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults',
194 minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults',
195 inif : '# intentionally left blank' }
195 inif : '# intentionally left blank' }
196 os.makedirs(ipythondir, mode = 0777)
196 os.makedirs(ipythondir, mode = 0777)
197 for f, cont in minimal_setup.items():
197 for f, cont in minimal_setup.items():
198 # In 2.5, this can be more cleanly done using 'with'
198 # In 2.5, this can be more cleanly done using 'with'
199 fobj = file(ipythondir + '/' + f,'w')
199 fobj = file(ipythondir + '/' + f,'w')
200 fobj.write(cont)
200 fobj.write(cont)
201 fobj.close()
201 fobj.close()
202
202
203 return
203 return
204
204
205 if mode == 'install':
205 if mode == 'install':
206 try:
206 try:
207 shutil.copytree(rcdir,ipythondir)
207 shutil.copytree(rcdir,ipythondir)
208 os.chdir(ipythondir)
208 os.chdir(ipythondir)
209 rc_files = glb("ipythonrc*")
209 rc_files = glb("ipythonrc*")
210 for rc_file in rc_files:
210 for rc_file in rc_files:
211 os.rename(rc_file,rc_file+rc_suffix)
211 os.rename(rc_file,rc_file+rc_suffix)
212 except:
212 except:
213 warning = """
213 warning = """
214
214
215 There was a problem with the installation:
215 There was a problem with the installation:
216 %s
216 %s
217 Try to correct it or contact the developers if you think it's a bug.
217 Try to correct it or contact the developers if you think it's a bug.
218 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
218 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
219 warn(warning)
219 warn(warning)
220 wait()
220 wait()
221 return
221 return
222
222
223 elif mode == 'upgrade':
223 elif mode == 'upgrade':
224 try:
224 try:
225 os.chdir(ipythondir)
225 os.chdir(ipythondir)
226 except:
226 except:
227 printf("""
227 printf("""
228 Can not upgrade: changing to directory %s failed. Details:
228 Can not upgrade: changing to directory %s failed. Details:
229 %s
229 %s
230 """ % (ipythondir,sys.exc_info()[1]) )
230 """ % (ipythondir,sys.exc_info()[1]) )
231 wait()
231 wait()
232 return
232 return
233 else:
233 else:
234 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
234 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
235 for new_full_path in sources:
235 for new_full_path in sources:
236 new_filename = os.path.basename(new_full_path)
236 new_filename = os.path.basename(new_full_path)
237 if new_filename.startswith('ipythonrc'):
237 if new_filename.startswith('ipythonrc'):
238 new_filename = new_filename + rc_suffix
238 new_filename = new_filename + rc_suffix
239 # The config directory should only contain files, skip any
239 # The config directory should only contain files, skip any
240 # directories which may be there (like CVS)
240 # directories which may be there (like CVS)
241 if os.path.isdir(new_full_path):
241 if os.path.isdir(new_full_path):
242 continue
242 continue
243 if os.path.exists(new_filename):
243 if os.path.exists(new_filename):
244 old_file = new_filename+'.old'
244 old_file = new_filename+'.old'
245 if os.path.exists(old_file):
245 if os.path.exists(old_file):
246 os.remove(old_file)
246 os.remove(old_file)
247 os.rename(new_filename,old_file)
247 os.rename(new_filename,old_file)
248 shutil.copy(new_full_path,new_filename)
248 shutil.copy(new_full_path,new_filename)
249 else:
249 else:
250 raise ValueError('unrecognized mode for install: %r' % mode)
250 raise ValueError('unrecognized mode for install: %r' % mode)
251
251
252 # Fix line-endings to those native to each platform in the config
252 # Fix line-endings to those native to each platform in the config
253 # directory.
253 # directory.
254 try:
254 try:
255 os.chdir(ipythondir)
255 os.chdir(ipythondir)
256 except:
256 except:
257 printf("""
257 printf("""
258 Problem: changing to directory %s failed.
258 Problem: changing to directory %s failed.
259 Details:
259 Details:
260 %s
260 %s
261
261
262 Some configuration files may have incorrect line endings. This should not
262 Some configuration files may have incorrect line endings. This should not
263 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) )
263 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1]) )
264 wait()
264 wait()
265 else:
265 else:
266 for fname in glb('ipythonrc*'):
266 for fname in glb('ipythonrc*'):
267 try:
267 try:
268 native_line_ends(fname,backup=0)
268 native_line_ends(fname,backup=0)
269 except IOError:
269 except IOError:
270 pass
270 pass
271
271
272 if mode == 'install':
272 if mode == 'install':
273 printf("""
273 printf("""
274 Successful installation!
274 Successful installation!
275
275
276 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
276 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
277 IPython manual (there are both HTML and PDF versions supplied with the
277 IPython manual (there are both HTML and PDF versions supplied with the
278 distribution) to make sure that your system environment is properly configured
278 distribution) to make sure that your system environment is properly configured
279 to take advantage of IPython's features.
279 to take advantage of IPython's features.
280
280
281 Important note: the configuration system has changed! The old system is
281 Important note: the configuration system has changed! The old system is
282 still in place, but its setting may be partly overridden by the settings in
282 still in place, but its setting may be partly overridden by the settings in
283 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
283 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
284 if some of the new settings bother you.
284 if some of the new settings bother you.
285
285
286 """)
286 """)
287 else:
287 else:
288 printf("""
288 printf("""
289 Successful upgrade!
289 Successful upgrade!
290
290
291 All files in your directory:
291 All files in your directory:
292 %(ipythondir)s
292 %(ipythondir)s
293 which would have been overwritten by the upgrade were backed up with a .old
293 which would have been overwritten by the upgrade were backed up with a .old
294 extension. If you had made particular customizations in those files you may
294 extension. If you had made particular customizations in those files you may
295 want to merge them back into the new files.""" % locals() )
295 want to merge them back into the new files.""" % locals() )
296 wait()
296 wait()
297 os.chdir(cwd)
297 os.chdir(cwd)
298
298
299 #****************************************************************************
299 #****************************************************************************
300 # Local use exceptions
300 # Local use exceptions
301 class SpaceInInput(exceptions.Exception): pass
301 class SpaceInInput(exceptions.Exception): pass
302
302
303
303
304 #****************************************************************************
304 #****************************************************************************
305 # Local use classes
305 # Local use classes
306 class Bunch: pass
306 class Bunch: pass
307
307
308 class Undefined: pass
308 class Undefined: pass
309
309
310 class Quitter(object):
310 class Quitter(object):
311 """Simple class to handle exit, similar to Python 2.5's.
311 """Simple class to handle exit, similar to Python 2.5's.
312
312
313 It handles exiting in an ipython-safe manner, which the one in Python 2.5
313 It handles exiting in an ipython-safe manner, which the one in Python 2.5
314 doesn't do (obviously, since it doesn't know about ipython)."""
314 doesn't do (obviously, since it doesn't know about ipython)."""
315
315
316 def __init__(self,shell,name):
316 def __init__(self,shell,name):
317 self.shell = shell
317 self.shell = shell
318 self.name = name
318 self.name = name
319
319
320 def __repr__(self):
320 def __repr__(self):
321 return 'Type %s() to exit.' % self.name
321 return 'Type %s() to exit.' % self.name
322 __str__ = __repr__
322 __str__ = __repr__
323
323
324 def __call__(self):
324 def __call__(self):
325 self.shell.exit()
325 self.shell.exit()
326
326
327 class InputList(list):
327 class InputList(list):
328 """Class to store user input.
328 """Class to store user input.
329
329
330 It's basically a list, but slices return a string instead of a list, thus
330 It's basically a list, but slices return a string instead of a list, thus
331 allowing things like (assuming 'In' is an instance):
331 allowing things like (assuming 'In' is an instance):
332
332
333 exec In[4:7]
333 exec In[4:7]
334
334
335 or
335 or
336
336
337 exec In[5:9] + In[14] + In[21:25]"""
337 exec In[5:9] + In[14] + In[21:25]"""
338
338
339 def __getslice__(self,i,j):
339 def __getslice__(self,i,j):
340 return ''.join(list.__getslice__(self,i,j))
340 return ''.join(list.__getslice__(self,i,j))
341
341
342 class SyntaxTB(ultraTB.ListTB):
342 class SyntaxTB(ultraTB.ListTB):
343 """Extension which holds some state: the last exception value"""
343 """Extension which holds some state: the last exception value"""
344
344
345 def __init__(self,color_scheme = 'NoColor'):
345 def __init__(self,color_scheme = 'NoColor'):
346 ultraTB.ListTB.__init__(self,color_scheme)
346 ultraTB.ListTB.__init__(self,color_scheme)
347 self.last_syntax_error = None
347 self.last_syntax_error = None
348
348
349 def __call__(self, etype, value, elist):
349 def __call__(self, etype, value, elist):
350 self.last_syntax_error = value
350 self.last_syntax_error = value
351 ultraTB.ListTB.__call__(self,etype,value,elist)
351 ultraTB.ListTB.__call__(self,etype,value,elist)
352
352
353 def clear_err_state(self):
353 def clear_err_state(self):
354 """Return the current error state and clear it"""
354 """Return the current error state and clear it"""
355 e = self.last_syntax_error
355 e = self.last_syntax_error
356 self.last_syntax_error = None
356 self.last_syntax_error = None
357 return e
357 return e
358
358
359 #****************************************************************************
359 #****************************************************************************
360 # Main IPython class
360 # Main IPython class
361
361
362 # FIXME: the Magic class is a mixin for now, and will unfortunately remain so
362 # FIXME: the Magic class is a mixin for now, and will unfortunately remain so
363 # until a full rewrite is made. I've cleaned all cross-class uses of
363 # until a full rewrite is made. I've cleaned all cross-class uses of
364 # attributes and methods, but too much user code out there relies on the
364 # attributes and methods, but too much user code out there relies on the
365 # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage.
365 # equlity %foo == __IP.magic_foo, so I can't actually remove the mixin usage.
366 #
366 #
367 # But at least now, all the pieces have been separated and we could, in
367 # But at least now, all the pieces have been separated and we could, in
368 # principle, stop using the mixin. This will ease the transition to the
368 # principle, stop using the mixin. This will ease the transition to the
369 # chainsaw branch.
369 # chainsaw branch.
370
370
371 # For reference, the following is the list of 'self.foo' uses in the Magic
371 # For reference, the following is the list of 'self.foo' uses in the Magic
372 # class as of 2005-12-28. These are names we CAN'T use in the main ipython
372 # class as of 2005-12-28. These are names we CAN'T use in the main ipython
373 # class, to prevent clashes.
373 # class, to prevent clashes.
374
374
375 # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind',
375 # ['self.__class__', 'self.__dict__', 'self._inspect', 'self._ofind',
376 # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic',
376 # 'self.arg_err', 'self.extract_input', 'self.format_', 'self.lsmagic',
377 # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell',
377 # 'self.magic_', 'self.options_table', 'self.parse', 'self.shell',
378 # 'self.value']
378 # 'self.value']
379
379
380 class InteractiveShell(object,Magic):
380 class InteractiveShell(object,Magic):
381 """An enhanced console for Python."""
381 """An enhanced console for Python."""
382
382
383 # class attribute to indicate whether the class supports threads or not.
383 # class attribute to indicate whether the class supports threads or not.
384 # Subclasses with thread support should override this as needed.
384 # Subclasses with thread support should override this as needed.
385 isthreaded = False
385 isthreaded = False
386
386
387 def __init__(self,name,usage=None,rc=Struct(opts=None,args=None),
387 def __init__(self,name,usage=None,rc=Struct(opts=None,args=None),
388 user_ns=None,user_global_ns=None,banner2='',
388 user_ns=None,user_global_ns=None,banner2='',
389 custom_exceptions=((),None),embedded=False):
389 custom_exceptions=((),None),embedded=False):
390
390
391 # log system
391 # log system
392 self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate')
392 self.logger = Logger(self,logfname='ipython_log.py',logmode='rotate')
393
393
394 # Job manager (for jobs run as background threads)
394 # Job manager (for jobs run as background threads)
395 self.jobs = BackgroundJobManager()
395 self.jobs = BackgroundJobManager()
396
396
397 # Store the actual shell's name
397 # Store the actual shell's name
398 self.name = name
398 self.name = name
399 self.more = False
399 self.more = False
400
400
401 # We need to know whether the instance is meant for embedding, since
401 # We need to know whether the instance is meant for embedding, since
402 # global/local namespaces need to be handled differently in that case
402 # global/local namespaces need to be handled differently in that case
403 self.embedded = embedded
403 self.embedded = embedded
404 if embedded:
404 if embedded:
405 # Control variable so users can, from within the embedded instance,
405 # Control variable so users can, from within the embedded instance,
406 # permanently deactivate it.
406 # permanently deactivate it.
407 self.embedded_active = True
407 self.embedded_active = True
408
408
409 # command compiler
409 # command compiler
410 self.compile = codeop.CommandCompiler()
410 self.compile = codeop.CommandCompiler()
411
411
412 # User input buffer
412 # User input buffer
413 self.buffer = []
413 self.buffer = []
414
414
415 # Default name given in compilation of code
415 # Default name given in compilation of code
416 self.filename = '<ipython console>'
416 self.filename = '<ipython console>'
417
417
418 # Install our own quitter instead of the builtins. For python2.3-2.4,
418 # Install our own quitter instead of the builtins. For python2.3-2.4,
419 # this brings in behavior like 2.5, and for 2.5 it's identical.
419 # this brings in behavior like 2.5, and for 2.5 it's identical.
420 __builtin__.exit = Quitter(self,'exit')
420 __builtin__.exit = Quitter(self,'exit')
421 __builtin__.quit = Quitter(self,'quit')
421 __builtin__.quit = Quitter(self,'quit')
422
422
423 # Make an empty namespace, which extension writers can rely on both
423 # Make an empty namespace, which extension writers can rely on both
424 # existing and NEVER being used by ipython itself. This gives them a
424 # existing and NEVER being used by ipython itself. This gives them a
425 # convenient location for storing additional information and state
425 # convenient location for storing additional information and state
426 # their extensions may require, without fear of collisions with other
426 # their extensions may require, without fear of collisions with other
427 # ipython names that may develop later.
427 # ipython names that may develop later.
428 self.meta = Struct()
428 self.meta = Struct()
429
429
430 # Create the namespace where the user will operate. user_ns is
430 # Create the namespace where the user will operate. user_ns is
431 # normally the only one used, and it is passed to the exec calls as
431 # normally the only one used, and it is passed to the exec calls as
432 # the locals argument. But we do carry a user_global_ns namespace
432 # the locals argument. But we do carry a user_global_ns namespace
433 # given as the exec 'globals' argument, This is useful in embedding
433 # given as the exec 'globals' argument, This is useful in embedding
434 # situations where the ipython shell opens in a context where the
434 # situations where the ipython shell opens in a context where the
435 # distinction between locals and globals is meaningful. For
435 # distinction between locals and globals is meaningful. For
436 # non-embedded contexts, it is just the same object as the user_ns dict.
436 # non-embedded contexts, it is just the same object as the user_ns dict.
437
437
438 # FIXME. For some strange reason, __builtins__ is showing up at user
438 # FIXME. For some strange reason, __builtins__ is showing up at user
439 # level as a dict instead of a module. This is a manual fix, but I
439 # level as a dict instead of a module. This is a manual fix, but I
440 # should really track down where the problem is coming from. Alex
440 # should really track down where the problem is coming from. Alex
441 # Schmolck reported this problem first.
441 # Schmolck reported this problem first.
442
442
443 # A useful post by Alex Martelli on this topic:
443 # A useful post by Alex Martelli on this topic:
444 # Re: inconsistent value from __builtins__
444 # Re: inconsistent value from __builtins__
445 # Von: Alex Martelli <aleaxit@yahoo.com>
445 # Von: Alex Martelli <aleaxit@yahoo.com>
446 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
446 # Datum: Freitag 01 Oktober 2004 04:45:34 nachmittags/abends
447 # Gruppen: comp.lang.python
447 # Gruppen: comp.lang.python
448
448
449 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
449 # Michael Hohn <hohn@hooknose.lbl.gov> wrote:
450 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
450 # > >>> print type(builtin_check.get_global_binding('__builtins__'))
451 # > <type 'dict'>
451 # > <type 'dict'>
452 # > >>> print type(__builtins__)
452 # > >>> print type(__builtins__)
453 # > <type 'module'>
453 # > <type 'module'>
454 # > Is this difference in return value intentional?
454 # > Is this difference in return value intentional?
455
455
456 # Well, it's documented that '__builtins__' can be either a dictionary
456 # Well, it's documented that '__builtins__' can be either a dictionary
457 # or a module, and it's been that way for a long time. Whether it's
457 # or a module, and it's been that way for a long time. Whether it's
458 # intentional (or sensible), I don't know. In any case, the idea is
458 # intentional (or sensible), I don't know. In any case, the idea is
459 # that if you need to access the built-in namespace directly, you
459 # that if you need to access the built-in namespace directly, you
460 # should start with "import __builtin__" (note, no 's') which will
460 # should start with "import __builtin__" (note, no 's') which will
461 # definitely give you a module. Yeah, it's somewhat confusing:-(.
461 # definitely give you a module. Yeah, it's somewhat confusing:-(.
462
462
463 # These routines return properly built dicts as needed by the rest of
463 # These routines return properly built dicts as needed by the rest of
464 # the code, and can also be used by extension writers to generate
464 # the code, and can also be used by extension writers to generate
465 # properly initialized namespaces.
465 # properly initialized namespaces.
466 user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns,
466 user_ns, user_global_ns = ipapi.make_user_namespaces(user_ns,
467 user_global_ns)
467 user_global_ns)
468
468
469 # Assign namespaces
469 # Assign namespaces
470 # This is the namespace where all normal user variables live
470 # This is the namespace where all normal user variables live
471 self.user_ns = user_ns
471 self.user_ns = user_ns
472 self.user_global_ns = user_global_ns
472 self.user_global_ns = user_global_ns
473
473
474 # An auxiliary namespace that checks what parts of the user_ns were
474 # An auxiliary namespace that checks what parts of the user_ns were
475 # loaded at startup, so we can list later only variables defined in
475 # loaded at startup, so we can list later only variables defined in
476 # actual interactive use. Since it is always a subset of user_ns, it
476 # actual interactive use. Since it is always a subset of user_ns, it
477 # doesn't need to be seaparately tracked in the ns_table
477 # doesn't need to be seaparately tracked in the ns_table
478 self.user_config_ns = {}
478 self.user_config_ns = {}
479
479
480 # A namespace to keep track of internal data structures to prevent
480 # A namespace to keep track of internal data structures to prevent
481 # them from cluttering user-visible stuff. Will be updated later
481 # them from cluttering user-visible stuff. Will be updated later
482 self.internal_ns = {}
482 self.internal_ns = {}
483
483
484 # Namespace of system aliases. Each entry in the alias
484 # Namespace of system aliases. Each entry in the alias
485 # table must be a 2-tuple of the form (N,name), where N is the number
485 # table must be a 2-tuple of the form (N,name), where N is the number
486 # of positional arguments of the alias.
486 # of positional arguments of the alias.
487 self.alias_table = {}
487 self.alias_table = {}
488
488
489 # Now that FakeModule produces a real module, we've run into a nasty
489 # Now that FakeModule produces a real module, we've run into a nasty
490 # problem: after script execution (via %run), the module where the user
490 # problem: after script execution (via %run), the module where the user
491 # code ran is deleted. Now that this object is a true module (needed
491 # code ran is deleted. Now that this object is a true module (needed
492 # so docetst and other tools work correctly), the Python module
492 # so docetst and other tools work correctly), the Python module
493 # teardown mechanism runs over it, and sets to None every variable
493 # teardown mechanism runs over it, and sets to None every variable
494 # present in that module. Top-level references to objects from the
494 # present in that module. Top-level references to objects from the
495 # script survive, because the user_ns is updated with them. However,
495 # script survive, because the user_ns is updated with them. However,
496 # calling functions defined in the script that use other things from
496 # calling functions defined in the script that use other things from
497 # the script will fail, because the function's closure had references
497 # the script will fail, because the function's closure had references
498 # to the original objects, which are now all None. So we must protect
498 # to the original objects, which are now all None. So we must protect
499 # these modules from deletion by keeping a cache.
499 # these modules from deletion by keeping a cache.
500 #
500 #
501 # To avoid keeping stale modules around (we only need the one from the
501 # To avoid keeping stale modules around (we only need the one from the
502 # last run), we use a dict keyed with the full path to the script, so
502 # last run), we use a dict keyed with the full path to the script, so
503 # only the last version of the module is held in the cache. Note,
503 # only the last version of the module is held in the cache. Note,
504 # however, that we must cache the module *namespace contents* (their
504 # however, that we must cache the module *namespace contents* (their
505 # __dict__). Because if we try to cache the actual modules, old ones
505 # __dict__). Because if we try to cache the actual modules, old ones
506 # (uncached) could be destroyed while still holding references (such as
506 # (uncached) could be destroyed while still holding references (such as
507 # those held by GUI objects that tend to be long-lived)>
507 # those held by GUI objects that tend to be long-lived)>
508 #
508 #
509 # The %reset command will flush this cache. See the cache_main_mod()
509 # The %reset command will flush this cache. See the cache_main_mod()
510 # and clear_main_mod_cache() methods for details on use.
510 # and clear_main_mod_cache() methods for details on use.
511
511
512 # This is the cache used for 'main' namespaces
512 # This is the cache used for 'main' namespaces
513 self._main_ns_cache = {}
513 self._main_ns_cache = {}
514 # And this is the single instance of FakeModule whose __dict__ we keep
514 # And this is the single instance of FakeModule whose __dict__ we keep
515 # copying and clearing for reuse on each %run
515 # copying and clearing for reuse on each %run
516 self._user_main_module = FakeModule()
516 self._user_main_module = FakeModule()
517
517
518 # A table holding all the namespaces IPython deals with, so that
518 # A table holding all the namespaces IPython deals with, so that
519 # introspection facilities can search easily.
519 # introspection facilities can search easily.
520 self.ns_table = {'user':user_ns,
520 self.ns_table = {'user':user_ns,
521 'user_global':user_global_ns,
521 'user_global':user_global_ns,
522 'alias':self.alias_table,
522 'alias':self.alias_table,
523 'internal':self.internal_ns,
523 'internal':self.internal_ns,
524 'builtin':__builtin__.__dict__
524 'builtin':__builtin__.__dict__
525 }
525 }
526
526
527 # Similarly, track all namespaces where references can be held and that
527 # Similarly, track all namespaces where references can be held and that
528 # we can safely clear (so it can NOT include builtin). This one can be
528 # we can safely clear (so it can NOT include builtin). This one can be
529 # a simple list.
529 # a simple list.
530 self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns,
530 self.ns_refs_table = [ user_ns, user_global_ns, self.user_config_ns,
531 self.alias_table, self.internal_ns,
531 self.alias_table, self.internal_ns,
532 self._main_ns_cache ]
532 self._main_ns_cache ]
533
533
534 # We need to insert into sys.modules something that looks like a
534 # We need to insert into sys.modules something that looks like a
535 # module but which accesses the IPython namespace, for shelve and
535 # module but which accesses the IPython namespace, for shelve and
536 # pickle to work interactively. Normally they rely on getting
536 # pickle to work interactively. Normally they rely on getting
537 # everything out of __main__, but for embedding purposes each IPython
537 # everything out of __main__, but for embedding purposes each IPython
538 # instance has its own private namespace, so we can't go shoving
538 # instance has its own private namespace, so we can't go shoving
539 # everything into __main__.
539 # everything into __main__.
540
540
541 # note, however, that we should only do this for non-embedded
541 # note, however, that we should only do this for non-embedded
542 # ipythons, which really mimic the __main__.__dict__ with their own
542 # ipythons, which really mimic the __main__.__dict__ with their own
543 # namespace. Embedded instances, on the other hand, should not do
543 # namespace. Embedded instances, on the other hand, should not do
544 # this because they need to manage the user local/global namespaces
544 # this because they need to manage the user local/global namespaces
545 # only, but they live within a 'normal' __main__ (meaning, they
545 # only, but they live within a 'normal' __main__ (meaning, they
546 # shouldn't overtake the execution environment of the script they're
546 # shouldn't overtake the execution environment of the script they're
547 # embedded in).
547 # embedded in).
548
548
549 if not embedded:
549 if not embedded:
550 try:
550 try:
551 main_name = self.user_ns['__name__']
551 main_name = self.user_ns['__name__']
552 except KeyError:
552 except KeyError:
553 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
553 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
554 else:
554 else:
555 #print "pickle hack in place" # dbg
555 #print "pickle hack in place" # dbg
556 #print 'main_name:',main_name # dbg
556 #print 'main_name:',main_name # dbg
557 sys.modules[main_name] = FakeModule(self.user_ns)
557 sys.modules[main_name] = FakeModule(self.user_ns)
558
558
559 # List of input with multi-line handling.
559 # List of input with multi-line handling.
560 self.input_hist = InputList()
560 self.input_hist = InputList()
561 # This one will hold the 'raw' input history, without any
561 # This one will hold the 'raw' input history, without any
562 # pre-processing. This will allow users to retrieve the input just as
562 # pre-processing. This will allow users to retrieve the input just as
563 # it was exactly typed in by the user, with %hist -r.
563 # it was exactly typed in by the user, with %hist -r.
564 self.input_hist_raw = InputList()
564 self.input_hist_raw = InputList()
565
565
566 # list of visited directories
566 # list of visited directories
567 try:
567 try:
568 self.dir_hist = [os.getcwd()]
568 self.dir_hist = [os.getcwd()]
569 except OSError:
569 except OSError:
570 self.dir_hist = []
570 self.dir_hist = []
571
571
572 # dict of output history
572 # dict of output history
573 self.output_hist = {}
573 self.output_hist = {}
574
574
575 # Get system encoding at startup time. Certain terminals (like Emacs
575 # Get system encoding at startup time. Certain terminals (like Emacs
576 # under Win32 have it set to None, and we need to have a known valid
576 # under Win32 have it set to None, and we need to have a known valid
577 # encoding to use in the raw_input() method
577 # encoding to use in the raw_input() method
578 try:
578 try:
579 self.stdin_encoding = sys.stdin.encoding or 'ascii'
579 self.stdin_encoding = sys.stdin.encoding or 'ascii'
580 except AttributeError:
580 except AttributeError:
581 self.stdin_encoding = 'ascii'
581 self.stdin_encoding = 'ascii'
582
582
583 # dict of things NOT to alias (keywords, builtins and some magics)
583 # dict of things NOT to alias (keywords, builtins and some magics)
584 no_alias = {}
584 no_alias = {}
585 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
585 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
586 for key in keyword.kwlist + no_alias_magics:
586 for key in keyword.kwlist + no_alias_magics:
587 no_alias[key] = 1
587 no_alias[key] = 1
588 no_alias.update(__builtin__.__dict__)
588 no_alias.update(__builtin__.__dict__)
589 self.no_alias = no_alias
589 self.no_alias = no_alias
590
590
591 # Object variable to store code object waiting execution. This is
591 # Object variable to store code object waiting execution. This is
592 # used mainly by the multithreaded shells, but it can come in handy in
592 # used mainly by the multithreaded shells, but it can come in handy in
593 # other situations. No need to use a Queue here, since it's a single
593 # other situations. No need to use a Queue here, since it's a single
594 # item which gets cleared once run.
594 # item which gets cleared once run.
595 self.code_to_run = None
595 self.code_to_run = None
596
596
597 # escapes for automatic behavior on the command line
597 # escapes for automatic behavior on the command line
598 self.ESC_SHELL = '!'
598 self.ESC_SHELL = '!'
599 self.ESC_SH_CAP = '!!'
599 self.ESC_SH_CAP = '!!'
600 self.ESC_HELP = '?'
600 self.ESC_HELP = '?'
601 self.ESC_MAGIC = '%'
601 self.ESC_MAGIC = '%'
602 self.ESC_QUOTE = ','
602 self.ESC_QUOTE = ','
603 self.ESC_QUOTE2 = ';'
603 self.ESC_QUOTE2 = ';'
604 self.ESC_PAREN = '/'
604 self.ESC_PAREN = '/'
605
605
606 # And their associated handlers
606 # And their associated handlers
607 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
607 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
608 self.ESC_QUOTE : self.handle_auto,
608 self.ESC_QUOTE : self.handle_auto,
609 self.ESC_QUOTE2 : self.handle_auto,
609 self.ESC_QUOTE2 : self.handle_auto,
610 self.ESC_MAGIC : self.handle_magic,
610 self.ESC_MAGIC : self.handle_magic,
611 self.ESC_HELP : self.handle_help,
611 self.ESC_HELP : self.handle_help,
612 self.ESC_SHELL : self.handle_shell_escape,
612 self.ESC_SHELL : self.handle_shell_escape,
613 self.ESC_SH_CAP : self.handle_shell_escape,
613 self.ESC_SH_CAP : self.handle_shell_escape,
614 }
614 }
615
615
616 # class initializations
616 # class initializations
617 Magic.__init__(self,self)
617 Magic.__init__(self,self)
618
618
619 # Python source parser/formatter for syntax highlighting
619 # Python source parser/formatter for syntax highlighting
620 pyformat = PyColorize.Parser().format
620 pyformat = PyColorize.Parser().format
621 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
621 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
622
622
623 # hooks holds pointers used for user-side customizations
623 # hooks holds pointers used for user-side customizations
624 self.hooks = Struct()
624 self.hooks = Struct()
625
625
626 self.strdispatchers = {}
626 self.strdispatchers = {}
627
627
628 # Set all default hooks, defined in the IPython.hooks module.
628 # Set all default hooks, defined in the IPython.hooks module.
629 import IPython.core.hooks
629 import IPython.core.hooks
630 hooks = IPython.core.hooks
630 hooks = IPython.core.hooks
631 for hook_name in hooks.__all__:
631 for hook_name in hooks.__all__:
632 # default hooks have priority 100, i.e. low; user hooks should have
632 # default hooks have priority 100, i.e. low; user hooks should have
633 # 0-100 priority
633 # 0-100 priority
634 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
634 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
635 #print "bound hook",hook_name
635 #print "bound hook",hook_name
636
636
637 # Flag to mark unconditional exit
637 # Flag to mark unconditional exit
638 self.exit_now = False
638 self.exit_now = False
639
639
640 self.usage_min = """\
640 self.usage_min = """\
641 An enhanced console for Python.
641 An enhanced console for Python.
642 Some of its features are:
642 Some of its features are:
643 - Readline support if the readline library is present.
643 - Readline support if the readline library is present.
644 - Tab completion in the local namespace.
644 - Tab completion in the local namespace.
645 - Logging of input, see command-line options.
645 - Logging of input, see command-line options.
646 - System shell escape via ! , eg !ls.
646 - System shell escape via ! , eg !ls.
647 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
647 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
648 - Keeps track of locally defined variables via %who, %whos.
648 - Keeps track of locally defined variables via %who, %whos.
649 - Show object information with a ? eg ?x or x? (use ?? for more info).
649 - Show object information with a ? eg ?x or x? (use ?? for more info).
650 """
650 """
651 if usage: self.usage = usage
651 if usage: self.usage = usage
652 else: self.usage = self.usage_min
652 else: self.usage = self.usage_min
653
653
654 # Storage
654 # Storage
655 self.rc = rc # This will hold all configuration information
655 self.rc = rc # This will hold all configuration information
656 self.pager = 'less'
656 self.pager = 'less'
657 # temporary files used for various purposes. Deleted at exit.
657 # temporary files used for various purposes. Deleted at exit.
658 self.tempfiles = []
658 self.tempfiles = []
659
659
660 # Keep track of readline usage (later set by init_readline)
660 # Keep track of readline usage (later set by init_readline)
661 self.has_readline = False
661 self.has_readline = False
662
662
663 # template for logfile headers. It gets resolved at runtime by the
663 # template for logfile headers. It gets resolved at runtime by the
664 # logstart method.
664 # logstart method.
665 self.loghead_tpl = \
665 self.loghead_tpl = \
666 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
666 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
667 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
667 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
668 #log# opts = %s
668 #log# opts = %s
669 #log# args = %s
669 #log# args = %s
670 #log# It is safe to make manual edits below here.
670 #log# It is safe to make manual edits below here.
671 #log#-----------------------------------------------------------------------
671 #log#-----------------------------------------------------------------------
672 """
672 """
673 # for pushd/popd management
673 # for pushd/popd management
674 try:
674 try:
675 self.home_dir = get_home_dir()
675 self.home_dir = get_home_dir()
676 except HomeDirError,msg:
676 except HomeDirError,msg:
677 fatal(msg)
677 fatal(msg)
678
678
679 self.dir_stack = []
679 self.dir_stack = []
680
680
681 # Functions to call the underlying shell.
681 # Functions to call the underlying shell.
682
682
683 # The first is similar to os.system, but it doesn't return a value,
683 # The first is similar to os.system, but it doesn't return a value,
684 # and it allows interpolation of variables in the user's namespace.
684 # and it allows interpolation of variables in the user's namespace.
685 self.system = lambda cmd: \
685 self.system = lambda cmd: \
686 self.hooks.shell_hook(self.var_expand(cmd,depth=2))
686 self.hooks.shell_hook(self.var_expand(cmd,depth=2))
687
687
688 # These are for getoutput and getoutputerror:
688 # These are for getoutput and getoutputerror:
689 self.getoutput = lambda cmd: \
689 self.getoutput = lambda cmd: \
690 getoutput(self.var_expand(cmd,depth=2),
690 getoutput(self.var_expand(cmd,depth=2),
691 header=self.rc.system_header,
691 header=self.rc.system_header,
692 verbose=self.rc.system_verbose)
692 verbose=self.rc.system_verbose)
693
693
694 self.getoutputerror = lambda cmd: \
694 self.getoutputerror = lambda cmd: \
695 getoutputerror(self.var_expand(cmd,depth=2),
695 getoutputerror(self.var_expand(cmd,depth=2),
696 header=self.rc.system_header,
696 header=self.rc.system_header,
697 verbose=self.rc.system_verbose)
697 verbose=self.rc.system_verbose)
698
698
699
699
700 # keep track of where we started running (mainly for crash post-mortem)
700 # keep track of where we started running (mainly for crash post-mortem)
701 self.starting_dir = os.getcwd()
701 self.starting_dir = os.getcwd()
702
702
703 # Various switches which can be set
703 # Various switches which can be set
704 self.CACHELENGTH = 5000 # this is cheap, it's just text
704 self.CACHELENGTH = 5000 # this is cheap, it's just text
705 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
705 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
706 self.banner2 = banner2
706 self.banner2 = banner2
707
707
708 # TraceBack handlers:
708 # TraceBack handlers:
709
709
710 # Syntax error handler.
710 # Syntax error handler.
711 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
711 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
712
712
713 # The interactive one is initialized with an offset, meaning we always
713 # The interactive one is initialized with an offset, meaning we always
714 # want to remove the topmost item in the traceback, which is our own
714 # want to remove the topmost item in the traceback, which is our own
715 # internal code. Valid modes: ['Plain','Context','Verbose']
715 # internal code. Valid modes: ['Plain','Context','Verbose']
716 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
716 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
717 color_scheme='NoColor',
717 color_scheme='NoColor',
718 tb_offset = 1)
718 tb_offset = 1)
719
719
720 # IPython itself shouldn't crash. This will produce a detailed
720 # IPython itself shouldn't crash. This will produce a detailed
721 # post-mortem if it does. But we only install the crash handler for
721 # post-mortem if it does. But we only install the crash handler for
722 # non-threaded shells, the threaded ones use a normal verbose reporter
722 # non-threaded shells, the threaded ones use a normal verbose reporter
723 # and lose the crash handler. This is because exceptions in the main
723 # and lose the crash handler. This is because exceptions in the main
724 # thread (such as in GUI code) propagate directly to sys.excepthook,
724 # thread (such as in GUI code) propagate directly to sys.excepthook,
725 # and there's no point in printing crash dumps for every user exception.
725 # and there's no point in printing crash dumps for every user exception.
726 if self.isthreaded:
726 if self.isthreaded:
727 ipCrashHandler = ultraTB.FormattedTB()
727 ipCrashHandler = ultraTB.FormattedTB()
728 else:
728 else:
729 from IPython.core import crashhandler
729 from IPython.core import crashhandler
730 ipCrashHandler = crashhandler.IPythonCrashHandler(self)
730 ipCrashHandler = crashhandler.IPythonCrashHandler(self)
731 self.set_crash_handler(ipCrashHandler)
731 self.set_crash_handler(ipCrashHandler)
732
732
733 # and add any custom exception handlers the user may have specified
733 # and add any custom exception handlers the user may have specified
734 self.set_custom_exc(*custom_exceptions)
734 self.set_custom_exc(*custom_exceptions)
735
735
736 # indentation management
736 # indentation management
737 self.autoindent = False
737 self.autoindent = False
738 self.indent_current_nsp = 0
738 self.indent_current_nsp = 0
739
739
740 # Make some aliases automatically
740 # Make some aliases automatically
741 # Prepare list of shell aliases to auto-define
741 # Prepare list of shell aliases to auto-define
742 if os.name == 'posix':
742 if os.name == 'posix':
743 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
743 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
744 'mv mv -i','rm rm -i','cp cp -i',
744 'mv mv -i','rm rm -i','cp cp -i',
745 'cat cat','less less','clear clear',
745 'cat cat','less less','clear clear',
746 # a better ls
746 # a better ls
747 'ls ls -F',
747 'ls ls -F',
748 # long ls
748 # long ls
749 'll ls -lF')
749 'll ls -lF')
750 # Extra ls aliases with color, which need special treatment on BSD
750 # Extra ls aliases with color, which need special treatment on BSD
751 # variants
751 # variants
752 ls_extra = ( # color ls
752 ls_extra = ( # color ls
753 'lc ls -F -o --color',
753 'lc ls -F -o --color',
754 # ls normal files only
754 # ls normal files only
755 'lf ls -F -o --color %l | grep ^-',
755 'lf ls -F -o --color %l | grep ^-',
756 # ls symbolic links
756 # ls symbolic links
757 'lk ls -F -o --color %l | grep ^l',
757 'lk ls -F -o --color %l | grep ^l',
758 # directories or links to directories,
758 # directories or links to directories,
759 'ldir ls -F -o --color %l | grep /$',
759 'ldir ls -F -o --color %l | grep /$',
760 # things which are executable
760 # things which are executable
761 'lx ls -F -o --color %l | grep ^-..x',
761 'lx ls -F -o --color %l | grep ^-..x',
762 )
762 )
763 # The BSDs don't ship GNU ls, so they don't understand the
763 # The BSDs don't ship GNU ls, so they don't understand the
764 # --color switch out of the box
764 # --color switch out of the box
765 if 'bsd' in sys.platform:
765 if 'bsd' in sys.platform:
766 ls_extra = ( # ls normal files only
766 ls_extra = ( # ls normal files only
767 'lf ls -lF | grep ^-',
767 'lf ls -lF | grep ^-',
768 # ls symbolic links
768 # ls symbolic links
769 'lk ls -lF | grep ^l',
769 'lk ls -lF | grep ^l',
770 # directories or links to directories,
770 # directories or links to directories,
771 'ldir ls -lF | grep /$',
771 'ldir ls -lF | grep /$',
772 # things which are executable
772 # things which are executable
773 'lx ls -lF | grep ^-..x',
773 'lx ls -lF | grep ^-..x',
774 )
774 )
775 auto_alias = auto_alias + ls_extra
775 auto_alias = auto_alias + ls_extra
776 elif os.name in ['nt','dos']:
776 elif os.name in ['nt','dos']:
777 auto_alias = ('ls dir /on',
777 auto_alias = ('ls dir /on',
778 'ddir dir /ad /on', 'ldir dir /ad /on',
778 'ddir dir /ad /on', 'ldir dir /ad /on',
779 'mkdir mkdir','rmdir rmdir','echo echo',
779 'mkdir mkdir','rmdir rmdir','echo echo',
780 'ren ren','cls cls','copy copy')
780 'ren ren','cls cls','copy copy')
781 else:
781 else:
782 auto_alias = ()
782 auto_alias = ()
783 self.auto_alias = [s.split(None,1) for s in auto_alias]
783 self.auto_alias = [s.split(None,1) for s in auto_alias]
784
784
785 # Produce a public API instance
785 # Produce a public API instance
786 self.api = ipapi.IPApi(self)
786 self.api = ipapi.IPApi(self)
787
787
788 # Initialize all user-visible namespaces
788 # Initialize all user-visible namespaces
789 self.init_namespaces()
789 self.init_namespaces()
790
790
791 # Call the actual (public) initializer
791 # Call the actual (public) initializer
792 self.init_auto_alias()
792 self.init_auto_alias()
793
793
794 # track which builtins we add, so we can clean up later
794 # track which builtins we add, so we can clean up later
795 self.builtins_added = {}
795 self.builtins_added = {}
796 # This method will add the necessary builtins for operation, but
796 # This method will add the necessary builtins for operation, but
797 # tracking what it did via the builtins_added dict.
797 # tracking what it did via the builtins_added dict.
798
798
799 #TODO: remove this, redundant
799 #TODO: remove this, redundant
800 self.add_builtins()
800 self.add_builtins()
801 # end __init__
801 # end __init__
802
802
803 def var_expand(self,cmd,depth=0):
803 def var_expand(self,cmd,depth=0):
804 """Expand python variables in a string.
804 """Expand python variables in a string.
805
805
806 The depth argument indicates how many frames above the caller should
806 The depth argument indicates how many frames above the caller should
807 be walked to look for the local namespace where to expand variables.
807 be walked to look for the local namespace where to expand variables.
808
808
809 The global namespace for expansion is always the user's interactive
809 The global namespace for expansion is always the user's interactive
810 namespace.
810 namespace.
811 """
811 """
812
812
813 return str(ItplNS(cmd,
813 return str(ItplNS(cmd,
814 self.user_ns, # globals
814 self.user_ns, # globals
815 # Skip our own frame in searching for locals:
815 # Skip our own frame in searching for locals:
816 sys._getframe(depth+1).f_locals # locals
816 sys._getframe(depth+1).f_locals # locals
817 ))
817 ))
818
818
819 def pre_config_initialization(self):
819 def pre_config_initialization(self):
820 """Pre-configuration init method
820 """Pre-configuration init method
821
821
822 This is called before the configuration files are processed to
822 This is called before the configuration files are processed to
823 prepare the services the config files might need.
823 prepare the services the config files might need.
824
824
825 self.rc already has reasonable default values at this point.
825 self.rc already has reasonable default values at this point.
826 """
826 """
827 rc = self.rc
827 rc = self.rc
828 try:
828 try:
829 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
829 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
830 except exceptions.UnicodeDecodeError:
830 except exceptions.UnicodeDecodeError:
831 print "Your ipythondir can't be decoded to unicode!"
831 print "Your ipythondir can't be decoded to unicode!"
832 print "Please set HOME environment variable to something that"
832 print "Please set HOME environment variable to something that"
833 print r"only has ASCII characters, e.g. c:\home"
833 print r"only has ASCII characters, e.g. c:\home"
834 print "Now it is",rc.ipythondir
834 print "Now it is",rc.ipythondir
835 sys.exit()
835 sys.exit()
836 self.shadowhist = IPython.core.history.ShadowHist(self.db)
836 self.shadowhist = IPython.core.history.ShadowHist(self.db)
837
837
838 def post_config_initialization(self):
838 def post_config_initialization(self):
839 """Post configuration init method
839 """Post configuration init method
840
840
841 This is called after the configuration files have been processed to
841 This is called after the configuration files have been processed to
842 'finalize' the initialization."""
842 'finalize' the initialization."""
843
843
844 rc = self.rc
844 rc = self.rc
845
845
846 # Object inspector
846 # Object inspector
847 self.inspector = oinspect.Inspector(oinspect.InspectColors,
847 self.inspector = oinspect.Inspector(oinspect.InspectColors,
848 PyColorize.ANSICodeColors,
848 PyColorize.ANSICodeColors,
849 'NoColor',
849 'NoColor',
850 rc.object_info_string_level)
850 rc.object_info_string_level)
851
851
852 self.rl_next_input = None
852 self.rl_next_input = None
853 self.rl_do_indent = False
853 self.rl_do_indent = False
854 # Load readline proper
854 # Load readline proper
855 if rc.readline:
855 if rc.readline:
856 self.init_readline()
856 self.init_readline()
857
857
858 # local shortcut, this is used a LOT
858 # local shortcut, this is used a LOT
859 self.log = self.logger.log
859 self.log = self.logger.log
860
860
861 # Initialize cache, set in/out prompts and printing system
861 # Initialize cache, set in/out prompts and printing system
862 self.outputcache = CachedOutput(self,
862 self.outputcache = CachedOutput(self,
863 rc.cache_size,
863 rc.cache_size,
864 rc.pprint,
864 rc.pprint,
865 input_sep = rc.separate_in,
865 input_sep = rc.separate_in,
866 output_sep = rc.separate_out,
866 output_sep = rc.separate_out,
867 output_sep2 = rc.separate_out2,
867 output_sep2 = rc.separate_out2,
868 ps1 = rc.prompt_in1,
868 ps1 = rc.prompt_in1,
869 ps2 = rc.prompt_in2,
869 ps2 = rc.prompt_in2,
870 ps_out = rc.prompt_out,
870 ps_out = rc.prompt_out,
871 pad_left = rc.prompts_pad_left)
871 pad_left = rc.prompts_pad_left)
872
872
873 # user may have over-ridden the default print hook:
873 # user may have over-ridden the default print hook:
874 try:
874 try:
875 self.outputcache.__class__.display = self.hooks.display
875 self.outputcache.__class__.display = self.hooks.display
876 except AttributeError:
876 except AttributeError:
877 pass
877 pass
878
878
879 # I don't like assigning globally to sys, because it means when
879 # I don't like assigning globally to sys, because it means when
880 # embedding instances, each embedded instance overrides the previous
880 # embedding instances, each embedded instance overrides the previous
881 # choice. But sys.displayhook seems to be called internally by exec,
881 # choice. But sys.displayhook seems to be called internally by exec,
882 # so I don't see a way around it. We first save the original and then
882 # so I don't see a way around it. We first save the original and then
883 # overwrite it.
883 # overwrite it.
884 self.sys_displayhook = sys.displayhook
884 self.sys_displayhook = sys.displayhook
885 sys.displayhook = self.outputcache
885 sys.displayhook = self.outputcache
886
886
887 # Do a proper resetting of doctest, including the necessary displayhook
887 # Do a proper resetting of doctest, including the necessary displayhook
888 # monkeypatching
888 # monkeypatching
889 try:
889 try:
890 doctest_reload()
890 doctest_reload()
891 except ImportError:
891 except ImportError:
892 warn("doctest module does not exist.")
892 warn("doctest module does not exist.")
893
893
894 # Set user colors (don't do it in the constructor above so that it
894 # Set user colors (don't do it in the constructor above so that it
895 # doesn't crash if colors option is invalid)
895 # doesn't crash if colors option is invalid)
896 self.magic_colors(rc.colors)
896 self.magic_colors(rc.colors)
897
897
898 # Set calling of pdb on exceptions
898 # Set calling of pdb on exceptions
899 self.call_pdb = rc.pdb
899 self.call_pdb = rc.pdb
900
900
901 # Load user aliases
901 # Load user aliases
902 for alias in rc.alias:
902 for alias in rc.alias:
903 self.magic_alias(alias)
903 self.magic_alias(alias)
904
904
905 self.hooks.late_startup_hook()
905 self.hooks.late_startup_hook()
906
906
907 for cmd in self.rc.autoexec:
907 for cmd in self.rc.autoexec:
908 #print "autoexec>",cmd #dbg
908 #print "autoexec>",cmd #dbg
909 self.api.runlines(cmd)
909 self.api.runlines(cmd)
910
910
911 batchrun = False
911 batchrun = False
912 for batchfile in [path(arg) for arg in self.rc.args
912 for batchfile in [path(arg) for arg in self.rc.args
913 if arg.lower().endswith('.ipy')]:
913 if arg.lower().endswith('.ipy')]:
914 if not batchfile.isfile():
914 if not batchfile.isfile():
915 print "No such batch file:", batchfile
915 print "No such batch file:", batchfile
916 continue
916 continue
917 self.api.runlines(batchfile.text())
917 self.api.runlines(batchfile.text())
918 batchrun = True
918 batchrun = True
919 # without -i option, exit after running the batch file
919 # without -i option, exit after running the batch file
920 if batchrun and not self.rc.interact:
920 if batchrun and not self.rc.interact:
921 self.ask_exit()
921 self.ask_exit()
922
922
923 def init_namespaces(self):
923 def init_namespaces(self):
924 """Initialize all user-visible namespaces to their minimum defaults.
924 """Initialize all user-visible namespaces to their minimum defaults.
925
925
926 Certain history lists are also initialized here, as they effectively
926 Certain history lists are also initialized here, as they effectively
927 act as user namespaces.
927 act as user namespaces.
928
928
929 Note
929 Note
930 ----
930 ----
931 All data structures here are only filled in, they are NOT reset by this
931 All data structures here are only filled in, they are NOT reset by this
932 method. If they were not empty before, data will simply be added to
932 method. If they were not empty before, data will simply be added to
933 therm.
933 therm.
934 """
934 """
935 # The user namespace MUST have a pointer to the shell itself.
935 # The user namespace MUST have a pointer to the shell itself.
936 self.user_ns[self.name] = self
936 self.user_ns[self.name] = self
937
937
938 # Store the public api instance
938 # Store the public api instance
939 self.user_ns['_ip'] = self.api
939 self.user_ns['_ip'] = self.api
940
940
941 # make global variables for user access to the histories
941 # make global variables for user access to the histories
942 self.user_ns['_ih'] = self.input_hist
942 self.user_ns['_ih'] = self.input_hist
943 self.user_ns['_oh'] = self.output_hist
943 self.user_ns['_oh'] = self.output_hist
944 self.user_ns['_dh'] = self.dir_hist
944 self.user_ns['_dh'] = self.dir_hist
945
945
946 # user aliases to input and output histories
946 # user aliases to input and output histories
947 self.user_ns['In'] = self.input_hist
947 self.user_ns['In'] = self.input_hist
948 self.user_ns['Out'] = self.output_hist
948 self.user_ns['Out'] = self.output_hist
949
949
950 self.user_ns['_sh'] = IPython.shadowns
950 self.user_ns['_sh'] = IPython.shadowns
951
951
952 # Fill the history zero entry, user counter starts at 1
952 # Fill the history zero entry, user counter starts at 1
953 self.input_hist.append('\n')
953 self.input_hist.append('\n')
954 self.input_hist_raw.append('\n')
954 self.input_hist_raw.append('\n')
955
955
956 def add_builtins(self):
956 def add_builtins(self):
957 """Store ipython references into the builtin namespace.
957 """Store ipython references into the builtin namespace.
958
958
959 Some parts of ipython operate via builtins injected here, which hold a
959 Some parts of ipython operate via builtins injected here, which hold a
960 reference to IPython itself."""
960 reference to IPython itself."""
961
961
962 # TODO: deprecate all of these, they are unsafe
962 # TODO: deprecate all of these, they are unsafe
963 builtins_new = dict(__IPYTHON__ = self,
963 builtins_new = dict(__IPYTHON__ = self,
964 ip_set_hook = self.set_hook,
964 ip_set_hook = self.set_hook,
965 jobs = self.jobs,
965 jobs = self.jobs,
966 ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'),
966 ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'),
967 ipalias = wrap_deprecated(self.ipalias),
967 ipalias = wrap_deprecated(self.ipalias),
968 ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'),
968 ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'),
969 #_ip = self.api
969 #_ip = self.api
970 )
970 )
971 for biname,bival in builtins_new.items():
971 for biname,bival in builtins_new.items():
972 try:
972 try:
973 # store the orignal value so we can restore it
973 # store the orignal value so we can restore it
974 self.builtins_added[biname] = __builtin__.__dict__[biname]
974 self.builtins_added[biname] = __builtin__.__dict__[biname]
975 except KeyError:
975 except KeyError:
976 # or mark that it wasn't defined, and we'll just delete it at
976 # or mark that it wasn't defined, and we'll just delete it at
977 # cleanup
977 # cleanup
978 self.builtins_added[biname] = Undefined
978 self.builtins_added[biname] = Undefined
979 __builtin__.__dict__[biname] = bival
979 __builtin__.__dict__[biname] = bival
980
980
981 # Keep in the builtins a flag for when IPython is active. We set it
981 # Keep in the builtins a flag for when IPython is active. We set it
982 # with setdefault so that multiple nested IPythons don't clobber one
982 # with setdefault so that multiple nested IPythons don't clobber one
983 # another. Each will increase its value by one upon being activated,
983 # another. Each will increase its value by one upon being activated,
984 # which also gives us a way to determine the nesting level.
984 # which also gives us a way to determine the nesting level.
985 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
985 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
986
986
987 def clean_builtins(self):
987 def clean_builtins(self):
988 """Remove any builtins which might have been added by add_builtins, or
988 """Remove any builtins which might have been added by add_builtins, or
989 restore overwritten ones to their previous values."""
989 restore overwritten ones to their previous values."""
990 for biname,bival in self.builtins_added.items():
990 for biname,bival in self.builtins_added.items():
991 if bival is Undefined:
991 if bival is Undefined:
992 del __builtin__.__dict__[biname]
992 del __builtin__.__dict__[biname]
993 else:
993 else:
994 __builtin__.__dict__[biname] = bival
994 __builtin__.__dict__[biname] = bival
995 self.builtins_added.clear()
995 self.builtins_added.clear()
996
996
997 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
997 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
998 """set_hook(name,hook) -> sets an internal IPython hook.
998 """set_hook(name,hook) -> sets an internal IPython hook.
999
999
1000 IPython exposes some of its internal API as user-modifiable hooks. By
1000 IPython exposes some of its internal API as user-modifiable hooks. By
1001 adding your function to one of these hooks, you can modify IPython's
1001 adding your function to one of these hooks, you can modify IPython's
1002 behavior to call at runtime your own routines."""
1002 behavior to call at runtime your own routines."""
1003
1003
1004 # At some point in the future, this should validate the hook before it
1004 # At some point in the future, this should validate the hook before it
1005 # accepts it. Probably at least check that the hook takes the number
1005 # accepts it. Probably at least check that the hook takes the number
1006 # of args it's supposed to.
1006 # of args it's supposed to.
1007
1007
1008 f = new.instancemethod(hook,self,self.__class__)
1008 f = new.instancemethod(hook,self,self.__class__)
1009
1009
1010 # check if the hook is for strdispatcher first
1010 # check if the hook is for strdispatcher first
1011 if str_key is not None:
1011 if str_key is not None:
1012 sdp = self.strdispatchers.get(name, StrDispatch())
1012 sdp = self.strdispatchers.get(name, StrDispatch())
1013 sdp.add_s(str_key, f, priority )
1013 sdp.add_s(str_key, f, priority )
1014 self.strdispatchers[name] = sdp
1014 self.strdispatchers[name] = sdp
1015 return
1015 return
1016 if re_key is not None:
1016 if re_key is not None:
1017 sdp = self.strdispatchers.get(name, StrDispatch())
1017 sdp = self.strdispatchers.get(name, StrDispatch())
1018 sdp.add_re(re.compile(re_key), f, priority )
1018 sdp.add_re(re.compile(re_key), f, priority )
1019 self.strdispatchers[name] = sdp
1019 self.strdispatchers[name] = sdp
1020 return
1020 return
1021
1021
1022 dp = getattr(self.hooks, name, None)
1022 dp = getattr(self.hooks, name, None)
1023 if name not in IPython.core.hooks.__all__:
1023 if name not in IPython.core.hooks.__all__:
1024 print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ )
1024 print "Warning! Hook '%s' is not one of %s" % (name, IPython.core.hooks.__all__ )
1025 if not dp:
1025 if not dp:
1026 dp = IPython.core.hooks.CommandChainDispatcher()
1026 dp = IPython.core.hooks.CommandChainDispatcher()
1027
1027
1028 try:
1028 try:
1029 dp.add(f,priority)
1029 dp.add(f,priority)
1030 except AttributeError:
1030 except AttributeError:
1031 # it was not commandchain, plain old func - replace
1031 # it was not commandchain, plain old func - replace
1032 dp = f
1032 dp = f
1033
1033
1034 setattr(self.hooks,name, dp)
1034 setattr(self.hooks,name, dp)
1035
1035
1036
1036
1037 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
1037 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
1038
1038
1039 def set_crash_handler(self,crashHandler):
1039 def set_crash_handler(self,crashHandler):
1040 """Set the IPython crash handler.
1040 """Set the IPython crash handler.
1041
1041
1042 This must be a callable with a signature suitable for use as
1042 This must be a callable with a signature suitable for use as
1043 sys.excepthook."""
1043 sys.excepthook."""
1044
1044
1045 # Install the given crash handler as the Python exception hook
1045 # Install the given crash handler as the Python exception hook
1046 sys.excepthook = crashHandler
1046 sys.excepthook = crashHandler
1047
1047
1048 # The instance will store a pointer to this, so that runtime code
1048 # The instance will store a pointer to this, so that runtime code
1049 # (such as magics) can access it. This is because during the
1049 # (such as magics) can access it. This is because during the
1050 # read-eval loop, it gets temporarily overwritten (to deal with GUI
1050 # read-eval loop, it gets temporarily overwritten (to deal with GUI
1051 # frameworks).
1051 # frameworks).
1052 self.sys_excepthook = sys.excepthook
1052 self.sys_excepthook = sys.excepthook
1053
1053
1054
1054
1055 def set_custom_exc(self,exc_tuple,handler):
1055 def set_custom_exc(self,exc_tuple,handler):
1056 """set_custom_exc(exc_tuple,handler)
1056 """set_custom_exc(exc_tuple,handler)
1057
1057
1058 Set a custom exception handler, which will be called if any of the
1058 Set a custom exception handler, which will be called if any of the
1059 exceptions in exc_tuple occur in the mainloop (specifically, in the
1059 exceptions in exc_tuple occur in the mainloop (specifically, in the
1060 runcode() method.
1060 runcode() method.
1061
1061
1062 Inputs:
1062 Inputs:
1063
1063
1064 - exc_tuple: a *tuple* of valid exceptions to call the defined
1064 - exc_tuple: a *tuple* of valid exceptions to call the defined
1065 handler for. It is very important that you use a tuple, and NOT A
1065 handler for. It is very important that you use a tuple, and NOT A
1066 LIST here, because of the way Python's except statement works. If
1066 LIST here, because of the way Python's except statement works. If
1067 you only want to trap a single exception, use a singleton tuple:
1067 you only want to trap a single exception, use a singleton tuple:
1068
1068
1069 exc_tuple == (MyCustomException,)
1069 exc_tuple == (MyCustomException,)
1070
1070
1071 - handler: this must be defined as a function with the following
1071 - handler: this must be defined as a function with the following
1072 basic interface: def my_handler(self,etype,value,tb).
1072 basic interface: def my_handler(self,etype,value,tb).
1073
1073
1074 This will be made into an instance method (via new.instancemethod)
1074 This will be made into an instance method (via new.instancemethod)
1075 of IPython itself, and it will be called if any of the exceptions
1075 of IPython itself, and it will be called if any of the exceptions
1076 listed in the exc_tuple are caught. If the handler is None, an
1076 listed in the exc_tuple are caught. If the handler is None, an
1077 internal basic one is used, which just prints basic info.
1077 internal basic one is used, which just prints basic info.
1078
1078
1079 WARNING: by putting in your own exception handler into IPython's main
1079 WARNING: by putting in your own exception handler into IPython's main
1080 execution loop, you run a very good chance of nasty crashes. This
1080 execution loop, you run a very good chance of nasty crashes. This
1081 facility should only be used if you really know what you are doing."""
1081 facility should only be used if you really know what you are doing."""
1082
1082
1083 assert type(exc_tuple)==type(()) , \
1083 assert type(exc_tuple)==type(()) , \
1084 "The custom exceptions must be given AS A TUPLE."
1084 "The custom exceptions must be given AS A TUPLE."
1085
1085
1086 def dummy_handler(self,etype,value,tb):
1086 def dummy_handler(self,etype,value,tb):
1087 print '*** Simple custom exception handler ***'
1087 print '*** Simple custom exception handler ***'
1088 print 'Exception type :',etype
1088 print 'Exception type :',etype
1089 print 'Exception value:',value
1089 print 'Exception value:',value
1090 print 'Traceback :',tb
1090 print 'Traceback :',tb
1091 print 'Source code :','\n'.join(self.buffer)
1091 print 'Source code :','\n'.join(self.buffer)
1092
1092
1093 if handler is None: handler = dummy_handler
1093 if handler is None: handler = dummy_handler
1094
1094
1095 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1095 self.CustomTB = new.instancemethod(handler,self,self.__class__)
1096 self.custom_exceptions = exc_tuple
1096 self.custom_exceptions = exc_tuple
1097
1097
1098 def set_custom_completer(self,completer,pos=0):
1098 def set_custom_completer(self,completer,pos=0):
1099 """set_custom_completer(completer,pos=0)
1099 """set_custom_completer(completer,pos=0)
1100
1100
1101 Adds a new custom completer function.
1101 Adds a new custom completer function.
1102
1102
1103 The position argument (defaults to 0) is the index in the completers
1103 The position argument (defaults to 0) is the index in the completers
1104 list where you want the completer to be inserted."""
1104 list where you want the completer to be inserted."""
1105
1105
1106 newcomp = new.instancemethod(completer,self.Completer,
1106 newcomp = new.instancemethod(completer,self.Completer,
1107 self.Completer.__class__)
1107 self.Completer.__class__)
1108 self.Completer.matchers.insert(pos,newcomp)
1108 self.Completer.matchers.insert(pos,newcomp)
1109
1109
1110 def set_completer(self):
1110 def set_completer(self):
1111 """reset readline's completer to be our own."""
1111 """reset readline's completer to be our own."""
1112 self.readline.set_completer(self.Completer.complete)
1112 self.readline.set_completer(self.Completer.complete)
1113
1113
1114 def _get_call_pdb(self):
1114 def _get_call_pdb(self):
1115 return self._call_pdb
1115 return self._call_pdb
1116
1116
1117 def _set_call_pdb(self,val):
1117 def _set_call_pdb(self,val):
1118
1118
1119 if val not in (0,1,False,True):
1119 if val not in (0,1,False,True):
1120 raise ValueError,'new call_pdb value must be boolean'
1120 raise ValueError,'new call_pdb value must be boolean'
1121
1121
1122 # store value in instance
1122 # store value in instance
1123 self._call_pdb = val
1123 self._call_pdb = val
1124
1124
1125 # notify the actual exception handlers
1125 # notify the actual exception handlers
1126 self.InteractiveTB.call_pdb = val
1126 self.InteractiveTB.call_pdb = val
1127 if self.isthreaded:
1127 if self.isthreaded:
1128 try:
1128 try:
1129 self.sys_excepthook.call_pdb = val
1129 self.sys_excepthook.call_pdb = val
1130 except:
1130 except:
1131 warn('Failed to activate pdb for threaded exception handler')
1131 warn('Failed to activate pdb for threaded exception handler')
1132
1132
1133 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1133 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
1134 'Control auto-activation of pdb at exceptions')
1134 'Control auto-activation of pdb at exceptions')
1135
1135
1136 # These special functions get installed in the builtin namespace, to
1136 # These special functions get installed in the builtin namespace, to
1137 # provide programmatic (pure python) access to magics, aliases and system
1137 # provide programmatic (pure python) access to magics, aliases and system
1138 # calls. This is important for logging, user scripting, and more.
1138 # calls. This is important for logging, user scripting, and more.
1139
1139
1140 # We are basically exposing, via normal python functions, the three
1140 # We are basically exposing, via normal python functions, the three
1141 # mechanisms in which ipython offers special call modes (magics for
1141 # mechanisms in which ipython offers special call modes (magics for
1142 # internal control, aliases for direct system access via pre-selected
1142 # internal control, aliases for direct system access via pre-selected
1143 # names, and !cmd for calling arbitrary system commands).
1143 # names, and !cmd for calling arbitrary system commands).
1144
1144
1145 def ipmagic(self,arg_s):
1145 def ipmagic(self,arg_s):
1146 """Call a magic function by name.
1146 """Call a magic function by name.
1147
1147
1148 Input: a string containing the name of the magic function to call and any
1148 Input: a string containing the name of the magic function to call and any
1149 additional arguments to be passed to the magic.
1149 additional arguments to be passed to the magic.
1150
1150
1151 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
1151 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
1152 prompt:
1152 prompt:
1153
1153
1154 In[1]: %name -opt foo bar
1154 In[1]: %name -opt foo bar
1155
1155
1156 To call a magic without arguments, simply use ipmagic('name').
1156 To call a magic without arguments, simply use ipmagic('name').
1157
1157
1158 This provides a proper Python function to call IPython's magics in any
1158 This provides a proper Python function to call IPython's magics in any
1159 valid Python code you can type at the interpreter, including loops and
1159 valid Python code you can type at the interpreter, including loops and
1160 compound statements. It is added by IPython to the Python builtin
1160 compound statements. It is added by IPython to the Python builtin
1161 namespace upon initialization."""
1161 namespace upon initialization."""
1162
1162
1163 args = arg_s.split(' ',1)
1163 args = arg_s.split(' ',1)
1164 magic_name = args[0]
1164 magic_name = args[0]
1165 magic_name = magic_name.lstrip(self.ESC_MAGIC)
1165 magic_name = magic_name.lstrip(self.ESC_MAGIC)
1166
1166
1167 try:
1167 try:
1168 magic_args = args[1]
1168 magic_args = args[1]
1169 except IndexError:
1169 except IndexError:
1170 magic_args = ''
1170 magic_args = ''
1171 fn = getattr(self,'magic_'+magic_name,None)
1171 fn = getattr(self,'magic_'+magic_name,None)
1172 if fn is None:
1172 if fn is None:
1173 error("Magic function `%s` not found." % magic_name)
1173 error("Magic function `%s` not found." % magic_name)
1174 else:
1174 else:
1175 magic_args = self.var_expand(magic_args,1)
1175 magic_args = self.var_expand(magic_args,1)
1176 return fn(magic_args)
1176 return fn(magic_args)
1177
1177
1178 def ipalias(self,arg_s):
1178 def ipalias(self,arg_s):
1179 """Call an alias by name.
1179 """Call an alias by name.
1180
1180
1181 Input: a string containing the name of the alias to call and any
1181 Input: a string containing the name of the alias to call and any
1182 additional arguments to be passed to the magic.
1182 additional arguments to be passed to the magic.
1183
1183
1184 ipalias('name -opt foo bar') is equivalent to typing at the ipython
1184 ipalias('name -opt foo bar') is equivalent to typing at the ipython
1185 prompt:
1185 prompt:
1186
1186
1187 In[1]: name -opt foo bar
1187 In[1]: name -opt foo bar
1188
1188
1189 To call an alias without arguments, simply use ipalias('name').
1189 To call an alias without arguments, simply use ipalias('name').
1190
1190
1191 This provides a proper Python function to call IPython's aliases in any
1191 This provides a proper Python function to call IPython's aliases in any
1192 valid Python code you can type at the interpreter, including loops and
1192 valid Python code you can type at the interpreter, including loops and
1193 compound statements. It is added by IPython to the Python builtin
1193 compound statements. It is added by IPython to the Python builtin
1194 namespace upon initialization."""
1194 namespace upon initialization."""
1195
1195
1196 args = arg_s.split(' ',1)
1196 args = arg_s.split(' ',1)
1197 alias_name = args[0]
1197 alias_name = args[0]
1198 try:
1198 try:
1199 alias_args = args[1]
1199 alias_args = args[1]
1200 except IndexError:
1200 except IndexError:
1201 alias_args = ''
1201 alias_args = ''
1202 if alias_name in self.alias_table:
1202 if alias_name in self.alias_table:
1203 self.call_alias(alias_name,alias_args)
1203 self.call_alias(alias_name,alias_args)
1204 else:
1204 else:
1205 error("Alias `%s` not found." % alias_name)
1205 error("Alias `%s` not found." % alias_name)
1206
1206
1207 def ipsystem(self,arg_s):
1207 def ipsystem(self,arg_s):
1208 """Make a system call, using IPython."""
1208 """Make a system call, using IPython."""
1209
1209
1210 self.system(arg_s)
1210 self.system(arg_s)
1211
1211
1212 def complete(self,text):
1212 def complete(self,text):
1213 """Return a sorted list of all possible completions on text.
1213 """Return a sorted list of all possible completions on text.
1214
1214
1215 Inputs:
1215 Inputs:
1216
1216
1217 - text: a string of text to be completed on.
1217 - text: a string of text to be completed on.
1218
1218
1219 This is a wrapper around the completion mechanism, similar to what
1219 This is a wrapper around the completion mechanism, similar to what
1220 readline does at the command line when the TAB key is hit. By
1220 readline does at the command line when the TAB key is hit. By
1221 exposing it as a method, it can be used by other non-readline
1221 exposing it as a method, it can be used by other non-readline
1222 environments (such as GUIs) for text completion.
1222 environments (such as GUIs) for text completion.
1223
1223
1224 Simple usage example:
1224 Simple usage example:
1225
1225
1226 In [7]: x = 'hello'
1226 In [7]: x = 'hello'
1227
1227
1228 In [8]: x
1228 In [8]: x
1229 Out[8]: 'hello'
1229 Out[8]: 'hello'
1230
1230
1231 In [9]: print x
1231 In [9]: print x
1232 hello
1232 hello
1233
1233
1234 In [10]: _ip.IP.complete('x.l')
1234 In [10]: _ip.IP.complete('x.l')
1235 Out[10]: ['x.ljust', 'x.lower', 'x.lstrip']
1235 Out[10]: ['x.ljust', 'x.lower', 'x.lstrip']
1236 """
1236 """
1237
1237
1238 complete = self.Completer.complete
1238 complete = self.Completer.complete
1239 state = 0
1239 state = 0
1240 # use a dict so we get unique keys, since ipyhton's multiple
1240 # use a dict so we get unique keys, since ipyhton's multiple
1241 # completers can return duplicates. When we make 2.4 a requirement,
1241 # completers can return duplicates. When we make 2.4 a requirement,
1242 # start using sets instead, which are faster.
1242 # start using sets instead, which are faster.
1243 comps = {}
1243 comps = {}
1244 while True:
1244 while True:
1245 newcomp = complete(text,state,line_buffer=text)
1245 newcomp = complete(text,state,line_buffer=text)
1246 if newcomp is None:
1246 if newcomp is None:
1247 break
1247 break
1248 comps[newcomp] = 1
1248 comps[newcomp] = 1
1249 state += 1
1249 state += 1
1250 outcomps = comps.keys()
1250 outcomps = comps.keys()
1251 outcomps.sort()
1251 outcomps.sort()
1252 #print "T:",text,"OC:",outcomps # dbg
1252 #print "T:",text,"OC:",outcomps # dbg
1253 #print "vars:",self.user_ns.keys()
1253 #print "vars:",self.user_ns.keys()
1254 return outcomps
1254 return outcomps
1255
1255
1256 def set_completer_frame(self, frame=None):
1256 def set_completer_frame(self, frame=None):
1257 if frame:
1257 if frame:
1258 self.Completer.namespace = frame.f_locals
1258 self.Completer.namespace = frame.f_locals
1259 self.Completer.global_namespace = frame.f_globals
1259 self.Completer.global_namespace = frame.f_globals
1260 else:
1260 else:
1261 self.Completer.namespace = self.user_ns
1261 self.Completer.namespace = self.user_ns
1262 self.Completer.global_namespace = self.user_global_ns
1262 self.Completer.global_namespace = self.user_global_ns
1263
1263
1264 def init_auto_alias(self):
1264 def init_auto_alias(self):
1265 """Define some aliases automatically.
1265 """Define some aliases automatically.
1266
1266
1267 These are ALL parameter-less aliases"""
1267 These are ALL parameter-less aliases"""
1268
1268
1269 for alias,cmd in self.auto_alias:
1269 for alias,cmd in self.auto_alias:
1270 self.getapi().defalias(alias,cmd)
1270 self.getapi().defalias(alias,cmd)
1271
1271
1272
1272
1273 def alias_table_validate(self,verbose=0):
1273 def alias_table_validate(self,verbose=0):
1274 """Update information about the alias table.
1274 """Update information about the alias table.
1275
1275
1276 In particular, make sure no Python keywords/builtins are in it."""
1276 In particular, make sure no Python keywords/builtins are in it."""
1277
1277
1278 no_alias = self.no_alias
1278 no_alias = self.no_alias
1279 for k in self.alias_table.keys():
1279 for k in self.alias_table.keys():
1280 if k in no_alias:
1280 if k in no_alias:
1281 del self.alias_table[k]
1281 del self.alias_table[k]
1282 if verbose:
1282 if verbose:
1283 print ("Deleting alias <%s>, it's a Python "
1283 print ("Deleting alias <%s>, it's a Python "
1284 "keyword or builtin." % k)
1284 "keyword or builtin." % k)
1285
1285
1286 def set_autoindent(self,value=None):
1286 def set_autoindent(self,value=None):
1287 """Set the autoindent flag, checking for readline support.
1287 """Set the autoindent flag, checking for readline support.
1288
1288
1289 If called with no arguments, it acts as a toggle."""
1289 If called with no arguments, it acts as a toggle."""
1290
1290
1291 if not self.has_readline:
1291 if not self.has_readline:
1292 if os.name == 'posix':
1292 if os.name == 'posix':
1293 warn("The auto-indent feature requires the readline library")
1293 warn("The auto-indent feature requires the readline library")
1294 self.autoindent = 0
1294 self.autoindent = 0
1295 return
1295 return
1296 if value is None:
1296 if value is None:
1297 self.autoindent = not self.autoindent
1297 self.autoindent = not self.autoindent
1298 else:
1298 else:
1299 self.autoindent = value
1299 self.autoindent = value
1300
1300
1301 def rc_set_toggle(self,rc_field,value=None):
1301 def rc_set_toggle(self,rc_field,value=None):
1302 """Set or toggle a field in IPython's rc config. structure.
1302 """Set or toggle a field in IPython's rc config. structure.
1303
1303
1304 If called with no arguments, it acts as a toggle.
1304 If called with no arguments, it acts as a toggle.
1305
1305
1306 If called with a non-existent field, the resulting AttributeError
1306 If called with a non-existent field, the resulting AttributeError
1307 exception will propagate out."""
1307 exception will propagate out."""
1308
1308
1309 rc_val = getattr(self.rc,rc_field)
1309 rc_val = getattr(self.rc,rc_field)
1310 if value is None:
1310 if value is None:
1311 value = not rc_val
1311 value = not rc_val
1312 setattr(self.rc,rc_field,value)
1312 setattr(self.rc,rc_field,value)
1313
1313
1314 def user_setup(self,ipythondir,rc_suffix,mode='install'):
1314 def user_setup(self,ipythondir,rc_suffix,mode='install'):
1315 """Install the user configuration directory.
1315 """Install the user configuration directory.
1316
1316
1317 Note
1317 Note
1318 ----
1318 ----
1319 DEPRECATED: use the top-level user_setup() function instead.
1319 DEPRECATED: use the top-level user_setup() function instead.
1320 """
1320 """
1321 return user_setup(ipythondir,rc_suffix,mode)
1321 return user_setup(ipythondir,rc_suffix,mode)
1322
1322
1323 def atexit_operations(self):
1323 def atexit_operations(self):
1324 """This will be executed at the time of exit.
1324 """This will be executed at the time of exit.
1325
1325
1326 Saving of persistent data should be performed here. """
1326 Saving of persistent data should be performed here. """
1327
1327
1328 #print '*** IPython exit cleanup ***' # dbg
1328 #print '*** IPython exit cleanup ***' # dbg
1329 # input history
1329 # input history
1330 self.savehist()
1330 self.savehist()
1331
1331
1332 # Cleanup all tempfiles left around
1332 # Cleanup all tempfiles left around
1333 for tfile in self.tempfiles:
1333 for tfile in self.tempfiles:
1334 try:
1334 try:
1335 os.unlink(tfile)
1335 os.unlink(tfile)
1336 except OSError:
1336 except OSError:
1337 pass
1337 pass
1338
1338
1339 # Clear all user namespaces to release all references cleanly.
1339 # Clear all user namespaces to release all references cleanly.
1340 self.reset()
1340 self.reset()
1341
1341
1342 # Run user hooks
1342 # Run user hooks
1343 self.hooks.shutdown_hook()
1343 self.hooks.shutdown_hook()
1344
1344
1345 def reset(self):
1345 def reset(self):
1346 """Clear all internal namespaces.
1346 """Clear all internal namespaces.
1347
1347
1348 Note that this is much more aggressive than %reset, since it clears
1348 Note that this is much more aggressive than %reset, since it clears
1349 fully all namespaces, as well as all input/output lists.
1349 fully all namespaces, as well as all input/output lists.
1350 """
1350 """
1351 for ns in self.ns_refs_table:
1351 for ns in self.ns_refs_table:
1352 ns.clear()
1352 ns.clear()
1353
1353
1354 # Clear input and output histories
1354 # Clear input and output histories
1355 self.input_hist[:] = []
1355 self.input_hist[:] = []
1356 self.input_hist_raw[:] = []
1356 self.input_hist_raw[:] = []
1357 self.output_hist.clear()
1357 self.output_hist.clear()
1358 # Restore the user namespaces to minimal usability
1358 # Restore the user namespaces to minimal usability
1359 self.init_namespaces()
1359 self.init_namespaces()
1360
1360
1361 def savehist(self):
1361 def savehist(self):
1362 """Save input history to a file (via readline library)."""
1362 """Save input history to a file (via readline library)."""
1363
1363
1364 if not self.has_readline:
1364 if not self.has_readline:
1365 return
1365 return
1366
1366
1367 try:
1367 try:
1368 self.readline.write_history_file(self.histfile)
1368 self.readline.write_history_file(self.histfile)
1369 except:
1369 except:
1370 print 'Unable to save IPython command history to file: ' + \
1370 print 'Unable to save IPython command history to file: ' + \
1371 `self.histfile`
1371 `self.histfile`
1372
1372
1373 def reloadhist(self):
1373 def reloadhist(self):
1374 """Reload the input history from disk file."""
1374 """Reload the input history from disk file."""
1375
1375
1376 if self.has_readline:
1376 if self.has_readline:
1377 try:
1377 try:
1378 self.readline.clear_history()
1378 self.readline.clear_history()
1379 self.readline.read_history_file(self.shell.histfile)
1379 self.readline.read_history_file(self.shell.histfile)
1380 except AttributeError:
1380 except AttributeError:
1381 pass
1381 pass
1382
1382
1383
1383
1384 def history_saving_wrapper(self, func):
1384 def history_saving_wrapper(self, func):
1385 """ Wrap func for readline history saving
1385 """ Wrap func for readline history saving
1386
1386
1387 Convert func into callable that saves & restores
1387 Convert func into callable that saves & restores
1388 history around the call """
1388 history around the call """
1389
1389
1390 if not self.has_readline:
1390 if not self.has_readline:
1391 return func
1391 return func
1392
1392
1393 def wrapper():
1393 def wrapper():
1394 self.savehist()
1394 self.savehist()
1395 try:
1395 try:
1396 func()
1396 func()
1397 finally:
1397 finally:
1398 readline.read_history_file(self.histfile)
1398 readline.read_history_file(self.histfile)
1399 return wrapper
1399 return wrapper
1400
1400
1401 def pre_readline(self):
1401 def pre_readline(self):
1402 """readline hook to be used at the start of each line.
1402 """readline hook to be used at the start of each line.
1403
1403
1404 Currently it handles auto-indent only."""
1404 Currently it handles auto-indent only."""
1405
1405
1406 #debugx('self.indent_current_nsp','pre_readline:')
1406 #debugx('self.indent_current_nsp','pre_readline:')
1407
1407
1408 if self.rl_do_indent:
1408 if self.rl_do_indent:
1409 self.readline.insert_text(self.indent_current_str())
1409 self.readline.insert_text(self.indent_current_str())
1410 if self.rl_next_input is not None:
1410 if self.rl_next_input is not None:
1411 self.readline.insert_text(self.rl_next_input)
1411 self.readline.insert_text(self.rl_next_input)
1412 self.rl_next_input = None
1412 self.rl_next_input = None
1413
1413
1414 def init_readline(self):
1414 def init_readline(self):
1415 """Command history completion/saving/reloading."""
1415 """Command history completion/saving/reloading."""
1416
1416
1417
1417
1418 import IPython.rlineimpl as readline
1418 import IPython.rlineimpl as readline
1419
1419
1420 if not readline.have_readline:
1420 if not readline.have_readline:
1421 self.has_readline = 0
1421 self.has_readline = 0
1422 self.readline = None
1422 self.readline = None
1423 # no point in bugging windows users with this every time:
1423 # no point in bugging windows users with this every time:
1424 warn('Readline services not available on this platform.')
1424 warn('Readline services not available on this platform.')
1425 else:
1425 else:
1426 sys.modules['readline'] = readline
1426 sys.modules['readline'] = readline
1427 import atexit
1427 import atexit
1428 from IPython.core.completer import IPCompleter
1428 from IPython.core.completer import IPCompleter
1429 self.Completer = IPCompleter(self,
1429 self.Completer = IPCompleter(self,
1430 self.user_ns,
1430 self.user_ns,
1431 self.user_global_ns,
1431 self.user_global_ns,
1432 self.rc.readline_omit__names,
1432 self.rc.readline_omit__names,
1433 self.alias_table)
1433 self.alias_table)
1434 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1434 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1435 self.strdispatchers['complete_command'] = sdisp
1435 self.strdispatchers['complete_command'] = sdisp
1436 self.Completer.custom_completers = sdisp
1436 self.Completer.custom_completers = sdisp
1437 # Platform-specific configuration
1437 # Platform-specific configuration
1438 if os.name == 'nt':
1438 if os.name == 'nt':
1439 self.readline_startup_hook = readline.set_pre_input_hook
1439 self.readline_startup_hook = readline.set_pre_input_hook
1440 else:
1440 else:
1441 self.readline_startup_hook = readline.set_startup_hook
1441 self.readline_startup_hook = readline.set_startup_hook
1442
1442
1443 # Load user's initrc file (readline config)
1443 # Load user's initrc file (readline config)
1444 # Or if libedit is used, load editrc.
1444 # Or if libedit is used, load editrc.
1445 inputrc_name = os.environ.get('INPUTRC')
1445 inputrc_name = os.environ.get('INPUTRC')
1446 if inputrc_name is None:
1446 if inputrc_name is None:
1447 home_dir = get_home_dir()
1447 home_dir = get_home_dir()
1448 if home_dir is not None:
1448 if home_dir is not None:
1449 inputrc_name = '.inputrc'
1449 inputrc_name = '.inputrc'
1450 if readline.uses_libedit:
1450 if readline.uses_libedit:
1451 inputrc_name = '.editrc'
1451 inputrc_name = '.editrc'
1452 inputrc_name = os.path.join(home_dir, inputrc_name)
1452 inputrc_name = os.path.join(home_dir, inputrc_name)
1453 if os.path.isfile(inputrc_name):
1453 if os.path.isfile(inputrc_name):
1454 try:
1454 try:
1455 readline.read_init_file(inputrc_name)
1455 readline.read_init_file(inputrc_name)
1456 except:
1456 except:
1457 warn('Problems reading readline initialization file <%s>'
1457 warn('Problems reading readline initialization file <%s>'
1458 % inputrc_name)
1458 % inputrc_name)
1459
1459
1460 self.has_readline = 1
1460 self.has_readline = 1
1461 self.readline = readline
1461 self.readline = readline
1462 # save this in sys so embedded copies can restore it properly
1462 # save this in sys so embedded copies can restore it properly
1463 sys.ipcompleter = self.Completer.complete
1463 sys.ipcompleter = self.Completer.complete
1464 self.set_completer()
1464 self.set_completer()
1465
1465
1466 # Configure readline according to user's prefs
1466 # Configure readline according to user's prefs
1467 # This is only done if GNU readline is being used. If libedit
1467 # This is only done if GNU readline is being used. If libedit
1468 # is being used (as on Leopard) the readline config is
1468 # is being used (as on Leopard) the readline config is
1469 # not run as the syntax for libedit is different.
1469 # not run as the syntax for libedit is different.
1470 if not readline.uses_libedit:
1470 if not readline.uses_libedit:
1471 for rlcommand in self.rc.readline_parse_and_bind:
1471 for rlcommand in self.rc.readline_parse_and_bind:
1472 #print "loading rl:",rlcommand # dbg
1472 #print "loading rl:",rlcommand # dbg
1473 readline.parse_and_bind(rlcommand)
1473 readline.parse_and_bind(rlcommand)
1474
1474
1475 # Remove some chars from the delimiters list. If we encounter
1475 # Remove some chars from the delimiters list. If we encounter
1476 # unicode chars, discard them.
1476 # unicode chars, discard them.
1477 delims = readline.get_completer_delims().encode("ascii", "ignore")
1477 delims = readline.get_completer_delims().encode("ascii", "ignore")
1478 delims = delims.translate(string._idmap,
1478 delims = delims.translate(string._idmap,
1479 self.rc.readline_remove_delims)
1479 self.rc.readline_remove_delims)
1480 readline.set_completer_delims(delims)
1480 readline.set_completer_delims(delims)
1481 # otherwise we end up with a monster history after a while:
1481 # otherwise we end up with a monster history after a while:
1482 readline.set_history_length(1000)
1482 readline.set_history_length(1000)
1483 try:
1483 try:
1484 #print '*** Reading readline history' # dbg
1484 #print '*** Reading readline history' # dbg
1485 readline.read_history_file(self.histfile)
1485 readline.read_history_file(self.histfile)
1486 except IOError:
1486 except IOError:
1487 pass # It doesn't exist yet.
1487 pass # It doesn't exist yet.
1488
1488
1489 atexit.register(self.atexit_operations)
1489 atexit.register(self.atexit_operations)
1490 del atexit
1490 del atexit
1491
1491
1492 # Configure auto-indent for all platforms
1492 # Configure auto-indent for all platforms
1493 self.set_autoindent(self.rc.autoindent)
1493 self.set_autoindent(self.rc.autoindent)
1494
1494
1495 def ask_yes_no(self,prompt,default=True):
1495 def ask_yes_no(self,prompt,default=True):
1496 if self.rc.quiet:
1496 if self.rc.quiet:
1497 return True
1497 return True
1498 return ask_yes_no(prompt,default)
1498 return ask_yes_no(prompt,default)
1499
1499
1500 def new_main_mod(self,ns=None):
1500 def new_main_mod(self,ns=None):
1501 """Return a new 'main' module object for user code execution.
1501 """Return a new 'main' module object for user code execution.
1502 """
1502 """
1503 main_mod = self._user_main_module
1503 main_mod = self._user_main_module
1504 init_fakemod_dict(main_mod,ns)
1504 init_fakemod_dict(main_mod,ns)
1505 return main_mod
1505 return main_mod
1506
1506
1507 def cache_main_mod(self,ns,fname):
1507 def cache_main_mod(self,ns,fname):
1508 """Cache a main module's namespace.
1508 """Cache a main module's namespace.
1509
1509
1510 When scripts are executed via %run, we must keep a reference to the
1510 When scripts are executed via %run, we must keep a reference to the
1511 namespace of their __main__ module (a FakeModule instance) around so
1511 namespace of their __main__ module (a FakeModule instance) around so
1512 that Python doesn't clear it, rendering objects defined therein
1512 that Python doesn't clear it, rendering objects defined therein
1513 useless.
1513 useless.
1514
1514
1515 This method keeps said reference in a private dict, keyed by the
1515 This method keeps said reference in a private dict, keyed by the
1516 absolute path of the module object (which corresponds to the script
1516 absolute path of the module object (which corresponds to the script
1517 path). This way, for multiple executions of the same script we only
1517 path). This way, for multiple executions of the same script we only
1518 keep one copy of the namespace (the last one), thus preventing memory
1518 keep one copy of the namespace (the last one), thus preventing memory
1519 leaks from old references while allowing the objects from the last
1519 leaks from old references while allowing the objects from the last
1520 execution to be accessible.
1520 execution to be accessible.
1521
1521
1522 Note: we can not allow the actual FakeModule instances to be deleted,
1522 Note: we can not allow the actual FakeModule instances to be deleted,
1523 because of how Python tears down modules (it hard-sets all their
1523 because of how Python tears down modules (it hard-sets all their
1524 references to None without regard for reference counts). This method
1524 references to None without regard for reference counts). This method
1525 must therefore make a *copy* of the given namespace, to allow the
1525 must therefore make a *copy* of the given namespace, to allow the
1526 original module's __dict__ to be cleared and reused.
1526 original module's __dict__ to be cleared and reused.
1527
1527
1528
1528
1529 Parameters
1529 Parameters
1530 ----------
1530 ----------
1531 ns : a namespace (a dict, typically)
1531 ns : a namespace (a dict, typically)
1532
1532
1533 fname : str
1533 fname : str
1534 Filename associated with the namespace.
1534 Filename associated with the namespace.
1535
1535
1536 Examples
1536 Examples
1537 --------
1537 --------
1538
1538
1539 In [10]: import IPython
1539 In [10]: import IPython
1540
1540
1541 In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1541 In [11]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1542
1542
1543 In [12]: IPython.__file__ in _ip.IP._main_ns_cache
1543 In [12]: IPython.__file__ in _ip.IP._main_ns_cache
1544 Out[12]: True
1544 Out[12]: True
1545 """
1545 """
1546 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
1546 self._main_ns_cache[os.path.abspath(fname)] = ns.copy()
1547
1547
1548 def clear_main_mod_cache(self):
1548 def clear_main_mod_cache(self):
1549 """Clear the cache of main modules.
1549 """Clear the cache of main modules.
1550
1550
1551 Mainly for use by utilities like %reset.
1551 Mainly for use by utilities like %reset.
1552
1552
1553 Examples
1553 Examples
1554 --------
1554 --------
1555
1555
1556 In [15]: import IPython
1556 In [15]: import IPython
1557
1557
1558 In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1558 In [16]: _ip.IP.cache_main_mod(IPython.__dict__,IPython.__file__)
1559
1559
1560 In [17]: len(_ip.IP._main_ns_cache) > 0
1560 In [17]: len(_ip.IP._main_ns_cache) > 0
1561 Out[17]: True
1561 Out[17]: True
1562
1562
1563 In [18]: _ip.IP.clear_main_mod_cache()
1563 In [18]: _ip.IP.clear_main_mod_cache()
1564
1564
1565 In [19]: len(_ip.IP._main_ns_cache) == 0
1565 In [19]: len(_ip.IP._main_ns_cache) == 0
1566 Out[19]: True
1566 Out[19]: True
1567 """
1567 """
1568 self._main_ns_cache.clear()
1568 self._main_ns_cache.clear()
1569
1569
1570 def _should_recompile(self,e):
1570 def _should_recompile(self,e):
1571 """Utility routine for edit_syntax_error"""
1571 """Utility routine for edit_syntax_error"""
1572
1572
1573 if e.filename in ('<ipython console>','<input>','<string>',
1573 if e.filename in ('<ipython console>','<input>','<string>',
1574 '<console>','<BackgroundJob compilation>',
1574 '<console>','<BackgroundJob compilation>',
1575 None):
1575 None):
1576
1576
1577 return False
1577 return False
1578 try:
1578 try:
1579 if (self.rc.autoedit_syntax and
1579 if (self.rc.autoedit_syntax and
1580 not self.ask_yes_no('Return to editor to correct syntax error? '
1580 not self.ask_yes_no('Return to editor to correct syntax error? '
1581 '[Y/n] ','y')):
1581 '[Y/n] ','y')):
1582 return False
1582 return False
1583 except EOFError:
1583 except EOFError:
1584 return False
1584 return False
1585
1585
1586 def int0(x):
1586 def int0(x):
1587 try:
1587 try:
1588 return int(x)
1588 return int(x)
1589 except TypeError:
1589 except TypeError:
1590 return 0
1590 return 0
1591 # always pass integer line and offset values to editor hook
1591 # always pass integer line and offset values to editor hook
1592 try:
1592 try:
1593 self.hooks.fix_error_editor(e.filename,
1593 self.hooks.fix_error_editor(e.filename,
1594 int0(e.lineno),int0(e.offset),e.msg)
1594 int0(e.lineno),int0(e.offset),e.msg)
1595 except ipapi.TryNext:
1595 except ipapi.TryNext:
1596 warn('Could not open editor')
1596 warn('Could not open editor')
1597 return False
1597 return False
1598 return True
1598 return True
1599
1599
1600 def edit_syntax_error(self):
1600 def edit_syntax_error(self):
1601 """The bottom half of the syntax error handler called in the main loop.
1601 """The bottom half of the syntax error handler called in the main loop.
1602
1602
1603 Loop until syntax error is fixed or user cancels.
1603 Loop until syntax error is fixed or user cancels.
1604 """
1604 """
1605
1605
1606 while self.SyntaxTB.last_syntax_error:
1606 while self.SyntaxTB.last_syntax_error:
1607 # copy and clear last_syntax_error
1607 # copy and clear last_syntax_error
1608 err = self.SyntaxTB.clear_err_state()
1608 err = self.SyntaxTB.clear_err_state()
1609 if not self._should_recompile(err):
1609 if not self._should_recompile(err):
1610 return
1610 return
1611 try:
1611 try:
1612 # may set last_syntax_error again if a SyntaxError is raised
1612 # may set last_syntax_error again if a SyntaxError is raised
1613 self.safe_execfile(err.filename,self.user_ns)
1613 self.safe_execfile(err.filename,self.user_ns)
1614 except:
1614 except:
1615 self.showtraceback()
1615 self.showtraceback()
1616 else:
1616 else:
1617 try:
1617 try:
1618 f = file(err.filename)
1618 f = file(err.filename)
1619 try:
1619 try:
1620 sys.displayhook(f.read())
1620 sys.displayhook(f.read())
1621 finally:
1621 finally:
1622 f.close()
1622 f.close()
1623 except:
1623 except:
1624 self.showtraceback()
1624 self.showtraceback()
1625
1625
1626 def showsyntaxerror(self, filename=None):
1626 def showsyntaxerror(self, filename=None):
1627 """Display the syntax error that just occurred.
1627 """Display the syntax error that just occurred.
1628
1628
1629 This doesn't display a stack trace because there isn't one.
1629 This doesn't display a stack trace because there isn't one.
1630
1630
1631 If a filename is given, it is stuffed in the exception instead
1631 If a filename is given, it is stuffed in the exception instead
1632 of what was there before (because Python's parser always uses
1632 of what was there before (because Python's parser always uses
1633 "<string>" when reading from a string).
1633 "<string>" when reading from a string).
1634 """
1634 """
1635 etype, value, last_traceback = sys.exc_info()
1635 etype, value, last_traceback = sys.exc_info()
1636
1636
1637 # See note about these variables in showtraceback() below
1637 # See note about these variables in showtraceback() below
1638 sys.last_type = etype
1638 sys.last_type = etype
1639 sys.last_value = value
1639 sys.last_value = value
1640 sys.last_traceback = last_traceback
1640 sys.last_traceback = last_traceback
1641
1641
1642 if filename and etype is SyntaxError:
1642 if filename and etype is SyntaxError:
1643 # Work hard to stuff the correct filename in the exception
1643 # Work hard to stuff the correct filename in the exception
1644 try:
1644 try:
1645 msg, (dummy_filename, lineno, offset, line) = value
1645 msg, (dummy_filename, lineno, offset, line) = value
1646 except:
1646 except:
1647 # Not the format we expect; leave it alone
1647 # Not the format we expect; leave it alone
1648 pass
1648 pass
1649 else:
1649 else:
1650 # Stuff in the right filename
1650 # Stuff in the right filename
1651 try:
1651 try:
1652 # Assume SyntaxError is a class exception
1652 # Assume SyntaxError is a class exception
1653 value = SyntaxError(msg, (filename, lineno, offset, line))
1653 value = SyntaxError(msg, (filename, lineno, offset, line))
1654 except:
1654 except:
1655 # If that failed, assume SyntaxError is a string
1655 # If that failed, assume SyntaxError is a string
1656 value = msg, (filename, lineno, offset, line)
1656 value = msg, (filename, lineno, offset, line)
1657 self.SyntaxTB(etype,value,[])
1657 self.SyntaxTB(etype,value,[])
1658
1658
1659 def debugger(self,force=False):
1659 def debugger(self,force=False):
1660 """Call the pydb/pdb debugger.
1660 """Call the pydb/pdb debugger.
1661
1661
1662 Keywords:
1662 Keywords:
1663
1663
1664 - force(False): by default, this routine checks the instance call_pdb
1664 - force(False): by default, this routine checks the instance call_pdb
1665 flag and does not actually invoke the debugger if the flag is false.
1665 flag and does not actually invoke the debugger if the flag is false.
1666 The 'force' option forces the debugger to activate even if the flag
1666 The 'force' option forces the debugger to activate even if the flag
1667 is false.
1667 is false.
1668 """
1668 """
1669
1669
1670 if not (force or self.call_pdb):
1670 if not (force or self.call_pdb):
1671 return
1671 return
1672
1672
1673 if not hasattr(sys,'last_traceback'):
1673 if not hasattr(sys,'last_traceback'):
1674 error('No traceback has been produced, nothing to debug.')
1674 error('No traceback has been produced, nothing to debug.')
1675 return
1675 return
1676
1676
1677 # use pydb if available
1677 # use pydb if available
1678 if debugger.has_pydb:
1678 if debugger.has_pydb:
1679 from pydb import pm
1679 from pydb import pm
1680 else:
1680 else:
1681 # fallback to our internal debugger
1681 # fallback to our internal debugger
1682 pm = lambda : self.InteractiveTB.debugger(force=True)
1682 pm = lambda : self.InteractiveTB.debugger(force=True)
1683 self.history_saving_wrapper(pm)()
1683 self.history_saving_wrapper(pm)()
1684
1684
1685 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None):
1685 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None):
1686 """Display the exception that just occurred.
1686 """Display the exception that just occurred.
1687
1687
1688 If nothing is known about the exception, this is the method which
1688 If nothing is known about the exception, this is the method which
1689 should be used throughout the code for presenting user tracebacks,
1689 should be used throughout the code for presenting user tracebacks,
1690 rather than directly invoking the InteractiveTB object.
1690 rather than directly invoking the InteractiveTB object.
1691
1691
1692 A specific showsyntaxerror() also exists, but this method can take
1692 A specific showsyntaxerror() also exists, but this method can take
1693 care of calling it if needed, so unless you are explicitly catching a
1693 care of calling it if needed, so unless you are explicitly catching a
1694 SyntaxError exception, don't try to analyze the stack manually and
1694 SyntaxError exception, don't try to analyze the stack manually and
1695 simply call this method."""
1695 simply call this method."""
1696
1696
1697
1697
1698 # Though this won't be called by syntax errors in the input line,
1698 # Though this won't be called by syntax errors in the input line,
1699 # there may be SyntaxError cases whith imported code.
1699 # there may be SyntaxError cases whith imported code.
1700
1700
1701 try:
1701 try:
1702 if exc_tuple is None:
1702 if exc_tuple is None:
1703 etype, value, tb = sys.exc_info()
1703 etype, value, tb = sys.exc_info()
1704 else:
1704 else:
1705 etype, value, tb = exc_tuple
1705 etype, value, tb = exc_tuple
1706
1706
1707 if etype is SyntaxError:
1707 if etype is SyntaxError:
1708 self.showsyntaxerror(filename)
1708 self.showsyntaxerror(filename)
1709 elif etype is ipapi.UsageError:
1709 elif etype is ipapi.UsageError:
1710 print "UsageError:", value
1710 print "UsageError:", value
1711 else:
1711 else:
1712 # WARNING: these variables are somewhat deprecated and not
1712 # WARNING: these variables are somewhat deprecated and not
1713 # necessarily safe to use in a threaded environment, but tools
1713 # necessarily safe to use in a threaded environment, but tools
1714 # like pdb depend on their existence, so let's set them. If we
1714 # like pdb depend on their existence, so let's set them. If we
1715 # find problems in the field, we'll need to revisit their use.
1715 # find problems in the field, we'll need to revisit their use.
1716 sys.last_type = etype
1716 sys.last_type = etype
1717 sys.last_value = value
1717 sys.last_value = value
1718 sys.last_traceback = tb
1718 sys.last_traceback = tb
1719
1719
1720 if etype in self.custom_exceptions:
1720 if etype in self.custom_exceptions:
1721 self.CustomTB(etype,value,tb)
1721 self.CustomTB(etype,value,tb)
1722 else:
1722 else:
1723 self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
1723 self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
1724 if self.InteractiveTB.call_pdb and self.has_readline:
1724 if self.InteractiveTB.call_pdb and self.has_readline:
1725 # pdb mucks up readline, fix it back
1725 # pdb mucks up readline, fix it back
1726 self.set_completer()
1726 self.set_completer()
1727 except KeyboardInterrupt:
1727 except KeyboardInterrupt:
1728 self.write("\nKeyboardInterrupt\n")
1728 self.write("\nKeyboardInterrupt\n")
1729
1729
1730 def mainloop(self,banner=None):
1730 def mainloop(self,banner=None):
1731 """Creates the local namespace and starts the mainloop.
1731 """Creates the local namespace and starts the mainloop.
1732
1732
1733 If an optional banner argument is given, it will override the
1733 If an optional banner argument is given, it will override the
1734 internally created default banner."""
1734 internally created default banner."""
1735
1735
1736 if self.rc.c: # Emulate Python's -c option
1736 if self.rc.c: # Emulate Python's -c option
1737 self.exec_init_cmd()
1737 self.exec_init_cmd()
1738 if banner is None:
1738 if banner is None:
1739 if not self.rc.banner:
1739 if not self.rc.banner:
1740 banner = ''
1740 banner = ''
1741 # banner is string? Use it directly!
1741 # banner is string? Use it directly!
1742 elif isinstance(self.rc.banner,basestring):
1742 elif isinstance(self.rc.banner,basestring):
1743 banner = self.rc.banner
1743 banner = self.rc.banner
1744 else:
1744 else:
1745 banner = self.BANNER+self.banner2
1745 banner = self.BANNER+self.banner2
1746
1746
1747 # if you run stuff with -c <cmd>, raw hist is not updated
1747 # if you run stuff with -c <cmd>, raw hist is not updated
1748 # ensure that it's in sync
1748 # ensure that it's in sync
1749 if len(self.input_hist) != len (self.input_hist_raw):
1749 if len(self.input_hist) != len (self.input_hist_raw):
1750 self.input_hist_raw = InputList(self.input_hist)
1750 self.input_hist_raw = InputList(self.input_hist)
1751
1751
1752 while 1:
1752 while 1:
1753 try:
1753 try:
1754 self.interact(banner)
1754 self.interact(banner)
1755 #self.interact_with_readline()
1755 #self.interact_with_readline()
1756
1756
1757 # XXX for testing of a readline-decoupled repl loop, call
1757 # XXX for testing of a readline-decoupled repl loop, call
1758 # interact_with_readline above
1758 # interact_with_readline above
1759
1759
1760 break
1760 break
1761 except KeyboardInterrupt:
1761 except KeyboardInterrupt:
1762 # this should not be necessary, but KeyboardInterrupt
1762 # this should not be necessary, but KeyboardInterrupt
1763 # handling seems rather unpredictable...
1763 # handling seems rather unpredictable...
1764 self.write("\nKeyboardInterrupt in interact()\n")
1764 self.write("\nKeyboardInterrupt in interact()\n")
1765
1765
1766 def exec_init_cmd(self):
1766 def exec_init_cmd(self):
1767 """Execute a command given at the command line.
1767 """Execute a command given at the command line.
1768
1768
1769 This emulates Python's -c option."""
1769 This emulates Python's -c option."""
1770
1770
1771 #sys.argv = ['-c']
1771 #sys.argv = ['-c']
1772 self.push(self.prefilter(self.rc.c, False))
1772 self.push(self.prefilter(self.rc.c, False))
1773 if not self.rc.interact:
1773 if not self.rc.interact:
1774 self.ask_exit()
1774 self.ask_exit()
1775
1775
1776 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1776 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1777 """Embeds IPython into a running python program.
1777 """Embeds IPython into a running python program.
1778
1778
1779 Input:
1779 Input:
1780
1780
1781 - header: An optional header message can be specified.
1781 - header: An optional header message can be specified.
1782
1782
1783 - local_ns, global_ns: working namespaces. If given as None, the
1783 - local_ns, global_ns: working namespaces. If given as None, the
1784 IPython-initialized one is updated with __main__.__dict__, so that
1784 IPython-initialized one is updated with __main__.__dict__, so that
1785 program variables become visible but user-specific configuration
1785 program variables become visible but user-specific configuration
1786 remains possible.
1786 remains possible.
1787
1787
1788 - stack_depth: specifies how many levels in the stack to go to
1788 - stack_depth: specifies how many levels in the stack to go to
1789 looking for namespaces (when local_ns and global_ns are None). This
1789 looking for namespaces (when local_ns and global_ns are None). This
1790 allows an intermediate caller to make sure that this function gets
1790 allows an intermediate caller to make sure that this function gets
1791 the namespace from the intended level in the stack. By default (0)
1791 the namespace from the intended level in the stack. By default (0)
1792 it will get its locals and globals from the immediate caller.
1792 it will get its locals and globals from the immediate caller.
1793
1793
1794 Warning: it's possible to use this in a program which is being run by
1794 Warning: it's possible to use this in a program which is being run by
1795 IPython itself (via %run), but some funny things will happen (a few
1795 IPython itself (via %run), but some funny things will happen (a few
1796 globals get overwritten). In the future this will be cleaned up, as
1796 globals get overwritten). In the future this will be cleaned up, as
1797 there is no fundamental reason why it can't work perfectly."""
1797 there is no fundamental reason why it can't work perfectly."""
1798
1798
1799 # Get locals and globals from caller
1799 # Get locals and globals from caller
1800 if local_ns is None or global_ns is None:
1800 if local_ns is None or global_ns is None:
1801 call_frame = sys._getframe(stack_depth).f_back
1801 call_frame = sys._getframe(stack_depth).f_back
1802
1802
1803 if local_ns is None:
1803 if local_ns is None:
1804 local_ns = call_frame.f_locals
1804 local_ns = call_frame.f_locals
1805 if global_ns is None:
1805 if global_ns is None:
1806 global_ns = call_frame.f_globals
1806 global_ns = call_frame.f_globals
1807
1807
1808 # Update namespaces and fire up interpreter
1808 # Update namespaces and fire up interpreter
1809
1809
1810 # The global one is easy, we can just throw it in
1810 # The global one is easy, we can just throw it in
1811 self.user_global_ns = global_ns
1811 self.user_global_ns = global_ns
1812
1812
1813 # but the user/local one is tricky: ipython needs it to store internal
1813 # but the user/local one is tricky: ipython needs it to store internal
1814 # data, but we also need the locals. We'll copy locals in the user
1814 # data, but we also need the locals. We'll copy locals in the user
1815 # one, but will track what got copied so we can delete them at exit.
1815 # one, but will track what got copied so we can delete them at exit.
1816 # This is so that a later embedded call doesn't see locals from a
1816 # This is so that a later embedded call doesn't see locals from a
1817 # previous call (which most likely existed in a separate scope).
1817 # previous call (which most likely existed in a separate scope).
1818 local_varnames = local_ns.keys()
1818 local_varnames = local_ns.keys()
1819 self.user_ns.update(local_ns)
1819 self.user_ns.update(local_ns)
1820 #self.user_ns['local_ns'] = local_ns # dbg
1820 #self.user_ns['local_ns'] = local_ns # dbg
1821
1821
1822 # Patch for global embedding to make sure that things don't overwrite
1822 # Patch for global embedding to make sure that things don't overwrite
1823 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1823 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1824 # FIXME. Test this a bit more carefully (the if.. is new)
1824 # FIXME. Test this a bit more carefully (the if.. is new)
1825 if local_ns is None and global_ns is None:
1825 if local_ns is None and global_ns is None:
1826 self.user_global_ns.update(__main__.__dict__)
1826 self.user_global_ns.update(__main__.__dict__)
1827
1827
1828 # make sure the tab-completer has the correct frame information, so it
1828 # make sure the tab-completer has the correct frame information, so it
1829 # actually completes using the frame's locals/globals
1829 # actually completes using the frame's locals/globals
1830 self.set_completer_frame()
1830 self.set_completer_frame()
1831
1831
1832 # before activating the interactive mode, we need to make sure that
1832 # before activating the interactive mode, we need to make sure that
1833 # all names in the builtin namespace needed by ipython point to
1833 # all names in the builtin namespace needed by ipython point to
1834 # ourselves, and not to other instances.
1834 # ourselves, and not to other instances.
1835 self.add_builtins()
1835 self.add_builtins()
1836
1836
1837 self.interact(header)
1837 self.interact(header)
1838
1838
1839 # now, purge out the user namespace from anything we might have added
1839 # now, purge out the user namespace from anything we might have added
1840 # from the caller's local namespace
1840 # from the caller's local namespace
1841 delvar = self.user_ns.pop
1841 delvar = self.user_ns.pop
1842 for var in local_varnames:
1842 for var in local_varnames:
1843 delvar(var,None)
1843 delvar(var,None)
1844 # and clean builtins we may have overridden
1844 # and clean builtins we may have overridden
1845 self.clean_builtins()
1845 self.clean_builtins()
1846
1846
1847 def interact_prompt(self):
1847 def interact_prompt(self):
1848 """ Print the prompt (in read-eval-print loop)
1848 """ Print the prompt (in read-eval-print loop)
1849
1849
1850 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1850 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1851 used in standard IPython flow.
1851 used in standard IPython flow.
1852 """
1852 """
1853 if self.more:
1853 if self.more:
1854 try:
1854 try:
1855 prompt = self.hooks.generate_prompt(True)
1855 prompt = self.hooks.generate_prompt(True)
1856 except:
1856 except:
1857 self.showtraceback()
1857 self.showtraceback()
1858 if self.autoindent:
1858 if self.autoindent:
1859 self.rl_do_indent = True
1859 self.rl_do_indent = True
1860
1860
1861 else:
1861 else:
1862 try:
1862 try:
1863 prompt = self.hooks.generate_prompt(False)
1863 prompt = self.hooks.generate_prompt(False)
1864 except:
1864 except:
1865 self.showtraceback()
1865 self.showtraceback()
1866 self.write(prompt)
1866 self.write(prompt)
1867
1867
1868 def interact_handle_input(self,line):
1868 def interact_handle_input(self,line):
1869 """ Handle the input line (in read-eval-print loop)
1869 """ Handle the input line (in read-eval-print loop)
1870
1870
1871 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1871 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1872 used in standard IPython flow.
1872 used in standard IPython flow.
1873 """
1873 """
1874 if line.lstrip() == line:
1874 if line.lstrip() == line:
1875 self.shadowhist.add(line.strip())
1875 self.shadowhist.add(line.strip())
1876 lineout = self.prefilter(line,self.more)
1876 lineout = self.prefilter(line,self.more)
1877
1877
1878 if line.strip():
1878 if line.strip():
1879 if self.more:
1879 if self.more:
1880 self.input_hist_raw[-1] += '%s\n' % line
1880 self.input_hist_raw[-1] += '%s\n' % line
1881 else:
1881 else:
1882 self.input_hist_raw.append('%s\n' % line)
1882 self.input_hist_raw.append('%s\n' % line)
1883
1883
1884
1884
1885 self.more = self.push(lineout)
1885 self.more = self.push(lineout)
1886 if (self.SyntaxTB.last_syntax_error and
1886 if (self.SyntaxTB.last_syntax_error and
1887 self.rc.autoedit_syntax):
1887 self.rc.autoedit_syntax):
1888 self.edit_syntax_error()
1888 self.edit_syntax_error()
1889
1889
1890 def interact_with_readline(self):
1890 def interact_with_readline(self):
1891 """ Demo of using interact_handle_input, interact_prompt
1891 """ Demo of using interact_handle_input, interact_prompt
1892
1892
1893 This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
1893 This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
1894 it should work like this.
1894 it should work like this.
1895 """
1895 """
1896 self.readline_startup_hook(self.pre_readline)
1896 self.readline_startup_hook(self.pre_readline)
1897 while not self.exit_now:
1897 while not self.exit_now:
1898 self.interact_prompt()
1898 self.interact_prompt()
1899 if self.more:
1899 if self.more:
1900 self.rl_do_indent = True
1900 self.rl_do_indent = True
1901 else:
1901 else:
1902 self.rl_do_indent = False
1902 self.rl_do_indent = False
1903 line = raw_input_original().decode(self.stdin_encoding)
1903 line = raw_input_original().decode(self.stdin_encoding)
1904 self.interact_handle_input(line)
1904 self.interact_handle_input(line)
1905
1905
1906
1906
1907 def interact(self, banner=None):
1907 def interact(self, banner=None):
1908 """Closely emulate the interactive Python console.
1908 """Closely emulate the interactive Python console.
1909
1909
1910 The optional banner argument specify the banner to print
1910 The optional banner argument specify the banner to print
1911 before the first interaction; by default it prints a banner
1911 before the first interaction; by default it prints a banner
1912 similar to the one printed by the real Python interpreter,
1912 similar to the one printed by the real Python interpreter,
1913 followed by the current class name in parentheses (so as not
1913 followed by the current class name in parentheses (so as not
1914 to confuse this with the real interpreter -- since it's so
1914 to confuse this with the real interpreter -- since it's so
1915 close!).
1915 close!).
1916
1916
1917 """
1917 """
1918
1918
1919 if self.exit_now:
1919 if self.exit_now:
1920 # batch run -> do not interact
1920 # batch run -> do not interact
1921 return
1921 return
1922 cprt = 'Type "copyright", "credits" or "license" for more information.'
1922 cprt = 'Type "copyright", "credits" or "license" for more information.'
1923 if banner is None:
1923 if banner is None:
1924 self.write("Python %s on %s\n%s\n(%s)\n" %
1924 self.write("Python %s on %s\n%s\n(%s)\n" %
1925 (sys.version, sys.platform, cprt,
1925 (sys.version, sys.platform, cprt,
1926 self.__class__.__name__))
1926 self.__class__.__name__))
1927 else:
1927 else:
1928 self.write(banner)
1928 self.write(banner)
1929
1929
1930 more = 0
1930 more = 0
1931
1931
1932 # Mark activity in the builtins
1932 # Mark activity in the builtins
1933 __builtin__.__dict__['__IPYTHON__active'] += 1
1933 __builtin__.__dict__['__IPYTHON__active'] += 1
1934
1934
1935 if self.has_readline:
1935 if self.has_readline:
1936 self.readline_startup_hook(self.pre_readline)
1936 self.readline_startup_hook(self.pre_readline)
1937 # exit_now is set by a call to %Exit or %Quit, through the
1937 # exit_now is set by a call to %Exit or %Quit, through the
1938 # ask_exit callback.
1938 # ask_exit callback.
1939
1939
1940 while not self.exit_now:
1940 while not self.exit_now:
1941 self.hooks.pre_prompt_hook()
1941 self.hooks.pre_prompt_hook()
1942 if more:
1942 if more:
1943 try:
1943 try:
1944 prompt = self.hooks.generate_prompt(True)
1944 prompt = self.hooks.generate_prompt(True)
1945 except:
1945 except:
1946 self.showtraceback()
1946 self.showtraceback()
1947 if self.autoindent:
1947 if self.autoindent:
1948 self.rl_do_indent = True
1948 self.rl_do_indent = True
1949
1949
1950 else:
1950 else:
1951 try:
1951 try:
1952 prompt = self.hooks.generate_prompt(False)
1952 prompt = self.hooks.generate_prompt(False)
1953 except:
1953 except:
1954 self.showtraceback()
1954 self.showtraceback()
1955 try:
1955 try:
1956 line = self.raw_input(prompt,more)
1956 line = self.raw_input(prompt,more)
1957 if self.exit_now:
1957 if self.exit_now:
1958 # quick exit on sys.std[in|out] close
1958 # quick exit on sys.std[in|out] close
1959 break
1959 break
1960 if self.autoindent:
1960 if self.autoindent:
1961 self.rl_do_indent = False
1961 self.rl_do_indent = False
1962
1962
1963 except KeyboardInterrupt:
1963 except KeyboardInterrupt:
1964 #double-guard against keyboardinterrupts during kbdint handling
1964 #double-guard against keyboardinterrupts during kbdint handling
1965 try:
1965 try:
1966 self.write('\nKeyboardInterrupt\n')
1966 self.write('\nKeyboardInterrupt\n')
1967 self.resetbuffer()
1967 self.resetbuffer()
1968 # keep cache in sync with the prompt counter:
1968 # keep cache in sync with the prompt counter:
1969 self.outputcache.prompt_count -= 1
1969 self.outputcache.prompt_count -= 1
1970
1970
1971 if self.autoindent:
1971 if self.autoindent:
1972 self.indent_current_nsp = 0
1972 self.indent_current_nsp = 0
1973 more = 0
1973 more = 0
1974 except KeyboardInterrupt:
1974 except KeyboardInterrupt:
1975 pass
1975 pass
1976 except EOFError:
1976 except EOFError:
1977 if self.autoindent:
1977 if self.autoindent:
1978 self.rl_do_indent = False
1978 self.rl_do_indent = False
1979 self.readline_startup_hook(None)
1979 self.readline_startup_hook(None)
1980 self.write('\n')
1980 self.write('\n')
1981 self.exit()
1981 self.exit()
1982 except bdb.BdbQuit:
1982 except bdb.BdbQuit:
1983 warn('The Python debugger has exited with a BdbQuit exception.\n'
1983 warn('The Python debugger has exited with a BdbQuit exception.\n'
1984 'Because of how pdb handles the stack, it is impossible\n'
1984 'Because of how pdb handles the stack, it is impossible\n'
1985 'for IPython to properly format this particular exception.\n'
1985 'for IPython to properly format this particular exception.\n'
1986 'IPython will resume normal operation.')
1986 'IPython will resume normal operation.')
1987 except:
1987 except:
1988 # exceptions here are VERY RARE, but they can be triggered
1988 # exceptions here are VERY RARE, but they can be triggered
1989 # asynchronously by signal handlers, for example.
1989 # asynchronously by signal handlers, for example.
1990 self.showtraceback()
1990 self.showtraceback()
1991 else:
1991 else:
1992 more = self.push(line)
1992 more = self.push(line)
1993 if (self.SyntaxTB.last_syntax_error and
1993 if (self.SyntaxTB.last_syntax_error and
1994 self.rc.autoedit_syntax):
1994 self.rc.autoedit_syntax):
1995 self.edit_syntax_error()
1995 self.edit_syntax_error()
1996
1996
1997 # We are off again...
1997 # We are off again...
1998 __builtin__.__dict__['__IPYTHON__active'] -= 1
1998 __builtin__.__dict__['__IPYTHON__active'] -= 1
1999
1999
2000 def excepthook(self, etype, value, tb):
2000 def excepthook(self, etype, value, tb):
2001 """One more defense for GUI apps that call sys.excepthook.
2001 """One more defense for GUI apps that call sys.excepthook.
2002
2002
2003 GUI frameworks like wxPython trap exceptions and call
2003 GUI frameworks like wxPython trap exceptions and call
2004 sys.excepthook themselves. I guess this is a feature that
2004 sys.excepthook themselves. I guess this is a feature that
2005 enables them to keep running after exceptions that would
2005 enables them to keep running after exceptions that would
2006 otherwise kill their mainloop. This is a bother for IPython
2006 otherwise kill their mainloop. This is a bother for IPython
2007 which excepts to catch all of the program exceptions with a try:
2007 which excepts to catch all of the program exceptions with a try:
2008 except: statement.
2008 except: statement.
2009
2009
2010 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
2010 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
2011 any app directly invokes sys.excepthook, it will look to the user like
2011 any app directly invokes sys.excepthook, it will look to the user like
2012 IPython crashed. In order to work around this, we can disable the
2012 IPython crashed. In order to work around this, we can disable the
2013 CrashHandler and replace it with this excepthook instead, which prints a
2013 CrashHandler and replace it with this excepthook instead, which prints a
2014 regular traceback using our InteractiveTB. In this fashion, apps which
2014 regular traceback using our InteractiveTB. In this fashion, apps which
2015 call sys.excepthook will generate a regular-looking exception from
2015 call sys.excepthook will generate a regular-looking exception from
2016 IPython, and the CrashHandler will only be triggered by real IPython
2016 IPython, and the CrashHandler will only be triggered by real IPython
2017 crashes.
2017 crashes.
2018
2018
2019 This hook should be used sparingly, only in places which are not likely
2019 This hook should be used sparingly, only in places which are not likely
2020 to be true IPython errors.
2020 to be true IPython errors.
2021 """
2021 """
2022 self.showtraceback((etype,value,tb),tb_offset=0)
2022 self.showtraceback((etype,value,tb),tb_offset=0)
2023
2023
2024 def expand_aliases(self,fn,rest):
2024 def expand_aliases(self,fn,rest):
2025 """ Expand multiple levels of aliases:
2025 """ Expand multiple levels of aliases:
2026
2026
2027 if:
2027 if:
2028
2028
2029 alias foo bar /tmp
2029 alias foo bar /tmp
2030 alias baz foo
2030 alias baz foo
2031
2031
2032 then:
2032 then:
2033
2033
2034 baz huhhahhei -> bar /tmp huhhahhei
2034 baz huhhahhei -> bar /tmp huhhahhei
2035
2035
2036 """
2036 """
2037 line = fn + " " + rest
2037 line = fn + " " + rest
2038
2038
2039 done = set()
2039 done = set()
2040 while 1:
2040 while 1:
2041 pre,fn,rest = prefilter.splitUserInput(line,
2041 pre,fn,rest = prefilter.splitUserInput(line,
2042 prefilter.shell_line_split)
2042 prefilter.shell_line_split)
2043 if fn in self.alias_table:
2043 if fn in self.alias_table:
2044 if fn in done:
2044 if fn in done:
2045 warn("Cyclic alias definition, repeated '%s'" % fn)
2045 warn("Cyclic alias definition, repeated '%s'" % fn)
2046 return ""
2046 return ""
2047 done.add(fn)
2047 done.add(fn)
2048
2048
2049 l2 = self.transform_alias(fn,rest)
2049 l2 = self.transform_alias(fn,rest)
2050 # dir -> dir
2050 # dir -> dir
2051 # print "alias",line, "->",l2 #dbg
2051 # print "alias",line, "->",l2 #dbg
2052 if l2 == line:
2052 if l2 == line:
2053 break
2053 break
2054 # ls -> ls -F should not recurse forever
2054 # ls -> ls -F should not recurse forever
2055 if l2.split(None,1)[0] == line.split(None,1)[0]:
2055 if l2.split(None,1)[0] == line.split(None,1)[0]:
2056 line = l2
2056 line = l2
2057 break
2057 break
2058
2058
2059 line=l2
2059 line=l2
2060
2060
2061
2061
2062 # print "al expand to",line #dbg
2062 # print "al expand to",line #dbg
2063 else:
2063 else:
2064 break
2064 break
2065
2065
2066 return line
2066 return line
2067
2067
2068 def transform_alias(self, alias,rest=''):
2068 def transform_alias(self, alias,rest=''):
2069 """ Transform alias to system command string.
2069 """ Transform alias to system command string.
2070 """
2070 """
2071 trg = self.alias_table[alias]
2071 trg = self.alias_table[alias]
2072
2072
2073 nargs,cmd = trg
2073 nargs,cmd = trg
2074 # print trg #dbg
2074 # print trg #dbg
2075 if ' ' in cmd and os.path.isfile(cmd):
2075 if ' ' in cmd and os.path.isfile(cmd):
2076 cmd = '"%s"' % cmd
2076 cmd = '"%s"' % cmd
2077
2077
2078 # Expand the %l special to be the user's input line
2078 # Expand the %l special to be the user's input line
2079 if cmd.find('%l') >= 0:
2079 if cmd.find('%l') >= 0:
2080 cmd = cmd.replace('%l',rest)
2080 cmd = cmd.replace('%l',rest)
2081 rest = ''
2081 rest = ''
2082 if nargs==0:
2082 if nargs==0:
2083 # Simple, argument-less aliases
2083 # Simple, argument-less aliases
2084 cmd = '%s %s' % (cmd,rest)
2084 cmd = '%s %s' % (cmd,rest)
2085 else:
2085 else:
2086 # Handle aliases with positional arguments
2086 # Handle aliases with positional arguments
2087 args = rest.split(None,nargs)
2087 args = rest.split(None,nargs)
2088 if len(args)< nargs:
2088 if len(args)< nargs:
2089 error('Alias <%s> requires %s arguments, %s given.' %
2089 error('Alias <%s> requires %s arguments, %s given.' %
2090 (alias,nargs,len(args)))
2090 (alias,nargs,len(args)))
2091 return None
2091 return None
2092 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
2092 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
2093 # Now call the macro, evaluating in the user's namespace
2093 # Now call the macro, evaluating in the user's namespace
2094 #print 'new command: <%r>' % cmd # dbg
2094 #print 'new command: <%r>' % cmd # dbg
2095 return cmd
2095 return cmd
2096
2096
2097 def call_alias(self,alias,rest=''):
2097 def call_alias(self,alias,rest=''):
2098 """Call an alias given its name and the rest of the line.
2098 """Call an alias given its name and the rest of the line.
2099
2099
2100 This is only used to provide backwards compatibility for users of
2100 This is only used to provide backwards compatibility for users of
2101 ipalias(), use of which is not recommended for anymore."""
2101 ipalias(), use of which is not recommended for anymore."""
2102
2102
2103 # Now call the macro, evaluating in the user's namespace
2103 # Now call the macro, evaluating in the user's namespace
2104 cmd = self.transform_alias(alias, rest)
2104 cmd = self.transform_alias(alias, rest)
2105 try:
2105 try:
2106 self.system(cmd)
2106 self.system(cmd)
2107 except:
2107 except:
2108 self.showtraceback()
2108 self.showtraceback()
2109
2109
2110 def indent_current_str(self):
2110 def indent_current_str(self):
2111 """return the current level of indentation as a string"""
2111 """return the current level of indentation as a string"""
2112 return self.indent_current_nsp * ' '
2112 return self.indent_current_nsp * ' '
2113
2113
2114 def autoindent_update(self,line):
2114 def autoindent_update(self,line):
2115 """Keep track of the indent level."""
2115 """Keep track of the indent level."""
2116
2116
2117 #debugx('line')
2117 #debugx('line')
2118 #debugx('self.indent_current_nsp')
2118 #debugx('self.indent_current_nsp')
2119 if self.autoindent:
2119 if self.autoindent:
2120 if line:
2120 if line:
2121 inisp = num_ini_spaces(line)
2121 inisp = num_ini_spaces(line)
2122 if inisp < self.indent_current_nsp:
2122 if inisp < self.indent_current_nsp:
2123 self.indent_current_nsp = inisp
2123 self.indent_current_nsp = inisp
2124
2124
2125 if line[-1] == ':':
2125 if line[-1] == ':':
2126 self.indent_current_nsp += 4
2126 self.indent_current_nsp += 4
2127 elif dedent_re.match(line):
2127 elif dedent_re.match(line):
2128 self.indent_current_nsp -= 4
2128 self.indent_current_nsp -= 4
2129 else:
2129 else:
2130 self.indent_current_nsp = 0
2130 self.indent_current_nsp = 0
2131
2131
2132 def runlines(self,lines):
2132 def runlines(self,lines):
2133 """Run a string of one or more lines of source.
2133 """Run a string of one or more lines of source.
2134
2134
2135 This method is capable of running a string containing multiple source
2135 This method is capable of running a string containing multiple source
2136 lines, as if they had been entered at the IPython prompt. Since it
2136 lines, as if they had been entered at the IPython prompt. Since it
2137 exposes IPython's processing machinery, the given strings can contain
2137 exposes IPython's processing machinery, the given strings can contain
2138 magic calls (%magic), special shell access (!cmd), etc."""
2138 magic calls (%magic), special shell access (!cmd), etc."""
2139
2139
2140 # We must start with a clean buffer, in case this is run from an
2140 # We must start with a clean buffer, in case this is run from an
2141 # interactive IPython session (via a magic, for example).
2141 # interactive IPython session (via a magic, for example).
2142 self.resetbuffer()
2142 self.resetbuffer()
2143 lines = lines.split('\n')
2143 lines = lines.split('\n')
2144 more = 0
2144 more = 0
2145
2145
2146 for line in lines:
2146 for line in lines:
2147 # skip blank lines so we don't mess up the prompt counter, but do
2147 # skip blank lines so we don't mess up the prompt counter, but do
2148 # NOT skip even a blank line if we are in a code block (more is
2148 # NOT skip even a blank line if we are in a code block (more is
2149 # true)
2149 # true)
2150
2150
2151 if line or more:
2151 if line or more:
2152 # push to raw history, so hist line numbers stay in sync
2152 # push to raw history, so hist line numbers stay in sync
2153 self.input_hist_raw.append("# " + line + "\n")
2153 self.input_hist_raw.append("# " + line + "\n")
2154 more = self.push(self.prefilter(line,more))
2154 more = self.push(self.prefilter(line,more))
2155 # IPython's runsource returns None if there was an error
2155 # IPython's runsource returns None if there was an error
2156 # compiling the code. This allows us to stop processing right
2156 # compiling the code. This allows us to stop processing right
2157 # away, so the user gets the error message at the right place.
2157 # away, so the user gets the error message at the right place.
2158 if more is None:
2158 if more is None:
2159 break
2159 break
2160 else:
2160 else:
2161 self.input_hist_raw.append("\n")
2161 self.input_hist_raw.append("\n")
2162 # final newline in case the input didn't have it, so that the code
2162 # final newline in case the input didn't have it, so that the code
2163 # actually does get executed
2163 # actually does get executed
2164 if more:
2164 if more:
2165 self.push('\n')
2165 self.push('\n')
2166
2166
2167 def runsource(self, source, filename='<input>', symbol='single'):
2167 def runsource(self, source, filename='<input>', symbol='single'):
2168 """Compile and run some source in the interpreter.
2168 """Compile and run some source in the interpreter.
2169
2169
2170 Arguments are as for compile_command().
2170 Arguments are as for compile_command().
2171
2171
2172 One several things can happen:
2172 One several things can happen:
2173
2173
2174 1) The input is incorrect; compile_command() raised an
2174 1) The input is incorrect; compile_command() raised an
2175 exception (SyntaxError or OverflowError). A syntax traceback
2175 exception (SyntaxError or OverflowError). A syntax traceback
2176 will be printed by calling the showsyntaxerror() method.
2176 will be printed by calling the showsyntaxerror() method.
2177
2177
2178 2) The input is incomplete, and more input is required;
2178 2) The input is incomplete, and more input is required;
2179 compile_command() returned None. Nothing happens.
2179 compile_command() returned None. Nothing happens.
2180
2180
2181 3) The input is complete; compile_command() returned a code
2181 3) The input is complete; compile_command() returned a code
2182 object. The code is executed by calling self.runcode() (which
2182 object. The code is executed by calling self.runcode() (which
2183 also handles run-time exceptions, except for SystemExit).
2183 also handles run-time exceptions, except for SystemExit).
2184
2184
2185 The return value is:
2185 The return value is:
2186
2186
2187 - True in case 2
2187 - True in case 2
2188
2188
2189 - False in the other cases, unless an exception is raised, where
2189 - False in the other cases, unless an exception is raised, where
2190 None is returned instead. This can be used by external callers to
2190 None is returned instead. This can be used by external callers to
2191 know whether to continue feeding input or not.
2191 know whether to continue feeding input or not.
2192
2192
2193 The return value can be used to decide whether to use sys.ps1 or
2193 The return value can be used to decide whether to use sys.ps1 or
2194 sys.ps2 to prompt the next line."""
2194 sys.ps2 to prompt the next line."""
2195
2195
2196 # if the source code has leading blanks, add 'if 1:\n' to it
2196 # if the source code has leading blanks, add 'if 1:\n' to it
2197 # this allows execution of indented pasted code. It is tempting
2197 # this allows execution of indented pasted code. It is tempting
2198 # to add '\n' at the end of source to run commands like ' a=1'
2198 # to add '\n' at the end of source to run commands like ' a=1'
2199 # directly, but this fails for more complicated scenarios
2199 # directly, but this fails for more complicated scenarios
2200 source=source.encode(self.stdin_encoding)
2200 source=source.encode(self.stdin_encoding)
2201 if source[:1] in [' ', '\t']:
2201 if source[:1] in [' ', '\t']:
2202 source = 'if 1:\n%s' % source
2202 source = 'if 1:\n%s' % source
2203
2203
2204 try:
2204 try:
2205 code = self.compile(source,filename,symbol)
2205 code = self.compile(source,filename,symbol)
2206 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2206 except (OverflowError, SyntaxError, ValueError, TypeError, MemoryError):
2207 # Case 1
2207 # Case 1
2208 self.showsyntaxerror(filename)
2208 self.showsyntaxerror(filename)
2209 return None
2209 return None
2210
2210
2211 if code is None:
2211 if code is None:
2212 # Case 2
2212 # Case 2
2213 return True
2213 return True
2214
2214
2215 # Case 3
2215 # Case 3
2216 # We store the code object so that threaded shells and
2216 # We store the code object so that threaded shells and
2217 # custom exception handlers can access all this info if needed.
2217 # custom exception handlers can access all this info if needed.
2218 # The source corresponding to this can be obtained from the
2218 # The source corresponding to this can be obtained from the
2219 # buffer attribute as '\n'.join(self.buffer).
2219 # buffer attribute as '\n'.join(self.buffer).
2220 self.code_to_run = code
2220 self.code_to_run = code
2221 # now actually execute the code object
2221 # now actually execute the code object
2222 if self.runcode(code) == 0:
2222 if self.runcode(code) == 0:
2223 return False
2223 return False
2224 else:
2224 else:
2225 return None
2225 return None
2226
2226
2227 def runcode(self,code_obj):
2227 def runcode(self,code_obj):
2228 """Execute a code object.
2228 """Execute a code object.
2229
2229
2230 When an exception occurs, self.showtraceback() is called to display a
2230 When an exception occurs, self.showtraceback() is called to display a
2231 traceback.
2231 traceback.
2232
2232
2233 Return value: a flag indicating whether the code to be run completed
2233 Return value: a flag indicating whether the code to be run completed
2234 successfully:
2234 successfully:
2235
2235
2236 - 0: successful execution.
2236 - 0: successful execution.
2237 - 1: an error occurred.
2237 - 1: an error occurred.
2238 """
2238 """
2239
2239
2240 # Set our own excepthook in case the user code tries to call it
2240 # Set our own excepthook in case the user code tries to call it
2241 # directly, so that the IPython crash handler doesn't get triggered
2241 # directly, so that the IPython crash handler doesn't get triggered
2242 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2242 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2243
2243
2244 # we save the original sys.excepthook in the instance, in case config
2244 # we save the original sys.excepthook in the instance, in case config
2245 # code (such as magics) needs access to it.
2245 # code (such as magics) needs access to it.
2246 self.sys_excepthook = old_excepthook
2246 self.sys_excepthook = old_excepthook
2247 outflag = 1 # happens in more places, so it's easier as default
2247 outflag = 1 # happens in more places, so it's easier as default
2248 try:
2248 try:
2249 try:
2249 try:
2250 self.hooks.pre_runcode_hook()
2250 self.hooks.pre_runcode_hook()
2251 exec code_obj in self.user_global_ns, self.user_ns
2251 exec code_obj in self.user_global_ns, self.user_ns
2252 finally:
2252 finally:
2253 # Reset our crash handler in place
2253 # Reset our crash handler in place
2254 sys.excepthook = old_excepthook
2254 sys.excepthook = old_excepthook
2255 except SystemExit:
2255 except SystemExit:
2256 self.resetbuffer()
2256 self.resetbuffer()
2257 self.showtraceback()
2257 self.showtraceback()
2258 warn("Type %exit or %quit to exit IPython "
2258 warn("Type %exit or %quit to exit IPython "
2259 "(%Exit or %Quit do so unconditionally).",level=1)
2259 "(%Exit or %Quit do so unconditionally).",level=1)
2260 except self.custom_exceptions:
2260 except self.custom_exceptions:
2261 etype,value,tb = sys.exc_info()
2261 etype,value,tb = sys.exc_info()
2262 self.CustomTB(etype,value,tb)
2262 self.CustomTB(etype,value,tb)
2263 except:
2263 except:
2264 self.showtraceback()
2264 self.showtraceback()
2265 else:
2265 else:
2266 outflag = 0
2266 outflag = 0
2267 if softspace(sys.stdout, 0):
2267 if softspace(sys.stdout, 0):
2268 print
2268 print
2269 # Flush out code object which has been run (and source)
2269 # Flush out code object which has been run (and source)
2270 self.code_to_run = None
2270 self.code_to_run = None
2271 return outflag
2271 return outflag
2272
2272
2273 def push(self, line):
2273 def push(self, line):
2274 """Push a line to the interpreter.
2274 """Push a line to the interpreter.
2275
2275
2276 The line should not have a trailing newline; it may have
2276 The line should not have a trailing newline; it may have
2277 internal newlines. The line is appended to a buffer and the
2277 internal newlines. The line is appended to a buffer and the
2278 interpreter's runsource() method is called with the
2278 interpreter's runsource() method is called with the
2279 concatenated contents of the buffer as source. If this
2279 concatenated contents of the buffer as source. If this
2280 indicates that the command was executed or invalid, the buffer
2280 indicates that the command was executed or invalid, the buffer
2281 is reset; otherwise, the command is incomplete, and the buffer
2281 is reset; otherwise, the command is incomplete, and the buffer
2282 is left as it was after the line was appended. The return
2282 is left as it was after the line was appended. The return
2283 value is 1 if more input is required, 0 if the line was dealt
2283 value is 1 if more input is required, 0 if the line was dealt
2284 with in some way (this is the same as runsource()).
2284 with in some way (this is the same as runsource()).
2285 """
2285 """
2286
2286
2287 # autoindent management should be done here, and not in the
2287 # autoindent management should be done here, and not in the
2288 # interactive loop, since that one is only seen by keyboard input. We
2288 # interactive loop, since that one is only seen by keyboard input. We
2289 # need this done correctly even for code run via runlines (which uses
2289 # need this done correctly even for code run via runlines (which uses
2290 # push).
2290 # push).
2291
2291
2292 #print 'push line: <%s>' % line # dbg
2292 #print 'push line: <%s>' % line # dbg
2293 for subline in line.splitlines():
2293 for subline in line.splitlines():
2294 self.autoindent_update(subline)
2294 self.autoindent_update(subline)
2295 self.buffer.append(line)
2295 self.buffer.append(line)
2296 more = self.runsource('\n'.join(self.buffer), self.filename)
2296 more = self.runsource('\n'.join(self.buffer), self.filename)
2297 if not more:
2297 if not more:
2298 self.resetbuffer()
2298 self.resetbuffer()
2299 return more
2299 return more
2300
2300
2301 def split_user_input(self, line):
2301 def split_user_input(self, line):
2302 # This is really a hold-over to support ipapi and some extensions
2302 # This is really a hold-over to support ipapi and some extensions
2303 return prefilter.splitUserInput(line)
2303 return prefilter.splitUserInput(line)
2304
2304
2305 def resetbuffer(self):
2305 def resetbuffer(self):
2306 """Reset the input buffer."""
2306 """Reset the input buffer."""
2307 self.buffer[:] = []
2307 self.buffer[:] = []
2308
2308
2309 def raw_input(self,prompt='',continue_prompt=False):
2309 def raw_input(self,prompt='',continue_prompt=False):
2310 """Write a prompt and read a line.
2310 """Write a prompt and read a line.
2311
2311
2312 The returned line does not include the trailing newline.
2312 The returned line does not include the trailing newline.
2313 When the user enters the EOF key sequence, EOFError is raised.
2313 When the user enters the EOF key sequence, EOFError is raised.
2314
2314
2315 Optional inputs:
2315 Optional inputs:
2316
2316
2317 - prompt(''): a string to be printed to prompt the user.
2317 - prompt(''): a string to be printed to prompt the user.
2318
2318
2319 - continue_prompt(False): whether this line is the first one or a
2319 - continue_prompt(False): whether this line is the first one or a
2320 continuation in a sequence of inputs.
2320 continuation in a sequence of inputs.
2321 """
2321 """
2322
2322
2323 # Code run by the user may have modified the readline completer state.
2323 # Code run by the user may have modified the readline completer state.
2324 # We must ensure that our completer is back in place.
2324 # We must ensure that our completer is back in place.
2325 if self.has_readline:
2325 if self.has_readline:
2326 self.set_completer()
2326 self.set_completer()
2327
2327
2328 try:
2328 try:
2329 line = raw_input_original(prompt).decode(self.stdin_encoding)
2329 line = raw_input_original(prompt).decode(self.stdin_encoding)
2330 except ValueError:
2330 except ValueError:
2331 warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
2331 warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
2332 " or sys.stdout.close()!\nExiting IPython!")
2332 " or sys.stdout.close()!\nExiting IPython!")
2333 self.ask_exit()
2333 self.ask_exit()
2334 return ""
2334 return ""
2335
2335
2336 # Try to be reasonably smart about not re-indenting pasted input more
2336 # Try to be reasonably smart about not re-indenting pasted input more
2337 # than necessary. We do this by trimming out the auto-indent initial
2337 # than necessary. We do this by trimming out the auto-indent initial
2338 # spaces, if the user's actual input started itself with whitespace.
2338 # spaces, if the user's actual input started itself with whitespace.
2339 #debugx('self.buffer[-1]')
2339 #debugx('self.buffer[-1]')
2340
2340
2341 if self.autoindent:
2341 if self.autoindent:
2342 if num_ini_spaces(line) > self.indent_current_nsp:
2342 if num_ini_spaces(line) > self.indent_current_nsp:
2343 line = line[self.indent_current_nsp:]
2343 line = line[self.indent_current_nsp:]
2344 self.indent_current_nsp = 0
2344 self.indent_current_nsp = 0
2345
2345
2346 # store the unfiltered input before the user has any chance to modify
2346 # store the unfiltered input before the user has any chance to modify
2347 # it.
2347 # it.
2348 if line.strip():
2348 if line.strip():
2349 if continue_prompt:
2349 if continue_prompt:
2350 self.input_hist_raw[-1] += '%s\n' % line
2350 self.input_hist_raw[-1] += '%s\n' % line
2351 if self.has_readline: # and some config option is set?
2351 if self.has_readline: # and some config option is set?
2352 try:
2352 try:
2353 histlen = self.readline.get_current_history_length()
2353 histlen = self.readline.get_current_history_length()
2354 if histlen > 1:
2354 if histlen > 1:
2355 newhist = self.input_hist_raw[-1].rstrip()
2355 newhist = self.input_hist_raw[-1].rstrip()
2356 self.readline.remove_history_item(histlen-1)
2356 self.readline.remove_history_item(histlen-1)
2357 self.readline.replace_history_item(histlen-2,
2357 self.readline.replace_history_item(histlen-2,
2358 newhist.encode(self.stdin_encoding))
2358 newhist.encode(self.stdin_encoding))
2359 except AttributeError:
2359 except AttributeError:
2360 pass # re{move,place}_history_item are new in 2.4.
2360 pass # re{move,place}_history_item are new in 2.4.
2361 else:
2361 else:
2362 self.input_hist_raw.append('%s\n' % line)
2362 self.input_hist_raw.append('%s\n' % line)
2363 # only entries starting at first column go to shadow history
2363 # only entries starting at first column go to shadow history
2364 if line.lstrip() == line:
2364 if line.lstrip() == line:
2365 self.shadowhist.add(line.strip())
2365 self.shadowhist.add(line.strip())
2366 elif not continue_prompt:
2366 elif not continue_prompt:
2367 self.input_hist_raw.append('\n')
2367 self.input_hist_raw.append('\n')
2368 try:
2368 try:
2369 lineout = self.prefilter(line,continue_prompt)
2369 lineout = self.prefilter(line,continue_prompt)
2370 except:
2370 except:
2371 # blanket except, in case a user-defined prefilter crashes, so it
2371 # blanket except, in case a user-defined prefilter crashes, so it
2372 # can't take all of ipython with it.
2372 # can't take all of ipython with it.
2373 self.showtraceback()
2373 self.showtraceback()
2374 return ''
2374 return ''
2375 else:
2375 else:
2376 return lineout
2376 return lineout
2377
2377
2378 def _prefilter(self, line, continue_prompt):
2378 def _prefilter(self, line, continue_prompt):
2379 """Calls different preprocessors, depending on the form of line."""
2379 """Calls different preprocessors, depending on the form of line."""
2380
2380
2381 # All handlers *must* return a value, even if it's blank ('').
2381 # All handlers *must* return a value, even if it's blank ('').
2382
2382
2383 # Lines are NOT logged here. Handlers should process the line as
2383 # Lines are NOT logged here. Handlers should process the line as
2384 # needed, update the cache AND log it (so that the input cache array
2384 # needed, update the cache AND log it (so that the input cache array
2385 # stays synced).
2385 # stays synced).
2386
2386
2387 #.....................................................................
2387 #.....................................................................
2388 # Code begins
2388 # Code begins
2389
2389
2390 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
2390 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
2391
2391
2392 # save the line away in case we crash, so the post-mortem handler can
2392 # save the line away in case we crash, so the post-mortem handler can
2393 # record it
2393 # record it
2394 self._last_input_line = line
2394 self._last_input_line = line
2395
2395
2396 #print '***line: <%s>' % line # dbg
2396 #print '***line: <%s>' % line # dbg
2397
2397
2398 if not line:
2398 if not line:
2399 # Return immediately on purely empty lines, so that if the user
2399 # Return immediately on purely empty lines, so that if the user
2400 # previously typed some whitespace that started a continuation
2400 # previously typed some whitespace that started a continuation
2401 # prompt, he can break out of that loop with just an empty line.
2401 # prompt, he can break out of that loop with just an empty line.
2402 # This is how the default python prompt works.
2402 # This is how the default python prompt works.
2403
2403
2404 # Only return if the accumulated input buffer was just whitespace!
2404 # Only return if the accumulated input buffer was just whitespace!
2405 if ''.join(self.buffer).isspace():
2405 if ''.join(self.buffer).isspace():
2406 self.buffer[:] = []
2406 self.buffer[:] = []
2407 return ''
2407 return ''
2408
2408
2409 line_info = prefilter.LineInfo(line, continue_prompt)
2409 line_info = prefilter.LineInfo(line, continue_prompt)
2410
2410
2411 # the input history needs to track even empty lines
2411 # the input history needs to track even empty lines
2412 stripped = line.strip()
2412 stripped = line.strip()
2413
2413
2414 if not stripped:
2414 if not stripped:
2415 if not continue_prompt:
2415 if not continue_prompt:
2416 self.outputcache.prompt_count -= 1
2416 self.outputcache.prompt_count -= 1
2417 return self.handle_normal(line_info)
2417 return self.handle_normal(line_info)
2418
2418
2419 # print '***cont',continue_prompt # dbg
2419 # print '***cont',continue_prompt # dbg
2420 # special handlers are only allowed for single line statements
2420 # special handlers are only allowed for single line statements
2421 if continue_prompt and not self.rc.multi_line_specials:
2421 if continue_prompt and not self.rc.multi_line_specials:
2422 return self.handle_normal(line_info)
2422 return self.handle_normal(line_info)
2423
2423
2424
2424
2425 # See whether any pre-existing handler can take care of it
2425 # See whether any pre-existing handler can take care of it
2426 rewritten = self.hooks.input_prefilter(stripped)
2426 rewritten = self.hooks.input_prefilter(stripped)
2427 if rewritten != stripped: # ok, some prefilter did something
2427 if rewritten != stripped: # ok, some prefilter did something
2428 rewritten = line_info.pre + rewritten # add indentation
2428 rewritten = line_info.pre + rewritten # add indentation
2429 return self.handle_normal(prefilter.LineInfo(rewritten,
2429 return self.handle_normal(prefilter.LineInfo(rewritten,
2430 continue_prompt))
2430 continue_prompt))
2431
2431
2432 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2432 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2433
2433
2434 return prefilter.prefilter(line_info, self)
2434 return prefilter.prefilter(line_info, self)
2435
2435
2436
2436
2437 def _prefilter_dumb(self, line, continue_prompt):
2437 def _prefilter_dumb(self, line, continue_prompt):
2438 """simple prefilter function, for debugging"""
2438 """simple prefilter function, for debugging"""
2439 return self.handle_normal(line,continue_prompt)
2439 return self.handle_normal(line,continue_prompt)
2440
2440
2441
2441
2442 def multiline_prefilter(self, line, continue_prompt):
2442 def multiline_prefilter(self, line, continue_prompt):
2443 """ Run _prefilter for each line of input
2443 """ Run _prefilter for each line of input
2444
2444
2445 Covers cases where there are multiple lines in the user entry,
2445 Covers cases where there are multiple lines in the user entry,
2446 which is the case when the user goes back to a multiline history
2446 which is the case when the user goes back to a multiline history
2447 entry and presses enter.
2447 entry and presses enter.
2448
2448
2449 """
2449 """
2450 out = []
2450 out = []
2451 for l in line.rstrip('\n').split('\n'):
2451 for l in line.rstrip('\n').split('\n'):
2452 out.append(self._prefilter(l, continue_prompt))
2452 out.append(self._prefilter(l, continue_prompt))
2453 return '\n'.join(out)
2453 return '\n'.join(out)
2454
2454
2455 # Set the default prefilter() function (this can be user-overridden)
2455 # Set the default prefilter() function (this can be user-overridden)
2456 prefilter = multiline_prefilter
2456 prefilter = multiline_prefilter
2457
2457
2458 def handle_normal(self,line_info):
2458 def handle_normal(self,line_info):
2459 """Handle normal input lines. Use as a template for handlers."""
2459 """Handle normal input lines. Use as a template for handlers."""
2460
2460
2461 # With autoindent on, we need some way to exit the input loop, and I
2461 # With autoindent on, we need some way to exit the input loop, and I
2462 # don't want to force the user to have to backspace all the way to
2462 # don't want to force the user to have to backspace all the way to
2463 # clear the line. The rule will be in this case, that either two
2463 # clear the line. The rule will be in this case, that either two
2464 # lines of pure whitespace in a row, or a line of pure whitespace but
2464 # lines of pure whitespace in a row, or a line of pure whitespace but
2465 # of a size different to the indent level, will exit the input loop.
2465 # of a size different to the indent level, will exit the input loop.
2466 line = line_info.line
2466 line = line_info.line
2467 continue_prompt = line_info.continue_prompt
2467 continue_prompt = line_info.continue_prompt
2468
2468
2469 if (continue_prompt and self.autoindent and line.isspace() and
2469 if (continue_prompt and self.autoindent and line.isspace() and
2470 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
2470 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
2471 (self.buffer[-1]).isspace() )):
2471 (self.buffer[-1]).isspace() )):
2472 line = ''
2472 line = ''
2473
2473
2474 self.log(line,line,continue_prompt)
2474 self.log(line,line,continue_prompt)
2475 return line
2475 return line
2476
2476
2477 def handle_alias(self,line_info):
2477 def handle_alias(self,line_info):
2478 """Handle alias input lines. """
2478 """Handle alias input lines. """
2479 tgt = self.alias_table[line_info.iFun]
2479 tgt = self.alias_table[line_info.iFun]
2480 # print "=>",tgt #dbg
2480 # print "=>",tgt #dbg
2481 if callable(tgt):
2481 if callable(tgt):
2482 if '$' in line_info.line:
2482 if '$' in line_info.line:
2483 call_meth = '(_ip, _ip.itpl(%s))'
2483 call_meth = '(_ip, _ip.itpl(%s))'
2484 else:
2484 else:
2485 call_meth = '(_ip,%s)'
2485 call_meth = '(_ip,%s)'
2486 line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace,
2486 line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace,
2487 line_info.iFun,
2487 line_info.iFun,
2488 make_quoted_expr(line_info.line))
2488 make_quoted_expr(line_info.line))
2489 else:
2489 else:
2490 transformed = self.expand_aliases(line_info.iFun,line_info.theRest)
2490 transformed = self.expand_aliases(line_info.iFun,line_info.theRest)
2491
2491
2492 # pre is needed, because it carries the leading whitespace. Otherwise
2492 # pre is needed, because it carries the leading whitespace. Otherwise
2493 # aliases won't work in indented sections.
2493 # aliases won't work in indented sections.
2494 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2494 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2495 make_quoted_expr( transformed ))
2495 make_quoted_expr( transformed ))
2496
2496
2497 self.log(line_info.line,line_out,line_info.continue_prompt)
2497 self.log(line_info.line,line_out,line_info.continue_prompt)
2498 #print 'line out:',line_out # dbg
2498 #print 'line out:',line_out # dbg
2499 return line_out
2499 return line_out
2500
2500
2501 def handle_shell_escape(self, line_info):
2501 def handle_shell_escape(self, line_info):
2502 """Execute the line in a shell, empty return value"""
2502 """Execute the line in a shell, empty return value"""
2503 #print 'line in :', `line` # dbg
2503 #print 'line in :', `line` # dbg
2504 line = line_info.line
2504 line = line_info.line
2505 if line.lstrip().startswith('!!'):
2505 if line.lstrip().startswith('!!'):
2506 # rewrite LineInfo's line, iFun and theRest to properly hold the
2506 # rewrite LineInfo's line, iFun and theRest to properly hold the
2507 # call to %sx and the actual command to be executed, so
2507 # call to %sx and the actual command to be executed, so
2508 # handle_magic can work correctly. Note that this works even if
2508 # handle_magic can work correctly. Note that this works even if
2509 # the line is indented, so it handles multi_line_specials
2509 # the line is indented, so it handles multi_line_specials
2510 # properly.
2510 # properly.
2511 new_rest = line.lstrip()[2:]
2511 new_rest = line.lstrip()[2:]
2512 line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest)
2512 line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest)
2513 line_info.iFun = 'sx'
2513 line_info.iFun = 'sx'
2514 line_info.theRest = new_rest
2514 line_info.theRest = new_rest
2515 return self.handle_magic(line_info)
2515 return self.handle_magic(line_info)
2516 else:
2516 else:
2517 cmd = line.lstrip().lstrip('!')
2517 cmd = line.lstrip().lstrip('!')
2518 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2518 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2519 make_quoted_expr(cmd))
2519 make_quoted_expr(cmd))
2520 # update cache/log and return
2520 # update cache/log and return
2521 self.log(line,line_out,line_info.continue_prompt)
2521 self.log(line,line_out,line_info.continue_prompt)
2522 return line_out
2522 return line_out
2523
2523
2524 def handle_magic(self, line_info):
2524 def handle_magic(self, line_info):
2525 """Execute magic functions."""
2525 """Execute magic functions."""
2526 iFun = line_info.iFun
2526 iFun = line_info.iFun
2527 theRest = line_info.theRest
2527 theRest = line_info.theRest
2528 cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace,
2528 cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace,
2529 make_quoted_expr(iFun + " " + theRest))
2529 make_quoted_expr(iFun + " " + theRest))
2530 self.log(line_info.line,cmd,line_info.continue_prompt)
2530 self.log(line_info.line,cmd,line_info.continue_prompt)
2531 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2531 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2532 return cmd
2532 return cmd
2533
2533
2534 def handle_auto(self, line_info):
2534 def handle_auto(self, line_info):
2535 """Hande lines which can be auto-executed, quoting if requested."""
2535 """Hande lines which can be auto-executed, quoting if requested."""
2536
2536
2537 line = line_info.line
2537 line = line_info.line
2538 iFun = line_info.iFun
2538 iFun = line_info.iFun
2539 theRest = line_info.theRest
2539 theRest = line_info.theRest
2540 pre = line_info.pre
2540 pre = line_info.pre
2541 continue_prompt = line_info.continue_prompt
2541 continue_prompt = line_info.continue_prompt
2542 obj = line_info.ofind(self)['obj']
2542 obj = line_info.ofind(self)['obj']
2543
2543
2544 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2544 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2545
2545
2546 # This should only be active for single-line input!
2546 # This should only be active for single-line input!
2547 if continue_prompt:
2547 if continue_prompt:
2548 self.log(line,line,continue_prompt)
2548 self.log(line,line,continue_prompt)
2549 return line
2549 return line
2550
2550
2551 force_auto = isinstance(obj, ipapi.IPyAutocall)
2551 force_auto = isinstance(obj, ipapi.IPyAutocall)
2552 auto_rewrite = True
2552 auto_rewrite = True
2553
2553
2554 if pre == self.ESC_QUOTE:
2554 if pre == self.ESC_QUOTE:
2555 # Auto-quote splitting on whitespace
2555 # Auto-quote splitting on whitespace
2556 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2556 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2557 elif pre == self.ESC_QUOTE2:
2557 elif pre == self.ESC_QUOTE2:
2558 # Auto-quote whole string
2558 # Auto-quote whole string
2559 newcmd = '%s("%s")' % (iFun,theRest)
2559 newcmd = '%s("%s")' % (iFun,theRest)
2560 elif pre == self.ESC_PAREN:
2560 elif pre == self.ESC_PAREN:
2561 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2561 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2562 else:
2562 else:
2563 # Auto-paren.
2563 # Auto-paren.
2564 # We only apply it to argument-less calls if the autocall
2564 # We only apply it to argument-less calls if the autocall
2565 # parameter is set to 2. We only need to check that autocall is <
2565 # parameter is set to 2. We only need to check that autocall is <
2566 # 2, since this function isn't called unless it's at least 1.
2566 # 2, since this function isn't called unless it's at least 1.
2567 if not theRest and (self.rc.autocall < 2) and not force_auto:
2567 if not theRest and (self.rc.autocall < 2) and not force_auto:
2568 newcmd = '%s %s' % (iFun,theRest)
2568 newcmd = '%s %s' % (iFun,theRest)
2569 auto_rewrite = False
2569 auto_rewrite = False
2570 else:
2570 else:
2571 if not force_auto and theRest.startswith('['):
2571 if not force_auto and theRest.startswith('['):
2572 if hasattr(obj,'__getitem__'):
2572 if hasattr(obj,'__getitem__'):
2573 # Don't autocall in this case: item access for an object
2573 # Don't autocall in this case: item access for an object
2574 # which is BOTH callable and implements __getitem__.
2574 # which is BOTH callable and implements __getitem__.
2575 newcmd = '%s %s' % (iFun,theRest)
2575 newcmd = '%s %s' % (iFun,theRest)
2576 auto_rewrite = False
2576 auto_rewrite = False
2577 else:
2577 else:
2578 # if the object doesn't support [] access, go ahead and
2578 # if the object doesn't support [] access, go ahead and
2579 # autocall
2579 # autocall
2580 newcmd = '%s(%s)' % (iFun.rstrip(),theRest)
2580 newcmd = '%s(%s)' % (iFun.rstrip(),theRest)
2581 elif theRest.endswith(';'):
2581 elif theRest.endswith(';'):
2582 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2582 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2583 else:
2583 else:
2584 newcmd = '%s(%s)' % (iFun.rstrip(), theRest)
2584 newcmd = '%s(%s)' % (iFun.rstrip(), theRest)
2585
2585
2586 if auto_rewrite:
2586 if auto_rewrite:
2587 rw = self.outputcache.prompt1.auto_rewrite() + newcmd
2587 rw = self.outputcache.prompt1.auto_rewrite() + newcmd
2588
2588
2589 try:
2589 try:
2590 # plain ascii works better w/ pyreadline, on some machines, so
2590 # plain ascii works better w/ pyreadline, on some machines, so
2591 # we use it and only print uncolored rewrite if we have unicode
2591 # we use it and only print uncolored rewrite if we have unicode
2592 rw = str(rw)
2592 rw = str(rw)
2593 print >>Term.cout, rw
2593 print >>Term.cout, rw
2594 except UnicodeEncodeError:
2594 except UnicodeEncodeError:
2595 print "-------------->" + newcmd
2595 print "-------------->" + newcmd
2596
2596
2597 # log what is now valid Python, not the actual user input (without the
2597 # log what is now valid Python, not the actual user input (without the
2598 # final newline)
2598 # final newline)
2599 self.log(line,newcmd,continue_prompt)
2599 self.log(line,newcmd,continue_prompt)
2600 return newcmd
2600 return newcmd
2601
2601
2602 def handle_help(self, line_info):
2602 def handle_help(self, line_info):
2603 """Try to get some help for the object.
2603 """Try to get some help for the object.
2604
2604
2605 obj? or ?obj -> basic information.
2605 obj? or ?obj -> basic information.
2606 obj?? or ??obj -> more details.
2606 obj?? or ??obj -> more details.
2607 """
2607 """
2608
2608
2609 line = line_info.line
2609 line = line_info.line
2610 # We need to make sure that we don't process lines which would be
2610 # We need to make sure that we don't process lines which would be
2611 # otherwise valid python, such as "x=1 # what?"
2611 # otherwise valid python, such as "x=1 # what?"
2612 try:
2612 try:
2613 codeop.compile_command(line)
2613 codeop.compile_command(line)
2614 except SyntaxError:
2614 except SyntaxError:
2615 # We should only handle as help stuff which is NOT valid syntax
2615 # We should only handle as help stuff which is NOT valid syntax
2616 if line[0]==self.ESC_HELP:
2616 if line[0]==self.ESC_HELP:
2617 line = line[1:]
2617 line = line[1:]
2618 elif line[-1]==self.ESC_HELP:
2618 elif line[-1]==self.ESC_HELP:
2619 line = line[:-1]
2619 line = line[:-1]
2620 self.log(line,'#?'+line,line_info.continue_prompt)
2620 self.log(line,'#?'+line,line_info.continue_prompt)
2621 if line:
2621 if line:
2622 #print 'line:<%r>' % line # dbg
2622 #print 'line:<%r>' % line # dbg
2623 self.magic_pinfo(line)
2623 self.magic_pinfo(line)
2624 else:
2624 else:
2625 page(self.usage,screen_lines=self.rc.screen_length)
2625 page(self.usage,screen_lines=self.rc.screen_length)
2626 return '' # Empty string is needed here!
2626 return '' # Empty string is needed here!
2627 except:
2627 except:
2628 # Pass any other exceptions through to the normal handler
2628 # Pass any other exceptions through to the normal handler
2629 return self.handle_normal(line_info)
2629 return self.handle_normal(line_info)
2630 else:
2630 else:
2631 # If the code compiles ok, we should handle it normally
2631 # If the code compiles ok, we should handle it normally
2632 return self.handle_normal(line_info)
2632 return self.handle_normal(line_info)
2633
2633
2634 def getapi(self):
2634 def getapi(self):
2635 """ Get an IPApi object for this shell instance
2635 """ Get an IPApi object for this shell instance
2636
2636
2637 Getting an IPApi object is always preferable to accessing the shell
2637 Getting an IPApi object is always preferable to accessing the shell
2638 directly, but this holds true especially for extensions.
2638 directly, but this holds true especially for extensions.
2639
2639
2640 It should always be possible to implement an extension with IPApi
2640 It should always be possible to implement an extension with IPApi
2641 alone. If not, contact maintainer to request an addition.
2641 alone. If not, contact maintainer to request an addition.
2642
2642
2643 """
2643 """
2644 return self.api
2644 return self.api
2645
2645
2646 def handle_emacs(self, line_info):
2646 def handle_emacs(self, line_info):
2647 """Handle input lines marked by python-mode."""
2647 """Handle input lines marked by python-mode."""
2648
2648
2649 # Currently, nothing is done. Later more functionality can be added
2649 # Currently, nothing is done. Later more functionality can be added
2650 # here if needed.
2650 # here if needed.
2651
2651
2652 # The input cache shouldn't be updated
2652 # The input cache shouldn't be updated
2653 return line_info.line
2653 return line_info.line
2654
2654
2655
2655
2656 def mktempfile(self,data=None):
2656 def mktempfile(self,data=None):
2657 """Make a new tempfile and return its filename.
2657 """Make a new tempfile and return its filename.
2658
2658
2659 This makes a call to tempfile.mktemp, but it registers the created
2659 This makes a call to tempfile.mktemp, but it registers the created
2660 filename internally so ipython cleans it up at exit time.
2660 filename internally so ipython cleans it up at exit time.
2661
2661
2662 Optional inputs:
2662 Optional inputs:
2663
2663
2664 - data(None): if data is given, it gets written out to the temp file
2664 - data(None): if data is given, it gets written out to the temp file
2665 immediately, and the file is closed again."""
2665 immediately, and the file is closed again."""
2666
2666
2667 filename = tempfile.mktemp('.py','ipython_edit_')
2667 filename = tempfile.mktemp('.py','ipython_edit_')
2668 self.tempfiles.append(filename)
2668 self.tempfiles.append(filename)
2669
2669
2670 if data:
2670 if data:
2671 tmp_file = open(filename,'w')
2671 tmp_file = open(filename,'w')
2672 tmp_file.write(data)
2672 tmp_file.write(data)
2673 tmp_file.close()
2673 tmp_file.close()
2674 return filename
2674 return filename
2675
2675
2676 def write(self,data):
2676 def write(self,data):
2677 """Write a string to the default output"""
2677 """Write a string to the default output"""
2678 Term.cout.write(data)
2678 Term.cout.write(data)
2679
2679
2680 def write_err(self,data):
2680 def write_err(self,data):
2681 """Write a string to the default error output"""
2681 """Write a string to the default error output"""
2682 Term.cerr.write(data)
2682 Term.cerr.write(data)
2683
2683
2684 def ask_exit(self):
2684 def ask_exit(self):
2685 """ Call for exiting. Can be overiden and used as a callback. """
2685 """ Call for exiting. Can be overiden and used as a callback. """
2686 self.exit_now = True
2686 self.exit_now = True
2687
2687
2688 def exit(self):
2688 def exit(self):
2689 """Handle interactive exit.
2689 """Handle interactive exit.
2690
2690
2691 This method calls the ask_exit callback."""
2691 This method calls the ask_exit callback."""
2692
2692
2693 if self.rc.confirm_exit:
2693 if self.rc.confirm_exit:
2694 if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2694 if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2695 self.ask_exit()
2695 self.ask_exit()
2696 else:
2696 else:
2697 self.ask_exit()
2697 self.ask_exit()
2698
2698
2699 def safe_execfile(self,fname,*where,**kw):
2699 def safe_execfile(self,fname,*where,**kw):
2700 """A safe version of the builtin execfile().
2700 """A safe version of the builtin execfile().
2701
2701
2702 This version will never throw an exception, and knows how to handle
2702 This version will never throw an exception, and knows how to handle
2703 ipython logs as well.
2703 ipython logs as well.
2704
2704
2705 :Parameters:
2705 :Parameters:
2706 fname : string
2706 fname : string
2707 Name of the file to be executed.
2707 Name of the file to be executed.
2708
2708
2709 where : tuple
2709 where : tuple
2710 One or two namespaces, passed to execfile() as (globals,locals).
2710 One or two namespaces, passed to execfile() as (globals,locals).
2711 If only one is given, it is passed as both.
2711 If only one is given, it is passed as both.
2712
2712
2713 :Keywords:
2713 :Keywords:
2714 islog : boolean (False)
2714 islog : boolean (False)
2715
2715
2716 quiet : boolean (True)
2716 quiet : boolean (True)
2717
2717
2718 exit_ignore : boolean (False)
2718 exit_ignore : boolean (False)
2719 """
2719 """
2720
2720
2721 def syspath_cleanup():
2721 def syspath_cleanup():
2722 """Internal cleanup routine for sys.path."""
2722 """Internal cleanup routine for sys.path."""
2723 if add_dname:
2723 if add_dname:
2724 try:
2724 try:
2725 sys.path.remove(dname)
2725 sys.path.remove(dname)
2726 except ValueError:
2726 except ValueError:
2727 # For some reason the user has already removed it, ignore.
2727 # For some reason the user has already removed it, ignore.
2728 pass
2728 pass
2729
2729
2730 fname = os.path.expanduser(fname)
2730 fname = os.path.expanduser(fname)
2731
2731
2732 # Find things also in current directory. This is needed to mimic the
2732 # Find things also in current directory. This is needed to mimic the
2733 # behavior of running a script from the system command line, where
2733 # behavior of running a script from the system command line, where
2734 # Python inserts the script's directory into sys.path
2734 # Python inserts the script's directory into sys.path
2735 dname = os.path.dirname(os.path.abspath(fname))
2735 dname = os.path.dirname(os.path.abspath(fname))
2736 add_dname = False
2736 add_dname = False
2737 if dname not in sys.path:
2737 if dname not in sys.path:
2738 sys.path.insert(0,dname)
2738 sys.path.insert(0,dname)
2739 add_dname = True
2739 add_dname = True
2740
2740
2741 try:
2741 try:
2742 xfile = open(fname)
2742 xfile = open(fname)
2743 except:
2743 except:
2744 print >> Term.cerr, \
2744 print >> Term.cerr, \
2745 'Could not open file <%s> for safe execution.' % fname
2745 'Could not open file <%s> for safe execution.' % fname
2746 syspath_cleanup()
2746 syspath_cleanup()
2747 return None
2747 return None
2748
2748
2749 kw.setdefault('islog',0)
2749 kw.setdefault('islog',0)
2750 kw.setdefault('quiet',1)
2750 kw.setdefault('quiet',1)
2751 kw.setdefault('exit_ignore',0)
2751 kw.setdefault('exit_ignore',0)
2752
2752
2753 first = xfile.readline()
2753 first = xfile.readline()
2754 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2754 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2755 xfile.close()
2755 xfile.close()
2756 # line by line execution
2756 # line by line execution
2757 if first.startswith(loghead) or kw['islog']:
2757 if first.startswith(loghead) or kw['islog']:
2758 print 'Loading log file <%s> one line at a time...' % fname
2758 print 'Loading log file <%s> one line at a time...' % fname
2759 if kw['quiet']:
2759 if kw['quiet']:
2760 stdout_save = sys.stdout
2760 stdout_save = sys.stdout
2761 sys.stdout = StringIO.StringIO()
2761 sys.stdout = StringIO.StringIO()
2762 try:
2762 try:
2763 globs,locs = where[0:2]
2763 globs,locs = where[0:2]
2764 except:
2764 except:
2765 try:
2765 try:
2766 globs = locs = where[0]
2766 globs = locs = where[0]
2767 except:
2767 except:
2768 globs = locs = globals()
2768 globs = locs = globals()
2769 badblocks = []
2769 badblocks = []
2770
2770
2771 # we also need to identify indented blocks of code when replaying
2771 # we also need to identify indented blocks of code when replaying
2772 # logs and put them together before passing them to an exec
2772 # logs and put them together before passing them to an exec
2773 # statement. This takes a bit of regexp and look-ahead work in the
2773 # statement. This takes a bit of regexp and look-ahead work in the
2774 # file. It's easiest if we swallow the whole thing in memory
2774 # file. It's easiest if we swallow the whole thing in memory
2775 # first, and manually walk through the lines list moving the
2775 # first, and manually walk through the lines list moving the
2776 # counter ourselves.
2776 # counter ourselves.
2777 indent_re = re.compile('\s+\S')
2777 indent_re = re.compile('\s+\S')
2778 xfile = open(fname)
2778 xfile = open(fname)
2779 filelines = xfile.readlines()
2779 filelines = xfile.readlines()
2780 xfile.close()
2780 xfile.close()
2781 nlines = len(filelines)
2781 nlines = len(filelines)
2782 lnum = 0
2782 lnum = 0
2783 while lnum < nlines:
2783 while lnum < nlines:
2784 line = filelines[lnum]
2784 line = filelines[lnum]
2785 lnum += 1
2785 lnum += 1
2786 # don't re-insert logger status info into cache
2786 # don't re-insert logger status info into cache
2787 if line.startswith('#log#'):
2787 if line.startswith('#log#'):
2788 continue
2788 continue
2789 else:
2789 else:
2790 # build a block of code (maybe a single line) for execution
2790 # build a block of code (maybe a single line) for execution
2791 block = line
2791 block = line
2792 try:
2792 try:
2793 next = filelines[lnum] # lnum has already incremented
2793 next = filelines[lnum] # lnum has already incremented
2794 except:
2794 except:
2795 next = None
2795 next = None
2796 while next and indent_re.match(next):
2796 while next and indent_re.match(next):
2797 block += next
2797 block += next
2798 lnum += 1
2798 lnum += 1
2799 try:
2799 try:
2800 next = filelines[lnum]
2800 next = filelines[lnum]
2801 except:
2801 except:
2802 next = None
2802 next = None
2803 # now execute the block of one or more lines
2803 # now execute the block of one or more lines
2804 try:
2804 try:
2805 exec block in globs,locs
2805 exec block in globs,locs
2806 except SystemExit:
2806 except SystemExit:
2807 pass
2807 pass
2808 except:
2808 except:
2809 badblocks.append(block.rstrip())
2809 badblocks.append(block.rstrip())
2810 if kw['quiet']: # restore stdout
2810 if kw['quiet']: # restore stdout
2811 sys.stdout.close()
2811 sys.stdout.close()
2812 sys.stdout = stdout_save
2812 sys.stdout = stdout_save
2813 print 'Finished replaying log file <%s>' % fname
2813 print 'Finished replaying log file <%s>' % fname
2814 if badblocks:
2814 if badblocks:
2815 print >> sys.stderr, ('\nThe following lines/blocks in file '
2815 print >> sys.stderr, ('\nThe following lines/blocks in file '
2816 '<%s> reported errors:' % fname)
2816 '<%s> reported errors:' % fname)
2817
2817
2818 for badline in badblocks:
2818 for badline in badblocks:
2819 print >> sys.stderr, badline
2819 print >> sys.stderr, badline
2820 else: # regular file execution
2820 else: # regular file execution
2821 try:
2821 try:
2822 if sys.platform == 'win32' and sys.version_info < (2,5,1):
2822 if sys.platform == 'win32' and sys.version_info < (2,5,1):
2823 # Work around a bug in Python for Windows. The bug was
2823 # Work around a bug in Python for Windows. The bug was
2824 # fixed in in Python 2.5 r54159 and 54158, but that's still
2824 # fixed in in Python 2.5 r54159 and 54158, but that's still
2825 # SVN Python as of March/07. For details, see:
2825 # SVN Python as of March/07. For details, see:
2826 # http://projects.scipy.org/ipython/ipython/ticket/123
2826 # http://projects.scipy.org/ipython/ipython/ticket/123
2827 try:
2827 try:
2828 globs,locs = where[0:2]
2828 globs,locs = where[0:2]
2829 except:
2829 except:
2830 try:
2830 try:
2831 globs = locs = where[0]
2831 globs = locs = where[0]
2832 except:
2832 except:
2833 globs = locs = globals()
2833 globs = locs = globals()
2834 exec file(fname) in globs,locs
2834 exec file(fname) in globs,locs
2835 else:
2835 else:
2836 execfile(fname,*where)
2836 execfile(fname,*where)
2837 except SyntaxError:
2837 except SyntaxError:
2838 self.showsyntaxerror()
2838 self.showsyntaxerror()
2839 warn('Failure executing file: <%s>' % fname)
2839 warn('Failure executing file: <%s>' % fname)
2840 except SystemExit,status:
2840 except SystemExit,status:
2841 # Code that correctly sets the exit status flag to success (0)
2841 # Code that correctly sets the exit status flag to success (0)
2842 # shouldn't be bothered with a traceback. Note that a plain
2842 # shouldn't be bothered with a traceback. Note that a plain
2843 # sys.exit() does NOT set the message to 0 (it's empty) so that
2843 # sys.exit() does NOT set the message to 0 (it's empty) so that
2844 # will still get a traceback. Note that the structure of the
2844 # will still get a traceback. Note that the structure of the
2845 # SystemExit exception changed between Python 2.4 and 2.5, so
2845 # SystemExit exception changed between Python 2.4 and 2.5, so
2846 # the checks must be done in a version-dependent way.
2846 # the checks must be done in a version-dependent way.
2847 show = False
2847 show = False
2848
2848
2849 if sys.version_info[:2] > (2,5):
2849 if sys.version_info[:2] > (2,5):
2850 if status.message!=0 and not kw['exit_ignore']:
2850 if status.message!=0 and not kw['exit_ignore']:
2851 show = True
2851 show = True
2852 else:
2852 else:
2853 if status.code and not kw['exit_ignore']:
2853 if status.code and not kw['exit_ignore']:
2854 show = True
2854 show = True
2855 if show:
2855 if show:
2856 self.showtraceback()
2856 self.showtraceback()
2857 warn('Failure executing file: <%s>' % fname)
2857 warn('Failure executing file: <%s>' % fname)
2858 except:
2858 except:
2859 self.showtraceback()
2859 self.showtraceback()
2860 warn('Failure executing file: <%s>' % fname)
2860 warn('Failure executing file: <%s>' % fname)
2861
2861
2862 syspath_cleanup()
2862 syspath_cleanup()
2863
2863
2864 #************************* end of file <iplib.py> *****************************
2864 #************************* end of file <iplib.py> *****************************
1 NO CONTENT: file renamed from IPython/Prompts.py to IPython/core/prompts.py
NO CONTENT: file renamed from IPython/Prompts.py to IPython/core/prompts.py
@@ -1,48 +1,53 b''
1 #!/usr/bin/env python
1 #!/usr/bin/env python
2 # encoding: utf-8
2 # encoding: utf-8
3
3
4 def test_import_completer():
4 def test_import_completer():
5 from IPython.core import completer
5 from IPython.core import completer
6
6
7 def test_import_crashhandler():
7 def test_import_crashhandler():
8 from IPython.core import crashhandler
8 from IPython.core import crashhandler
9
9
10 def test_import_debugger():
10 def test_import_debugger():
11 from IPython.core import debugger
11 from IPython.core import debugger
12
12
13 def test_import_fakemodule():
13 def test_import_fakemodule():
14 from IPython.core import fakemodule
14 from IPython.core import fakemodule
15
15
16 def test_import_excolors():
16 def test_import_excolors():
17 from IPython.core import excolors
17 from IPython.core import excolors
18
18
19 def test_import_history():
19 def test_import_history():
20 from IPython.core import history
20 from IPython.core import history
21
21
22 def test_import_hooks():
22 def test_import_hooks():
23 from IPython.core import hooks
23 from IPython.core import hooks
24
24
25 def test_import_ipapi():
25 def test_import_ipapi():
26 from IPython.core import ipapi
26 from IPython.core import ipapi
27
27
28 def test_import_iplib():
28 def test_import_iplib():
29 from IPython.core import iplib
29 from IPython.core import iplib
30
30
31 def test_import_ipmaker():
31 def test_import_ipmaker():
32 from IPython.core import ipmaker
32 from IPython.core import ipmaker
33
33
34 def test_import_logger():
34 def test_import_logger():
35 from IPython.core import logger
35 from IPython.core import logger
36
36
37 def test_import_macro():
37 def test_import_macro():
38 from IPython.core import macro
38 from IPython.core import macro
39
39
40 def test_import_magic():
40 def test_import_magic():
41 from IPython.core import magic
41 from IPython.core import magic
42
42
43 def test_import_oinspect():
43 def test_import_oinspect():
44 from IPython.core import oinspect
44 from IPython.core import oinspect
45
45
46 def test_import_outputtrap():
46 def test_import_outputtrap():
47 from IPython.core import outputtrap
47 from IPython.core import outputtrap
48
48
49 def test_import_prefilter():
50 from IPython.core import prefilter
51
52 def test_import_prompts():
53 from IPython.core import prompts
@@ -1,300 +1,300 b''
1 # -*- coding: utf-8 -*-
1 # -*- coding: utf-8 -*-
2 """IPython Test Suite Runner.
2 """IPython Test Suite Runner.
3
3
4 This module provides a main entry point to a user script to test IPython
4 This module provides a main entry point to a user script to test IPython
5 itself from the command line. There are two ways of running this script:
5 itself from the command line. There are two ways of running this script:
6
6
7 1. With the syntax `iptest all`. This runs our entire test suite by
7 1. With the syntax `iptest all`. This runs our entire test suite by
8 calling this script (with different arguments) or trial recursively. This
8 calling this script (with different arguments) or trial recursively. This
9 causes modules and package to be tested in different processes, using nose
9 causes modules and package to be tested in different processes, using nose
10 or trial where appropriate.
10 or trial where appropriate.
11 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form
11 2. With the regular nose syntax, like `iptest -vvs IPython`. In this form
12 the script simply calls nose, but with special command line flags and
12 the script simply calls nose, but with special command line flags and
13 plugins loaded.
13 plugins loaded.
14
14
15 For now, this script requires that both nose and twisted are installed. This
15 For now, this script requires that both nose and twisted are installed. This
16 will change in the future.
16 will change in the future.
17 """
17 """
18
18
19 #-----------------------------------------------------------------------------
19 #-----------------------------------------------------------------------------
20 # Module imports
20 # Module imports
21 #-----------------------------------------------------------------------------
21 #-----------------------------------------------------------------------------
22
22
23 import os
23 import os
24 import os.path as path
24 import os.path as path
25 import sys
25 import sys
26 import subprocess
26 import subprocess
27 import time
27 import time
28 import warnings
28 import warnings
29
29
30 import nose.plugins.builtin
30 import nose.plugins.builtin
31 from nose.core import TestProgram
31 from nose.core import TestProgram
32
32
33 from IPython.utils.platutils import find_cmd
33 from IPython.utils.platutils import find_cmd
34 from IPython.testing.plugin.ipdoctest import IPythonDoctest
34 from IPython.testing.plugin.ipdoctest import IPythonDoctest
35
35
36 pjoin = path.join
36 pjoin = path.join
37
37
38 #-----------------------------------------------------------------------------
38 #-----------------------------------------------------------------------------
39 # Logic for skipping doctests
39 # Logic for skipping doctests
40 #-----------------------------------------------------------------------------
40 #-----------------------------------------------------------------------------
41
41
42 def test_for(mod):
42 def test_for(mod):
43 """Test to see if mod is importable."""
43 """Test to see if mod is importable."""
44 try:
44 try:
45 __import__(mod)
45 __import__(mod)
46 except ImportError:
46 except ImportError:
47 return False
47 return False
48 else:
48 else:
49 return True
49 return True
50
50
51 have_curses = test_for('_curses')
51 have_curses = test_for('_curses')
52 have_wx = test_for('wx')
52 have_wx = test_for('wx')
53 have_zi = test_for('zope.interface')
53 have_zi = test_for('zope.interface')
54 have_twisted = test_for('twisted')
54 have_twisted = test_for('twisted')
55 have_foolscap = test_for('foolscap')
55 have_foolscap = test_for('foolscap')
56 have_objc = test_for('objc')
56 have_objc = test_for('objc')
57 have_pexpect = test_for('pexpect')
57 have_pexpect = test_for('pexpect')
58
58
59 # For the IPythonDoctest plugin, we need to exclude certain patterns that cause
59 # For the IPythonDoctest plugin, we need to exclude certain patterns that cause
60 # testing problems. We should strive to minimize the number of skipped
60 # testing problems. We should strive to minimize the number of skipped
61 # modules, since this means untested code. As the testing machinery
61 # modules, since this means untested code. As the testing machinery
62 # solidifies, this list should eventually become empty.
62 # solidifies, this list should eventually become empty.
63 EXCLUDE = [pjoin('IPython', 'external'),
63 EXCLUDE = [pjoin('IPython', 'external'),
64 pjoin('IPython', 'frontend', 'process', 'winprocess.py'),
64 pjoin('IPython', 'frontend', 'process', 'winprocess.py'),
65 pjoin('IPython_doctest_plugin'),
65 pjoin('IPython_doctest_plugin'),
66 pjoin('IPython', 'Gnuplot'),
66 pjoin('IPython', 'Gnuplot'),
67 pjoin('IPython', 'Extensions', 'ipy_'),
67 pjoin('IPython', 'Extensions', 'ipy_'),
68 pjoin('IPython', 'Extensions', 'clearcmd'),
68 pjoin('IPython', 'Extensions', 'clearcmd'),
69 pjoin('IPython', 'Extensions', 'PhysicalQInteractive'),
69 pjoin('IPython', 'Extensions', 'PhysicalQInteractive'),
70 pjoin('IPython', 'Extensions', 'scitedirector'),
70 pjoin('IPython', 'Extensions', 'scitedirector'),
71 pjoin('IPython', 'Extensions', 'numeric_formats'),
71 pjoin('IPython', 'Extensions', 'numeric_formats'),
72 pjoin('IPython', 'testing', 'attic'),
72 pjoin('IPython', 'testing', 'attic'),
73 pjoin('IPython', 'testing', 'tutils'),
73 pjoin('IPython', 'testing', 'tutils'),
74 pjoin('IPython', 'testing', 'tools'),
74 pjoin('IPython', 'testing', 'tools'),
75 pjoin('IPython', 'testing', 'mkdoctests')
75 pjoin('IPython', 'testing', 'mkdoctests')
76 ]
76 ]
77
77
78 if not have_wx:
78 if not have_wx:
79 EXCLUDE.append(pjoin('IPython', 'Extensions', 'igrid'))
79 EXCLUDE.append(pjoin('IPython', 'Extensions', 'igrid'))
80 EXCLUDE.append(pjoin('IPython', 'gui'))
80 EXCLUDE.append(pjoin('IPython', 'gui'))
81 EXCLUDE.append(pjoin('IPython', 'frontend', 'wx'))
81 EXCLUDE.append(pjoin('IPython', 'frontend', 'wx'))
82
82
83 if not have_objc:
83 if not have_objc:
84 EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa'))
84 EXCLUDE.append(pjoin('IPython', 'frontend', 'cocoa'))
85
85
86 if not have_curses:
86 if not have_curses:
87 EXCLUDE.append(pjoin('IPython', 'Extensions', 'ibrowse'))
87 EXCLUDE.append(pjoin('IPython', 'Extensions', 'ibrowse'))
88
88
89 if not sys.platform == 'win32':
89 if not sys.platform == 'win32':
90 EXCLUDE.append(pjoin('IPython', 'platutils_win32'))
90 EXCLUDE.append(pjoin('IPython', 'platutils_win32'))
91
91
92 # These have to be skipped on win32 because the use echo, rm, cd, etc.
92 # These have to be skipped on win32 because the use echo, rm, cd, etc.
93 # See ticket https://bugs.launchpad.net/bugs/366982
93 # See ticket https://bugs.launchpad.net/bugs/366982
94 if sys.platform == 'win32':
94 if sys.platform == 'win32':
95 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip'))
95 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'test_exampleip'))
96 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample'))
96 EXCLUDE.append(pjoin('IPython', 'testing', 'plugin', 'dtexample'))
97
97
98 if not os.name == 'posix':
98 if not os.name == 'posix':
99 EXCLUDE.append(pjoin('IPython', 'platutils_posix'))
99 EXCLUDE.append(pjoin('IPython', 'platutils_posix'))
100
100
101 if not have_pexpect:
101 if not have_pexpect:
102 EXCLUDE.append(pjoin('IPython', 'lib', 'irunner'))
102 EXCLUDE.append(pjoin('IPython', 'lib', 'irunner'))
103
103
104 # This is needed for the reg-exp to match on win32 in the ipdoctest plugin.
104 # This is needed for the reg-exp to match on win32 in the ipdoctest plugin.
105 if sys.platform == 'win32':
105 if sys.platform == 'win32':
106 EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE]
106 EXCLUDE = [s.replace('\\','\\\\') for s in EXCLUDE]
107
107
108
108
109 #-----------------------------------------------------------------------------
109 #-----------------------------------------------------------------------------
110 # Functions and classes
110 # Functions and classes
111 #-----------------------------------------------------------------------------
111 #-----------------------------------------------------------------------------
112
112
113 def run_iptest():
113 def run_iptest():
114 """Run the IPython test suite using nose.
114 """Run the IPython test suite using nose.
115
115
116 This function is called when this script is **not** called with the form
116 This function is called when this script is **not** called with the form
117 `iptest all`. It simply calls nose with appropriate command line flags
117 `iptest all`. It simply calls nose with appropriate command line flags
118 and accepts all of the standard nose arguments.
118 and accepts all of the standard nose arguments.
119 """
119 """
120
120
121 warnings.filterwarnings('ignore',
121 warnings.filterwarnings('ignore',
122 'This will be removed soon. Use IPython.testing.util instead')
122 'This will be removed soon. Use IPython.testing.util instead')
123
123
124 argv = sys.argv + [
124 argv = sys.argv + [
125 # Loading ipdoctest causes problems with Twisted.
125 # Loading ipdoctest causes problems with Twisted.
126 # I am removing this as a temporary fix to get the
126 # I am removing this as a temporary fix to get the
127 # test suite back into working shape. Our nose
127 # test suite back into working shape. Our nose
128 # plugin needs to be gone through with a fine
128 # plugin needs to be gone through with a fine
129 # toothed comb to find what is causing the problem.
129 # toothed comb to find what is causing the problem.
130 '--with-ipdoctest',
130 '--with-ipdoctest',
131 '--ipdoctest-tests','--ipdoctest-extension=txt',
131 '--ipdoctest-tests','--ipdoctest-extension=txt',
132 '--detailed-errors',
132 '--detailed-errors',
133
133
134 # We add --exe because of setuptools' imbecility (it
134 # We add --exe because of setuptools' imbecility (it
135 # blindly does chmod +x on ALL files). Nose does the
135 # blindly does chmod +x on ALL files). Nose does the
136 # right thing and it tries to avoid executables,
136 # right thing and it tries to avoid executables,
137 # setuptools unfortunately forces our hand here. This
137 # setuptools unfortunately forces our hand here. This
138 # has been discussed on the distutils list and the
138 # has been discussed on the distutils list and the
139 # setuptools devs refuse to fix this problem!
139 # setuptools devs refuse to fix this problem!
140 '--exe',
140 '--exe',
141 ]
141 ]
142
142
143 # Detect if any tests were required by explicitly calling an IPython
143 # Detect if any tests were required by explicitly calling an IPython
144 # submodule or giving a specific path
144 # submodule or giving a specific path
145 has_tests = False
145 has_tests = False
146 for arg in sys.argv:
146 for arg in sys.argv:
147 if 'IPython' in arg or arg.endswith('.py') or \
147 if 'IPython' in arg or arg.endswith('.py') or \
148 (':' in arg and '.py' in arg):
148 (':' in arg and '.py' in arg):
149 has_tests = True
149 has_tests = True
150 break
150 break
151
151
152 # If nothing was specifically requested, test full IPython
152 # If nothing was specifically requested, test full IPython
153 if not has_tests:
153 if not has_tests:
154 argv.append('IPython')
154 argv.append('IPython')
155
155
156 # Construct list of plugins, omitting the existing doctest plugin, which
156 # Construct list of plugins, omitting the existing doctest plugin, which
157 # ours replaces (and extends).
157 # ours replaces (and extends).
158 plugins = [IPythonDoctest(EXCLUDE)]
158 plugins = [IPythonDoctest(EXCLUDE)]
159 for p in nose.plugins.builtin.plugins:
159 for p in nose.plugins.builtin.plugins:
160 plug = p()
160 plug = p()
161 if plug.name == 'doctest':
161 if plug.name == 'doctest':
162 continue
162 continue
163
163
164 #print '*** adding plugin:',plug.name # dbg
164 #print '*** adding plugin:',plug.name # dbg
165 plugins.append(plug)
165 plugins.append(plug)
166
166
167 TestProgram(argv=argv,plugins=plugins)
167 TestProgram(argv=argv,plugins=plugins)
168
168
169
169
170 class IPTester(object):
170 class IPTester(object):
171 """Call that calls iptest or trial in a subprocess.
171 """Call that calls iptest or trial in a subprocess.
172 """
172 """
173 def __init__(self,runner='iptest',params=None):
173 def __init__(self,runner='iptest',params=None):
174 """ """
174 """ """
175 if runner == 'iptest':
175 if runner == 'iptest':
176 self.runner = ['iptest','-v']
176 self.runner = ['iptest','-v']
177 else:
177 else:
178 self.runner = [find_cmd('trial')]
178 self.runner = [find_cmd('trial')]
179 if params is None:
179 if params is None:
180 params = []
180 params = []
181 if isinstance(params,str):
181 if isinstance(params,str):
182 params = [params]
182 params = [params]
183 self.params = params
183 self.params = params
184
184
185 # Assemble call
185 # Assemble call
186 self.call_args = self.runner+self.params
186 self.call_args = self.runner+self.params
187
187
188 def run(self):
188 def run(self):
189 """Run the stored commands"""
189 """Run the stored commands"""
190 return subprocess.call(self.call_args)
190 return subprocess.call(self.call_args)
191
191
192
192
193 def make_runners():
193 def make_runners():
194 """Define the modules and packages that need to be tested.
194 """Define the modules and packages that need to be tested.
195 """
195 """
196
196
197 # This omits additional top-level modules that should not be doctested.
197 # This omits additional top-level modules that should not be doctested.
198 # XXX: Shell.py is also ommited because of a bug in the skip_doctest
198 # XXX: Shell.py is also ommited because of a bug in the skip_doctest
199 # decorator. See ticket https://bugs.launchpad.net/bugs/366209
199 # decorator. See ticket https://bugs.launchpad.net/bugs/366209
200 top_mod = \
200 top_mod = \
201 ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py',
201 ['backgroundjobs.py', 'coloransi.py', 'completer.py', 'configloader.py',
202 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py',
202 'crashhandler.py', 'debugger.py', 'deepreload.py', 'demo.py',
203 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py',
203 'DPyGetOpt.py', 'dtutils.py', 'excolors.py', 'fakemodule.py',
204 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py',
204 'generics.py', 'genutils.py', 'history.py', 'hooks.py', 'ipapi.py',
205 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py',
205 'iplib.py', 'ipmaker.py', 'ipstruct.py', 'Itpl.py',
206 'logger.py', 'macro.py', 'magic.py', 'oinspect.py',
206 'logger.py', 'macro.py', 'magic.py', 'oinspect.py',
207 'outputtrap.py', 'platutils.py', 'prefilter.py', 'Prompts.py',
207 'outputtrap.py', 'platutils.py', 'prefilter.py', 'prompts.py',
208 'PyColorize.py', 'Release.py', 'rlineimpl.py', 'shadowns.py',
208 'PyColorize.py', 'Release.py', 'rlineimpl.py', 'shadowns.py',
209 'shellglobals.py', 'strdispatch.py', 'twshell.py',
209 'shellglobals.py', 'strdispatch.py', 'twshell.py',
210 'ultraTB.py', 'upgrade_dir.py', 'usage.py', 'wildcard.py',
210 'ultraTB.py', 'upgrade_dir.py', 'usage.py', 'wildcard.py',
211 # See note above for why this is skipped
211 # See note above for why this is skipped
212 # 'Shell.py',
212 # 'Shell.py',
213 'winconsole.py']
213 'winconsole.py']
214
214
215 if have_pexpect:
215 if have_pexpect:
216 top_mod.append('irunner.py')
216 top_mod.append('irunner.py')
217
217
218 if sys.platform == 'win32':
218 if sys.platform == 'win32':
219 top_mod.append('platutils_win32.py')
219 top_mod.append('platutils_win32.py')
220 elif os.name == 'posix':
220 elif os.name == 'posix':
221 top_mod.append('platutils_posix.py')
221 top_mod.append('platutils_posix.py')
222 else:
222 else:
223 top_mod.append('platutils_dummy.py')
223 top_mod.append('platutils_dummy.py')
224
224
225 # These are tested by nose, so skip IPython.kernel
225 # These are tested by nose, so skip IPython.kernel
226 top_pack = ['config','Extensions','frontend',
226 top_pack = ['config','Extensions','frontend',
227 'testing','tests','tools','UserConfig']
227 'testing','tests','tools','UserConfig']
228
228
229 if have_wx:
229 if have_wx:
230 top_pack.append('gui')
230 top_pack.append('gui')
231
231
232 modules = ['IPython.%s' % m[:-3] for m in top_mod ]
232 modules = ['IPython.%s' % m[:-3] for m in top_mod ]
233 packages = ['IPython.%s' % m for m in top_pack ]
233 packages = ['IPython.%s' % m for m in top_pack ]
234
234
235 # Make runners
235 # Make runners
236 runners = dict(zip(top_pack, [IPTester(params=v) for v in packages]))
236 runners = dict(zip(top_pack, [IPTester(params=v) for v in packages]))
237
237
238 # Test IPython.kernel using trial if twisted is installed
238 # Test IPython.kernel using trial if twisted is installed
239 if have_zi and have_twisted and have_foolscap:
239 if have_zi and have_twisted and have_foolscap:
240 runners['trial'] = IPTester('trial',['IPython'])
240 runners['trial'] = IPTester('trial',['IPython'])
241
241
242 runners['modules'] = IPTester(params=modules)
242 runners['modules'] = IPTester(params=modules)
243
243
244 return runners
244 return runners
245
245
246
246
247 def run_iptestall():
247 def run_iptestall():
248 """Run the entire IPython test suite by calling nose and trial.
248 """Run the entire IPython test suite by calling nose and trial.
249
249
250 This function constructs :class:`IPTester` instances for all IPython
250 This function constructs :class:`IPTester` instances for all IPython
251 modules and package and then runs each of them. This causes the modules
251 modules and package and then runs each of them. This causes the modules
252 and packages of IPython to be tested each in their own subprocess using
252 and packages of IPython to be tested each in their own subprocess using
253 nose or twisted.trial appropriately.
253 nose or twisted.trial appropriately.
254 """
254 """
255 runners = make_runners()
255 runners = make_runners()
256 # Run all test runners, tracking execution time
256 # Run all test runners, tracking execution time
257 failed = {}
257 failed = {}
258 t_start = time.time()
258 t_start = time.time()
259 for name,runner in runners.iteritems():
259 for name,runner in runners.iteritems():
260 print '*'*77
260 print '*'*77
261 print 'IPython test set:',name
261 print 'IPython test set:',name
262 res = runner.run()
262 res = runner.run()
263 if res:
263 if res:
264 failed[name] = res
264 failed[name] = res
265 t_end = time.time()
265 t_end = time.time()
266 t_tests = t_end - t_start
266 t_tests = t_end - t_start
267 nrunners = len(runners)
267 nrunners = len(runners)
268 nfail = len(failed)
268 nfail = len(failed)
269 # summarize results
269 # summarize results
270 print
270 print
271 print '*'*77
271 print '*'*77
272 print 'Ran %s test sets in %.3fs' % (nrunners, t_tests)
272 print 'Ran %s test sets in %.3fs' % (nrunners, t_tests)
273 print
273 print
274 if not failed:
274 if not failed:
275 print 'OK'
275 print 'OK'
276 else:
276 else:
277 # If anything went wrong, point out what command to rerun manually to
277 # If anything went wrong, point out what command to rerun manually to
278 # see the actual errors and individual summary
278 # see the actual errors and individual summary
279 print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners)
279 print 'ERROR - %s out of %s test sets failed.' % (nfail, nrunners)
280 for name in failed:
280 for name in failed:
281 failed_runner = runners[name]
281 failed_runner = runners[name]
282 print '-'*40
282 print '-'*40
283 print 'Runner failed:',name
283 print 'Runner failed:',name
284 print 'You may wish to rerun this one individually, with:'
284 print 'You may wish to rerun this one individually, with:'
285 print ' '.join(failed_runner.call_args)
285 print ' '.join(failed_runner.call_args)
286 print
286 print
287
287
288
288
289 def main():
289 def main():
290 if len(sys.argv) == 1:
290 if len(sys.argv) == 1:
291 run_iptestall()
291 run_iptestall()
292 else:
292 else:
293 if sys.argv[1] == 'all':
293 if sys.argv[1] == 'all':
294 run_iptestall()
294 run_iptestall()
295 else:
295 else:
296 run_iptest()
296 run_iptest()
297
297
298
298
299 if __name__ == '__main__':
299 if __name__ == '__main__':
300 main() No newline at end of file
300 main()
General Comments 0
You need to be logged in to leave comments. Login now