##// END OF EJS Templates
Fix quoting of aliases in transform_alias
vivainio -
Show More

The requested changes are too big and content was truncated. Show full diff

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