##// END OF EJS Templates
Fix bug with aliases, exposed by windows test suite.
Fernando Perez -
Show More
@@ -1,3612 +1,3613 b''
1 1 # -*- coding: utf-8 -*-
2 2 """Magic functions for InteractiveShell.
3 3 """
4 4
5 5 #*****************************************************************************
6 6 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
7 7 # Copyright (C) 2001-2006 Fernando Perez <fperez@colorado.edu>
8 8 #
9 9 # Distributed under the terms of the BSD License. The full license is in
10 10 # the file COPYING, distributed as part of this software.
11 11 #*****************************************************************************
12 12
13 13 #****************************************************************************
14 14 # Modules and globals
15 15
16 16 # Python standard modules
17 17 import __builtin__
18 18 import bdb
19 19 import inspect
20 20 import os
21 21 import pdb
22 22 import pydoc
23 23 import sys
24 24 import shutil
25 25 import re
26 26 import tempfile
27 27 import time
28 28 import cPickle as pickle
29 29 import textwrap
30 30 from cStringIO import StringIO
31 31 from getopt import getopt,GetoptError
32 32 from pprint import pprint, pformat
33 33
34 34 # cProfile was added in Python2.5
35 35 try:
36 36 import cProfile as profile
37 37 import pstats
38 38 except ImportError:
39 39 # profile isn't bundled by default in Debian for license reasons
40 40 try:
41 41 import profile,pstats
42 42 except ImportError:
43 43 profile = pstats = None
44 44
45 45 # Homebrewed
46 46 import IPython
47 47 import IPython.utils.generics
48 48
49 49 from IPython.core import debugger, oinspect
50 50 from IPython.core.error import TryNext
51 51 from IPython.core.error import UsageError
52 52 from IPython.core.fakemodule import FakeModule
53 53 from IPython.core.macro import Macro
54 54 from IPython.core.page import page
55 55 from IPython.core.prefilter import ESC_MAGIC
56 56 from IPython.core.pylabtools import mpl_runner
57 57 from IPython.lib.inputhook import enable_gui
58 58 from IPython.external.Itpl import Itpl, itpl, printpl,itplns
59 59 from IPython.testing import decorators as testdec
60 60 from IPython.utils import platutils
61 61 from IPython.utils import wildcard
62 62 from IPython.utils.PyColorize import Parser
63 63 from IPython.utils.ipstruct import Struct
64 64
65 65 # XXX - We need to switch to explicit imports here with genutils
66 66 from IPython.utils.genutils import *
67 67
68 68 #***************************************************************************
69 69 # Utility functions
70 70 def on_off(tag):
71 71 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
72 72 return ['OFF','ON'][tag]
73 73
74 74 class Bunch: pass
75 75
76 76 def compress_dhist(dh):
77 77 head, tail = dh[:-10], dh[-10:]
78 78
79 79 newhead = []
80 80 done = set()
81 81 for h in head:
82 82 if h in done:
83 83 continue
84 84 newhead.append(h)
85 85 done.add(h)
86 86
87 87 return newhead + tail
88 88
89 89
90 90 #***************************************************************************
91 91 # Main class implementing Magic functionality
92 92
93 93 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
94 94 # on construction of the main InteractiveShell object. Something odd is going
95 95 # on with super() calls, Component and the MRO... For now leave it as-is, but
96 96 # eventually this needs to be clarified.
97 97
98 98 class Magic:
99 99 """Magic functions for InteractiveShell.
100 100
101 101 Shell functions which can be reached as %function_name. All magic
102 102 functions should accept a string, which they can parse for their own
103 103 needs. This can make some functions easier to type, eg `%cd ../`
104 104 vs. `%cd("../")`
105 105
106 106 ALL definitions MUST begin with the prefix magic_. The user won't need it
107 107 at the command line, but it is is needed in the definition. """
108 108
109 109 # class globals
110 110 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
111 111 'Automagic is ON, % prefix NOT needed for magic functions.']
112 112
113 113 #......................................................................
114 114 # some utility functions
115 115
116 116 def __init__(self,shell):
117 117
118 118 self.options_table = {}
119 119 if profile is None:
120 120 self.magic_prun = self.profile_missing_notice
121 121 self.shell = shell
122 122
123 123 # namespace for holding state we may need
124 124 self._magic_state = Bunch()
125 125
126 126 def profile_missing_notice(self, *args, **kwargs):
127 127 error("""\
128 128 The profile module could not be found. It has been removed from the standard
129 129 python packages because of its non-free license. To use profiling, install the
130 130 python-profiler package from non-free.""")
131 131
132 132 def default_option(self,fn,optstr):
133 133 """Make an entry in the options_table for fn, with value optstr"""
134 134
135 135 if fn not in self.lsmagic():
136 136 error("%s is not a magic function" % fn)
137 137 self.options_table[fn] = optstr
138 138
139 139 def lsmagic(self):
140 140 """Return a list of currently available magic functions.
141 141
142 142 Gives a list of the bare names after mangling (['ls','cd', ...], not
143 143 ['magic_ls','magic_cd',...]"""
144 144
145 145 # FIXME. This needs a cleanup, in the way the magics list is built.
146 146
147 147 # magics in class definition
148 148 class_magic = lambda fn: fn.startswith('magic_') and \
149 149 callable(Magic.__dict__[fn])
150 150 # in instance namespace (run-time user additions)
151 151 inst_magic = lambda fn: fn.startswith('magic_') and \
152 152 callable(self.__dict__[fn])
153 153 # and bound magics by user (so they can access self):
154 154 inst_bound_magic = lambda fn: fn.startswith('magic_') and \
155 155 callable(self.__class__.__dict__[fn])
156 156 magics = filter(class_magic,Magic.__dict__.keys()) + \
157 157 filter(inst_magic,self.__dict__.keys()) + \
158 158 filter(inst_bound_magic,self.__class__.__dict__.keys())
159 159 out = []
160 160 for fn in set(magics):
161 161 out.append(fn.replace('magic_','',1))
162 162 out.sort()
163 163 return out
164 164
165 165 def extract_input_slices(self,slices,raw=False):
166 166 """Return as a string a set of input history slices.
167 167
168 168 Inputs:
169 169
170 170 - slices: the set of slices is given as a list of strings (like
171 171 ['1','4:8','9'], since this function is for use by magic functions
172 172 which get their arguments as strings.
173 173
174 174 Optional inputs:
175 175
176 176 - raw(False): by default, the processed input is used. If this is
177 177 true, the raw input history is used instead.
178 178
179 179 Note that slices can be called with two notations:
180 180
181 181 N:M -> standard python form, means including items N...(M-1).
182 182
183 183 N-M -> include items N..M (closed endpoint)."""
184 184
185 185 if raw:
186 186 hist = self.shell.input_hist_raw
187 187 else:
188 188 hist = self.shell.input_hist
189 189
190 190 cmds = []
191 191 for chunk in slices:
192 192 if ':' in chunk:
193 193 ini,fin = map(int,chunk.split(':'))
194 194 elif '-' in chunk:
195 195 ini,fin = map(int,chunk.split('-'))
196 196 fin += 1
197 197 else:
198 198 ini = int(chunk)
199 199 fin = ini+1
200 200 cmds.append(hist[ini:fin])
201 201 return cmds
202 202
203 203 def _ofind(self, oname, namespaces=None):
204 204 """Find an object in the available namespaces.
205 205
206 206 self._ofind(oname) -> dict with keys: found,obj,ospace,ismagic
207 207
208 208 Has special code to detect magic functions.
209 209 """
210 210
211 211 oname = oname.strip()
212 212
213 213 alias_ns = None
214 214 if namespaces is None:
215 215 # Namespaces to search in:
216 216 # Put them in a list. The order is important so that we
217 217 # find things in the same order that Python finds them.
218 218 namespaces = [ ('Interactive', self.shell.user_ns),
219 219 ('IPython internal', self.shell.internal_ns),
220 220 ('Python builtin', __builtin__.__dict__),
221 221 ('Alias', self.shell.alias_manager.alias_table),
222 222 ]
223 223 alias_ns = self.shell.alias_manager.alias_table
224 224
225 225 # initialize results to 'null'
226 226 found = 0; obj = None; ospace = None; ds = None;
227 227 ismagic = 0; isalias = 0; parent = None
228 228
229 229 # Look for the given name by splitting it in parts. If the head is
230 230 # found, then we look for all the remaining parts as members, and only
231 231 # declare success if we can find them all.
232 232 oname_parts = oname.split('.')
233 233 oname_head, oname_rest = oname_parts[0],oname_parts[1:]
234 234 for nsname,ns in namespaces:
235 235 try:
236 236 obj = ns[oname_head]
237 237 except KeyError:
238 238 continue
239 239 else:
240 240 #print 'oname_rest:', oname_rest # dbg
241 241 for part in oname_rest:
242 242 try:
243 243 parent = obj
244 244 obj = getattr(obj,part)
245 245 except:
246 246 # Blanket except b/c some badly implemented objects
247 247 # allow __getattr__ to raise exceptions other than
248 248 # AttributeError, which then crashes IPython.
249 249 break
250 250 else:
251 251 # If we finish the for loop (no break), we got all members
252 252 found = 1
253 253 ospace = nsname
254 254 if ns == alias_ns:
255 255 isalias = 1
256 256 break # namespace loop
257 257
258 258 # Try to see if it's magic
259 259 if not found:
260 260 if oname.startswith(ESC_MAGIC):
261 261 oname = oname[1:]
262 262 obj = getattr(self,'magic_'+oname,None)
263 263 if obj is not None:
264 264 found = 1
265 265 ospace = 'IPython internal'
266 266 ismagic = 1
267 267
268 268 # Last try: special-case some literals like '', [], {}, etc:
269 269 if not found and oname_head in ["''",'""','[]','{}','()']:
270 270 obj = eval(oname_head)
271 271 found = 1
272 272 ospace = 'Interactive'
273 273
274 274 return {'found':found, 'obj':obj, 'namespace':ospace,
275 275 'ismagic':ismagic, 'isalias':isalias, 'parent':parent}
276 276
277 277 def arg_err(self,func):
278 278 """Print docstring if incorrect arguments were passed"""
279 279 print 'Error in arguments:'
280 280 print OInspect.getdoc(func)
281 281
282 282 def format_latex(self,strng):
283 283 """Format a string for latex inclusion."""
284 284
285 285 # Characters that need to be escaped for latex:
286 286 escape_re = re.compile(r'(%|_|\$|#|&)',re.MULTILINE)
287 287 # Magic command names as headers:
288 288 cmd_name_re = re.compile(r'^(%s.*?):' % ESC_MAGIC,
289 289 re.MULTILINE)
290 290 # Magic commands
291 291 cmd_re = re.compile(r'(?P<cmd>%s.+?\b)(?!\}\}:)' % ESC_MAGIC,
292 292 re.MULTILINE)
293 293 # Paragraph continue
294 294 par_re = re.compile(r'\\$',re.MULTILINE)
295 295
296 296 # The "\n" symbol
297 297 newline_re = re.compile(r'\\n')
298 298
299 299 # Now build the string for output:
300 300 #strng = cmd_name_re.sub(r'\n\\texttt{\\textsl{\\large \1}}:',strng)
301 301 strng = cmd_name_re.sub(r'\n\\bigskip\n\\texttt{\\textbf{ \1}}:',
302 302 strng)
303 303 strng = cmd_re.sub(r'\\texttt{\g<cmd>}',strng)
304 304 strng = par_re.sub(r'\\\\',strng)
305 305 strng = escape_re.sub(r'\\\1',strng)
306 306 strng = newline_re.sub(r'\\textbackslash{}n',strng)
307 307 return strng
308 308
309 309 def format_screen(self,strng):
310 310 """Format a string for screen printing.
311 311
312 312 This removes some latex-type format codes."""
313 313 # Paragraph continue
314 314 par_re = re.compile(r'\\$',re.MULTILINE)
315 315 strng = par_re.sub('',strng)
316 316 return strng
317 317
318 318 def parse_options(self,arg_str,opt_str,*long_opts,**kw):
319 319 """Parse options passed to an argument string.
320 320
321 321 The interface is similar to that of getopt(), but it returns back a
322 322 Struct with the options as keys and the stripped argument string still
323 323 as a string.
324 324
325 325 arg_str is quoted as a true sys.argv vector by using shlex.split.
326 326 This allows us to easily expand variables, glob files, quote
327 327 arguments, etc.
328 328
329 329 Options:
330 330 -mode: default 'string'. If given as 'list', the argument string is
331 331 returned as a list (split on whitespace) instead of a string.
332 332
333 333 -list_all: put all option values in lists. Normally only options
334 334 appearing more than once are put in a list.
335 335
336 336 -posix (True): whether to split the input line in POSIX mode or not,
337 337 as per the conventions outlined in the shlex module from the
338 338 standard library."""
339 339
340 340 # inject default options at the beginning of the input line
341 341 caller = sys._getframe(1).f_code.co_name.replace('magic_','')
342 342 arg_str = '%s %s' % (self.options_table.get(caller,''),arg_str)
343 343
344 344 mode = kw.get('mode','string')
345 345 if mode not in ['string','list']:
346 346 raise ValueError,'incorrect mode given: %s' % mode
347 347 # Get options
348 348 list_all = kw.get('list_all',0)
349 349 posix = kw.get('posix',True)
350 350
351 351 # Check if we have more than one argument to warrant extra processing:
352 352 odict = {} # Dictionary with options
353 353 args = arg_str.split()
354 354 if len(args) >= 1:
355 355 # If the list of inputs only has 0 or 1 thing in it, there's no
356 356 # need to look for options
357 357 argv = arg_split(arg_str,posix)
358 358 # Do regular option processing
359 359 try:
360 360 opts,args = getopt(argv,opt_str,*long_opts)
361 361 except GetoptError,e:
362 362 raise UsageError('%s ( allowed: "%s" %s)' % (e.msg,opt_str,
363 363 " ".join(long_opts)))
364 364 for o,a in opts:
365 365 if o.startswith('--'):
366 366 o = o[2:]
367 367 else:
368 368 o = o[1:]
369 369 try:
370 370 odict[o].append(a)
371 371 except AttributeError:
372 372 odict[o] = [odict[o],a]
373 373 except KeyError:
374 374 if list_all:
375 375 odict[o] = [a]
376 376 else:
377 377 odict[o] = a
378 378
379 379 # Prepare opts,args for return
380 380 opts = Struct(odict)
381 381 if mode == 'string':
382 382 args = ' '.join(args)
383 383
384 384 return opts,args
385 385
386 386 #......................................................................
387 387 # And now the actual magic functions
388 388
389 389 # Functions for IPython shell work (vars,funcs, config, etc)
390 390 def magic_lsmagic(self, parameter_s = ''):
391 391 """List currently available magic functions."""
392 392 mesc = ESC_MAGIC
393 393 print 'Available magic functions:\n'+mesc+\
394 394 (' '+mesc).join(self.lsmagic())
395 395 print '\n' + Magic.auto_status[self.shell.automagic]
396 396 return None
397 397
398 398 def magic_magic(self, parameter_s = ''):
399 399 """Print information about the magic function system.
400 400
401 401 Supported formats: -latex, -brief, -rest
402 402 """
403 403
404 404 mode = ''
405 405 try:
406 406 if parameter_s.split()[0] == '-latex':
407 407 mode = 'latex'
408 408 if parameter_s.split()[0] == '-brief':
409 409 mode = 'brief'
410 410 if parameter_s.split()[0] == '-rest':
411 411 mode = 'rest'
412 412 rest_docs = []
413 413 except:
414 414 pass
415 415
416 416 magic_docs = []
417 417 for fname in self.lsmagic():
418 418 mname = 'magic_' + fname
419 419 for space in (Magic,self,self.__class__):
420 420 try:
421 421 fn = space.__dict__[mname]
422 422 except KeyError:
423 423 pass
424 424 else:
425 425 break
426 426 if mode == 'brief':
427 427 # only first line
428 428 if fn.__doc__:
429 429 fndoc = fn.__doc__.split('\n',1)[0]
430 430 else:
431 431 fndoc = 'No documentation'
432 432 else:
433 433 if fn.__doc__:
434 434 fndoc = fn.__doc__.rstrip()
435 435 else:
436 436 fndoc = 'No documentation'
437 437
438 438
439 439 if mode == 'rest':
440 440 rest_docs.append('**%s%s**::\n\n\t%s\n\n' %(ESC_MAGIC,
441 441 fname,fndoc))
442 442
443 443 else:
444 444 magic_docs.append('%s%s:\n\t%s\n' %(ESC_MAGIC,
445 445 fname,fndoc))
446 446
447 447 magic_docs = ''.join(magic_docs)
448 448
449 449 if mode == 'rest':
450 450 return "".join(rest_docs)
451 451
452 452 if mode == 'latex':
453 453 print self.format_latex(magic_docs)
454 454 return
455 455 else:
456 456 magic_docs = self.format_screen(magic_docs)
457 457 if mode == 'brief':
458 458 return magic_docs
459 459
460 460 outmsg = """
461 461 IPython's 'magic' functions
462 462 ===========================
463 463
464 464 The magic function system provides a series of functions which allow you to
465 465 control the behavior of IPython itself, plus a lot of system-type
466 466 features. All these functions are prefixed with a % character, but parameters
467 467 are given without parentheses or quotes.
468 468
469 469 NOTE: If you have 'automagic' enabled (via the command line option or with the
470 470 %automagic function), you don't need to type in the % explicitly. By default,
471 471 IPython ships with automagic on, so you should only rarely need the % escape.
472 472
473 473 Example: typing '%cd mydir' (without the quotes) changes you working directory
474 474 to 'mydir', if it exists.
475 475
476 476 You can define your own magic functions to extend the system. See the supplied
477 477 ipythonrc and example-magic.py files for details (in your ipython
478 478 configuration directory, typically $HOME/.ipython/).
479 479
480 480 You can also define your own aliased names for magic functions. In your
481 481 ipythonrc file, placing a line like:
482 482
483 483 execute __IPYTHON__.magic_pf = __IPYTHON__.magic_profile
484 484
485 485 will define %pf as a new name for %profile.
486 486
487 487 You can also call magics in code using the magic() function, which IPython
488 488 automatically adds to the builtin namespace. Type 'magic?' for details.
489 489
490 490 For a list of the available magic functions, use %lsmagic. For a description
491 491 of any of them, type %magic_name?, e.g. '%cd?'.
492 492
493 493 Currently the magic system has the following functions:\n"""
494 494
495 495 mesc = ESC_MAGIC
496 496 outmsg = ("%s\n%s\n\nSummary of magic functions (from %slsmagic):"
497 497 "\n\n%s%s\n\n%s" % (outmsg,
498 498 magic_docs,mesc,mesc,
499 499 (' '+mesc).join(self.lsmagic()),
500 500 Magic.auto_status[self.shell.automagic] ) )
501 501
502 502 page(outmsg,screen_lines=self.shell.usable_screen_length)
503 503
504 504
505 505 def magic_autoindent(self, parameter_s = ''):
506 506 """Toggle autoindent on/off (if available)."""
507 507
508 508 self.shell.set_autoindent()
509 509 print "Automatic indentation is:",['OFF','ON'][self.shell.autoindent]
510 510
511 511
512 512 def magic_automagic(self, parameter_s = ''):
513 513 """Make magic functions callable without having to type the initial %.
514 514
515 515 Without argumentsl toggles on/off (when off, you must call it as
516 516 %automagic, of course). With arguments it sets the value, and you can
517 517 use any of (case insensitive):
518 518
519 519 - on,1,True: to activate
520 520
521 521 - off,0,False: to deactivate.
522 522
523 523 Note that magic functions have lowest priority, so if there's a
524 524 variable whose name collides with that of a magic fn, automagic won't
525 525 work for that function (you get the variable instead). However, if you
526 526 delete the variable (del var), the previously shadowed magic function
527 527 becomes visible to automagic again."""
528 528
529 529 arg = parameter_s.lower()
530 530 if parameter_s in ('on','1','true'):
531 531 self.shell.automagic = True
532 532 elif parameter_s in ('off','0','false'):
533 533 self.shell.automagic = False
534 534 else:
535 535 self.shell.automagic = not self.shell.automagic
536 536 print '\n' + Magic.auto_status[self.shell.automagic]
537 537
538 538 @testdec.skip_doctest
539 539 def magic_autocall(self, parameter_s = ''):
540 540 """Make functions callable without having to type parentheses.
541 541
542 542 Usage:
543 543
544 544 %autocall [mode]
545 545
546 546 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
547 547 value is toggled on and off (remembering the previous state).
548 548
549 549 In more detail, these values mean:
550 550
551 551 0 -> fully disabled
552 552
553 553 1 -> active, but do not apply if there are no arguments on the line.
554 554
555 555 In this mode, you get:
556 556
557 557 In [1]: callable
558 558 Out[1]: <built-in function callable>
559 559
560 560 In [2]: callable 'hello'
561 561 ------> callable('hello')
562 562 Out[2]: False
563 563
564 564 2 -> Active always. Even if no arguments are present, the callable
565 565 object is called:
566 566
567 567 In [2]: float
568 568 ------> float()
569 569 Out[2]: 0.0
570 570
571 571 Note that even with autocall off, you can still use '/' at the start of
572 572 a line to treat the first argument on the command line as a function
573 573 and add parentheses to it:
574 574
575 575 In [8]: /str 43
576 576 ------> str(43)
577 577 Out[8]: '43'
578 578
579 579 # all-random (note for auto-testing)
580 580 """
581 581
582 582 if parameter_s:
583 583 arg = int(parameter_s)
584 584 else:
585 585 arg = 'toggle'
586 586
587 587 if not arg in (0,1,2,'toggle'):
588 588 error('Valid modes: (0->Off, 1->Smart, 2->Full')
589 589 return
590 590
591 591 if arg in (0,1,2):
592 592 self.shell.autocall = arg
593 593 else: # toggle
594 594 if self.shell.autocall:
595 595 self._magic_state.autocall_save = self.shell.autocall
596 596 self.shell.autocall = 0
597 597 else:
598 598 try:
599 599 self.shell.autocall = self._magic_state.autocall_save
600 600 except AttributeError:
601 601 self.shell.autocall = self._magic_state.autocall_save = 1
602 602
603 603 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
604 604
605 605 def magic_system_verbose(self, parameter_s = ''):
606 606 """Set verbose printing of system calls.
607 607
608 608 If called without an argument, act as a toggle"""
609 609
610 610 if parameter_s:
611 611 val = bool(eval(parameter_s))
612 612 else:
613 613 val = None
614 614
615 615 if self.shell.system_verbose:
616 616 self.shell.system_verbose = False
617 617 else:
618 618 self.shell.system_verbose = True
619 619 print "System verbose printing is:",\
620 620 ['OFF','ON'][self.shell.system_verbose]
621 621
622 622
623 623 def magic_page(self, parameter_s=''):
624 624 """Pretty print the object and display it through a pager.
625 625
626 626 %page [options] OBJECT
627 627
628 628 If no object is given, use _ (last output).
629 629
630 630 Options:
631 631
632 632 -r: page str(object), don't pretty-print it."""
633 633
634 634 # After a function contributed by Olivier Aubert, slightly modified.
635 635
636 636 # Process options/args
637 637 opts,args = self.parse_options(parameter_s,'r')
638 638 raw = 'r' in opts
639 639
640 640 oname = args and args or '_'
641 641 info = self._ofind(oname)
642 642 if info['found']:
643 643 txt = (raw and str or pformat)( info['obj'] )
644 644 page(txt)
645 645 else:
646 646 print 'Object `%s` not found' % oname
647 647
648 648 def magic_profile(self, parameter_s=''):
649 649 """Print your currently active IPyhton profile."""
650 650 if self.shell.profile:
651 651 printpl('Current IPython profile: $self.shell.profile.')
652 652 else:
653 653 print 'No profile active.'
654 654
655 655 def magic_pinfo(self, parameter_s='', namespaces=None):
656 656 """Provide detailed information about an object.
657 657
658 658 '%pinfo object' is just a synonym for object? or ?object."""
659 659
660 660 #print 'pinfo par: <%s>' % parameter_s # dbg
661 661
662 662
663 663 # detail_level: 0 -> obj? , 1 -> obj??
664 664 detail_level = 0
665 665 # We need to detect if we got called as 'pinfo pinfo foo', which can
666 666 # happen if the user types 'pinfo foo?' at the cmd line.
667 667 pinfo,qmark1,oname,qmark2 = \
668 668 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
669 669 if pinfo or qmark1 or qmark2:
670 670 detail_level = 1
671 671 if "*" in oname:
672 672 self.magic_psearch(oname)
673 673 else:
674 674 self._inspect('pinfo', oname, detail_level=detail_level,
675 675 namespaces=namespaces)
676 676
677 677 def magic_pdef(self, parameter_s='', namespaces=None):
678 678 """Print the definition header for any callable object.
679 679
680 680 If the object is a class, print the constructor information."""
681 681 self._inspect('pdef',parameter_s, namespaces)
682 682
683 683 def magic_pdoc(self, parameter_s='', namespaces=None):
684 684 """Print the docstring for an object.
685 685
686 686 If the given object is a class, it will print both the class and the
687 687 constructor docstrings."""
688 688 self._inspect('pdoc',parameter_s, namespaces)
689 689
690 690 def magic_psource(self, parameter_s='', namespaces=None):
691 691 """Print (or run through pager) the source code for an object."""
692 692 self._inspect('psource',parameter_s, namespaces)
693 693
694 694 def magic_pfile(self, parameter_s=''):
695 695 """Print (or run through pager) the file where an object is defined.
696 696
697 697 The file opens at the line where the object definition begins. IPython
698 698 will honor the environment variable PAGER if set, and otherwise will
699 699 do its best to print the file in a convenient form.
700 700
701 701 If the given argument is not an object currently defined, IPython will
702 702 try to interpret it as a filename (automatically adding a .py extension
703 703 if needed). You can thus use %pfile as a syntax highlighting code
704 704 viewer."""
705 705
706 706 # first interpret argument as an object name
707 707 out = self._inspect('pfile',parameter_s)
708 708 # if not, try the input as a filename
709 709 if out == 'not found':
710 710 try:
711 711 filename = get_py_filename(parameter_s)
712 712 except IOError,msg:
713 713 print msg
714 714 return
715 715 page(self.shell.inspector.format(file(filename).read()))
716 716
717 717 def _inspect(self,meth,oname,namespaces=None,**kw):
718 718 """Generic interface to the inspector system.
719 719
720 720 This function is meant to be called by pdef, pdoc & friends."""
721 721
722 722 #oname = oname.strip()
723 723 #print '1- oname: <%r>' % oname # dbg
724 724 try:
725 725 oname = oname.strip().encode('ascii')
726 726 #print '2- oname: <%r>' % oname # dbg
727 727 except UnicodeEncodeError:
728 728 print 'Python identifiers can only contain ascii characters.'
729 729 return 'not found'
730 730
731 731 info = Struct(self._ofind(oname, namespaces))
732 732
733 733 if info.found:
734 734 try:
735 735 IPython.utils.generics.inspect_object(info.obj)
736 736 return
737 737 except TryNext:
738 738 pass
739 739 # Get the docstring of the class property if it exists.
740 740 path = oname.split('.')
741 741 root = '.'.join(path[:-1])
742 742 if info.parent is not None:
743 743 try:
744 744 target = getattr(info.parent, '__class__')
745 745 # The object belongs to a class instance.
746 746 try:
747 747 target = getattr(target, path[-1])
748 748 # The class defines the object.
749 749 if isinstance(target, property):
750 750 oname = root + '.__class__.' + path[-1]
751 751 info = Struct(self._ofind(oname))
752 752 except AttributeError: pass
753 753 except AttributeError: pass
754 754
755 755 pmethod = getattr(self.shell.inspector,meth)
756 756 formatter = info.ismagic and self.format_screen or None
757 757 if meth == 'pdoc':
758 758 pmethod(info.obj,oname,formatter)
759 759 elif meth == 'pinfo':
760 760 pmethod(info.obj,oname,formatter,info,**kw)
761 761 else:
762 762 pmethod(info.obj,oname)
763 763 else:
764 764 print 'Object `%s` not found.' % oname
765 765 return 'not found' # so callers can take other action
766 766
767 767 def magic_psearch(self, parameter_s=''):
768 768 """Search for object in namespaces by wildcard.
769 769
770 770 %psearch [options] PATTERN [OBJECT TYPE]
771 771
772 772 Note: ? can be used as a synonym for %psearch, at the beginning or at
773 773 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
774 774 rest of the command line must be unchanged (options come first), so
775 775 for example the following forms are equivalent
776 776
777 777 %psearch -i a* function
778 778 -i a* function?
779 779 ?-i a* function
780 780
781 781 Arguments:
782 782
783 783 PATTERN
784 784
785 785 where PATTERN is a string containing * as a wildcard similar to its
786 786 use in a shell. The pattern is matched in all namespaces on the
787 787 search path. By default objects starting with a single _ are not
788 788 matched, many IPython generated objects have a single
789 789 underscore. The default is case insensitive matching. Matching is
790 790 also done on the attributes of objects and not only on the objects
791 791 in a module.
792 792
793 793 [OBJECT TYPE]
794 794
795 795 Is the name of a python type from the types module. The name is
796 796 given in lowercase without the ending type, ex. StringType is
797 797 written string. By adding a type here only objects matching the
798 798 given type are matched. Using all here makes the pattern match all
799 799 types (this is the default).
800 800
801 801 Options:
802 802
803 803 -a: makes the pattern match even objects whose names start with a
804 804 single underscore. These names are normally ommitted from the
805 805 search.
806 806
807 807 -i/-c: make the pattern case insensitive/sensitive. If neither of
808 808 these options is given, the default is read from your ipythonrc
809 809 file. The option name which sets this value is
810 810 'wildcards_case_sensitive'. If this option is not specified in your
811 811 ipythonrc file, IPython's internal default is to do a case sensitive
812 812 search.
813 813
814 814 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
815 815 specifiy can be searched in any of the following namespaces:
816 816 'builtin', 'user', 'user_global','internal', 'alias', where
817 817 'builtin' and 'user' are the search defaults. Note that you should
818 818 not use quotes when specifying namespaces.
819 819
820 820 'Builtin' contains the python module builtin, 'user' contains all
821 821 user data, 'alias' only contain the shell aliases and no python
822 822 objects, 'internal' contains objects used by IPython. The
823 823 'user_global' namespace is only used by embedded IPython instances,
824 824 and it contains module-level globals. You can add namespaces to the
825 825 search with -s or exclude them with -e (these options can be given
826 826 more than once).
827 827
828 828 Examples:
829 829
830 830 %psearch a* -> objects beginning with an a
831 831 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
832 832 %psearch a* function -> all functions beginning with an a
833 833 %psearch re.e* -> objects beginning with an e in module re
834 834 %psearch r*.e* -> objects that start with e in modules starting in r
835 835 %psearch r*.* string -> all strings in modules beginning with r
836 836
837 837 Case sensitve search:
838 838
839 839 %psearch -c a* list all object beginning with lower case a
840 840
841 841 Show objects beginning with a single _:
842 842
843 843 %psearch -a _* list objects beginning with a single underscore"""
844 844 try:
845 845 parameter_s = parameter_s.encode('ascii')
846 846 except UnicodeEncodeError:
847 847 print 'Python identifiers can only contain ascii characters.'
848 848 return
849 849
850 850 # default namespaces to be searched
851 851 def_search = ['user','builtin']
852 852
853 853 # Process options/args
854 854 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
855 855 opt = opts.get
856 856 shell = self.shell
857 857 psearch = shell.inspector.psearch
858 858
859 859 # select case options
860 860 if opts.has_key('i'):
861 861 ignore_case = True
862 862 elif opts.has_key('c'):
863 863 ignore_case = False
864 864 else:
865 865 ignore_case = not shell.wildcards_case_sensitive
866 866
867 867 # Build list of namespaces to search from user options
868 868 def_search.extend(opt('s',[]))
869 869 ns_exclude = ns_exclude=opt('e',[])
870 870 ns_search = [nm for nm in def_search if nm not in ns_exclude]
871 871
872 872 # Call the actual search
873 873 try:
874 874 psearch(args,shell.ns_table,ns_search,
875 875 show_all=opt('a'),ignore_case=ignore_case)
876 876 except:
877 877 shell.showtraceback()
878 878
879 879 def magic_who_ls(self, parameter_s=''):
880 880 """Return a sorted list of all interactive variables.
881 881
882 882 If arguments are given, only variables of types matching these
883 883 arguments are returned."""
884 884
885 885 user_ns = self.shell.user_ns
886 886 internal_ns = self.shell.internal_ns
887 887 user_config_ns = self.shell.user_config_ns
888 888 out = [ i for i in user_ns
889 889 if not i.startswith('_') \
890 890 and not (i in internal_ns or i in user_config_ns) ]
891 891
892 892 typelist = parameter_s.split()
893 893 if typelist:
894 894 typeset = set(typelist)
895 895 out = [i for i in out if type(i).__name__ in typeset]
896 896
897 897 out.sort()
898 898 return out
899 899
900 900 def magic_who(self, parameter_s=''):
901 901 """Print all interactive variables, with some minimal formatting.
902 902
903 903 If any arguments are given, only variables whose type matches one of
904 904 these are printed. For example:
905 905
906 906 %who function str
907 907
908 908 will only list functions and strings, excluding all other types of
909 909 variables. To find the proper type names, simply use type(var) at a
910 910 command line to see how python prints type names. For example:
911 911
912 912 In [1]: type('hello')\\
913 913 Out[1]: <type 'str'>
914 914
915 915 indicates that the type name for strings is 'str'.
916 916
917 917 %who always excludes executed names loaded through your configuration
918 918 file and things which are internal to IPython.
919 919
920 920 This is deliberate, as typically you may load many modules and the
921 921 purpose of %who is to show you only what you've manually defined."""
922 922
923 923 varlist = self.magic_who_ls(parameter_s)
924 924 if not varlist:
925 925 if parameter_s:
926 926 print 'No variables match your requested type.'
927 927 else:
928 928 print 'Interactive namespace is empty.'
929 929 return
930 930
931 931 # if we have variables, move on...
932 932 count = 0
933 933 for i in varlist:
934 934 print i+'\t',
935 935 count += 1
936 936 if count > 8:
937 937 count = 0
938 938 print
939 939 print
940 940
941 941 def magic_whos(self, parameter_s=''):
942 942 """Like %who, but gives some extra information about each variable.
943 943
944 944 The same type filtering of %who can be applied here.
945 945
946 946 For all variables, the type is printed. Additionally it prints:
947 947
948 948 - For {},[],(): their length.
949 949
950 950 - For numpy and Numeric arrays, a summary with shape, number of
951 951 elements, typecode and size in memory.
952 952
953 953 - Everything else: a string representation, snipping their middle if
954 954 too long."""
955 955
956 956 varnames = self.magic_who_ls(parameter_s)
957 957 if not varnames:
958 958 if parameter_s:
959 959 print 'No variables match your requested type.'
960 960 else:
961 961 print 'Interactive namespace is empty.'
962 962 return
963 963
964 964 # if we have variables, move on...
965 965
966 966 # for these types, show len() instead of data:
967 967 seq_types = [types.DictType,types.ListType,types.TupleType]
968 968
969 969 # for numpy/Numeric arrays, display summary info
970 970 try:
971 971 import numpy
972 972 except ImportError:
973 973 ndarray_type = None
974 974 else:
975 975 ndarray_type = numpy.ndarray.__name__
976 976 try:
977 977 import Numeric
978 978 except ImportError:
979 979 array_type = None
980 980 else:
981 981 array_type = Numeric.ArrayType.__name__
982 982
983 983 # Find all variable names and types so we can figure out column sizes
984 984 def get_vars(i):
985 985 return self.shell.user_ns[i]
986 986
987 987 # some types are well known and can be shorter
988 988 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
989 989 def type_name(v):
990 990 tn = type(v).__name__
991 991 return abbrevs.get(tn,tn)
992 992
993 993 varlist = map(get_vars,varnames)
994 994
995 995 typelist = []
996 996 for vv in varlist:
997 997 tt = type_name(vv)
998 998
999 999 if tt=='instance':
1000 1000 typelist.append( abbrevs.get(str(vv.__class__),
1001 1001 str(vv.__class__)))
1002 1002 else:
1003 1003 typelist.append(tt)
1004 1004
1005 1005 # column labels and # of spaces as separator
1006 1006 varlabel = 'Variable'
1007 1007 typelabel = 'Type'
1008 1008 datalabel = 'Data/Info'
1009 1009 colsep = 3
1010 1010 # variable format strings
1011 1011 vformat = "$vname.ljust(varwidth)$vtype.ljust(typewidth)"
1012 1012 vfmt_short = '$vstr[:25]<...>$vstr[-25:]'
1013 1013 aformat = "%s: %s elems, type `%s`, %s bytes"
1014 1014 # find the size of the columns to format the output nicely
1015 1015 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
1016 1016 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
1017 1017 # table header
1018 1018 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
1019 1019 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
1020 1020 # and the table itself
1021 1021 kb = 1024
1022 1022 Mb = 1048576 # kb**2
1023 1023 for vname,var,vtype in zip(varnames,varlist,typelist):
1024 1024 print itpl(vformat),
1025 1025 if vtype in seq_types:
1026 1026 print len(var)
1027 1027 elif vtype in [array_type,ndarray_type]:
1028 1028 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
1029 1029 if vtype==ndarray_type:
1030 1030 # numpy
1031 1031 vsize = var.size
1032 1032 vbytes = vsize*var.itemsize
1033 1033 vdtype = var.dtype
1034 1034 else:
1035 1035 # Numeric
1036 1036 vsize = Numeric.size(var)
1037 1037 vbytes = vsize*var.itemsize()
1038 1038 vdtype = var.typecode()
1039 1039
1040 1040 if vbytes < 100000:
1041 1041 print aformat % (vshape,vsize,vdtype,vbytes)
1042 1042 else:
1043 1043 print aformat % (vshape,vsize,vdtype,vbytes),
1044 1044 if vbytes < Mb:
1045 1045 print '(%s kb)' % (vbytes/kb,)
1046 1046 else:
1047 1047 print '(%s Mb)' % (vbytes/Mb,)
1048 1048 else:
1049 1049 try:
1050 1050 vstr = str(var)
1051 1051 except UnicodeEncodeError:
1052 1052 vstr = unicode(var).encode(sys.getdefaultencoding(),
1053 1053 'backslashreplace')
1054 1054 vstr = vstr.replace('\n','\\n')
1055 1055 if len(vstr) < 50:
1056 1056 print vstr
1057 1057 else:
1058 1058 printpl(vfmt_short)
1059 1059
1060 1060 def magic_reset(self, parameter_s=''):
1061 1061 """Resets the namespace by removing all names defined by the user.
1062 1062
1063 1063 Input/Output history are left around in case you need them.
1064 1064
1065 1065 Parameters
1066 1066 ----------
1067 1067 -y : force reset without asking for confirmation.
1068 1068
1069 1069 Examples
1070 1070 --------
1071 1071 In [6]: a = 1
1072 1072
1073 1073 In [7]: a
1074 1074 Out[7]: 1
1075 1075
1076 1076 In [8]: 'a' in _ip.user_ns
1077 1077 Out[8]: True
1078 1078
1079 1079 In [9]: %reset -f
1080 1080
1081 1081 In [10]: 'a' in _ip.user_ns
1082 1082 Out[10]: False
1083 1083 """
1084 1084
1085 1085 if parameter_s == '-f':
1086 1086 ans = True
1087 1087 else:
1088 1088 ans = self.shell.ask_yes_no(
1089 1089 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ")
1090 1090 if not ans:
1091 1091 print 'Nothing done.'
1092 1092 return
1093 1093 user_ns = self.shell.user_ns
1094 1094 for i in self.magic_who_ls():
1095 1095 del(user_ns[i])
1096 1096
1097 1097 # Also flush the private list of module references kept for script
1098 1098 # execution protection
1099 1099 self.shell.clear_main_mod_cache()
1100 1100
1101 1101 def magic_logstart(self,parameter_s=''):
1102 1102 """Start logging anywhere in a session.
1103 1103
1104 1104 %logstart [-o|-r|-t] [log_name [log_mode]]
1105 1105
1106 1106 If no name is given, it defaults to a file named 'ipython_log.py' in your
1107 1107 current directory, in 'rotate' mode (see below).
1108 1108
1109 1109 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1110 1110 history up to that point and then continues logging.
1111 1111
1112 1112 %logstart takes a second optional parameter: logging mode. This can be one
1113 1113 of (note that the modes are given unquoted):\\
1114 1114 append: well, that says it.\\
1115 1115 backup: rename (if exists) to name~ and start name.\\
1116 1116 global: single logfile in your home dir, appended to.\\
1117 1117 over : overwrite existing log.\\
1118 1118 rotate: create rotating logs name.1~, name.2~, etc.
1119 1119
1120 1120 Options:
1121 1121
1122 1122 -o: log also IPython's output. In this mode, all commands which
1123 1123 generate an Out[NN] prompt are recorded to the logfile, right after
1124 1124 their corresponding input line. The output lines are always
1125 1125 prepended with a '#[Out]# ' marker, so that the log remains valid
1126 1126 Python code.
1127 1127
1128 1128 Since this marker is always the same, filtering only the output from
1129 1129 a log is very easy, using for example a simple awk call:
1130 1130
1131 1131 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1132 1132
1133 1133 -r: log 'raw' input. Normally, IPython's logs contain the processed
1134 1134 input, so that user lines are logged in their final form, converted
1135 1135 into valid Python. For example, %Exit is logged as
1136 1136 '_ip.magic("Exit"). If the -r flag is given, all input is logged
1137 1137 exactly as typed, with no transformations applied.
1138 1138
1139 1139 -t: put timestamps before each input line logged (these are put in
1140 1140 comments)."""
1141 1141
1142 1142 opts,par = self.parse_options(parameter_s,'ort')
1143 1143 log_output = 'o' in opts
1144 1144 log_raw_input = 'r' in opts
1145 1145 timestamp = 't' in opts
1146 1146
1147 1147 logger = self.shell.logger
1148 1148
1149 1149 # if no args are given, the defaults set in the logger constructor by
1150 1150 # ipytohn remain valid
1151 1151 if par:
1152 1152 try:
1153 1153 logfname,logmode = par.split()
1154 1154 except:
1155 1155 logfname = par
1156 1156 logmode = 'backup'
1157 1157 else:
1158 1158 logfname = logger.logfname
1159 1159 logmode = logger.logmode
1160 1160 # put logfname into rc struct as if it had been called on the command
1161 1161 # line, so it ends up saved in the log header Save it in case we need
1162 1162 # to restore it...
1163 1163 old_logfile = self.shell.logfile
1164 1164 if logfname:
1165 1165 logfname = os.path.expanduser(logfname)
1166 1166 self.shell.logfile = logfname
1167 1167
1168 1168 loghead = '# IPython log file\n\n'
1169 1169 try:
1170 1170 started = logger.logstart(logfname,loghead,logmode,
1171 1171 log_output,timestamp,log_raw_input)
1172 1172 except:
1173 1173 rc.opts.logfile = old_logfile
1174 1174 warn("Couldn't start log: %s" % sys.exc_info()[1])
1175 1175 else:
1176 1176 # log input history up to this point, optionally interleaving
1177 1177 # output if requested
1178 1178
1179 1179 if timestamp:
1180 1180 # disable timestamping for the previous history, since we've
1181 1181 # lost those already (no time machine here).
1182 1182 logger.timestamp = False
1183 1183
1184 1184 if log_raw_input:
1185 1185 input_hist = self.shell.input_hist_raw
1186 1186 else:
1187 1187 input_hist = self.shell.input_hist
1188 1188
1189 1189 if log_output:
1190 1190 log_write = logger.log_write
1191 1191 output_hist = self.shell.output_hist
1192 1192 for n in range(1,len(input_hist)-1):
1193 1193 log_write(input_hist[n].rstrip())
1194 1194 if n in output_hist:
1195 1195 log_write(repr(output_hist[n]),'output')
1196 1196 else:
1197 1197 logger.log_write(input_hist[1:])
1198 1198 if timestamp:
1199 1199 # re-enable timestamping
1200 1200 logger.timestamp = True
1201 1201
1202 1202 print ('Activating auto-logging. '
1203 1203 'Current session state plus future input saved.')
1204 1204 logger.logstate()
1205 1205
1206 1206 def magic_logstop(self,parameter_s=''):
1207 1207 """Fully stop logging and close log file.
1208 1208
1209 1209 In order to start logging again, a new %logstart call needs to be made,
1210 1210 possibly (though not necessarily) with a new filename, mode and other
1211 1211 options."""
1212 1212 self.logger.logstop()
1213 1213
1214 1214 def magic_logoff(self,parameter_s=''):
1215 1215 """Temporarily stop logging.
1216 1216
1217 1217 You must have previously started logging."""
1218 1218 self.shell.logger.switch_log(0)
1219 1219
1220 1220 def magic_logon(self,parameter_s=''):
1221 1221 """Restart logging.
1222 1222
1223 1223 This function is for restarting logging which you've temporarily
1224 1224 stopped with %logoff. For starting logging for the first time, you
1225 1225 must use the %logstart function, which allows you to specify an
1226 1226 optional log filename."""
1227 1227
1228 1228 self.shell.logger.switch_log(1)
1229 1229
1230 1230 def magic_logstate(self,parameter_s=''):
1231 1231 """Print the status of the logging system."""
1232 1232
1233 1233 self.shell.logger.logstate()
1234 1234
1235 1235 def magic_pdb(self, parameter_s=''):
1236 1236 """Control the automatic calling of the pdb interactive debugger.
1237 1237
1238 1238 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1239 1239 argument it works as a toggle.
1240 1240
1241 1241 When an exception is triggered, IPython can optionally call the
1242 1242 interactive pdb debugger after the traceback printout. %pdb toggles
1243 1243 this feature on and off.
1244 1244
1245 1245 The initial state of this feature is set in your ipythonrc
1246 1246 configuration file (the variable is called 'pdb').
1247 1247
1248 1248 If you want to just activate the debugger AFTER an exception has fired,
1249 1249 without having to type '%pdb on' and rerunning your code, you can use
1250 1250 the %debug magic."""
1251 1251
1252 1252 par = parameter_s.strip().lower()
1253 1253
1254 1254 if par:
1255 1255 try:
1256 1256 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1257 1257 except KeyError:
1258 1258 print ('Incorrect argument. Use on/1, off/0, '
1259 1259 'or nothing for a toggle.')
1260 1260 return
1261 1261 else:
1262 1262 # toggle
1263 1263 new_pdb = not self.shell.call_pdb
1264 1264
1265 1265 # set on the shell
1266 1266 self.shell.call_pdb = new_pdb
1267 1267 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1268 1268
1269 1269 def magic_debug(self, parameter_s=''):
1270 1270 """Activate the interactive debugger in post-mortem mode.
1271 1271
1272 1272 If an exception has just occurred, this lets you inspect its stack
1273 1273 frames interactively. Note that this will always work only on the last
1274 1274 traceback that occurred, so you must call this quickly after an
1275 1275 exception that you wish to inspect has fired, because if another one
1276 1276 occurs, it clobbers the previous one.
1277 1277
1278 1278 If you want IPython to automatically do this on every exception, see
1279 1279 the %pdb magic for more details.
1280 1280 """
1281 1281 self.shell.debugger(force=True)
1282 1282
1283 1283 @testdec.skip_doctest
1284 1284 def magic_prun(self, parameter_s ='',user_mode=1,
1285 1285 opts=None,arg_lst=None,prog_ns=None):
1286 1286
1287 1287 """Run a statement through the python code profiler.
1288 1288
1289 1289 Usage:
1290 1290 %prun [options] statement
1291 1291
1292 1292 The given statement (which doesn't require quote marks) is run via the
1293 1293 python profiler in a manner similar to the profile.run() function.
1294 1294 Namespaces are internally managed to work correctly; profile.run
1295 1295 cannot be used in IPython because it makes certain assumptions about
1296 1296 namespaces which do not hold under IPython.
1297 1297
1298 1298 Options:
1299 1299
1300 1300 -l <limit>: you can place restrictions on what or how much of the
1301 1301 profile gets printed. The limit value can be:
1302 1302
1303 1303 * A string: only information for function names containing this string
1304 1304 is printed.
1305 1305
1306 1306 * An integer: only these many lines are printed.
1307 1307
1308 1308 * A float (between 0 and 1): this fraction of the report is printed
1309 1309 (for example, use a limit of 0.4 to see the topmost 40% only).
1310 1310
1311 1311 You can combine several limits with repeated use of the option. For
1312 1312 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1313 1313 information about class constructors.
1314 1314
1315 1315 -r: return the pstats.Stats object generated by the profiling. This
1316 1316 object has all the information about the profile in it, and you can
1317 1317 later use it for further analysis or in other functions.
1318 1318
1319 1319 -s <key>: sort profile by given key. You can provide more than one key
1320 1320 by using the option several times: '-s key1 -s key2 -s key3...'. The
1321 1321 default sorting key is 'time'.
1322 1322
1323 1323 The following is copied verbatim from the profile documentation
1324 1324 referenced below:
1325 1325
1326 1326 When more than one key is provided, additional keys are used as
1327 1327 secondary criteria when the there is equality in all keys selected
1328 1328 before them.
1329 1329
1330 1330 Abbreviations can be used for any key names, as long as the
1331 1331 abbreviation is unambiguous. The following are the keys currently
1332 1332 defined:
1333 1333
1334 1334 Valid Arg Meaning
1335 1335 "calls" call count
1336 1336 "cumulative" cumulative time
1337 1337 "file" file name
1338 1338 "module" file name
1339 1339 "pcalls" primitive call count
1340 1340 "line" line number
1341 1341 "name" function name
1342 1342 "nfl" name/file/line
1343 1343 "stdname" standard name
1344 1344 "time" internal time
1345 1345
1346 1346 Note that all sorts on statistics are in descending order (placing
1347 1347 most time consuming items first), where as name, file, and line number
1348 1348 searches are in ascending order (i.e., alphabetical). The subtle
1349 1349 distinction between "nfl" and "stdname" is that the standard name is a
1350 1350 sort of the name as printed, which means that the embedded line
1351 1351 numbers get compared in an odd way. For example, lines 3, 20, and 40
1352 1352 would (if the file names were the same) appear in the string order
1353 1353 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1354 1354 line numbers. In fact, sort_stats("nfl") is the same as
1355 1355 sort_stats("name", "file", "line").
1356 1356
1357 1357 -T <filename>: save profile results as shown on screen to a text
1358 1358 file. The profile is still shown on screen.
1359 1359
1360 1360 -D <filename>: save (via dump_stats) profile statistics to given
1361 1361 filename. This data is in a format understod by the pstats module, and
1362 1362 is generated by a call to the dump_stats() method of profile
1363 1363 objects. The profile is still shown on screen.
1364 1364
1365 1365 If you want to run complete programs under the profiler's control, use
1366 1366 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1367 1367 contains profiler specific options as described here.
1368 1368
1369 1369 You can read the complete documentation for the profile module with::
1370 1370
1371 1371 In [1]: import profile; profile.help()
1372 1372 """
1373 1373
1374 1374 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1375 1375 # protect user quote marks
1376 1376 parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
1377 1377
1378 1378 if user_mode: # regular user call
1379 1379 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
1380 1380 list_all=1)
1381 1381 namespace = self.shell.user_ns
1382 1382 else: # called to run a program by %run -p
1383 1383 try:
1384 1384 filename = get_py_filename(arg_lst[0])
1385 1385 except IOError,msg:
1386 1386 error(msg)
1387 1387 return
1388 1388
1389 1389 arg_str = 'execfile(filename,prog_ns)'
1390 1390 namespace = locals()
1391 1391
1392 1392 opts.merge(opts_def)
1393 1393
1394 1394 prof = profile.Profile()
1395 1395 try:
1396 1396 prof = prof.runctx(arg_str,namespace,namespace)
1397 1397 sys_exit = ''
1398 1398 except SystemExit:
1399 1399 sys_exit = """*** SystemExit exception caught in code being profiled."""
1400 1400
1401 1401 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1402 1402
1403 1403 lims = opts.l
1404 1404 if lims:
1405 1405 lims = [] # rebuild lims with ints/floats/strings
1406 1406 for lim in opts.l:
1407 1407 try:
1408 1408 lims.append(int(lim))
1409 1409 except ValueError:
1410 1410 try:
1411 1411 lims.append(float(lim))
1412 1412 except ValueError:
1413 1413 lims.append(lim)
1414 1414
1415 1415 # Trap output.
1416 1416 stdout_trap = StringIO()
1417 1417
1418 1418 if hasattr(stats,'stream'):
1419 1419 # In newer versions of python, the stats object has a 'stream'
1420 1420 # attribute to write into.
1421 1421 stats.stream = stdout_trap
1422 1422 stats.print_stats(*lims)
1423 1423 else:
1424 1424 # For older versions, we manually redirect stdout during printing
1425 1425 sys_stdout = sys.stdout
1426 1426 try:
1427 1427 sys.stdout = stdout_trap
1428 1428 stats.print_stats(*lims)
1429 1429 finally:
1430 1430 sys.stdout = sys_stdout
1431 1431
1432 1432 output = stdout_trap.getvalue()
1433 1433 output = output.rstrip()
1434 1434
1435 1435 page(output,screen_lines=self.shell.usable_screen_length)
1436 1436 print sys_exit,
1437 1437
1438 1438 dump_file = opts.D[0]
1439 1439 text_file = opts.T[0]
1440 1440 if dump_file:
1441 1441 prof.dump_stats(dump_file)
1442 1442 print '\n*** Profile stats marshalled to file',\
1443 1443 `dump_file`+'.',sys_exit
1444 1444 if text_file:
1445 1445 pfile = file(text_file,'w')
1446 1446 pfile.write(output)
1447 1447 pfile.close()
1448 1448 print '\n*** Profile printout saved to text file',\
1449 1449 `text_file`+'.',sys_exit
1450 1450
1451 1451 if opts.has_key('r'):
1452 1452 return stats
1453 1453 else:
1454 1454 return None
1455 1455
1456 1456 @testdec.skip_doctest
1457 1457 def magic_run(self, parameter_s ='',runner=None,
1458 1458 file_finder=get_py_filename):
1459 1459 """Run the named file inside IPython as a program.
1460 1460
1461 1461 Usage:\\
1462 1462 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1463 1463
1464 1464 Parameters after the filename are passed as command-line arguments to
1465 1465 the program (put in sys.argv). Then, control returns to IPython's
1466 1466 prompt.
1467 1467
1468 1468 This is similar to running at a system prompt:\\
1469 1469 $ python file args\\
1470 1470 but with the advantage of giving you IPython's tracebacks, and of
1471 1471 loading all variables into your interactive namespace for further use
1472 1472 (unless -p is used, see below).
1473 1473
1474 1474 The file is executed in a namespace initially consisting only of
1475 1475 __name__=='__main__' and sys.argv constructed as indicated. It thus
1476 1476 sees its environment as if it were being run as a stand-alone program
1477 1477 (except for sharing global objects such as previously imported
1478 1478 modules). But after execution, the IPython interactive namespace gets
1479 1479 updated with all variables defined in the program (except for __name__
1480 1480 and sys.argv). This allows for very convenient loading of code for
1481 1481 interactive work, while giving each program a 'clean sheet' to run in.
1482 1482
1483 1483 Options:
1484 1484
1485 1485 -n: __name__ is NOT set to '__main__', but to the running file's name
1486 1486 without extension (as python does under import). This allows running
1487 1487 scripts and reloading the definitions in them without calling code
1488 1488 protected by an ' if __name__ == "__main__" ' clause.
1489 1489
1490 1490 -i: run the file in IPython's namespace instead of an empty one. This
1491 1491 is useful if you are experimenting with code written in a text editor
1492 1492 which depends on variables defined interactively.
1493 1493
1494 1494 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1495 1495 being run. This is particularly useful if IPython is being used to
1496 1496 run unittests, which always exit with a sys.exit() call. In such
1497 1497 cases you are interested in the output of the test results, not in
1498 1498 seeing a traceback of the unittest module.
1499 1499
1500 1500 -t: print timing information at the end of the run. IPython will give
1501 1501 you an estimated CPU time consumption for your script, which under
1502 1502 Unix uses the resource module to avoid the wraparound problems of
1503 1503 time.clock(). Under Unix, an estimate of time spent on system tasks
1504 1504 is also given (for Windows platforms this is reported as 0.0).
1505 1505
1506 1506 If -t is given, an additional -N<N> option can be given, where <N>
1507 1507 must be an integer indicating how many times you want the script to
1508 1508 run. The final timing report will include total and per run results.
1509 1509
1510 1510 For example (testing the script uniq_stable.py):
1511 1511
1512 1512 In [1]: run -t uniq_stable
1513 1513
1514 1514 IPython CPU timings (estimated):\\
1515 1515 User : 0.19597 s.\\
1516 1516 System: 0.0 s.\\
1517 1517
1518 1518 In [2]: run -t -N5 uniq_stable
1519 1519
1520 1520 IPython CPU timings (estimated):\\
1521 1521 Total runs performed: 5\\
1522 1522 Times : Total Per run\\
1523 1523 User : 0.910862 s, 0.1821724 s.\\
1524 1524 System: 0.0 s, 0.0 s.
1525 1525
1526 1526 -d: run your program under the control of pdb, the Python debugger.
1527 1527 This allows you to execute your program step by step, watch variables,
1528 1528 etc. Internally, what IPython does is similar to calling:
1529 1529
1530 1530 pdb.run('execfile("YOURFILENAME")')
1531 1531
1532 1532 with a breakpoint set on line 1 of your file. You can change the line
1533 1533 number for this automatic breakpoint to be <N> by using the -bN option
1534 1534 (where N must be an integer). For example:
1535 1535
1536 1536 %run -d -b40 myscript
1537 1537
1538 1538 will set the first breakpoint at line 40 in myscript.py. Note that
1539 1539 the first breakpoint must be set on a line which actually does
1540 1540 something (not a comment or docstring) for it to stop execution.
1541 1541
1542 1542 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1543 1543 first enter 'c' (without qoutes) to start execution up to the first
1544 1544 breakpoint.
1545 1545
1546 1546 Entering 'help' gives information about the use of the debugger. You
1547 1547 can easily see pdb's full documentation with "import pdb;pdb.help()"
1548 1548 at a prompt.
1549 1549
1550 1550 -p: run program under the control of the Python profiler module (which
1551 1551 prints a detailed report of execution times, function calls, etc).
1552 1552
1553 1553 You can pass other options after -p which affect the behavior of the
1554 1554 profiler itself. See the docs for %prun for details.
1555 1555
1556 1556 In this mode, the program's variables do NOT propagate back to the
1557 1557 IPython interactive namespace (because they remain in the namespace
1558 1558 where the profiler executes them).
1559 1559
1560 1560 Internally this triggers a call to %prun, see its documentation for
1561 1561 details on the options available specifically for profiling.
1562 1562
1563 1563 There is one special usage for which the text above doesn't apply:
1564 1564 if the filename ends with .ipy, the file is run as ipython script,
1565 1565 just as if the commands were written on IPython prompt.
1566 1566 """
1567 1567
1568 1568 # get arguments and set sys.argv for program to be run.
1569 1569 opts,arg_lst = self.parse_options(parameter_s,'nidtN:b:pD:l:rs:T:e',
1570 1570 mode='list',list_all=1)
1571 1571
1572 1572 try:
1573 1573 filename = file_finder(arg_lst[0])
1574 1574 except IndexError:
1575 1575 warn('you must provide at least a filename.')
1576 1576 print '\n%run:\n',oinspect.getdoc(self.magic_run)
1577 1577 return
1578 1578 except IOError,msg:
1579 1579 error(msg)
1580 1580 return
1581 1581
1582 1582 if filename.lower().endswith('.ipy'):
1583 1583 self.shell.safe_execfile_ipy(filename)
1584 1584 return
1585 1585
1586 1586 # Control the response to exit() calls made by the script being run
1587 1587 exit_ignore = opts.has_key('e')
1588 1588
1589 1589 # Make sure that the running script gets a proper sys.argv as if it
1590 1590 # were run from a system shell.
1591 1591 save_argv = sys.argv # save it for later restoring
1592 1592 sys.argv = [filename]+ arg_lst[1:] # put in the proper filename
1593 1593
1594 1594 if opts.has_key('i'):
1595 1595 # Run in user's interactive namespace
1596 1596 prog_ns = self.shell.user_ns
1597 1597 __name__save = self.shell.user_ns['__name__']
1598 1598 prog_ns['__name__'] = '__main__'
1599 1599 main_mod = self.shell.new_main_mod(prog_ns)
1600 1600 else:
1601 1601 # Run in a fresh, empty namespace
1602 1602 if opts.has_key('n'):
1603 1603 name = os.path.splitext(os.path.basename(filename))[0]
1604 1604 else:
1605 1605 name = '__main__'
1606 1606
1607 1607 main_mod = self.shell.new_main_mod()
1608 1608 prog_ns = main_mod.__dict__
1609 1609 prog_ns['__name__'] = name
1610 1610
1611 1611 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1612 1612 # set the __file__ global in the script's namespace
1613 1613 prog_ns['__file__'] = filename
1614 1614
1615 1615 # pickle fix. See iplib for an explanation. But we need to make sure
1616 1616 # that, if we overwrite __main__, we replace it at the end
1617 1617 main_mod_name = prog_ns['__name__']
1618 1618
1619 1619 if main_mod_name == '__main__':
1620 1620 restore_main = sys.modules['__main__']
1621 1621 else:
1622 1622 restore_main = False
1623 1623
1624 1624 # This needs to be undone at the end to prevent holding references to
1625 1625 # every single object ever created.
1626 1626 sys.modules[main_mod_name] = main_mod
1627 1627
1628 1628 stats = None
1629 1629 try:
1630 1630 self.shell.savehist()
1631 1631
1632 1632 if opts.has_key('p'):
1633 1633 stats = self.magic_prun('',0,opts,arg_lst,prog_ns)
1634 1634 else:
1635 1635 if opts.has_key('d'):
1636 1636 deb = debugger.Pdb(self.shell.colors)
1637 1637 # reset Breakpoint state, which is moronically kept
1638 1638 # in a class
1639 1639 bdb.Breakpoint.next = 1
1640 1640 bdb.Breakpoint.bplist = {}
1641 1641 bdb.Breakpoint.bpbynumber = [None]
1642 1642 # Set an initial breakpoint to stop execution
1643 1643 maxtries = 10
1644 1644 bp = int(opts.get('b',[1])[0])
1645 1645 checkline = deb.checkline(filename,bp)
1646 1646 if not checkline:
1647 1647 for bp in range(bp+1,bp+maxtries+1):
1648 1648 if deb.checkline(filename,bp):
1649 1649 break
1650 1650 else:
1651 1651 msg = ("\nI failed to find a valid line to set "
1652 1652 "a breakpoint\n"
1653 1653 "after trying up to line: %s.\n"
1654 1654 "Please set a valid breakpoint manually "
1655 1655 "with the -b option." % bp)
1656 1656 error(msg)
1657 1657 return
1658 1658 # if we find a good linenumber, set the breakpoint
1659 1659 deb.do_break('%s:%s' % (filename,bp))
1660 1660 # Start file run
1661 1661 print "NOTE: Enter 'c' at the",
1662 1662 print "%s prompt to start your script." % deb.prompt
1663 1663 try:
1664 1664 deb.run('execfile("%s")' % filename,prog_ns)
1665 1665
1666 1666 except:
1667 1667 etype, value, tb = sys.exc_info()
1668 1668 # Skip three frames in the traceback: the %run one,
1669 1669 # one inside bdb.py, and the command-line typed by the
1670 1670 # user (run by exec in pdb itself).
1671 1671 self.shell.InteractiveTB(etype,value,tb,tb_offset=3)
1672 1672 else:
1673 1673 if runner is None:
1674 1674 runner = self.shell.safe_execfile
1675 1675 if opts.has_key('t'):
1676 1676 # timed execution
1677 1677 try:
1678 1678 nruns = int(opts['N'][0])
1679 1679 if nruns < 1:
1680 1680 error('Number of runs must be >=1')
1681 1681 return
1682 1682 except (KeyError):
1683 1683 nruns = 1
1684 1684 if nruns == 1:
1685 1685 t0 = clock2()
1686 1686 runner(filename,prog_ns,prog_ns,
1687 1687 exit_ignore=exit_ignore)
1688 1688 t1 = clock2()
1689 1689 t_usr = t1[0]-t0[0]
1690 1690 t_sys = t1[1]-t0[1]
1691 1691 print "\nIPython CPU timings (estimated):"
1692 1692 print " User : %10s s." % t_usr
1693 1693 print " System: %10s s." % t_sys
1694 1694 else:
1695 1695 runs = range(nruns)
1696 1696 t0 = clock2()
1697 1697 for nr in runs:
1698 1698 runner(filename,prog_ns,prog_ns,
1699 1699 exit_ignore=exit_ignore)
1700 1700 t1 = clock2()
1701 1701 t_usr = t1[0]-t0[0]
1702 1702 t_sys = t1[1]-t0[1]
1703 1703 print "\nIPython CPU timings (estimated):"
1704 1704 print "Total runs performed:",nruns
1705 1705 print " Times : %10s %10s" % ('Total','Per run')
1706 1706 print " User : %10s s, %10s s." % (t_usr,t_usr/nruns)
1707 1707 print " System: %10s s, %10s s." % (t_sys,t_sys/nruns)
1708 1708
1709 1709 else:
1710 1710 # regular execution
1711 1711 runner(filename,prog_ns,prog_ns,exit_ignore=exit_ignore)
1712 1712
1713 1713 if opts.has_key('i'):
1714 1714 self.shell.user_ns['__name__'] = __name__save
1715 1715 else:
1716 1716 # The shell MUST hold a reference to prog_ns so after %run
1717 1717 # exits, the python deletion mechanism doesn't zero it out
1718 1718 # (leaving dangling references).
1719 1719 self.shell.cache_main_mod(prog_ns,filename)
1720 1720 # update IPython interactive namespace
1721 1721
1722 1722 # Some forms of read errors on the file may mean the
1723 1723 # __name__ key was never set; using pop we don't have to
1724 1724 # worry about a possible KeyError.
1725 1725 prog_ns.pop('__name__', None)
1726 1726
1727 1727 self.shell.user_ns.update(prog_ns)
1728 1728 finally:
1729 1729 # It's a bit of a mystery why, but __builtins__ can change from
1730 1730 # being a module to becoming a dict missing some key data after
1731 1731 # %run. As best I can see, this is NOT something IPython is doing
1732 1732 # at all, and similar problems have been reported before:
1733 1733 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1734 1734 # Since this seems to be done by the interpreter itself, the best
1735 1735 # we can do is to at least restore __builtins__ for the user on
1736 1736 # exit.
1737 1737 self.shell.user_ns['__builtins__'] = __builtin__
1738 1738
1739 1739 # Ensure key global structures are restored
1740 1740 sys.argv = save_argv
1741 1741 if restore_main:
1742 1742 sys.modules['__main__'] = restore_main
1743 1743 else:
1744 1744 # Remove from sys.modules the reference to main_mod we'd
1745 1745 # added. Otherwise it will trap references to objects
1746 1746 # contained therein.
1747 1747 del sys.modules[main_mod_name]
1748 1748
1749 1749 self.shell.reloadhist()
1750 1750
1751 1751 return stats
1752 1752
1753 1753 @testdec.skip_doctest
1754 1754 def magic_timeit(self, parameter_s =''):
1755 1755 """Time execution of a Python statement or expression
1756 1756
1757 1757 Usage:\\
1758 1758 %timeit [-n<N> -r<R> [-t|-c]] statement
1759 1759
1760 1760 Time execution of a Python statement or expression using the timeit
1761 1761 module.
1762 1762
1763 1763 Options:
1764 1764 -n<N>: execute the given statement <N> times in a loop. If this value
1765 1765 is not given, a fitting value is chosen.
1766 1766
1767 1767 -r<R>: repeat the loop iteration <R> times and take the best result.
1768 1768 Default: 3
1769 1769
1770 1770 -t: use time.time to measure the time, which is the default on Unix.
1771 1771 This function measures wall time.
1772 1772
1773 1773 -c: use time.clock to measure the time, which is the default on
1774 1774 Windows and measures wall time. On Unix, resource.getrusage is used
1775 1775 instead and returns the CPU user time.
1776 1776
1777 1777 -p<P>: use a precision of <P> digits to display the timing result.
1778 1778 Default: 3
1779 1779
1780 1780
1781 1781 Examples:
1782 1782
1783 1783 In [1]: %timeit pass
1784 1784 10000000 loops, best of 3: 53.3 ns per loop
1785 1785
1786 1786 In [2]: u = None
1787 1787
1788 1788 In [3]: %timeit u is None
1789 1789 10000000 loops, best of 3: 184 ns per loop
1790 1790
1791 1791 In [4]: %timeit -r 4 u == None
1792 1792 1000000 loops, best of 4: 242 ns per loop
1793 1793
1794 1794 In [5]: import time
1795 1795
1796 1796 In [6]: %timeit -n1 time.sleep(2)
1797 1797 1 loops, best of 3: 2 s per loop
1798 1798
1799 1799
1800 1800 The times reported by %timeit will be slightly higher than those
1801 1801 reported by the timeit.py script when variables are accessed. This is
1802 1802 due to the fact that %timeit executes the statement in the namespace
1803 1803 of the shell, compared with timeit.py, which uses a single setup
1804 1804 statement to import function or create variables. Generally, the bias
1805 1805 does not matter as long as results from timeit.py are not mixed with
1806 1806 those from %timeit."""
1807 1807
1808 1808 import timeit
1809 1809 import math
1810 1810
1811 1811 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1812 1812 # certain terminals. Until we figure out a robust way of
1813 1813 # auto-detecting if the terminal can deal with it, use plain 'us' for
1814 1814 # microseconds. I am really NOT happy about disabling the proper
1815 1815 # 'micro' prefix, but crashing is worse... If anyone knows what the
1816 1816 # right solution for this is, I'm all ears...
1817 1817 #
1818 1818 # Note: using
1819 1819 #
1820 1820 # s = u'\xb5'
1821 1821 # s.encode(sys.getdefaultencoding())
1822 1822 #
1823 1823 # is not sufficient, as I've seen terminals where that fails but
1824 1824 # print s
1825 1825 #
1826 1826 # succeeds
1827 1827 #
1828 1828 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
1829 1829
1830 1830 #units = [u"s", u"ms",u'\xb5',"ns"]
1831 1831 units = [u"s", u"ms",u'us',"ns"]
1832 1832
1833 1833 scaling = [1, 1e3, 1e6, 1e9]
1834 1834
1835 1835 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1836 1836 posix=False)
1837 1837 if stmt == "":
1838 1838 return
1839 1839 timefunc = timeit.default_timer
1840 1840 number = int(getattr(opts, "n", 0))
1841 1841 repeat = int(getattr(opts, "r", timeit.default_repeat))
1842 1842 precision = int(getattr(opts, "p", 3))
1843 1843 if hasattr(opts, "t"):
1844 1844 timefunc = time.time
1845 1845 if hasattr(opts, "c"):
1846 1846 timefunc = clock
1847 1847
1848 1848 timer = timeit.Timer(timer=timefunc)
1849 1849 # this code has tight coupling to the inner workings of timeit.Timer,
1850 1850 # but is there a better way to achieve that the code stmt has access
1851 1851 # to the shell namespace?
1852 1852
1853 1853 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1854 1854 'setup': "pass"}
1855 1855 # Track compilation time so it can be reported if too long
1856 1856 # Minimum time above which compilation time will be reported
1857 1857 tc_min = 0.1
1858 1858
1859 1859 t0 = clock()
1860 1860 code = compile(src, "<magic-timeit>", "exec")
1861 1861 tc = clock()-t0
1862 1862
1863 1863 ns = {}
1864 1864 exec code in self.shell.user_ns, ns
1865 1865 timer.inner = ns["inner"]
1866 1866
1867 1867 if number == 0:
1868 1868 # determine number so that 0.2 <= total time < 2.0
1869 1869 number = 1
1870 1870 for i in range(1, 10):
1871 1871 if timer.timeit(number) >= 0.2:
1872 1872 break
1873 1873 number *= 10
1874 1874
1875 1875 best = min(timer.repeat(repeat, number)) / number
1876 1876
1877 1877 if best > 0.0:
1878 1878 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1879 1879 else:
1880 1880 order = 3
1881 1881 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1882 1882 precision,
1883 1883 best * scaling[order],
1884 1884 units[order])
1885 1885 if tc > tc_min:
1886 1886 print "Compiler time: %.2f s" % tc
1887 1887
1888 1888 @testdec.skip_doctest
1889 1889 def magic_time(self,parameter_s = ''):
1890 1890 """Time execution of a Python statement or expression.
1891 1891
1892 1892 The CPU and wall clock times are printed, and the value of the
1893 1893 expression (if any) is returned. Note that under Win32, system time
1894 1894 is always reported as 0, since it can not be measured.
1895 1895
1896 1896 This function provides very basic timing functionality. In Python
1897 1897 2.3, the timeit module offers more control and sophistication, so this
1898 1898 could be rewritten to use it (patches welcome).
1899 1899
1900 1900 Some examples:
1901 1901
1902 1902 In [1]: time 2**128
1903 1903 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1904 1904 Wall time: 0.00
1905 1905 Out[1]: 340282366920938463463374607431768211456L
1906 1906
1907 1907 In [2]: n = 1000000
1908 1908
1909 1909 In [3]: time sum(range(n))
1910 1910 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
1911 1911 Wall time: 1.37
1912 1912 Out[3]: 499999500000L
1913 1913
1914 1914 In [4]: time print 'hello world'
1915 1915 hello world
1916 1916 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1917 1917 Wall time: 0.00
1918 1918
1919 1919 Note that the time needed by Python to compile the given expression
1920 1920 will be reported if it is more than 0.1s. In this example, the
1921 1921 actual exponentiation is done by Python at compilation time, so while
1922 1922 the expression can take a noticeable amount of time to compute, that
1923 1923 time is purely due to the compilation:
1924 1924
1925 1925 In [5]: time 3**9999;
1926 1926 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1927 1927 Wall time: 0.00 s
1928 1928
1929 1929 In [6]: time 3**999999;
1930 1930 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
1931 1931 Wall time: 0.00 s
1932 1932 Compiler : 0.78 s
1933 1933 """
1934 1934
1935 1935 # fail immediately if the given expression can't be compiled
1936 1936
1937 1937 expr = self.shell.prefilter(parameter_s,False)
1938 1938
1939 1939 # Minimum time above which compilation time will be reported
1940 1940 tc_min = 0.1
1941 1941
1942 1942 try:
1943 1943 mode = 'eval'
1944 1944 t0 = clock()
1945 1945 code = compile(expr,'<timed eval>',mode)
1946 1946 tc = clock()-t0
1947 1947 except SyntaxError:
1948 1948 mode = 'exec'
1949 1949 t0 = clock()
1950 1950 code = compile(expr,'<timed exec>',mode)
1951 1951 tc = clock()-t0
1952 1952 # skew measurement as little as possible
1953 1953 glob = self.shell.user_ns
1954 1954 clk = clock2
1955 1955 wtime = time.time
1956 1956 # time execution
1957 1957 wall_st = wtime()
1958 1958 if mode=='eval':
1959 1959 st = clk()
1960 1960 out = eval(code,glob)
1961 1961 end = clk()
1962 1962 else:
1963 1963 st = clk()
1964 1964 exec code in glob
1965 1965 end = clk()
1966 1966 out = None
1967 1967 wall_end = wtime()
1968 1968 # Compute actual times and report
1969 1969 wall_time = wall_end-wall_st
1970 1970 cpu_user = end[0]-st[0]
1971 1971 cpu_sys = end[1]-st[1]
1972 1972 cpu_tot = cpu_user+cpu_sys
1973 1973 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
1974 1974 (cpu_user,cpu_sys,cpu_tot)
1975 1975 print "Wall time: %.2f s" % wall_time
1976 1976 if tc > tc_min:
1977 1977 print "Compiler : %.2f s" % tc
1978 1978 return out
1979 1979
1980 1980 @testdec.skip_doctest
1981 1981 def magic_macro(self,parameter_s = ''):
1982 1982 """Define a set of input lines as a macro for future re-execution.
1983 1983
1984 1984 Usage:\\
1985 1985 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
1986 1986
1987 1987 Options:
1988 1988
1989 1989 -r: use 'raw' input. By default, the 'processed' history is used,
1990 1990 so that magics are loaded in their transformed version to valid
1991 1991 Python. If this option is given, the raw input as typed as the
1992 1992 command line is used instead.
1993 1993
1994 1994 This will define a global variable called `name` which is a string
1995 1995 made of joining the slices and lines you specify (n1,n2,... numbers
1996 1996 above) from your input history into a single string. This variable
1997 1997 acts like an automatic function which re-executes those lines as if
1998 1998 you had typed them. You just type 'name' at the prompt and the code
1999 1999 executes.
2000 2000
2001 2001 The notation for indicating number ranges is: n1-n2 means 'use line
2002 2002 numbers n1,...n2' (the endpoint is included). That is, '5-7' means
2003 2003 using the lines numbered 5,6 and 7.
2004 2004
2005 2005 Note: as a 'hidden' feature, you can also use traditional python slice
2006 2006 notation, where N:M means numbers N through M-1.
2007 2007
2008 2008 For example, if your history contains (%hist prints it):
2009 2009
2010 2010 44: x=1
2011 2011 45: y=3
2012 2012 46: z=x+y
2013 2013 47: print x
2014 2014 48: a=5
2015 2015 49: print 'x',x,'y',y
2016 2016
2017 2017 you can create a macro with lines 44 through 47 (included) and line 49
2018 2018 called my_macro with:
2019 2019
2020 2020 In [55]: %macro my_macro 44-47 49
2021 2021
2022 2022 Now, typing `my_macro` (without quotes) will re-execute all this code
2023 2023 in one pass.
2024 2024
2025 2025 You don't need to give the line-numbers in order, and any given line
2026 2026 number can appear multiple times. You can assemble macros with any
2027 2027 lines from your input history in any order.
2028 2028
2029 2029 The macro is a simple object which holds its value in an attribute,
2030 2030 but IPython's display system checks for macros and executes them as
2031 2031 code instead of printing them when you type their name.
2032 2032
2033 2033 You can view a macro's contents by explicitly printing it with:
2034 2034
2035 2035 'print macro_name'.
2036 2036
2037 2037 For one-off cases which DON'T contain magic function calls in them you
2038 2038 can obtain similar results by explicitly executing slices from your
2039 2039 input history with:
2040 2040
2041 2041 In [60]: exec In[44:48]+In[49]"""
2042 2042
2043 2043 opts,args = self.parse_options(parameter_s,'r',mode='list')
2044 2044 if not args:
2045 2045 macs = [k for k,v in self.shell.user_ns.items() if isinstance(v, Macro)]
2046 2046 macs.sort()
2047 2047 return macs
2048 2048 if len(args) == 1:
2049 2049 raise UsageError(
2050 2050 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2051 2051 name,ranges = args[0], args[1:]
2052 2052
2053 2053 #print 'rng',ranges # dbg
2054 2054 lines = self.extract_input_slices(ranges,opts.has_key('r'))
2055 2055 macro = Macro(lines)
2056 2056 self.shell.define_macro(name, macro)
2057 2057 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2058 2058 print 'Macro contents:'
2059 2059 print macro,
2060 2060
2061 2061 def magic_save(self,parameter_s = ''):
2062 2062 """Save a set of lines to a given filename.
2063 2063
2064 2064 Usage:\\
2065 2065 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2066 2066
2067 2067 Options:
2068 2068
2069 2069 -r: use 'raw' input. By default, the 'processed' history is used,
2070 2070 so that magics are loaded in their transformed version to valid
2071 2071 Python. If this option is given, the raw input as typed as the
2072 2072 command line is used instead.
2073 2073
2074 2074 This function uses the same syntax as %macro for line extraction, but
2075 2075 instead of creating a macro it saves the resulting string to the
2076 2076 filename you specify.
2077 2077
2078 2078 It adds a '.py' extension to the file if you don't do so yourself, and
2079 2079 it asks for confirmation before overwriting existing files."""
2080 2080
2081 2081 opts,args = self.parse_options(parameter_s,'r',mode='list')
2082 2082 fname,ranges = args[0], args[1:]
2083 2083 if not fname.endswith('.py'):
2084 2084 fname += '.py'
2085 2085 if os.path.isfile(fname):
2086 2086 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
2087 2087 if ans.lower() not in ['y','yes']:
2088 2088 print 'Operation cancelled.'
2089 2089 return
2090 2090 cmds = ''.join(self.extract_input_slices(ranges,opts.has_key('r')))
2091 2091 f = file(fname,'w')
2092 2092 f.write(cmds)
2093 2093 f.close()
2094 2094 print 'The following commands were written to file `%s`:' % fname
2095 2095 print cmds
2096 2096
2097 2097 def _edit_macro(self,mname,macro):
2098 2098 """open an editor with the macro data in a file"""
2099 2099 filename = self.shell.mktempfile(macro.value)
2100 2100 self.shell.hooks.editor(filename)
2101 2101
2102 2102 # and make a new macro object, to replace the old one
2103 2103 mfile = open(filename)
2104 2104 mvalue = mfile.read()
2105 2105 mfile.close()
2106 2106 self.shell.user_ns[mname] = Macro(mvalue)
2107 2107
2108 2108 def magic_ed(self,parameter_s=''):
2109 2109 """Alias to %edit."""
2110 2110 return self.magic_edit(parameter_s)
2111 2111
2112 2112 @testdec.skip_doctest
2113 2113 def magic_edit(self,parameter_s='',last_call=['','']):
2114 2114 """Bring up an editor and execute the resulting code.
2115 2115
2116 2116 Usage:
2117 2117 %edit [options] [args]
2118 2118
2119 2119 %edit runs IPython's editor hook. The default version of this hook is
2120 2120 set to call the __IPYTHON__.rc.editor command. This is read from your
2121 2121 environment variable $EDITOR. If this isn't found, it will default to
2122 2122 vi under Linux/Unix and to notepad under Windows. See the end of this
2123 2123 docstring for how to change the editor hook.
2124 2124
2125 2125 You can also set the value of this editor via the command line option
2126 2126 '-editor' or in your ipythonrc file. This is useful if you wish to use
2127 2127 specifically for IPython an editor different from your typical default
2128 2128 (and for Windows users who typically don't set environment variables).
2129 2129
2130 2130 This command allows you to conveniently edit multi-line code right in
2131 2131 your IPython session.
2132 2132
2133 2133 If called without arguments, %edit opens up an empty editor with a
2134 2134 temporary file and will execute the contents of this file when you
2135 2135 close it (don't forget to save it!).
2136 2136
2137 2137
2138 2138 Options:
2139 2139
2140 2140 -n <number>: open the editor at a specified line number. By default,
2141 2141 the IPython editor hook uses the unix syntax 'editor +N filename', but
2142 2142 you can configure this by providing your own modified hook if your
2143 2143 favorite editor supports line-number specifications with a different
2144 2144 syntax.
2145 2145
2146 2146 -p: this will call the editor with the same data as the previous time
2147 2147 it was used, regardless of how long ago (in your current session) it
2148 2148 was.
2149 2149
2150 2150 -r: use 'raw' input. This option only applies to input taken from the
2151 2151 user's history. By default, the 'processed' history is used, so that
2152 2152 magics are loaded in their transformed version to valid Python. If
2153 2153 this option is given, the raw input as typed as the command line is
2154 2154 used instead. When you exit the editor, it will be executed by
2155 2155 IPython's own processor.
2156 2156
2157 2157 -x: do not execute the edited code immediately upon exit. This is
2158 2158 mainly useful if you are editing programs which need to be called with
2159 2159 command line arguments, which you can then do using %run.
2160 2160
2161 2161
2162 2162 Arguments:
2163 2163
2164 2164 If arguments are given, the following possibilites exist:
2165 2165
2166 2166 - The arguments are numbers or pairs of colon-separated numbers (like
2167 2167 1 4:8 9). These are interpreted as lines of previous input to be
2168 2168 loaded into the editor. The syntax is the same of the %macro command.
2169 2169
2170 2170 - If the argument doesn't start with a number, it is evaluated as a
2171 2171 variable and its contents loaded into the editor. You can thus edit
2172 2172 any string which contains python code (including the result of
2173 2173 previous edits).
2174 2174
2175 2175 - If the argument is the name of an object (other than a string),
2176 2176 IPython will try to locate the file where it was defined and open the
2177 2177 editor at the point where it is defined. You can use `%edit function`
2178 2178 to load an editor exactly at the point where 'function' is defined,
2179 2179 edit it and have the file be executed automatically.
2180 2180
2181 2181 If the object is a macro (see %macro for details), this opens up your
2182 2182 specified editor with a temporary file containing the macro's data.
2183 2183 Upon exit, the macro is reloaded with the contents of the file.
2184 2184
2185 2185 Note: opening at an exact line is only supported under Unix, and some
2186 2186 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2187 2187 '+NUMBER' parameter necessary for this feature. Good editors like
2188 2188 (X)Emacs, vi, jed, pico and joe all do.
2189 2189
2190 2190 - If the argument is not found as a variable, IPython will look for a
2191 2191 file with that name (adding .py if necessary) and load it into the
2192 2192 editor. It will execute its contents with execfile() when you exit,
2193 2193 loading any code in the file into your interactive namespace.
2194 2194
2195 2195 After executing your code, %edit will return as output the code you
2196 2196 typed in the editor (except when it was an existing file). This way
2197 2197 you can reload the code in further invocations of %edit as a variable,
2198 2198 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2199 2199 the output.
2200 2200
2201 2201 Note that %edit is also available through the alias %ed.
2202 2202
2203 2203 This is an example of creating a simple function inside the editor and
2204 2204 then modifying it. First, start up the editor:
2205 2205
2206 2206 In [1]: ed
2207 2207 Editing... done. Executing edited code...
2208 2208 Out[1]: 'def foo():n print "foo() was defined in an editing session"n'
2209 2209
2210 2210 We can then call the function foo():
2211 2211
2212 2212 In [2]: foo()
2213 2213 foo() was defined in an editing session
2214 2214
2215 2215 Now we edit foo. IPython automatically loads the editor with the
2216 2216 (temporary) file where foo() was previously defined:
2217 2217
2218 2218 In [3]: ed foo
2219 2219 Editing... done. Executing edited code...
2220 2220
2221 2221 And if we call foo() again we get the modified version:
2222 2222
2223 2223 In [4]: foo()
2224 2224 foo() has now been changed!
2225 2225
2226 2226 Here is an example of how to edit a code snippet successive
2227 2227 times. First we call the editor:
2228 2228
2229 2229 In [5]: ed
2230 2230 Editing... done. Executing edited code...
2231 2231 hello
2232 2232 Out[5]: "print 'hello'n"
2233 2233
2234 2234 Now we call it again with the previous output (stored in _):
2235 2235
2236 2236 In [6]: ed _
2237 2237 Editing... done. Executing edited code...
2238 2238 hello world
2239 2239 Out[6]: "print 'hello world'n"
2240 2240
2241 2241 Now we call it with the output #8 (stored in _8, also as Out[8]):
2242 2242
2243 2243 In [7]: ed _8
2244 2244 Editing... done. Executing edited code...
2245 2245 hello again
2246 2246 Out[7]: "print 'hello again'n"
2247 2247
2248 2248
2249 2249 Changing the default editor hook:
2250 2250
2251 2251 If you wish to write your own editor hook, you can put it in a
2252 2252 configuration file which you load at startup time. The default hook
2253 2253 is defined in the IPython.core.hooks module, and you can use that as a
2254 2254 starting example for further modifications. That file also has
2255 2255 general instructions on how to set a new hook for use once you've
2256 2256 defined it."""
2257 2257
2258 2258 # FIXME: This function has become a convoluted mess. It needs a
2259 2259 # ground-up rewrite with clean, simple logic.
2260 2260
2261 2261 def make_filename(arg):
2262 2262 "Make a filename from the given args"
2263 2263 try:
2264 2264 filename = get_py_filename(arg)
2265 2265 except IOError:
2266 2266 if args.endswith('.py'):
2267 2267 filename = arg
2268 2268 else:
2269 2269 filename = None
2270 2270 return filename
2271 2271
2272 2272 # custom exceptions
2273 2273 class DataIsObject(Exception): pass
2274 2274
2275 2275 opts,args = self.parse_options(parameter_s,'prxn:')
2276 2276 # Set a few locals from the options for convenience:
2277 2277 opts_p = opts.has_key('p')
2278 2278 opts_r = opts.has_key('r')
2279 2279
2280 2280 # Default line number value
2281 2281 lineno = opts.get('n',None)
2282 2282
2283 2283 if opts_p:
2284 2284 args = '_%s' % last_call[0]
2285 2285 if not self.shell.user_ns.has_key(args):
2286 2286 args = last_call[1]
2287 2287
2288 2288 # use last_call to remember the state of the previous call, but don't
2289 2289 # let it be clobbered by successive '-p' calls.
2290 2290 try:
2291 2291 last_call[0] = self.shell.outputcache.prompt_count
2292 2292 if not opts_p:
2293 2293 last_call[1] = parameter_s
2294 2294 except:
2295 2295 pass
2296 2296
2297 2297 # by default this is done with temp files, except when the given
2298 2298 # arg is a filename
2299 2299 use_temp = 1
2300 2300
2301 2301 if re.match(r'\d',args):
2302 2302 # Mode where user specifies ranges of lines, like in %macro.
2303 2303 # This means that you can't edit files whose names begin with
2304 2304 # numbers this way. Tough.
2305 2305 ranges = args.split()
2306 2306 data = ''.join(self.extract_input_slices(ranges,opts_r))
2307 2307 elif args.endswith('.py'):
2308 2308 filename = make_filename(args)
2309 2309 data = ''
2310 2310 use_temp = 0
2311 2311 elif args:
2312 2312 try:
2313 2313 # Load the parameter given as a variable. If not a string,
2314 2314 # process it as an object instead (below)
2315 2315
2316 2316 #print '*** args',args,'type',type(args) # dbg
2317 2317 data = eval(args,self.shell.user_ns)
2318 2318 if not type(data) in StringTypes:
2319 2319 raise DataIsObject
2320 2320
2321 2321 except (NameError,SyntaxError):
2322 2322 # given argument is not a variable, try as a filename
2323 2323 filename = make_filename(args)
2324 2324 if filename is None:
2325 2325 warn("Argument given (%s) can't be found as a variable "
2326 2326 "or as a filename." % args)
2327 2327 return
2328 2328
2329 2329 data = ''
2330 2330 use_temp = 0
2331 2331 except DataIsObject:
2332 2332
2333 2333 # macros have a special edit function
2334 2334 if isinstance(data,Macro):
2335 2335 self._edit_macro(args,data)
2336 2336 return
2337 2337
2338 2338 # For objects, try to edit the file where they are defined
2339 2339 try:
2340 2340 filename = inspect.getabsfile(data)
2341 2341 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2342 2342 # class created by %edit? Try to find source
2343 2343 # by looking for method definitions instead, the
2344 2344 # __module__ in those classes is FakeModule.
2345 2345 attrs = [getattr(data, aname) for aname in dir(data)]
2346 2346 for attr in attrs:
2347 2347 if not inspect.ismethod(attr):
2348 2348 continue
2349 2349 filename = inspect.getabsfile(attr)
2350 2350 if filename and 'fakemodule' not in filename.lower():
2351 2351 # change the attribute to be the edit target instead
2352 2352 data = attr
2353 2353 break
2354 2354
2355 2355 datafile = 1
2356 2356 except TypeError:
2357 2357 filename = make_filename(args)
2358 2358 datafile = 1
2359 2359 warn('Could not find file where `%s` is defined.\n'
2360 2360 'Opening a file named `%s`' % (args,filename))
2361 2361 # Now, make sure we can actually read the source (if it was in
2362 2362 # a temp file it's gone by now).
2363 2363 if datafile:
2364 2364 try:
2365 2365 if lineno is None:
2366 2366 lineno = inspect.getsourcelines(data)[1]
2367 2367 except IOError:
2368 2368 filename = make_filename(args)
2369 2369 if filename is None:
2370 2370 warn('The file `%s` where `%s` was defined cannot '
2371 2371 'be read.' % (filename,data))
2372 2372 return
2373 2373 use_temp = 0
2374 2374 else:
2375 2375 data = ''
2376 2376
2377 2377 if use_temp:
2378 2378 filename = self.shell.mktempfile(data)
2379 2379 print 'IPython will make a temporary file named:',filename
2380 2380
2381 2381 # do actual editing here
2382 2382 print 'Editing...',
2383 2383 sys.stdout.flush()
2384 2384 try:
2385 2385 self.shell.hooks.editor(filename,lineno)
2386 2386 except TryNext:
2387 2387 warn('Could not open editor')
2388 2388 return
2389 2389
2390 2390 # XXX TODO: should this be generalized for all string vars?
2391 2391 # For now, this is special-cased to blocks created by cpaste
2392 2392 if args.strip() == 'pasted_block':
2393 2393 self.shell.user_ns['pasted_block'] = file_read(filename)
2394 2394
2395 2395 if opts.has_key('x'): # -x prevents actual execution
2396 2396 print
2397 2397 else:
2398 2398 print 'done. Executing edited code...'
2399 2399 if opts_r:
2400 2400 self.shell.runlines(file_read(filename))
2401 2401 else:
2402 2402 self.shell.safe_execfile(filename,self.shell.user_ns,
2403 2403 self.shell.user_ns)
2404 2404
2405 2405
2406 2406 if use_temp:
2407 2407 try:
2408 2408 return open(filename).read()
2409 2409 except IOError,msg:
2410 2410 if msg.filename == filename:
2411 2411 warn('File not found. Did you forget to save?')
2412 2412 return
2413 2413 else:
2414 2414 self.shell.showtraceback()
2415 2415
2416 2416 def magic_xmode(self,parameter_s = ''):
2417 2417 """Switch modes for the exception handlers.
2418 2418
2419 2419 Valid modes: Plain, Context and Verbose.
2420 2420
2421 2421 If called without arguments, acts as a toggle."""
2422 2422
2423 2423 def xmode_switch_err(name):
2424 2424 warn('Error changing %s exception modes.\n%s' %
2425 2425 (name,sys.exc_info()[1]))
2426 2426
2427 2427 shell = self.shell
2428 2428 new_mode = parameter_s.strip().capitalize()
2429 2429 try:
2430 2430 shell.InteractiveTB.set_mode(mode=new_mode)
2431 2431 print 'Exception reporting mode:',shell.InteractiveTB.mode
2432 2432 except:
2433 2433 xmode_switch_err('user')
2434 2434
2435 2435 # threaded shells use a special handler in sys.excepthook
2436 2436 if shell.isthreaded:
2437 2437 try:
2438 2438 shell.sys_excepthook.set_mode(mode=new_mode)
2439 2439 except:
2440 2440 xmode_switch_err('threaded')
2441 2441
2442 2442 def magic_colors(self,parameter_s = ''):
2443 2443 """Switch color scheme for prompts, info system and exception handlers.
2444 2444
2445 2445 Currently implemented schemes: NoColor, Linux, LightBG.
2446 2446
2447 2447 Color scheme names are not case-sensitive."""
2448 2448
2449 2449 def color_switch_err(name):
2450 2450 warn('Error changing %s color schemes.\n%s' %
2451 2451 (name,sys.exc_info()[1]))
2452 2452
2453 2453
2454 2454 new_scheme = parameter_s.strip()
2455 2455 if not new_scheme:
2456 2456 raise UsageError(
2457 2457 "%colors: you must specify a color scheme. See '%colors?'")
2458 2458 return
2459 2459 # local shortcut
2460 2460 shell = self.shell
2461 2461
2462 2462 import IPython.utils.rlineimpl as readline
2463 2463
2464 2464 if not readline.have_readline and sys.platform == "win32":
2465 2465 msg = """\
2466 2466 Proper color support under MS Windows requires the pyreadline library.
2467 2467 You can find it at:
2468 2468 http://ipython.scipy.org/moin/PyReadline/Intro
2469 2469 Gary's readline needs the ctypes module, from:
2470 2470 http://starship.python.net/crew/theller/ctypes
2471 2471 (Note that ctypes is already part of Python versions 2.5 and newer).
2472 2472
2473 2473 Defaulting color scheme to 'NoColor'"""
2474 2474 new_scheme = 'NoColor'
2475 2475 warn(msg)
2476 2476
2477 2477 # readline option is 0
2478 2478 if not shell.has_readline:
2479 2479 new_scheme = 'NoColor'
2480 2480
2481 2481 # Set prompt colors
2482 2482 try:
2483 2483 shell.outputcache.set_colors(new_scheme)
2484 2484 except:
2485 2485 color_switch_err('prompt')
2486 2486 else:
2487 2487 shell.colors = \
2488 2488 shell.outputcache.color_table.active_scheme_name
2489 2489 # Set exception colors
2490 2490 try:
2491 2491 shell.InteractiveTB.set_colors(scheme = new_scheme)
2492 2492 shell.SyntaxTB.set_colors(scheme = new_scheme)
2493 2493 except:
2494 2494 color_switch_err('exception')
2495 2495
2496 2496 # threaded shells use a verbose traceback in sys.excepthook
2497 2497 if shell.isthreaded:
2498 2498 try:
2499 2499 shell.sys_excepthook.set_colors(scheme=new_scheme)
2500 2500 except:
2501 2501 color_switch_err('system exception handler')
2502 2502
2503 2503 # Set info (for 'object?') colors
2504 2504 if shell.color_info:
2505 2505 try:
2506 2506 shell.inspector.set_active_scheme(new_scheme)
2507 2507 except:
2508 2508 color_switch_err('object inspector')
2509 2509 else:
2510 2510 shell.inspector.set_active_scheme('NoColor')
2511 2511
2512 2512 def magic_color_info(self,parameter_s = ''):
2513 2513 """Toggle color_info.
2514 2514
2515 2515 The color_info configuration parameter controls whether colors are
2516 2516 used for displaying object details (by things like %psource, %pfile or
2517 2517 the '?' system). This function toggles this value with each call.
2518 2518
2519 2519 Note that unless you have a fairly recent pager (less works better
2520 2520 than more) in your system, using colored object information displays
2521 2521 will not work properly. Test it and see."""
2522 2522
2523 2523 self.shell.color_info = not self.shell.color_info
2524 2524 self.magic_colors(self.shell.colors)
2525 2525 print 'Object introspection functions have now coloring:',
2526 2526 print ['OFF','ON'][int(self.shell.color_info)]
2527 2527
2528 2528 def magic_Pprint(self, parameter_s=''):
2529 2529 """Toggle pretty printing on/off."""
2530 2530
2531 2531 self.shell.pprint = 1 - self.shell.pprint
2532 2532 print 'Pretty printing has been turned', \
2533 2533 ['OFF','ON'][self.shell.pprint]
2534 2534
2535 2535 def magic_Exit(self, parameter_s=''):
2536 2536 """Exit IPython without confirmation."""
2537 2537
2538 2538 self.shell.ask_exit()
2539 2539
2540 2540 #......................................................................
2541 2541 # Functions to implement unix shell-type things
2542 2542
2543 2543 @testdec.skip_doctest
2544 2544 def magic_alias(self, parameter_s = ''):
2545 2545 """Define an alias for a system command.
2546 2546
2547 2547 '%alias alias_name cmd' defines 'alias_name' as an alias for 'cmd'
2548 2548
2549 2549 Then, typing 'alias_name params' will execute the system command 'cmd
2550 2550 params' (from your underlying operating system).
2551 2551
2552 2552 Aliases have lower precedence than magic functions and Python normal
2553 2553 variables, so if 'foo' is both a Python variable and an alias, the
2554 2554 alias can not be executed until 'del foo' removes the Python variable.
2555 2555
2556 2556 You can use the %l specifier in an alias definition to represent the
2557 2557 whole line when the alias is called. For example:
2558 2558
2559 2559 In [2]: alias all echo "Input in brackets: <%l>"
2560 2560 In [3]: all hello world
2561 2561 Input in brackets: <hello world>
2562 2562
2563 2563 You can also define aliases with parameters using %s specifiers (one
2564 2564 per parameter):
2565 2565
2566 2566 In [1]: alias parts echo first %s second %s
2567 2567 In [2]: %parts A B
2568 2568 first A second B
2569 2569 In [3]: %parts A
2570 2570 Incorrect number of arguments: 2 expected.
2571 2571 parts is an alias to: 'echo first %s second %s'
2572 2572
2573 2573 Note that %l and %s are mutually exclusive. You can only use one or
2574 2574 the other in your aliases.
2575 2575
2576 2576 Aliases expand Python variables just like system calls using ! or !!
2577 2577 do: all expressions prefixed with '$' get expanded. For details of
2578 2578 the semantic rules, see PEP-215:
2579 2579 http://www.python.org/peps/pep-0215.html. This is the library used by
2580 2580 IPython for variable expansion. If you want to access a true shell
2581 2581 variable, an extra $ is necessary to prevent its expansion by IPython:
2582 2582
2583 2583 In [6]: alias show echo
2584 2584 In [7]: PATH='A Python string'
2585 2585 In [8]: show $PATH
2586 2586 A Python string
2587 2587 In [9]: show $$PATH
2588 2588 /usr/local/lf9560/bin:/usr/local/intel/compiler70/ia32/bin:...
2589 2589
2590 2590 You can use the alias facility to acess all of $PATH. See the %rehash
2591 2591 and %rehashx functions, which automatically create aliases for the
2592 2592 contents of your $PATH.
2593 2593
2594 2594 If called with no parameters, %alias prints the current alias table."""
2595 2595
2596 2596 par = parameter_s.strip()
2597 2597 if not par:
2598 2598 stored = self.db.get('stored_aliases', {} )
2599 2599 aliases = sorted(self.shell.alias_manager.aliases)
2600 2600 # for k, v in stored:
2601 2601 # atab.append(k, v[0])
2602 2602
2603 2603 print "Total number of aliases:", len(aliases)
2604 2604 return aliases
2605 2605
2606 2606 # Now try to define a new one
2607 2607 try:
2608 2608 alias,cmd = par.split(None, 1)
2609 2609 except:
2610 2610 print oinspect.getdoc(self.magic_alias)
2611 2611 else:
2612 2612 self.shell.alias_manager.soft_define_alias(alias, cmd)
2613 2613 # end magic_alias
2614 2614
2615 2615 def magic_unalias(self, parameter_s = ''):
2616 2616 """Remove an alias"""
2617 2617
2618 2618 aname = parameter_s.strip()
2619 2619 self.shell.alias_manager.undefine_alias(aname)
2620 2620 stored = self.db.get('stored_aliases', {} )
2621 2621 if aname in stored:
2622 2622 print "Removing %stored alias",aname
2623 2623 del stored[aname]
2624 2624 self.db['stored_aliases'] = stored
2625 2625
2626 2626
2627 2627 def magic_rehashx(self, parameter_s = ''):
2628 2628 """Update the alias table with all executable files in $PATH.
2629 2629
2630 2630 This version explicitly checks that every entry in $PATH is a file
2631 2631 with execute access (os.X_OK), so it is much slower than %rehash.
2632 2632
2633 2633 Under Windows, it checks executability as a match agains a
2634 2634 '|'-separated string of extensions, stored in the IPython config
2635 2635 variable win_exec_ext. This defaults to 'exe|com|bat'.
2636 2636
2637 2637 This function also resets the root module cache of module completer,
2638 2638 used on slow filesystems.
2639 2639 """
2640 2640 from IPython.core.alias import InvalidAliasError
2641 2641
2642 2642 # for the benefit of module completer in ipy_completers.py
2643 2643 del self.db['rootmodules']
2644 2644
2645 2645 path = [os.path.abspath(os.path.expanduser(p)) for p in
2646 2646 os.environ.get('PATH','').split(os.pathsep)]
2647 2647 path = filter(os.path.isdir,path)
2648 2648
2649 2649 syscmdlist = []
2650 2650 # Now define isexec in a cross platform manner.
2651 2651 if os.name == 'posix':
2652 2652 isexec = lambda fname:os.path.isfile(fname) and \
2653 2653 os.access(fname,os.X_OK)
2654 2654 else:
2655 2655 try:
2656 2656 winext = os.environ['pathext'].replace(';','|').replace('.','')
2657 2657 except KeyError:
2658 2658 winext = 'exe|com|bat|py'
2659 2659 if 'py' not in winext:
2660 2660 winext += '|py'
2661 2661 execre = re.compile(r'(.*)\.(%s)$' % winext,re.IGNORECASE)
2662 2662 isexec = lambda fname:os.path.isfile(fname) and execre.match(fname)
2663 2663 savedir = os.getcwd()
2664 2664
2665 2665 # Now walk the paths looking for executables to alias.
2666 2666 try:
2667 2667 # write the whole loop for posix/Windows so we don't have an if in
2668 2668 # the innermost part
2669 2669 if os.name == 'posix':
2670 2670 for pdir in path:
2671 2671 os.chdir(pdir)
2672 2672 for ff in os.listdir(pdir):
2673 2673 if isexec(ff):
2674 2674 try:
2675 2675 # Removes dots from the name since ipython
2676 2676 # will assume names with dots to be python.
2677 2677 self.shell.alias_manager.define_alias(
2678 2678 ff.replace('.',''), ff)
2679 2679 except InvalidAliasError:
2680 2680 pass
2681 2681 else:
2682 2682 syscmdlist.append(ff)
2683 2683 else:
2684 no_alias = self.shell.alias_manager.no_alias
2684 2685 for pdir in path:
2685 2686 os.chdir(pdir)
2686 2687 for ff in os.listdir(pdir):
2687 2688 base, ext = os.path.splitext(ff)
2688 if isexec(ff) and base.lower() not in self.shell.no_alias:
2689 if isexec(ff) and base.lower() not in no_alias:
2689 2690 if ext.lower() == '.exe':
2690 2691 ff = base
2691 2692 try:
2692 2693 # Removes dots from the name since ipython
2693 2694 # will assume names with dots to be python.
2694 2695 self.shell.alias_manager.define_alias(
2695 2696 base.lower().replace('.',''), ff)
2696 2697 except InvalidAliasError:
2697 2698 pass
2698 2699 syscmdlist.append(ff)
2699 2700 db = self.db
2700 2701 db['syscmdlist'] = syscmdlist
2701 2702 finally:
2702 2703 os.chdir(savedir)
2703 2704
2704 2705 def magic_pwd(self, parameter_s = ''):
2705 2706 """Return the current working directory path."""
2706 2707 return os.getcwd()
2707 2708
2708 2709 def magic_cd(self, parameter_s=''):
2709 2710 """Change the current working directory.
2710 2711
2711 2712 This command automatically maintains an internal list of directories
2712 2713 you visit during your IPython session, in the variable _dh. The
2713 2714 command %dhist shows this history nicely formatted. You can also
2714 2715 do 'cd -<tab>' to see directory history conveniently.
2715 2716
2716 2717 Usage:
2717 2718
2718 2719 cd 'dir': changes to directory 'dir'.
2719 2720
2720 2721 cd -: changes to the last visited directory.
2721 2722
2722 2723 cd -<n>: changes to the n-th directory in the directory history.
2723 2724
2724 2725 cd --foo: change to directory that matches 'foo' in history
2725 2726
2726 2727 cd -b <bookmark_name>: jump to a bookmark set by %bookmark
2727 2728 (note: cd <bookmark_name> is enough if there is no
2728 2729 directory <bookmark_name>, but a bookmark with the name exists.)
2729 2730 'cd -b <tab>' allows you to tab-complete bookmark names.
2730 2731
2731 2732 Options:
2732 2733
2733 2734 -q: quiet. Do not print the working directory after the cd command is
2734 2735 executed. By default IPython's cd command does print this directory,
2735 2736 since the default prompts do not display path information.
2736 2737
2737 2738 Note that !cd doesn't work for this purpose because the shell where
2738 2739 !command runs is immediately discarded after executing 'command'."""
2739 2740
2740 2741 parameter_s = parameter_s.strip()
2741 2742 #bkms = self.shell.persist.get("bookmarks",{})
2742 2743
2743 2744 oldcwd = os.getcwd()
2744 2745 numcd = re.match(r'(-)(\d+)$',parameter_s)
2745 2746 # jump in directory history by number
2746 2747 if numcd:
2747 2748 nn = int(numcd.group(2))
2748 2749 try:
2749 2750 ps = self.shell.user_ns['_dh'][nn]
2750 2751 except IndexError:
2751 2752 print 'The requested directory does not exist in history.'
2752 2753 return
2753 2754 else:
2754 2755 opts = {}
2755 2756 elif parameter_s.startswith('--'):
2756 2757 ps = None
2757 2758 fallback = None
2758 2759 pat = parameter_s[2:]
2759 2760 dh = self.shell.user_ns['_dh']
2760 2761 # first search only by basename (last component)
2761 2762 for ent in reversed(dh):
2762 2763 if pat in os.path.basename(ent) and os.path.isdir(ent):
2763 2764 ps = ent
2764 2765 break
2765 2766
2766 2767 if fallback is None and pat in ent and os.path.isdir(ent):
2767 2768 fallback = ent
2768 2769
2769 2770 # if we have no last part match, pick the first full path match
2770 2771 if ps is None:
2771 2772 ps = fallback
2772 2773
2773 2774 if ps is None:
2774 2775 print "No matching entry in directory history"
2775 2776 return
2776 2777 else:
2777 2778 opts = {}
2778 2779
2779 2780
2780 2781 else:
2781 2782 #turn all non-space-escaping backslashes to slashes,
2782 2783 # for c:\windows\directory\names\
2783 2784 parameter_s = re.sub(r'\\(?! )','/', parameter_s)
2784 2785 opts,ps = self.parse_options(parameter_s,'qb',mode='string')
2785 2786 # jump to previous
2786 2787 if ps == '-':
2787 2788 try:
2788 2789 ps = self.shell.user_ns['_dh'][-2]
2789 2790 except IndexError:
2790 2791 raise UsageError('%cd -: No previous directory to change to.')
2791 2792 # jump to bookmark if needed
2792 2793 else:
2793 2794 if not os.path.isdir(ps) or opts.has_key('b'):
2794 2795 bkms = self.db.get('bookmarks', {})
2795 2796
2796 2797 if bkms.has_key(ps):
2797 2798 target = bkms[ps]
2798 2799 print '(bookmark:%s) -> %s' % (ps,target)
2799 2800 ps = target
2800 2801 else:
2801 2802 if opts.has_key('b'):
2802 2803 raise UsageError("Bookmark '%s' not found. "
2803 2804 "Use '%%bookmark -l' to see your bookmarks." % ps)
2804 2805
2805 2806 # at this point ps should point to the target dir
2806 2807 if ps:
2807 2808 try:
2808 2809 os.chdir(os.path.expanduser(ps))
2809 2810 if self.shell.term_title:
2810 2811 platutils.set_term_title('IPython: ' + abbrev_cwd())
2811 2812 except OSError:
2812 2813 print sys.exc_info()[1]
2813 2814 else:
2814 2815 cwd = os.getcwd()
2815 2816 dhist = self.shell.user_ns['_dh']
2816 2817 if oldcwd != cwd:
2817 2818 dhist.append(cwd)
2818 2819 self.db['dhist'] = compress_dhist(dhist)[-100:]
2819 2820
2820 2821 else:
2821 2822 os.chdir(self.shell.home_dir)
2822 2823 if self.shell.term_title:
2823 2824 platutils.set_term_title('IPython: ' + '~')
2824 2825 cwd = os.getcwd()
2825 2826 dhist = self.shell.user_ns['_dh']
2826 2827
2827 2828 if oldcwd != cwd:
2828 2829 dhist.append(cwd)
2829 2830 self.db['dhist'] = compress_dhist(dhist)[-100:]
2830 2831 if not 'q' in opts and self.shell.user_ns['_dh']:
2831 2832 print self.shell.user_ns['_dh'][-1]
2832 2833
2833 2834
2834 2835 def magic_env(self, parameter_s=''):
2835 2836 """List environment variables."""
2836 2837
2837 2838 return os.environ.data
2838 2839
2839 2840 def magic_pushd(self, parameter_s=''):
2840 2841 """Place the current dir on stack and change directory.
2841 2842
2842 2843 Usage:\\
2843 2844 %pushd ['dirname']
2844 2845 """
2845 2846
2846 2847 dir_s = self.shell.dir_stack
2847 2848 tgt = os.path.expanduser(parameter_s)
2848 2849 cwd = os.getcwd().replace(self.home_dir,'~')
2849 2850 if tgt:
2850 2851 self.magic_cd(parameter_s)
2851 2852 dir_s.insert(0,cwd)
2852 2853 return self.magic_dirs()
2853 2854
2854 2855 def magic_popd(self, parameter_s=''):
2855 2856 """Change to directory popped off the top of the stack.
2856 2857 """
2857 2858 if not self.shell.dir_stack:
2858 2859 raise UsageError("%popd on empty stack")
2859 2860 top = self.shell.dir_stack.pop(0)
2860 2861 self.magic_cd(top)
2861 2862 print "popd ->",top
2862 2863
2863 2864 def magic_dirs(self, parameter_s=''):
2864 2865 """Return the current directory stack."""
2865 2866
2866 2867 return self.shell.dir_stack
2867 2868
2868 2869 def magic_dhist(self, parameter_s=''):
2869 2870 """Print your history of visited directories.
2870 2871
2871 2872 %dhist -> print full history\\
2872 2873 %dhist n -> print last n entries only\\
2873 2874 %dhist n1 n2 -> print entries between n1 and n2 (n1 not included)\\
2874 2875
2875 2876 This history is automatically maintained by the %cd command, and
2876 2877 always available as the global list variable _dh. You can use %cd -<n>
2877 2878 to go to directory number <n>.
2878 2879
2879 2880 Note that most of time, you should view directory history by entering
2880 2881 cd -<TAB>.
2881 2882
2882 2883 """
2883 2884
2884 2885 dh = self.shell.user_ns['_dh']
2885 2886 if parameter_s:
2886 2887 try:
2887 2888 args = map(int,parameter_s.split())
2888 2889 except:
2889 2890 self.arg_err(Magic.magic_dhist)
2890 2891 return
2891 2892 if len(args) == 1:
2892 2893 ini,fin = max(len(dh)-(args[0]),0),len(dh)
2893 2894 elif len(args) == 2:
2894 2895 ini,fin = args
2895 2896 else:
2896 2897 self.arg_err(Magic.magic_dhist)
2897 2898 return
2898 2899 else:
2899 2900 ini,fin = 0,len(dh)
2900 2901 nlprint(dh,
2901 2902 header = 'Directory history (kept in _dh)',
2902 2903 start=ini,stop=fin)
2903 2904
2904 2905 @testdec.skip_doctest
2905 2906 def magic_sc(self, parameter_s=''):
2906 2907 """Shell capture - execute a shell command and capture its output.
2907 2908
2908 2909 DEPRECATED. Suboptimal, retained for backwards compatibility.
2909 2910
2910 2911 You should use the form 'var = !command' instead. Example:
2911 2912
2912 2913 "%sc -l myfiles = ls ~" should now be written as
2913 2914
2914 2915 "myfiles = !ls ~"
2915 2916
2916 2917 myfiles.s, myfiles.l and myfiles.n still apply as documented
2917 2918 below.
2918 2919
2919 2920 --
2920 2921 %sc [options] varname=command
2921 2922
2922 2923 IPython will run the given command using commands.getoutput(), and
2923 2924 will then update the user's interactive namespace with a variable
2924 2925 called varname, containing the value of the call. Your command can
2925 2926 contain shell wildcards, pipes, etc.
2926 2927
2927 2928 The '=' sign in the syntax is mandatory, and the variable name you
2928 2929 supply must follow Python's standard conventions for valid names.
2929 2930
2930 2931 (A special format without variable name exists for internal use)
2931 2932
2932 2933 Options:
2933 2934
2934 2935 -l: list output. Split the output on newlines into a list before
2935 2936 assigning it to the given variable. By default the output is stored
2936 2937 as a single string.
2937 2938
2938 2939 -v: verbose. Print the contents of the variable.
2939 2940
2940 2941 In most cases you should not need to split as a list, because the
2941 2942 returned value is a special type of string which can automatically
2942 2943 provide its contents either as a list (split on newlines) or as a
2943 2944 space-separated string. These are convenient, respectively, either
2944 2945 for sequential processing or to be passed to a shell command.
2945 2946
2946 2947 For example:
2947 2948
2948 2949 # all-random
2949 2950
2950 2951 # Capture into variable a
2951 2952 In [1]: sc a=ls *py
2952 2953
2953 2954 # a is a string with embedded newlines
2954 2955 In [2]: a
2955 2956 Out[2]: 'setup.py\\nwin32_manual_post_install.py'
2956 2957
2957 2958 # which can be seen as a list:
2958 2959 In [3]: a.l
2959 2960 Out[3]: ['setup.py', 'win32_manual_post_install.py']
2960 2961
2961 2962 # or as a whitespace-separated string:
2962 2963 In [4]: a.s
2963 2964 Out[4]: 'setup.py win32_manual_post_install.py'
2964 2965
2965 2966 # a.s is useful to pass as a single command line:
2966 2967 In [5]: !wc -l $a.s
2967 2968 146 setup.py
2968 2969 130 win32_manual_post_install.py
2969 2970 276 total
2970 2971
2971 2972 # while the list form is useful to loop over:
2972 2973 In [6]: for f in a.l:
2973 2974 ...: !wc -l $f
2974 2975 ...:
2975 2976 146 setup.py
2976 2977 130 win32_manual_post_install.py
2977 2978
2978 2979 Similiarly, the lists returned by the -l option are also special, in
2979 2980 the sense that you can equally invoke the .s attribute on them to
2980 2981 automatically get a whitespace-separated string from their contents:
2981 2982
2982 2983 In [7]: sc -l b=ls *py
2983 2984
2984 2985 In [8]: b
2985 2986 Out[8]: ['setup.py', 'win32_manual_post_install.py']
2986 2987
2987 2988 In [9]: b.s
2988 2989 Out[9]: 'setup.py win32_manual_post_install.py'
2989 2990
2990 2991 In summary, both the lists and strings used for ouptut capture have
2991 2992 the following special attributes:
2992 2993
2993 2994 .l (or .list) : value as list.
2994 2995 .n (or .nlstr): value as newline-separated string.
2995 2996 .s (or .spstr): value as space-separated string.
2996 2997 """
2997 2998
2998 2999 opts,args = self.parse_options(parameter_s,'lv')
2999 3000 # Try to get a variable name and command to run
3000 3001 try:
3001 3002 # the variable name must be obtained from the parse_options
3002 3003 # output, which uses shlex.split to strip options out.
3003 3004 var,_ = args.split('=',1)
3004 3005 var = var.strip()
3005 3006 # But the the command has to be extracted from the original input
3006 3007 # parameter_s, not on what parse_options returns, to avoid the
3007 3008 # quote stripping which shlex.split performs on it.
3008 3009 _,cmd = parameter_s.split('=',1)
3009 3010 except ValueError:
3010 3011 var,cmd = '',''
3011 3012 # If all looks ok, proceed
3012 3013 out,err = self.shell.getoutputerror(cmd)
3013 3014 if err:
3014 3015 print >> Term.cerr,err
3015 3016 if opts.has_key('l'):
3016 3017 out = SList(out.split('\n'))
3017 3018 else:
3018 3019 out = LSString(out)
3019 3020 if opts.has_key('v'):
3020 3021 print '%s ==\n%s' % (var,pformat(out))
3021 3022 if var:
3022 3023 self.shell.user_ns.update({var:out})
3023 3024 else:
3024 3025 return out
3025 3026
3026 3027 def magic_sx(self, parameter_s=''):
3027 3028 """Shell execute - run a shell command and capture its output.
3028 3029
3029 3030 %sx command
3030 3031
3031 3032 IPython will run the given command using commands.getoutput(), and
3032 3033 return the result formatted as a list (split on '\\n'). Since the
3033 3034 output is _returned_, it will be stored in ipython's regular output
3034 3035 cache Out[N] and in the '_N' automatic variables.
3035 3036
3036 3037 Notes:
3037 3038
3038 3039 1) If an input line begins with '!!', then %sx is automatically
3039 3040 invoked. That is, while:
3040 3041 !ls
3041 3042 causes ipython to simply issue system('ls'), typing
3042 3043 !!ls
3043 3044 is a shorthand equivalent to:
3044 3045 %sx ls
3045 3046
3046 3047 2) %sx differs from %sc in that %sx automatically splits into a list,
3047 3048 like '%sc -l'. The reason for this is to make it as easy as possible
3048 3049 to process line-oriented shell output via further python commands.
3049 3050 %sc is meant to provide much finer control, but requires more
3050 3051 typing.
3051 3052
3052 3053 3) Just like %sc -l, this is a list with special attributes:
3053 3054
3054 3055 .l (or .list) : value as list.
3055 3056 .n (or .nlstr): value as newline-separated string.
3056 3057 .s (or .spstr): value as whitespace-separated string.
3057 3058
3058 3059 This is very useful when trying to use such lists as arguments to
3059 3060 system commands."""
3060 3061
3061 3062 if parameter_s:
3062 3063 out,err = self.shell.getoutputerror(parameter_s)
3063 3064 if err:
3064 3065 print >> Term.cerr,err
3065 3066 return SList(out.split('\n'))
3066 3067
3067 3068 def magic_bg(self, parameter_s=''):
3068 3069 """Run a job in the background, in a separate thread.
3069 3070
3070 3071 For example,
3071 3072
3072 3073 %bg myfunc(x,y,z=1)
3073 3074
3074 3075 will execute 'myfunc(x,y,z=1)' in a background thread. As soon as the
3075 3076 execution starts, a message will be printed indicating the job
3076 3077 number. If your job number is 5, you can use
3077 3078
3078 3079 myvar = jobs.result(5) or myvar = jobs[5].result
3079 3080
3080 3081 to assign this result to variable 'myvar'.
3081 3082
3082 3083 IPython has a job manager, accessible via the 'jobs' object. You can
3083 3084 type jobs? to get more information about it, and use jobs.<TAB> to see
3084 3085 its attributes. All attributes not starting with an underscore are
3085 3086 meant for public use.
3086 3087
3087 3088 In particular, look at the jobs.new() method, which is used to create
3088 3089 new jobs. This magic %bg function is just a convenience wrapper
3089 3090 around jobs.new(), for expression-based jobs. If you want to create a
3090 3091 new job with an explicit function object and arguments, you must call
3091 3092 jobs.new() directly.
3092 3093
3093 3094 The jobs.new docstring also describes in detail several important
3094 3095 caveats associated with a thread-based model for background job
3095 3096 execution. Type jobs.new? for details.
3096 3097
3097 3098 You can check the status of all jobs with jobs.status().
3098 3099
3099 3100 The jobs variable is set by IPython into the Python builtin namespace.
3100 3101 If you ever declare a variable named 'jobs', you will shadow this
3101 3102 name. You can either delete your global jobs variable to regain
3102 3103 access to the job manager, or make a new name and assign it manually
3103 3104 to the manager (stored in IPython's namespace). For example, to
3104 3105 assign the job manager to the Jobs name, use:
3105 3106
3106 3107 Jobs = __builtins__.jobs"""
3107 3108
3108 3109 self.shell.jobs.new(parameter_s,self.shell.user_ns)
3109 3110
3110 3111 def magic_r(self, parameter_s=''):
3111 3112 """Repeat previous input.
3112 3113
3113 3114 Note: Consider using the more powerfull %rep instead!
3114 3115
3115 3116 If given an argument, repeats the previous command which starts with
3116 3117 the same string, otherwise it just repeats the previous input.
3117 3118
3118 3119 Shell escaped commands (with ! as first character) are not recognized
3119 3120 by this system, only pure python code and magic commands.
3120 3121 """
3121 3122
3122 3123 start = parameter_s.strip()
3123 3124 esc_magic = ESC_MAGIC
3124 3125 # Identify magic commands even if automagic is on (which means
3125 3126 # the in-memory version is different from that typed by the user).
3126 3127 if self.shell.automagic:
3127 3128 start_magic = esc_magic+start
3128 3129 else:
3129 3130 start_magic = start
3130 3131 # Look through the input history in reverse
3131 3132 for n in range(len(self.shell.input_hist)-2,0,-1):
3132 3133 input = self.shell.input_hist[n]
3133 3134 # skip plain 'r' lines so we don't recurse to infinity
3134 3135 if input != '_ip.magic("r")\n' and \
3135 3136 (input.startswith(start) or input.startswith(start_magic)):
3136 3137 #print 'match',`input` # dbg
3137 3138 print 'Executing:',input,
3138 3139 self.shell.runlines(input)
3139 3140 return
3140 3141 print 'No previous input matching `%s` found.' % start
3141 3142
3142 3143
3143 3144 def magic_bookmark(self, parameter_s=''):
3144 3145 """Manage IPython's bookmark system.
3145 3146
3146 3147 %bookmark <name> - set bookmark to current dir
3147 3148 %bookmark <name> <dir> - set bookmark to <dir>
3148 3149 %bookmark -l - list all bookmarks
3149 3150 %bookmark -d <name> - remove bookmark
3150 3151 %bookmark -r - remove all bookmarks
3151 3152
3152 3153 You can later on access a bookmarked folder with:
3153 3154 %cd -b <name>
3154 3155 or simply '%cd <name>' if there is no directory called <name> AND
3155 3156 there is such a bookmark defined.
3156 3157
3157 3158 Your bookmarks persist through IPython sessions, but they are
3158 3159 associated with each profile."""
3159 3160
3160 3161 opts,args = self.parse_options(parameter_s,'drl',mode='list')
3161 3162 if len(args) > 2:
3162 3163 raise UsageError("%bookmark: too many arguments")
3163 3164
3164 3165 bkms = self.db.get('bookmarks',{})
3165 3166
3166 3167 if opts.has_key('d'):
3167 3168 try:
3168 3169 todel = args[0]
3169 3170 except IndexError:
3170 3171 raise UsageError(
3171 3172 "%bookmark -d: must provide a bookmark to delete")
3172 3173 else:
3173 3174 try:
3174 3175 del bkms[todel]
3175 3176 except KeyError:
3176 3177 raise UsageError(
3177 3178 "%%bookmark -d: Can't delete bookmark '%s'" % todel)
3178 3179
3179 3180 elif opts.has_key('r'):
3180 3181 bkms = {}
3181 3182 elif opts.has_key('l'):
3182 3183 bks = bkms.keys()
3183 3184 bks.sort()
3184 3185 if bks:
3185 3186 size = max(map(len,bks))
3186 3187 else:
3187 3188 size = 0
3188 3189 fmt = '%-'+str(size)+'s -> %s'
3189 3190 print 'Current bookmarks:'
3190 3191 for bk in bks:
3191 3192 print fmt % (bk,bkms[bk])
3192 3193 else:
3193 3194 if not args:
3194 3195 raise UsageError("%bookmark: You must specify the bookmark name")
3195 3196 elif len(args)==1:
3196 3197 bkms[args[0]] = os.getcwd()
3197 3198 elif len(args)==2:
3198 3199 bkms[args[0]] = args[1]
3199 3200 self.db['bookmarks'] = bkms
3200 3201
3201 3202 def magic_pycat(self, parameter_s=''):
3202 3203 """Show a syntax-highlighted file through a pager.
3203 3204
3204 3205 This magic is similar to the cat utility, but it will assume the file
3205 3206 to be Python source and will show it with syntax highlighting. """
3206 3207
3207 3208 try:
3208 3209 filename = get_py_filename(parameter_s)
3209 3210 cont = file_read(filename)
3210 3211 except IOError:
3211 3212 try:
3212 3213 cont = eval(parameter_s,self.user_ns)
3213 3214 except NameError:
3214 3215 cont = None
3215 3216 if cont is None:
3216 3217 print "Error: no such file or variable"
3217 3218 return
3218 3219
3219 3220 page(self.shell.pycolorize(cont),
3220 3221 screen_lines=self.shell.usable_screen_length)
3221 3222
3222 3223 def _rerun_pasted(self):
3223 3224 """ Rerun a previously pasted command.
3224 3225 """
3225 3226 b = self.user_ns.get('pasted_block', None)
3226 3227 if b is None:
3227 3228 raise UsageError('No previous pasted block available')
3228 3229 print "Re-executing '%s...' (%d chars)"% (b.split('\n',1)[0], len(b))
3229 3230 exec b in self.user_ns
3230 3231
3231 3232 def _get_pasted_lines(self, sentinel):
3232 3233 """ Yield pasted lines until the user enters the given sentinel value.
3233 3234 """
3234 3235 from IPython.core import iplib
3235 3236 print "Pasting code; enter '%s' alone on the line to stop." % sentinel
3236 3237 while True:
3237 3238 l = iplib.raw_input_original(':')
3238 3239 if l == sentinel:
3239 3240 return
3240 3241 else:
3241 3242 yield l
3242 3243
3243 3244 def _strip_pasted_lines_for_code(self, raw_lines):
3244 3245 """ Strip non-code parts of a sequence of lines to return a block of
3245 3246 code.
3246 3247 """
3247 3248 # Regular expressions that declare text we strip from the input:
3248 3249 strip_re = [r'^\s*In \[\d+\]:', # IPython input prompt
3249 3250 r'^\s*(\s?>)+', # Python input prompt
3250 3251 r'^\s*\.{3,}', # Continuation prompts
3251 3252 r'^\++',
3252 3253 ]
3253 3254
3254 3255 strip_from_start = map(re.compile,strip_re)
3255 3256
3256 3257 lines = []
3257 3258 for l in raw_lines:
3258 3259 for pat in strip_from_start:
3259 3260 l = pat.sub('',l)
3260 3261 lines.append(l)
3261 3262
3262 3263 block = "\n".join(lines) + '\n'
3263 3264 #print "block:\n",block
3264 3265 return block
3265 3266
3266 3267 def _execute_block(self, block, par):
3267 3268 """ Execute a block, or store it in a variable, per the user's request.
3268 3269 """
3269 3270 if not par:
3270 3271 b = textwrap.dedent(block)
3271 3272 self.user_ns['pasted_block'] = b
3272 3273 exec b in self.user_ns
3273 3274 else:
3274 3275 self.user_ns[par] = SList(block.splitlines())
3275 3276 print "Block assigned to '%s'" % par
3276 3277
3277 3278 def magic_cpaste(self, parameter_s=''):
3278 3279 """Allows you to paste & execute a pre-formatted code block from clipboard.
3279 3280
3280 3281 You must terminate the block with '--' (two minus-signs) alone on the
3281 3282 line. You can also provide your own sentinel with '%paste -s %%' ('%%'
3282 3283 is the new sentinel for this operation)
3283 3284
3284 3285 The block is dedented prior to execution to enable execution of method
3285 3286 definitions. '>' and '+' characters at the beginning of a line are
3286 3287 ignored, to allow pasting directly from e-mails, diff files and
3287 3288 doctests (the '...' continuation prompt is also stripped). The
3288 3289 executed block is also assigned to variable named 'pasted_block' for
3289 3290 later editing with '%edit pasted_block'.
3290 3291
3291 3292 You can also pass a variable name as an argument, e.g. '%cpaste foo'.
3292 3293 This assigns the pasted block to variable 'foo' as string, without
3293 3294 dedenting or executing it (preceding >>> and + is still stripped)
3294 3295
3295 3296 '%cpaste -r' re-executes the block previously entered by cpaste.
3296 3297
3297 3298 Do not be alarmed by garbled output on Windows (it's a readline bug).
3298 3299 Just press enter and type -- (and press enter again) and the block
3299 3300 will be what was just pasted.
3300 3301
3301 3302 IPython statements (magics, shell escapes) are not supported (yet).
3302 3303
3303 3304 See also
3304 3305 --------
3305 3306 paste: automatically pull code from clipboard.
3306 3307 """
3307 3308
3308 3309 opts,args = self.parse_options(parameter_s,'rs:',mode='string')
3309 3310 par = args.strip()
3310 3311 if opts.has_key('r'):
3311 3312 self._rerun_pasted()
3312 3313 return
3313 3314
3314 3315 sentinel = opts.get('s','--')
3315 3316
3316 3317 block = self._strip_pasted_lines_for_code(
3317 3318 self._get_pasted_lines(sentinel))
3318 3319
3319 3320 self._execute_block(block, par)
3320 3321
3321 3322 def magic_paste(self, parameter_s=''):
3322 3323 """Allows you to paste & execute a pre-formatted code block from clipboard.
3323 3324
3324 3325 The text is pulled directly from the clipboard without user
3325 3326 intervention and printed back on the screen before execution (unless
3326 3327 the -q flag is given to force quiet mode).
3327 3328
3328 3329 The block is dedented prior to execution to enable execution of method
3329 3330 definitions. '>' and '+' characters at the beginning of a line are
3330 3331 ignored, to allow pasting directly from e-mails, diff files and
3331 3332 doctests (the '...' continuation prompt is also stripped). The
3332 3333 executed block is also assigned to variable named 'pasted_block' for
3333 3334 later editing with '%edit pasted_block'.
3334 3335
3335 3336 You can also pass a variable name as an argument, e.g. '%paste foo'.
3336 3337 This assigns the pasted block to variable 'foo' as string, without
3337 3338 dedenting or executing it (preceding >>> and + is still stripped)
3338 3339
3339 3340 Options
3340 3341 -------
3341 3342
3342 3343 -r: re-executes the block previously entered by cpaste.
3343 3344
3344 3345 -q: quiet mode: do not echo the pasted text back to the terminal.
3345 3346
3346 3347 IPython statements (magics, shell escapes) are not supported (yet).
3347 3348
3348 3349 See also
3349 3350 --------
3350 3351 cpaste: manually paste code into terminal until you mark its end.
3351 3352 """
3352 3353 opts,args = self.parse_options(parameter_s,'rq',mode='string')
3353 3354 par = args.strip()
3354 3355 if opts.has_key('r'):
3355 3356 self._rerun_pasted()
3356 3357 return
3357 3358
3358 3359 text = self.shell.hooks.clipboard_get()
3359 3360 block = self._strip_pasted_lines_for_code(text.splitlines())
3360 3361
3361 3362 # By default, echo back to terminal unless quiet mode is requested
3362 3363 if not opts.has_key('q'):
3363 3364 write = self.shell.write
3364 3365 write(self.shell.pycolorize(block))
3365 3366 if not block.endswith('\n'):
3366 3367 write('\n')
3367 3368 write("## -- End pasted text --\n")
3368 3369
3369 3370 self._execute_block(block, par)
3370 3371
3371 3372 def magic_quickref(self,arg):
3372 3373 """ Show a quick reference sheet """
3373 3374 import IPython.core.usage
3374 3375 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3375 3376
3376 3377 page(qr)
3377 3378
3378 3379 def magic_doctest_mode(self,parameter_s=''):
3379 3380 """Toggle doctest mode on and off.
3380 3381
3381 3382 This mode allows you to toggle the prompt behavior between normal
3382 3383 IPython prompts and ones that are as similar to the default IPython
3383 3384 interpreter as possible.
3384 3385
3385 3386 It also supports the pasting of code snippets that have leading '>>>'
3386 3387 and '...' prompts in them. This means that you can paste doctests from
3387 3388 files or docstrings (even if they have leading whitespace), and the
3388 3389 code will execute correctly. You can then use '%history -tn' to see
3389 3390 the translated history without line numbers; this will give you the
3390 3391 input after removal of all the leading prompts and whitespace, which
3391 3392 can be pasted back into an editor.
3392 3393
3393 3394 With these features, you can switch into this mode easily whenever you
3394 3395 need to do testing and changes to doctests, without having to leave
3395 3396 your existing IPython session.
3396 3397 """
3397 3398
3398 3399 from IPython.utils.ipstruct import Struct
3399 3400
3400 3401 # Shorthands
3401 3402 shell = self.shell
3402 3403 oc = shell.outputcache
3403 3404 meta = shell.meta
3404 3405 # dstore is a data store kept in the instance metadata bag to track any
3405 3406 # changes we make, so we can undo them later.
3406 3407 dstore = meta.setdefault('doctest_mode',Struct())
3407 3408 save_dstore = dstore.setdefault
3408 3409
3409 3410 # save a few values we'll need to recover later
3410 3411 mode = save_dstore('mode',False)
3411 3412 save_dstore('rc_pprint',shell.pprint)
3412 3413 save_dstore('xmode',shell.InteractiveTB.mode)
3413 3414 save_dstore('rc_separate_out',shell.separate_out)
3414 3415 save_dstore('rc_separate_out2',shell.separate_out2)
3415 3416 save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
3416 3417 save_dstore('rc_separate_in',shell.separate_in)
3417 3418
3418 3419 if mode == False:
3419 3420 # turn on
3420 3421 oc.prompt1.p_template = '>>> '
3421 3422 oc.prompt2.p_template = '... '
3422 3423 oc.prompt_out.p_template = ''
3423 3424
3424 3425 # Prompt separators like plain python
3425 3426 oc.input_sep = oc.prompt1.sep = ''
3426 3427 oc.output_sep = ''
3427 3428 oc.output_sep2 = ''
3428 3429
3429 3430 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3430 3431 oc.prompt_out.pad_left = False
3431 3432
3432 3433 shell.pprint = False
3433 3434
3434 3435 shell.magic_xmode('Plain')
3435 3436
3436 3437 else:
3437 3438 # turn off
3438 3439 oc.prompt1.p_template = shell.prompt_in1
3439 3440 oc.prompt2.p_template = shell.prompt_in2
3440 3441 oc.prompt_out.p_template = shell.prompt_out
3441 3442
3442 3443 oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
3443 3444
3444 3445 oc.output_sep = dstore.rc_separate_out
3445 3446 oc.output_sep2 = dstore.rc_separate_out2
3446 3447
3447 3448 oc.prompt1.pad_left = oc.prompt2.pad_left = \
3448 3449 oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
3449 3450
3450 3451 shell.pprint = dstore.rc_pprint
3451 3452
3452 3453 shell.magic_xmode(dstore.xmode)
3453 3454
3454 3455 # Store new mode and inform
3455 3456 dstore.mode = bool(1-int(mode))
3456 3457 print 'Doctest mode is:',
3457 3458 print ['OFF','ON'][dstore.mode]
3458 3459
3459 3460 def magic_gui(self, parameter_s=''):
3460 3461 """Enable or disable IPython GUI event loop integration.
3461 3462
3462 3463 %gui [-a] [GUINAME]
3463 3464
3464 3465 This magic replaces IPython's threaded shells that were activated
3465 3466 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3466 3467 can now be enabled, disabled and swtiched at runtime and keyboard
3467 3468 interrupts should work without any problems. The following toolkits
3468 3469 are supported: wxPython, PyQt4, PyGTK, and Tk::
3469 3470
3470 3471 %gui wx # enable wxPython event loop integration
3471 3472 %gui qt4|qt # enable PyQt4 event loop integration
3472 3473 %gui gtk # enable PyGTK event loop integration
3473 3474 %gui tk # enable Tk event loop integration
3474 3475 %gui # disable all event loop integration
3475 3476
3476 3477 WARNING: after any of these has been called you can simply create
3477 3478 an application object, but DO NOT start the event loop yourself, as
3478 3479 we have already handled that.
3479 3480
3480 3481 If you want us to create an appropriate application object add the
3481 3482 "-a" flag to your command::
3482 3483
3483 3484 %gui -a wx
3484 3485
3485 3486 This is highly recommended for most users.
3486 3487 """
3487 3488 opts, arg = self.parse_options(parameter_s,'a')
3488 3489 if arg=='': arg = None
3489 3490 return enable_gui(arg, 'a' in opts)
3490 3491
3491 3492 def magic_load_ext(self, module_str):
3492 3493 """Load an IPython extension by its module name."""
3493 3494 return self.load_extension(module_str)
3494 3495
3495 3496 def magic_unload_ext(self, module_str):
3496 3497 """Unload an IPython extension by its module name."""
3497 3498 self.unload_extension(module_str)
3498 3499
3499 3500 def magic_reload_ext(self, module_str):
3500 3501 """Reload an IPython extension by its module name."""
3501 3502 self.reload_extension(module_str)
3502 3503
3503 3504 @testdec.skip_doctest
3504 3505 def magic_install_profiles(self, s):
3505 3506 """Install the default IPython profiles into the .ipython dir.
3506 3507
3507 3508 If the default profiles have already been installed, they will not
3508 3509 be overwritten. You can force overwriting them by using the ``-o``
3509 3510 option::
3510 3511
3511 3512 In [1]: %install_profiles -o
3512 3513 """
3513 3514 if '-o' in s:
3514 3515 overwrite = True
3515 3516 else:
3516 3517 overwrite = False
3517 3518 from IPython.config import profile
3518 3519 profile_dir = os.path.split(profile.__file__)[0]
3519 3520 ipython_dir = self.ipython_dir
3520 3521 files = os.listdir(profile_dir)
3521 3522
3522 3523 to_install = []
3523 3524 for f in files:
3524 3525 if f.startswith('ipython_config'):
3525 3526 src = os.path.join(profile_dir, f)
3526 3527 dst = os.path.join(ipython_dir, f)
3527 3528 if (not os.path.isfile(dst)) or overwrite:
3528 3529 to_install.append((f, src, dst))
3529 3530 if len(to_install)>0:
3530 3531 print "Installing profiles to: ", ipython_dir
3531 3532 for (f, src, dst) in to_install:
3532 3533 shutil.copy(src, dst)
3533 3534 print " %s" % f
3534 3535
3535 3536 def magic_install_default_config(self, s):
3536 3537 """Install IPython's default config file into the .ipython dir.
3537 3538
3538 3539 If the default config file (:file:`ipython_config.py`) is already
3539 3540 installed, it will not be overwritten. You can force overwriting
3540 3541 by using the ``-o`` option::
3541 3542
3542 3543 In [1]: %install_default_config
3543 3544 """
3544 3545 if '-o' in s:
3545 3546 overwrite = True
3546 3547 else:
3547 3548 overwrite = False
3548 3549 from IPython.config import default
3549 3550 config_dir = os.path.split(default.__file__)[0]
3550 3551 ipython_dir = self.ipython_dir
3551 3552 default_config_file_name = 'ipython_config.py'
3552 3553 src = os.path.join(config_dir, default_config_file_name)
3553 3554 dst = os.path.join(ipython_dir, default_config_file_name)
3554 3555 if (not os.path.isfile(dst)) or overwrite:
3555 3556 shutil.copy(src, dst)
3556 3557 print "Installing default config file: %s" % dst
3557 3558
3558 3559 # Pylab support: simple wrappers that activate pylab, load gui input
3559 3560 # handling and modify slightly %run
3560 3561
3561 3562 @testdec.skip_doctest
3562 3563 def _pylab_magic_run(self, parameter_s=''):
3563 3564 Magic.magic_run(self, parameter_s,
3564 3565 runner=mpl_runner(self.shell.safe_execfile))
3565 3566
3566 3567 _pylab_magic_run.__doc__ = magic_run.__doc__
3567 3568
3568 3569 @testdec.skip_doctest
3569 3570 def magic_pylab(self, s):
3570 3571 """Load numpy and matplotlib to work interactively.
3571 3572
3572 3573 %pylab [GUINAME]
3573 3574
3574 3575 This function lets you activate pylab (matplotlib, numpy and
3575 3576 interactive support) at any point during an IPython session.
3576 3577
3577 3578 It will import at the top level numpy as np, pyplot as plt, matplotlib,
3578 3579 pylab and mlab, as well as all names from numpy and pylab.
3579 3580
3580 3581 Parameters
3581 3582 ----------
3582 3583 guiname : optional
3583 3584 One of the valid arguments to the %gui magic ('qt', 'wx', 'gtk' or
3584 3585 'tk'). If given, the corresponding Matplotlib backend is used,
3585 3586 otherwise matplotlib's default (which you can override in your
3586 3587 matplotlib config file) is used.
3587 3588
3588 3589 Examples
3589 3590 --------
3590 3591 In this case, where the MPL default is TkAgg:
3591 3592 In [2]: %pylab
3592 3593
3593 3594 Welcome to pylab, a matplotlib-based Python environment.
3594 3595 Backend in use: TkAgg
3595 3596 For more information, type 'help(pylab)'.
3596 3597
3597 3598 But you can explicitly request a different backend:
3598 3599 In [3]: %pylab qt
3599 3600
3600 3601 Welcome to pylab, a matplotlib-based Python environment.
3601 3602 Backend in use: Qt4Agg
3602 3603 For more information, type 'help(pylab)'.
3603 3604 """
3604 3605 self.shell.enable_pylab(s)
3605 3606
3606 3607 def magic_tb(self, s):
3607 3608 """Print the last traceback with the currently active exception mode.
3608 3609
3609 3610 See %xmode for changing exception reporting modes."""
3610 3611 self.shell.showtraceback()
3611 3612
3612 3613 # end Magic
General Comments 0
You need to be logged in to leave comments. Login now