##// END OF EJS Templates
Hooks now implement "Chain of Command" design pattern,...
vivainio -
Show More

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

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