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