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