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