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