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