##// END OF EJS Templates
Add demo app. Add callback for exit to the ipython0 code.
Gael Varoquaux -
Show More
@@ -0,0 +1,80 b''
1 """
2 Entry point for a simple application giving a graphical frontend to
3 ipython.
4 """
5
6 import wx
7 from wx_frontend import WxController
8
9 class WIPythonController(WxController):
10 """ Sub class of WxController that adds some application-specific
11 bindings.
12 """
13
14 def __init__(self, *args, **kwargs):
15 WxController.__init__(self, *args, **kwargs)
16 self.ipython0.ask_exit = self.do_exit
17
18
19 def _on_key_down(self, event, skip=True):
20 # Intercept Ctrl-D to quit
21 if event.KeyCode == ord('D') and event.ControlDown() and \
22 self.get_current_edit_buffer()=='':
23 wx.CallAfter(self.ask_exit)
24 else:
25 WxController._on_key_down(self, event, skip=skip)
26
27
28 def ask_exit(self):
29 """ Ask the user whether to exit.
30 """
31 self.write('\n')
32 self.capture_output()
33 self.ipython0.shell.exit()
34 self.release_output()
35 wx.Yield()
36 if not self.ipython0.exit_now:
37 self.new_prompt(self.prompt % (self.last_result['number'] + 1))
38
39
40 def do_exit(self):
41 """ Exits the interpreter, kills the windows.
42 """
43 WxController.do_exit(self)
44 # Remove the callbacks, to avoid PyDeadObjectErrors
45 do_nothing = lambda *args, **kwargs: True
46 self.release_output()
47 self._on_key_down = do_nothing
48 self._on_key_up = do_nothing
49 self._on_enter = do_nothing
50 self.after_execute = do_nothing
51 wx.Yield()
52 wx.CallAfter(self.Parent.Destroy)
53
54
55
56 class WIPython(wx.Frame):
57 """ Main frame of the WIPython app.
58 """
59
60 def __init__(self, parent, id, title):
61 wx.Frame.__init__(self, parent, id, title, size=(300,250))
62 self._sizer = wx.BoxSizer(wx.VERTICAL)
63 self.shell = WIPythonController(self)
64 self._sizer.Add(self.shell, 1, wx.EXPAND)
65 self.SetSizer(self._sizer)
66 self.SetAutoLayout(1)
67 self.Show(True)
68
69
70 def main():
71 app = wx.PySimpleApp()
72 frame = WIPython(None, wx.ID_ANY, 'WIpython')
73 frame.shell.SetFocus()
74 frame.shell.app = app
75 frame.SetSize((680, 460))
76
77 app.MainLoop()
78
79 if __name__ == '__main__':
80 main()
@@ -1,62 +1,62 b''
1 1 """ Legacy stuff
2 2
3 3 Various stuff that are there for historical / familiarity reasons.
4 4
5 5 This is automatically imported by default profile, though not other profiles
6 6 (e.g. 'sh' profile).
7 7
8 8 Stuff that is considered obsolete / redundant is gradually moved here.
9 9
10 10 """
11 11
12 12 import IPython.ipapi
13 13 ip = IPython.ipapi.get()
14 14
15 15 import os,sys
16 16
17 17 from IPython.genutils import *
18 18
19 19 # use rehashx
20 20
21 21 def magic_rehash(self, parameter_s = ''):
22 22 """Update the alias table with all entries in $PATH.
23 23
24 24 This version does no checks on execute permissions or whether the
25 25 contents of $PATH are truly files (instead of directories or something
26 26 else). For such a safer (but slower) version, use %rehashx."""
27 27
28 28 # This function (and rehashx) manipulate the alias_table directly
29 29 # rather than calling magic_alias, for speed reasons. A rehash on a
30 30 # typical Linux box involves several thousand entries, so efficiency
31 31 # here is a top concern.
32 32
33 33 path = filter(os.path.isdir,os.environ.get('PATH','').split(os.pathsep))
34 34 alias_table = self.shell.alias_table
35 35 for pdir in path:
36 36 for ff in os.listdir(pdir):
37 37 # each entry in the alias table must be (N,name), where
38 38 # N is the number of positional arguments of the alias.
39 39 alias_table[ff] = (0,ff)
40 40 # Make sure the alias table doesn't contain keywords or builtins
41 41 self.shell.alias_table_validate()
42 42 # Call again init_auto_alias() so we get 'rm -i' and other modified
43 43 # aliases since %rehash will probably clobber them
44 44 self.shell.init_auto_alias()
45 45
46 46 ip.expose_magic("rehash", magic_rehash)
47 47
48 48 # Exit
49 49 def magic_Quit(self, parameter_s=''):
50 50 """Exit IPython without confirmation (like %Exit)."""
51 51
52 self.shell.exit_now = True
52 self.shell.ask_exit()
53 53
54 54 ip.expose_magic("Quit", magic_Quit)
55 55
56 56
57 57 # make it autocallable fn if you really need it
58 58 def magic_p(self, parameter_s=''):
59 59 """Just a short alias for Python's 'print'."""
60 60 exec 'print ' + parameter_s in self.shell.user_ns
61 61
62 62 ip.expose_magic("p", magic_p)
@@ -1,3318 +1,3318 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Magic functions for InteractiveShell.
3 3
4 4 $Id: Magic.py 2996 2008-01-30 06:31:39Z fperez $"""
5 5
6 6 #*****************************************************************************
7 7 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
8 8 # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu>
9 9 #
10 10 # Distributed under the terms of the BSD License. The full license is in
11 11 # the file COPYING, distributed as part of this software.
12 12 #*****************************************************************************
13 13
14 14 #****************************************************************************
15 15 # Modules and globals
16 16
17 17 from IPython import Release
18 18 __author__ = '%s <%s>\n%s <%s>' % \
19 19 ( Release.authors['Janko'] + Release.authors['Fernando'] )
20 20 __license__ = Release.license
21 21
22 22 # Python standard modules
23 23 import __builtin__
24 24 import bdb
25 25 import inspect
26 26 import os
27 27 import pdb
28 28 import pydoc
29 29 import sys
30 30 import re
31 31 import tempfile
32 32 import time
33 33 import cPickle as pickle
34 34 import textwrap
35 35 from cStringIO import StringIO
36 36 from getopt import getopt,GetoptError
37 37 from pprint import pprint, pformat
38 38 from sets import Set
39 39
40 40 # cProfile was added in Python2.5
41 41 try:
42 42 import cProfile as profile
43 43 import pstats
44 44 except ImportError:
45 45 # profile isn't bundled by default in Debian for license reasons
46 46 try:
47 47 import profile,pstats
48 48 except ImportError:
49 49 profile = pstats = None
50 50
51 51 # Homebrewed
52 52 import IPython
53 53 from IPython import Debugger, OInspect, wildcard
54 54 from IPython.FakeModule import FakeModule
55 55 from IPython.Itpl import Itpl, itpl, printpl,itplns
56 56 from IPython.PyColorize import Parser
57 57 from IPython.ipstruct import Struct
58 58 from IPython.macro import Macro
59 59 from IPython.genutils import *
60 60 from IPython import platutils
61 61 import IPython.generics
62 62 import IPython.ipapi
63 63 from IPython.ipapi import UsageError
64 64 #***************************************************************************
65 65 # Utility functions
66 66 def on_off(tag):
67 67 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
68 68 return ['OFF','ON'][tag]
69 69
70 70 class Bunch: pass
71 71
72 72 def compress_dhist(dh):
73 73 head, tail = dh[:-10], dh[-10:]
74 74
75 75 newhead = []
76 76 done = Set()
77 77 for h in head:
78 78 if h in done:
79 79 continue
80 80 newhead.append(h)
81 81 done.add(h)
82 82
83 83 return newhead + tail
84 84
85 85
86 86 #***************************************************************************
87 87 # Main class implementing Magic functionality
88 88 class Magic:
89 89 """Magic functions for InteractiveShell.
90 90
91 91 Shell functions which can be reached as %function_name. All magic
92 92 functions should accept a string, which they can parse for their own
93 93 needs. This can make some functions easier to type, eg `%cd ../`
94 94 vs. `%cd("../")`
95 95
96 96 ALL definitions MUST begin with the prefix magic_. The user won't need it
97 97 at the command line, but it is is needed in the definition. """
98 98
99 99 # class globals
100 100 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
101 101 'Automagic is ON, % prefix NOT needed for magic functions.']
102 102
103 103 #......................................................................
104 104 # some utility functions
105 105
106 106 def __init__(self,shell):
107 107
108 108 self.options_table = {}
109 109 if profile is None:
110 110 self.magic_prun = self.profile_missing_notice
111 111 self.shell = shell
112 112
113 113 # namespace for holding state we may need
114 114 self._magic_state = Bunch()
115 115
116 116 def profile_missing_notice(self, *args, **kwargs):
117 117 error("""\
118 118 The profile module could not be found. It has been removed from the standard
119 119 python packages because of its non-free license. To use profiling, install the
120 120 python-profiler package from non-free.""")
121 121
122 122 def default_option(self,fn,optstr):
123 123 """Make an entry in the options_table for fn, with value optstr"""
124 124
125 125 if fn not in self.lsmagic():
126 126 error("%s is not a magic function" % fn)
127 127 self.options_table[fn] = optstr
128 128
129 129 def lsmagic(self):
130 130 """Return a list of currently available magic functions.
131 131
132 132 Gives a list of the bare names after mangling (['ls','cd', ...], not
133 133 ['magic_ls','magic_cd',...]"""
134 134
135 135 # FIXME. This needs a cleanup, in the way the magics list is built.
136 136
137 137 # magics in class definition
138 138 class_magic = lambda fn: fn.startswith('magic_') and \
139 139 callable(Magic.__dict__[fn])
140 140 # in instance namespace (run-time user additions)
141 141 inst_magic = lambda fn: fn.startswith('magic_') and \
142 142 callable(self.__dict__[fn])
143 143 # and bound magics by user (so they can access self):
144 144 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
145 145 callable(self.__class__.__dict__[fn])
146 146 magics = filter(class_magic,Magic.__dict__.keys()) + \
147 147 filter(inst_magic,self.__dict__.keys()) + \
148 148 filter(inst_bound_magic,self.__class__.__dict__.keys())
149 149 out = []
150 150 for fn in Set(magics):
151 151 out.append(fn.replace('magic_','',1))
152 152 out.sort()
153 153 return out
154 154
155 155 def extract_input_slices(self,slices,raw=False):
156 156 """Return as a string a set of input history slices.
157 157
158 158 Inputs:
159 159
160 160 - slices: the set of slices is given as a list of strings (like
161 161 ['1','4:8','9'], since this function is for use by magic functions
162 162 which get their arguments as strings.
163 163
164 164 Optional inputs:
165 165
166 166 - raw(False): by default, the processed input is used. If this is
167 167 true, the raw input history is used instead.
168 168
169 169 Note that slices can be called with two notations:
170 170
171 171 N:M -> standard python form, means including items N...(M-1).
172 172
173 173 N-M -> include items N..M (closed endpoint)."""
174 174
175 175 if raw:
176 176 hist = self.shell.input_hist_raw
177 177 else:
178 178 hist = self.shell.input_hist
179 179
180 180 cmds = []
181 181 for chunk in slices:
182 182 if ':' in chunk:
183 183 ini,fin = map(int,chunk.split(':'))
184 184 elif '-' in chunk:
185 185 ini,fin = map(int,chunk.split('-'))
186 186 fin += 1
187 187 else:
188 188 ini = int(chunk)
189 189 fin = ini+1
190 190 cmds.append(hist[ini:fin])
191 191 return cmds
192 192
193 193 def _ofind(self, oname, namespaces=None):
194 194 """Find an object in the available namespaces.
195 195
196 196 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
197 197
198 198 Has special code to detect magic functions.
199 199 """
200 200
201 201 oname = oname.strip()
202 202
203 203 alias_ns = None
204 204 if namespaces is None:
205 205 # Namespaces to search in:
206 206 # Put them in a list. The order is important so that we
207 207 # find things in the same order that Python finds them.
208 208 namespaces = [ ('Interactive', self.shell.user_ns),
209 209 ('IPython internal', self.shell.internal_ns),
210 210 ('Python builtin', __builtin__.__dict__),
211 211 ('Alias', self.shell.alias_table),
212 212 ]
213 213 alias_ns = self.shell.alias_table
214 214
215 215 # initialize results to 'null'
216 216 found = 0; obj = None; ospace = None; ds = None;
217 217 ismagic = 0; isalias = 0; parent = None
218 218
219 219 # Look for the given name by splitting it in parts. If the head is
220 220 # found, then we look for all the remaining parts as members, and only
221 221 # declare success if we can find them all.
222 222 oname_parts = oname.split('.')
223 223 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
224 224 for nsname,ns in namespaces:
225 225 try:
226 226 obj = ns[oname_head]
227 227 except KeyError:
228 228 continue
229 229 else:
230 230 #print 'oname_rest:', oname_rest # dbg
231 231 for part in oname_rest:
232 232 try:
233 233 parent = obj
234 234 obj = getattr(obj,part)
235 235 except:
236 236 # Blanket except b/c some badly implemented objects
237 237 # allow __getattr__ to raise exceptions other than
238 238 # AttributeError, which then crashes IPython.
239 239 break
240 240 else:
241 241 # If we finish the for loop (no break), we got all members
242 242 found = 1
243 243 ospace = nsname
244 244 if ns == alias_ns:
245 245 isalias = 1
246 246 break # namespace loop
247 247
248 248 # Try to see if it's magic
249 249 if not found:
250 250 if oname.startswith(self.shell.ESC_MAGIC):
251 251 oname = oname[1:]
252 252 obj = getattr(self,'magic_'+oname,None)
253 253 if obj is not None:
254 254 found = 1
255 255 ospace = 'IPython internal'
256 256 ismagic = 1
257 257
258 258 # Last try: special-case some literals like '', [], {}, etc:
259 259 if not found and oname_head in ["''",'""','[]','{}','()']:
260 260 obj = eval(oname_head)
261 261 found = 1
262 262 ospace = 'Interactive'
263 263
264 264 return {'found':found, 'obj':obj, 'namespace':ospace,
265 265 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
266 266
267 267 def arg_err(self,func):
268 268 """Print docstring if incorrect arguments were passed"""
269 269 print 'Error in arguments:'
270 270 print OInspect.getdoc(func)
271 271
272 272 def format_latex(self,strng):
273 273 """Format a string for latex inclusion."""
274 274
275 275 # Characters that need to be escaped for latex:
276 276 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
277 277 # Magic command names as headers:
278 278 cmd_name_re = re.compile(r'^(%s.*?):' % self.shell.ESC_MAGIC,
279 279 re.MULTILINE)
280 280 # Magic commands
281 281 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % self.shell.ESC_MAGIC,
282 282 re.MULTILINE)
283 283 # Paragraph continue
284 284 par_re = re.compile(r'\\$',re.MULTILINE)
285 285
286 286 # The "\n" symbol
287 287 newline_re = re.compile(r'\\n')
288 288
289 289 # Now build the string for output:
290 290 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
291 291 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
292 292 strng)
293 293 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
294 294 strng = par_re.sub(r'\\\\',strng)
295 295 strng = escape_re.sub(r'\\\1',strng)
296 296 strng = newline_re.sub(r'\\textbackslash{}n',strng)
297 297 return strng
298 298
299 299 def format_screen(self,strng):
300 300 """Format a string for screen printing.
301 301
302 302 This removes some latex-type format codes."""
303 303 # Paragraph continue
304 304 par_re = re.compile(r'\\$',re.MULTILINE)
305 305 strng = par_re.sub('',strng)
306 306 return strng
307 307
308 308 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
309 309 """Parse options passed to an argument string.
310 310
311 311 The interface is similar to that of getopt(), but it returns back a
312 312 Struct with the options as keys and the stripped argument string still
313 313 as a string.
314 314
315 315 arg_str is quoted as a true sys.argv vector by using shlex.split.
316 316 This allows us to easily expand variables, glob files, quote
317 317 arguments, etc.
318 318
319 319 Options:
320 320 -mode: default 'string'. If given as 'list', the argument string is
321 321 returned as a list (split on whitespace) instead of a string.
322 322
323 323 -list_all: put all option values in lists. Normally only options
324 324 appearing more than once are put in a list.
325 325
326 326 -posix (True): whether to split the input line in POSIX mode or not,
327 327 as per the conventions outlined in the shlex module from the
328 328 standard library."""
329 329
330 330 # inject default options at the beginning of the input line
331 331 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
332 332 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
333 333
334 334 mode = kw.get('mode','string')
335 335 if mode not in ['string','list']:
336 336 raise ValueError,'incorrect mode given: %s' % mode
337 337 # Get options
338 338 list_all = kw.get('list_all',0)
339 339 posix = kw.get('posix',True)
340 340
341 341 # Check if we have more than one argument to warrant extra processing:
342 342 odict = {} # Dictionary with options
343 343 args = arg_str.split()
344 344 if len(args) >= 1:
345 345 # If the list of inputs only has 0 or 1 thing in it, there's no
346 346 # need to look for options
347 347 argv = arg_split(arg_str,posix)
348 348 # Do regular option processing
349 349 try:
350 350 opts,args = getopt(argv,opt_str,*long_opts)
351 351 except GetoptError,e:
352 352 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
353 353 " ".join(long_opts)))
354 354 for o,a in opts:
355 355 if o.startswith('--'):
356 356 o = o[2:]
357 357 else:
358 358 o = o[1:]
359 359 try:
360 360 odict[o].append(a)
361 361 except AttributeError:
362 362 odict[o] = [odict[o],a]
363 363 except KeyError:
364 364 if list_all:
365 365 odict[o] = [a]
366 366 else:
367 367 odict[o] = a
368 368
369 369 # Prepare opts,args for return
370 370 opts = Struct(odict)
371 371 if mode == 'string':
372 372 args = ' '.join(args)
373 373
374 374 return opts,args
375 375
376 376 #......................................................................
377 377 # And now the actual magic functions
378 378
379 379 # Functions for IPython shell work (vars,funcs, config, etc)
380 380 def magic_lsmagic(self, parameter_s = ''):
381 381 """List currently available magic functions."""
382 382 mesc = self.shell.ESC_MAGIC
383 383 print 'Available magic functions:\n'+mesc+\
384 384 (' '+mesc).join(self.lsmagic())
385 385 print '\n' + Magic.auto_status[self.shell.rc.automagic]
386 386 return None
387 387
388 388 def magic_magic(self, parameter_s = ''):
389 389 """Print information about the magic function system.
390 390
391 391 Supported formats: -latex, -brief, -rest
392 392 """
393 393
394 394 mode = ''
395 395 try:
396 396 if parameter_s.split()[0] == '-latex':
397 397 mode = 'latex'
398 398 if parameter_s.split()[0] == '-brief':
399 399 mode = 'brief'
400 400 if parameter_s.split()[0] == '-rest':
401 401 mode = 'rest'
402 402 rest_docs = []
403 403 except:
404 404 pass
405 405
406 406 magic_docs = []
407 407 for fname in self.lsmagic():
408 408 mname = 'magic_' + fname
409 409 for space in (Magic,self,self.__class__):
410 410 try:
411 411 fn = space.__dict__[mname]
412 412 except KeyError:
413 413 pass
414 414 else:
415 415 break
416 416 if mode == 'brief':
417 417 # only first line
418 418 if fn.__doc__:
419 419 fndoc = fn.__doc__.split('\n',1)[0]
420 420 else:
421 421 fndoc = 'No documentation'
422 422 else:
423 423 fndoc = fn.__doc__.rstrip()
424 424
425 425 if mode == 'rest':
426 426 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(self.shell.ESC_MAGIC,
427 427 fname,fndoc))
428 428
429 429 else:
430 430 magic_docs.append('%s%s:\n\t%s\n' %(self.shell.ESC_MAGIC,
431 431 fname,fndoc))
432 432
433 433 magic_docs = ''.join(magic_docs)
434 434
435 435 if mode == 'rest':
436 436 return "".join(rest_docs)
437 437
438 438 if mode == 'latex':
439 439 print self.format_latex(magic_docs)
440 440 return
441 441 else:
442 442 magic_docs = self.format_screen(magic_docs)
443 443 if mode == 'brief':
444 444 return magic_docs
445 445
446 446 outmsg = """
447 447 IPython's 'magic' functions
448 448 ===========================
449 449
450 450 The magic function system provides a series of functions which allow you to
451 451 control the behavior of IPython itself, plus a lot of system-type
452 452 features. All these functions are prefixed with a % character, but parameters
453 453 are given without parentheses or quotes.
454 454
455 455 NOTE: If you have 'automagic' enabled (via the command line option or with the
456 456 %automagic function), you don't need to type in the % explicitly. By default,
457 457 IPython ships with automagic on, so you should only rarely need the % escape.
458 458
459 459 Example: typing '%cd mydir' (without the quotes) changes you working directory
460 460 to 'mydir', if it exists.
461 461
462 462 You can define your own magic functions to extend the system. See the supplied
463 463 ipythonrc and example-magic.py files for details (in your ipython
464 464 configuration directory, typically $HOME/.ipython/).
465 465
466 466 You can also define your own aliased names for magic functions. In your
467 467 ipythonrc file, placing a line like:
468 468
469 469 execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile
470 470
471 471 will define %pf as a new name for %profile.
472 472
473 473 You can also call magics in code using the ipmagic() function, which IPython
474 474 automatically adds to the builtin namespace. Type 'ipmagic?' for details.
475 475
476 476 For a list of the available magic functions, use %lsmagic. For a description
477 477 of any of them, type %magic_name?, e.g. '%cd?'.
478 478
479 479 Currently the magic system has the following functions:\n"""
480 480
481 481 mesc = self.shell.ESC_MAGIC
482 482 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
483 483 "\n\n%s%s\n\n%s" % (outmsg,
484 484 magic_docs,mesc,mesc,
485 485 (' '+mesc).join(self.lsmagic()),
486 486 Magic.auto_status[self.shell.rc.automagic] ) )
487 487
488 488 page(outmsg,screen_lines=self.shell.rc.screen_length)
489 489
490 490
491 491 def magic_autoindent(self, parameter_s = ''):
492 492 """Toggle autoindent on/off (if available)."""
493 493
494 494 self.shell.set_autoindent()
495 495 print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent]
496 496
497 497
498 498 def magic_automagic(self, parameter_s = ''):
499 499 """Make magic functions callable without having to type the initial %.
500 500
501 501 Without argumentsl toggles on/off (when off, you must call it as
502 502 %automagic, of course). With arguments it sets the value, and you can
503 503 use any of (case insensitive):
504 504
505 505 - on,1,True: to activate
506 506
507 507 - off,0,False: to deactivate.
508 508
509 509 Note that magic functions have lowest priority, so if there's a
510 510 variable whose name collides with that of a magic fn, automagic won't
511 511 work for that function (you get the variable instead). However, if you
512 512 delete the variable (del var), the previously shadowed magic function
513 513 becomes visible to automagic again."""
514 514
515 515 rc = self.shell.rc
516 516 arg = parameter_s.lower()
517 517 if parameter_s in ('on','1','true'):
518 518 rc.automagic = True
519 519 elif parameter_s in ('off','0','false'):
520 520 rc.automagic = False
521 521 else:
522 522 rc.automagic = not rc.automagic
523 523 print '\n' + Magic.auto_status[rc.automagic]
524 524
525 525
526 526 def magic_autocall(self, parameter_s = ''):
527 527 """Make functions callable without having to type parentheses.
528 528
529 529 Usage:
530 530
531 531 %autocall [mode]
532 532
533 533 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
534 534 value is toggled on and off (remembering the previous state).
535 535
536 536 In more detail, these values mean:
537 537
538 538 0 -> fully disabled
539 539
540 540 1 -> active, but do not apply if there are no arguments on the line.
541 541
542 542 In this mode, you get:
543 543
544 544 In [1]: callable
545 545 Out[1]: <built-in function callable>
546 546
547 547 In [2]: callable 'hello'
548 548 ------> callable('hello')
549 549 Out[2]: False
550 550
551 551 2 -> Active always. Even if no arguments are present, the callable
552 552 object is called:
553 553
554 554 In [4]: callable
555 555 ------> callable()
556 556
557 557 Note that even with autocall off, you can still use '/' at the start of
558 558 a line to treat the first argument on the command line as a function
559 559 and add parentheses to it:
560 560
561 561 In [8]: /str 43
562 562 ------> str(43)
563 563 Out[8]: '43'
564 564 """
565 565
566 566 rc = self.shell.rc
567 567
568 568 if parameter_s:
569 569 arg = int(parameter_s)
570 570 else:
571 571 arg = 'toggle'
572 572
573 573 if not arg in (0,1,2,'toggle'):
574 574 error('Valid modes: (0->Off, 1->Smart, 2->Full')
575 575 return
576 576
577 577 if arg in (0,1,2):
578 578 rc.autocall = arg
579 579 else: # toggle
580 580 if rc.autocall:
581 581 self._magic_state.autocall_save = rc.autocall
582 582 rc.autocall = 0
583 583 else:
584 584 try:
585 585 rc.autocall = self._magic_state.autocall_save
586 586 except AttributeError:
587 587 rc.autocall = self._magic_state.autocall_save = 1
588 588
589 589 print "Automatic calling is:",['OFF','Smart','Full'][rc.autocall]
590 590
591 591 def magic_system_verbose(self, parameter_s = ''):
592 592 """Set verbose printing of system calls.
593 593
594 594 If called without an argument, act as a toggle"""
595 595
596 596 if parameter_s:
597 597 val = bool(eval(parameter_s))
598 598 else:
599 599 val = None
600 600
601 601 self.shell.rc_set_toggle('system_verbose',val)
602 602 print "System verbose printing is:",\
603 603 ['OFF','ON'][self.shell.rc.system_verbose]
604 604
605 605
606 606 def magic_page(self, parameter_s=''):
607 607 """Pretty print the object and display it through a pager.
608 608
609 609 %page [options] OBJECT
610 610
611 611 If no object is given, use _ (last output).
612 612
613 613 Options:
614 614
615 615 -r: page str(object), don't pretty-print it."""
616 616
617 617 # After a function contributed by Olivier Aubert, slightly modified.
618 618
619 619 # Process options/args
620 620 opts,args = self.parse_options(parameter_s,'r')
621 621 raw = 'r' in opts
622 622
623 623 oname = args and args or '_'
624 624 info = self._ofind(oname)
625 625 if info['found']:
626 626 txt = (raw and str or pformat)( info['obj'] )
627 627 page(txt)
628 628 else:
629 629 print 'Object `%s` not found' % oname
630 630
631 631 def magic_profile(self, parameter_s=''):
632 632 """Print your currently active IPyhton profile."""
633 633 if self.shell.rc.profile:
634 634 printpl('Current IPython profile: $self.shell.rc.profile.')
635 635 else:
636 636 print 'No profile active.'
637 637
638 638 def magic_pinfo(self, parameter_s='', namespaces=None):
639 639 """Provide detailed information about an object.
640 640
641 641 '%pinfo object' is just a synonym for object? or ?object."""
642 642
643 643 #print 'pinfo par: <%s>' % parameter_s # dbg
644 644
645 645
646 646 # detail_level: 0 -> obj? , 1 -> obj??
647 647 detail_level = 0
648 648 # We need to detect if we got called as 'pinfo pinfo foo', which can
649 649 # happen if the user types 'pinfo foo?' at the cmd line.
650 650 pinfo,qmark1,oname,qmark2 = \
651 651 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
652 652 if pinfo or qmark1 or qmark2:
653 653 detail_level = 1
654 654 if "*" in oname:
655 655 self.magic_psearch(oname)
656 656 else:
657 657 self._inspect('pinfo', oname, detail_level=detail_level,
658 658 namespaces=namespaces)
659 659
660 660 def magic_pdef(self, parameter_s='', namespaces=None):
661 661 """Print the definition header for any callable object.
662 662
663 663 If the object is a class, print the constructor information."""
664 664 self._inspect('pdef',parameter_s, namespaces)
665 665
666 666 def magic_pdoc(self, parameter_s='', namespaces=None):
667 667 """Print the docstring for an object.
668 668
669 669 If the given object is a class, it will print both the class and the
670 670 constructor docstrings."""
671 671 self._inspect('pdoc',parameter_s, namespaces)
672 672
673 673 def magic_psource(self, parameter_s='', namespaces=None):
674 674 """Print (or run through pager) the source code for an object."""
675 675 self._inspect('psource',parameter_s, namespaces)
676 676
677 677 def magic_pfile(self, parameter_s=''):
678 678 """Print (or run through pager) the file where an object is defined.
679 679
680 680 The file opens at the line where the object definition begins. IPython
681 681 will honor the environment variable PAGER if set, and otherwise will
682 682 do its best to print the file in a convenient form.
683 683
684 684 If the given argument is not an object currently defined, IPython will
685 685 try to interpret it as a filename (automatically adding a .py extension
686 686 if needed). You can thus use %pfile as a syntax highlighting code
687 687 viewer."""
688 688
689 689 # first interpret argument as an object name
690 690 out = self._inspect('pfile',parameter_s)
691 691 # if not, try the input as a filename
692 692 if out == 'not found':
693 693 try:
694 694 filename = get_py_filename(parameter_s)
695 695 except IOError,msg:
696 696 print msg
697 697 return
698 698 page(self.shell.inspector.format(file(filename).read()))
699 699
700 700 def _inspect(self,meth,oname,namespaces=None,**kw):
701 701 """Generic interface to the inspector system.
702 702
703 703 This function is meant to be called by pdef, pdoc & friends."""
704 704
705 705 #oname = oname.strip()
706 706 #print '1- oname: <%r>' % oname # dbg
707 707 try:
708 708 oname = oname.strip().encode('ascii')
709 709 #print '2- oname: <%r>' % oname # dbg
710 710 except UnicodeEncodeError:
711 711 print 'Python identifiers can only contain ascii characters.'
712 712 return 'not found'
713 713
714 714 info = Struct(self._ofind(oname, namespaces))
715 715
716 716 if info.found:
717 717 try:
718 718 IPython.generics.inspect_object(info.obj)
719 719 return
720 720 except IPython.ipapi.TryNext:
721 721 pass
722 722 # Get the docstring of the class property if it exists.
723 723 path = oname.split('.')
724 724 root = '.'.join(path[:-1])
725 725 if info.parent is not None:
726 726 try:
727 727 target = getattr(info.parent, '__class__')
728 728 # The object belongs to a class instance.
729 729 try:
730 730 target = getattr(target, path[-1])
731 731 # The class defines the object.
732 732 if isinstance(target, property):
733 733 oname = root + '.__class__.' + path[-1]
734 734 info = Struct(self._ofind(oname))
735 735 except AttributeError: pass
736 736 except AttributeError: pass
737 737
738 738 pmethod = getattr(self.shell.inspector,meth)
739 739 formatter = info.ismagic and self.format_screen or None
740 740 if meth == 'pdoc':
741 741 pmethod(info.obj,oname,formatter)
742 742 elif meth == 'pinfo':
743 743 pmethod(info.obj,oname,formatter,info,**kw)
744 744 else:
745 745 pmethod(info.obj,oname)
746 746 else:
747 747 print 'Object `%s` not found.' % oname
748 748 return 'not found' # so callers can take other action
749 749
750 750 def magic_psearch(self, parameter_s=''):
751 751 """Search for object in namespaces by wildcard.
752 752
753 753 %psearch [options] PATTERN [OBJECT TYPE]
754 754
755 755 Note: ? can be used as a synonym for %psearch, at the beginning or at
756 756 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
757 757 rest of the command line must be unchanged (options come first), so
758 758 for example the following forms are equivalent
759 759
760 760 %psearch -i a* function
761 761 -i a* function?
762 762 ?-i a* function
763 763
764 764 Arguments:
765 765
766 766 PATTERN
767 767
768 768 where PATTERN is a string containing * as a wildcard similar to its
769 769 use in a shell. The pattern is matched in all namespaces on the
770 770 search path. By default objects starting with a single _ are not
771 771 matched, many IPython generated objects have a single
772 772 underscore. The default is case insensitive matching. Matching is
773 773 also done on the attributes of objects and not only on the objects
774 774 in a module.
775 775
776 776 [OBJECT TYPE]
777 777
778 778 Is the name of a python type from the types module. The name is
779 779 given in lowercase without the ending type, ex. StringType is
780 780 written string. By adding a type here only objects matching the
781 781 given type are matched. Using all here makes the pattern match all
782 782 types (this is the default).
783 783
784 784 Options:
785 785
786 786 -a: makes the pattern match even objects whose names start with a
787 787 single underscore. These names are normally ommitted from the
788 788 search.
789 789
790 790 -i/-c: make the pattern case insensitive/sensitive. If neither of
791 791 these options is given, the default is read from your ipythonrc
792 792 file. The option name which sets this value is
793 793 'wildcards_case_sensitive'. If this option is not specified in your
794 794 ipythonrc file, IPython's internal default is to do a case sensitive
795 795 search.
796 796
797 797 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
798 798 specifiy can be searched in any of the following namespaces:
799 799 'builtin', 'user', 'user_global','internal', 'alias', where
800 800 'builtin' and 'user' are the search defaults. Note that you should
801 801 not use quotes when specifying namespaces.
802 802
803 803 'Builtin' contains the python module builtin, 'user' contains all
804 804 user data, 'alias' only contain the shell aliases and no python
805 805 objects, 'internal' contains objects used by IPython. The
806 806 'user_global' namespace is only used by embedded IPython instances,
807 807 and it contains module-level globals. You can add namespaces to the
808 808 search with -s or exclude them with -e (these options can be given
809 809 more than once).
810 810
811 811 Examples:
812 812
813 813 %psearch a* -> objects beginning with an a
814 814 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
815 815 %psearch a* function -> all functions beginning with an a
816 816 %psearch re.e* -> objects beginning with an e in module re
817 817 %psearch r*.e* -> objects that start with e in modules starting in r
818 818 %psearch r*.* string -> all strings in modules beginning with r
819 819
820 820 Case sensitve search:
821 821
822 822 %psearch -c a* list all object beginning with lower case a
823 823
824 824 Show objects beginning with a single _:
825 825
826 826 %psearch -a _* list objects beginning with a single underscore"""
827 827 try:
828 828 parameter_s = parameter_s.encode('ascii')
829 829 except UnicodeEncodeError:
830 830 print 'Python identifiers can only contain ascii characters.'
831 831 return
832 832
833 833 # default namespaces to be searched
834 834 def_search = ['user','builtin']
835 835
836 836 # Process options/args
837 837 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
838 838 opt = opts.get
839 839 shell = self.shell
840 840 psearch = shell.inspector.psearch
841 841
842 842 # select case options
843 843 if opts.has_key('i'):
844 844 ignore_case = True
845 845 elif opts.has_key('c'):
846 846 ignore_case = False
847 847 else:
848 848 ignore_case = not shell.rc.wildcards_case_sensitive
849 849
850 850 # Build list of namespaces to search from user options
851 851 def_search.extend(opt('s',[]))
852 852 ns_exclude = ns_exclude=opt('e',[])
853 853 ns_search = [nm for nm in def_search if nm not in ns_exclude]
854 854
855 855 # Call the actual search
856 856 try:
857 857 psearch(args,shell.ns_table,ns_search,
858 858 show_all=opt('a'),ignore_case=ignore_case)
859 859 except:
860 860 shell.showtraceback()
861 861
862 862 def magic_who_ls(self, parameter_s=''):
863 863 """Return a sorted list of all interactive variables.
864 864
865 865 If arguments are given, only variables of types matching these
866 866 arguments are returned."""
867 867
868 868 user_ns = self.shell.user_ns
869 869 internal_ns = self.shell.internal_ns
870 870 user_config_ns = self.shell.user_config_ns
871 871 out = []
872 872 typelist = parameter_s.split()
873 873
874 874 for i in user_ns:
875 875 if not (i.startswith('_') or i.startswith('_i')) \
876 876 and not (i in internal_ns or i in user_config_ns):
877 877 if typelist:
878 878 if type(user_ns[i]).__name__ in typelist:
879 879 out.append(i)
880 880 else:
881 881 out.append(i)
882 882 out.sort()
883 883 return out
884 884
885 885 def magic_who(self, parameter_s=''):
886 886 """Print all interactive variables, with some minimal formatting.
887 887
888 888 If any arguments are given, only variables whose type matches one of
889 889 these are printed. For example:
890 890
891 891 %who function str
892 892
893 893 will only list functions and strings, excluding all other types of
894 894 variables. To find the proper type names, simply use type(var) at a
895 895 command line to see how python prints type names. For example:
896 896
897 897 In [1]: type('hello')\\
898 898 Out[1]: <type 'str'>
899 899
900 900 indicates that the type name for strings is 'str'.
901 901
902 902 %who always excludes executed names loaded through your configuration
903 903 file and things which are internal to IPython.
904 904
905 905 This is deliberate, as typically you may load many modules and the
906 906 purpose of %who is to show you only what you've manually defined."""
907 907
908 908 varlist = self.magic_who_ls(parameter_s)
909 909 if not varlist:
910 910 if parameter_s:
911 911 print 'No variables match your requested type.'
912 912 else:
913 913 print 'Interactive namespace is empty.'
914 914 return
915 915
916 916 # if we have variables, move on...
917 917 count = 0
918 918 for i in varlist:
919 919 print i+'\t',
920 920 count += 1
921 921 if count > 8:
922 922 count = 0
923 923 print
924 924 print
925 925
926 926 def magic_whos(self, parameter_s=''):
927 927 """Like %who, but gives some extra information about each variable.
928 928
929 929 The same type filtering of %who can be applied here.
930 930
931 931 For all variables, the type is printed. Additionally it prints:
932 932
933 933 - For {},[],(): their length.
934 934
935 935 - For numpy and Numeric arrays, a summary with shape, number of
936 936 elements, typecode and size in memory.
937 937
938 938 - Everything else: a string representation, snipping their middle if
939 939 too long."""
940 940
941 941 varnames = self.magic_who_ls(parameter_s)
942 942 if not varnames:
943 943 if parameter_s:
944 944 print 'No variables match your requested type.'
945 945 else:
946 946 print 'Interactive namespace is empty.'
947 947 return
948 948
949 949 # if we have variables, move on...
950 950
951 951 # for these types, show len() instead of data:
952 952 seq_types = [types.DictType,types.ListType,types.TupleType]
953 953
954 954 # for numpy/Numeric arrays, display summary info
955 955 try:
956 956 import numpy
957 957 except ImportError:
958 958 ndarray_type = None
959 959 else:
960 960 ndarray_type = numpy.ndarray.__name__
961 961 try:
962 962 import Numeric
963 963 except ImportError:
964 964 array_type = None
965 965 else:
966 966 array_type = Numeric.ArrayType.__name__
967 967
968 968 # Find all variable names and types so we can figure out column sizes
969 969 def get_vars(i):
970 970 return self.shell.user_ns[i]
971 971
972 972 # some types are well known and can be shorter
973 973 abbrevs = {'IPython.macro.Macro' : 'Macro'}
974 974 def type_name(v):
975 975 tn = type(v).__name__
976 976 return abbrevs.get(tn,tn)
977 977
978 978 varlist = map(get_vars,varnames)
979 979
980 980 typelist = []
981 981 for vv in varlist:
982 982 tt = type_name(vv)
983 983
984 984 if tt=='instance':
985 985 typelist.append( abbrevs.get(str(vv.__class__),
986 986 str(vv.__class__)))
987 987 else:
988 988 typelist.append(tt)
989 989
990 990 # column labels and # of spaces as separator
991 991 varlabel = 'Variable'
992 992 typelabel = 'Type'
993 993 datalabel = 'Data/Info'
994 994 colsep = 3
995 995 # variable format strings
996 996 vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)"
997 997 vfmt_short = '$vstr[:25]<...>$vstr[-25:]'
998 998 aformat = "%s: %s elems, type `%s`, %s bytes"
999 999 # find the size of the columns to format the output nicely
1000 1000 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
1001 1001 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
1002 1002 # table header
1003 1003 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
1004 1004 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
1005 1005 # and the table itself
1006 1006 kb = 1024
1007 1007 Mb = 1048576 # kb**2
1008 1008 for vname,var,vtype in zip(varnames,varlist,typelist):
1009 1009 print itpl(vformat),
1010 1010 if vtype in seq_types:
1011 1011 print len(var)
1012 1012 elif vtype in [array_type,ndarray_type]:
1013 1013 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
1014 1014 if vtype==ndarray_type:
1015 1015 # numpy
1016 1016 vsize = var.size
1017 1017 vbytes = vsize*var.itemsize
1018 1018 vdtype = var.dtype
1019 1019 else:
1020 1020 # Numeric
1021 1021 vsize = Numeric.size(var)
1022 1022 vbytes = vsize*var.itemsize()
1023 1023 vdtype = var.typecode()
1024 1024
1025 1025 if vbytes < 100000:
1026 1026 print aformat % (vshape,vsize,vdtype,vbytes)
1027 1027 else:
1028 1028 print aformat % (vshape,vsize,vdtype,vbytes),
1029 1029 if vbytes < Mb:
1030 1030 print '(%s kb)' % (vbytes/kb,)
1031 1031 else:
1032 1032 print '(%s Mb)' % (vbytes/Mb,)
1033 1033 else:
1034 1034 try:
1035 1035 vstr = str(var)
1036 1036 except UnicodeEncodeError:
1037 1037 vstr = unicode(var).encode(sys.getdefaultencoding(),
1038 1038 'backslashreplace')
1039 1039 vstr = vstr.replace('\n','\\n')
1040 1040 if len(vstr) < 50:
1041 1041 print vstr
1042 1042 else:
1043 1043 printpl(vfmt_short)
1044 1044
1045 1045 def magic_reset(self, parameter_s=''):
1046 1046 """Resets the namespace by removing all names defined by the user.
1047 1047
1048 1048 Input/Output history are left around in case you need them."""
1049 1049
1050 1050 ans = self.shell.ask_yes_no(
1051 1051 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1052 1052 if not ans:
1053 1053 print 'Nothing done.'
1054 1054 return
1055 1055 user_ns = self.shell.user_ns
1056 1056 for i in self.magic_who_ls():
1057 1057 del(user_ns[i])
1058 1058
1059 1059 # Also flush the private list of module references kept for script
1060 1060 # execution protection
1061 1061 self.shell._user_main_modules[:] = []
1062 1062
1063 1063 def magic_logstart(self,parameter_s=''):
1064 1064 """Start logging anywhere in a session.
1065 1065
1066 1066 %logstart [-o|-r|-t] [log_name [log_mode]]
1067 1067
1068 1068 If no name is given, it defaults to a file named 'ipython_log.py' in your
1069 1069 current directory, in 'rotate' mode (see below).
1070 1070
1071 1071 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1072 1072 history up to that point and then continues logging.
1073 1073
1074 1074 %logstart takes a second optional parameter: logging mode. This can be one
1075 1075 of (note that the modes are given unquoted):\\
1076 1076 append: well, that says it.\\
1077 1077 backup: rename (if exists) to name~ and start name.\\
1078 1078 global: single logfile in your home dir, appended to.\\
1079 1079 over : overwrite existing log.\\
1080 1080 rotate: create rotating logs name.1~, name.2~, etc.
1081 1081
1082 1082 Options:
1083 1083
1084 1084 -o: log also IPython's output. In this mode, all commands which
1085 1085 generate an Out[NN] prompt are recorded to the logfile, right after
1086 1086 their corresponding input line. The output lines are always
1087 1087 prepended with a '#[Out]# ' marker, so that the log remains valid
1088 1088 Python code.
1089 1089
1090 1090 Since this marker is always the same, filtering only the output from
1091 1091 a log is very easy, using for example a simple awk call:
1092 1092
1093 1093 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1094 1094
1095 1095 -r: log 'raw' input. Normally, IPython's logs contain the processed
1096 1096 input, so that user lines are logged in their final form, converted
1097 1097 into valid Python. For example, %Exit is logged as
1098 1098 '_ip.magic("Exit"). If the -r flag is given, all input is logged
1099 1099 exactly as typed, with no transformations applied.
1100 1100
1101 1101 -t: put timestamps before each input line logged (these are put in
1102 1102 comments)."""
1103 1103
1104 1104 opts,par = self.parse_options(parameter_s,'ort')
1105 1105 log_output = 'o' in opts
1106 1106 log_raw_input = 'r' in opts
1107 1107 timestamp = 't' in opts
1108 1108
1109 1109 rc = self.shell.rc
1110 1110 logger = self.shell.logger
1111 1111
1112 1112 # if no args are given, the defaults set in the logger constructor by
1113 1113 # ipytohn remain valid
1114 1114 if par:
1115 1115 try:
1116 1116 logfname,logmode = par.split()
1117 1117 except:
1118 1118 logfname = par
1119 1119 logmode = 'backup'
1120 1120 else:
1121 1121 logfname = logger.logfname
1122 1122 logmode = logger.logmode
1123 1123 # put logfname into rc struct as if it had been called on the command
1124 1124 # line, so it ends up saved in the log header Save it in case we need
1125 1125 # to restore it...
1126 1126 old_logfile = rc.opts.get('logfile','')
1127 1127 if logfname:
1128 1128 logfname = os.path.expanduser(logfname)
1129 1129 rc.opts.logfile = logfname
1130 1130 loghead = self.shell.loghead_tpl % (rc.opts,rc.args)
1131 1131 try:
1132 1132 started = logger.logstart(logfname,loghead,logmode,
1133 1133 log_output,timestamp,log_raw_input)
1134 1134 except:
1135 1135 rc.opts.logfile = old_logfile
1136 1136 warn("Couldn't start log: %s" % sys.exc_info()[1])
1137 1137 else:
1138 1138 # log input history up to this point, optionally interleaving
1139 1139 # output if requested
1140 1140
1141 1141 if timestamp:
1142 1142 # disable timestamping for the previous history, since we've
1143 1143 # lost those already (no time machine here).
1144 1144 logger.timestamp = False
1145 1145
1146 1146 if log_raw_input:
1147 1147 input_hist = self.shell.input_hist_raw
1148 1148 else:
1149 1149 input_hist = self.shell.input_hist
1150 1150
1151 1151 if log_output:
1152 1152 log_write = logger.log_write
1153 1153 output_hist = self.shell.output_hist
1154 1154 for n in range(1,len(input_hist)-1):
1155 1155 log_write(input_hist[n].rstrip())
1156 1156 if n in output_hist:
1157 1157 log_write(repr(output_hist[n]),'output')
1158 1158 else:
1159 1159 logger.log_write(input_hist[1:])
1160 1160 if timestamp:
1161 1161 # re-enable timestamping
1162 1162 logger.timestamp = True
1163 1163
1164 1164 print ('Activating auto-logging. '
1165 1165 'Current session state plus future input saved.')
1166 1166 logger.logstate()
1167 1167
1168 1168 def magic_logstop(self,parameter_s=''):
1169 1169 """Fully stop logging and close log file.
1170 1170
1171 1171 In order to start logging again, a new %logstart call needs to be made,
1172 1172 possibly (though not necessarily) with a new filename, mode and other
1173 1173 options."""
1174 1174 self.logger.logstop()
1175 1175
1176 1176 def magic_logoff(self,parameter_s=''):
1177 1177 """Temporarily stop logging.
1178 1178
1179 1179 You must have previously started logging."""
1180 1180 self.shell.logger.switch_log(0)
1181 1181
1182 1182 def magic_logon(self,parameter_s=''):
1183 1183 """Restart logging.
1184 1184
1185 1185 This function is for restarting logging which you've temporarily
1186 1186 stopped with %logoff. For starting logging for the first time, you
1187 1187 must use the %logstart function, which allows you to specify an
1188 1188 optional log filename."""
1189 1189
1190 1190 self.shell.logger.switch_log(1)
1191 1191
1192 1192 def magic_logstate(self,parameter_s=''):
1193 1193 """Print the status of the logging system."""
1194 1194
1195 1195 self.shell.logger.logstate()
1196 1196
1197 1197 def magic_pdb(self, parameter_s=''):
1198 1198 """Control the automatic calling of the pdb interactive debugger.
1199 1199
1200 1200 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1201 1201 argument it works as a toggle.
1202 1202
1203 1203 When an exception is triggered, IPython can optionally call the
1204 1204 interactive pdb debugger after the traceback printout. %pdb toggles
1205 1205 this feature on and off.
1206 1206
1207 1207 The initial state of this feature is set in your ipythonrc
1208 1208 configuration file (the variable is called 'pdb').
1209 1209
1210 1210 If you want to just activate the debugger AFTER an exception has fired,
1211 1211 without having to type '%pdb on' and rerunning your code, you can use
1212 1212 the %debug magic."""
1213 1213
1214 1214 par = parameter_s.strip().lower()
1215 1215
1216 1216 if par:
1217 1217 try:
1218 1218 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1219 1219 except KeyError:
1220 1220 print ('Incorrect argument. Use on/1, off/0, '
1221 1221 'or nothing for a toggle.')
1222 1222 return
1223 1223 else:
1224 1224 # toggle
1225 1225 new_pdb = not self.shell.call_pdb
1226 1226
1227 1227 # set on the shell
1228 1228 self.shell.call_pdb = new_pdb
1229 1229 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1230 1230
1231 1231 def magic_debug(self, parameter_s=''):
1232 1232 """Activate the interactive debugger in post-mortem mode.
1233 1233
1234 1234 If an exception has just occurred, this lets you inspect its stack
1235 1235 frames interactively. Note that this will always work only on the last
1236 1236 traceback that occurred, so you must call this quickly after an
1237 1237 exception that you wish to inspect has fired, because if another one
1238 1238 occurs, it clobbers the previous one.
1239 1239
1240 1240 If you want IPython to automatically do this on every exception, see
1241 1241 the %pdb magic for more details.
1242 1242 """
1243 1243
1244 1244 self.shell.debugger(force=True)
1245 1245
1246 1246 def magic_prun(self, parameter_s ='',user_mode=1,
1247 1247 opts=None,arg_lst=None,prog_ns=None):
1248 1248
1249 1249 """Run a statement through the python code profiler.
1250 1250
1251 1251 Usage:\\
1252 1252 %prun [options] statement
1253 1253
1254 1254 The given statement (which doesn't require quote marks) is run via the
1255 1255 python profiler in a manner similar to the profile.run() function.
1256 1256 Namespaces are internally managed to work correctly; profile.run
1257 1257 cannot be used in IPython because it makes certain assumptions about
1258 1258 namespaces which do not hold under IPython.
1259 1259
1260 1260 Options:
1261 1261
1262 1262 -l <limit>: you can place restrictions on what or how much of the
1263 1263 profile gets printed. The limit value can be:
1264 1264
1265 1265 * A string: only information for function names containing this string
1266 1266 is printed.
1267 1267
1268 1268 * An integer: only these many lines are printed.
1269 1269
1270 1270 * A float (between 0 and 1): this fraction of the report is printed
1271 1271 (for example, use a limit of 0.4 to see the topmost 40% only).
1272 1272
1273 1273 You can combine several limits with repeated use of the option. For
1274 1274 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1275 1275 information about class constructors.
1276 1276
1277 1277 -r: return the pstats.Stats object generated by the profiling. This
1278 1278 object has all the information about the profile in it, and you can
1279 1279 later use it for further analysis or in other functions.
1280 1280
1281 1281 -s <key>: sort profile by given key. You can provide more than one key
1282 1282 by using the option several times: '-s key1 -s key2 -s key3...'. The
1283 1283 default sorting key is 'time'.
1284 1284
1285 1285 The following is copied verbatim from the profile documentation
1286 1286 referenced below:
1287 1287
1288 1288 When more than one key is provided, additional keys are used as
1289 1289 secondary criteria when the there is equality in all keys selected
1290 1290 before them.
1291 1291
1292 1292 Abbreviations can be used for any key names, as long as the
1293 1293 abbreviation is unambiguous. The following are the keys currently
1294 1294 defined:
1295 1295
1296 1296 Valid Arg Meaning\\
1297 1297 "calls" call count\\
1298 1298 "cumulative" cumulative time\\
1299 1299 "file" file name\\
1300 1300 "module" file name\\
1301 1301 "pcalls" primitive call count\\
1302 1302 "line" line number\\
1303 1303 "name" function name\\
1304 1304 "nfl" name/file/line\\
1305 1305 "stdname" standard name\\
1306 1306 "time" internal time
1307 1307
1308 1308 Note that all sorts on statistics are in descending order (placing
1309 1309 most time consuming items first), where as name, file, and line number
1310 1310 searches are in ascending order (i.e., alphabetical). The subtle
1311 1311 distinction between "nfl" and "stdname" is that the standard name is a
1312 1312 sort of the name as printed, which means that the embedded line
1313 1313 numbers get compared in an odd way. For example, lines 3, 20, and 40
1314 1314 would (if the file names were the same) appear in the string order
1315 1315 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1316 1316 line numbers. In fact, sort_stats("nfl") is the same as
1317 1317 sort_stats("name", "file", "line").
1318 1318
1319 1319 -T <filename>: save profile results as shown on screen to a text
1320 1320 file. The profile is still shown on screen.
1321 1321
1322 1322 -D <filename>: save (via dump_stats) profile statistics to given
1323 1323 filename. This data is in a format understod by the pstats module, and
1324 1324 is generated by a call to the dump_stats() method of profile
1325 1325 objects. The profile is still shown on screen.
1326 1326
1327 1327 If you want to run complete programs under the profiler's control, use
1328 1328 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1329 1329 contains profiler specific options as described here.
1330 1330
1331 1331 You can read the complete documentation for the profile module with:\\
1332 1332 In [1]: import profile; profile.help() """
1333 1333
1334 1334 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1335 1335 # protect user quote marks
1336 1336 parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
1337 1337
1338 1338 if user_mode: # regular user call
1339 1339 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
1340 1340 list_all=1)
1341 1341 namespace = self.shell.user_ns
1342 1342 else: # called to run a program by %run -p
1343 1343 try:
1344 1344 filename = get_py_filename(arg_lst[0])
1345 1345 except IOError,msg:
1346 1346 error(msg)
1347 1347 return
1348 1348
1349 1349 arg_str = 'execfile(filename,prog_ns)'
1350 1350 namespace = locals()
1351 1351
1352 1352 opts.merge(opts_def)
1353 1353
1354 1354 prof = profile.Profile()
1355 1355 try:
1356 1356 prof = prof.runctx(arg_str,namespace,namespace)
1357 1357 sys_exit = ''
1358 1358 except SystemExit:
1359 1359 sys_exit = """*** SystemExit exception caught in code being profiled."""
1360 1360
1361 1361 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1362 1362
1363 1363 lims = opts.l
1364 1364 if lims:
1365 1365 lims = [] # rebuild lims with ints/floats/strings
1366 1366 for lim in opts.l:
1367 1367 try:
1368 1368 lims.append(int(lim))
1369 1369 except ValueError:
1370 1370 try:
1371 1371 lims.append(float(lim))
1372 1372 except ValueError:
1373 1373 lims.append(lim)
1374 1374
1375 1375 # Trap output.
1376 1376 stdout_trap = StringIO()
1377 1377
1378 1378 if hasattr(stats,'stream'):
1379 1379 # In newer versions of python, the stats object has a 'stream'
1380 1380 # attribute to write into.
1381 1381 stats.stream = stdout_trap
1382 1382 stats.print_stats(*lims)
1383 1383 else:
1384 1384 # For older versions, we manually redirect stdout during printing
1385 1385 sys_stdout = sys.stdout
1386 1386 try:
1387 1387 sys.stdout = stdout_trap
1388 1388 stats.print_stats(*lims)
1389 1389 finally:
1390 1390 sys.stdout = sys_stdout
1391 1391
1392 1392 output = stdout_trap.getvalue()
1393 1393 output = output.rstrip()
1394 1394
1395 1395 page(output,screen_lines=self.shell.rc.screen_length)
1396 1396 print sys_exit,
1397 1397
1398 1398 dump_file = opts.D[0]
1399 1399 text_file = opts.T[0]
1400 1400 if dump_file:
1401 1401 prof.dump_stats(dump_file)
1402 1402 print '\n*** Profile stats marshalled to file',\
1403 1403 `dump_file`+'.',sys_exit
1404 1404 if text_file:
1405 1405 pfile = file(text_file,'w')
1406 1406 pfile.write(output)
1407 1407 pfile.close()
1408 1408 print '\n*** Profile printout saved to text file',\
1409 1409 `text_file`+'.',sys_exit
1410 1410
1411 1411 if opts.has_key('r'):
1412 1412 return stats
1413 1413 else:
1414 1414 return None
1415 1415
1416 1416 def magic_run(self, parameter_s ='',runner=None):
1417 1417 """Run the named file inside IPython as a program.
1418 1418
1419 1419 Usage:\\
1420 1420 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1421 1421
1422 1422 Parameters after the filename are passed as command-line arguments to
1423 1423 the program (put in sys.argv). Then, control returns to IPython's
1424 1424 prompt.
1425 1425
1426 1426 This is similar to running at a system prompt:\\
1427 1427 $ python file args\\
1428 1428 but with the advantage of giving you IPython's tracebacks, and of
1429 1429 loading all variables into your interactive namespace for further use
1430 1430 (unless -p is used, see below).
1431 1431
1432 1432 The file is executed in a namespace initially consisting only of
1433 1433 __name__=='__main__' and sys.argv constructed as indicated. It thus
1434 1434 sees its environment as if it were being run as a stand-alone program
1435 1435 (except for sharing global objects such as previously imported
1436 1436 modules). But after execution, the IPython interactive namespace gets
1437 1437 updated with all variables defined in the program (except for __name__
1438 1438 and sys.argv). This allows for very convenient loading of code for
1439 1439 interactive work, while giving each program a 'clean sheet' to run in.
1440 1440
1441 1441 Options:
1442 1442
1443 1443 -n: __name__ is NOT set to '__main__', but to the running file's name
1444 1444 without extension (as python does under import). This allows running
1445 1445 scripts and reloading the definitions in them without calling code
1446 1446 protected by an ' if __name__ == "__main__" ' clause.
1447 1447
1448 1448 -i: run the file in IPython's namespace instead of an empty one. This
1449 1449 is useful if you are experimenting with code written in a text editor
1450 1450 which depends on variables defined interactively.
1451 1451
1452 1452 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1453 1453 being run. This is particularly useful if IPython is being used to
1454 1454 run unittests, which always exit with a sys.exit() call. In such
1455 1455 cases you are interested in the output of the test results, not in
1456 1456 seeing a traceback of the unittest module.
1457 1457
1458 1458 -t: print timing information at the end of the run. IPython will give
1459 1459 you an estimated CPU time consumption for your script, which under
1460 1460 Unix uses the resource module to avoid the wraparound problems of
1461 1461 time.clock(). Under Unix, an estimate of time spent on system tasks
1462 1462 is also given (for Windows platforms this is reported as 0.0).
1463 1463
1464 1464 If -t is given, an additional -N<N> option can be given, where <N>
1465 1465 must be an integer indicating how many times you want the script to
1466 1466 run. The final timing report will include total and per run results.
1467 1467
1468 1468 For example (testing the script uniq_stable.py):
1469 1469
1470 1470 In [1]: run -t uniq_stable
1471 1471
1472 1472 IPython CPU timings (estimated):\\
1473 1473 User : 0.19597 s.\\
1474 1474 System: 0.0 s.\\
1475 1475
1476 1476 In [2]: run -t -N5 uniq_stable
1477 1477
1478 1478 IPython CPU timings (estimated):\\
1479 1479 Total runs performed: 5\\
1480 1480 Times : Total Per run\\
1481 1481 User : 0.910862 s, 0.1821724 s.\\
1482 1482 System: 0.0 s, 0.0 s.
1483 1483
1484 1484 -d: run your program under the control of pdb, the Python debugger.
1485 1485 This allows you to execute your program step by step, watch variables,
1486 1486 etc. Internally, what IPython does is similar to calling:
1487 1487
1488 1488 pdb.run('execfile("YOURFILENAME")')
1489 1489
1490 1490 with a breakpoint set on line 1 of your file. You can change the line
1491 1491 number for this automatic breakpoint to be <N> by using the -bN option
1492 1492 (where N must be an integer). For example:
1493 1493
1494 1494 %run -d -b40 myscript
1495 1495
1496 1496 will set the first breakpoint at line 40 in myscript.py. Note that
1497 1497 the first breakpoint must be set on a line which actually does
1498 1498 something (not a comment or docstring) for it to stop execution.
1499 1499
1500 1500 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1501 1501 first enter 'c' (without qoutes) to start execution up to the first
1502 1502 breakpoint.
1503 1503
1504 1504 Entering 'help' gives information about the use of the debugger. You
1505 1505 can easily see pdb's full documentation with "import pdb;pdb.help()"
1506 1506 at a prompt.
1507 1507
1508 1508 -p: run program under the control of the Python profiler module (which
1509 1509 prints a detailed report of execution times, function calls, etc).
1510 1510
1511 1511 You can pass other options after -p which affect the behavior of the
1512 1512 profiler itself. See the docs for %prun for details.
1513 1513
1514 1514 In this mode, the program's variables do NOT propagate back to the
1515 1515 IPython interactive namespace (because they remain in the namespace
1516 1516 where the profiler executes them).
1517 1517
1518 1518 Internally this triggers a call to %prun, see its documentation for
1519 1519 details on the options available specifically for profiling.
1520 1520
1521 1521 There is one special usage for which the text above doesn't apply:
1522 1522 if the filename ends with .ipy, the file is run as ipython script,
1523 1523 just as if the commands were written on IPython prompt.
1524 1524 """
1525 1525
1526 1526 # get arguments and set sys.argv for program to be run.
1527 1527 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1528 1528 mode='list',list_all=1)
1529 1529
1530 1530 try:
1531 1531 filename = get_py_filename(arg_lst[0])
1532 1532 except IndexError:
1533 1533 warn('you must provide at least a filename.')
1534 1534 print '\n%run:\n',OInspect.getdoc(self.magic_run)
1535 1535 return
1536 1536 except IOError,msg:
1537 1537 error(msg)
1538 1538 return
1539 1539
1540 1540 if filename.lower().endswith('.ipy'):
1541 1541 self.api.runlines(open(filename).read())
1542 1542 return
1543 1543
1544 1544 # Control the response to exit() calls made by the script being run
1545 1545 exit_ignore = opts.has_key('e')
1546 1546
1547 1547 # Make sure that the running script gets a proper sys.argv as if it
1548 1548 # were run from a system shell.
1549 1549 save_argv = sys.argv # save it for later restoring
1550 1550 sys.argv = [filename]+ arg_lst[1:] # put in the proper filename
1551 1551
1552 1552 if opts.has_key('i'):
1553 1553 # Run in user's interactive namespace
1554 1554 prog_ns = self.shell.user_ns
1555 1555 __name__save = self.shell.user_ns['__name__']
1556 1556 prog_ns['__name__'] = '__main__'
1557 1557 main_mod = FakeModule(prog_ns)
1558 1558 else:
1559 1559 # Run in a fresh, empty namespace
1560 1560 if opts.has_key('n'):
1561 1561 name = os.path.splitext(os.path.basename(filename))[0]
1562 1562 else:
1563 1563 name = '__main__'
1564 1564 main_mod = FakeModule()
1565 1565 prog_ns = main_mod.__dict__
1566 1566 prog_ns['__name__'] = name
1567 1567 # The shell MUST hold a reference to main_mod so after %run exits,
1568 1568 # the python deletion mechanism doesn't zero it out (leaving
1569 1569 # dangling references)
1570 1570 self.shell._user_main_modules.append(main_mod)
1571 1571
1572 1572 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1573 1573 # set the __file__ global in the script's namespace
1574 1574 prog_ns['__file__'] = filename
1575 1575
1576 1576 # pickle fix. See iplib for an explanation. But we need to make sure
1577 1577 # that, if we overwrite __main__, we replace it at the end
1578 1578 if prog_ns['__name__'] == '__main__':
1579 1579 restore_main = sys.modules['__main__']
1580 1580 else:
1581 1581 restore_main = False
1582 1582
1583 1583 sys.modules[prog_ns['__name__']] = main_mod
1584 1584
1585 1585 stats = None
1586 1586 try:
1587 1587 self.shell.savehist()
1588 1588
1589 1589 if opts.has_key('p'):
1590 1590 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1591 1591 else:
1592 1592 if opts.has_key('d'):
1593 1593 deb = Debugger.Pdb(self.shell.rc.colors)
1594 1594 # reset Breakpoint state, which is moronically kept
1595 1595 # in a class
1596 1596 bdb.Breakpoint.next = 1
1597 1597 bdb.Breakpoint.bplist = {}
1598 1598 bdb.Breakpoint.bpbynumber = [None]
1599 1599 # Set an initial breakpoint to stop execution
1600 1600 maxtries = 10
1601 1601 bp = int(opts.get('b',[1])[0])
1602 1602 checkline = deb.checkline(filename,bp)
1603 1603 if not checkline:
1604 1604 for bp in range(bp+1,bp+maxtries+1):
1605 1605 if deb.checkline(filename,bp):
1606 1606 break
1607 1607 else:
1608 1608 msg = ("\nI failed to find a valid line to set "
1609 1609 "a breakpoint\n"
1610 1610 "after trying up to line: %s.\n"
1611 1611 "Please set a valid breakpoint manually "
1612 1612 "with the -b option." % bp)
1613 1613 error(msg)
1614 1614 return
1615 1615 # if we find a good linenumber, set the breakpoint
1616 1616 deb.do_break('%s:%s' % (filename,bp))
1617 1617 # Start file run
1618 1618 print "NOTE: Enter 'c' at the",
1619 1619 print "%s prompt to start your script." % deb.prompt
1620 1620 try:
1621 1621 deb.run('execfile("%s")' % filename,prog_ns)
1622 1622
1623 1623 except:
1624 1624 etype, value, tb = sys.exc_info()
1625 1625 # Skip three frames in the traceback: the %run one,
1626 1626 # one inside bdb.py, and the command-line typed by the
1627 1627 # user (run by exec in pdb itself).
1628 1628 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1629 1629 else:
1630 1630 if runner is None:
1631 1631 runner = self.shell.safe_execfile
1632 1632 if opts.has_key('t'):
1633 1633 # timed execution
1634 1634 try:
1635 1635 nruns = int(opts['N'][0])
1636 1636 if nruns < 1:
1637 1637 error('Number of runs must be >=1')
1638 1638 return
1639 1639 except (KeyError):
1640 1640 nruns = 1
1641 1641 if nruns == 1:
1642 1642 t0 = clock2()
1643 1643 runner(filename,prog_ns,prog_ns,
1644 1644 exit_ignore=exit_ignore)
1645 1645 t1 = clock2()
1646 1646 t_usr = t1[0]-t0[0]
1647 1647 t_sys = t1[1]-t1[1]
1648 1648 print "\nIPython CPU timings (estimated):"
1649 1649 print " User : %10s s." % t_usr
1650 1650 print " System: %10s s." % t_sys
1651 1651 else:
1652 1652 runs = range(nruns)
1653 1653 t0 = clock2()
1654 1654 for nr in runs:
1655 1655 runner(filename,prog_ns,prog_ns,
1656 1656 exit_ignore=exit_ignore)
1657 1657 t1 = clock2()
1658 1658 t_usr = t1[0]-t0[0]
1659 1659 t_sys = t1[1]-t1[1]
1660 1660 print "\nIPython CPU timings (estimated):"
1661 1661 print "Total runs performed:",nruns
1662 1662 print " Times : %10s %10s" % ('Total','Per run')
1663 1663 print " User : %10s s, %10s s." % (t_usr,t_usr/nruns)
1664 1664 print " System: %10s s, %10s s." % (t_sys,t_sys/nruns)
1665 1665
1666 1666 else:
1667 1667 # regular execution
1668 1668 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1669 1669 if opts.has_key('i'):
1670 1670 self.shell.user_ns['__name__'] = __name__save
1671 1671 else:
1672 1672 # update IPython interactive namespace
1673 1673 del prog_ns['__name__']
1674 1674 self.shell.user_ns.update(prog_ns)
1675 1675 finally:
1676 1676 sys.argv = save_argv
1677 1677 if restore_main:
1678 1678 sys.modules['__main__'] = restore_main
1679 1679 self.shell.reloadhist()
1680 1680
1681 1681 return stats
1682 1682
1683 1683 def magic_runlog(self, parameter_s =''):
1684 1684 """Run files as logs.
1685 1685
1686 1686 Usage:\\
1687 1687 %runlog file1 file2 ...
1688 1688
1689 1689 Run the named files (treating them as log files) in sequence inside
1690 1690 the interpreter, and return to the prompt. This is much slower than
1691 1691 %run because each line is executed in a try/except block, but it
1692 1692 allows running files with syntax errors in them.
1693 1693
1694 1694 Normally IPython will guess when a file is one of its own logfiles, so
1695 1695 you can typically use %run even for logs. This shorthand allows you to
1696 1696 force any file to be treated as a log file."""
1697 1697
1698 1698 for f in parameter_s.split():
1699 1699 self.shell.safe_execfile(f,self.shell.user_ns,
1700 1700 self.shell.user_ns,islog=1)
1701 1701
1702 1702 def magic_timeit(self, parameter_s =''):
1703 1703 """Time execution of a Python statement or expression
1704 1704
1705 1705 Usage:\\
1706 1706 %timeit [-n<N> -r<R> [-t|-c]] statement
1707 1707
1708 1708 Time execution of a Python statement or expression using the timeit
1709 1709 module.
1710 1710
1711 1711 Options:
1712 1712 -n<N>: execute the given statement <N> times in a loop. If this value
1713 1713 is not given, a fitting value is chosen.
1714 1714
1715 1715 -r<R>: repeat the loop iteration <R> times and take the best result.
1716 1716 Default: 3
1717 1717
1718 1718 -t: use time.time to measure the time, which is the default on Unix.
1719 1719 This function measures wall time.
1720 1720
1721 1721 -c: use time.clock to measure the time, which is the default on
1722 1722 Windows and measures wall time. On Unix, resource.getrusage is used
1723 1723 instead and returns the CPU user time.
1724 1724
1725 1725 -p<P>: use a precision of <P> digits to display the timing result.
1726 1726 Default: 3
1727 1727
1728 1728
1729 1729 Examples:\\
1730 1730 In [1]: %timeit pass
1731 1731 10000000 loops, best of 3: 53.3 ns per loop
1732 1732
1733 1733 In [2]: u = None
1734 1734
1735 1735 In [3]: %timeit u is None
1736 1736 10000000 loops, best of 3: 184 ns per loop
1737 1737
1738 1738 In [4]: %timeit -r 4 u == None
1739 1739 1000000 loops, best of 4: 242 ns per loop
1740 1740
1741 1741 In [5]: import time
1742 1742
1743 1743 In [6]: %timeit -n1 time.sleep(2)
1744 1744 1 loops, best of 3: 2 s per loop
1745 1745
1746 1746
1747 1747 The times reported by %timeit will be slightly higher than those
1748 1748 reported by the timeit.py script when variables are accessed. This is
1749 1749 due to the fact that %timeit executes the statement in the namespace
1750 1750 of the shell, compared with timeit.py, which uses a single setup
1751 1751 statement to import function or create variables. Generally, the bias
1752 1752 does not matter as long as results from timeit.py are not mixed with
1753 1753 those from %timeit."""
1754 1754
1755 1755 import timeit
1756 1756 import math
1757 1757
1758 1758 units = ["s", "ms", "\xc2\xb5s", "ns"]
1759 1759 scaling = [1, 1e3, 1e6, 1e9]
1760 1760
1761 1761 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1762 1762 posix=False)
1763 1763 if stmt == "":
1764 1764 return
1765 1765 timefunc = timeit.default_timer
1766 1766 number = int(getattr(opts, "n", 0))
1767 1767 repeat = int(getattr(opts, "r", timeit.default_repeat))
1768 1768 precision = int(getattr(opts, "p", 3))
1769 1769 if hasattr(opts, "t"):
1770 1770 timefunc = time.time
1771 1771 if hasattr(opts, "c"):
1772 1772 timefunc = clock
1773 1773
1774 1774 timer = timeit.Timer(timer=timefunc)
1775 1775 # this code has tight coupling to the inner workings of timeit.Timer,
1776 1776 # but is there a better way to achieve that the code stmt has access
1777 1777 # to the shell namespace?
1778 1778
1779 1779 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1780 1780 'setup': "pass"}
1781 1781 # Track compilation time so it can be reported if too long
1782 1782 # Minimum time above which compilation time will be reported
1783 1783 tc_min = 0.1
1784 1784
1785 1785 t0 = clock()
1786 1786 code = compile(src, "<magic-timeit>", "exec")
1787 1787 tc = clock()-t0
1788 1788
1789 1789 ns = {}
1790 1790 exec code in self.shell.user_ns, ns
1791 1791 timer.inner = ns["inner"]
1792 1792
1793 1793 if number == 0:
1794 1794 # determine number so that 0.2 <= total time < 2.0
1795 1795 number = 1
1796 1796 for i in range(1, 10):
1797 1797 number *= 10
1798 1798 if timer.timeit(number) >= 0.2:
1799 1799 break
1800 1800
1801 1801 best = min(timer.repeat(repeat, number)) / number
1802 1802
1803 1803 if best > 0.0:
1804 1804 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1805 1805 else:
1806 1806 order = 3
1807 1807 print "%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1808 1808 precision,
1809 1809 best * scaling[order],
1810 1810 units[order])
1811 1811 if tc > tc_min:
1812 1812 print "Compiler time: %.2f s" % tc
1813 1813
1814 1814 def magic_time(self,parameter_s = ''):
1815 1815 """Time execution of a Python statement or expression.
1816 1816
1817 1817 The CPU and wall clock times are printed, and the value of the
1818 1818 expression (if any) is returned. Note that under Win32, system time
1819 1819 is always reported as 0, since it can not be measured.
1820 1820
1821 1821 This function provides very basic timing functionality. In Python
1822 1822 2.3, the timeit module offers more control and sophistication, so this
1823 1823 could be rewritten to use it (patches welcome).
1824 1824
1825 1825 Some examples:
1826 1826
1827 1827 In [1]: time 2**128
1828 1828 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1829 1829 Wall time: 0.00
1830 1830 Out[1]: 340282366920938463463374607431768211456L
1831 1831
1832 1832 In [2]: n = 1000000
1833 1833
1834 1834 In [3]: time sum(range(n))
1835 1835 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1836 1836 Wall time: 1.37
1837 1837 Out[3]: 499999500000L
1838 1838
1839 1839 In [4]: time print 'hello world'
1840 1840 hello world
1841 1841 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1842 1842 Wall time: 0.00
1843 1843
1844 1844 Note that the time needed by Python to compile the given expression
1845 1845 will be reported if it is more than 0.1s. In this example, the
1846 1846 actual exponentiation is done by Python at compilation time, so while
1847 1847 the expression can take a noticeable amount of time to compute, that
1848 1848 time is purely due to the compilation:
1849 1849
1850 1850 In [5]: time 3**9999;
1851 1851 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1852 1852 Wall time: 0.00 s
1853 1853
1854 1854 In [6]: time 3**999999;
1855 1855 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1856 1856 Wall time: 0.00 s
1857 1857 Compiler : 0.78 s
1858 1858 """
1859 1859
1860 1860 # fail immediately if the given expression can't be compiled
1861 1861
1862 1862 expr = self.shell.prefilter(parameter_s,False)
1863 1863
1864 1864 # Minimum time above which compilation time will be reported
1865 1865 tc_min = 0.1
1866 1866
1867 1867 try:
1868 1868 mode = 'eval'
1869 1869 t0 = clock()
1870 1870 code = compile(expr,'<timed eval>',mode)
1871 1871 tc = clock()-t0
1872 1872 except SyntaxError:
1873 1873 mode = 'exec'
1874 1874 t0 = clock()
1875 1875 code = compile(expr,'<timed exec>',mode)
1876 1876 tc = clock()-t0
1877 1877 # skew measurement as little as possible
1878 1878 glob = self.shell.user_ns
1879 1879 clk = clock2
1880 1880 wtime = time.time
1881 1881 # time execution
1882 1882 wall_st = wtime()
1883 1883 if mode=='eval':
1884 1884 st = clk()
1885 1885 out = eval(code,glob)
1886 1886 end = clk()
1887 1887 else:
1888 1888 st = clk()
1889 1889 exec code in glob
1890 1890 end = clk()
1891 1891 out = None
1892 1892 wall_end = wtime()
1893 1893 # Compute actual times and report
1894 1894 wall_time = wall_end-wall_st
1895 1895 cpu_user = end[0]-st[0]
1896 1896 cpu_sys = end[1]-st[1]
1897 1897 cpu_tot = cpu_user+cpu_sys
1898 1898 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1899 1899 (cpu_user,cpu_sys,cpu_tot)
1900 1900 print "Wall time: %.2f s" % wall_time
1901 1901 if tc > tc_min:
1902 1902 print "Compiler : %.2f s" % tc
1903 1903 return out
1904 1904
1905 1905 def magic_macro(self,parameter_s = ''):
1906 1906 """Define a set of input lines as a macro for future re-execution.
1907 1907
1908 1908 Usage:\\
1909 1909 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1910 1910
1911 1911 Options:
1912 1912
1913 1913 -r: use 'raw' input. By default, the 'processed' history is used,
1914 1914 so that magics are loaded in their transformed version to valid
1915 1915 Python. If this option is given, the raw input as typed as the
1916 1916 command line is used instead.
1917 1917
1918 1918 This will define a global variable called `name` which is a string
1919 1919 made of joining the slices and lines you specify (n1,n2,... numbers
1920 1920 above) from your input history into a single string. This variable
1921 1921 acts like an automatic function which re-executes those lines as if
1922 1922 you had typed them. You just type 'name' at the prompt and the code
1923 1923 executes.
1924 1924
1925 1925 The notation for indicating number ranges is: n1-n2 means 'use line
1926 1926 numbers n1,...n2' (the endpoint is included). That is, '5-7' means
1927 1927 using the lines numbered 5,6 and 7.
1928 1928
1929 1929 Note: as a 'hidden' feature, you can also use traditional python slice
1930 1930 notation, where N:M means numbers N through M-1.
1931 1931
1932 1932 For example, if your history contains (%hist prints it):
1933 1933
1934 1934 44: x=1\\
1935 1935 45: y=3\\
1936 1936 46: z=x+y\\
1937 1937 47: print x\\
1938 1938 48: a=5\\
1939 1939 49: print 'x',x,'y',y\\
1940 1940
1941 1941 you can create a macro with lines 44 through 47 (included) and line 49
1942 1942 called my_macro with:
1943 1943
1944 1944 In [51]: %macro my_macro 44-47 49
1945 1945
1946 1946 Now, typing `my_macro` (without quotes) will re-execute all this code
1947 1947 in one pass.
1948 1948
1949 1949 You don't need to give the line-numbers in order, and any given line
1950 1950 number can appear multiple times. You can assemble macros with any
1951 1951 lines from your input history in any order.
1952 1952
1953 1953 The macro is a simple object which holds its value in an attribute,
1954 1954 but IPython's display system checks for macros and executes them as
1955 1955 code instead of printing them when you type their name.
1956 1956
1957 1957 You can view a macro's contents by explicitly printing it with:
1958 1958
1959 1959 'print macro_name'.
1960 1960
1961 1961 For one-off cases which DON'T contain magic function calls in them you
1962 1962 can obtain similar results by explicitly executing slices from your
1963 1963 input history with:
1964 1964
1965 1965 In [60]: exec In[44:48]+In[49]"""
1966 1966
1967 1967 opts,args = self.parse_options(parameter_s,'r',mode='list')
1968 1968 if not args:
1969 1969 macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)]
1970 1970 macs.sort()
1971 1971 return macs
1972 1972 if len(args) == 1:
1973 1973 raise UsageError(
1974 1974 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
1975 1975 name,ranges = args[0], args[1:]
1976 1976
1977 1977 #print 'rng',ranges # dbg
1978 1978 lines = self.extract_input_slices(ranges,opts.has_key('r'))
1979 1979 macro = Macro(lines)
1980 1980 self.shell.user_ns.update({name:macro})
1981 1981 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
1982 1982 print 'Macro contents:'
1983 1983 print macro,
1984 1984
1985 1985 def magic_save(self,parameter_s = ''):
1986 1986 """Save a set of lines to a given filename.
1987 1987
1988 1988 Usage:\\
1989 1989 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
1990 1990
1991 1991 Options:
1992 1992
1993 1993 -r: use 'raw' input. By default, the 'processed' history is used,
1994 1994 so that magics are loaded in their transformed version to valid
1995 1995 Python. If this option is given, the raw input as typed as the
1996 1996 command line is used instead.
1997 1997
1998 1998 This function uses the same syntax as %macro for line extraction, but
1999 1999 instead of creating a macro it saves the resulting string to the
2000 2000 filename you specify.
2001 2001
2002 2002 It adds a '.py' extension to the file if you don't do so yourself, and
2003 2003 it asks for confirmation before overwriting existing files."""
2004 2004
2005 2005 opts,args = self.parse_options(parameter_s,'r',mode='list')
2006 2006 fname,ranges = args[0], args[1:]
2007 2007 if not fname.endswith('.py'):
2008 2008 fname += '.py'
2009 2009 if os.path.isfile(fname):
2010 2010 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2011 2011 if ans.lower() not in ['y','yes']:
2012 2012 print 'Operation cancelled.'
2013 2013 return
2014 2014 cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r')))
2015 2015 f = file(fname,'w')
2016 2016 f.write(cmds)
2017 2017 f.close()
2018 2018 print 'The following commands were written to file `%s`:' % fname
2019 2019 print cmds
2020 2020
2021 2021 def _edit_macro(self,mname,macro):
2022 2022 """open an editor with the macro data in a file"""
2023 2023 filename = self.shell.mktempfile(macro.value)
2024 2024 self.shell.hooks.editor(filename)
2025 2025
2026 2026 # and make a new macro object, to replace the old one
2027 2027 mfile = open(filename)
2028 2028 mvalue = mfile.read()
2029 2029 mfile.close()
2030 2030 self.shell.user_ns[mname] = Macro(mvalue)
2031 2031
2032 2032 def magic_ed(self,parameter_s=''):
2033 2033 """Alias to %edit."""
2034 2034 return self.magic_edit(parameter_s)
2035 2035
2036 2036 def magic_edit(self,parameter_s='',last_call=['','']):
2037 2037 """Bring up an editor and execute the resulting code.
2038 2038
2039 2039 Usage:
2040 2040 %edit [options] [args]
2041 2041
2042 2042 %edit runs IPython's editor hook. The default version of this hook is
2043 2043 set to call the __IPYTHON__.rc.editor command. This is read from your
2044 2044 environment variable $EDITOR. If this isn't found, it will default to
2045 2045 vi under Linux/Unix and to notepad under Windows. See the end of this
2046 2046 docstring for how to change the editor hook.
2047 2047
2048 2048 You can also set the value of this editor via the command line option
2049 2049 '-editor' or in your ipythonrc file. This is useful if you wish to use
2050 2050 specifically for IPython an editor different from your typical default
2051 2051 (and for Windows users who typically don't set environment variables).
2052 2052
2053 2053 This command allows you to conveniently edit multi-line code right in
2054 2054 your IPython session.
2055 2055
2056 2056 If called without arguments, %edit opens up an empty editor with a
2057 2057 temporary file and will execute the contents of this file when you
2058 2058 close it (don't forget to save it!).
2059 2059
2060 2060
2061 2061 Options:
2062 2062
2063 2063 -n <number>: open the editor at a specified line number. By default,
2064 2064 the IPython editor hook uses the unix syntax 'editor +N filename', but
2065 2065 you can configure this by providing your own modified hook if your
2066 2066 favorite editor supports line-number specifications with a different
2067 2067 syntax.
2068 2068
2069 2069 -p: this will call the editor with the same data as the previous time
2070 2070 it was used, regardless of how long ago (in your current session) it
2071 2071 was.
2072 2072
2073 2073 -r: use 'raw' input. This option only applies to input taken from the
2074 2074 user's history. By default, the 'processed' history is used, so that
2075 2075 magics are loaded in their transformed version to valid Python. If
2076 2076 this option is given, the raw input as typed as the command line is
2077 2077 used instead. When you exit the editor, it will be executed by
2078 2078 IPython's own processor.
2079 2079
2080 2080 -x: do not execute the edited code immediately upon exit. This is
2081 2081 mainly useful if you are editing programs which need to be called with
2082 2082 command line arguments, which you can then do using %run.
2083 2083
2084 2084
2085 2085 Arguments:
2086 2086
2087 2087 If arguments are given, the following possibilites exist:
2088 2088
2089 2089 - The arguments are numbers or pairs of colon-separated numbers (like
2090 2090 1 4:8 9). These are interpreted as lines of previous input to be
2091 2091 loaded into the editor. The syntax is the same of the %macro command.
2092 2092
2093 2093 - If the argument doesn't start with a number, it is evaluated as a
2094 2094 variable and its contents loaded into the editor. You can thus edit
2095 2095 any string which contains python code (including the result of
2096 2096 previous edits).
2097 2097
2098 2098 - If the argument is the name of an object (other than a string),
2099 2099 IPython will try to locate the file where it was defined and open the
2100 2100 editor at the point where it is defined. You can use `%edit function`
2101 2101 to load an editor exactly at the point where 'function' is defined,
2102 2102 edit it and have the file be executed automatically.
2103 2103
2104 2104 If the object is a macro (see %macro for details), this opens up your
2105 2105 specified editor with a temporary file containing the macro's data.
2106 2106 Upon exit, the macro is reloaded with the contents of the file.
2107 2107
2108 2108 Note: opening at an exact line is only supported under Unix, and some
2109 2109 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2110 2110 '+NUMBER' parameter necessary for this feature. Good editors like
2111 2111 (X)Emacs, vi, jed, pico and joe all do.
2112 2112
2113 2113 - If the argument is not found as a variable, IPython will look for a
2114 2114 file with that name (adding .py if necessary) and load it into the
2115 2115 editor. It will execute its contents with execfile() when you exit,
2116 2116 loading any code in the file into your interactive namespace.
2117 2117
2118 2118 After executing your code, %edit will return as output the code you
2119 2119 typed in the editor (except when it was an existing file). This way
2120 2120 you can reload the code in further invocations of %edit as a variable,
2121 2121 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2122 2122 the output.
2123 2123
2124 2124 Note that %edit is also available through the alias %ed.
2125 2125
2126 2126 This is an example of creating a simple function inside the editor and
2127 2127 then modifying it. First, start up the editor:
2128 2128
2129 2129 In [1]: ed\\
2130 2130 Editing... done. Executing edited code...\\
2131 2131 Out[1]: 'def foo():\\n print "foo() was defined in an editing session"\\n'
2132 2132
2133 2133 We can then call the function foo():
2134 2134
2135 2135 In [2]: foo()\\
2136 2136 foo() was defined in an editing session
2137 2137
2138 2138 Now we edit foo. IPython automatically loads the editor with the
2139 2139 (temporary) file where foo() was previously defined:
2140 2140
2141 2141 In [3]: ed foo\\
2142 2142 Editing... done. Executing edited code...
2143 2143
2144 2144 And if we call foo() again we get the modified version:
2145 2145
2146 2146 In [4]: foo()\\
2147 2147 foo() has now been changed!
2148 2148
2149 2149 Here is an example of how to edit a code snippet successive
2150 2150 times. First we call the editor:
2151 2151
2152 2152 In [8]: ed\\
2153 2153 Editing... done. Executing edited code...\\
2154 2154 hello\\
2155 2155 Out[8]: "print 'hello'\\n"
2156 2156
2157 2157 Now we call it again with the previous output (stored in _):
2158 2158
2159 2159 In [9]: ed _\\
2160 2160 Editing... done. Executing edited code...\\
2161 2161 hello world\\
2162 2162 Out[9]: "print 'hello world'\\n"
2163 2163
2164 2164 Now we call it with the output #8 (stored in _8, also as Out[8]):
2165 2165
2166 2166 In [10]: ed _8\\
2167 2167 Editing... done. Executing edited code...\\
2168 2168 hello again\\
2169 2169 Out[10]: "print 'hello again'\\n"
2170 2170
2171 2171
2172 2172 Changing the default editor hook:
2173 2173
2174 2174 If you wish to write your own editor hook, you can put it in a
2175 2175 configuration file which you load at startup time. The default hook
2176 2176 is defined in the IPython.hooks module, and you can use that as a
2177 2177 starting example for further modifications. That file also has
2178 2178 general instructions on how to set a new hook for use once you've
2179 2179 defined it."""
2180 2180
2181 2181 # FIXME: This function has become a convoluted mess. It needs a
2182 2182 # ground-up rewrite with clean, simple logic.
2183 2183
2184 2184 def make_filename(arg):
2185 2185 "Make a filename from the given args"
2186 2186 try:
2187 2187 filename = get_py_filename(arg)
2188 2188 except IOError:
2189 2189 if args.endswith('.py'):
2190 2190 filename = arg
2191 2191 else:
2192 2192 filename = None
2193 2193 return filename
2194 2194
2195 2195 # custom exceptions
2196 2196 class DataIsObject(Exception): pass
2197 2197
2198 2198 opts,args = self.parse_options(parameter_s,'prxn:')
2199 2199 # Set a few locals from the options for convenience:
2200 2200 opts_p = opts.has_key('p')
2201 2201 opts_r = opts.has_key('r')
2202 2202
2203 2203 # Default line number value
2204 2204 lineno = opts.get('n',None)
2205 2205
2206 2206 if opts_p:
2207 2207 args = '_%s' % last_call[0]
2208 2208 if not self.shell.user_ns.has_key(args):
2209 2209 args = last_call[1]
2210 2210
2211 2211 # use last_call to remember the state of the previous call, but don't
2212 2212 # let it be clobbered by successive '-p' calls.
2213 2213 try:
2214 2214 last_call[0] = self.shell.outputcache.prompt_count
2215 2215 if not opts_p:
2216 2216 last_call[1] = parameter_s
2217 2217 except:
2218 2218 pass
2219 2219
2220 2220 # by default this is done with temp files, except when the given
2221 2221 # arg is a filename
2222 2222 use_temp = 1
2223 2223
2224 2224 if re.match(r'\d',args):
2225 2225 # Mode where user specifies ranges of lines, like in %macro.
2226 2226 # This means that you can't edit files whose names begin with
2227 2227 # numbers this way. Tough.
2228 2228 ranges = args.split()
2229 2229 data = ''.join(self.extract_input_slices(ranges,opts_r))
2230 2230 elif args.endswith('.py'):
2231 2231 filename = make_filename(args)
2232 2232 data = ''
2233 2233 use_temp = 0
2234 2234 elif args:
2235 2235 try:
2236 2236 # Load the parameter given as a variable. If not a string,
2237 2237 # process it as an object instead (below)
2238 2238
2239 2239 #print '*** args',args,'type',type(args) # dbg
2240 2240 data = eval(args,self.shell.user_ns)
2241 2241 if not type(data) in StringTypes:
2242 2242 raise DataIsObject
2243 2243
2244 2244 except (NameError,SyntaxError):
2245 2245 # given argument is not a variable, try as a filename
2246 2246 filename = make_filename(args)
2247 2247 if filename is None:
2248 2248 warn("Argument given (%s) can't be found as a variable "
2249 2249 "or as a filename." % args)
2250 2250 return
2251 2251
2252 2252 data = ''
2253 2253 use_temp = 0
2254 2254 except DataIsObject:
2255 2255
2256 2256 # macros have a special edit function
2257 2257 if isinstance(data,Macro):
2258 2258 self._edit_macro(args,data)
2259 2259 return
2260 2260
2261 2261 # For objects, try to edit the file where they are defined
2262 2262 try:
2263 2263 filename = inspect.getabsfile(data)
2264 2264 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2265 2265 # class created by %edit? Try to find source
2266 2266 # by looking for method definitions instead, the
2267 2267 # __module__ in those classes is FakeModule.
2268 2268 attrs = [getattr(data, aname) for aname in dir(data)]
2269 2269 for attr in attrs:
2270 2270 if not inspect.ismethod(attr):
2271 2271 continue
2272 2272 filename = inspect.getabsfile(attr)
2273 2273 if filename and 'fakemodule' not in filename.lower():
2274 2274 # change the attribute to be the edit target instead
2275 2275 data = attr
2276 2276 break
2277 2277
2278 2278 datafile = 1
2279 2279 except TypeError:
2280 2280 filename = make_filename(args)
2281 2281 datafile = 1
2282 2282 warn('Could not find file where `%s` is defined.\n'
2283 2283 'Opening a file named `%s`' % (args,filename))
2284 2284 # Now, make sure we can actually read the source (if it was in
2285 2285 # a temp file it's gone by now).
2286 2286 if datafile:
2287 2287 try:
2288 2288 if lineno is None:
2289 2289 lineno = inspect.getsourcelines(data)[1]
2290 2290 except IOError:
2291 2291 filename = make_filename(args)
2292 2292 if filename is None:
2293 2293 warn('The file `%s` where `%s` was defined cannot '
2294 2294 'be read.' % (filename,data))
2295 2295 return
2296 2296 use_temp = 0
2297 2297 else:
2298 2298 data = ''
2299 2299
2300 2300 if use_temp:
2301 2301 filename = self.shell.mktempfile(data)
2302 2302 print 'IPython will make a temporary file named:',filename
2303 2303
2304 2304 # do actual editing here
2305 2305 print 'Editing...',
2306 2306 sys.stdout.flush()
2307 2307 self.shell.hooks.editor(filename,lineno)
2308 2308 if opts.has_key('x'): # -x prevents actual execution
2309 2309 print
2310 2310 else:
2311 2311 print 'done. Executing edited code...'
2312 2312 if opts_r:
2313 2313 self.shell.runlines(file_read(filename))
2314 2314 else:
2315 2315 self.shell.safe_execfile(filename,self.shell.user_ns,
2316 2316 self.shell.user_ns)
2317 2317 if use_temp:
2318 2318 try:
2319 2319 return open(filename).read()
2320 2320 except IOError,msg:
2321 2321 if msg.filename == filename:
2322 2322 warn('File not found. Did you forget to save?')
2323 2323 return
2324 2324 else:
2325 2325 self.shell.showtraceback()
2326 2326
2327 2327 def magic_xmode(self,parameter_s = ''):
2328 2328 """Switch modes for the exception handlers.
2329 2329
2330 2330 Valid modes: Plain, Context and Verbose.
2331 2331
2332 2332 If called without arguments, acts as a toggle."""
2333 2333
2334 2334 def xmode_switch_err(name):
2335 2335 warn('Error changing %s exception modes.\n%s' %
2336 2336 (name,sys.exc_info()[1]))
2337 2337
2338 2338 shell = self.shell
2339 2339 new_mode = parameter_s.strip().capitalize()
2340 2340 try:
2341 2341 shell.InteractiveTB.set_mode(mode=new_mode)
2342 2342 print 'Exception reporting mode:',shell.InteractiveTB.mode
2343 2343 except:
2344 2344 xmode_switch_err('user')
2345 2345
2346 2346 # threaded shells use a special handler in sys.excepthook
2347 2347 if shell.isthreaded:
2348 2348 try:
2349 2349 shell.sys_excepthook.set_mode(mode=new_mode)
2350 2350 except:
2351 2351 xmode_switch_err('threaded')
2352 2352
2353 2353 def magic_colors(self,parameter_s = ''):
2354 2354 """Switch color scheme for prompts, info system and exception handlers.
2355 2355
2356 2356 Currently implemented schemes: NoColor, Linux, LightBG.
2357 2357
2358 2358 Color scheme names are not case-sensitive."""
2359 2359
2360 2360 def color_switch_err(name):
2361 2361 warn('Error changing %s color schemes.\n%s' %
2362 2362 (name,sys.exc_info()[1]))
2363 2363
2364 2364
2365 2365 new_scheme = parameter_s.strip()
2366 2366 if not new_scheme:
2367 2367 raise UsageError(
2368 2368 "%colors: you must specify a color scheme. See '%colors?'")
2369 2369 return
2370 2370 # local shortcut
2371 2371 shell = self.shell
2372 2372
2373 2373 import IPython.rlineimpl as readline
2374 2374
2375 2375 if not readline.have_readline and sys.platform == "win32":
2376 2376 msg = """\
2377 2377 Proper color support under MS Windows requires the pyreadline library.
2378 2378 You can find it at:
2379 2379 http://ipython.scipy.org/moin/PyReadline/Intro
2380 2380 Gary's readline needs the ctypes module, from:
2381 2381 http://starship.python.net/crew/theller/ctypes
2382 2382 (Note that ctypes is already part of Python versions 2.5 and newer).
2383 2383
2384 2384 Defaulting color scheme to 'NoColor'"""
2385 2385 new_scheme = 'NoColor'
2386 2386 warn(msg)
2387 2387
2388 2388 # readline option is 0
2389 2389 if not shell.has_readline:
2390 2390 new_scheme = 'NoColor'
2391 2391
2392 2392 # Set prompt colors
2393 2393 try:
2394 2394 shell.outputcache.set_colors(new_scheme)
2395 2395 except:
2396 2396 color_switch_err('prompt')
2397 2397 else:
2398 2398 shell.rc.colors = \
2399 2399 shell.outputcache.color_table.active_scheme_name
2400 2400 # Set exception colors
2401 2401 try:
2402 2402 shell.InteractiveTB.set_colors(scheme = new_scheme)
2403 2403 shell.SyntaxTB.set_colors(scheme = new_scheme)
2404 2404 except:
2405 2405 color_switch_err('exception')
2406 2406
2407 2407 # threaded shells use a verbose traceback in sys.excepthook
2408 2408 if shell.isthreaded:
2409 2409 try:
2410 2410 shell.sys_excepthook.set_colors(scheme=new_scheme)
2411 2411 except:
2412 2412 color_switch_err('system exception handler')
2413 2413
2414 2414 # Set info (for 'object?') colors
2415 2415 if shell.rc.color_info:
2416 2416 try:
2417 2417 shell.inspector.set_active_scheme(new_scheme)
2418 2418 except:
2419 2419 color_switch_err('object inspector')
2420 2420 else:
2421 2421 shell.inspector.set_active_scheme('NoColor')
2422 2422
2423 2423 def magic_color_info(self,parameter_s = ''):
2424 2424 """Toggle color_info.
2425 2425
2426 2426 The color_info configuration parameter controls whether colors are
2427 2427 used for displaying object details (by things like %psource, %pfile or
2428 2428 the '?' system). This function toggles this value with each call.
2429 2429
2430 2430 Note that unless you have a fairly recent pager (less works better
2431 2431 than more) in your system, using colored object information displays
2432 2432 will not work properly. Test it and see."""
2433 2433
2434 2434 self.shell.rc.color_info = 1 - self.shell.rc.color_info
2435 2435 self.magic_colors(self.shell.rc.colors)
2436 2436 print 'Object introspection functions have now coloring:',
2437 2437 print ['OFF','ON'][self.shell.rc.color_info]
2438 2438
2439 2439 def magic_Pprint(self, parameter_s=''):
2440 2440 """Toggle pretty printing on/off."""
2441 2441
2442 2442 self.shell.rc.pprint = 1 - self.shell.rc.pprint
2443 2443 print 'Pretty printing has been turned', \
2444 2444 ['OFF','ON'][self.shell.rc.pprint]
2445 2445
2446 2446 def magic_exit(self, parameter_s=''):
2447 2447 """Exit IPython, confirming if configured to do so.
2448 2448
2449 2449 You can configure whether IPython asks for confirmation upon exit by
2450 2450 setting the confirm_exit flag in the ipythonrc file."""
2451 2451
2452 2452 self.shell.exit()
2453 2453
2454 2454 def magic_quit(self, parameter_s=''):
2455 2455 """Exit IPython, confirming if configured to do so (like %exit)"""
2456 2456
2457 2457 self.shell.exit()
2458 2458
2459 2459 def magic_Exit(self, parameter_s=''):
2460 2460 """Exit IPython without confirmation."""
2461 2461
2462 self.shell.exit_now = True
2462 self.shell.ask_exit()
2463 2463
2464 2464 #......................................................................
2465 2465 # Functions to implement unix shell-type things
2466 2466
2467 2467 def magic_alias(self, parameter_s = ''):
2468 2468 """Define an alias for a system command.
2469 2469
2470 2470 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2471 2471
2472 2472 Then, typing 'alias_name params' will execute the system command 'cmd
2473 2473 params' (from your underlying operating system).
2474 2474
2475 2475 Aliases have lower precedence than magic functions and Python normal
2476 2476 variables, so if 'foo' is both a Python variable and an alias, the
2477 2477 alias can not be executed until 'del foo' removes the Python variable.
2478 2478
2479 2479 You can use the %l specifier in an alias definition to represent the
2480 2480 whole line when the alias is called. For example:
2481 2481
2482 2482 In [2]: alias all echo "Input in brackets: <%l>"\\
2483 2483 In [3]: all hello world\\
2484 2484 Input in brackets: <hello world>
2485 2485
2486 2486 You can also define aliases with parameters using %s specifiers (one
2487 2487 per parameter):
2488 2488
2489 2489 In [1]: alias parts echo first %s second %s\\
2490 2490 In [2]: %parts A B\\
2491 2491 first A second B\\
2492 2492 In [3]: %parts A\\
2493 2493 Incorrect number of arguments: 2 expected.\\
2494 2494 parts is an alias to: 'echo first %s second %s'
2495 2495
2496 2496 Note that %l and %s are mutually exclusive. You can only use one or
2497 2497 the other in your aliases.
2498 2498
2499 2499 Aliases expand Python variables just like system calls using ! or !!
2500 2500 do: all expressions prefixed with '$' get expanded. For details of
2501 2501 the semantic rules, see PEP-215:
2502 2502 http://www.python.org/peps/pep-0215.html. This is the library used by
2503 2503 IPython for variable expansion. If you want to access a true shell
2504 2504 variable, an extra $ is necessary to prevent its expansion by IPython:
2505 2505
2506 2506 In [6]: alias show echo\\
2507 2507 In [7]: PATH='A Python string'\\
2508 2508 In [8]: show $PATH\\
2509 2509 A Python string\\
2510 2510 In [9]: show $$PATH\\
2511 2511 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2512 2512
2513 2513 You can use the alias facility to acess all of $PATH. See the %rehash
2514 2514 and %rehashx functions, which automatically create aliases for the
2515 2515 contents of your $PATH.
2516 2516
2517 2517 If called with no parameters, %alias prints the current alias table."""
2518 2518
2519 2519 par = parameter_s.strip()
2520 2520 if not par:
2521 2521 stored = self.db.get('stored_aliases', {} )
2522 2522 atab = self.shell.alias_table
2523 2523 aliases = atab.keys()
2524 2524 aliases.sort()
2525 2525 res = []
2526 2526 showlast = []
2527 2527 for alias in aliases:
2528 2528 special = False
2529 2529 try:
2530 2530 tgt = atab[alias][1]
2531 2531 except (TypeError, AttributeError):
2532 2532 # unsubscriptable? probably a callable
2533 2533 tgt = atab[alias]
2534 2534 special = True
2535 2535 # 'interesting' aliases
2536 2536 if (alias in stored or
2537 2537 special or
2538 2538 alias.lower() != os.path.splitext(tgt)[0].lower() or
2539 2539 ' ' in tgt):
2540 2540 showlast.append((alias, tgt))
2541 2541 else:
2542 2542 res.append((alias, tgt ))
2543 2543
2544 2544 # show most interesting aliases last
2545 2545 res.extend(showlast)
2546 2546 print "Total number of aliases:",len(aliases)
2547 2547 return res
2548 2548 try:
2549 2549 alias,cmd = par.split(None,1)
2550 2550 except:
2551 2551 print OInspect.getdoc(self.magic_alias)
2552 2552 else:
2553 2553 nargs = cmd.count('%s')
2554 2554 if nargs>0 and cmd.find('%l')>=0:
2555 2555 error('The %s and %l specifiers are mutually exclusive '
2556 2556 'in alias definitions.')
2557 2557 else: # all looks OK
2558 2558 self.shell.alias_table[alias] = (nargs,cmd)
2559 2559 self.shell.alias_table_validate(verbose=0)
2560 2560 # end magic_alias
2561 2561
2562 2562 def magic_unalias(self, parameter_s = ''):
2563 2563 """Remove an alias"""
2564 2564
2565 2565 aname = parameter_s.strip()
2566 2566 if aname in self.shell.alias_table:
2567 2567 del self.shell.alias_table[aname]
2568 2568 stored = self.db.get('stored_aliases', {} )
2569 2569 if aname in stored:
2570 2570 print "Removing %stored alias",aname
2571 2571 del stored[aname]
2572 2572 self.db['stored_aliases'] = stored
2573 2573
2574 2574
2575 2575 def magic_rehashx(self, parameter_s = ''):
2576 2576 """Update the alias table with all executable files in $PATH.
2577 2577
2578 2578 This version explicitly checks that every entry in $PATH is a file
2579 2579 with execute access (os.X_OK), so it is much slower than %rehash.
2580 2580
2581 2581 Under Windows, it checks executability as a match agains a
2582 2582 '|'-separated string of extensions, stored in the IPython config
2583 2583 variable win_exec_ext. This defaults to 'exe|com|bat'.
2584 2584
2585 2585 This function also resets the root module cache of module completer,
2586 2586 used on slow filesystems.
2587 2587 """
2588 2588
2589 2589
2590 2590 ip = self.api
2591 2591
2592 2592 # for the benefit of module completer in ipy_completers.py
2593 2593 del ip.db['rootmodules']
2594 2594
2595 2595 path = [os.path.abspath(os.path.expanduser(p)) for p in
2596 2596 os.environ.get('PATH','').split(os.pathsep)]
2597 2597 path = filter(os.path.isdir,path)
2598 2598
2599 2599 alias_table = self.shell.alias_table
2600 2600 syscmdlist = []
2601 2601 if os.name == 'posix':
2602 2602 isexec = lambda fname:os.path.isfile(fname) and \
2603 2603 os.access(fname,os.X_OK)
2604 2604 else:
2605 2605
2606 2606 try:
2607 2607 winext = os.environ['pathext'].replace(';','|').replace('.','')
2608 2608 except KeyError:
2609 2609 winext = 'exe|com|bat|py'
2610 2610 if 'py' not in winext:
2611 2611 winext += '|py'
2612 2612 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2613 2613 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2614 2614 savedir = os.getcwd()
2615 2615 try:
2616 2616 # write the whole loop for posix/Windows so we don't have an if in
2617 2617 # the innermost part
2618 2618 if os.name == 'posix':
2619 2619 for pdir in path:
2620 2620 os.chdir(pdir)
2621 2621 for ff in os.listdir(pdir):
2622 2622 if isexec(ff) and ff not in self.shell.no_alias:
2623 2623 # each entry in the alias table must be (N,name),
2624 2624 # where N is the number of positional arguments of the
2625 2625 # alias.
2626 2626 alias_table[ff] = (0,ff)
2627 2627 syscmdlist.append(ff)
2628 2628 else:
2629 2629 for pdir in path:
2630 2630 os.chdir(pdir)
2631 2631 for ff in os.listdir(pdir):
2632 2632 base, ext = os.path.splitext(ff)
2633 2633 if isexec(ff) and base.lower() not in self.shell.no_alias:
2634 2634 if ext.lower() == '.exe':
2635 2635 ff = base
2636 2636 alias_table[base.lower()] = (0,ff)
2637 2637 syscmdlist.append(ff)
2638 2638 # Make sure the alias table doesn't contain keywords or builtins
2639 2639 self.shell.alias_table_validate()
2640 2640 # Call again init_auto_alias() so we get 'rm -i' and other
2641 2641 # modified aliases since %rehashx will probably clobber them
2642 2642
2643 2643 # no, we don't want them. if %rehashx clobbers them, good,
2644 2644 # we'll probably get better versions
2645 2645 # self.shell.init_auto_alias()
2646 2646 db = ip.db
2647 2647 db['syscmdlist'] = syscmdlist
2648 2648 finally:
2649 2649 os.chdir(savedir)
2650 2650
2651 2651 def magic_pwd(self, parameter_s = ''):
2652 2652 """Return the current working directory path."""
2653 2653 return os.getcwd()
2654 2654
2655 2655 def magic_cd(self, parameter_s=''):
2656 2656 """Change the current working directory.
2657 2657
2658 2658 This command automatically maintains an internal list of directories
2659 2659 you visit during your IPython session, in the variable _dh. The
2660 2660 command %dhist shows this history nicely formatted. You can also
2661 2661 do 'cd -<tab>' to see directory history conveniently.
2662 2662
2663 2663 Usage:
2664 2664
2665 2665 cd 'dir': changes to directory 'dir'.
2666 2666
2667 2667 cd -: changes to the last visited directory.
2668 2668
2669 2669 cd -<n>: changes to the n-th directory in the directory history.
2670 2670
2671 2671 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2672 2672 (note: cd <bookmark_name> is enough if there is no
2673 2673 directory <bookmark_name>, but a bookmark with the name exists.)
2674 2674 'cd -b <tab>' allows you to tab-complete bookmark names.
2675 2675
2676 2676 Options:
2677 2677
2678 2678 -q: quiet. Do not print the working directory after the cd command is
2679 2679 executed. By default IPython's cd command does print this directory,
2680 2680 since the default prompts do not display path information.
2681 2681
2682 2682 Note that !cd doesn't work for this purpose because the shell where
2683 2683 !command runs is immediately discarded after executing 'command'."""
2684 2684
2685 2685 parameter_s = parameter_s.strip()
2686 2686 #bkms = self.shell.persist.get("bookmarks",{})
2687 2687
2688 2688 oldcwd = os.getcwd()
2689 2689 numcd = re.match(r'(-)(\d+)$',parameter_s)
2690 2690 # jump in directory history by number
2691 2691 if numcd:
2692 2692 nn = int(numcd.group(2))
2693 2693 try:
2694 2694 ps = self.shell.user_ns['_dh'][nn]
2695 2695 except IndexError:
2696 2696 print 'The requested directory does not exist in history.'
2697 2697 return
2698 2698 else:
2699 2699 opts = {}
2700 2700 else:
2701 2701 #turn all non-space-escaping backslashes to slashes,
2702 2702 # for c:\windows\directory\names\
2703 2703 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2704 2704 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2705 2705 # jump to previous
2706 2706 if ps == '-':
2707 2707 try:
2708 2708 ps = self.shell.user_ns['_dh'][-2]
2709 2709 except IndexError:
2710 2710 raise UsageError('%cd -: No previous directory to change to.')
2711 2711 # jump to bookmark if needed
2712 2712 else:
2713 2713 if not os.path.isdir(ps) or opts.has_key('b'):
2714 2714 bkms = self.db.get('bookmarks', {})
2715 2715
2716 2716 if bkms.has_key(ps):
2717 2717 target = bkms[ps]
2718 2718 print '(bookmark:%s) -> %s' % (ps,target)
2719 2719 ps = target
2720 2720 else:
2721 2721 if opts.has_key('b'):
2722 2722 raise UsageError("Bookmark '%s' not found. "
2723 2723 "Use '%%bookmark -l' to see your bookmarks." % ps)
2724 2724
2725 2725 # at this point ps should point to the target dir
2726 2726 if ps:
2727 2727 try:
2728 2728 os.chdir(os.path.expanduser(ps))
2729 2729 if self.shell.rc.term_title:
2730 2730 #print 'set term title:',self.shell.rc.term_title # dbg
2731 2731 platutils.set_term_title('IPy ' + abbrev_cwd())
2732 2732 except OSError:
2733 2733 print sys.exc_info()[1]
2734 2734 else:
2735 2735 cwd = os.getcwd()
2736 2736 dhist = self.shell.user_ns['_dh']
2737 2737 if oldcwd != cwd:
2738 2738 dhist.append(cwd)
2739 2739 self.db['dhist'] = compress_dhist(dhist)[-100:]
2740 2740
2741 2741 else:
2742 2742 os.chdir(self.shell.home_dir)
2743 2743 if self.shell.rc.term_title:
2744 2744 platutils.set_term_title("IPy ~")
2745 2745 cwd = os.getcwd()
2746 2746 dhist = self.shell.user_ns['_dh']
2747 2747
2748 2748 if oldcwd != cwd:
2749 2749 dhist.append(cwd)
2750 2750 self.db['dhist'] = compress_dhist(dhist)[-100:]
2751 2751 if not 'q' in opts and self.shell.user_ns['_dh']:
2752 2752 print self.shell.user_ns['_dh'][-1]
2753 2753
2754 2754
2755 2755 def magic_env(self, parameter_s=''):
2756 2756 """List environment variables."""
2757 2757
2758 2758 return os.environ.data
2759 2759
2760 2760 def magic_pushd(self, parameter_s=''):
2761 2761 """Place the current dir on stack and change directory.
2762 2762
2763 2763 Usage:\\
2764 2764 %pushd ['dirname']
2765 2765 """
2766 2766
2767 2767 dir_s = self.shell.dir_stack
2768 2768 tgt = os.path.expanduser(parameter_s)
2769 2769 cwd = os.getcwd().replace(self.home_dir,'~')
2770 2770 if tgt:
2771 2771 self.magic_cd(parameter_s)
2772 2772 dir_s.insert(0,cwd)
2773 2773 return self.magic_dirs()
2774 2774
2775 2775 def magic_popd(self, parameter_s=''):
2776 2776 """Change to directory popped off the top of the stack.
2777 2777 """
2778 2778 if not self.shell.dir_stack:
2779 2779 raise UsageError("%popd on empty stack")
2780 2780 top = self.shell.dir_stack.pop(0)
2781 2781 self.magic_cd(top)
2782 2782 print "popd ->",top
2783 2783
2784 2784 def magic_dirs(self, parameter_s=''):
2785 2785 """Return the current directory stack."""
2786 2786
2787 2787 return self.shell.dir_stack
2788 2788
2789 2789 def magic_dhist(self, parameter_s=''):
2790 2790 """Print your history of visited directories.
2791 2791
2792 2792 %dhist -> print full history\\
2793 2793 %dhist n -> print last n entries only\\
2794 2794 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2795 2795
2796 2796 This history is automatically maintained by the %cd command, and
2797 2797 always available as the global list variable _dh. You can use %cd -<n>
2798 2798 to go to directory number <n>.
2799 2799
2800 2800 Note that most of time, you should view directory history by entering
2801 2801 cd -<TAB>.
2802 2802
2803 2803 """
2804 2804
2805 2805 dh = self.shell.user_ns['_dh']
2806 2806 if parameter_s:
2807 2807 try:
2808 2808 args = map(int,parameter_s.split())
2809 2809 except:
2810 2810 self.arg_err(Magic.magic_dhist)
2811 2811 return
2812 2812 if len(args) == 1:
2813 2813 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2814 2814 elif len(args) == 2:
2815 2815 ini,fin = args
2816 2816 else:
2817 2817 self.arg_err(Magic.magic_dhist)
2818 2818 return
2819 2819 else:
2820 2820 ini,fin = 0,len(dh)
2821 2821 nlprint(dh,
2822 2822 header = 'Directory history (kept in _dh)',
2823 2823 start=ini,stop=fin)
2824 2824
2825 2825
2826 2826 def magic_sc(self, parameter_s=''):
2827 2827 """Shell capture - execute a shell command and capture its output.
2828 2828
2829 2829 DEPRECATED. Suboptimal, retained for backwards compatibility.
2830 2830
2831 2831 You should use the form 'var = !command' instead. Example:
2832 2832
2833 2833 "%sc -l myfiles = ls ~" should now be written as
2834 2834
2835 2835 "myfiles = !ls ~"
2836 2836
2837 2837 myfiles.s, myfiles.l and myfiles.n still apply as documented
2838 2838 below.
2839 2839
2840 2840 --
2841 2841 %sc [options] varname=command
2842 2842
2843 2843 IPython will run the given command using commands.getoutput(), and
2844 2844 will then update the user's interactive namespace with a variable
2845 2845 called varname, containing the value of the call. Your command can
2846 2846 contain shell wildcards, pipes, etc.
2847 2847
2848 2848 The '=' sign in the syntax is mandatory, and the variable name you
2849 2849 supply must follow Python's standard conventions for valid names.
2850 2850
2851 2851 (A special format without variable name exists for internal use)
2852 2852
2853 2853 Options:
2854 2854
2855 2855 -l: list output. Split the output on newlines into a list before
2856 2856 assigning it to the given variable. By default the output is stored
2857 2857 as a single string.
2858 2858
2859 2859 -v: verbose. Print the contents of the variable.
2860 2860
2861 2861 In most cases you should not need to split as a list, because the
2862 2862 returned value is a special type of string which can automatically
2863 2863 provide its contents either as a list (split on newlines) or as a
2864 2864 space-separated string. These are convenient, respectively, either
2865 2865 for sequential processing or to be passed to a shell command.
2866 2866
2867 2867 For example:
2868 2868
2869 2869 # Capture into variable a
2870 2870 In [9]: sc a=ls *py
2871 2871
2872 2872 # a is a string with embedded newlines
2873 2873 In [10]: a
2874 2874 Out[10]: 'setup.py\nwin32_manual_post_install.py'
2875 2875
2876 2876 # which can be seen as a list:
2877 2877 In [11]: a.l
2878 2878 Out[11]: ['setup.py', 'win32_manual_post_install.py']
2879 2879
2880 2880 # or as a whitespace-separated string:
2881 2881 In [12]: a.s
2882 2882 Out[12]: 'setup.py win32_manual_post_install.py'
2883 2883
2884 2884 # a.s is useful to pass as a single command line:
2885 2885 In [13]: !wc -l $a.s
2886 2886 146 setup.py
2887 2887 130 win32_manual_post_install.py
2888 2888 276 total
2889 2889
2890 2890 # while the list form is useful to loop over:
2891 2891 In [14]: for f in a.l:
2892 2892 ....: !wc -l $f
2893 2893 ....:
2894 2894 146 setup.py
2895 2895 130 win32_manual_post_install.py
2896 2896
2897 2897 Similiarly, the lists returned by the -l option are also special, in
2898 2898 the sense that you can equally invoke the .s attribute on them to
2899 2899 automatically get a whitespace-separated string from their contents:
2900 2900
2901 2901 In [1]: sc -l b=ls *py
2902 2902
2903 2903 In [2]: b
2904 2904 Out[2]: ['setup.py', 'win32_manual_post_install.py']
2905 2905
2906 2906 In [3]: b.s
2907 2907 Out[3]: 'setup.py win32_manual_post_install.py'
2908 2908
2909 2909 In summary, both the lists and strings used for ouptut capture have
2910 2910 the following special attributes:
2911 2911
2912 2912 .l (or .list) : value as list.
2913 2913 .n (or .nlstr): value as newline-separated string.
2914 2914 .s (or .spstr): value as space-separated string.
2915 2915 """
2916 2916
2917 2917 opts,args = self.parse_options(parameter_s,'lv')
2918 2918 # Try to get a variable name and command to run
2919 2919 try:
2920 2920 # the variable name must be obtained from the parse_options
2921 2921 # output, which uses shlex.split to strip options out.
2922 2922 var,_ = args.split('=',1)
2923 2923 var = var.strip()
2924 2924 # But the the command has to be extracted from the original input
2925 2925 # parameter_s, not on what parse_options returns, to avoid the
2926 2926 # quote stripping which shlex.split performs on it.
2927 2927 _,cmd = parameter_s.split('=',1)
2928 2928 except ValueError:
2929 2929 var,cmd = '',''
2930 2930 # If all looks ok, proceed
2931 2931 out,err = self.shell.getoutputerror(cmd)
2932 2932 if err:
2933 2933 print >> Term.cerr,err
2934 2934 if opts.has_key('l'):
2935 2935 out = SList(out.split('\n'))
2936 2936 else:
2937 2937 out = LSString(out)
2938 2938 if opts.has_key('v'):
2939 2939 print '%s ==\n%s' % (var,pformat(out))
2940 2940 if var:
2941 2941 self.shell.user_ns.update({var:out})
2942 2942 else:
2943 2943 return out
2944 2944
2945 2945 def magic_sx(self, parameter_s=''):
2946 2946 """Shell execute - run a shell command and capture its output.
2947 2947
2948 2948 %sx command
2949 2949
2950 2950 IPython will run the given command using commands.getoutput(), and
2951 2951 return the result formatted as a list (split on '\\n'). Since the
2952 2952 output is _returned_, it will be stored in ipython's regular output
2953 2953 cache Out[N] and in the '_N' automatic variables.
2954 2954
2955 2955 Notes:
2956 2956
2957 2957 1) If an input line begins with '!!', then %sx is automatically
2958 2958 invoked. That is, while:
2959 2959 !ls
2960 2960 causes ipython to simply issue system('ls'), typing
2961 2961 !!ls
2962 2962 is a shorthand equivalent to:
2963 2963 %sx ls
2964 2964
2965 2965 2) %sx differs from %sc in that %sx automatically splits into a list,
2966 2966 like '%sc -l'. The reason for this is to make it as easy as possible
2967 2967 to process line-oriented shell output via further python commands.
2968 2968 %sc is meant to provide much finer control, but requires more
2969 2969 typing.
2970 2970
2971 2971 3) Just like %sc -l, this is a list with special attributes:
2972 2972
2973 2973 .l (or .list) : value as list.
2974 2974 .n (or .nlstr): value as newline-separated string.
2975 2975 .s (or .spstr): value as whitespace-separated string.
2976 2976
2977 2977 This is very useful when trying to use such lists as arguments to
2978 2978 system commands."""
2979 2979
2980 2980 if parameter_s:
2981 2981 out,err = self.shell.getoutputerror(parameter_s)
2982 2982 if err:
2983 2983 print >> Term.cerr,err
2984 2984 return SList(out.split('\n'))
2985 2985
2986 2986 def magic_bg(self, parameter_s=''):
2987 2987 """Run a job in the background, in a separate thread.
2988 2988
2989 2989 For example,
2990 2990
2991 2991 %bg myfunc(x,y,z=1)
2992 2992
2993 2993 will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the
2994 2994 execution starts, a message will be printed indicating the job
2995 2995 number. If your job number is 5, you can use
2996 2996
2997 2997 myvar = jobs.result(5) or myvar = jobs[5].result
2998 2998
2999 2999 to assign this result to variable 'myvar'.
3000 3000
3001 3001 IPython has a job manager, accessible via the 'jobs' object. You can
3002 3002 type jobs? to get more information about it, and use jobs.<TAB> to see
3003 3003 its attributes. All attributes not starting with an underscore are
3004 3004 meant for public use.
3005 3005
3006 3006 In particular, look at the jobs.new() method, which is used to create
3007 3007 new jobs. This magic %bg function is just a convenience wrapper
3008 3008 around jobs.new(), for expression-based jobs. If you want to create a
3009 3009 new job with an explicit function object and arguments, you must call
3010 3010 jobs.new() directly.
3011 3011
3012 3012 The jobs.new docstring also describes in detail several important
3013 3013 caveats associated with a thread-based model for background job
3014 3014 execution. Type jobs.new? for details.
3015 3015
3016 3016 You can check the status of all jobs with jobs.status().
3017 3017
3018 3018 The jobs variable is set by IPython into the Python builtin namespace.
3019 3019 If you ever declare a variable named 'jobs', you will shadow this
3020 3020 name. You can either delete your global jobs variable to regain
3021 3021 access to the job manager, or make a new name and assign it manually
3022 3022 to the manager (stored in IPython's namespace). For example, to
3023 3023 assign the job manager to the Jobs name, use:
3024 3024
3025 3025 Jobs = __builtins__.jobs"""
3026 3026
3027 3027 self.shell.jobs.new(parameter_s,self.shell.user_ns)
3028 3028
3029 3029 def magic_r(self, parameter_s=''):
3030 3030 """Repeat previous input.
3031 3031
3032 3032 Note: Consider using the more powerfull %rep instead!
3033 3033
3034 3034 If given an argument, repeats the previous command which starts with
3035 3035 the same string, otherwise it just repeats the previous input.
3036 3036
3037 3037 Shell escaped commands (with ! as first character) are not recognized
3038 3038 by this system, only pure python code and magic commands.
3039 3039 """
3040 3040
3041 3041 start = parameter_s.strip()
3042 3042 esc_magic = self.shell.ESC_MAGIC
3043 3043 # Identify magic commands even if automagic is on (which means
3044 3044 # the in-memory version is different from that typed by the user).
3045 3045 if self.shell.rc.automagic:
3046 3046 start_magic = esc_magic+start
3047 3047 else:
3048 3048 start_magic = start
3049 3049 # Look through the input history in reverse
3050 3050 for n in range(len(self.shell.input_hist)-2,0,-1):
3051 3051 input = self.shell.input_hist[n]
3052 3052 # skip plain 'r' lines so we don't recurse to infinity
3053 3053 if input != '_ip.magic("r")\n' and \
3054 3054 (input.startswith(start) or input.startswith(start_magic)):
3055 3055 #print 'match',`input` # dbg
3056 3056 print 'Executing:',input,
3057 3057 self.shell.runlines(input)
3058 3058 return
3059 3059 print 'No previous input matching `%s` found.' % start
3060 3060
3061 3061
3062 3062 def magic_bookmark(self, parameter_s=''):
3063 3063 """Manage IPython's bookmark system.
3064 3064
3065 3065 %bookmark <name> - set bookmark to current dir
3066 3066 %bookmark <name> <dir> - set bookmark to <dir>
3067 3067 %bookmark -l - list all bookmarks
3068 3068 %bookmark -d <name> - remove bookmark
3069 3069 %bookmark -r - remove all bookmarks
3070 3070
3071 3071 You can later on access a bookmarked folder with:
3072 3072 %cd -b <name>
3073 3073 or simply '%cd <name>' if there is no directory called <name> AND
3074 3074 there is such a bookmark defined.
3075 3075
3076 3076 Your bookmarks persist through IPython sessions, but they are
3077 3077 associated with each profile."""
3078 3078
3079 3079 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3080 3080 if len(args) > 2:
3081 3081 raise UsageError("%bookmark: too many arguments")
3082 3082
3083 3083 bkms = self.db.get('bookmarks',{})
3084 3084
3085 3085 if opts.has_key('d'):
3086 3086 try:
3087 3087 todel = args[0]
3088 3088 except IndexError:
3089 3089 raise UsageError(
3090 3090 "%bookmark -d: must provide a bookmark to delete")
3091 3091 else:
3092 3092 try:
3093 3093 del bkms[todel]
3094 3094 except KeyError:
3095 3095 raise UsageError(
3096 3096 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3097 3097
3098 3098 elif opts.has_key('r'):
3099 3099 bkms = {}
3100 3100 elif opts.has_key('l'):
3101 3101 bks = bkms.keys()
3102 3102 bks.sort()
3103 3103 if bks:
3104 3104 size = max(map(len,bks))
3105 3105 else:
3106 3106 size = 0
3107 3107 fmt = '%-'+str(size)+'s -> %s'
3108 3108 print 'Current bookmarks:'
3109 3109 for bk in bks:
3110 3110 print fmt % (bk,bkms[bk])
3111 3111 else:
3112 3112 if not args:
3113 3113 raise UsageError("%bookmark: You must specify the bookmark name")
3114 3114 elif len(args)==1:
3115 3115 bkms[args[0]] = os.getcwd()
3116 3116 elif len(args)==2:
3117 3117 bkms[args[0]] = args[1]
3118 3118 self.db['bookmarks'] = bkms
3119 3119
3120 3120 def magic_pycat(self, parameter_s=''):
3121 3121 """Show a syntax-highlighted file through a pager.
3122 3122
3123 3123 This magic is similar to the cat utility, but it will assume the file
3124 3124 to be Python source and will show it with syntax highlighting. """
3125 3125
3126 3126 try:
3127 3127 filename = get_py_filename(parameter_s)
3128 3128 cont = file_read(filename)
3129 3129 except IOError:
3130 3130 try:
3131 3131 cont = eval(parameter_s,self.user_ns)
3132 3132 except NameError:
3133 3133 cont = None
3134 3134 if cont is None:
3135 3135 print "Error: no such file or variable"
3136 3136 return
3137 3137
3138 3138 page(self.shell.pycolorize(cont),
3139 3139 screen_lines=self.shell.rc.screen_length)
3140 3140
3141 3141 def magic_cpaste(self, parameter_s=''):
3142 3142 """Allows you to paste & execute a pre-formatted code block from clipboard.
3143 3143
3144 3144 You must terminate the block with '--' (two minus-signs) alone on the
3145 3145 line. You can also provide your own sentinel with '%paste -s %%' ('%%'
3146 3146 is the new sentinel for this operation)
3147 3147
3148 3148 The block is dedented prior to execution to enable execution of method
3149 3149 definitions. '>' and '+' characters at the beginning of a line are
3150 3150 ignored, to allow pasting directly from e-mails, diff files and
3151 3151 doctests (the '...' continuation prompt is also stripped). The
3152 3152 executed block is also assigned to variable named 'pasted_block' for
3153 3153 later editing with '%edit pasted_block'.
3154 3154
3155 3155 You can also pass a variable name as an argument, e.g. '%cpaste foo'.
3156 3156 This assigns the pasted block to variable 'foo' as string, without
3157 3157 dedenting or executing it (preceding >>> and + is still stripped)
3158 3158
3159 3159 Do not be alarmed by garbled output on Windows (it's a readline bug).
3160 3160 Just press enter and type -- (and press enter again) and the block
3161 3161 will be what was just pasted.
3162 3162
3163 3163 IPython statements (magics, shell escapes) are not supported (yet).
3164 3164 """
3165 3165 opts,args = self.parse_options(parameter_s,'s:',mode='string')
3166 3166 par = args.strip()
3167 3167 sentinel = opts.get('s','--')
3168 3168
3169 3169 # Regular expressions that declare text we strip from the input:
3170 3170 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3171 3171 r'^\s*(\s?>)+', # Python input prompt
3172 3172 r'^\s*\.{3,}', # Continuation prompts
3173 3173 r'^\++',
3174 3174 ]
3175 3175
3176 3176 strip_from_start = map(re.compile,strip_re)
3177 3177
3178 3178 from IPython import iplib
3179 3179 lines = []
3180 3180 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3181 3181 while 1:
3182 3182 l = iplib.raw_input_original(':')
3183 3183 if l ==sentinel:
3184 3184 break
3185 3185
3186 3186 for pat in strip_from_start:
3187 3187 l = pat.sub('',l)
3188 3188 lines.append(l)
3189 3189
3190 3190 block = "\n".join(lines) + '\n'
3191 3191 #print "block:\n",block
3192 3192 if not par:
3193 3193 b = textwrap.dedent(block)
3194 3194 exec b in self.user_ns
3195 3195 self.user_ns['pasted_block'] = b
3196 3196 else:
3197 3197 self.user_ns[par] = SList(block.splitlines())
3198 3198 print "Block assigned to '%s'" % par
3199 3199
3200 3200 def magic_quickref(self,arg):
3201 3201 """ Show a quick reference sheet """
3202 3202 import IPython.usage
3203 3203 qr = IPython.usage.quick_reference + self.magic_magic('-brief')
3204 3204
3205 3205 page(qr)
3206 3206
3207 3207 def magic_upgrade(self,arg):
3208 3208 """ Upgrade your IPython installation
3209 3209
3210 3210 This will copy the config files that don't yet exist in your
3211 3211 ipython dir from the system config dir. Use this after upgrading
3212 3212 IPython if you don't wish to delete your .ipython dir.
3213 3213
3214 3214 Call with -nolegacy to get rid of ipythonrc* files (recommended for
3215 3215 new users)
3216 3216
3217 3217 """
3218 3218 ip = self.getapi()
3219 3219 ipinstallation = path(IPython.__file__).dirname()
3220 3220 upgrade_script = '%s "%s"' % (sys.executable,ipinstallation / 'upgrade_dir.py')
3221 3221 src_config = ipinstallation / 'UserConfig'
3222 3222 userdir = path(ip.options.ipythondir)
3223 3223 cmd = '%s "%s" "%s"' % (upgrade_script, src_config, userdir)
3224 3224 print ">",cmd
3225 3225 shell(cmd)
3226 3226 if arg == '-nolegacy':
3227 3227 legacy = userdir.files('ipythonrc*')
3228 3228 print "Nuking legacy files:",legacy
3229 3229
3230 3230 [p.remove() for p in legacy]
3231 3231 suffix = (sys.platform == 'win32' and '.ini' or '')
3232 3232 (userdir / ('ipythonrc' + suffix)).write_text('# Empty, see ipy_user_conf.py\n')
3233 3233
3234 3234
3235 3235 def magic_doctest_mode(self,parameter_s=''):
3236 3236 """Toggle doctest mode on and off.
3237 3237
3238 3238 This mode allows you to toggle the prompt behavior between normal
3239 3239 IPython prompts and ones that are as similar to the default IPython
3240 3240 interpreter as possible.
3241 3241
3242 3242 It also supports the pasting of code snippets that have leading '>>>'
3243 3243 and '...' prompts in them. This means that you can paste doctests from
3244 3244 files or docstrings (even if they have leading whitespace), and the
3245 3245 code will execute correctly. You can then use '%history -tn' to see
3246 3246 the translated history without line numbers; this will give you the
3247 3247 input after removal of all the leading prompts and whitespace, which
3248 3248 can be pasted back into an editor.
3249 3249
3250 3250 With these features, you can switch into this mode easily whenever you
3251 3251 need to do testing and changes to doctests, without having to leave
3252 3252 your existing IPython session.
3253 3253 """
3254 3254
3255 3255 # XXX - Fix this to have cleaner activate/deactivate calls.
3256 3256 from IPython.Extensions import InterpreterPasteInput as ipaste
3257 3257 from IPython.ipstruct import Struct
3258 3258
3259 3259 # Shorthands
3260 3260 shell = self.shell
3261 3261 oc = shell.outputcache
3262 3262 rc = shell.rc
3263 3263 meta = shell.meta
3264 3264 # dstore is a data store kept in the instance metadata bag to track any
3265 3265 # changes we make, so we can undo them later.
3266 3266 dstore = meta.setdefault('doctest_mode',Struct())
3267 3267 save_dstore = dstore.setdefault
3268 3268
3269 3269 # save a few values we'll need to recover later
3270 3270 mode = save_dstore('mode',False)
3271 3271 save_dstore('rc_pprint',rc.pprint)
3272 3272 save_dstore('xmode',shell.InteractiveTB.mode)
3273 3273 save_dstore('rc_separate_out',rc.separate_out)
3274 3274 save_dstore('rc_separate_out2',rc.separate_out2)
3275 3275 save_dstore('rc_prompts_pad_left',rc.prompts_pad_left)
3276 3276
3277 3277 if mode == False:
3278 3278 # turn on
3279 3279 ipaste.activate_prefilter()
3280 3280
3281 3281 oc.prompt1.p_template = '>>> '
3282 3282 oc.prompt2.p_template = '... '
3283 3283 oc.prompt_out.p_template = ''
3284 3284
3285 3285 oc.output_sep = ''
3286 3286 oc.output_sep2 = ''
3287 3287
3288 3288 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3289 3289 oc.prompt_out.pad_left = False
3290 3290
3291 3291 rc.pprint = False
3292 3292
3293 3293 shell.magic_xmode('Plain')
3294 3294
3295 3295 else:
3296 3296 # turn off
3297 3297 ipaste.deactivate_prefilter()
3298 3298
3299 3299 oc.prompt1.p_template = rc.prompt_in1
3300 3300 oc.prompt2.p_template = rc.prompt_in2
3301 3301 oc.prompt_out.p_template = rc.prompt_out
3302 3302
3303 3303 oc.output_sep = dstore.rc_separate_out
3304 3304 oc.output_sep2 = dstore.rc_separate_out2
3305 3305
3306 3306 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3307 3307 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3308 3308
3309 3309 rc.pprint = dstore.rc_pprint
3310 3310
3311 3311 shell.magic_xmode(dstore.xmode)
3312 3312
3313 3313 # Store new mode and inform
3314 3314 dstore.mode = bool(1-int(mode))
3315 3315 print 'Doctest mode is:',
3316 3316 print ['OFF','ON'][dstore.mode]
3317 3317
3318 3318 # end Magic
@@ -1,141 +1,157 b''
1 1 """
2 2 Frontend class that uses IPython0 to prefilter the inputs.
3 3
4 4 Using the IPython0 mechanism gives us access to the magics.
5 5 """
6 6 __docformat__ = "restructuredtext en"
7 7
8 8 #-------------------------------------------------------------------------------
9 9 # Copyright (C) 2008 The IPython Development Team
10 10 #
11 11 # Distributed under the terms of the BSD License. The full license is in
12 12 # the file COPYING, distributed as part of this software.
13 13 #-------------------------------------------------------------------------------
14 14
15 15 #-------------------------------------------------------------------------------
16 16 # Imports
17 17 #-------------------------------------------------------------------------------
18 18 import sys
19 19
20 20 from linefrontendbase import LineFrontEndBase, common_prefix
21 21
22 22 from IPython.ipmaker import make_IPython
23 23 from IPython.ipapi import IPApi
24 24 from IPython.kernel.core.sync_output_trap import SyncOutputTrap
25 25
26 26 from IPython.genutils import Term
27 import pydoc
27 28
28 29 #-------------------------------------------------------------------------------
29 30 # Utility functions (temporary, should be moved out of here)
30 31 #-------------------------------------------------------------------------------
31 32 import os
32 33 def xterm_system(command):
33 34 """ Run a command in a separate console window.
34 35 """
35 36 os.system("""
36 37 xterm -title "%s" -e \'/bin/sh -c "%s ;
37 38 printf \\"\\\\n\\";
38 39 printf \\"press a key to close\\" ;
39 40 printf \\"\x1b]0;%s (finished -- press a key to close)\x07\\" ;
40 41 read foo;"\'
41 42 """ % (command, command, command) )
42 43
43 44 #-------------------------------------------------------------------------------
44 45 # Frontend class using ipython0 to do the prefiltering.
45 46 #-------------------------------------------------------------------------------
46 47 class PrefilterFrontEnd(LineFrontEndBase):
47 48
48 49 def __init__(self, *args, **kwargs):
49 50 LineFrontEndBase.__init__(self, *args, **kwargs)
50 51 # Instanciate an IPython0 interpreter to be able to use the
51 52 # prefiltering.
52 53 self.ipython0 = make_IPython()
53 54 # Set the pager:
54 55 self.ipython0.set_hook('show_in_pager',
55 56 lambda s, string: self.write("\n"+string))
56 57 self.ipython0.write = self.write
57 58 self._ip = _ip = IPApi(self.ipython0)
58 59 # XXX: Hack: mix the two namespaces
59 60 self.shell.user_ns = self.ipython0.user_ns
60 61 self.shell.user_global_ns = self.ipython0.user_global_ns
61 62 # Make sure the raw system call doesn't get called, as we don't
62 63 # have a stdin accessible.
63 64 self._ip.system = xterm_system
64 65 # Redefine a serie of magics to avoid os.system:
65 66 # FIXME: I am redefining way too much magics.
66 67 for alias_name, (_, alias_value) in \
67 68 _ip.IP.shell.alias_table.iteritems():
68 69 magic = lambda s : _ip.magic('sx %s %s' % (alias_value, s))
69 70 setattr(_ip.IP, 'magic_%s' % alias_name, magic)
70 71 # FIXME: I should create a real file-like object dedicated to this
71 72 # terminal
72 73 self.shell.output_trap = SyncOutputTrap(write_out=self.write,
73 74 write_err=self.write)
74
75 import pydoc
76 pydoc.help.output = self.shell.output_trap.out
75 # Capture and release the outputs, to make sure all the
76 # shadow variables are set
77 self.capture_output()
78 self.release_output()
77 79
78 80
79 81 def prefilter_input(self, input_string):
80 82 """ Using IPython0 to prefilter the commands.
81 83 """
82 84 input_string = LineFrontEndBase.prefilter_input(self, input_string)
83 85 filtered_lines = []
84 86 # The IPython0 prefilters sometime produce output. We need to
85 87 # capture it.
86 88 self.capture_output()
87 89 self.last_result = dict(number=self.prompt_number)
88 90 try:
89 91 for line in input_string.split('\n'):
90 92 filtered_lines.append(self.ipython0.prefilter(line, False))
91 93 except:
92 94 # XXX: probably not the right thing to do.
93 95 self.ipython0.showsyntaxerror()
94 96 self.after_execute()
95 97 finally:
96 98 self.release_output()
97 99
98 100 filtered_string = '\n'.join(filtered_lines)
99 101 return filtered_string
100 102
101 103
102 104 def show_traceback(self):
103 105 self.capture_output()
104 106 self.ipython0.showtraceback()
105 107 self.release_output()
106 108
107 109
110 def execute(self, python_string, raw_string=None):
111 self.capture_output()
112 LineFrontEndBase.execute(self, python_string,
113 raw_string=raw_string)
114 self.release_output()
115
116
108 117 def capture_output(self):
109 """ Capture all the output mechanism we can think of.
118 """ Capture all the output mechanisms we can think of.
110 119 """
111 120 self.__old_cout_write = Term.cout.write
112 121 self.__old_err_write = Term.cerr.write
113 122 Term.cout.write = self.write
114 123 Term.cerr.write = self.write
115 124 self.__old_stdout = sys.stdout
116 125 self.__old_stderr= sys.stderr
117 126 sys.stdout = Term.cout
118 127 sys.stderr = Term.cerr
128 self.__old_help_output = pydoc.help.output
129 pydoc.help.output = self.shell.output_trap.out
119 130
120 131
121 132 def release_output(self):
122 """ Release all the different captures we have made,
123 and flush the buffers.
133 """ Release all the different captures we have made.
124 134 """
125 135 Term.cout.write = self.__old_cout_write
126 136 Term.cerr.write = self.__old_err_write
127 137 sys.stdout = self.__old_stdout
128 138 sys.stderr = self.__old_stderr
139 pydoc.help.output = self.__old_help_output
129 140
130 141
131 142 def complete(self, line):
132 143 word = line.split('\n')[-1].split(' ')[-1]
133 144 completions = self.ipython0.complete(word)
134 145 key = lambda x: x.replace('_', '')
135 146 completions.sort(key=key)
136 147 if completions:
137 148 prefix = common_prefix(completions)
138 149 line = line[:-len(word)] + prefix
139 150 return line, completions
140 151
141 152
153 def do_exit(self):
154 """ Exit the shell, cleanup and save the history.
155 """
156 self.ipython0.atexit_operations()
157
@@ -1,254 +1,262 b''
1 1 # encoding: utf-8 -*- test-case-name:
2 2 # FIXME: Need to add tests.
3 3 # ipython1.frontend.cocoa.tests.test_cocoa_frontend -*-
4 4
5 5 """Classes to provide a Wx frontend to the
6 6 IPython.kernel.core.interpreter.
7 7
8 8 """
9 9
10 10 __docformat__ = "restructuredtext en"
11 11
12 12 #-------------------------------------------------------------------------------
13 13 # Copyright (C) 2008 The IPython Development Team
14 14 #
15 15 # Distributed under the terms of the BSD License. The full license is in
16 16 # the file COPYING, distributed as part of this software.
17 17 #-------------------------------------------------------------------------------
18 18
19 19 #-------------------------------------------------------------------------------
20 20 # Imports
21 21 #-------------------------------------------------------------------------------
22 22
23 23
24 24 import wx
25 25 import re
26 26 from wx import stc
27 27 from console_widget import ConsoleWidget
28 28 import __builtin__
29 29 from time import sleep
30 30
31 31 from IPython.frontend.prefilterfrontend import PrefilterFrontEnd
32 32
33 33 #_COMMAND_BG = '#FAFAF1' # Nice green
34 34 _RUNNING_BUFFER_BG = '#FDFFD3' # Nice yellow
35 35 _ERROR_BG = '#FFF1F1' # Nice red
36 36
37 37 _RUNNING_BUFFER_MARKER = 31
38 38 _ERROR_MARKER = 30
39 39
40 40 #-------------------------------------------------------------------------------
41 41 # Classes to implement the Wx frontend
42 42 #-------------------------------------------------------------------------------
43 43 class WxController(PrefilterFrontEnd, ConsoleWidget):
44 44
45 45 output_prompt = \
46 46 '\x01\x1b[0;31m\x02Out[\x01\x1b[1;31m\x02%i\x01\x1b[0;31m\x02]: \x01\x1b[0m\x02'
47 47
48 48 #--------------------------------------------------------------------------
49 49 # Public API
50 50 #--------------------------------------------------------------------------
51 51
52 52 def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition,
53 53 size=wx.DefaultSize, style=wx.CLIP_CHILDREN,
54 54 *args, **kwds):
55 55 """ Create Shell instance.
56 56 """
57 57 ConsoleWidget.__init__(self, parent, id, pos, size, style)
58 58 PrefilterFrontEnd.__init__(self)
59 59
60 60 # Capture Character keys
61 61 self.Bind(wx.EVT_KEY_DOWN, self._on_key_down)
62 62
63 63 # Marker for running buffer.
64 64 self.MarkerDefine(_RUNNING_BUFFER_MARKER, stc.STC_MARK_BACKGROUND,
65 65 background=_RUNNING_BUFFER_BG)
66 66 # Marker for tracebacks.
67 67 self.MarkerDefine(_ERROR_MARKER, stc.STC_MARK_BACKGROUND,
68 68 background=_ERROR_BG)
69 69
70 70
71 71
72 72 def do_completion(self):
73 73 """ Do code completion.
74 74 """
75 75 line = self.get_current_edit_buffer()
76 76 new_line, completions = self.complete(line)
77 77 if len(completions)>1:
78 78 self.write_completion(completions)
79 79 self.replace_current_edit_buffer(new_line)
80 80
81 81
82 82 def do_calltip(self):
83 83 separators = re.compile('[\s\{\}\[\]\(\)\= ,:]')
84 84 symbol = self.get_current_edit_buffer()
85 85 symbol_string = separators.split(symbol)[-1]
86 86 base_symbol_string = symbol_string.split('.')[0]
87 87 if base_symbol_string in self.shell.user_ns:
88 88 symbol = self.shell.user_ns[base_symbol_string]
89 89 elif base_symbol_string in self.shell.user_global_ns:
90 90 symbol = self.shell.user_global_ns[base_symbol_string]
91 91 elif base_symbol_string in __builtin__.__dict__:
92 92 symbol = __builtin__.__dict__[base_symbol_string]
93 93 else:
94 94 return False
95 95 for name in symbol_string.split('.')[1:] + ['__doc__']:
96 96 symbol = getattr(symbol, name)
97 97 try:
98 98 self.AutoCompCancel()
99 99 wx.Yield()
100 100 self.CallTipShow(self.GetCurrentPos(), symbol)
101 101 except:
102 102 # The retrieve symbol couldn't be converted to a string
103 103 pass
104 104
105 105
106 106 def popup_completion(self, create=False):
107 107 """ Updates the popup completion menu if it exists. If create is
108 108 true, open the menu.
109 109 """
110 110 line = self.get_current_edit_buffer()
111 111 if (self.AutoCompActive() and not line[-1] == '.') \
112 112 or create==True:
113 113 suggestion, completions = self.complete(line)
114 114 offset=0
115 115 if completions:
116 116 complete_sep = re.compile('[\s\{\}\[\]\(\)\= ,:]')
117 117 residual = complete_sep.split(line)[-1]
118 118 offset = len(residual)
119 119 self.pop_completion(completions, offset=offset)
120 120
121 121
122 122 def raw_input(self, prompt):
123 123 """ A replacement from python's raw_input.
124 124 """
125 125 self.new_prompt(prompt)
126 126 self.waiting = True
127 127 self.__old_on_enter = self._on_enter
128 128 def my_on_enter():
129 129 self.waiting = False
130 130 self._on_enter = my_on_enter
131 131 # XXX: Busy waiting, ugly.
132 132 while self.waiting:
133 133 wx.Yield()
134 134 sleep(0.1)
135 135 self._on_enter = self.__old_on_enter
136 136 return self.get_current_edit_buffer().rstrip('\n')
137 137
138 138
139 139 def execute(self, python_string, raw_string=None):
140 140 self.CallTipCancel()
141 141 self._cursor = wx.BusyCursor()
142 142 if raw_string is None:
143 143 raw_string = python_string
144 144 end_line = self.current_prompt_line \
145 145 + max(1, len(raw_string.split('\n'))-1)
146 146 for i in range(self.current_prompt_line, end_line):
147 147 self.MarkerAdd(i, _RUNNING_BUFFER_MARKER)
148 148 # Update the display:
149 149 wx.Yield()
150 150 ## Remove the trailing "\n" for cleaner display
151 151 #self.SetSelection(self.GetLength()-1, self.GetLength())
152 152 #self.ReplaceSelection('')
153 153 self.GotoPos(self.GetLength())
154 PrefilterFrontEnd.execute(self, python_string, raw_string=raw_string)
155
156
157 def capture_output(self):
154 158 self.__old_raw_input = __builtin__.raw_input
155 159 __builtin__.raw_input = self.raw_input
156 PrefilterFrontEnd.execute(self, python_string, raw_string=raw_string)
160 PrefilterFrontEnd.capture_output(self)
161
162
163 def release_output(self):
157 164 __builtin__.raw_input = self.__old_raw_input
165 PrefilterFrontEnd.capture_output(self)
158 166
159 167
160 168 def after_execute(self):
161 169 PrefilterFrontEnd.after_execute(self)
162 170 if hasattr(self, '_cursor'):
163 171 del self._cursor
164 172
165 173
166 174 def show_traceback(self):
167 175 start_line = self.GetCurrentLine()
168 176 PrefilterFrontEnd.show_traceback(self)
169 177 wx.Yield()
170 178 for i in range(start_line, self.GetCurrentLine()):
171 179 self.MarkerAdd(i, _ERROR_MARKER)
172 180
173 181
174 182 #--------------------------------------------------------------------------
175 183 # Private API
176 184 #--------------------------------------------------------------------------
177 185
178 186
179 187 def _on_key_down(self, event, skip=True):
180 188 """ Capture the character events, let the parent
181 189 widget handle them, and put our logic afterward.
182 190 """
183 191 current_line_number = self.GetCurrentLine()
184 192 # Calltips
185 193 if event.KeyCode == ord('('):
186 194 event.Skip()
187 195 self.do_calltip()
188 196 elif self.AutoCompActive():
189 197 event.Skip()
190 198 if event.KeyCode in (wx.WXK_BACK, wx.WXK_DELETE):
191 199 wx.CallAfter(self.popup_completion, create=True)
192 200 elif not event.KeyCode in (wx.WXK_UP, wx.WXK_DOWN, wx.WXK_LEFT,
193 201 wx.WXK_RIGHT):
194 202 wx.CallAfter(self.popup_completion)
195 203 else:
196 204 # Up history
197 205 if event.KeyCode == wx.WXK_UP and (
198 206 ( current_line_number == self.current_prompt_line and
199 207 event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN) )
200 208 or event.ControlDown() ):
201 209 new_buffer = self.get_history_previous(
202 210 self.get_current_edit_buffer())
203 211 if new_buffer is not None:
204 212 self.replace_current_edit_buffer(new_buffer)
205 213 if self.GetCurrentLine() > self.current_prompt_line:
206 214 # Go to first line, for seemless history up.
207 215 self.GotoPos(self.current_prompt_pos)
208 216 # Down history
209 217 elif event.KeyCode == wx.WXK_DOWN and (
210 218 ( current_line_number == self.LineCount -1 and
211 219 event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN) )
212 220 or event.ControlDown() ):
213 221 new_buffer = self.get_history_next()
214 222 if new_buffer is not None:
215 223 self.replace_current_edit_buffer(new_buffer)
216 224 # Tab-completion
217 225 elif event.KeyCode == ord('\t'):
218 226 last_line = self.get_current_edit_buffer().split('\n')[-1]
219 227 if not re.match(r'^\s*$', last_line):
220 228 self.do_completion()
221 229 else:
222 230 event.Skip()
223 231 else:
224 232 ConsoleWidget._on_key_down(self, event, skip=skip)
225 233
226 234
227 235 def _on_key_up(self, event, skip=True):
228 236 if event.KeyCode == 59:
229 237 # Intercepting '.'
230 238 event.Skip()
231 239 self.popup_completion(create=True)
232 240 else:
233 241 ConsoleWidget._on_key_up(self, event, skip=skip)
234 242
235 243
236 244 if __name__ == '__main__':
237 245 class MainWindow(wx.Frame):
238 246 def __init__(self, parent, id, title):
239 247 wx.Frame.__init__(self, parent, id, title, size=(300,250))
240 248 self._sizer = wx.BoxSizer(wx.VERTICAL)
241 249 self.shell = WxController(self)
242 250 self._sizer.Add(self.shell, 1, wx.EXPAND)
243 251 self.SetSizer(self._sizer)
244 252 self.SetAutoLayout(1)
245 253 self.Show(True)
246 254
247 255 app = wx.PySimpleApp()
248 256 frame = MainWindow(None, wx.ID_ANY, 'Ipython')
249 257 frame.shell.SetFocus()
250 258 frame.SetSize((680, 460))
251 259 self = frame.shell
252 260
253 261 app.MainLoop()
254 262
@@ -1,2686 +1,2691 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 9 """
10 10
11 11 #*****************************************************************************
12 12 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
13 13 # Copyright (C) 2001-2006 Fernando Perez. <fperez@colorado.edu>
14 14 #
15 15 # Distributed under the terms of the BSD License. The full license is in
16 16 # the file COPYING, distributed as part of this software.
17 17 #
18 18 # Note: this code originally subclassed code.InteractiveConsole from the
19 19 # Python standard library. Over time, all of that class has been copied
20 20 # verbatim here for modifications which could not be accomplished by
21 21 # subclassing. At this point, there are no dependencies at all on the code
22 22 # module anymore (it is not even imported). The Python License (sec. 2)
23 23 # allows for this, but it's always nice to acknowledge credit where credit is
24 24 # due.
25 25 #*****************************************************************************
26 26
27 27 #****************************************************************************
28 28 # Modules and globals
29 29
30 30 from IPython import Release
31 31 __author__ = '%s <%s>\n%s <%s>' % \
32 32 ( Release.authors['Janko'] + Release.authors['Fernando'] )
33 33 __license__ = Release.license
34 34 __version__ = Release.version
35 35
36 36 # Python standard modules
37 37 import __main__
38 38 import __builtin__
39 39 import StringIO
40 40 import bdb
41 41 import cPickle as pickle
42 42 import codeop
43 43 import exceptions
44 44 import glob
45 45 import inspect
46 46 import keyword
47 47 import new
48 48 import os
49 49 import pydoc
50 50 import re
51 51 import shutil
52 52 import string
53 53 import sys
54 54 import tempfile
55 55 import traceback
56 56 import types
57 57 import warnings
58 58 warnings.filterwarnings('ignore', r'.*sets module*')
59 59 from sets import Set
60 60 from pprint import pprint, pformat
61 61
62 62 # IPython's own modules
63 63 #import IPython
64 64 from IPython import Debugger,OInspect,PyColorize,ultraTB
65 65 from IPython.ColorANSI import ColorScheme,ColorSchemeTable # too long names
66 66 from IPython.Extensions import pickleshare
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 # Job manager (for jobs run as background threads)
223 223 self.jobs = BackgroundJobManager()
224 224
225 225 # Store the actual shell's name
226 226 self.name = name
227 227 self.more = False
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 # The user namespace MUST have a pointer to the shell itself.
320 320 self.user_ns[name] = self
321 321
322 322 # We need to insert into sys.modules something that looks like a
323 323 # module but which accesses the IPython namespace, for shelve and
324 324 # pickle to work interactively. Normally they rely on getting
325 325 # everything out of __main__, but for embedding purposes each IPython
326 326 # instance has its own private namespace, so we can't go shoving
327 327 # everything into __main__.
328 328
329 329 # note, however, that we should only do this for non-embedded
330 330 # ipythons, which really mimic the __main__.__dict__ with their own
331 331 # namespace. Embedded instances, on the other hand, should not do
332 332 # this because they need to manage the user local/global namespaces
333 333 # only, but they live within a 'normal' __main__ (meaning, they
334 334 # shouldn't overtake the execution environment of the script they're
335 335 # embedded in).
336 336
337 337 if not embedded:
338 338 try:
339 339 main_name = self.user_ns['__name__']
340 340 except KeyError:
341 341 raise KeyError,'user_ns dictionary MUST have a "__name__" key'
342 342 else:
343 343 #print "pickle hack in place" # dbg
344 344 #print 'main_name:',main_name # dbg
345 345 sys.modules[main_name] = FakeModule(self.user_ns)
346 346
347 347 # Now that FakeModule produces a real module, we've run into a nasty
348 348 # problem: after script execution (via %run), the module where the user
349 349 # code ran is deleted. Now that this object is a true module (needed
350 350 # so docetst and other tools work correctly), the Python module
351 351 # teardown mechanism runs over it, and sets to None every variable
352 352 # present in that module. This means that later calls to functions
353 353 # defined in the script (which have become interactively visible after
354 354 # script exit) fail, because they hold references to objects that have
355 355 # become overwritten into None. The only solution I see right now is
356 356 # to protect every FakeModule used by %run by holding an internal
357 357 # reference to it. This private list will be used for that. The
358 358 # %reset command will flush it as well.
359 359 self._user_main_modules = []
360 360
361 361 # List of input with multi-line handling.
362 362 # Fill its zero entry, user counter starts at 1
363 363 self.input_hist = InputList(['\n'])
364 364 # This one will hold the 'raw' input history, without any
365 365 # pre-processing. This will allow users to retrieve the input just as
366 366 # it was exactly typed in by the user, with %hist -r.
367 367 self.input_hist_raw = InputList(['\n'])
368 368
369 369 # list of visited directories
370 370 try:
371 371 self.dir_hist = [os.getcwd()]
372 372 except OSError:
373 373 self.dir_hist = []
374 374
375 375 # dict of output history
376 376 self.output_hist = {}
377 377
378 378 # Get system encoding at startup time. Certain terminals (like Emacs
379 379 # under Win32 have it set to None, and we need to have a known valid
380 380 # encoding to use in the raw_input() method
381 381 try:
382 382 self.stdin_encoding = sys.stdin.encoding or 'ascii'
383 383 except AttributeError:
384 384 self.stdin_encoding = 'ascii'
385 385
386 386 # dict of things NOT to alias (keywords, builtins and some magics)
387 387 no_alias = {}
388 388 no_alias_magics = ['cd','popd','pushd','dhist','alias','unalias']
389 389 for key in keyword.kwlist + no_alias_magics:
390 390 no_alias[key] = 1
391 391 no_alias.update(__builtin__.__dict__)
392 392 self.no_alias = no_alias
393 393
394 394 # make global variables for user access to these
395 395 self.user_ns['_ih'] = self.input_hist
396 396 self.user_ns['_oh'] = self.output_hist
397 397 self.user_ns['_dh'] = self.dir_hist
398 398
399 399 # user aliases to input and output histories
400 400 self.user_ns['In'] = self.input_hist
401 401 self.user_ns['Out'] = self.output_hist
402 402
403 403 self.user_ns['_sh'] = IPython.shadowns
404 404 # Object variable to store code object waiting execution. This is
405 405 # used mainly by the multithreaded shells, but it can come in handy in
406 406 # other situations. No need to use a Queue here, since it's a single
407 407 # item which gets cleared once run.
408 408 self.code_to_run = None
409 409
410 410 # escapes for automatic behavior on the command line
411 411 self.ESC_SHELL = '!'
412 412 self.ESC_SH_CAP = '!!'
413 413 self.ESC_HELP = '?'
414 414 self.ESC_MAGIC = '%'
415 415 self.ESC_QUOTE = ','
416 416 self.ESC_QUOTE2 = ';'
417 417 self.ESC_PAREN = '/'
418 418
419 419 # And their associated handlers
420 420 self.esc_handlers = {self.ESC_PAREN : self.handle_auto,
421 421 self.ESC_QUOTE : self.handle_auto,
422 422 self.ESC_QUOTE2 : self.handle_auto,
423 423 self.ESC_MAGIC : self.handle_magic,
424 424 self.ESC_HELP : self.handle_help,
425 425 self.ESC_SHELL : self.handle_shell_escape,
426 426 self.ESC_SH_CAP : self.handle_shell_escape,
427 427 }
428 428
429 429 # class initializations
430 430 Magic.__init__(self,self)
431 431
432 432 # Python source parser/formatter for syntax highlighting
433 433 pyformat = PyColorize.Parser().format
434 434 self.pycolorize = lambda src: pyformat(src,'str',self.rc['colors'])
435 435
436 436 # hooks holds pointers used for user-side customizations
437 437 self.hooks = Struct()
438 438
439 439 self.strdispatchers = {}
440 440
441 441 # Set all default hooks, defined in the IPython.hooks module.
442 442 hooks = IPython.hooks
443 443 for hook_name in hooks.__all__:
444 444 # default hooks have priority 100, i.e. low; user hooks should have
445 445 # 0-100 priority
446 446 self.set_hook(hook_name,getattr(hooks,hook_name), 100)
447 447 #print "bound hook",hook_name
448 448
449 449 # Flag to mark unconditional exit
450 450 self.exit_now = False
451 451
452 452 self.usage_min = """\
453 453 An enhanced console for Python.
454 454 Some of its features are:
455 455 - Readline support if the readline library is present.
456 456 - Tab completion in the local namespace.
457 457 - Logging of input, see command-line options.
458 458 - System shell escape via ! , eg !ls.
459 459 - Magic commands, starting with a % (like %ls, %pwd, %cd, etc.)
460 460 - Keeps track of locally defined variables via %who, %whos.
461 461 - Show object information with a ? eg ?x or x? (use ?? for more info).
462 462 """
463 463 if usage: self.usage = usage
464 464 else: self.usage = self.usage_min
465 465
466 466 # Storage
467 467 self.rc = rc # This will hold all configuration information
468 468 self.pager = 'less'
469 469 # temporary files used for various purposes. Deleted at exit.
470 470 self.tempfiles = []
471 471
472 472 # Keep track of readline usage (later set by init_readline)
473 473 self.has_readline = False
474 474
475 475 # template for logfile headers. It gets resolved at runtime by the
476 476 # logstart method.
477 477 self.loghead_tpl = \
478 478 """#log# Automatic Logger file. *** THIS MUST BE THE FIRST LINE ***
479 479 #log# DO NOT CHANGE THIS LINE OR THE TWO BELOW
480 480 #log# opts = %s
481 481 #log# args = %s
482 482 #log# It is safe to make manual edits below here.
483 483 #log#-----------------------------------------------------------------------
484 484 """
485 485 # for pushd/popd management
486 486 try:
487 487 self.home_dir = get_home_dir()
488 488 except HomeDirError,msg:
489 489 fatal(msg)
490 490
491 491 self.dir_stack = []
492 492
493 493 # Functions to call the underlying shell.
494 494
495 495 # The first is similar to os.system, but it doesn't return a value,
496 496 # and it allows interpolation of variables in the user's namespace.
497 497 self.system = lambda cmd: \
498 498 self.hooks.shell_hook(self.var_expand(cmd,depth=2))
499 499
500 500 # These are for getoutput and getoutputerror:
501 501 self.getoutput = lambda cmd: \
502 502 getoutput(self.var_expand(cmd,depth=2),
503 503 header=self.rc.system_header,
504 504 verbose=self.rc.system_verbose)
505 505
506 506 self.getoutputerror = lambda cmd: \
507 507 getoutputerror(self.var_expand(cmd,depth=2),
508 508 header=self.rc.system_header,
509 509 verbose=self.rc.system_verbose)
510 510
511 511
512 512 # keep track of where we started running (mainly for crash post-mortem)
513 513 self.starting_dir = os.getcwd()
514 514
515 515 # Various switches which can be set
516 516 self.CACHELENGTH = 5000 # this is cheap, it's just text
517 517 self.BANNER = "Python %(version)s on %(platform)s\n" % sys.__dict__
518 518 self.banner2 = banner2
519 519
520 520 # TraceBack handlers:
521 521
522 522 # Syntax error handler.
523 523 self.SyntaxTB = SyntaxTB(color_scheme='NoColor')
524 524
525 525 # The interactive one is initialized with an offset, meaning we always
526 526 # want to remove the topmost item in the traceback, which is our own
527 527 # internal code. Valid modes: ['Plain','Context','Verbose']
528 528 self.InteractiveTB = ultraTB.AutoFormattedTB(mode = 'Plain',
529 529 color_scheme='NoColor',
530 530 tb_offset = 1)
531 531
532 532 # IPython itself shouldn't crash. This will produce a detailed
533 533 # post-mortem if it does. But we only install the crash handler for
534 534 # non-threaded shells, the threaded ones use a normal verbose reporter
535 535 # and lose the crash handler. This is because exceptions in the main
536 536 # thread (such as in GUI code) propagate directly to sys.excepthook,
537 537 # and there's no point in printing crash dumps for every user exception.
538 538 if self.isthreaded:
539 539 ipCrashHandler = ultraTB.FormattedTB()
540 540 else:
541 541 from IPython import CrashHandler
542 542 ipCrashHandler = CrashHandler.IPythonCrashHandler(self)
543 543 self.set_crash_handler(ipCrashHandler)
544 544
545 545 # and add any custom exception handlers the user may have specified
546 546 self.set_custom_exc(*custom_exceptions)
547 547
548 548 # indentation management
549 549 self.autoindent = False
550 550 self.indent_current_nsp = 0
551 551
552 552 # Make some aliases automatically
553 553 # Prepare list of shell aliases to auto-define
554 554 if os.name == 'posix':
555 555 auto_alias = ('mkdir mkdir', 'rmdir rmdir',
556 556 'mv mv -i','rm rm -i','cp cp -i',
557 557 'cat cat','less less','clear clear',
558 558 # a better ls
559 559 'ls ls -F',
560 560 # long ls
561 561 'll ls -lF')
562 562 # Extra ls aliases with color, which need special treatment on BSD
563 563 # variants
564 564 ls_extra = ( # color ls
565 565 'lc ls -F -o --color',
566 566 # ls normal files only
567 567 'lf ls -F -o --color %l | grep ^-',
568 568 # ls symbolic links
569 569 'lk ls -F -o --color %l | grep ^l',
570 570 # directories or links to directories,
571 571 'ldir ls -F -o --color %l | grep /$',
572 572 # things which are executable
573 573 'lx ls -F -o --color %l | grep ^-..x',
574 574 )
575 575 # The BSDs don't ship GNU ls, so they don't understand the
576 576 # --color switch out of the box
577 577 if 'bsd' in sys.platform:
578 578 ls_extra = ( # ls normal files only
579 579 'lf ls -lF | grep ^-',
580 580 # ls symbolic links
581 581 'lk ls -lF | grep ^l',
582 582 # directories or links to directories,
583 583 'ldir ls -lF | grep /$',
584 584 # things which are executable
585 585 'lx ls -lF | grep ^-..x',
586 586 )
587 587 auto_alias = auto_alias + ls_extra
588 588 elif os.name in ['nt','dos']:
589 589 auto_alias = ('ls dir /on',
590 590 'ddir dir /ad /on', 'ldir dir /ad /on',
591 591 'mkdir mkdir','rmdir rmdir','echo echo',
592 592 'ren ren','cls cls','copy copy')
593 593 else:
594 594 auto_alias = ()
595 595 self.auto_alias = [s.split(None,1) for s in auto_alias]
596 596
597 597
598 598 # Produce a public API instance
599 599 self.api = IPython.ipapi.IPApi(self)
600 600
601 601 # Call the actual (public) initializer
602 602 self.init_auto_alias()
603 603
604 604 # track which builtins we add, so we can clean up later
605 605 self.builtins_added = {}
606 606 # This method will add the necessary builtins for operation, but
607 607 # tracking what it did via the builtins_added dict.
608 608
609 609 #TODO: remove this, redundant
610 610 self.add_builtins()
611 611
612 612
613 613
614 614
615 615 # end __init__
616 616
617 617 def var_expand(self,cmd,depth=0):
618 618 """Expand python variables in a string.
619 619
620 620 The depth argument indicates how many frames above the caller should
621 621 be walked to look for the local namespace where to expand variables.
622 622
623 623 The global namespace for expansion is always the user's interactive
624 624 namespace.
625 625 """
626 626
627 627 return str(ItplNS(cmd,
628 628 self.user_ns, # globals
629 629 # Skip our own frame in searching for locals:
630 630 sys._getframe(depth+1).f_locals # locals
631 631 ))
632 632
633 633 def pre_config_initialization(self):
634 634 """Pre-configuration init method
635 635
636 636 This is called before the configuration files are processed to
637 637 prepare the services the config files might need.
638 638
639 639 self.rc already has reasonable default values at this point.
640 640 """
641 641 rc = self.rc
642 642 try:
643 643 self.db = pickleshare.PickleShareDB(rc.ipythondir + "/db")
644 644 except exceptions.UnicodeDecodeError:
645 645 print "Your ipythondir can't be decoded to unicode!"
646 646 print "Please set HOME environment variable to something that"
647 647 print r"only has ASCII characters, e.g. c:\home"
648 648 print "Now it is",rc.ipythondir
649 649 sys.exit()
650 650 self.shadowhist = IPython.history.ShadowHist(self.db)
651 651
652 652
653 653 def post_config_initialization(self):
654 654 """Post configuration init method
655 655
656 656 This is called after the configuration files have been processed to
657 657 'finalize' the initialization."""
658 658
659 659 rc = self.rc
660 660
661 661 # Object inspector
662 662 self.inspector = OInspect.Inspector(OInspect.InspectColors,
663 663 PyColorize.ANSICodeColors,
664 664 'NoColor',
665 665 rc.object_info_string_level)
666 666
667 667 self.rl_next_input = None
668 668 self.rl_do_indent = False
669 669 # Load readline proper
670 670 if rc.readline:
671 671 self.init_readline()
672 672
673 673
674 674 # local shortcut, this is used a LOT
675 675 self.log = self.logger.log
676 676
677 677 # Initialize cache, set in/out prompts and printing system
678 678 self.outputcache = CachedOutput(self,
679 679 rc.cache_size,
680 680 rc.pprint,
681 681 input_sep = rc.separate_in,
682 682 output_sep = rc.separate_out,
683 683 output_sep2 = rc.separate_out2,
684 684 ps1 = rc.prompt_in1,
685 685 ps2 = rc.prompt_in2,
686 686 ps_out = rc.prompt_out,
687 687 pad_left = rc.prompts_pad_left)
688 688
689 689 # user may have over-ridden the default print hook:
690 690 try:
691 691 self.outputcache.__class__.display = self.hooks.display
692 692 except AttributeError:
693 693 pass
694 694
695 695 # I don't like assigning globally to sys, because it means when
696 696 # embedding instances, each embedded instance overrides the previous
697 697 # choice. But sys.displayhook seems to be called internally by exec,
698 698 # so I don't see a way around it. We first save the original and then
699 699 # overwrite it.
700 700 self.sys_displayhook = sys.displayhook
701 701 sys.displayhook = self.outputcache
702 702
703 703 # Do a proper resetting of doctest, including the necessary displayhook
704 704 # monkeypatching
705 705 try:
706 706 doctest_reload()
707 707 except ImportError:
708 708 warn("doctest module does not exist.")
709 709
710 710 # Set user colors (don't do it in the constructor above so that it
711 711 # doesn't crash if colors option is invalid)
712 712 self.magic_colors(rc.colors)
713 713
714 714 # Set calling of pdb on exceptions
715 715 self.call_pdb = rc.pdb
716 716
717 717 # Load user aliases
718 718 for alias in rc.alias:
719 719 self.magic_alias(alias)
720 720
721 721 self.hooks.late_startup_hook()
722 722
723 723 for cmd in self.rc.autoexec:
724 724 #print "autoexec>",cmd #dbg
725 725 self.api.runlines(cmd)
726 726
727 727 batchrun = False
728 728 for batchfile in [path(arg) for arg in self.rc.args
729 729 if arg.lower().endswith('.ipy')]:
730 730 if not batchfile.isfile():
731 731 print "No such batch file:", batchfile
732 732 continue
733 733 self.api.runlines(batchfile.text())
734 734 batchrun = True
735 735 # without -i option, exit after running the batch file
736 736 if batchrun and not self.rc.interact:
737 self.exit_now = True
737 self.ask_exit()
738 738
739 739 def add_builtins(self):
740 740 """Store ipython references into the builtin namespace.
741 741
742 742 Some parts of ipython operate via builtins injected here, which hold a
743 743 reference to IPython itself."""
744 744
745 745 # TODO: deprecate all of these, they are unsafe
746 746 builtins_new = dict(__IPYTHON__ = self,
747 747 ip_set_hook = self.set_hook,
748 748 jobs = self.jobs,
749 749 ipmagic = wrap_deprecated(self.ipmagic,'_ip.magic()'),
750 750 ipalias = wrap_deprecated(self.ipalias),
751 751 ipsystem = wrap_deprecated(self.ipsystem,'_ip.system()'),
752 752 #_ip = self.api
753 753 )
754 754 for biname,bival in builtins_new.items():
755 755 try:
756 756 # store the orignal value so we can restore it
757 757 self.builtins_added[biname] = __builtin__.__dict__[biname]
758 758 except KeyError:
759 759 # or mark that it wasn't defined, and we'll just delete it at
760 760 # cleanup
761 761 self.builtins_added[biname] = Undefined
762 762 __builtin__.__dict__[biname] = bival
763 763
764 764 # Keep in the builtins a flag for when IPython is active. We set it
765 765 # with setdefault so that multiple nested IPythons don't clobber one
766 766 # another. Each will increase its value by one upon being activated,
767 767 # which also gives us a way to determine the nesting level.
768 768 __builtin__.__dict__.setdefault('__IPYTHON__active',0)
769 769
770 770 def clean_builtins(self):
771 771 """Remove any builtins which might have been added by add_builtins, or
772 772 restore overwritten ones to their previous values."""
773 773 for biname,bival in self.builtins_added.items():
774 774 if bival is Undefined:
775 775 del __builtin__.__dict__[biname]
776 776 else:
777 777 __builtin__.__dict__[biname] = bival
778 778 self.builtins_added.clear()
779 779
780 780 def set_hook(self,name,hook, priority = 50, str_key = None, re_key = None):
781 781 """set_hook(name,hook) -> sets an internal IPython hook.
782 782
783 783 IPython exposes some of its internal API as user-modifiable hooks. By
784 784 adding your function to one of these hooks, you can modify IPython's
785 785 behavior to call at runtime your own routines."""
786 786
787 787 # At some point in the future, this should validate the hook before it
788 788 # accepts it. Probably at least check that the hook takes the number
789 789 # of args it's supposed to.
790 790
791 791 f = new.instancemethod(hook,self,self.__class__)
792 792
793 793 # check if the hook is for strdispatcher first
794 794 if str_key is not None:
795 795 sdp = self.strdispatchers.get(name, StrDispatch())
796 796 sdp.add_s(str_key, f, priority )
797 797 self.strdispatchers[name] = sdp
798 798 return
799 799 if re_key is not None:
800 800 sdp = self.strdispatchers.get(name, StrDispatch())
801 801 sdp.add_re(re.compile(re_key), f, priority )
802 802 self.strdispatchers[name] = sdp
803 803 return
804 804
805 805 dp = getattr(self.hooks, name, None)
806 806 if name not in IPython.hooks.__all__:
807 807 print "Warning! Hook '%s' is not one of %s" % (name, IPython.hooks.__all__ )
808 808 if not dp:
809 809 dp = IPython.hooks.CommandChainDispatcher()
810 810
811 811 try:
812 812 dp.add(f,priority)
813 813 except AttributeError:
814 814 # it was not commandchain, plain old func - replace
815 815 dp = f
816 816
817 817 setattr(self.hooks,name, dp)
818 818
819 819
820 820 #setattr(self.hooks,name,new.instancemethod(hook,self,self.__class__))
821 821
822 822 def set_crash_handler(self,crashHandler):
823 823 """Set the IPython crash handler.
824 824
825 825 This must be a callable with a signature suitable for use as
826 826 sys.excepthook."""
827 827
828 828 # Install the given crash handler as the Python exception hook
829 829 sys.excepthook = crashHandler
830 830
831 831 # The instance will store a pointer to this, so that runtime code
832 832 # (such as magics) can access it. This is because during the
833 833 # read-eval loop, it gets temporarily overwritten (to deal with GUI
834 834 # frameworks).
835 835 self.sys_excepthook = sys.excepthook
836 836
837 837
838 838 def set_custom_exc(self,exc_tuple,handler):
839 839 """set_custom_exc(exc_tuple,handler)
840 840
841 841 Set a custom exception handler, which will be called if any of the
842 842 exceptions in exc_tuple occur in the mainloop (specifically, in the
843 843 runcode() method.
844 844
845 845 Inputs:
846 846
847 847 - exc_tuple: a *tuple* of valid exceptions to call the defined
848 848 handler for. It is very important that you use a tuple, and NOT A
849 849 LIST here, because of the way Python's except statement works. If
850 850 you only want to trap a single exception, use a singleton tuple:
851 851
852 852 exc_tuple == (MyCustomException,)
853 853
854 854 - handler: this must be defined as a function with the following
855 855 basic interface: def my_handler(self,etype,value,tb).
856 856
857 857 This will be made into an instance method (via new.instancemethod)
858 858 of IPython itself, and it will be called if any of the exceptions
859 859 listed in the exc_tuple are caught. If the handler is None, an
860 860 internal basic one is used, which just prints basic info.
861 861
862 862 WARNING: by putting in your own exception handler into IPython's main
863 863 execution loop, you run a very good chance of nasty crashes. This
864 864 facility should only be used if you really know what you are doing."""
865 865
866 866 assert type(exc_tuple)==type(()) , \
867 867 "The custom exceptions must be given AS A TUPLE."
868 868
869 869 def dummy_handler(self,etype,value,tb):
870 870 print '*** Simple custom exception handler ***'
871 871 print 'Exception type :',etype
872 872 print 'Exception value:',value
873 873 print 'Traceback :',tb
874 874 print 'Source code :','\n'.join(self.buffer)
875 875
876 876 if handler is None: handler = dummy_handler
877 877
878 878 self.CustomTB = new.instancemethod(handler,self,self.__class__)
879 879 self.custom_exceptions = exc_tuple
880 880
881 881 def set_custom_completer(self,completer,pos=0):
882 882 """set_custom_completer(completer,pos=0)
883 883
884 884 Adds a new custom completer function.
885 885
886 886 The position argument (defaults to 0) is the index in the completers
887 887 list where you want the completer to be inserted."""
888 888
889 889 newcomp = new.instancemethod(completer,self.Completer,
890 890 self.Completer.__class__)
891 891 self.Completer.matchers.insert(pos,newcomp)
892 892
893 893 def set_completer(self):
894 894 """reset readline's completer to be our own."""
895 895 self.readline.set_completer(self.Completer.complete)
896 896
897 897 def _get_call_pdb(self):
898 898 return self._call_pdb
899 899
900 900 def _set_call_pdb(self,val):
901 901
902 902 if val not in (0,1,False,True):
903 903 raise ValueError,'new call_pdb value must be boolean'
904 904
905 905 # store value in instance
906 906 self._call_pdb = val
907 907
908 908 # notify the actual exception handlers
909 909 self.InteractiveTB.call_pdb = val
910 910 if self.isthreaded:
911 911 try:
912 912 self.sys_excepthook.call_pdb = val
913 913 except:
914 914 warn('Failed to activate pdb for threaded exception handler')
915 915
916 916 call_pdb = property(_get_call_pdb,_set_call_pdb,None,
917 917 'Control auto-activation of pdb at exceptions')
918 918
919 919
920 920 # These special functions get installed in the builtin namespace, to
921 921 # provide programmatic (pure python) access to magics, aliases and system
922 922 # calls. This is important for logging, user scripting, and more.
923 923
924 924 # We are basically exposing, via normal python functions, the three
925 925 # mechanisms in which ipython offers special call modes (magics for
926 926 # internal control, aliases for direct system access via pre-selected
927 927 # names, and !cmd for calling arbitrary system commands).
928 928
929 929 def ipmagic(self,arg_s):
930 930 """Call a magic function by name.
931 931
932 932 Input: a string containing the name of the magic function to call and any
933 933 additional arguments to be passed to the magic.
934 934
935 935 ipmagic('name -opt foo bar') is equivalent to typing at the ipython
936 936 prompt:
937 937
938 938 In[1]: %name -opt foo bar
939 939
940 940 To call a magic without arguments, simply use ipmagic('name').
941 941
942 942 This provides a proper Python function to call IPython's magics in any
943 943 valid Python code you can type at the interpreter, including loops and
944 944 compound statements. It is added by IPython to the Python builtin
945 945 namespace upon initialization."""
946 946
947 947 args = arg_s.split(' ',1)
948 948 magic_name = args[0]
949 949 magic_name = magic_name.lstrip(self.ESC_MAGIC)
950 950
951 951 try:
952 952 magic_args = args[1]
953 953 except IndexError:
954 954 magic_args = ''
955 955 fn = getattr(self,'magic_'+magic_name,None)
956 956 if fn is None:
957 957 error("Magic function `%s` not found." % magic_name)
958 958 else:
959 959 magic_args = self.var_expand(magic_args,1)
960 960 return fn(magic_args)
961 961
962 962 def ipalias(self,arg_s):
963 963 """Call an alias by name.
964 964
965 965 Input: a string containing the name of the alias to call and any
966 966 additional arguments to be passed to the magic.
967 967
968 968 ipalias('name -opt foo bar') is equivalent to typing at the ipython
969 969 prompt:
970 970
971 971 In[1]: name -opt foo bar
972 972
973 973 To call an alias without arguments, simply use ipalias('name').
974 974
975 975 This provides a proper Python function to call IPython's aliases in any
976 976 valid Python code you can type at the interpreter, including loops and
977 977 compound statements. It is added by IPython to the Python builtin
978 978 namespace upon initialization."""
979 979
980 980 args = arg_s.split(' ',1)
981 981 alias_name = args[0]
982 982 try:
983 983 alias_args = args[1]
984 984 except IndexError:
985 985 alias_args = ''
986 986 if alias_name in self.alias_table:
987 987 self.call_alias(alias_name,alias_args)
988 988 else:
989 989 error("Alias `%s` not found." % alias_name)
990 990
991 991 def ipsystem(self,arg_s):
992 992 """Make a system call, using IPython."""
993 993
994 994 self.system(arg_s)
995 995
996 996 def complete(self,text):
997 997 """Return a sorted list of all possible completions on text.
998 998
999 999 Inputs:
1000 1000
1001 1001 - text: a string of text to be completed on.
1002 1002
1003 1003 This is a wrapper around the completion mechanism, similar to what
1004 1004 readline does at the command line when the TAB key is hit. By
1005 1005 exposing it as a method, it can be used by other non-readline
1006 1006 environments (such as GUIs) for text completion.
1007 1007
1008 1008 Simple usage example:
1009 1009
1010 1010 In [1]: x = 'hello'
1011 1011
1012 1012 In [2]: __IP.complete('x.l')
1013 1013 Out[2]: ['x.ljust', 'x.lower', 'x.lstrip']"""
1014 1014
1015 1015 complete = self.Completer.complete
1016 1016 state = 0
1017 1017 # use a dict so we get unique keys, since ipyhton's multiple
1018 1018 # completers can return duplicates. When we make 2.4 a requirement,
1019 1019 # start using sets instead, which are faster.
1020 1020 comps = {}
1021 1021 while True:
1022 1022 newcomp = complete(text,state,line_buffer=text)
1023 1023 if newcomp is None:
1024 1024 break
1025 1025 comps[newcomp] = 1
1026 1026 state += 1
1027 1027 outcomps = comps.keys()
1028 1028 outcomps.sort()
1029 1029 return outcomps
1030 1030
1031 1031 def set_completer_frame(self, frame=None):
1032 1032 if frame:
1033 1033 self.Completer.namespace = frame.f_locals
1034 1034 self.Completer.global_namespace = frame.f_globals
1035 1035 else:
1036 1036 self.Completer.namespace = self.user_ns
1037 1037 self.Completer.global_namespace = self.user_global_ns
1038 1038
1039 1039 def init_auto_alias(self):
1040 1040 """Define some aliases automatically.
1041 1041
1042 1042 These are ALL parameter-less aliases"""
1043 1043
1044 1044 for alias,cmd in self.auto_alias:
1045 1045 self.getapi().defalias(alias,cmd)
1046 1046
1047 1047
1048 1048 def alias_table_validate(self,verbose=0):
1049 1049 """Update information about the alias table.
1050 1050
1051 1051 In particular, make sure no Python keywords/builtins are in it."""
1052 1052
1053 1053 no_alias = self.no_alias
1054 1054 for k in self.alias_table.keys():
1055 1055 if k in no_alias:
1056 1056 del self.alias_table[k]
1057 1057 if verbose:
1058 1058 print ("Deleting alias <%s>, it's a Python "
1059 1059 "keyword or builtin." % k)
1060 1060
1061 1061 def set_autoindent(self,value=None):
1062 1062 """Set the autoindent flag, checking for readline support.
1063 1063
1064 1064 If called with no arguments, it acts as a toggle."""
1065 1065
1066 1066 if not self.has_readline:
1067 1067 if os.name == 'posix':
1068 1068 warn("The auto-indent feature requires the readline library")
1069 1069 self.autoindent = 0
1070 1070 return
1071 1071 if value is None:
1072 1072 self.autoindent = not self.autoindent
1073 1073 else:
1074 1074 self.autoindent = value
1075 1075
1076 1076 def rc_set_toggle(self,rc_field,value=None):
1077 1077 """Set or toggle a field in IPython's rc config. structure.
1078 1078
1079 1079 If called with no arguments, it acts as a toggle.
1080 1080
1081 1081 If called with a non-existent field, the resulting AttributeError
1082 1082 exception will propagate out."""
1083 1083
1084 1084 rc_val = getattr(self.rc,rc_field)
1085 1085 if value is None:
1086 1086 value = not rc_val
1087 1087 setattr(self.rc,rc_field,value)
1088 1088
1089 1089 def user_setup(self,ipythondir,rc_suffix,mode='install'):
1090 1090 """Install the user configuration directory.
1091 1091
1092 1092 Can be called when running for the first time or to upgrade the user's
1093 1093 .ipython/ directory with the mode parameter. Valid modes are 'install'
1094 1094 and 'upgrade'."""
1095 1095
1096 1096 def wait():
1097 1097 try:
1098 1098 raw_input("Please press <RETURN> to start IPython.")
1099 1099 except EOFError:
1100 1100 print >> Term.cout
1101 1101 print '*'*70
1102 1102
1103 1103 cwd = os.getcwd() # remember where we started
1104 1104 glb = glob.glob
1105 1105 print '*'*70
1106 1106 if mode == 'install':
1107 1107 print \
1108 1108 """Welcome to IPython. I will try to create a personal configuration directory
1109 1109 where you can customize many aspects of IPython's functionality in:\n"""
1110 1110 else:
1111 1111 print 'I am going to upgrade your configuration in:'
1112 1112
1113 1113 print ipythondir
1114 1114
1115 1115 rcdirend = os.path.join('IPython','UserConfig')
1116 1116 cfg = lambda d: os.path.join(d,rcdirend)
1117 1117 try:
1118 1118 rcdir = filter(os.path.isdir,map(cfg,sys.path))[0]
1119 1119 print "Initializing from configuration",rcdir
1120 1120 except IndexError:
1121 1121 warning = """
1122 1122 Installation error. IPython's directory was not found.
1123 1123
1124 1124 Check the following:
1125 1125
1126 1126 The ipython/IPython directory should be in a directory belonging to your
1127 1127 PYTHONPATH environment variable (that is, it should be in a directory
1128 1128 belonging to sys.path). You can copy it explicitly there or just link to it.
1129 1129
1130 1130 IPython will create a minimal default configuration for you.
1131 1131
1132 1132 """
1133 1133 warn(warning)
1134 1134 wait()
1135 1135
1136 1136 if sys.platform =='win32':
1137 1137 inif = 'ipythonrc.ini'
1138 1138 else:
1139 1139 inif = 'ipythonrc'
1140 1140 minimal_setup = {'ipy_user_conf.py' : 'import ipy_defaults', inif : '# intentionally left blank' }
1141 1141 os.makedirs(ipythondir, mode = 0777)
1142 1142 for f, cont in minimal_setup.items():
1143 1143 open(ipythondir + '/' + f,'w').write(cont)
1144 1144
1145 1145 return
1146 1146
1147 1147 if mode == 'install':
1148 1148 try:
1149 1149 shutil.copytree(rcdir,ipythondir)
1150 1150 os.chdir(ipythondir)
1151 1151 rc_files = glb("ipythonrc*")
1152 1152 for rc_file in rc_files:
1153 1153 os.rename(rc_file,rc_file+rc_suffix)
1154 1154 except:
1155 1155 warning = """
1156 1156
1157 1157 There was a problem with the installation:
1158 1158 %s
1159 1159 Try to correct it or contact the developers if you think it's a bug.
1160 1160 IPython will proceed with builtin defaults.""" % sys.exc_info()[1]
1161 1161 warn(warning)
1162 1162 wait()
1163 1163 return
1164 1164
1165 1165 elif mode == 'upgrade':
1166 1166 try:
1167 1167 os.chdir(ipythondir)
1168 1168 except:
1169 1169 print """
1170 1170 Can not upgrade: changing to directory %s failed. Details:
1171 1171 %s
1172 1172 """ % (ipythondir,sys.exc_info()[1])
1173 1173 wait()
1174 1174 return
1175 1175 else:
1176 1176 sources = glb(os.path.join(rcdir,'[A-Za-z]*'))
1177 1177 for new_full_path in sources:
1178 1178 new_filename = os.path.basename(new_full_path)
1179 1179 if new_filename.startswith('ipythonrc'):
1180 1180 new_filename = new_filename + rc_suffix
1181 1181 # The config directory should only contain files, skip any
1182 1182 # directories which may be there (like CVS)
1183 1183 if os.path.isdir(new_full_path):
1184 1184 continue
1185 1185 if os.path.exists(new_filename):
1186 1186 old_file = new_filename+'.old'
1187 1187 if os.path.exists(old_file):
1188 1188 os.remove(old_file)
1189 1189 os.rename(new_filename,old_file)
1190 1190 shutil.copy(new_full_path,new_filename)
1191 1191 else:
1192 1192 raise ValueError,'unrecognized mode for install:',`mode`
1193 1193
1194 1194 # Fix line-endings to those native to each platform in the config
1195 1195 # directory.
1196 1196 try:
1197 1197 os.chdir(ipythondir)
1198 1198 except:
1199 1199 print """
1200 1200 Problem: changing to directory %s failed.
1201 1201 Details:
1202 1202 %s
1203 1203
1204 1204 Some configuration files may have incorrect line endings. This should not
1205 1205 cause any problems during execution. """ % (ipythondir,sys.exc_info()[1])
1206 1206 wait()
1207 1207 else:
1208 1208 for fname in glb('ipythonrc*'):
1209 1209 try:
1210 1210 native_line_ends(fname,backup=0)
1211 1211 except IOError:
1212 1212 pass
1213 1213
1214 1214 if mode == 'install':
1215 1215 print """
1216 1216 Successful installation!
1217 1217
1218 1218 Please read the sections 'Initial Configuration' and 'Quick Tips' in the
1219 1219 IPython manual (there are both HTML and PDF versions supplied with the
1220 1220 distribution) to make sure that your system environment is properly configured
1221 1221 to take advantage of IPython's features.
1222 1222
1223 1223 Important note: the configuration system has changed! The old system is
1224 1224 still in place, but its setting may be partly overridden by the settings in
1225 1225 "~/.ipython/ipy_user_conf.py" config file. Please take a look at the file
1226 1226 if some of the new settings bother you.
1227 1227
1228 1228 """
1229 1229 else:
1230 1230 print """
1231 1231 Successful upgrade!
1232 1232
1233 1233 All files in your directory:
1234 1234 %(ipythondir)s
1235 1235 which would have been overwritten by the upgrade were backed up with a .old
1236 1236 extension. If you had made particular customizations in those files you may
1237 1237 want to merge them back into the new files.""" % locals()
1238 1238 wait()
1239 1239 os.chdir(cwd)
1240 1240 # end user_setup()
1241 1241
1242 1242 def atexit_operations(self):
1243 1243 """This will be executed at the time of exit.
1244 1244
1245 1245 Saving of persistent data should be performed here. """
1246 1246
1247 1247 #print '*** IPython exit cleanup ***' # dbg
1248 1248 # input history
1249 1249 self.savehist()
1250 1250
1251 1251 # Cleanup all tempfiles left around
1252 1252 for tfile in self.tempfiles:
1253 1253 try:
1254 1254 os.unlink(tfile)
1255 1255 except OSError:
1256 1256 pass
1257 1257
1258 1258 self.hooks.shutdown_hook()
1259 1259
1260 1260 def savehist(self):
1261 1261 """Save input history to a file (via readline library)."""
1262 1262
1263 1263 if not self.has_readline:
1264 1264 return
1265 1265
1266 1266 try:
1267 1267 self.readline.write_history_file(self.histfile)
1268 1268 except:
1269 1269 print 'Unable to save IPython command history to file: ' + \
1270 1270 `self.histfile`
1271 1271
1272 1272 def reloadhist(self):
1273 1273 """Reload the input history from disk file."""
1274 1274
1275 1275 if self.has_readline:
1276 1276 try:
1277 1277 self.readline.clear_history()
1278 1278 self.readline.read_history_file(self.shell.histfile)
1279 1279 except AttributeError:
1280 1280 pass
1281 1281
1282 1282
1283 1283 def history_saving_wrapper(self, func):
1284 1284 """ Wrap func for readline history saving
1285 1285
1286 1286 Convert func into callable that saves & restores
1287 1287 history around the call """
1288 1288
1289 1289 if not self.has_readline:
1290 1290 return func
1291 1291
1292 1292 def wrapper():
1293 1293 self.savehist()
1294 1294 try:
1295 1295 func()
1296 1296 finally:
1297 1297 readline.read_history_file(self.histfile)
1298 1298 return wrapper
1299 1299
1300 1300
1301 1301 def pre_readline(self):
1302 1302 """readline hook to be used at the start of each line.
1303 1303
1304 1304 Currently it handles auto-indent only."""
1305 1305
1306 1306 #debugx('self.indent_current_nsp','pre_readline:')
1307 1307
1308 1308 if self.rl_do_indent:
1309 1309 self.readline.insert_text(self.indent_current_str())
1310 1310 if self.rl_next_input is not None:
1311 1311 self.readline.insert_text(self.rl_next_input)
1312 1312 self.rl_next_input = None
1313 1313
1314 1314 def init_readline(self):
1315 1315 """Command history completion/saving/reloading."""
1316 1316
1317 1317
1318 1318 import IPython.rlineimpl as readline
1319 1319
1320 1320 if not readline.have_readline:
1321 1321 self.has_readline = 0
1322 1322 self.readline = None
1323 1323 # no point in bugging windows users with this every time:
1324 1324 warn('Readline services not available on this platform.')
1325 1325 else:
1326 1326 sys.modules['readline'] = readline
1327 1327 import atexit
1328 1328 from IPython.completer import IPCompleter
1329 1329 self.Completer = IPCompleter(self,
1330 1330 self.user_ns,
1331 1331 self.user_global_ns,
1332 1332 self.rc.readline_omit__names,
1333 1333 self.alias_table)
1334 1334 sdisp = self.strdispatchers.get('complete_command', StrDispatch())
1335 1335 self.strdispatchers['complete_command'] = sdisp
1336 1336 self.Completer.custom_completers = sdisp
1337 1337 # Platform-specific configuration
1338 1338 if os.name == 'nt':
1339 1339 self.readline_startup_hook = readline.set_pre_input_hook
1340 1340 else:
1341 1341 self.readline_startup_hook = readline.set_startup_hook
1342 1342
1343 1343 # Load user's initrc file (readline config)
1344 1344 # Or if libedit is used, load editrc.
1345 1345 inputrc_name = os.environ.get('INPUTRC')
1346 1346 if inputrc_name is None:
1347 1347 home_dir = get_home_dir()
1348 1348 if home_dir is not None:
1349 1349 inputrc_name = '.inputrc'
1350 1350 if readline.uses_libedit:
1351 1351 inputrc_name = '.editrc'
1352 1352 inputrc_name = os.path.join(home_dir, inputrc_name)
1353 1353 if os.path.isfile(inputrc_name):
1354 1354 try:
1355 1355 readline.read_init_file(inputrc_name)
1356 1356 except:
1357 1357 warn('Problems reading readline initialization file <%s>'
1358 1358 % inputrc_name)
1359 1359
1360 1360 self.has_readline = 1
1361 1361 self.readline = readline
1362 1362 # save this in sys so embedded copies can restore it properly
1363 1363 sys.ipcompleter = self.Completer.complete
1364 1364 self.set_completer()
1365 1365
1366 1366 # Configure readline according to user's prefs
1367 1367 # This is only done if GNU readline is being used. If libedit
1368 1368 # is being used (as on Leopard) the readline config is
1369 1369 # not run as the syntax for libedit is different.
1370 1370 if not readline.uses_libedit:
1371 1371 for rlcommand in self.rc.readline_parse_and_bind:
1372 1372 readline.parse_and_bind(rlcommand)
1373 1373
1374 1374 # remove some chars from the delimiters list
1375 1375 delims = readline.get_completer_delims()
1376 1376 delims = delims.translate(string._idmap,
1377 1377 self.rc.readline_remove_delims)
1378 1378 readline.set_completer_delims(delims)
1379 1379 # otherwise we end up with a monster history after a while:
1380 1380 readline.set_history_length(1000)
1381 1381 try:
1382 1382 #print '*** Reading readline history' # dbg
1383 1383 readline.read_history_file(self.histfile)
1384 1384 except IOError:
1385 1385 pass # It doesn't exist yet.
1386 1386
1387 1387 atexit.register(self.atexit_operations)
1388 1388 del atexit
1389 1389
1390 1390 # Configure auto-indent for all platforms
1391 1391 self.set_autoindent(self.rc.autoindent)
1392 1392
1393 1393 def ask_yes_no(self,prompt,default=True):
1394 1394 if self.rc.quiet:
1395 1395 return True
1396 1396 return ask_yes_no(prompt,default)
1397 1397
1398 1398 def _should_recompile(self,e):
1399 1399 """Utility routine for edit_syntax_error"""
1400 1400
1401 1401 if e.filename in ('<ipython console>','<input>','<string>',
1402 1402 '<console>','<BackgroundJob compilation>',
1403 1403 None):
1404 1404
1405 1405 return False
1406 1406 try:
1407 1407 if (self.rc.autoedit_syntax and
1408 1408 not self.ask_yes_no('Return to editor to correct syntax error? '
1409 1409 '[Y/n] ','y')):
1410 1410 return False
1411 1411 except EOFError:
1412 1412 return False
1413 1413
1414 1414 def int0(x):
1415 1415 try:
1416 1416 return int(x)
1417 1417 except TypeError:
1418 1418 return 0
1419 1419 # always pass integer line and offset values to editor hook
1420 1420 self.hooks.fix_error_editor(e.filename,
1421 1421 int0(e.lineno),int0(e.offset),e.msg)
1422 1422 return True
1423 1423
1424 1424 def edit_syntax_error(self):
1425 1425 """The bottom half of the syntax error handler called in the main loop.
1426 1426
1427 1427 Loop until syntax error is fixed or user cancels.
1428 1428 """
1429 1429
1430 1430 while self.SyntaxTB.last_syntax_error:
1431 1431 # copy and clear last_syntax_error
1432 1432 err = self.SyntaxTB.clear_err_state()
1433 1433 if not self._should_recompile(err):
1434 1434 return
1435 1435 try:
1436 1436 # may set last_syntax_error again if a SyntaxError is raised
1437 1437 self.safe_execfile(err.filename,self.user_ns)
1438 1438 except:
1439 1439 self.showtraceback()
1440 1440 else:
1441 1441 try:
1442 1442 f = file(err.filename)
1443 1443 try:
1444 1444 sys.displayhook(f.read())
1445 1445 finally:
1446 1446 f.close()
1447 1447 except:
1448 1448 self.showtraceback()
1449 1449
1450 1450 def showsyntaxerror(self, filename=None):
1451 1451 """Display the syntax error that just occurred.
1452 1452
1453 1453 This doesn't display a stack trace because there isn't one.
1454 1454
1455 1455 If a filename is given, it is stuffed in the exception instead
1456 1456 of what was there before (because Python's parser always uses
1457 1457 "<string>" when reading from a string).
1458 1458 """
1459 1459 etype, value, last_traceback = sys.exc_info()
1460 1460
1461 1461 # See note about these variables in showtraceback() below
1462 1462 sys.last_type = etype
1463 1463 sys.last_value = value
1464 1464 sys.last_traceback = last_traceback
1465 1465
1466 1466 if filename and etype is SyntaxError:
1467 1467 # Work hard to stuff the correct filename in the exception
1468 1468 try:
1469 1469 msg, (dummy_filename, lineno, offset, line) = value
1470 1470 except:
1471 1471 # Not the format we expect; leave it alone
1472 1472 pass
1473 1473 else:
1474 1474 # Stuff in the right filename
1475 1475 try:
1476 1476 # Assume SyntaxError is a class exception
1477 1477 value = SyntaxError(msg, (filename, lineno, offset, line))
1478 1478 except:
1479 1479 # If that failed, assume SyntaxError is a string
1480 1480 value = msg, (filename, lineno, offset, line)
1481 1481 self.SyntaxTB(etype,value,[])
1482 1482
1483 1483 def debugger(self,force=False):
1484 1484 """Call the pydb/pdb debugger.
1485 1485
1486 1486 Keywords:
1487 1487
1488 1488 - force(False): by default, this routine checks the instance call_pdb
1489 1489 flag and does not actually invoke the debugger if the flag is false.
1490 1490 The 'force' option forces the debugger to activate even if the flag
1491 1491 is false.
1492 1492 """
1493 1493
1494 1494 if not (force or self.call_pdb):
1495 1495 return
1496 1496
1497 1497 if not hasattr(sys,'last_traceback'):
1498 1498 error('No traceback has been produced, nothing to debug.')
1499 1499 return
1500 1500
1501 1501 # use pydb if available
1502 1502 if Debugger.has_pydb:
1503 1503 from pydb import pm
1504 1504 else:
1505 1505 # fallback to our internal debugger
1506 1506 pm = lambda : self.InteractiveTB.debugger(force=True)
1507 1507 self.history_saving_wrapper(pm)()
1508 1508
1509 1509 def showtraceback(self,exc_tuple = None,filename=None,tb_offset=None):
1510 1510 """Display the exception that just occurred.
1511 1511
1512 1512 If nothing is known about the exception, this is the method which
1513 1513 should be used throughout the code for presenting user tracebacks,
1514 1514 rather than directly invoking the InteractiveTB object.
1515 1515
1516 1516 A specific showsyntaxerror() also exists, but this method can take
1517 1517 care of calling it if needed, so unless you are explicitly catching a
1518 1518 SyntaxError exception, don't try to analyze the stack manually and
1519 1519 simply call this method."""
1520 1520
1521 1521
1522 1522 # Though this won't be called by syntax errors in the input line,
1523 1523 # there may be SyntaxError cases whith imported code.
1524 1524
1525 1525 try:
1526 1526 if exc_tuple is None:
1527 1527 etype, value, tb = sys.exc_info()
1528 1528 else:
1529 1529 etype, value, tb = exc_tuple
1530 1530
1531 1531 if etype is SyntaxError:
1532 1532 self.showsyntaxerror(filename)
1533 1533 elif etype is IPython.ipapi.UsageError:
1534 1534 print "UsageError:", value
1535 1535 else:
1536 1536 # WARNING: these variables are somewhat deprecated and not
1537 1537 # necessarily safe to use in a threaded environment, but tools
1538 1538 # like pdb depend on their existence, so let's set them. If we
1539 1539 # find problems in the field, we'll need to revisit their use.
1540 1540 sys.last_type = etype
1541 1541 sys.last_value = value
1542 1542 sys.last_traceback = tb
1543 1543
1544 1544 if etype in self.custom_exceptions:
1545 1545 self.CustomTB(etype,value,tb)
1546 1546 else:
1547 1547 self.InteractiveTB(etype,value,tb,tb_offset=tb_offset)
1548 1548 if self.InteractiveTB.call_pdb and self.has_readline:
1549 1549 # pdb mucks up readline, fix it back
1550 1550 self.set_completer()
1551 1551 except KeyboardInterrupt:
1552 1552 self.write("\nKeyboardInterrupt\n")
1553 1553
1554 1554
1555 1555
1556 1556 def mainloop(self,banner=None):
1557 1557 """Creates the local namespace and starts the mainloop.
1558 1558
1559 1559 If an optional banner argument is given, it will override the
1560 1560 internally created default banner."""
1561 1561
1562 1562 if self.rc.c: # Emulate Python's -c option
1563 1563 self.exec_init_cmd()
1564 1564 if banner is None:
1565 1565 if not self.rc.banner:
1566 1566 banner = ''
1567 1567 # banner is string? Use it directly!
1568 1568 elif isinstance(self.rc.banner,basestring):
1569 1569 banner = self.rc.banner
1570 1570 else:
1571 1571 banner = self.BANNER+self.banner2
1572 1572
1573 1573 while 1:
1574 1574 try:
1575 1575 self.interact(banner)
1576 1576 #self.interact_with_readline()
1577 1577 # XXX for testing of a readline-decoupled repl loop, call interact_with_readline above
1578 1578
1579 1579 break
1580 1580 except KeyboardInterrupt:
1581 1581 # this should not be necessary, but KeyboardInterrupt
1582 1582 # handling seems rather unpredictable...
1583 1583 self.write("\nKeyboardInterrupt in interact()\n")
1584 1584
1585 1585 def exec_init_cmd(self):
1586 1586 """Execute a command given at the command line.
1587 1587
1588 1588 This emulates Python's -c option."""
1589 1589
1590 1590 #sys.argv = ['-c']
1591 1591 self.push(self.prefilter(self.rc.c, False))
1592 1592 if not self.rc.interact:
1593 self.exit_now = True
1593 self.ask_exit()
1594 1594
1595 1595 def embed_mainloop(self,header='',local_ns=None,global_ns=None,stack_depth=0):
1596 1596 """Embeds IPython into a running python program.
1597 1597
1598 1598 Input:
1599 1599
1600 1600 - header: An optional header message can be specified.
1601 1601
1602 1602 - local_ns, global_ns: working namespaces. If given as None, the
1603 1603 IPython-initialized one is updated with __main__.__dict__, so that
1604 1604 program variables become visible but user-specific configuration
1605 1605 remains possible.
1606 1606
1607 1607 - stack_depth: specifies how many levels in the stack to go to
1608 1608 looking for namespaces (when local_ns and global_ns are None). This
1609 1609 allows an intermediate caller to make sure that this function gets
1610 1610 the namespace from the intended level in the stack. By default (0)
1611 1611 it will get its locals and globals from the immediate caller.
1612 1612
1613 1613 Warning: it's possible to use this in a program which is being run by
1614 1614 IPython itself (via %run), but some funny things will happen (a few
1615 1615 globals get overwritten). In the future this will be cleaned up, as
1616 1616 there is no fundamental reason why it can't work perfectly."""
1617 1617
1618 1618 # Get locals and globals from caller
1619 1619 if local_ns is None or global_ns is None:
1620 1620 call_frame = sys._getframe(stack_depth).f_back
1621 1621
1622 1622 if local_ns is None:
1623 1623 local_ns = call_frame.f_locals
1624 1624 if global_ns is None:
1625 1625 global_ns = call_frame.f_globals
1626 1626
1627 1627 # Update namespaces and fire up interpreter
1628 1628
1629 1629 # The global one is easy, we can just throw it in
1630 1630 self.user_global_ns = global_ns
1631 1631
1632 1632 # but the user/local one is tricky: ipython needs it to store internal
1633 1633 # data, but we also need the locals. We'll copy locals in the user
1634 1634 # one, but will track what got copied so we can delete them at exit.
1635 1635 # This is so that a later embedded call doesn't see locals from a
1636 1636 # previous call (which most likely existed in a separate scope).
1637 1637 local_varnames = local_ns.keys()
1638 1638 self.user_ns.update(local_ns)
1639 1639
1640 1640 # Patch for global embedding to make sure that things don't overwrite
1641 1641 # user globals accidentally. Thanks to Richard <rxe@renre-europe.com>
1642 1642 # FIXME. Test this a bit more carefully (the if.. is new)
1643 1643 if local_ns is None and global_ns is None:
1644 1644 self.user_global_ns.update(__main__.__dict__)
1645 1645
1646 1646 # make sure the tab-completer has the correct frame information, so it
1647 1647 # actually completes using the frame's locals/globals
1648 1648 self.set_completer_frame()
1649 1649
1650 1650 # before activating the interactive mode, we need to make sure that
1651 1651 # all names in the builtin namespace needed by ipython point to
1652 1652 # ourselves, and not to other instances.
1653 1653 self.add_builtins()
1654 1654
1655 1655 self.interact(header)
1656 1656
1657 1657 # now, purge out the user namespace from anything we might have added
1658 1658 # from the caller's local namespace
1659 1659 delvar = self.user_ns.pop
1660 1660 for var in local_varnames:
1661 1661 delvar(var,None)
1662 1662 # and clean builtins we may have overridden
1663 1663 self.clean_builtins()
1664 1664
1665 1665 def interact_prompt(self):
1666 1666 """ Print the prompt (in read-eval-print loop)
1667 1667
1668 1668 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1669 1669 used in standard IPython flow.
1670 1670 """
1671 1671 if self.more:
1672 1672 try:
1673 1673 prompt = self.hooks.generate_prompt(True)
1674 1674 except:
1675 1675 self.showtraceback()
1676 1676 if self.autoindent:
1677 1677 self.rl_do_indent = True
1678 1678
1679 1679 else:
1680 1680 try:
1681 1681 prompt = self.hooks.generate_prompt(False)
1682 1682 except:
1683 1683 self.showtraceback()
1684 1684 self.write(prompt)
1685 1685
1686 1686 def interact_handle_input(self,line):
1687 1687 """ Handle the input line (in read-eval-print loop)
1688 1688
1689 1689 Provided for those who want to implement their own read-eval-print loop (e.g. GUIs), not
1690 1690 used in standard IPython flow.
1691 1691 """
1692 1692 if line.lstrip() == line:
1693 1693 self.shadowhist.add(line.strip())
1694 1694 lineout = self.prefilter(line,self.more)
1695 1695
1696 1696 if line.strip():
1697 1697 if self.more:
1698 1698 self.input_hist_raw[-1] += '%s\n' % line
1699 1699 else:
1700 1700 self.input_hist_raw.append('%s\n' % line)
1701 1701
1702 1702
1703 1703 self.more = self.push(lineout)
1704 1704 if (self.SyntaxTB.last_syntax_error and
1705 1705 self.rc.autoedit_syntax):
1706 1706 self.edit_syntax_error()
1707 1707
1708 1708 def interact_with_readline(self):
1709 1709 """ Demo of using interact_handle_input, interact_prompt
1710 1710
1711 1711 This is the main read-eval-print loop. If you need to implement your own (e.g. for GUI),
1712 1712 it should work like this.
1713 1713 """
1714 1714 self.readline_startup_hook(self.pre_readline)
1715 1715 while not self.exit_now:
1716 1716 self.interact_prompt()
1717 1717 if self.more:
1718 1718 self.rl_do_indent = True
1719 1719 else:
1720 1720 self.rl_do_indent = False
1721 1721 line = raw_input_original().decode(self.stdin_encoding)
1722 1722 self.interact_handle_input(line)
1723 1723
1724 1724
1725 1725 def interact(self, banner=None):
1726 1726 """Closely emulate the interactive Python console.
1727 1727
1728 1728 The optional banner argument specify the banner to print
1729 1729 before the first interaction; by default it prints a banner
1730 1730 similar to the one printed by the real Python interpreter,
1731 1731 followed by the current class name in parentheses (so as not
1732 1732 to confuse this with the real interpreter -- since it's so
1733 1733 close!).
1734 1734
1735 1735 """
1736 1736
1737 1737 if self.exit_now:
1738 1738 # batch run -> do not interact
1739 1739 return
1740 1740 cprt = 'Type "copyright", "credits" or "license" for more information.'
1741 1741 if banner is None:
1742 1742 self.write("Python %s on %s\n%s\n(%s)\n" %
1743 1743 (sys.version, sys.platform, cprt,
1744 1744 self.__class__.__name__))
1745 1745 else:
1746 1746 self.write(banner)
1747 1747
1748 1748 more = 0
1749 1749
1750 1750 # Mark activity in the builtins
1751 1751 __builtin__.__dict__['__IPYTHON__active'] += 1
1752 1752
1753 1753 if self.has_readline:
1754 1754 self.readline_startup_hook(self.pre_readline)
1755 # exit_now is set by a call to %Exit or %Quit
1755 # exit_now is set by a call to %Exit or %Quit, through the
1756 # ask_exit callback.
1756 1757
1757 1758 while not self.exit_now:
1758 1759 self.hooks.pre_prompt_hook()
1759 1760 if more:
1760 1761 try:
1761 1762 prompt = self.hooks.generate_prompt(True)
1762 1763 except:
1763 1764 self.showtraceback()
1764 1765 if self.autoindent:
1765 1766 self.rl_do_indent = True
1766 1767
1767 1768 else:
1768 1769 try:
1769 1770 prompt = self.hooks.generate_prompt(False)
1770 1771 except:
1771 1772 self.showtraceback()
1772 1773 try:
1773 1774 line = self.raw_input(prompt,more)
1774 1775 if self.exit_now:
1775 1776 # quick exit on sys.std[in|out] close
1776 1777 break
1777 1778 if self.autoindent:
1778 1779 self.rl_do_indent = False
1779 1780
1780 1781 except KeyboardInterrupt:
1781 1782 #double-guard against keyboardinterrupts during kbdint handling
1782 1783 try:
1783 1784 self.write('\nKeyboardInterrupt\n')
1784 1785 self.resetbuffer()
1785 1786 # keep cache in sync with the prompt counter:
1786 1787 self.outputcache.prompt_count -= 1
1787 1788
1788 1789 if self.autoindent:
1789 1790 self.indent_current_nsp = 0
1790 1791 more = 0
1791 1792 except KeyboardInterrupt:
1792 1793 pass
1793 1794 except EOFError:
1794 1795 if self.autoindent:
1795 1796 self.rl_do_indent = False
1796 1797 self.readline_startup_hook(None)
1797 1798 self.write('\n')
1798 1799 self.exit()
1799 1800 except bdb.BdbQuit:
1800 1801 warn('The Python debugger has exited with a BdbQuit exception.\n'
1801 1802 'Because of how pdb handles the stack, it is impossible\n'
1802 1803 'for IPython to properly format this particular exception.\n'
1803 1804 'IPython will resume normal operation.')
1804 1805 except:
1805 1806 # exceptions here are VERY RARE, but they can be triggered
1806 1807 # asynchronously by signal handlers, for example.
1807 1808 self.showtraceback()
1808 1809 else:
1809 1810 more = self.push(line)
1810 1811 if (self.SyntaxTB.last_syntax_error and
1811 1812 self.rc.autoedit_syntax):
1812 1813 self.edit_syntax_error()
1813 1814
1814 1815 # We are off again...
1815 1816 __builtin__.__dict__['__IPYTHON__active'] -= 1
1816 1817
1817 1818 def excepthook(self, etype, value, tb):
1818 1819 """One more defense for GUI apps that call sys.excepthook.
1819 1820
1820 1821 GUI frameworks like wxPython trap exceptions and call
1821 1822 sys.excepthook themselves. I guess this is a feature that
1822 1823 enables them to keep running after exceptions that would
1823 1824 otherwise kill their mainloop. This is a bother for IPython
1824 1825 which excepts to catch all of the program exceptions with a try:
1825 1826 except: statement.
1826 1827
1827 1828 Normally, IPython sets sys.excepthook to a CrashHandler instance, so if
1828 1829 any app directly invokes sys.excepthook, it will look to the user like
1829 1830 IPython crashed. In order to work around this, we can disable the
1830 1831 CrashHandler and replace it with this excepthook instead, which prints a
1831 1832 regular traceback using our InteractiveTB. In this fashion, apps which
1832 1833 call sys.excepthook will generate a regular-looking exception from
1833 1834 IPython, and the CrashHandler will only be triggered by real IPython
1834 1835 crashes.
1835 1836
1836 1837 This hook should be used sparingly, only in places which are not likely
1837 1838 to be true IPython errors.
1838 1839 """
1839 1840 self.showtraceback((etype,value,tb),tb_offset=0)
1840 1841
1841 1842 def expand_aliases(self,fn,rest):
1842 1843 """ Expand multiple levels of aliases:
1843 1844
1844 1845 if:
1845 1846
1846 1847 alias foo bar /tmp
1847 1848 alias baz foo
1848 1849
1849 1850 then:
1850 1851
1851 1852 baz huhhahhei -> bar /tmp huhhahhei
1852 1853
1853 1854 """
1854 1855 line = fn + " " + rest
1855 1856
1856 1857 done = Set()
1857 1858 while 1:
1858 1859 pre,fn,rest = prefilter.splitUserInput(line,
1859 1860 prefilter.shell_line_split)
1860 1861 if fn in self.alias_table:
1861 1862 if fn in done:
1862 1863 warn("Cyclic alias definition, repeated '%s'" % fn)
1863 1864 return ""
1864 1865 done.add(fn)
1865 1866
1866 1867 l2 = self.transform_alias(fn,rest)
1867 1868 # dir -> dir
1868 1869 # print "alias",line, "->",l2 #dbg
1869 1870 if l2 == line:
1870 1871 break
1871 1872 # ls -> ls -F should not recurse forever
1872 1873 if l2.split(None,1)[0] == line.split(None,1)[0]:
1873 1874 line = l2
1874 1875 break
1875 1876
1876 1877 line=l2
1877 1878
1878 1879
1879 1880 # print "al expand to",line #dbg
1880 1881 else:
1881 1882 break
1882 1883
1883 1884 return line
1884 1885
1885 1886 def transform_alias(self, alias,rest=''):
1886 1887 """ Transform alias to system command string.
1887 1888 """
1888 1889 trg = self.alias_table[alias]
1889 1890
1890 1891 nargs,cmd = trg
1891 1892 # print trg #dbg
1892 1893 if ' ' in cmd and os.path.isfile(cmd):
1893 1894 cmd = '"%s"' % cmd
1894 1895
1895 1896 # Expand the %l special to be the user's input line
1896 1897 if cmd.find('%l') >= 0:
1897 1898 cmd = cmd.replace('%l',rest)
1898 1899 rest = ''
1899 1900 if nargs==0:
1900 1901 # Simple, argument-less aliases
1901 1902 cmd = '%s %s' % (cmd,rest)
1902 1903 else:
1903 1904 # Handle aliases with positional arguments
1904 1905 args = rest.split(None,nargs)
1905 1906 if len(args)< nargs:
1906 1907 error('Alias <%s> requires %s arguments, %s given.' %
1907 1908 (alias,nargs,len(args)))
1908 1909 return None
1909 1910 cmd = '%s %s' % (cmd % tuple(args[:nargs]),' '.join(args[nargs:]))
1910 1911 # Now call the macro, evaluating in the user's namespace
1911 1912 #print 'new command: <%r>' % cmd # dbg
1912 1913 return cmd
1913 1914
1914 1915 def call_alias(self,alias,rest=''):
1915 1916 """Call an alias given its name and the rest of the line.
1916 1917
1917 1918 This is only used to provide backwards compatibility for users of
1918 1919 ipalias(), use of which is not recommended for anymore."""
1919 1920
1920 1921 # Now call the macro, evaluating in the user's namespace
1921 1922 cmd = self.transform_alias(alias, rest)
1922 1923 try:
1923 1924 self.system(cmd)
1924 1925 except:
1925 1926 self.showtraceback()
1926 1927
1927 1928 def indent_current_str(self):
1928 1929 """return the current level of indentation as a string"""
1929 1930 return self.indent_current_nsp * ' '
1930 1931
1931 1932 def autoindent_update(self,line):
1932 1933 """Keep track of the indent level."""
1933 1934
1934 1935 #debugx('line')
1935 1936 #debugx('self.indent_current_nsp')
1936 1937 if self.autoindent:
1937 1938 if line:
1938 1939 inisp = num_ini_spaces(line)
1939 1940 if inisp < self.indent_current_nsp:
1940 1941 self.indent_current_nsp = inisp
1941 1942
1942 1943 if line[-1] == ':':
1943 1944 self.indent_current_nsp += 4
1944 1945 elif dedent_re.match(line):
1945 1946 self.indent_current_nsp -= 4
1946 1947 else:
1947 1948 self.indent_current_nsp = 0
1948 1949
1949 1950 def runlines(self,lines):
1950 1951 """Run a string of one or more lines of source.
1951 1952
1952 1953 This method is capable of running a string containing multiple source
1953 1954 lines, as if they had been entered at the IPython prompt. Since it
1954 1955 exposes IPython's processing machinery, the given strings can contain
1955 1956 magic calls (%magic), special shell access (!cmd), etc."""
1956 1957
1957 1958 # We must start with a clean buffer, in case this is run from an
1958 1959 # interactive IPython session (via a magic, for example).
1959 1960 self.resetbuffer()
1960 1961 lines = lines.split('\n')
1961 1962 more = 0
1962 1963
1963 1964 for line in lines:
1964 1965 # skip blank lines so we don't mess up the prompt counter, but do
1965 1966 # NOT skip even a blank line if we are in a code block (more is
1966 1967 # true)
1967 1968
1968 1969
1969 1970 if line or more:
1970 1971 # push to raw history, so hist line numbers stay in sync
1971 1972 self.input_hist_raw.append("# " + line + "\n")
1972 1973 more = self.push(self.prefilter(line,more))
1973 1974 # IPython's runsource returns None if there was an error
1974 1975 # compiling the code. This allows us to stop processing right
1975 1976 # away, so the user gets the error message at the right place.
1976 1977 if more is None:
1977 1978 break
1978 1979 else:
1979 1980 self.input_hist_raw.append("\n")
1980 1981 # final newline in case the input didn't have it, so that the code
1981 1982 # actually does get executed
1982 1983 if more:
1983 1984 self.push('\n')
1984 1985
1985 1986 def runsource(self, source, filename='<input>', symbol='single'):
1986 1987 """Compile and run some source in the interpreter.
1987 1988
1988 1989 Arguments are as for compile_command().
1989 1990
1990 1991 One several things can happen:
1991 1992
1992 1993 1) The input is incorrect; compile_command() raised an
1993 1994 exception (SyntaxError or OverflowError). A syntax traceback
1994 1995 will be printed by calling the showsyntaxerror() method.
1995 1996
1996 1997 2) The input is incomplete, and more input is required;
1997 1998 compile_command() returned None. Nothing happens.
1998 1999
1999 2000 3) The input is complete; compile_command() returned a code
2000 2001 object. The code is executed by calling self.runcode() (which
2001 2002 also handles run-time exceptions, except for SystemExit).
2002 2003
2003 2004 The return value is:
2004 2005
2005 2006 - True in case 2
2006 2007
2007 2008 - False in the other cases, unless an exception is raised, where
2008 2009 None is returned instead. This can be used by external callers to
2009 2010 know whether to continue feeding input or not.
2010 2011
2011 2012 The return value can be used to decide whether to use sys.ps1 or
2012 2013 sys.ps2 to prompt the next line."""
2013 2014
2014 2015 # if the source code has leading blanks, add 'if 1:\n' to it
2015 2016 # this allows execution of indented pasted code. It is tempting
2016 2017 # to add '\n' at the end of source to run commands like ' a=1'
2017 2018 # directly, but this fails for more complicated scenarios
2018 2019 source=source.encode(self.stdin_encoding)
2019 2020 if source[:1] in [' ', '\t']:
2020 2021 source = 'if 1:\n%s' % source
2021 2022
2022 2023 try:
2023 2024 code = self.compile(source,filename,symbol)
2024 2025 except (OverflowError, SyntaxError, ValueError, TypeError):
2025 2026 # Case 1
2026 2027 self.showsyntaxerror(filename)
2027 2028 return None
2028 2029
2029 2030 if code is None:
2030 2031 # Case 2
2031 2032 return True
2032 2033
2033 2034 # Case 3
2034 2035 # We store the code object so that threaded shells and
2035 2036 # custom exception handlers can access all this info if needed.
2036 2037 # The source corresponding to this can be obtained from the
2037 2038 # buffer attribute as '\n'.join(self.buffer).
2038 2039 self.code_to_run = code
2039 2040 # now actually execute the code object
2040 2041 if self.runcode(code) == 0:
2041 2042 return False
2042 2043 else:
2043 2044 return None
2044 2045
2045 2046 def runcode(self,code_obj):
2046 2047 """Execute a code object.
2047 2048
2048 2049 When an exception occurs, self.showtraceback() is called to display a
2049 2050 traceback.
2050 2051
2051 2052 Return value: a flag indicating whether the code to be run completed
2052 2053 successfully:
2053 2054
2054 2055 - 0: successful execution.
2055 2056 - 1: an error occurred.
2056 2057 """
2057 2058
2058 2059 # Set our own excepthook in case the user code tries to call it
2059 2060 # directly, so that the IPython crash handler doesn't get triggered
2060 2061 old_excepthook,sys.excepthook = sys.excepthook, self.excepthook
2061 2062
2062 2063 # we save the original sys.excepthook in the instance, in case config
2063 2064 # code (such as magics) needs access to it.
2064 2065 self.sys_excepthook = old_excepthook
2065 2066 outflag = 1 # happens in more places, so it's easier as default
2066 2067 try:
2067 2068 try:
2068 2069 self.hooks.pre_runcode_hook()
2069 2070 # Embedded instances require separate global/local namespaces
2070 2071 # so they can see both the surrounding (local) namespace and
2071 2072 # the module-level globals when called inside another function.
2072 2073 if self.embedded:
2073 2074 exec code_obj in self.user_global_ns, self.user_ns
2074 2075 # Normal (non-embedded) instances should only have a single
2075 2076 # namespace for user code execution, otherwise functions won't
2076 2077 # see interactive top-level globals.
2077 2078 else:
2078 2079 exec code_obj in self.user_ns
2079 2080 finally:
2080 2081 # Reset our crash handler in place
2081 2082 sys.excepthook = old_excepthook
2082 2083 except SystemExit:
2083 2084 self.resetbuffer()
2084 2085 self.showtraceback()
2085 2086 warn("Type %exit or %quit to exit IPython "
2086 2087 "(%Exit or %Quit do so unconditionally).",level=1)
2087 2088 except self.custom_exceptions:
2088 2089 etype,value,tb = sys.exc_info()
2089 2090 self.CustomTB(etype,value,tb)
2090 2091 except:
2091 2092 self.showtraceback()
2092 2093 else:
2093 2094 outflag = 0
2094 2095 if softspace(sys.stdout, 0):
2095 2096 print
2096 2097 # Flush out code object which has been run (and source)
2097 2098 self.code_to_run = None
2098 2099 return outflag
2099 2100
2100 2101 def push(self, line):
2101 2102 """Push a line to the interpreter.
2102 2103
2103 2104 The line should not have a trailing newline; it may have
2104 2105 internal newlines. The line is appended to a buffer and the
2105 2106 interpreter's runsource() method is called with the
2106 2107 concatenated contents of the buffer as source. If this
2107 2108 indicates that the command was executed or invalid, the buffer
2108 2109 is reset; otherwise, the command is incomplete, and the buffer
2109 2110 is left as it was after the line was appended. The return
2110 2111 value is 1 if more input is required, 0 if the line was dealt
2111 2112 with in some way (this is the same as runsource()).
2112 2113 """
2113 2114
2114 2115 # autoindent management should be done here, and not in the
2115 2116 # interactive loop, since that one is only seen by keyboard input. We
2116 2117 # need this done correctly even for code run via runlines (which uses
2117 2118 # push).
2118 2119
2119 2120 #print 'push line: <%s>' % line # dbg
2120 2121 for subline in line.splitlines():
2121 2122 self.autoindent_update(subline)
2122 2123 self.buffer.append(line)
2123 2124 more = self.runsource('\n'.join(self.buffer), self.filename)
2124 2125 if not more:
2125 2126 self.resetbuffer()
2126 2127 return more
2127 2128
2128 2129 def split_user_input(self, line):
2129 2130 # This is really a hold-over to support ipapi and some extensions
2130 2131 return prefilter.splitUserInput(line)
2131 2132
2132 2133 def resetbuffer(self):
2133 2134 """Reset the input buffer."""
2134 2135 self.buffer[:] = []
2135 2136
2136 2137 def raw_input(self,prompt='',continue_prompt=False):
2137 2138 """Write a prompt and read a line.
2138 2139
2139 2140 The returned line does not include the trailing newline.
2140 2141 When the user enters the EOF key sequence, EOFError is raised.
2141 2142
2142 2143 Optional inputs:
2143 2144
2144 2145 - prompt(''): a string to be printed to prompt the user.
2145 2146
2146 2147 - continue_prompt(False): whether this line is the first one or a
2147 2148 continuation in a sequence of inputs.
2148 2149 """
2149 2150
2150 2151 # Code run by the user may have modified the readline completer state.
2151 2152 # We must ensure that our completer is back in place.
2152 2153 if self.has_readline:
2153 2154 self.set_completer()
2154 2155
2155 2156 try:
2156 2157 line = raw_input_original(prompt).decode(self.stdin_encoding)
2157 2158 except ValueError:
2158 2159 warn("\n********\nYou or a %run:ed script called sys.stdin.close()"
2159 2160 " or sys.stdout.close()!\nExiting IPython!")
2160 self.exit_now = True
2161 self.ask_exit()
2161 2162 return ""
2162 2163
2163 2164 # Try to be reasonably smart about not re-indenting pasted input more
2164 2165 # than necessary. We do this by trimming out the auto-indent initial
2165 2166 # spaces, if the user's actual input started itself with whitespace.
2166 2167 #debugx('self.buffer[-1]')
2167 2168
2168 2169 if self.autoindent:
2169 2170 if num_ini_spaces(line) > self.indent_current_nsp:
2170 2171 line = line[self.indent_current_nsp:]
2171 2172 self.indent_current_nsp = 0
2172 2173
2173 2174 # store the unfiltered input before the user has any chance to modify
2174 2175 # it.
2175 2176 if line.strip():
2176 2177 if continue_prompt:
2177 2178 self.input_hist_raw[-1] += '%s\n' % line
2178 2179 if self.has_readline: # and some config option is set?
2179 2180 try:
2180 2181 histlen = self.readline.get_current_history_length()
2181 2182 if histlen > 1:
2182 2183 newhist = self.input_hist_raw[-1].rstrip()
2183 2184 self.readline.remove_history_item(histlen-1)
2184 2185 self.readline.replace_history_item(histlen-2,
2185 2186 newhist.encode(self.stdin_encoding))
2186 2187 except AttributeError:
2187 2188 pass # re{move,place}_history_item are new in 2.4.
2188 2189 else:
2189 2190 self.input_hist_raw.append('%s\n' % line)
2190 2191 # only entries starting at first column go to shadow history
2191 2192 if line.lstrip() == line:
2192 2193 self.shadowhist.add(line.strip())
2193 2194 elif not continue_prompt:
2194 2195 self.input_hist_raw.append('\n')
2195 2196 try:
2196 2197 lineout = self.prefilter(line,continue_prompt)
2197 2198 except:
2198 2199 # blanket except, in case a user-defined prefilter crashes, so it
2199 2200 # can't take all of ipython with it.
2200 2201 self.showtraceback()
2201 2202 return ''
2202 2203 else:
2203 2204 return lineout
2204 2205
2205 2206 def _prefilter(self, line, continue_prompt):
2206 2207 """Calls different preprocessors, depending on the form of line."""
2207 2208
2208 2209 # All handlers *must* return a value, even if it's blank ('').
2209 2210
2210 2211 # Lines are NOT logged here. Handlers should process the line as
2211 2212 # needed, update the cache AND log it (so that the input cache array
2212 2213 # stays synced).
2213 2214
2214 2215 #.....................................................................
2215 2216 # Code begins
2216 2217
2217 2218 #if line.startswith('%crash'): raise RuntimeError,'Crash now!' # dbg
2218 2219
2219 2220 # save the line away in case we crash, so the post-mortem handler can
2220 2221 # record it
2221 2222 self._last_input_line = line
2222 2223
2223 2224 #print '***line: <%s>' % line # dbg
2224 2225
2225 2226 if not line:
2226 2227 # Return immediately on purely empty lines, so that if the user
2227 2228 # previously typed some whitespace that started a continuation
2228 2229 # prompt, he can break out of that loop with just an empty line.
2229 2230 # This is how the default python prompt works.
2230 2231
2231 2232 # Only return if the accumulated input buffer was just whitespace!
2232 2233 if ''.join(self.buffer).isspace():
2233 2234 self.buffer[:] = []
2234 2235 return ''
2235 2236
2236 2237 line_info = prefilter.LineInfo(line, continue_prompt)
2237 2238
2238 2239 # the input history needs to track even empty lines
2239 2240 stripped = line.strip()
2240 2241
2241 2242 if not stripped:
2242 2243 if not continue_prompt:
2243 2244 self.outputcache.prompt_count -= 1
2244 2245 return self.handle_normal(line_info)
2245 2246
2246 2247 # print '***cont',continue_prompt # dbg
2247 2248 # special handlers are only allowed for single line statements
2248 2249 if continue_prompt and not self.rc.multi_line_specials:
2249 2250 return self.handle_normal(line_info)
2250 2251
2251 2252
2252 2253 # See whether any pre-existing handler can take care of it
2253 2254 rewritten = self.hooks.input_prefilter(stripped)
2254 2255 if rewritten != stripped: # ok, some prefilter did something
2255 2256 rewritten = line_info.pre + rewritten # add indentation
2256 2257 return self.handle_normal(prefilter.LineInfo(rewritten,
2257 2258 continue_prompt))
2258 2259
2259 2260 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2260 2261
2261 2262 return prefilter.prefilter(line_info, self)
2262 2263
2263 2264
2264 2265 def _prefilter_dumb(self, line, continue_prompt):
2265 2266 """simple prefilter function, for debugging"""
2266 2267 return self.handle_normal(line,continue_prompt)
2267 2268
2268 2269
2269 2270 def multiline_prefilter(self, line, continue_prompt):
2270 2271 """ Run _prefilter for each line of input
2271 2272
2272 2273 Covers cases where there are multiple lines in the user entry,
2273 2274 which is the case when the user goes back to a multiline history
2274 2275 entry and presses enter.
2275 2276
2276 2277 """
2277 2278 out = []
2278 2279 for l in line.rstrip('\n').split('\n'):
2279 2280 out.append(self._prefilter(l, continue_prompt))
2280 2281 return '\n'.join(out)
2281 2282
2282 2283 # Set the default prefilter() function (this can be user-overridden)
2283 2284 prefilter = multiline_prefilter
2284 2285
2285 2286 def handle_normal(self,line_info):
2286 2287 """Handle normal input lines. Use as a template for handlers."""
2287 2288
2288 2289 # With autoindent on, we need some way to exit the input loop, and I
2289 2290 # don't want to force the user to have to backspace all the way to
2290 2291 # clear the line. The rule will be in this case, that either two
2291 2292 # lines of pure whitespace in a row, or a line of pure whitespace but
2292 2293 # of a size different to the indent level, will exit the input loop.
2293 2294 line = line_info.line
2294 2295 continue_prompt = line_info.continue_prompt
2295 2296
2296 2297 if (continue_prompt and self.autoindent and line.isspace() and
2297 2298 (0 < abs(len(line) - self.indent_current_nsp) <= 2 or
2298 2299 (self.buffer[-1]).isspace() )):
2299 2300 line = ''
2300 2301
2301 2302 self.log(line,line,continue_prompt)
2302 2303 return line
2303 2304
2304 2305 def handle_alias(self,line_info):
2305 2306 """Handle alias input lines. """
2306 2307 tgt = self.alias_table[line_info.iFun]
2307 2308 # print "=>",tgt #dbg
2308 2309 if callable(tgt):
2309 2310 if '$' in line_info.line:
2310 2311 call_meth = '(_ip, _ip.itpl(%s))'
2311 2312 else:
2312 2313 call_meth = '(_ip,%s)'
2313 2314 line_out = ("%s_sh.%s" + call_meth) % (line_info.preWhitespace,
2314 2315 line_info.iFun,
2315 2316 make_quoted_expr(line_info.line))
2316 2317 else:
2317 2318 transformed = self.expand_aliases(line_info.iFun,line_info.theRest)
2318 2319
2319 2320 # pre is needed, because it carries the leading whitespace. Otherwise
2320 2321 # aliases won't work in indented sections.
2321 2322 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2322 2323 make_quoted_expr( transformed ))
2323 2324
2324 2325 self.log(line_info.line,line_out,line_info.continue_prompt)
2325 2326 #print 'line out:',line_out # dbg
2326 2327 return line_out
2327 2328
2328 2329 def handle_shell_escape(self, line_info):
2329 2330 """Execute the line in a shell, empty return value"""
2330 2331 #print 'line in :', `line` # dbg
2331 2332 line = line_info.line
2332 2333 if line.lstrip().startswith('!!'):
2333 2334 # rewrite LineInfo's line, iFun and theRest to properly hold the
2334 2335 # call to %sx and the actual command to be executed, so
2335 2336 # handle_magic can work correctly. Note that this works even if
2336 2337 # the line is indented, so it handles multi_line_specials
2337 2338 # properly.
2338 2339 new_rest = line.lstrip()[2:]
2339 2340 line_info.line = '%ssx %s' % (self.ESC_MAGIC,new_rest)
2340 2341 line_info.iFun = 'sx'
2341 2342 line_info.theRest = new_rest
2342 2343 return self.handle_magic(line_info)
2343 2344 else:
2344 2345 cmd = line.lstrip().lstrip('!')
2345 2346 line_out = '%s_ip.system(%s)' % (line_info.preWhitespace,
2346 2347 make_quoted_expr(cmd))
2347 2348 # update cache/log and return
2348 2349 self.log(line,line_out,line_info.continue_prompt)
2349 2350 return line_out
2350 2351
2351 2352 def handle_magic(self, line_info):
2352 2353 """Execute magic functions."""
2353 2354 iFun = line_info.iFun
2354 2355 theRest = line_info.theRest
2355 2356 cmd = '%s_ip.magic(%s)' % (line_info.preWhitespace,
2356 2357 make_quoted_expr(iFun + " " + theRest))
2357 2358 self.log(line_info.line,cmd,line_info.continue_prompt)
2358 2359 #print 'in handle_magic, cmd=<%s>' % cmd # dbg
2359 2360 return cmd
2360 2361
2361 2362 def handle_auto(self, line_info):
2362 2363 """Hande lines which can be auto-executed, quoting if requested."""
2363 2364
2364 2365 #print 'pre <%s> iFun <%s> rest <%s>' % (pre,iFun,theRest) # dbg
2365 2366 line = line_info.line
2366 2367 iFun = line_info.iFun
2367 2368 theRest = line_info.theRest
2368 2369 pre = line_info.pre
2369 2370 continue_prompt = line_info.continue_prompt
2370 2371 obj = line_info.ofind(self)['obj']
2371 2372
2372 2373 # This should only be active for single-line input!
2373 2374 if continue_prompt:
2374 2375 self.log(line,line,continue_prompt)
2375 2376 return line
2376 2377
2377 2378 force_auto = isinstance(obj, IPython.ipapi.IPyAutocall)
2378 2379 auto_rewrite = True
2379 2380
2380 2381 if pre == self.ESC_QUOTE:
2381 2382 # Auto-quote splitting on whitespace
2382 2383 newcmd = '%s("%s")' % (iFun,'", "'.join(theRest.split()) )
2383 2384 elif pre == self.ESC_QUOTE2:
2384 2385 # Auto-quote whole string
2385 2386 newcmd = '%s("%s")' % (iFun,theRest)
2386 2387 elif pre == self.ESC_PAREN:
2387 2388 newcmd = '%s(%s)' % (iFun,",".join(theRest.split()))
2388 2389 else:
2389 2390 # Auto-paren.
2390 2391 # We only apply it to argument-less calls if the autocall
2391 2392 # parameter is set to 2. We only need to check that autocall is <
2392 2393 # 2, since this function isn't called unless it's at least 1.
2393 2394 if not theRest and (self.rc.autocall < 2) and not force_auto:
2394 2395 newcmd = '%s %s' % (iFun,theRest)
2395 2396 auto_rewrite = False
2396 2397 else:
2397 2398 if not force_auto and theRest.startswith('['):
2398 2399 if hasattr(obj,'__getitem__'):
2399 2400 # Don't autocall in this case: item access for an object
2400 2401 # which is BOTH callable and implements __getitem__.
2401 2402 newcmd = '%s %s' % (iFun,theRest)
2402 2403 auto_rewrite = False
2403 2404 else:
2404 2405 # if the object doesn't support [] access, go ahead and
2405 2406 # autocall
2406 2407 newcmd = '%s(%s)' % (iFun.rstrip(),theRest)
2407 2408 elif theRest.endswith(';'):
2408 2409 newcmd = '%s(%s);' % (iFun.rstrip(),theRest[:-1])
2409 2410 else:
2410 2411 newcmd = '%s(%s)' % (iFun.rstrip(), theRest)
2411 2412
2412 2413 if auto_rewrite:
2413 2414 rw = self.outputcache.prompt1.auto_rewrite() + newcmd
2414 2415
2415 2416 try:
2416 2417 # plain ascii works better w/ pyreadline, on some machines, so
2417 2418 # we use it and only print uncolored rewrite if we have unicode
2418 2419 rw = str(rw)
2419 2420 print >>Term.cout, rw
2420 2421 except UnicodeEncodeError:
2421 2422 print "-------------->" + newcmd
2422 2423
2423 2424 # log what is now valid Python, not the actual user input (without the
2424 2425 # final newline)
2425 2426 self.log(line,newcmd,continue_prompt)
2426 2427 return newcmd
2427 2428
2428 2429 def handle_help(self, line_info):
2429 2430 """Try to get some help for the object.
2430 2431
2431 2432 obj? or ?obj -> basic information.
2432 2433 obj?? or ??obj -> more details.
2433 2434 """
2434 2435
2435 2436 line = line_info.line
2436 2437 # We need to make sure that we don't process lines which would be
2437 2438 # otherwise valid python, such as "x=1 # what?"
2438 2439 try:
2439 2440 codeop.compile_command(line)
2440 2441 except SyntaxError:
2441 2442 # We should only handle as help stuff which is NOT valid syntax
2442 2443 if line[0]==self.ESC_HELP:
2443 2444 line = line[1:]
2444 2445 elif line[-1]==self.ESC_HELP:
2445 2446 line = line[:-1]
2446 2447 self.log(line,'#?'+line,line_info.continue_prompt)
2447 2448 if line:
2448 2449 #print 'line:<%r>' % line # dbg
2449 2450 self.magic_pinfo(line)
2450 2451 else:
2451 2452 page(self.usage,screen_lines=self.rc.screen_length)
2452 2453 return '' # Empty string is needed here!
2453 2454 except:
2454 2455 # Pass any other exceptions through to the normal handler
2455 2456 return self.handle_normal(line_info)
2456 2457 else:
2457 2458 # If the code compiles ok, we should handle it normally
2458 2459 return self.handle_normal(line_info)
2459 2460
2460 2461 def getapi(self):
2461 2462 """ Get an IPApi object for this shell instance
2462 2463
2463 2464 Getting an IPApi object is always preferable to accessing the shell
2464 2465 directly, but this holds true especially for extensions.
2465 2466
2466 2467 It should always be possible to implement an extension with IPApi
2467 2468 alone. If not, contact maintainer to request an addition.
2468 2469
2469 2470 """
2470 2471 return self.api
2471 2472
2472 2473 def handle_emacs(self, line_info):
2473 2474 """Handle input lines marked by python-mode."""
2474 2475
2475 2476 # Currently, nothing is done. Later more functionality can be added
2476 2477 # here if needed.
2477 2478
2478 2479 # The input cache shouldn't be updated
2479 2480 return line_info.line
2480 2481
2481 2482
2482 2483 def mktempfile(self,data=None):
2483 2484 """Make a new tempfile and return its filename.
2484 2485
2485 2486 This makes a call to tempfile.mktemp, but it registers the created
2486 2487 filename internally so ipython cleans it up at exit time.
2487 2488
2488 2489 Optional inputs:
2489 2490
2490 2491 - data(None): if data is given, it gets written out to the temp file
2491 2492 immediately, and the file is closed again."""
2492 2493
2493 2494 filename = tempfile.mktemp('.py','ipython_edit_')
2494 2495 self.tempfiles.append(filename)
2495 2496
2496 2497 if data:
2497 2498 tmp_file = open(filename,'w')
2498 2499 tmp_file.write(data)
2499 2500 tmp_file.close()
2500 2501 return filename
2501 2502
2502 2503 def write(self,data):
2503 2504 """Write a string to the default output"""
2504 2505 Term.cout.write(data)
2505 2506
2506 2507 def write_err(self,data):
2507 2508 """Write a string to the default error output"""
2508 2509 Term.cerr.write(data)
2509 2510
2511 def ask_exit(self):
2512 """ Call for exiting. Can be overiden and used as a callback. """
2513 self.exit_now = True
2514
2510 2515 def exit(self):
2511 2516 """Handle interactive exit.
2512 2517
2513 This method sets the exit_now attribute."""
2518 This method calls the ask_exit callback."""
2514 2519
2515 2520 if self.rc.confirm_exit:
2516 2521 if self.ask_yes_no('Do you really want to exit ([y]/n)?','y'):
2517 self.exit_now = True
2522 self.ask_exit()
2518 2523 else:
2519 self.exit_now = True
2524 self.ask_exit()
2520 2525
2521 2526 def safe_execfile(self,fname,*where,**kw):
2522 2527 """A safe version of the builtin execfile().
2523 2528
2524 2529 This version will never throw an exception, and knows how to handle
2525 2530 ipython logs as well.
2526 2531
2527 2532 :Parameters:
2528 2533 fname : string
2529 2534 Name of the file to be executed.
2530 2535
2531 2536 where : tuple
2532 2537 One or two namespaces, passed to execfile() as (globals,locals).
2533 2538 If only one is given, it is passed as both.
2534 2539
2535 2540 :Keywords:
2536 2541 islog : boolean (False)
2537 2542
2538 2543 quiet : boolean (True)
2539 2544
2540 2545 exit_ignore : boolean (False)
2541 2546 """
2542 2547
2543 2548 def syspath_cleanup():
2544 2549 """Internal cleanup routine for sys.path."""
2545 2550 if add_dname:
2546 2551 try:
2547 2552 sys.path.remove(dname)
2548 2553 except ValueError:
2549 2554 # For some reason the user has already removed it, ignore.
2550 2555 pass
2551 2556
2552 2557 fname = os.path.expanduser(fname)
2553 2558
2554 2559 # Find things also in current directory. This is needed to mimic the
2555 2560 # behavior of running a script from the system command line, where
2556 2561 # Python inserts the script's directory into sys.path
2557 2562 dname = os.path.dirname(os.path.abspath(fname))
2558 2563 add_dname = False
2559 2564 if dname not in sys.path:
2560 2565 sys.path.insert(0,dname)
2561 2566 add_dname = True
2562 2567
2563 2568 try:
2564 2569 xfile = open(fname)
2565 2570 except:
2566 2571 print >> Term.cerr, \
2567 2572 'Could not open file <%s> for safe execution.' % fname
2568 2573 syspath_cleanup()
2569 2574 return None
2570 2575
2571 2576 kw.setdefault('islog',0)
2572 2577 kw.setdefault('quiet',1)
2573 2578 kw.setdefault('exit_ignore',0)
2574 2579
2575 2580 first = xfile.readline()
2576 2581 loghead = str(self.loghead_tpl).split('\n',1)[0].strip()
2577 2582 xfile.close()
2578 2583 # line by line execution
2579 2584 if first.startswith(loghead) or kw['islog']:
2580 2585 print 'Loading log file <%s> one line at a time...' % fname
2581 2586 if kw['quiet']:
2582 2587 stdout_save = sys.stdout
2583 2588 sys.stdout = StringIO.StringIO()
2584 2589 try:
2585 2590 globs,locs = where[0:2]
2586 2591 except:
2587 2592 try:
2588 2593 globs = locs = where[0]
2589 2594 except:
2590 2595 globs = locs = globals()
2591 2596 badblocks = []
2592 2597
2593 2598 # we also need to identify indented blocks of code when replaying
2594 2599 # logs and put them together before passing them to an exec
2595 2600 # statement. This takes a bit of regexp and look-ahead work in the
2596 2601 # file. It's easiest if we swallow the whole thing in memory
2597 2602 # first, and manually walk through the lines list moving the
2598 2603 # counter ourselves.
2599 2604 indent_re = re.compile('\s+\S')
2600 2605 xfile = open(fname)
2601 2606 filelines = xfile.readlines()
2602 2607 xfile.close()
2603 2608 nlines = len(filelines)
2604 2609 lnum = 0
2605 2610 while lnum < nlines:
2606 2611 line = filelines[lnum]
2607 2612 lnum += 1
2608 2613 # don't re-insert logger status info into cache
2609 2614 if line.startswith('#log#'):
2610 2615 continue
2611 2616 else:
2612 2617 # build a block of code (maybe a single line) for execution
2613 2618 block = line
2614 2619 try:
2615 2620 next = filelines[lnum] # lnum has already incremented
2616 2621 except:
2617 2622 next = None
2618 2623 while next and indent_re.match(next):
2619 2624 block += next
2620 2625 lnum += 1
2621 2626 try:
2622 2627 next = filelines[lnum]
2623 2628 except:
2624 2629 next = None
2625 2630 # now execute the block of one or more lines
2626 2631 try:
2627 2632 exec block in globs,locs
2628 2633 except SystemExit:
2629 2634 pass
2630 2635 except:
2631 2636 badblocks.append(block.rstrip())
2632 2637 if kw['quiet']: # restore stdout
2633 2638 sys.stdout.close()
2634 2639 sys.stdout = stdout_save
2635 2640 print 'Finished replaying log file <%s>' % fname
2636 2641 if badblocks:
2637 2642 print >> sys.stderr, ('\nThe following lines/blocks in file '
2638 2643 '<%s> reported errors:' % fname)
2639 2644
2640 2645 for badline in badblocks:
2641 2646 print >> sys.stderr, badline
2642 2647 else: # regular file execution
2643 2648 try:
2644 2649 if sys.platform == 'win32' and sys.version_info < (2,5,1):
2645 2650 # Work around a bug in Python for Windows. The bug was
2646 2651 # fixed in in Python 2.5 r54159 and 54158, but that's still
2647 2652 # SVN Python as of March/07. For details, see:
2648 2653 # http://projects.scipy.org/ipython/ipython/ticket/123
2649 2654 try:
2650 2655 globs,locs = where[0:2]
2651 2656 except:
2652 2657 try:
2653 2658 globs = locs = where[0]
2654 2659 except:
2655 2660 globs = locs = globals()
2656 2661 exec file(fname) in globs,locs
2657 2662 else:
2658 2663 execfile(fname,*where)
2659 2664 except SyntaxError:
2660 2665 self.showsyntaxerror()
2661 2666 warn('Failure executing file: <%s>' % fname)
2662 2667 except SystemExit,status:
2663 2668 # Code that correctly sets the exit status flag to success (0)
2664 2669 # shouldn't be bothered with a traceback. Note that a plain
2665 2670 # sys.exit() does NOT set the message to 0 (it's empty) so that
2666 2671 # will still get a traceback. Note that the structure of the
2667 2672 # SystemExit exception changed between Python 2.4 and 2.5, so
2668 2673 # the checks must be done in a version-dependent way.
2669 2674 show = False
2670 2675
2671 2676 if sys.version_info[:2] > (2,5):
2672 2677 if status.message!=0 and not kw['exit_ignore']:
2673 2678 show = True
2674 2679 else:
2675 2680 if status.code and not kw['exit_ignore']:
2676 2681 show = True
2677 2682 if show:
2678 2683 self.showtraceback()
2679 2684 warn('Failure executing file: <%s>' % fname)
2680 2685 except:
2681 2686 self.showtraceback()
2682 2687 warn('Failure executing file: <%s>' % fname)
2683 2688
2684 2689 syspath_cleanup()
2685 2690
2686 2691 #************************* end of file <iplib.py> *****************************
General Comments 0
You need to be logged in to leave comments. Login now