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