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