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