##// END OF EJS Templates
ipsystem() -> _ip.system()
vivainio -
Show More
@@ -1,2271 +1,2271 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 1096 2006-01-28 20:08:02Z vivainio $
9 $Id: iplib.py 1097 2006-01-28 20:22:13Z 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 # TODO: deprecate all except _ip; 'jobs' should be installed
683 # TODO: deprecate all except _ip; 'jobs' should be installed
684 # by an extension and the rest are under _ip
684 # by an extension and the rest are under _ip
685 builtins_new = dict(__IPYTHON__ = self,
685 builtins_new = dict(__IPYTHON__ = self,
686 ip_set_hook = self.set_hook,
686 ip_set_hook = self.set_hook,
687 jobs = self.jobs,
687 jobs = self.jobs,
688 ipmagic = self.ipmagic,
688 ipmagic = self.ipmagic,
689 ipalias = self.ipalias,
689 ipalias = self.ipalias,
690 ipsystem = self.ipsystem,
690 ipsystem = self.ipsystem,
691 _ip = self.api
691 _ip = self.api
692 )
692 )
693 for biname,bival in builtins_new.items():
693 for biname,bival in builtins_new.items():
694 try:
694 try:
695 # store the orignal value so we can restore it
695 # store the orignal value so we can restore it
696 self.builtins_added[biname] = __builtin__.__dict__[biname]
696 self.builtins_added[biname] = __builtin__.__dict__[biname]
697 except KeyError:
697 except KeyError:
698 # or mark that it wasn't defined, and we'll just delete it at
698 # or mark that it wasn't defined, and we'll just delete it at
699 # cleanup
699 # cleanup
700 self.builtins_added[biname] = Undefined
700 self.builtins_added[biname] = Undefined
701 __builtin__.__dict__[biname] = bival
701 __builtin__.__dict__[biname] = bival
702
702
703 # Keep in the builtins a flag for when IPython is active. We set it
703 # Keep in the builtins a flag for when IPython is active. We set it
704 # with setdefault so that multiple nested IPythons don't clobber one
704 # with setdefault so that multiple nested IPythons don't clobber one
705 # another. Each will increase its value by one upon being activated,
705 # another. Each will increase its value by one upon being activated,
706 # which also gives us a way to determine the nesting level.
706 # which also gives us a way to determine the nesting level.
707 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
707 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
708
708
709 def clean_builtins(self):
709 def clean_builtins(self):
710 """Remove any builtins which might have been added by add_builtins, or
710 """Remove any builtins which might have been added by add_builtins, or
711 restore overwritten ones to their previous values."""
711 restore overwritten ones to their previous values."""
712 for biname,bival in self.builtins_added.items():
712 for biname,bival in self.builtins_added.items():
713 if bival is Undefined:
713 if bival is Undefined:
714 del __builtin__.__dict__[biname]
714 del __builtin__.__dict__[biname]
715 else:
715 else:
716 __builtin__.__dict__[biname] = bival
716 __builtin__.__dict__[biname] = bival
717 self.builtins_added.clear()
717 self.builtins_added.clear()
718
718
719 def set_hook(self,name,hook, priority = 50):
719 def set_hook(self,name,hook, priority = 50):
720 """set_hook(name,hook) -> sets an internal IPython hook.
720 """set_hook(name,hook) -> sets an internal IPython hook.
721
721
722 IPython exposes some of its internal API as user-modifiable hooks. By
722 IPython exposes some of its internal API as user-modifiable hooks. By
723 adding your function to one of these hooks, you can modify IPython's
723 adding your function to one of these hooks, you can modify IPython's
724 behavior to call at runtime your own routines."""
724 behavior to call at runtime your own routines."""
725
725
726 # At some point in the future, this should validate the hook before it
726 # At some point in the future, this should validate the hook before it
727 # accepts it. Probably at least check that the hook takes the number
727 # accepts it. Probably at least check that the hook takes the number
728 # of args it's supposed to.
728 # of args it's supposed to.
729 dp = getattr(self.hooks, name, None)
729 dp = getattr(self.hooks, name, None)
730 if name not in IPython.hooks.__all__:
730 if name not in IPython.hooks.__all__:
731 print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ )
731 print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ )
732 if not dp:
732 if not dp:
733 dp = IPython.hooks.CommandChainDispatcher()
733 dp = IPython.hooks.CommandChainDispatcher()
734
734
735 f = new.instancemethod(hook,self,self.__class__)
735 f = new.instancemethod(hook,self,self.__class__)
736 try:
736 try:
737 dp.add(f,priority)
737 dp.add(f,priority)
738 except AttributeError:
738 except AttributeError:
739 # it was not commandchain, plain old func - replace
739 # it was not commandchain, plain old func - replace
740 dp = f
740 dp = f
741
741
742 setattr(self.hooks,name, dp)
742 setattr(self.hooks,name, dp)
743
743
744
744
745 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
745 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
746
746
747 def set_custom_exc(self,exc_tuple,handler):
747 def set_custom_exc(self,exc_tuple,handler):
748 """set_custom_exc(exc_tuple,handler)
748 """set_custom_exc(exc_tuple,handler)
749
749
750 Set a custom exception handler, which will be called if any of the
750 Set a custom exception handler, which will be called if any of the
751 exceptions in exc_tuple occur in the mainloop (specifically, in the
751 exceptions in exc_tuple occur in the mainloop (specifically, in the
752 runcode() method.
752 runcode() method.
753
753
754 Inputs:
754 Inputs:
755
755
756 - exc_tuple: a *tuple* of valid exceptions to call the defined
756 - exc_tuple: a *tuple* of valid exceptions to call the defined
757 handler for. It is very important that you use a tuple, and NOT A
757 handler for. It is very important that you use a tuple, and NOT A
758 LIST here, because of the way Python's except statement works. If
758 LIST here, because of the way Python's except statement works. If
759 you only want to trap a single exception, use a singleton tuple:
759 you only want to trap a single exception, use a singleton tuple:
760
760
761 exc_tuple == (MyCustomException,)
761 exc_tuple == (MyCustomException,)
762
762
763 - handler: this must be defined as a function with the following
763 - handler: this must be defined as a function with the following
764 basic interface: def my_handler(self,etype,value,tb).
764 basic interface: def my_handler(self,etype,value,tb).
765
765
766 This will be made into an instance method (via new.instancemethod)
766 This will be made into an instance method (via new.instancemethod)
767 of IPython itself, and it will be called if any of the exceptions
767 of IPython itself, and it will be called if any of the exceptions
768 listed in the exc_tuple are caught. If the handler is None, an
768 listed in the exc_tuple are caught. If the handler is None, an
769 internal basic one is used, which just prints basic info.
769 internal basic one is used, which just prints basic info.
770
770
771 WARNING: by putting in your own exception handler into IPython's main
771 WARNING: by putting in your own exception handler into IPython's main
772 execution loop, you run a very good chance of nasty crashes. This
772 execution loop, you run a very good chance of nasty crashes. This
773 facility should only be used if you really know what you are doing."""
773 facility should only be used if you really know what you are doing."""
774
774
775 assert type(exc_tuple)==type(()) , \
775 assert type(exc_tuple)==type(()) , \
776 "The custom exceptions must be given AS A TUPLE."
776 "The custom exceptions must be given AS A TUPLE."
777
777
778 def dummy_handler(self,etype,value,tb):
778 def dummy_handler(self,etype,value,tb):
779 print '*** Simple custom exception handler ***'
779 print '*** Simple custom exception handler ***'
780 print 'Exception type :',etype
780 print 'Exception type :',etype
781 print 'Exception value:',value
781 print 'Exception value:',value
782 print 'Traceback :',tb
782 print 'Traceback :',tb
783 print 'Source code :','\n'.join(self.buffer)
783 print 'Source code :','\n'.join(self.buffer)
784
784
785 if handler is None: handler = dummy_handler
785 if handler is None: handler = dummy_handler
786
786
787 self.CustomTB = new.instancemethod(handler,self,self.__class__)
787 self.CustomTB = new.instancemethod(handler,self,self.__class__)
788 self.custom_exceptions = exc_tuple
788 self.custom_exceptions = exc_tuple
789
789
790 def set_custom_completer(self,completer,pos=0):
790 def set_custom_completer(self,completer,pos=0):
791 """set_custom_completer(completer,pos=0)
791 """set_custom_completer(completer,pos=0)
792
792
793 Adds a new custom completer function.
793 Adds a new custom completer function.
794
794
795 The position argument (defaults to 0) is the index in the completers
795 The position argument (defaults to 0) is the index in the completers
796 list where you want the completer to be inserted."""
796 list where you want the completer to be inserted."""
797
797
798 newcomp = new.instancemethod(completer,self.Completer,
798 newcomp = new.instancemethod(completer,self.Completer,
799 self.Completer.__class__)
799 self.Completer.__class__)
800 self.Completer.matchers.insert(pos,newcomp)
800 self.Completer.matchers.insert(pos,newcomp)
801
801
802 def _get_call_pdb(self):
802 def _get_call_pdb(self):
803 return self._call_pdb
803 return self._call_pdb
804
804
805 def _set_call_pdb(self,val):
805 def _set_call_pdb(self,val):
806
806
807 if val not in (0,1,False,True):
807 if val not in (0,1,False,True):
808 raise ValueError,'new call_pdb value must be boolean'
808 raise ValueError,'new call_pdb value must be boolean'
809
809
810 # store value in instance
810 # store value in instance
811 self._call_pdb = val
811 self._call_pdb = val
812
812
813 # notify the actual exception handlers
813 # notify the actual exception handlers
814 self.InteractiveTB.call_pdb = val
814 self.InteractiveTB.call_pdb = val
815 if self.isthreaded:
815 if self.isthreaded:
816 try:
816 try:
817 self.sys_excepthook.call_pdb = val
817 self.sys_excepthook.call_pdb = val
818 except:
818 except:
819 warn('Failed to activate pdb for threaded exception handler')
819 warn('Failed to activate pdb for threaded exception handler')
820
820
821 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
821 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
822 'Control auto-activation of pdb at exceptions')
822 'Control auto-activation of pdb at exceptions')
823
823
824
824
825 # These special functions get installed in the builtin namespace, to
825 # These special functions get installed in the builtin namespace, to
826 # provide programmatic (pure python) access to magics, aliases and system
826 # provide programmatic (pure python) access to magics, aliases and system
827 # calls. This is important for logging, user scripting, and more.
827 # calls. This is important for logging, user scripting, and more.
828
828
829 # We are basically exposing, via normal python functions, the three
829 # We are basically exposing, via normal python functions, the three
830 # mechanisms in which ipython offers special call modes (magics for
830 # mechanisms in which ipython offers special call modes (magics for
831 # internal control, aliases for direct system access via pre-selected
831 # internal control, aliases for direct system access via pre-selected
832 # names, and !cmd for calling arbitrary system commands).
832 # names, and !cmd for calling arbitrary system commands).
833
833
834 def ipmagic(self,arg_s):
834 def ipmagic(self,arg_s):
835 """Call a magic function by name.
835 """Call a magic function by name.
836
836
837 Input: a string containing the name of the magic function to call and any
837 Input: a string containing the name of the magic function to call and any
838 additional arguments to be passed to the magic.
838 additional arguments to be passed to the magic.
839
839
840 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
840 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
841 prompt:
841 prompt:
842
842
843 In[1]: %name -opt foo bar
843 In[1]: %name -opt foo bar
844
844
845 To call a magic without arguments, simply use ipmagic('name').
845 To call a magic without arguments, simply use ipmagic('name').
846
846
847 This provides a proper Python function to call IPython's magics in any
847 This provides a proper Python function to call IPython's magics in any
848 valid Python code you can type at the interpreter, including loops and
848 valid Python code you can type at the interpreter, including loops and
849 compound statements. It is added by IPython to the Python builtin
849 compound statements. It is added by IPython to the Python builtin
850 namespace upon initialization."""
850 namespace upon initialization."""
851
851
852 args = arg_s.split(' ',1)
852 args = arg_s.split(' ',1)
853 magic_name = args[0]
853 magic_name = args[0]
854 magic_name = magic_name.lstrip(self.ESC_MAGIC)
854 magic_name = magic_name.lstrip(self.ESC_MAGIC)
855
855
856 try:
856 try:
857 magic_args = args[1]
857 magic_args = args[1]
858 except IndexError:
858 except IndexError:
859 magic_args = ''
859 magic_args = ''
860 fn = getattr(self,'magic_'+magic_name,None)
860 fn = getattr(self,'magic_'+magic_name,None)
861 if fn is None:
861 if fn is None:
862 error("Magic function `%s` not found." % magic_name)
862 error("Magic function `%s` not found." % magic_name)
863 else:
863 else:
864 magic_args = self.var_expand(magic_args)
864 magic_args = self.var_expand(magic_args)
865 return fn(magic_args)
865 return fn(magic_args)
866
866
867 def ipalias(self,arg_s):
867 def ipalias(self,arg_s):
868 """Call an alias by name.
868 """Call an alias by name.
869
869
870 Input: a string containing the name of the alias to call and any
870 Input: a string containing the name of the alias to call and any
871 additional arguments to be passed to the magic.
871 additional arguments to be passed to the magic.
872
872
873 ipalias('name -opt foo bar') is equivalent to typing at the ipython
873 ipalias('name -opt foo bar') is equivalent to typing at the ipython
874 prompt:
874 prompt:
875
875
876 In[1]: name -opt foo bar
876 In[1]: name -opt foo bar
877
877
878 To call an alias without arguments, simply use ipalias('name').
878 To call an alias without arguments, simply use ipalias('name').
879
879
880 This provides a proper Python function to call IPython's aliases in any
880 This provides a proper Python function to call IPython's aliases in any
881 valid Python code you can type at the interpreter, including loops and
881 valid Python code you can type at the interpreter, including loops and
882 compound statements. It is added by IPython to the Python builtin
882 compound statements. It is added by IPython to the Python builtin
883 namespace upon initialization."""
883 namespace upon initialization."""
884
884
885 args = arg_s.split(' ',1)
885 args = arg_s.split(' ',1)
886 alias_name = args[0]
886 alias_name = args[0]
887 try:
887 try:
888 alias_args = args[1]
888 alias_args = args[1]
889 except IndexError:
889 except IndexError:
890 alias_args = ''
890 alias_args = ''
891 if alias_name in self.alias_table:
891 if alias_name in self.alias_table:
892 self.call_alias(alias_name,alias_args)
892 self.call_alias(alias_name,alias_args)
893 else:
893 else:
894 error("Alias `%s` not found." % alias_name)
894 error("Alias `%s` not found." % alias_name)
895
895
896 def ipsystem(self,arg_s):
896 def ipsystem(self,arg_s):
897 """Make a system call, using IPython."""
897 """Make a system call, using IPython."""
898
898
899 self.system(arg_s)
899 self.system(arg_s)
900
900
901 def complete(self,text):
901 def complete(self,text):
902 """Return a sorted list of all possible completions on text.
902 """Return a sorted list of all possible completions on text.
903
903
904 Inputs:
904 Inputs:
905
905
906 - text: a string of text to be completed on.
906 - text: a string of text to be completed on.
907
907
908 This is a wrapper around the completion mechanism, similar to what
908 This is a wrapper around the completion mechanism, similar to what
909 readline does at the command line when the TAB key is hit. By
909 readline does at the command line when the TAB key is hit. By
910 exposing it as a method, it can be used by other non-readline
910 exposing it as a method, it can be used by other non-readline
911 environments (such as GUIs) for text completion.
911 environments (such as GUIs) for text completion.
912
912
913 Simple usage example:
913 Simple usage example:
914
914
915 In [1]: x = 'hello'
915 In [1]: x = 'hello'
916
916
917 In [2]: __IP.complete('x.l')
917 In [2]: __IP.complete('x.l')
918 Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']"""
918 Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']"""
919
919
920 complete = self.Completer.complete
920 complete = self.Completer.complete
921 state = 0
921 state = 0
922 # use a dict so we get unique keys, since ipyhton's multiple
922 # use a dict so we get unique keys, since ipyhton's multiple
923 # completers can return duplicates.
923 # completers can return duplicates.
924 comps = {}
924 comps = {}
925 while True:
925 while True:
926 newcomp = complete(text,state)
926 newcomp = complete(text,state)
927 if newcomp is None:
927 if newcomp is None:
928 break
928 break
929 comps[newcomp] = 1
929 comps[newcomp] = 1
930 state += 1
930 state += 1
931 outcomps = comps.keys()
931 outcomps = comps.keys()
932 outcomps.sort()
932 outcomps.sort()
933 return outcomps
933 return outcomps
934
934
935 def set_completer_frame(self, frame=None):
935 def set_completer_frame(self, frame=None):
936 if frame:
936 if frame:
937 self.Completer.namespace = frame.f_locals
937 self.Completer.namespace = frame.f_locals
938 self.Completer.global_namespace = frame.f_globals
938 self.Completer.global_namespace = frame.f_globals
939 else:
939 else:
940 self.Completer.namespace = self.user_ns
940 self.Completer.namespace = self.user_ns
941 self.Completer.global_namespace = self.user_global_ns
941 self.Completer.global_namespace = self.user_global_ns
942
942
943 def init_auto_alias(self):
943 def init_auto_alias(self):
944 """Define some aliases automatically.
944 """Define some aliases automatically.
945
945
946 These are ALL parameter-less aliases"""
946 These are ALL parameter-less aliases"""
947
947
948 for alias,cmd in self.auto_alias:
948 for alias,cmd in self.auto_alias:
949 self.alias_table[alias] = (0,cmd)
949 self.alias_table[alias] = (0,cmd)
950
950
951 def alias_table_validate(self,verbose=0):
951 def alias_table_validate(self,verbose=0):
952 """Update information about the alias table.
952 """Update information about the alias table.
953
953
954 In particular, make sure no Python keywords/builtins are in it."""
954 In particular, make sure no Python keywords/builtins are in it."""
955
955
956 no_alias = self.no_alias
956 no_alias = self.no_alias
957 for k in self.alias_table.keys():
957 for k in self.alias_table.keys():
958 if k in no_alias:
958 if k in no_alias:
959 del self.alias_table[k]
959 del self.alias_table[k]
960 if verbose:
960 if verbose:
961 print ("Deleting alias <%s>, it's a Python "
961 print ("Deleting alias <%s>, it's a Python "
962 "keyword or builtin." % k)
962 "keyword or builtin." % k)
963
963
964 def set_autoindent(self,value=None):
964 def set_autoindent(self,value=None):
965 """Set the autoindent flag, checking for readline support.
965 """Set the autoindent flag, checking for readline support.
966
966
967 If called with no arguments, it acts as a toggle."""
967 If called with no arguments, it acts as a toggle."""
968
968
969 if not self.has_readline:
969 if not self.has_readline:
970 if os.name == 'posix':
970 if os.name == 'posix':
971 warn("The auto-indent feature requires the readline library")
971 warn("The auto-indent feature requires the readline library")
972 self.autoindent = 0
972 self.autoindent = 0
973 return
973 return
974 if value is None:
974 if value is None:
975 self.autoindent = not self.autoindent
975 self.autoindent = not self.autoindent
976 else:
976 else:
977 self.autoindent = value
977 self.autoindent = value
978
978
979 def rc_set_toggle(self,rc_field,value=None):
979 def rc_set_toggle(self,rc_field,value=None):
980 """Set or toggle a field in IPython's rc config. structure.
980 """Set or toggle a field in IPython's rc config. structure.
981
981
982 If called with no arguments, it acts as a toggle.
982 If called with no arguments, it acts as a toggle.
983
983
984 If called with a non-existent field, the resulting AttributeError
984 If called with a non-existent field, the resulting AttributeError
985 exception will propagate out."""
985 exception will propagate out."""
986
986
987 rc_val = getattr(self.rc,rc_field)
987 rc_val = getattr(self.rc,rc_field)
988 if value is None:
988 if value is None:
989 value = not rc_val
989 value = not rc_val
990 setattr(self.rc,rc_field,value)
990 setattr(self.rc,rc_field,value)
991
991
992 def user_setup(self,ipythondir,rc_suffix,mode='install'):
992 def user_setup(self,ipythondir,rc_suffix,mode='install'):
993 """Install the user configuration directory.
993 """Install the user configuration directory.
994
994
995 Can be called when running for the first time or to upgrade the user's
995 Can be called when running for the first time or to upgrade the user's
996 .ipython/ directory with the mode parameter. Valid modes are 'install'
996 .ipython/ directory with the mode parameter. Valid modes are 'install'
997 and 'upgrade'."""
997 and 'upgrade'."""
998
998
999 def wait():
999 def wait():
1000 try:
1000 try:
1001 raw_input("Please press <RETURN> to start IPython.")
1001 raw_input("Please press <RETURN> to start IPython.")
1002 except EOFError:
1002 except EOFError:
1003 print >> Term.cout
1003 print >> Term.cout
1004 print '*'*70
1004 print '*'*70
1005
1005
1006 cwd = os.getcwd() # remember where we started
1006 cwd = os.getcwd() # remember where we started
1007 glb = glob.glob
1007 glb = glob.glob
1008 print '*'*70
1008 print '*'*70
1009 if mode == 'install':
1009 if mode == 'install':
1010 print \
1010 print \
1011 """Welcome to IPython. I will try to create a personal configuration directory
1011 """Welcome to IPython. I will try to create a personal configuration directory
1012 where you can customize many aspects of IPython's functionality in:\n"""
1012 where you can customize many aspects of IPython's functionality in:\n"""
1013 else:
1013 else:
1014 print 'I am going to upgrade your configuration in:'
1014 print 'I am going to upgrade your configuration in:'
1015
1015
1016 print ipythondir
1016 print ipythondir
1017
1017
1018 rcdirend = os.path.join('IPython','UserConfig')
1018 rcdirend = os.path.join('IPython','UserConfig')
1019 cfg = lambda d: os.path.join(d,rcdirend)
1019 cfg = lambda d: os.path.join(d,rcdirend)
1020 try:
1020 try:
1021 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
1021 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
1022 except IOError:
1022 except IOError:
1023 warning = """
1023 warning = """
1024 Installation error. IPython's directory was not found.
1024 Installation error. IPython's directory was not found.
1025
1025
1026 Check the following:
1026 Check the following:
1027
1027
1028 The ipython/IPython directory should be in a directory belonging to your
1028 The ipython/IPython directory should be in a directory belonging to your
1029 PYTHONPATH environment variable (that is, it should be in a directory
1029 PYTHONPATH environment variable (that is, it should be in a directory
1030 belonging to sys.path). You can copy it explicitly there or just link to it.
1030 belonging to sys.path). You can copy it explicitly there or just link to it.
1031
1031
1032 IPython will proceed with builtin defaults.
1032 IPython will proceed with builtin defaults.
1033 """
1033 """
1034 warn(warning)
1034 warn(warning)
1035 wait()
1035 wait()
1036 return
1036 return
1037
1037
1038 if mode == 'install':
1038 if mode == 'install':
1039 try:
1039 try:
1040 shutil.copytree(rcdir,ipythondir)
1040 shutil.copytree(rcdir,ipythondir)
1041 os.chdir(ipythondir)
1041 os.chdir(ipythondir)
1042 rc_files = glb("ipythonrc*")
1042 rc_files = glb("ipythonrc*")
1043 for rc_file in rc_files:
1043 for rc_file in rc_files:
1044 os.rename(rc_file,rc_file+rc_suffix)
1044 os.rename(rc_file,rc_file+rc_suffix)
1045 except:
1045 except:
1046 warning = """
1046 warning = """
1047
1047
1048 There was a problem with the installation:
1048 There was a problem with the installation:
1049 %s
1049 %s
1050 Try to correct it or contact the developers if you think it's a bug.
1050 Try to correct it or contact the developers if you think it's a bug.
1051 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
1051 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
1052 warn(warning)
1052 warn(warning)
1053 wait()
1053 wait()
1054 return
1054 return
1055
1055
1056 elif mode == 'upgrade':
1056 elif mode == 'upgrade':
1057 try:
1057 try:
1058 os.chdir(ipythondir)
1058 os.chdir(ipythondir)
1059 except:
1059 except:
1060 print """
1060 print """
1061 Can not upgrade: changing to directory %s failed. Details:
1061 Can not upgrade: changing to directory %s failed. Details:
1062 %s
1062 %s
1063 """ % (ipythondir,sys.exc_info()[1])
1063 """ % (ipythondir,sys.exc_info()[1])
1064 wait()
1064 wait()
1065 return
1065 return
1066 else:
1066 else:
1067 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
1067 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
1068 for new_full_path in sources:
1068 for new_full_path in sources:
1069 new_filename = os.path.basename(new_full_path)
1069 new_filename = os.path.basename(new_full_path)
1070 if new_filename.startswith('ipythonrc'):
1070 if new_filename.startswith('ipythonrc'):
1071 new_filename = new_filename + rc_suffix
1071 new_filename = new_filename + rc_suffix
1072 # The config directory should only contain files, skip any
1072 # The config directory should only contain files, skip any
1073 # directories which may be there (like CVS)
1073 # directories which may be there (like CVS)
1074 if os.path.isdir(new_full_path):
1074 if os.path.isdir(new_full_path):
1075 continue
1075 continue
1076 if os.path.exists(new_filename):
1076 if os.path.exists(new_filename):
1077 old_file = new_filename+'.old'
1077 old_file = new_filename+'.old'
1078 if os.path.exists(old_file):
1078 if os.path.exists(old_file):
1079 os.remove(old_file)
1079 os.remove(old_file)
1080 os.rename(new_filename,old_file)
1080 os.rename(new_filename,old_file)
1081 shutil.copy(new_full_path,new_filename)
1081 shutil.copy(new_full_path,new_filename)
1082 else:
1082 else:
1083 raise ValueError,'unrecognized mode for install:',`mode`
1083 raise ValueError,'unrecognized mode for install:',`mode`
1084
1084
1085 # Fix line-endings to those native to each platform in the config
1085 # Fix line-endings to those native to each platform in the config
1086 # directory.
1086 # directory.
1087 try:
1087 try:
1088 os.chdir(ipythondir)
1088 os.chdir(ipythondir)
1089 except:
1089 except:
1090 print """
1090 print """
1091 Problem: changing to directory %s failed.
1091 Problem: changing to directory %s failed.
1092 Details:
1092 Details:
1093 %s
1093 %s
1094
1094
1095 Some configuration files may have incorrect line endings. This should not
1095 Some configuration files may have incorrect line endings. This should not
1096 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1])
1096 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1])
1097 wait()
1097 wait()
1098 else:
1098 else:
1099 for fname in glb('ipythonrc*'):
1099 for fname in glb('ipythonrc*'):
1100 try:
1100 try:
1101 native_line_ends(fname,backup=0)
1101 native_line_ends(fname,backup=0)
1102 except IOError:
1102 except IOError:
1103 pass
1103 pass
1104
1104
1105 if mode == 'install':
1105 if mode == 'install':
1106 print """
1106 print """
1107 Successful installation!
1107 Successful installation!
1108
1108
1109 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
1109 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
1110 IPython manual (there are both HTML and PDF versions supplied with the
1110 IPython manual (there are both HTML and PDF versions supplied with the
1111 distribution) to make sure that your system environment is properly configured
1111 distribution) to make sure that your system environment is properly configured
1112 to take advantage of IPython's features.
1112 to take advantage of IPython's features.
1113
1113
1114 Important note: the configuration system has changed! The old system is
1114 Important note: the configuration system has changed! The old system is
1115 still in place, but its setting may be partly overridden by the settings in
1115 still in place, but its setting may be partly overridden by the settings in
1116 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
1116 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
1117 if some of the new settings bother you.
1117 if some of the new settings bother you.
1118
1118
1119 """
1119 """
1120 else:
1120 else:
1121 print """
1121 print """
1122 Successful upgrade!
1122 Successful upgrade!
1123
1123
1124 All files in your directory:
1124 All files in your directory:
1125 %(ipythondir)s
1125 %(ipythondir)s
1126 which would have been overwritten by the upgrade were backed up with a .old
1126 which would have been overwritten by the upgrade were backed up with a .old
1127 extension. If you had made particular customizations in those files you may
1127 extension. If you had made particular customizations in those files you may
1128 want to merge them back into the new files.""" % locals()
1128 want to merge them back into the new files.""" % locals()
1129 wait()
1129 wait()
1130 os.chdir(cwd)
1130 os.chdir(cwd)
1131 # end user_setup()
1131 # end user_setup()
1132
1132
1133 def atexit_operations(self):
1133 def atexit_operations(self):
1134 """This will be executed at the time of exit.
1134 """This will be executed at the time of exit.
1135
1135
1136 Saving of persistent data should be performed here. """
1136 Saving of persistent data should be performed here. """
1137
1137
1138 #print '*** IPython exit cleanup ***' # dbg
1138 #print '*** IPython exit cleanup ***' # dbg
1139 # input history
1139 # input history
1140 self.savehist()
1140 self.savehist()
1141
1141
1142 # Cleanup all tempfiles left around
1142 # Cleanup all tempfiles left around
1143 for tfile in self.tempfiles:
1143 for tfile in self.tempfiles:
1144 try:
1144 try:
1145 os.unlink(tfile)
1145 os.unlink(tfile)
1146 except OSError:
1146 except OSError:
1147 pass
1147 pass
1148
1148
1149 # save the "persistent data" catch-all dictionary
1149 # save the "persistent data" catch-all dictionary
1150 try:
1150 try:
1151 pickle.dump(self.persist, open(self.persist_fname,"w"))
1151 pickle.dump(self.persist, open(self.persist_fname,"w"))
1152 except:
1152 except:
1153 print "*** ERROR *** persistent data saving failed."
1153 print "*** ERROR *** persistent data saving failed."
1154
1154
1155 def savehist(self):
1155 def savehist(self):
1156 """Save input history to a file (via readline library)."""
1156 """Save input history to a file (via readline library)."""
1157 try:
1157 try:
1158 self.readline.write_history_file(self.histfile)
1158 self.readline.write_history_file(self.histfile)
1159 except:
1159 except:
1160 print 'Unable to save IPython command history to file: ' + \
1160 print 'Unable to save IPython command history to file: ' + \
1161 `self.histfile`
1161 `self.histfile`
1162
1162
1163 def pre_readline(self):
1163 def pre_readline(self):
1164 """readline hook to be used at the start of each line.
1164 """readline hook to be used at the start of each line.
1165
1165
1166 Currently it handles auto-indent only."""
1166 Currently it handles auto-indent only."""
1167
1167
1168 #debugx('self.indent_current_nsp','pre_readline:')
1168 #debugx('self.indent_current_nsp','pre_readline:')
1169 self.readline.insert_text(self.indent_current_str())
1169 self.readline.insert_text(self.indent_current_str())
1170
1170
1171 def init_readline(self):
1171 def init_readline(self):
1172 """Command history completion/saving/reloading."""
1172 """Command history completion/saving/reloading."""
1173 try:
1173 try:
1174 import readline
1174 import readline
1175 except ImportError:
1175 except ImportError:
1176 self.has_readline = 0
1176 self.has_readline = 0
1177 self.readline = None
1177 self.readline = None
1178 # no point in bugging windows users with this every time:
1178 # no point in bugging windows users with this every time:
1179 if os.name == 'posix':
1179 if os.name == 'posix':
1180 warn('Readline services not available on this platform.')
1180 warn('Readline services not available on this platform.')
1181 else:
1181 else:
1182 import atexit
1182 import atexit
1183 from IPython.completer import IPCompleter
1183 from IPython.completer import IPCompleter
1184 self.Completer = IPCompleter(self,
1184 self.Completer = IPCompleter(self,
1185 self.user_ns,
1185 self.user_ns,
1186 self.user_global_ns,
1186 self.user_global_ns,
1187 self.rc.readline_omit__names,
1187 self.rc.readline_omit__names,
1188 self.alias_table)
1188 self.alias_table)
1189
1189
1190 # Platform-specific configuration
1190 # Platform-specific configuration
1191 if os.name == 'nt':
1191 if os.name == 'nt':
1192 self.readline_startup_hook = readline.set_pre_input_hook
1192 self.readline_startup_hook = readline.set_pre_input_hook
1193 else:
1193 else:
1194 self.readline_startup_hook = readline.set_startup_hook
1194 self.readline_startup_hook = readline.set_startup_hook
1195
1195
1196 # Load user's initrc file (readline config)
1196 # Load user's initrc file (readline config)
1197 inputrc_name = os.environ.get('INPUTRC')
1197 inputrc_name = os.environ.get('INPUTRC')
1198 if inputrc_name is None:
1198 if inputrc_name is None:
1199 home_dir = get_home_dir()
1199 home_dir = get_home_dir()
1200 if home_dir is not None:
1200 if home_dir is not None:
1201 inputrc_name = os.path.join(home_dir,'.inputrc')
1201 inputrc_name = os.path.join(home_dir,'.inputrc')
1202 if os.path.isfile(inputrc_name):
1202 if os.path.isfile(inputrc_name):
1203 try:
1203 try:
1204 readline.read_init_file(inputrc_name)
1204 readline.read_init_file(inputrc_name)
1205 except:
1205 except:
1206 warn('Problems reading readline initialization file <%s>'
1206 warn('Problems reading readline initialization file <%s>'
1207 % inputrc_name)
1207 % inputrc_name)
1208
1208
1209 self.has_readline = 1
1209 self.has_readline = 1
1210 self.readline = readline
1210 self.readline = readline
1211 # save this in sys so embedded copies can restore it properly
1211 # save this in sys so embedded copies can restore it properly
1212 sys.ipcompleter = self.Completer.complete
1212 sys.ipcompleter = self.Completer.complete
1213 readline.set_completer(self.Completer.complete)
1213 readline.set_completer(self.Completer.complete)
1214
1214
1215 # Configure readline according to user's prefs
1215 # Configure readline according to user's prefs
1216 for rlcommand in self.rc.readline_parse_and_bind:
1216 for rlcommand in self.rc.readline_parse_and_bind:
1217 readline.parse_and_bind(rlcommand)
1217 readline.parse_and_bind(rlcommand)
1218
1218
1219 # remove some chars from the delimiters list
1219 # remove some chars from the delimiters list
1220 delims = readline.get_completer_delims()
1220 delims = readline.get_completer_delims()
1221 delims = delims.translate(string._idmap,
1221 delims = delims.translate(string._idmap,
1222 self.rc.readline_remove_delims)
1222 self.rc.readline_remove_delims)
1223 readline.set_completer_delims(delims)
1223 readline.set_completer_delims(delims)
1224 # otherwise we end up with a monster history after a while:
1224 # otherwise we end up with a monster history after a while:
1225 readline.set_history_length(1000)
1225 readline.set_history_length(1000)
1226 try:
1226 try:
1227 #print '*** Reading readline history' # dbg
1227 #print '*** Reading readline history' # dbg
1228 readline.read_history_file(self.histfile)
1228 readline.read_history_file(self.histfile)
1229 except IOError:
1229 except IOError:
1230 pass # It doesn't exist yet.
1230 pass # It doesn't exist yet.
1231
1231
1232 atexit.register(self.atexit_operations)
1232 atexit.register(self.atexit_operations)
1233 del atexit
1233 del atexit
1234
1234
1235 # Configure auto-indent for all platforms
1235 # Configure auto-indent for all platforms
1236 self.set_autoindent(self.rc.autoindent)
1236 self.set_autoindent(self.rc.autoindent)
1237
1237
1238 def _should_recompile(self,e):
1238 def _should_recompile(self,e):
1239 """Utility routine for edit_syntax_error"""
1239 """Utility routine for edit_syntax_error"""
1240
1240
1241 if e.filename in ('<ipython console>','<input>','<string>',
1241 if e.filename in ('<ipython console>','<input>','<string>',
1242 '<console>',None):
1242 '<console>',None):
1243
1243
1244 return False
1244 return False
1245 try:
1245 try:
1246 if (self.rc.autoedit_syntax != 2 and
1246 if (self.rc.autoedit_syntax != 2 and
1247 not ask_yes_no('Return to editor to correct syntax error? '
1247 not ask_yes_no('Return to editor to correct syntax error? '
1248 '[Y/n] ','y')):
1248 '[Y/n] ','y')):
1249 return False
1249 return False
1250 except EOFError:
1250 except EOFError:
1251 return False
1251 return False
1252
1252
1253 def int0(x):
1253 def int0(x):
1254 try:
1254 try:
1255 return int(x)
1255 return int(x)
1256 except TypeError:
1256 except TypeError:
1257 return 0
1257 return 0
1258 # always pass integer line and offset values to editor hook
1258 # always pass integer line and offset values to editor hook
1259 self.hooks.fix_error_editor(e.filename,
1259 self.hooks.fix_error_editor(e.filename,
1260 int0(e.lineno),int0(e.offset),e.msg)
1260 int0(e.lineno),int0(e.offset),e.msg)
1261 return True
1261 return True
1262
1262
1263 def edit_syntax_error(self):
1263 def edit_syntax_error(self):
1264 """The bottom half of the syntax error handler called in the main loop.
1264 """The bottom half of the syntax error handler called in the main loop.
1265
1265
1266 Loop until syntax error is fixed or user cancels.
1266 Loop until syntax error is fixed or user cancels.
1267 """
1267 """
1268
1268
1269 while self.SyntaxTB.last_syntax_error:
1269 while self.SyntaxTB.last_syntax_error:
1270 # copy and clear last_syntax_error
1270 # copy and clear last_syntax_error
1271 err = self.SyntaxTB.clear_err_state()
1271 err = self.SyntaxTB.clear_err_state()
1272 if not self._should_recompile(err):
1272 if not self._should_recompile(err):
1273 return
1273 return
1274 try:
1274 try:
1275 # may set last_syntax_error again if a SyntaxError is raised
1275 # may set last_syntax_error again if a SyntaxError is raised
1276 self.safe_execfile(err.filename,self.shell.user_ns)
1276 self.safe_execfile(err.filename,self.shell.user_ns)
1277 except:
1277 except:
1278 self.showtraceback()
1278 self.showtraceback()
1279 else:
1279 else:
1280 f = file(err.filename)
1280 f = file(err.filename)
1281 try:
1281 try:
1282 sys.displayhook(f.read())
1282 sys.displayhook(f.read())
1283 finally:
1283 finally:
1284 f.close()
1284 f.close()
1285
1285
1286 def showsyntaxerror(self, filename=None):
1286 def showsyntaxerror(self, filename=None):
1287 """Display the syntax error that just occurred.
1287 """Display the syntax error that just occurred.
1288
1288
1289 This doesn't display a stack trace because there isn't one.
1289 This doesn't display a stack trace because there isn't one.
1290
1290
1291 If a filename is given, it is stuffed in the exception instead
1291 If a filename is given, it is stuffed in the exception instead
1292 of what was there before (because Python's parser always uses
1292 of what was there before (because Python's parser always uses
1293 "<string>" when reading from a string).
1293 "<string>" when reading from a string).
1294 """
1294 """
1295 etype, value, last_traceback = sys.exc_info()
1295 etype, value, last_traceback = sys.exc_info()
1296 if filename and etype is SyntaxError:
1296 if filename and etype is SyntaxError:
1297 # Work hard to stuff the correct filename in the exception
1297 # Work hard to stuff the correct filename in the exception
1298 try:
1298 try:
1299 msg, (dummy_filename, lineno, offset, line) = value
1299 msg, (dummy_filename, lineno, offset, line) = value
1300 except:
1300 except:
1301 # Not the format we expect; leave it alone
1301 # Not the format we expect; leave it alone
1302 pass
1302 pass
1303 else:
1303 else:
1304 # Stuff in the right filename
1304 # Stuff in the right filename
1305 try:
1305 try:
1306 # Assume SyntaxError is a class exception
1306 # Assume SyntaxError is a class exception
1307 value = SyntaxError(msg, (filename, lineno, offset, line))
1307 value = SyntaxError(msg, (filename, lineno, offset, line))
1308 except:
1308 except:
1309 # If that failed, assume SyntaxError is a string
1309 # If that failed, assume SyntaxError is a string
1310 value = msg, (filename, lineno, offset, line)
1310 value = msg, (filename, lineno, offset, line)
1311 self.SyntaxTB(etype,value,[])
1311 self.SyntaxTB(etype,value,[])
1312
1312
1313 def debugger(self):
1313 def debugger(self):
1314 """Call the pdb debugger."""
1314 """Call the pdb debugger."""
1315
1315
1316 if not self.rc.pdb:
1316 if not self.rc.pdb:
1317 return
1317 return
1318 pdb.pm()
1318 pdb.pm()
1319
1319
1320 def showtraceback(self,exc_tuple = None,filename=None):
1320 def showtraceback(self,exc_tuple = None,filename=None):
1321 """Display the exception that just occurred."""
1321 """Display the exception that just occurred."""
1322
1322
1323 # Though this won't be called by syntax errors in the input line,
1323 # Though this won't be called by syntax errors in the input line,
1324 # there may be SyntaxError cases whith imported code.
1324 # there may be SyntaxError cases whith imported code.
1325 if exc_tuple is None:
1325 if exc_tuple is None:
1326 type, value, tb = sys.exc_info()
1326 type, value, tb = sys.exc_info()
1327 else:
1327 else:
1328 type, value, tb = exc_tuple
1328 type, value, tb = exc_tuple
1329 if type is SyntaxError:
1329 if type is SyntaxError:
1330 self.showsyntaxerror(filename)
1330 self.showsyntaxerror(filename)
1331 else:
1331 else:
1332 self.InteractiveTB()
1332 self.InteractiveTB()
1333 if self.InteractiveTB.call_pdb and self.has_readline:
1333 if self.InteractiveTB.call_pdb and self.has_readline:
1334 # pdb mucks up readline, fix it back
1334 # pdb mucks up readline, fix it back
1335 self.readline.set_completer(self.Completer.complete)
1335 self.readline.set_completer(self.Completer.complete)
1336
1336
1337 def mainloop(self,banner=None):
1337 def mainloop(self,banner=None):
1338 """Creates the local namespace and starts the mainloop.
1338 """Creates the local namespace and starts the mainloop.
1339
1339
1340 If an optional banner argument is given, it will override the
1340 If an optional banner argument is given, it will override the
1341 internally created default banner."""
1341 internally created default banner."""
1342
1342
1343 if self.rc.c: # Emulate Python's -c option
1343 if self.rc.c: # Emulate Python's -c option
1344 self.exec_init_cmd()
1344 self.exec_init_cmd()
1345 if banner is None:
1345 if banner is None:
1346 if self.rc.banner:
1346 if self.rc.banner:
1347 banner = self.BANNER+self.banner2
1347 banner = self.BANNER+self.banner2
1348 else:
1348 else:
1349 banner = ''
1349 banner = ''
1350 self.interact(banner)
1350 self.interact(banner)
1351
1351
1352 def exec_init_cmd(self):
1352 def exec_init_cmd(self):
1353 """Execute a command given at the command line.
1353 """Execute a command given at the command line.
1354
1354
1355 This emulates Python's -c option."""
1355 This emulates Python's -c option."""
1356
1356
1357 #sys.argv = ['-c']
1357 #sys.argv = ['-c']
1358 self.push(self.rc.c)
1358 self.push(self.rc.c)
1359
1359
1360 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1360 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1361 """Embeds IPython into a running python program.
1361 """Embeds IPython into a running python program.
1362
1362
1363 Input:
1363 Input:
1364
1364
1365 - header: An optional header message can be specified.
1365 - header: An optional header message can be specified.
1366
1366
1367 - local_ns, global_ns: working namespaces. If given as None, the
1367 - local_ns, global_ns: working namespaces. If given as None, the
1368 IPython-initialized one is updated with __main__.__dict__, so that
1368 IPython-initialized one is updated with __main__.__dict__, so that
1369 program variables become visible but user-specific configuration
1369 program variables become visible but user-specific configuration
1370 remains possible.
1370 remains possible.
1371
1371
1372 - stack_depth: specifies how many levels in the stack to go to
1372 - stack_depth: specifies how many levels in the stack to go to
1373 looking for namespaces (when local_ns and global_ns are None). This
1373 looking for namespaces (when local_ns and global_ns are None). This
1374 allows an intermediate caller to make sure that this function gets
1374 allows an intermediate caller to make sure that this function gets
1375 the namespace from the intended level in the stack. By default (0)
1375 the namespace from the intended level in the stack. By default (0)
1376 it will get its locals and globals from the immediate caller.
1376 it will get its locals and globals from the immediate caller.
1377
1377
1378 Warning: it's possible to use this in a program which is being run by
1378 Warning: it's possible to use this in a program which is being run by
1379 IPython itself (via %run), but some funny things will happen (a few
1379 IPython itself (via %run), but some funny things will happen (a few
1380 globals get overwritten). In the future this will be cleaned up, as
1380 globals get overwritten). In the future this will be cleaned up, as
1381 there is no fundamental reason why it can't work perfectly."""
1381 there is no fundamental reason why it can't work perfectly."""
1382
1382
1383 # Get locals and globals from caller
1383 # Get locals and globals from caller
1384 if local_ns is None or global_ns is None:
1384 if local_ns is None or global_ns is None:
1385 call_frame = sys._getframe(stack_depth).f_back
1385 call_frame = sys._getframe(stack_depth).f_back
1386
1386
1387 if local_ns is None:
1387 if local_ns is None:
1388 local_ns = call_frame.f_locals
1388 local_ns = call_frame.f_locals
1389 if global_ns is None:
1389 if global_ns is None:
1390 global_ns = call_frame.f_globals
1390 global_ns = call_frame.f_globals
1391
1391
1392 # Update namespaces and fire up interpreter
1392 # Update namespaces and fire up interpreter
1393
1393
1394 # The global one is easy, we can just throw it in
1394 # The global one is easy, we can just throw it in
1395 self.user_global_ns = global_ns
1395 self.user_global_ns = global_ns
1396
1396
1397 # but the user/local one is tricky: ipython needs it to store internal
1397 # but the user/local one is tricky: ipython needs it to store internal
1398 # data, but we also need the locals. We'll copy locals in the user
1398 # data, but we also need the locals. We'll copy locals in the user
1399 # one, but will track what got copied so we can delete them at exit.
1399 # one, but will track what got copied so we can delete them at exit.
1400 # This is so that a later embedded call doesn't see locals from a
1400 # This is so that a later embedded call doesn't see locals from a
1401 # previous call (which most likely existed in a separate scope).
1401 # previous call (which most likely existed in a separate scope).
1402 local_varnames = local_ns.keys()
1402 local_varnames = local_ns.keys()
1403 self.user_ns.update(local_ns)
1403 self.user_ns.update(local_ns)
1404
1404
1405 # Patch for global embedding to make sure that things don't overwrite
1405 # Patch for global embedding to make sure that things don't overwrite
1406 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1406 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1407 # FIXME. Test this a bit more carefully (the if.. is new)
1407 # FIXME. Test this a bit more carefully (the if.. is new)
1408 if local_ns is None and global_ns is None:
1408 if local_ns is None and global_ns is None:
1409 self.user_global_ns.update(__main__.__dict__)
1409 self.user_global_ns.update(__main__.__dict__)
1410
1410
1411 # make sure the tab-completer has the correct frame information, so it
1411 # make sure the tab-completer has the correct frame information, so it
1412 # actually completes using the frame's locals/globals
1412 # actually completes using the frame's locals/globals
1413 self.set_completer_frame()
1413 self.set_completer_frame()
1414
1414
1415 # before activating the interactive mode, we need to make sure that
1415 # before activating the interactive mode, we need to make sure that
1416 # all names in the builtin namespace needed by ipython point to
1416 # all names in the builtin namespace needed by ipython point to
1417 # ourselves, and not to other instances.
1417 # ourselves, and not to other instances.
1418 self.add_builtins()
1418 self.add_builtins()
1419
1419
1420 self.interact(header)
1420 self.interact(header)
1421
1421
1422 # now, purge out the user namespace from anything we might have added
1422 # now, purge out the user namespace from anything we might have added
1423 # from the caller's local namespace
1423 # from the caller's local namespace
1424 delvar = self.user_ns.pop
1424 delvar = self.user_ns.pop
1425 for var in local_varnames:
1425 for var in local_varnames:
1426 delvar(var,None)
1426 delvar(var,None)
1427 # and clean builtins we may have overridden
1427 # and clean builtins we may have overridden
1428 self.clean_builtins()
1428 self.clean_builtins()
1429
1429
1430 def interact(self, banner=None):
1430 def interact(self, banner=None):
1431 """Closely emulate the interactive Python console.
1431 """Closely emulate the interactive Python console.
1432
1432
1433 The optional banner argument specify the banner to print
1433 The optional banner argument specify the banner to print
1434 before the first interaction; by default it prints a banner
1434 before the first interaction; by default it prints a banner
1435 similar to the one printed by the real Python interpreter,
1435 similar to the one printed by the real Python interpreter,
1436 followed by the current class name in parentheses (so as not
1436 followed by the current class name in parentheses (so as not
1437 to confuse this with the real interpreter -- since it's so
1437 to confuse this with the real interpreter -- since it's so
1438 close!).
1438 close!).
1439
1439
1440 """
1440 """
1441 cprt = 'Type "copyright", "credits" or "license" for more information.'
1441 cprt = 'Type "copyright", "credits" or "license" for more information.'
1442 if banner is None:
1442 if banner is None:
1443 self.write("Python %s on %s\n%s\n(%s)\n" %
1443 self.write("Python %s on %s\n%s\n(%s)\n" %
1444 (sys.version, sys.platform, cprt,
1444 (sys.version, sys.platform, cprt,
1445 self.__class__.__name__))
1445 self.__class__.__name__))
1446 else:
1446 else:
1447 self.write(banner)
1447 self.write(banner)
1448
1448
1449 more = 0
1449 more = 0
1450
1450
1451 # Mark activity in the builtins
1451 # Mark activity in the builtins
1452 __builtin__.__dict__['__IPYTHON__active'] += 1
1452 __builtin__.__dict__['__IPYTHON__active'] += 1
1453
1453
1454 # exit_now is set by a call to %Exit or %Quit
1454 # exit_now is set by a call to %Exit or %Quit
1455 self.exit_now = False
1455 self.exit_now = False
1456 while not self.exit_now:
1456 while not self.exit_now:
1457
1457
1458 try:
1458 try:
1459 if more:
1459 if more:
1460 prompt = self.outputcache.prompt2
1460 prompt = self.outputcache.prompt2
1461 if self.autoindent:
1461 if self.autoindent:
1462 self.readline_startup_hook(self.pre_readline)
1462 self.readline_startup_hook(self.pre_readline)
1463 else:
1463 else:
1464 prompt = self.outputcache.prompt1
1464 prompt = self.outputcache.prompt1
1465 try:
1465 try:
1466 line = self.raw_input(prompt,more)
1466 line = self.raw_input(prompt,more)
1467 if self.autoindent:
1467 if self.autoindent:
1468 self.readline_startup_hook(None)
1468 self.readline_startup_hook(None)
1469 except EOFError:
1469 except EOFError:
1470 if self.autoindent:
1470 if self.autoindent:
1471 self.readline_startup_hook(None)
1471 self.readline_startup_hook(None)
1472 self.write("\n")
1472 self.write("\n")
1473 self.exit()
1473 self.exit()
1474 except:
1474 except:
1475 # exceptions here are VERY RARE, but they can be triggered
1475 # exceptions here are VERY RARE, but they can be triggered
1476 # asynchronously by signal handlers, for example.
1476 # asynchronously by signal handlers, for example.
1477 self.showtraceback()
1477 self.showtraceback()
1478 else:
1478 else:
1479 more = self.push(line)
1479 more = self.push(line)
1480
1480
1481 if (self.SyntaxTB.last_syntax_error and
1481 if (self.SyntaxTB.last_syntax_error and
1482 self.rc.autoedit_syntax):
1482 self.rc.autoedit_syntax):
1483 self.edit_syntax_error()
1483 self.edit_syntax_error()
1484
1484
1485 except KeyboardInterrupt:
1485 except KeyboardInterrupt:
1486 self.write("\nKeyboardInterrupt\n")
1486 self.write("\nKeyboardInterrupt\n")
1487 self.resetbuffer()
1487 self.resetbuffer()
1488 more = 0
1488 more = 0
1489 # keep cache in sync with the prompt counter:
1489 # keep cache in sync with the prompt counter:
1490 self.outputcache.prompt_count -= 1
1490 self.outputcache.prompt_count -= 1
1491
1491
1492 if self.autoindent:
1492 if self.autoindent:
1493 self.indent_current_nsp = 0
1493 self.indent_current_nsp = 0
1494
1494
1495 except bdb.BdbQuit:
1495 except bdb.BdbQuit:
1496 warn("The Python debugger has exited with a BdbQuit exception.\n"
1496 warn("The Python debugger has exited with a BdbQuit exception.\n"
1497 "Because of how pdb handles the stack, it is impossible\n"
1497 "Because of how pdb handles the stack, it is impossible\n"
1498 "for IPython to properly format this particular exception.\n"
1498 "for IPython to properly format this particular exception.\n"
1499 "IPython will resume normal operation.")
1499 "IPython will resume normal operation.")
1500
1500
1501 # We are off again...
1501 # We are off again...
1502 __builtin__.__dict__['__IPYTHON__active'] -= 1
1502 __builtin__.__dict__['__IPYTHON__active'] -= 1
1503
1503
1504 def excepthook(self, type, value, tb):
1504 def excepthook(self, type, value, tb):
1505 """One more defense for GUI apps that call sys.excepthook.
1505 """One more defense for GUI apps that call sys.excepthook.
1506
1506
1507 GUI frameworks like wxPython trap exceptions and call
1507 GUI frameworks like wxPython trap exceptions and call
1508 sys.excepthook themselves. I guess this is a feature that
1508 sys.excepthook themselves. I guess this is a feature that
1509 enables them to keep running after exceptions that would
1509 enables them to keep running after exceptions that would
1510 otherwise kill their mainloop. This is a bother for IPython
1510 otherwise kill their mainloop. This is a bother for IPython
1511 which excepts to catch all of the program exceptions with a try:
1511 which excepts to catch all of the program exceptions with a try:
1512 except: statement.
1512 except: statement.
1513
1513
1514 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1514 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1515 any app directly invokes sys.excepthook, it will look to the user like
1515 any app directly invokes sys.excepthook, it will look to the user like
1516 IPython crashed. In order to work around this, we can disable the
1516 IPython crashed. In order to work around this, we can disable the
1517 CrashHandler and replace it with this excepthook instead, which prints a
1517 CrashHandler and replace it with this excepthook instead, which prints a
1518 regular traceback using our InteractiveTB. In this fashion, apps which
1518 regular traceback using our InteractiveTB. In this fashion, apps which
1519 call sys.excepthook will generate a regular-looking exception from
1519 call sys.excepthook will generate a regular-looking exception from
1520 IPython, and the CrashHandler will only be triggered by real IPython
1520 IPython, and the CrashHandler will only be triggered by real IPython
1521 crashes.
1521 crashes.
1522
1522
1523 This hook should be used sparingly, only in places which are not likely
1523 This hook should be used sparingly, only in places which are not likely
1524 to be true IPython errors.
1524 to be true IPython errors.
1525 """
1525 """
1526
1526
1527 self.InteractiveTB(type, value, tb, tb_offset=0)
1527 self.InteractiveTB(type, value, tb, tb_offset=0)
1528 if self.InteractiveTB.call_pdb and self.has_readline:
1528 if self.InteractiveTB.call_pdb and self.has_readline:
1529 self.readline.set_completer(self.Completer.complete)
1529 self.readline.set_completer(self.Completer.complete)
1530
1530
1531 def call_alias(self,alias,rest=''):
1531 def call_alias(self,alias,rest=''):
1532 """Call an alias given its name and the rest of the line.
1532 """Call an alias given its name and the rest of the line.
1533
1533
1534 This function MUST be given a proper alias, because it doesn't make
1534 This function MUST be given a proper alias, because it doesn't make
1535 any checks when looking up into the alias table. The caller is
1535 any checks when looking up into the alias table. The caller is
1536 responsible for invoking it only with a valid alias."""
1536 responsible for invoking it only with a valid alias."""
1537
1537
1538 #print 'ALIAS: <%s>+<%s>' % (alias,rest) # dbg
1538 #print 'ALIAS: <%s>+<%s>' % (alias,rest) # dbg
1539 nargs,cmd = self.alias_table[alias]
1539 nargs,cmd = self.alias_table[alias]
1540 # Expand the %l special to be the user's input line
1540 # Expand the %l special to be the user's input line
1541 if cmd.find('%l') >= 0:
1541 if cmd.find('%l') >= 0:
1542 cmd = cmd.replace('%l',rest)
1542 cmd = cmd.replace('%l',rest)
1543 rest = ''
1543 rest = ''
1544 if nargs==0:
1544 if nargs==0:
1545 # Simple, argument-less aliases
1545 # Simple, argument-less aliases
1546 cmd = '%s %s' % (cmd,rest)
1546 cmd = '%s %s' % (cmd,rest)
1547 else:
1547 else:
1548 # Handle aliases with positional arguments
1548 # Handle aliases with positional arguments
1549 args = rest.split(None,nargs)
1549 args = rest.split(None,nargs)
1550 if len(args)< nargs:
1550 if len(args)< nargs:
1551 error('Alias <%s> requires %s arguments, %s given.' %
1551 error('Alias <%s> requires %s arguments, %s given.' %
1552 (alias,nargs,len(args)))
1552 (alias,nargs,len(args)))
1553 return
1553 return
1554 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
1554 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
1555 # Now call the macro, evaluating in the user's namespace
1555 # Now call the macro, evaluating in the user's namespace
1556 try:
1556 try:
1557 self.system(cmd)
1557 self.system(cmd)
1558 except:
1558 except:
1559 self.showtraceback()
1559 self.showtraceback()
1560
1560
1561 def indent_current_str(self):
1561 def indent_current_str(self):
1562 """return the current level of indentation as a string"""
1562 """return the current level of indentation as a string"""
1563 return self.indent_current_nsp * ' '
1563 return self.indent_current_nsp * ' '
1564
1564
1565 def autoindent_update(self,line):
1565 def autoindent_update(self,line):
1566 """Keep track of the indent level."""
1566 """Keep track of the indent level."""
1567
1567
1568 #debugx('line')
1568 #debugx('line')
1569 #debugx('self.indent_current_nsp')
1569 #debugx('self.indent_current_nsp')
1570 if self.autoindent:
1570 if self.autoindent:
1571 if line:
1571 if line:
1572 inisp = num_ini_spaces(line)
1572 inisp = num_ini_spaces(line)
1573 if inisp < self.indent_current_nsp:
1573 if inisp < self.indent_current_nsp:
1574 self.indent_current_nsp = inisp
1574 self.indent_current_nsp = inisp
1575
1575
1576 if line[-1] == ':':
1576 if line[-1] == ':':
1577 self.indent_current_nsp += 4
1577 self.indent_current_nsp += 4
1578 elif dedent_re.match(line):
1578 elif dedent_re.match(line):
1579 self.indent_current_nsp -= 4
1579 self.indent_current_nsp -= 4
1580 else:
1580 else:
1581 self.indent_current_nsp = 0
1581 self.indent_current_nsp = 0
1582
1582
1583 def runlines(self,lines):
1583 def runlines(self,lines):
1584 """Run a string of one or more lines of source.
1584 """Run a string of one or more lines of source.
1585
1585
1586 This method is capable of running a string containing multiple source
1586 This method is capable of running a string containing multiple source
1587 lines, as if they had been entered at the IPython prompt. Since it
1587 lines, as if they had been entered at the IPython prompt. Since it
1588 exposes IPython's processing machinery, the given strings can contain
1588 exposes IPython's processing machinery, the given strings can contain
1589 magic calls (%magic), special shell access (!cmd), etc."""
1589 magic calls (%magic), special shell access (!cmd), etc."""
1590
1590
1591 # We must start with a clean buffer, in case this is run from an
1591 # We must start with a clean buffer, in case this is run from an
1592 # interactive IPython session (via a magic, for example).
1592 # interactive IPython session (via a magic, for example).
1593 self.resetbuffer()
1593 self.resetbuffer()
1594 lines = lines.split('\n')
1594 lines = lines.split('\n')
1595 more = 0
1595 more = 0
1596 for line in lines:
1596 for line in lines:
1597 # skip blank lines so we don't mess up the prompt counter, but do
1597 # skip blank lines so we don't mess up the prompt counter, but do
1598 # NOT skip even a blank line if we are in a code block (more is
1598 # NOT skip even a blank line if we are in a code block (more is
1599 # true)
1599 # true)
1600 if line or more:
1600 if line or more:
1601 more = self.push(self.prefilter(line,more))
1601 more = self.push(self.prefilter(line,more))
1602 # IPython's runsource returns None if there was an error
1602 # IPython's runsource returns None if there was an error
1603 # compiling the code. This allows us to stop processing right
1603 # compiling the code. This allows us to stop processing right
1604 # away, so the user gets the error message at the right place.
1604 # away, so the user gets the error message at the right place.
1605 if more is None:
1605 if more is None:
1606 break
1606 break
1607 # final newline in case the input didn't have it, so that the code
1607 # final newline in case the input didn't have it, so that the code
1608 # actually does get executed
1608 # actually does get executed
1609 if more:
1609 if more:
1610 self.push('\n')
1610 self.push('\n')
1611
1611
1612 def runsource(self, source, filename='<input>', symbol='single'):
1612 def runsource(self, source, filename='<input>', symbol='single'):
1613 """Compile and run some source in the interpreter.
1613 """Compile and run some source in the interpreter.
1614
1614
1615 Arguments are as for compile_command().
1615 Arguments are as for compile_command().
1616
1616
1617 One several things can happen:
1617 One several things can happen:
1618
1618
1619 1) The input is incorrect; compile_command() raised an
1619 1) The input is incorrect; compile_command() raised an
1620 exception (SyntaxError or OverflowError). A syntax traceback
1620 exception (SyntaxError or OverflowError). A syntax traceback
1621 will be printed by calling the showsyntaxerror() method.
1621 will be printed by calling the showsyntaxerror() method.
1622
1622
1623 2) The input is incomplete, and more input is required;
1623 2) The input is incomplete, and more input is required;
1624 compile_command() returned None. Nothing happens.
1624 compile_command() returned None. Nothing happens.
1625
1625
1626 3) The input is complete; compile_command() returned a code
1626 3) The input is complete; compile_command() returned a code
1627 object. The code is executed by calling self.runcode() (which
1627 object. The code is executed by calling self.runcode() (which
1628 also handles run-time exceptions, except for SystemExit).
1628 also handles run-time exceptions, except for SystemExit).
1629
1629
1630 The return value is:
1630 The return value is:
1631
1631
1632 - True in case 2
1632 - True in case 2
1633
1633
1634 - False in the other cases, unless an exception is raised, where
1634 - False in the other cases, unless an exception is raised, where
1635 None is returned instead. This can be used by external callers to
1635 None is returned instead. This can be used by external callers to
1636 know whether to continue feeding input or not.
1636 know whether to continue feeding input or not.
1637
1637
1638 The return value can be used to decide whether to use sys.ps1 or
1638 The return value can be used to decide whether to use sys.ps1 or
1639 sys.ps2 to prompt the next line."""
1639 sys.ps2 to prompt the next line."""
1640
1640
1641 try:
1641 try:
1642 code = self.compile(source,filename,symbol)
1642 code = self.compile(source,filename,symbol)
1643 except (OverflowError, SyntaxError, ValueError):
1643 except (OverflowError, SyntaxError, ValueError):
1644 # Case 1
1644 # Case 1
1645 self.showsyntaxerror(filename)
1645 self.showsyntaxerror(filename)
1646 return None
1646 return None
1647
1647
1648 if code is None:
1648 if code is None:
1649 # Case 2
1649 # Case 2
1650 return True
1650 return True
1651
1651
1652 # Case 3
1652 # Case 3
1653 # We store the code object so that threaded shells and
1653 # We store the code object so that threaded shells and
1654 # custom exception handlers can access all this info if needed.
1654 # custom exception handlers can access all this info if needed.
1655 # The source corresponding to this can be obtained from the
1655 # The source corresponding to this can be obtained from the
1656 # buffer attribute as '\n'.join(self.buffer).
1656 # buffer attribute as '\n'.join(self.buffer).
1657 self.code_to_run = code
1657 self.code_to_run = code
1658 # now actually execute the code object
1658 # now actually execute the code object
1659 if self.runcode(code) == 0:
1659 if self.runcode(code) == 0:
1660 return False
1660 return False
1661 else:
1661 else:
1662 return None
1662 return None
1663
1663
1664 def runcode(self,code_obj):
1664 def runcode(self,code_obj):
1665 """Execute a code object.
1665 """Execute a code object.
1666
1666
1667 When an exception occurs, self.showtraceback() is called to display a
1667 When an exception occurs, self.showtraceback() is called to display a
1668 traceback.
1668 traceback.
1669
1669
1670 Return value: a flag indicating whether the code to be run completed
1670 Return value: a flag indicating whether the code to be run completed
1671 successfully:
1671 successfully:
1672
1672
1673 - 0: successful execution.
1673 - 0: successful execution.
1674 - 1: an error occurred.
1674 - 1: an error occurred.
1675 """
1675 """
1676
1676
1677 # Set our own excepthook in case the user code tries to call it
1677 # Set our own excepthook in case the user code tries to call it
1678 # directly, so that the IPython crash handler doesn't get triggered
1678 # directly, so that the IPython crash handler doesn't get triggered
1679 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
1679 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
1680
1680
1681 # we save the original sys.excepthook in the instance, in case config
1681 # we save the original sys.excepthook in the instance, in case config
1682 # code (such as magics) needs access to it.
1682 # code (such as magics) needs access to it.
1683 self.sys_excepthook = old_excepthook
1683 self.sys_excepthook = old_excepthook
1684 outflag = 1 # happens in more places, so it's easier as default
1684 outflag = 1 # happens in more places, so it's easier as default
1685 try:
1685 try:
1686 try:
1686 try:
1687 # Embedded instances require separate global/local namespaces
1687 # Embedded instances require separate global/local namespaces
1688 # so they can see both the surrounding (local) namespace and
1688 # so they can see both the surrounding (local) namespace and
1689 # the module-level globals when called inside another function.
1689 # the module-level globals when called inside another function.
1690 if self.embedded:
1690 if self.embedded:
1691 exec code_obj in self.user_global_ns, self.user_ns
1691 exec code_obj in self.user_global_ns, self.user_ns
1692 # Normal (non-embedded) instances should only have a single
1692 # Normal (non-embedded) instances should only have a single
1693 # namespace for user code execution, otherwise functions won't
1693 # namespace for user code execution, otherwise functions won't
1694 # see interactive top-level globals.
1694 # see interactive top-level globals.
1695 else:
1695 else:
1696 exec code_obj in self.user_ns
1696 exec code_obj in self.user_ns
1697 finally:
1697 finally:
1698 # Reset our crash handler in place
1698 # Reset our crash handler in place
1699 sys.excepthook = old_excepthook
1699 sys.excepthook = old_excepthook
1700 except SystemExit:
1700 except SystemExit:
1701 self.resetbuffer()
1701 self.resetbuffer()
1702 self.showtraceback()
1702 self.showtraceback()
1703 warn("Type exit or quit to exit IPython "
1703 warn("Type exit or quit to exit IPython "
1704 "(%Exit or %Quit do so unconditionally).",level=1)
1704 "(%Exit or %Quit do so unconditionally).",level=1)
1705 except self.custom_exceptions:
1705 except self.custom_exceptions:
1706 etype,value,tb = sys.exc_info()
1706 etype,value,tb = sys.exc_info()
1707 self.CustomTB(etype,value,tb)
1707 self.CustomTB(etype,value,tb)
1708 except:
1708 except:
1709 self.showtraceback()
1709 self.showtraceback()
1710 else:
1710 else:
1711 outflag = 0
1711 outflag = 0
1712 if softspace(sys.stdout, 0):
1712 if softspace(sys.stdout, 0):
1713 print
1713 print
1714 # Flush out code object which has been run (and source)
1714 # Flush out code object which has been run (and source)
1715 self.code_to_run = None
1715 self.code_to_run = None
1716 return outflag
1716 return outflag
1717
1717
1718 def push(self, line):
1718 def push(self, line):
1719 """Push a line to the interpreter.
1719 """Push a line to the interpreter.
1720
1720
1721 The line should not have a trailing newline; it may have
1721 The line should not have a trailing newline; it may have
1722 internal newlines. The line is appended to a buffer and the
1722 internal newlines. The line is appended to a buffer and the
1723 interpreter's runsource() method is called with the
1723 interpreter's runsource() method is called with the
1724 concatenated contents of the buffer as source. If this
1724 concatenated contents of the buffer as source. If this
1725 indicates that the command was executed or invalid, the buffer
1725 indicates that the command was executed or invalid, the buffer
1726 is reset; otherwise, the command is incomplete, and the buffer
1726 is reset; otherwise, the command is incomplete, and the buffer
1727 is left as it was after the line was appended. The return
1727 is left as it was after the line was appended. The return
1728 value is 1 if more input is required, 0 if the line was dealt
1728 value is 1 if more input is required, 0 if the line was dealt
1729 with in some way (this is the same as runsource()).
1729 with in some way (this is the same as runsource()).
1730 """
1730 """
1731
1731
1732 # autoindent management should be done here, and not in the
1732 # autoindent management should be done here, and not in the
1733 # interactive loop, since that one is only seen by keyboard input. We
1733 # interactive loop, since that one is only seen by keyboard input. We
1734 # need this done correctly even for code run via runlines (which uses
1734 # need this done correctly even for code run via runlines (which uses
1735 # push).
1735 # push).
1736
1736
1737 #print 'push line: <%s>' % line # dbg
1737 #print 'push line: <%s>' % line # dbg
1738 self.autoindent_update(line)
1738 self.autoindent_update(line)
1739
1739
1740 self.buffer.append(line)
1740 self.buffer.append(line)
1741 more = self.runsource('\n'.join(self.buffer), self.filename)
1741 more = self.runsource('\n'.join(self.buffer), self.filename)
1742 if not more:
1742 if not more:
1743 self.resetbuffer()
1743 self.resetbuffer()
1744 return more
1744 return more
1745
1745
1746 def resetbuffer(self):
1746 def resetbuffer(self):
1747 """Reset the input buffer."""
1747 """Reset the input buffer."""
1748 self.buffer[:] = []
1748 self.buffer[:] = []
1749
1749
1750 def raw_input(self,prompt='',continue_prompt=False):
1750 def raw_input(self,prompt='',continue_prompt=False):
1751 """Write a prompt and read a line.
1751 """Write a prompt and read a line.
1752
1752
1753 The returned line does not include the trailing newline.
1753 The returned line does not include the trailing newline.
1754 When the user enters the EOF key sequence, EOFError is raised.
1754 When the user enters the EOF key sequence, EOFError is raised.
1755
1755
1756 Optional inputs:
1756 Optional inputs:
1757
1757
1758 - prompt(''): a string to be printed to prompt the user.
1758 - prompt(''): a string to be printed to prompt the user.
1759
1759
1760 - continue_prompt(False): whether this line is the first one or a
1760 - continue_prompt(False): whether this line is the first one or a
1761 continuation in a sequence of inputs.
1761 continuation in a sequence of inputs.
1762 """
1762 """
1763
1763
1764 line = raw_input_original(prompt)
1764 line = raw_input_original(prompt)
1765 # Try to be reasonably smart about not re-indenting pasted input more
1765 # Try to be reasonably smart about not re-indenting pasted input more
1766 # than necessary. We do this by trimming out the auto-indent initial
1766 # than necessary. We do this by trimming out the auto-indent initial
1767 # spaces, if the user's actual input started itself with whitespace.
1767 # spaces, if the user's actual input started itself with whitespace.
1768 #debugx('self.buffer[-1]')
1768 #debugx('self.buffer[-1]')
1769
1769
1770 if self.autoindent:
1770 if self.autoindent:
1771 if num_ini_spaces(line) > self.indent_current_nsp:
1771 if num_ini_spaces(line) > self.indent_current_nsp:
1772 line = line[self.indent_current_nsp:]
1772 line = line[self.indent_current_nsp:]
1773 self.indent_current_nsp = 0
1773 self.indent_current_nsp = 0
1774
1774
1775 # store the unfiltered input before the user has any chance to modify
1775 # store the unfiltered input before the user has any chance to modify
1776 # it.
1776 # it.
1777 if line.strip():
1777 if line.strip():
1778 if continue_prompt:
1778 if continue_prompt:
1779 self.input_hist_raw[-1] += '%s\n' % line
1779 self.input_hist_raw[-1] += '%s\n' % line
1780 else:
1780 else:
1781 self.input_hist_raw.append('%s\n' % line)
1781 self.input_hist_raw.append('%s\n' % line)
1782
1782
1783 lineout = self.prefilter(line,continue_prompt)
1783 lineout = self.prefilter(line,continue_prompt)
1784 return lineout
1784 return lineout
1785
1785
1786 def split_user_input(self,line):
1786 def split_user_input(self,line):
1787 """Split user input into pre-char, function part and rest."""
1787 """Split user input into pre-char, function part and rest."""
1788
1788
1789 lsplit = self.line_split.match(line)
1789 lsplit = self.line_split.match(line)
1790 if lsplit is None: # no regexp match returns None
1790 if lsplit is None: # no regexp match returns None
1791 try:
1791 try:
1792 iFun,theRest = line.split(None,1)
1792 iFun,theRest = line.split(None,1)
1793 except ValueError:
1793 except ValueError:
1794 iFun,theRest = line,''
1794 iFun,theRest = line,''
1795 pre = re.match('^(\s*)(.*)',line).groups()[0]
1795 pre = re.match('^(\s*)(.*)',line).groups()[0]
1796 else:
1796 else:
1797 pre,iFun,theRest = lsplit.groups()
1797 pre,iFun,theRest = lsplit.groups()
1798
1798
1799 #print 'line:<%s>' % line # dbg
1799 #print 'line:<%s>' % line # dbg
1800 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun.strip(),theRest) # dbg
1800 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun.strip(),theRest) # dbg
1801 return pre,iFun.strip(),theRest
1801 return pre,iFun.strip(),theRest
1802
1802
1803 def _prefilter(self, line, continue_prompt):
1803 def _prefilter(self, line, continue_prompt):
1804 """Calls different preprocessors, depending on the form of line."""
1804 """Calls different preprocessors, depending on the form of line."""
1805
1805
1806 # All handlers *must* return a value, even if it's blank ('').
1806 # All handlers *must* return a value, even if it's blank ('').
1807
1807
1808 # Lines are NOT logged here. Handlers should process the line as
1808 # Lines are NOT logged here. Handlers should process the line as
1809 # needed, update the cache AND log it (so that the input cache array
1809 # needed, update the cache AND log it (so that the input cache array
1810 # stays synced).
1810 # stays synced).
1811
1811
1812 # This function is _very_ delicate, and since it's also the one which
1812 # This function is _very_ delicate, and since it's also the one which
1813 # determines IPython's response to user input, it must be as efficient
1813 # determines IPython's response to user input, it must be as efficient
1814 # as possible. For this reason it has _many_ returns in it, trying
1814 # as possible. For this reason it has _many_ returns in it, trying
1815 # always to exit as quickly as it can figure out what it needs to do.
1815 # always to exit as quickly as it can figure out what it needs to do.
1816
1816
1817 # This function is the main responsible for maintaining IPython's
1817 # This function is the main responsible for maintaining IPython's
1818 # behavior respectful of Python's semantics. So be _very_ careful if
1818 # behavior respectful of Python's semantics. So be _very_ careful if
1819 # making changes to anything here.
1819 # making changes to anything here.
1820
1820
1821 #.....................................................................
1821 #.....................................................................
1822 # Code begins
1822 # Code begins
1823
1823
1824 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
1824 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
1825
1825
1826 # save the line away in case we crash, so the post-mortem handler can
1826 # save the line away in case we crash, so the post-mortem handler can
1827 # record it
1827 # record it
1828 self._last_input_line = line
1828 self._last_input_line = line
1829
1829
1830 #print '***line: <%s>' % line # dbg
1830 #print '***line: <%s>' % line # dbg
1831
1831
1832 # the input history needs to track even empty lines
1832 # the input history needs to track even empty lines
1833 stripped = line.strip()
1833 stripped = line.strip()
1834
1834
1835 if not stripped:
1835 if not stripped:
1836 if not continue_prompt:
1836 if not continue_prompt:
1837 self.outputcache.prompt_count -= 1
1837 self.outputcache.prompt_count -= 1
1838 return self.handle_normal(line,continue_prompt)
1838 return self.handle_normal(line,continue_prompt)
1839 #return self.handle_normal('',continue_prompt)
1839 #return self.handle_normal('',continue_prompt)
1840
1840
1841 # print '***cont',continue_prompt # dbg
1841 # print '***cont',continue_prompt # dbg
1842 # special handlers are only allowed for single line statements
1842 # special handlers are only allowed for single line statements
1843 if continue_prompt and not self.rc.multi_line_specials:
1843 if continue_prompt and not self.rc.multi_line_specials:
1844 return self.handle_normal(line,continue_prompt)
1844 return self.handle_normal(line,continue_prompt)
1845
1845
1846
1846
1847 # For the rest, we need the structure of the input
1847 # For the rest, we need the structure of the input
1848 pre,iFun,theRest = self.split_user_input(line)
1848 pre,iFun,theRest = self.split_user_input(line)
1849
1849
1850 # See whether any pre-existing handler can take care of it
1850 # See whether any pre-existing handler can take care of it
1851
1851
1852 rewritten = self.hooks.input_prefilter(stripped)
1852 rewritten = self.hooks.input_prefilter(stripped)
1853 if rewritten != stripped: # ok, some prefilter did something
1853 if rewritten != stripped: # ok, some prefilter did something
1854 rewritten = pre + rewritten # add indentation
1854 rewritten = pre + rewritten # add indentation
1855 return self.handle_normal(rewritten)
1855 return self.handle_normal(rewritten)
1856
1856
1857
1857
1858
1858
1859
1859
1860 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1860 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1861
1861
1862 # First check for explicit escapes in the last/first character
1862 # First check for explicit escapes in the last/first character
1863 handler = None
1863 handler = None
1864 if line[-1] == self.ESC_HELP:
1864 if line[-1] == self.ESC_HELP:
1865 handler = self.esc_handlers.get(line[-1]) # the ? can be at the end
1865 handler = self.esc_handlers.get(line[-1]) # the ? can be at the end
1866 if handler is None:
1866 if handler is None:
1867 # look at the first character of iFun, NOT of line, so we skip
1867 # look at the first character of iFun, NOT of line, so we skip
1868 # leading whitespace in multiline input
1868 # leading whitespace in multiline input
1869 handler = self.esc_handlers.get(iFun[0:1])
1869 handler = self.esc_handlers.get(iFun[0:1])
1870 if handler is not None:
1870 if handler is not None:
1871 return handler(line,continue_prompt,pre,iFun,theRest)
1871 return handler(line,continue_prompt,pre,iFun,theRest)
1872 # Emacs ipython-mode tags certain input lines
1872 # Emacs ipython-mode tags certain input lines
1873 if line.endswith('# PYTHON-MODE'):
1873 if line.endswith('# PYTHON-MODE'):
1874 return self.handle_emacs(line,continue_prompt)
1874 return self.handle_emacs(line,continue_prompt)
1875
1875
1876 # Next, check if we can automatically execute this thing
1876 # Next, check if we can automatically execute this thing
1877
1877
1878 # Allow ! in multi-line statements if multi_line_specials is on:
1878 # Allow ! in multi-line statements if multi_line_specials is on:
1879 if continue_prompt and self.rc.multi_line_specials and \
1879 if continue_prompt and self.rc.multi_line_specials and \
1880 iFun.startswith(self.ESC_SHELL):
1880 iFun.startswith(self.ESC_SHELL):
1881 return self.handle_shell_escape(line,continue_prompt,
1881 return self.handle_shell_escape(line,continue_prompt,
1882 pre=pre,iFun=iFun,
1882 pre=pre,iFun=iFun,
1883 theRest=theRest)
1883 theRest=theRest)
1884
1884
1885 # Let's try to find if the input line is a magic fn
1885 # Let's try to find if the input line is a magic fn
1886 oinfo = None
1886 oinfo = None
1887 if hasattr(self,'magic_'+iFun):
1887 if hasattr(self,'magic_'+iFun):
1888 # WARNING: _ofind uses getattr(), so it can consume generators and
1888 # WARNING: _ofind uses getattr(), so it can consume generators and
1889 # cause other side effects.
1889 # cause other side effects.
1890 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1890 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1891 if oinfo['ismagic']:
1891 if oinfo['ismagic']:
1892 # Be careful not to call magics when a variable assignment is
1892 # Be careful not to call magics when a variable assignment is
1893 # being made (ls='hi', for example)
1893 # being made (ls='hi', for example)
1894 if self.rc.automagic and \
1894 if self.rc.automagic and \
1895 (len(theRest)==0 or theRest[0] not in '!=()<>,') and \
1895 (len(theRest)==0 or theRest[0] not in '!=()<>,') and \
1896 (self.rc.multi_line_specials or not continue_prompt):
1896 (self.rc.multi_line_specials or not continue_prompt):
1897 return self.handle_magic(line,continue_prompt,
1897 return self.handle_magic(line,continue_prompt,
1898 pre,iFun,theRest)
1898 pre,iFun,theRest)
1899 else:
1899 else:
1900 return self.handle_normal(line,continue_prompt)
1900 return self.handle_normal(line,continue_prompt)
1901
1901
1902 # If the rest of the line begins with an (in)equality, assginment or
1902 # If the rest of the line begins with an (in)equality, assginment or
1903 # function call, we should not call _ofind but simply execute it.
1903 # function call, we should not call _ofind but simply execute it.
1904 # This avoids spurious geattr() accesses on objects upon assignment.
1904 # This avoids spurious geattr() accesses on objects upon assignment.
1905 #
1905 #
1906 # It also allows users to assign to either alias or magic names true
1906 # It also allows users to assign to either alias or magic names true
1907 # python variables (the magic/alias systems always take second seat to
1907 # python variables (the magic/alias systems always take second seat to
1908 # true python code).
1908 # true python code).
1909 if theRest and theRest[0] in '!=()':
1909 if theRest and theRest[0] in '!=()':
1910 return self.handle_normal(line,continue_prompt)
1910 return self.handle_normal(line,continue_prompt)
1911
1911
1912 if oinfo is None:
1912 if oinfo is None:
1913 # let's try to ensure that _oinfo is ONLY called when autocall is
1913 # let's try to ensure that _oinfo is ONLY called when autocall is
1914 # on. Since it has inevitable potential side effects, at least
1914 # on. Since it has inevitable potential side effects, at least
1915 # having autocall off should be a guarantee to the user that no
1915 # having autocall off should be a guarantee to the user that no
1916 # weird things will happen.
1916 # weird things will happen.
1917
1917
1918 if self.rc.autocall:
1918 if self.rc.autocall:
1919 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1919 oinfo = self._ofind(iFun) # FIXME - _ofind is part of Magic
1920 else:
1920 else:
1921 # in this case, all that's left is either an alias or
1921 # in this case, all that's left is either an alias or
1922 # processing the line normally.
1922 # processing the line normally.
1923 if iFun in self.alias_table:
1923 if iFun in self.alias_table:
1924 return self.handle_alias(line,continue_prompt,
1924 return self.handle_alias(line,continue_prompt,
1925 pre,iFun,theRest)
1925 pre,iFun,theRest)
1926
1926
1927 else:
1927 else:
1928 return self.handle_normal(line,continue_prompt)
1928 return self.handle_normal(line,continue_prompt)
1929
1929
1930 if not oinfo['found']:
1930 if not oinfo['found']:
1931 return self.handle_normal(line,continue_prompt)
1931 return self.handle_normal(line,continue_prompt)
1932 else:
1932 else:
1933 #print 'pre<%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1933 #print 'pre<%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
1934 if oinfo['isalias']:
1934 if oinfo['isalias']:
1935 return self.handle_alias(line,continue_prompt,
1935 return self.handle_alias(line,continue_prompt,
1936 pre,iFun,theRest)
1936 pre,iFun,theRest)
1937
1937
1938 if (self.rc.autocall
1938 if (self.rc.autocall
1939 and
1939 and
1940 (
1940 (
1941 #only consider exclusion re if not "," or ";" autoquoting
1941 #only consider exclusion re if not "," or ";" autoquoting
1942 (pre == self.ESC_QUOTE or pre == self.ESC_QUOTE2
1942 (pre == self.ESC_QUOTE or pre == self.ESC_QUOTE2
1943 or pre == self.ESC_PAREN) or
1943 or pre == self.ESC_PAREN) or
1944 (not self.re_exclude_auto.match(theRest)))
1944 (not self.re_exclude_auto.match(theRest)))
1945 and
1945 and
1946 self.re_fun_name.match(iFun) and
1946 self.re_fun_name.match(iFun) and
1947 callable(oinfo['obj'])) :
1947 callable(oinfo['obj'])) :
1948 #print 'going auto' # dbg
1948 #print 'going auto' # dbg
1949 return self.handle_auto(line,continue_prompt,
1949 return self.handle_auto(line,continue_prompt,
1950 pre,iFun,theRest,oinfo['obj'])
1950 pre,iFun,theRest,oinfo['obj'])
1951 else:
1951 else:
1952 #print 'was callable?', callable(oinfo['obj']) # dbg
1952 #print 'was callable?', callable(oinfo['obj']) # dbg
1953 return self.handle_normal(line,continue_prompt)
1953 return self.handle_normal(line,continue_prompt)
1954
1954
1955 # If we get here, we have a normal Python line. Log and return.
1955 # If we get here, we have a normal Python line. Log and return.
1956 return self.handle_normal(line,continue_prompt)
1956 return self.handle_normal(line,continue_prompt)
1957
1957
1958 def _prefilter_dumb(self, line, continue_prompt):
1958 def _prefilter_dumb(self, line, continue_prompt):
1959 """simple prefilter function, for debugging"""
1959 """simple prefilter function, for debugging"""
1960 return self.handle_normal(line,continue_prompt)
1960 return self.handle_normal(line,continue_prompt)
1961
1961
1962 # Set the default prefilter() function (this can be user-overridden)
1962 # Set the default prefilter() function (this can be user-overridden)
1963 prefilter = _prefilter
1963 prefilter = _prefilter
1964
1964
1965 def handle_normal(self,line,continue_prompt=None,
1965 def handle_normal(self,line,continue_prompt=None,
1966 pre=None,iFun=None,theRest=None):
1966 pre=None,iFun=None,theRest=None):
1967 """Handle normal input lines. Use as a template for handlers."""
1967 """Handle normal input lines. Use as a template for handlers."""
1968
1968
1969 # With autoindent on, we need some way to exit the input loop, and I
1969 # With autoindent on, we need some way to exit the input loop, and I
1970 # don't want to force the user to have to backspace all the way to
1970 # don't want to force the user to have to backspace all the way to
1971 # clear the line. The rule will be in this case, that either two
1971 # clear the line. The rule will be in this case, that either two
1972 # lines of pure whitespace in a row, or a line of pure whitespace but
1972 # lines of pure whitespace in a row, or a line of pure whitespace but
1973 # of a size different to the indent level, will exit the input loop.
1973 # of a size different to the indent level, will exit the input loop.
1974
1974
1975 if (continue_prompt and self.autoindent and line.isspace() and
1975 if (continue_prompt and self.autoindent and line.isspace() and
1976 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
1976 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
1977 (self.buffer[-1]).isspace() )):
1977 (self.buffer[-1]).isspace() )):
1978 line = ''
1978 line = ''
1979
1979
1980 self.log(line,continue_prompt)
1980 self.log(line,continue_prompt)
1981 return line
1981 return line
1982
1982
1983 def handle_alias(self,line,continue_prompt=None,
1983 def handle_alias(self,line,continue_prompt=None,
1984 pre=None,iFun=None,theRest=None):
1984 pre=None,iFun=None,theRest=None):
1985 """Handle alias input lines. """
1985 """Handle alias input lines. """
1986
1986
1987 # pre is needed, because it carries the leading whitespace. Otherwise
1987 # pre is needed, because it carries the leading whitespace. Otherwise
1988 # aliases won't work in indented sections.
1988 # aliases won't work in indented sections.
1989 line_out = '%sipalias(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
1989 line_out = '%sipalias(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
1990 self.log(line_out,continue_prompt)
1990 self.log(line_out,continue_prompt)
1991 return line_out
1991 return line_out
1992
1992
1993 def handle_shell_escape(self, line, continue_prompt=None,
1993 def handle_shell_escape(self, line, continue_prompt=None,
1994 pre=None,iFun=None,theRest=None):
1994 pre=None,iFun=None,theRest=None):
1995 """Execute the line in a shell, empty return value"""
1995 """Execute the line in a shell, empty return value"""
1996
1996
1997 #print 'line in :', `line` # dbg
1997 #print 'line in :', `line` # dbg
1998 # Example of a special handler. Others follow a similar pattern.
1998 # Example of a special handler. Others follow a similar pattern.
1999 if line.lstrip().startswith('!!'):
1999 if line.lstrip().startswith('!!'):
2000 # rewrite iFun/theRest to properly hold the call to %sx and
2000 # rewrite iFun/theRest to properly hold the call to %sx and
2001 # the actual command to be executed, so handle_magic can work
2001 # the actual command to be executed, so handle_magic can work
2002 # correctly
2002 # correctly
2003 theRest = '%s %s' % (iFun[2:],theRest)
2003 theRest = '%s %s' % (iFun[2:],theRest)
2004 iFun = 'sx'
2004 iFun = 'sx'
2005 return self.handle_magic('%ssx %s' % (self.ESC_MAGIC,
2005 return self.handle_magic('%ssx %s' % (self.ESC_MAGIC,
2006 line.lstrip()[2:]),
2006 line.lstrip()[2:]),
2007 continue_prompt,pre,iFun,theRest)
2007 continue_prompt,pre,iFun,theRest)
2008 else:
2008 else:
2009 cmd=line.lstrip().lstrip('!')
2009 cmd=line.lstrip().lstrip('!')
2010 line_out = '%sipsystem(%s)' % (pre,make_quoted_expr(cmd))
2010 line_out = '%s_ip.system(%s)' % (pre,make_quoted_expr(cmd))
2011 # update cache/log and return
2011 # update cache/log and return
2012 self.log(line_out,continue_prompt)
2012 self.log(line_out,continue_prompt)
2013 return line_out
2013 return line_out
2014
2014
2015 def handle_magic(self, line, continue_prompt=None,
2015 def handle_magic(self, line, continue_prompt=None,
2016 pre=None,iFun=None,theRest=None):
2016 pre=None,iFun=None,theRest=None):
2017 """Execute magic functions."""
2017 """Execute magic functions."""
2018
2018
2019
2019
2020 cmd = '%s_ip.magic(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
2020 cmd = '%s_ip.magic(%s)' % (pre,make_quoted_expr(iFun + " " + theRest))
2021 self.log(cmd,continue_prompt)
2021 self.log(cmd,continue_prompt)
2022 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2022 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2023 return cmd
2023 return cmd
2024
2024
2025 def handle_auto(self, line, continue_prompt=None,
2025 def handle_auto(self, line, continue_prompt=None,
2026 pre=None,iFun=None,theRest=None,obj=None):
2026 pre=None,iFun=None,theRest=None,obj=None):
2027 """Hande lines which can be auto-executed, quoting if requested."""
2027 """Hande lines which can be auto-executed, quoting if requested."""
2028
2028
2029 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2029 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2030
2030
2031 # This should only be active for single-line input!
2031 # This should only be active for single-line input!
2032 if continue_prompt:
2032 if continue_prompt:
2033 self.log(line,continue_prompt)
2033 self.log(line,continue_prompt)
2034 return line
2034 return line
2035
2035
2036 auto_rewrite = True
2036 auto_rewrite = True
2037
2037
2038 if pre == self.ESC_QUOTE:
2038 if pre == self.ESC_QUOTE:
2039 # Auto-quote splitting on whitespace
2039 # Auto-quote splitting on whitespace
2040 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2040 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2041 elif pre == self.ESC_QUOTE2:
2041 elif pre == self.ESC_QUOTE2:
2042 # Auto-quote whole string
2042 # Auto-quote whole string
2043 newcmd = '%s("%s")' % (iFun,theRest)
2043 newcmd = '%s("%s")' % (iFun,theRest)
2044 elif pre == self.ESC_PAREN:
2044 elif pre == self.ESC_PAREN:
2045 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2045 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2046 else:
2046 else:
2047 # Auto-paren.
2047 # Auto-paren.
2048 # We only apply it to argument-less calls if the autocall
2048 # We only apply it to argument-less calls if the autocall
2049 # parameter is set to 2. We only need to check that autocall is <
2049 # parameter is set to 2. We only need to check that autocall is <
2050 # 2, since this function isn't called unless it's at least 1.
2050 # 2, since this function isn't called unless it's at least 1.
2051 if not theRest and (self.rc.autocall < 2):
2051 if not theRest and (self.rc.autocall < 2):
2052 newcmd = '%s %s' % (iFun,theRest)
2052 newcmd = '%s %s' % (iFun,theRest)
2053 auto_rewrite = False
2053 auto_rewrite = False
2054 else:
2054 else:
2055 if theRest.startswith('['):
2055 if theRest.startswith('['):
2056 if hasattr(obj,'__getitem__'):
2056 if hasattr(obj,'__getitem__'):
2057 # Don't autocall in this case: item access for an object
2057 # Don't autocall in this case: item access for an object
2058 # which is BOTH callable and implements __getitem__.
2058 # which is BOTH callable and implements __getitem__.
2059 newcmd = '%s %s' % (iFun,theRest)
2059 newcmd = '%s %s' % (iFun,theRest)
2060 auto_rewrite = False
2060 auto_rewrite = False
2061 else:
2061 else:
2062 # if the object doesn't support [] access, go ahead and
2062 # if the object doesn't support [] access, go ahead and
2063 # autocall
2063 # autocall
2064 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2064 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2065 elif theRest.endswith(';'):
2065 elif theRest.endswith(';'):
2066 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2066 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2067 else:
2067 else:
2068 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2068 newcmd = '%s(%s)' % (iFun.rstrip(),",".join(theRest.split()))
2069
2069
2070 if auto_rewrite:
2070 if auto_rewrite:
2071 print >>Term.cout, self.outputcache.prompt1.auto_rewrite() + newcmd
2071 print >>Term.cout, self.outputcache.prompt1.auto_rewrite() + newcmd
2072 # log what is now valid Python, not the actual user input (without the
2072 # log what is now valid Python, not the actual user input (without the
2073 # final newline)
2073 # final newline)
2074 self.log(newcmd,continue_prompt)
2074 self.log(newcmd,continue_prompt)
2075 return newcmd
2075 return newcmd
2076
2076
2077 def handle_help(self, line, continue_prompt=None,
2077 def handle_help(self, line, continue_prompt=None,
2078 pre=None,iFun=None,theRest=None):
2078 pre=None,iFun=None,theRest=None):
2079 """Try to get some help for the object.
2079 """Try to get some help for the object.
2080
2080
2081 obj? or ?obj -> basic information.
2081 obj? or ?obj -> basic information.
2082 obj?? or ??obj -> more details.
2082 obj?? or ??obj -> more details.
2083 """
2083 """
2084
2084
2085 # We need to make sure that we don't process lines which would be
2085 # We need to make sure that we don't process lines which would be
2086 # otherwise valid python, such as "x=1 # what?"
2086 # otherwise valid python, such as "x=1 # what?"
2087 try:
2087 try:
2088 codeop.compile_command(line)
2088 codeop.compile_command(line)
2089 except SyntaxError:
2089 except SyntaxError:
2090 # We should only handle as help stuff which is NOT valid syntax
2090 # We should only handle as help stuff which is NOT valid syntax
2091 if line[0]==self.ESC_HELP:
2091 if line[0]==self.ESC_HELP:
2092 line = line[1:]
2092 line = line[1:]
2093 elif line[-1]==self.ESC_HELP:
2093 elif line[-1]==self.ESC_HELP:
2094 line = line[:-1]
2094 line = line[:-1]
2095 self.log('#?'+line)
2095 self.log('#?'+line)
2096 if line:
2096 if line:
2097 self.magic_pinfo(line)
2097 self.magic_pinfo(line)
2098 else:
2098 else:
2099 page(self.usage,screen_lines=self.rc.screen_length)
2099 page(self.usage,screen_lines=self.rc.screen_length)
2100 return '' # Empty string is needed here!
2100 return '' # Empty string is needed here!
2101 except:
2101 except:
2102 # Pass any other exceptions through to the normal handler
2102 # Pass any other exceptions through to the normal handler
2103 return self.handle_normal(line,continue_prompt)
2103 return self.handle_normal(line,continue_prompt)
2104 else:
2104 else:
2105 # If the code compiles ok, we should handle it normally
2105 # If the code compiles ok, we should handle it normally
2106 return self.handle_normal(line,continue_prompt)
2106 return self.handle_normal(line,continue_prompt)
2107
2107
2108 def getapi(self):
2108 def getapi(self):
2109 """ Get an IPApi object for this shell instance
2109 """ Get an IPApi object for this shell instance
2110
2110
2111 Getting an IPApi object is always preferable to accessing the shell
2111 Getting an IPApi object is always preferable to accessing the shell
2112 directly, but this holds true especially for extensions.
2112 directly, but this holds true especially for extensions.
2113
2113
2114 It should always be possible to implement an extension with IPApi
2114 It should always be possible to implement an extension with IPApi
2115 alone. If not, contact maintainer to request an addition.
2115 alone. If not, contact maintainer to request an addition.
2116
2116
2117 """
2117 """
2118 return self.api
2118 return self.api
2119
2119
2120 def handle_emacs(self,line,continue_prompt=None,
2120 def handle_emacs(self,line,continue_prompt=None,
2121 pre=None,iFun=None,theRest=None):
2121 pre=None,iFun=None,theRest=None):
2122 """Handle input lines marked by python-mode."""
2122 """Handle input lines marked by python-mode."""
2123
2123
2124 # Currently, nothing is done. Later more functionality can be added
2124 # Currently, nothing is done. Later more functionality can be added
2125 # here if needed.
2125 # here if needed.
2126
2126
2127 # The input cache shouldn't be updated
2127 # The input cache shouldn't be updated
2128
2128
2129 return line
2129 return line
2130
2130
2131 def mktempfile(self,data=None):
2131 def mktempfile(self,data=None):
2132 """Make a new tempfile and return its filename.
2132 """Make a new tempfile and return its filename.
2133
2133
2134 This makes a call to tempfile.mktemp, but it registers the created
2134 This makes a call to tempfile.mktemp, but it registers the created
2135 filename internally so ipython cleans it up at exit time.
2135 filename internally so ipython cleans it up at exit time.
2136
2136
2137 Optional inputs:
2137 Optional inputs:
2138
2138
2139 - data(None): if data is given, it gets written out to the temp file
2139 - data(None): if data is given, it gets written out to the temp file
2140 immediately, and the file is closed again."""
2140 immediately, and the file is closed again."""
2141
2141
2142 filename = tempfile.mktemp('.py','ipython_edit_')
2142 filename = tempfile.mktemp('.py','ipython_edit_')
2143 self.tempfiles.append(filename)
2143 self.tempfiles.append(filename)
2144
2144
2145 if data:
2145 if data:
2146 tmp_file = open(filename,'w')
2146 tmp_file = open(filename,'w')
2147 tmp_file.write(data)
2147 tmp_file.write(data)
2148 tmp_file.close()
2148 tmp_file.close()
2149 return filename
2149 return filename
2150
2150
2151 def write(self,data):
2151 def write(self,data):
2152 """Write a string to the default output"""
2152 """Write a string to the default output"""
2153 Term.cout.write(data)
2153 Term.cout.write(data)
2154
2154
2155 def write_err(self,data):
2155 def write_err(self,data):
2156 """Write a string to the default error output"""
2156 """Write a string to the default error output"""
2157 Term.cerr.write(data)
2157 Term.cerr.write(data)
2158
2158
2159 def exit(self):
2159 def exit(self):
2160 """Handle interactive exit.
2160 """Handle interactive exit.
2161
2161
2162 This method sets the exit_now attribute."""
2162 This method sets the exit_now attribute."""
2163
2163
2164 if self.rc.confirm_exit:
2164 if self.rc.confirm_exit:
2165 if ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2165 if ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2166 self.exit_now = True
2166 self.exit_now = True
2167 else:
2167 else:
2168 self.exit_now = True
2168 self.exit_now = True
2169 return self.exit_now
2169 return self.exit_now
2170
2170
2171 def safe_execfile(self,fname,*where,**kw):
2171 def safe_execfile(self,fname,*where,**kw):
2172 fname = os.path.expanduser(fname)
2172 fname = os.path.expanduser(fname)
2173
2173
2174 # find things also in current directory
2174 # find things also in current directory
2175 dname = os.path.dirname(fname)
2175 dname = os.path.dirname(fname)
2176 if not sys.path.count(dname):
2176 if not sys.path.count(dname):
2177 sys.path.append(dname)
2177 sys.path.append(dname)
2178
2178
2179 try:
2179 try:
2180 xfile = open(fname)
2180 xfile = open(fname)
2181 except:
2181 except:
2182 print >> Term.cerr, \
2182 print >> Term.cerr, \
2183 'Could not open file <%s> for safe execution.' % fname
2183 'Could not open file <%s> for safe execution.' % fname
2184 return None
2184 return None
2185
2185
2186 kw.setdefault('islog',0)
2186 kw.setdefault('islog',0)
2187 kw.setdefault('quiet',1)
2187 kw.setdefault('quiet',1)
2188 kw.setdefault('exit_ignore',0)
2188 kw.setdefault('exit_ignore',0)
2189 first = xfile.readline()
2189 first = xfile.readline()
2190 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2190 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2191 xfile.close()
2191 xfile.close()
2192 # line by line execution
2192 # line by line execution
2193 if first.startswith(loghead) or kw['islog']:
2193 if first.startswith(loghead) or kw['islog']:
2194 print 'Loading log file <%s> one line at a time...' % fname
2194 print 'Loading log file <%s> one line at a time...' % fname
2195 if kw['quiet']:
2195 if kw['quiet']:
2196 stdout_save = sys.stdout
2196 stdout_save = sys.stdout
2197 sys.stdout = StringIO.StringIO()
2197 sys.stdout = StringIO.StringIO()
2198 try:
2198 try:
2199 globs,locs = where[0:2]
2199 globs,locs = where[0:2]
2200 except:
2200 except:
2201 try:
2201 try:
2202 globs = locs = where[0]
2202 globs = locs = where[0]
2203 except:
2203 except:
2204 globs = locs = globals()
2204 globs = locs = globals()
2205 badblocks = []
2205 badblocks = []
2206
2206
2207 # we also need to identify indented blocks of code when replaying
2207 # we also need to identify indented blocks of code when replaying
2208 # logs and put them together before passing them to an exec
2208 # logs and put them together before passing them to an exec
2209 # statement. This takes a bit of regexp and look-ahead work in the
2209 # statement. This takes a bit of regexp and look-ahead work in the
2210 # file. It's easiest if we swallow the whole thing in memory
2210 # file. It's easiest if we swallow the whole thing in memory
2211 # first, and manually walk through the lines list moving the
2211 # first, and manually walk through the lines list moving the
2212 # counter ourselves.
2212 # counter ourselves.
2213 indent_re = re.compile('\s+\S')
2213 indent_re = re.compile('\s+\S')
2214 xfile = open(fname)
2214 xfile = open(fname)
2215 filelines = xfile.readlines()
2215 filelines = xfile.readlines()
2216 xfile.close()
2216 xfile.close()
2217 nlines = len(filelines)
2217 nlines = len(filelines)
2218 lnum = 0
2218 lnum = 0
2219 while lnum < nlines:
2219 while lnum < nlines:
2220 line = filelines[lnum]
2220 line = filelines[lnum]
2221 lnum += 1
2221 lnum += 1
2222 # don't re-insert logger status info into cache
2222 # don't re-insert logger status info into cache
2223 if line.startswith('#log#'):
2223 if line.startswith('#log#'):
2224 continue
2224 continue
2225 else:
2225 else:
2226 # build a block of code (maybe a single line) for execution
2226 # build a block of code (maybe a single line) for execution
2227 block = line
2227 block = line
2228 try:
2228 try:
2229 next = filelines[lnum] # lnum has already incremented
2229 next = filelines[lnum] # lnum has already incremented
2230 except:
2230 except:
2231 next = None
2231 next = None
2232 while next and indent_re.match(next):
2232 while next and indent_re.match(next):
2233 block += next
2233 block += next
2234 lnum += 1
2234 lnum += 1
2235 try:
2235 try:
2236 next = filelines[lnum]
2236 next = filelines[lnum]
2237 except:
2237 except:
2238 next = None
2238 next = None
2239 # now execute the block of one or more lines
2239 # now execute the block of one or more lines
2240 try:
2240 try:
2241 exec block in globs,locs
2241 exec block in globs,locs
2242 except SystemExit:
2242 except SystemExit:
2243 pass
2243 pass
2244 except:
2244 except:
2245 badblocks.append(block.rstrip())
2245 badblocks.append(block.rstrip())
2246 if kw['quiet']: # restore stdout
2246 if kw['quiet']: # restore stdout
2247 sys.stdout.close()
2247 sys.stdout.close()
2248 sys.stdout = stdout_save
2248 sys.stdout = stdout_save
2249 print 'Finished replaying log file <%s>' % fname
2249 print 'Finished replaying log file <%s>' % fname
2250 if badblocks:
2250 if badblocks:
2251 print >> sys.stderr, ('\nThe following lines/blocks in file '
2251 print >> sys.stderr, ('\nThe following lines/blocks in file '
2252 '<%s> reported errors:' % fname)
2252 '<%s> reported errors:' % fname)
2253
2253
2254 for badline in badblocks:
2254 for badline in badblocks:
2255 print >> sys.stderr, badline
2255 print >> sys.stderr, badline
2256 else: # regular file execution
2256 else: # regular file execution
2257 try:
2257 try:
2258 execfile(fname,*where)
2258 execfile(fname,*where)
2259 except SyntaxError:
2259 except SyntaxError:
2260 etype,evalue = sys.exc_info()[:2]
2260 etype,evalue = sys.exc_info()[:2]
2261 self.SyntaxTB(etype,evalue,[])
2261 self.SyntaxTB(etype,evalue,[])
2262 warn('Failure executing file: <%s>' % fname)
2262 warn('Failure executing file: <%s>' % fname)
2263 except SystemExit,status:
2263 except SystemExit,status:
2264 if not kw['exit_ignore']:
2264 if not kw['exit_ignore']:
2265 self.InteractiveTB()
2265 self.InteractiveTB()
2266 warn('Failure executing file: <%s>' % fname)
2266 warn('Failure executing file: <%s>' % fname)
2267 except:
2267 except:
2268 self.InteractiveTB()
2268 self.InteractiveTB()
2269 warn('Failure executing file: <%s>' % fname)
2269 warn('Failure executing file: <%s>' % fname)
2270
2270
2271 #************************* end of file <iplib.py> *****************************
2271 #************************* end of file <iplib.py> *****************************
General Comments 0
You need to be logged in to leave comments. Login now