##// END OF EJS Templates
ipapi decorators ashook, asmagic; ipapi.options() for __IP.rc access
vivainio -
Show More

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

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