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