##// END OF EJS Templates
ipalias deprecated/redundant; aliases are converted and called...
vivainio -
Show More

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

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