##// END OF EJS Templates
Major restructuring of magics, breaking them up into separate classes....
Fernando Perez -
Show More
@@ -380,6 +380,7 b' class InteractiveShell(SingletonConfigurable):'
380 380 plugin_manager = Instance('IPython.core.plugin.PluginManager')
381 381 payload_manager = Instance('IPython.core.payload.PayloadManager')
382 382 history_manager = Instance('IPython.core.history.HistoryManager')
383 magics_manager = Instance('IPython.core.magic.MagicsManager')
383 384
384 385 profile_dir = Instance('IPython.core.application.ProfileDir')
385 386 @property
This diff has been collapsed as it changes many lines, (4544 lines changed) Show them Hide them
@@ -4,8 +4,8 b''
4 4
5 5 #-----------------------------------------------------------------------------
6 6 # Copyright (C) 2001 Janko Hauser <jhauser@zscout.de> and
7 # Copyright (C) 2001-2007 Fernando Perez <fperez@colorado.edu>
8 # Copyright (C) 2008-2011 The IPython Development Team
7 # Copyright (C) 2001 Fernando Perez <fperez@colorado.edu>
8 # Copyright (C) 2008 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.
@@ -18,14 +18,16 b''
18 18 import __builtin__ as builtin_mod
19 19 import __future__
20 20 import bdb
21 import gc
22 import imp
21 23 import inspect
22 24 import io
23 25 import json
24 26 import os
25 import sys
26 27 import re
28 import shutil
29 import sys
27 30 import time
28 import gc
29 31 from StringIO import StringIO
30 32 from getopt import getopt,GetoptError
31 33 from pprint import pformat
@@ -42,36 +44,48 b' except ImportError:'
42 44 except ImportError:
43 45 profile = pstats = None
44 46
47 import IPython
48 from IPython.config.application import Application
49 from IPython.config.configurable import Configurable
45 50 from IPython.core import debugger, oinspect
51 from IPython.core import magic_arguments, page
52 from IPython.core.error import StdinNotImplementedError
46 53 from IPython.core.error import TryNext
47 54 from IPython.core.error import UsageError
48 from IPython.core.error import StdinNotImplementedError
55 from IPython.core.fakemodule import FakeModule
49 56 from IPython.core.macro import Macro
50 from IPython.core import magic_arguments, page
51 57 from IPython.core.prefilter import ESC_MAGIC
58 from IPython.core.profiledir import ProfileDir
52 59 from IPython.testing.skipdoctest import skip_doctest
60 from IPython.utils import openpy
53 61 from IPython.utils import py3compat
54 62 from IPython.utils.encoding import DEFAULT_ENCODING
55 63 from IPython.utils.io import file_read, nlprint
64 from IPython.utils.ipstruct import Struct
56 65 from IPython.utils.module_paths import find_mod
57 66 from IPython.utils.path import get_py_filename, unquote_filename
58 67 from IPython.utils.process import arg_split, abbrev_cwd
59 68 from IPython.utils.terminal import set_term_title
60 69 from IPython.utils.text import format_screen
61 70 from IPython.utils.timing import clock, clock2
71 from IPython.utils.traitlets import Bool, Dict, Instance, Integer, List, Unicode
62 72 from IPython.utils.warn import warn, error
63 from IPython.utils.ipstruct import Struct
64 from IPython.config.application import Application
65 73
66 74 #-----------------------------------------------------------------------------
67 # Utility functions
75 # Utility classes and functions
68 76 #-----------------------------------------------------------------------------
69 77
78 class Bunch: pass
79
80
81 # Used for exception handling in magic_edit
82 class MacroToEdit(ValueError): pass
83
84
70 85 def on_off(tag):
71 86 """Return an ON/OFF string for a 1/0 input. Simple utility function."""
72 87 return ['OFF','ON'][tag]
73 88
74 class Bunch: pass
75 89
76 90 def compress_dhist(dh):
77 91 head, tail = dh[:-10], dh[-10:]
@@ -86,72 +100,28 b' def compress_dhist(dh):'
86 100
87 101 return newhead + tail
88 102
103
89 104 def needs_local_scope(func):
90 105 """Decorator to mark magic functions which need to local scope to run."""
91 106 func.needs_local_scope = True
92 107 return func
93 108
94
95 # Used for exception handling in magic_edit
96 class MacroToEdit(ValueError): pass
97
98 109 #***************************************************************************
99 # Main class implementing Magic functionality
100
101 # XXX - for some odd reason, if Magic is made a new-style class, we get errors
102 # on construction of the main InteractiveShell object. Something odd is going
103 # on with super() calls, Configurable and the MRO... For now leave it as-is, but
104 # eventually this needs to be clarified.
105 # BG: This is because InteractiveShell inherits from this, but is itself a
106 # Configurable. This messes up the MRO in some way. The fix is that we need to
107 # make Magic a configurable that InteractiveShell does not subclass.
108
109 class Magic(object):
110 """Magic functions for InteractiveShell.
111
112 Shell functions which can be reached as %function_name. All magic
113 functions should accept a string, which they can parse for their own
114 needs. This can make some functions easier to type, eg `%cd ../`
115 vs. `%cd("../")`
116
117 ALL definitions MUST begin with the prefix magic_. The user won't need it
118 at the command line, but it is is needed in the definition. """
119
120 # class globals
121 auto_status = ['Automagic is OFF, % prefix IS needed for magic functions.',
122 'Automagic is ON, % prefix NOT needed for magic functions.']
123
124
125 configurables = None
126
127 default_runner = None
128 #......................................................................
129 # some utility functions
130
131 def __init__(self, shell):
132 110
133 self.options_table = {}
134 if profile is None:
135 self.magic_prun = self.profile_missing_notice
136 self.shell = shell
137 if self.configurables is None:
138 self.configurables = []
111 class MagicManager(Configurable):
112 """Object that handles all magic-related functionality for IPython.
113 """
114 # An instance of the IPython shell we are attached to
115 shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
139 116
140 # namespace for holding state we may need
141 self._magic_state = Bunch()
117 auto_status = Enum([
118 'Automagic is OFF, % prefix IS needed for magic functions.',
119 'Automagic is ON, % prefix NOT needed for magic functions.'])
142 120
143 def profile_missing_notice(self, *args, **kwargs):
144 error("""\
145 The profile module could not be found. It has been removed from the standard
146 python packages because of its non-free license. To use profiling, install the
147 python-profiler package from non-free.""")
121 def __init__(self, shell=None, config=None, **traits):
148 122
149 def default_option(self,fn,optstr):
150 """Make an entry in the options_table for fn, with value optstr"""
123 super(MagicManager, self).__init__(shell=shell, config=config, **traits)
151 124
152 if fn not in self.lsmagic():
153 error("%s is not a magic function" % fn)
154 self.options_table[fn] = optstr
155 125
156 126 def lsmagic(self):
157 127 """Return a list of currently available magic functions.
@@ -179,6 +149,30 b' python-profiler package from non-free.""")'
179 149 out.sort()
180 150 return out
181 151
152
153 class MagicFunctions(object):
154 """Base class for implementing magic functions.
155
156 Shell functions which can be reached as %function_name. All magic
157 functions should accept a string, which they can parse for their own
158 needs. This can make some functions easier to type, eg `%cd ../`
159 vs. `%cd("../")`
160 """
161
162 options_table = Dict(config=True,
163 help = """Dict holding all command-line options for each magic.
164 """)
165
166 class __metaclass__(type):
167 def __new__(cls, name, bases, dct):
168 cls.registered = False
169 return type.__new__(cls, name, bases, dct)
170
171 def __init__(self, shell):
172 if not(self.__class__.registered):
173 raise ValueError('unregistered Magics')
174 self.shell = shell
175
182 176 def arg_err(self,func):
183 177 """Print docstring if incorrect arguments were passed"""
184 178 print 'Error in arguments:'
@@ -280,10 +274,20 b' python-profiler package from non-free.""")'
280 274
281 275 return opts,args
282 276
283 #......................................................................
284 # And now the actual magic functions
277 def default_option(self,fn,optstr):
278 """Make an entry in the options_table for fn, with value optstr"""
279
280 if fn not in self.lsmagic():
281 error("%s is not a magic function" % fn)
282 self.options_table[fn] = optstr
283
284
285 class BasicMagics(MagicFunctions):
286 """Magics that provide central IPython functionality.
287
288 These are various magics that don't fit into specific categories but that
289 are all part of the base 'IPython experience'."""
285 290
286 # Functions for IPython shell work (vars,funcs, config, etc)
287 291 def magic_lsmagic(self, parameter_s = ''):
288 292 """List currently available magic functions."""
289 293 mesc = ESC_MAGIC
@@ -383,99 +387,6 b' Currently the magic system has the following functions:\\n"""'
383 387 Magic.auto_status[self.shell.automagic] ) )
384 388 page.page(outmsg)
385 389
386 def magic_automagic(self, parameter_s = ''):
387 """Make magic functions callable without having to type the initial %.
388
389 Without argumentsl toggles on/off (when off, you must call it as
390 %automagic, of course). With arguments it sets the value, and you can
391 use any of (case insensitive):
392
393 - on,1,True: to activate
394
395 - off,0,False: to deactivate.
396
397 Note that magic functions have lowest priority, so if there's a
398 variable whose name collides with that of a magic fn, automagic won't
399 work for that function (you get the variable instead). However, if you
400 delete the variable (del var), the previously shadowed magic function
401 becomes visible to automagic again."""
402
403 arg = parameter_s.lower()
404 if parameter_s in ('on','1','true'):
405 self.shell.automagic = True
406 elif parameter_s in ('off','0','false'):
407 self.shell.automagic = False
408 else:
409 self.shell.automagic = not self.shell.automagic
410 print '\n' + Magic.auto_status[self.shell.automagic]
411
412 @skip_doctest
413 def magic_autocall(self, parameter_s = ''):
414 """Make functions callable without having to type parentheses.
415
416 Usage:
417
418 %autocall [mode]
419
420 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
421 value is toggled on and off (remembering the previous state).
422
423 In more detail, these values mean:
424
425 0 -> fully disabled
426
427 1 -> active, but do not apply if there are no arguments on the line.
428
429 In this mode, you get::
430
431 In [1]: callable
432 Out[1]: <built-in function callable>
433
434 In [2]: callable 'hello'
435 ------> callable('hello')
436 Out[2]: False
437
438 2 -> Active always. Even if no arguments are present, the callable
439 object is called::
440
441 In [2]: float
442 ------> float()
443 Out[2]: 0.0
444
445 Note that even with autocall off, you can still use '/' at the start of
446 a line to treat the first argument on the command line as a function
447 and add parentheses to it::
448
449 In [8]: /str 43
450 ------> str(43)
451 Out[8]: '43'
452
453 # all-random (note for auto-testing)
454 """
455
456 if parameter_s:
457 arg = int(parameter_s)
458 else:
459 arg = 'toggle'
460
461 if not arg in (0,1,2,'toggle'):
462 error('Valid modes: (0->Off, 1->Smart, 2->Full')
463 return
464
465 if arg in (0,1,2):
466 self.shell.autocall = arg
467 else: # toggle
468 if self.shell.autocall:
469 self._magic_state.autocall_save = self.shell.autocall
470 self.shell.autocall = 0
471 else:
472 try:
473 self.shell.autocall = self._magic_state.autocall_save
474 except AttributeError:
475 self.shell.autocall = self._magic_state.autocall_save = 1
476
477 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
478
479 390
480 391 def magic_page(self, parameter_s=''):
481 392 """Pretty print the object and display it through a pager.
@@ -510,2214 +421,2572 b' Currently the magic system has the following functions:\\n"""'
510 421 else:
511 422 error("profile is an application-level value, but you don't appear to be in an IPython application")
512 423
513 def magic_pinfo(self, parameter_s='', namespaces=None):
514 """Provide detailed information about an object.
515
516 '%pinfo object' is just a synonym for object? or ?object."""
517
518 #print 'pinfo par: <%s>' % parameter_s # dbg
519
520
521 # detail_level: 0 -> obj? , 1 -> obj??
522 detail_level = 0
523 # We need to detect if we got called as 'pinfo pinfo foo', which can
524 # happen if the user types 'pinfo foo?' at the cmd line.
525 pinfo,qmark1,oname,qmark2 = \
526 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
527 if pinfo or qmark1 or qmark2:
528 detail_level = 1
529 if "*" in oname:
530 self.magic_psearch(oname)
531 else:
532 self.shell._inspect('pinfo', oname, detail_level=detail_level,
533 namespaces=namespaces)
534
535 def magic_pinfo2(self, parameter_s='', namespaces=None):
536 """Provide extra detailed information about an object.
424 def magic_pprint(self, parameter_s=''):
425 """Toggle pretty printing on/off."""
426 ptformatter = self.shell.display_formatter.formatters['text/plain']
427 ptformatter.pprint = bool(1 - ptformatter.pprint)
428 print 'Pretty printing has been turned', \
429 ['OFF','ON'][ptformatter.pprint]
537 430
538 '%pinfo2 object' is just a synonym for object?? or ??object."""
539 self.shell._inspect('pinfo', parameter_s, detail_level=1,
540 namespaces=namespaces)
431 def magic_colors(self,parameter_s = ''):
432 """Switch color scheme for prompts, info system and exception handlers.
541 433
542 @skip_doctest
543 def magic_pdef(self, parameter_s='', namespaces=None):
544 """Print the definition header for any callable object.
434 Currently implemented schemes: NoColor, Linux, LightBG.
545 435
546 If the object is a class, print the constructor information.
436 Color scheme names are not case-sensitive.
547 437
548 438 Examples
549 439 --------
550 ::
440 To get a plain black and white terminal::
551 441
552 In [3]: %pdef urllib.urlopen
553 urllib.urlopen(url, data=None, proxies=None)
442 %colors nocolor
554 443 """
555 self._inspect('pdef',parameter_s, namespaces)
556 444
557 def magic_pdoc(self, parameter_s='', namespaces=None):
558 """Print the docstring for an object.
445 def color_switch_err(name):
446 warn('Error changing %s color schemes.\n%s' %
447 (name,sys.exc_info()[1]))
559 448
560 If the given object is a class, it will print both the class and the
561 constructor docstrings."""
562 self._inspect('pdoc',parameter_s, namespaces)
563 449
564 def magic_psource(self, parameter_s='', namespaces=None):
565 """Print (or run through pager) the source code for an object."""
566 self._inspect('psource',parameter_s, namespaces)
450 new_scheme = parameter_s.strip()
451 if not new_scheme:
452 raise UsageError(
453 "%colors: you must specify a color scheme. See '%colors?'")
454 return
455 # local shortcut
456 shell = self.shell
567 457
568 def magic_pfile(self, parameter_s=''):
569 """Print (or run through pager) the file where an object is defined.
458 import IPython.utils.rlineimpl as readline
570 459
571 The file opens at the line where the object definition begins. IPython
572 will honor the environment variable PAGER if set, and otherwise will
573 do its best to print the file in a convenient form.
460 if not shell.colors_force and \
461 not readline.have_readline and sys.platform == "win32":
462 msg = """\
463 Proper color support under MS Windows requires the pyreadline library.
464 You can find it at:
465 http://ipython.org/pyreadline.html
466 Gary's readline needs the ctypes module, from:
467 http://starship.python.net/crew/theller/ctypes
468 (Note that ctypes is already part of Python versions 2.5 and newer).
574 469
575 If the given argument is not an object currently defined, IPython will
576 try to interpret it as a filename (automatically adding a .py extension
577 if needed). You can thus use %pfile as a syntax highlighting code
578 viewer."""
579
580 # first interpret argument as an object name
581 out = self._inspect('pfile',parameter_s)
582 # if not, try the input as a filename
583 if out == 'not found':
584 try:
585 filename = get_py_filename(parameter_s)
586 except IOError,msg:
587 print msg
588 return
589 page.page(self.shell.inspector.format(open(filename).read()))
590
591 def magic_psearch(self, parameter_s=''):
592 """Search for object in namespaces by wildcard.
470 Defaulting color scheme to 'NoColor'"""
471 new_scheme = 'NoColor'
472 warn(msg)
593 473
594 %psearch [options] PATTERN [OBJECT TYPE]
474 # readline option is 0
475 if not shell.colors_force and not shell.has_readline:
476 new_scheme = 'NoColor'
595 477
596 Note: ? can be used as a synonym for %psearch, at the beginning or at
597 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
598 rest of the command line must be unchanged (options come first), so
599 for example the following forms are equivalent
478 # Set prompt colors
479 try:
480 shell.prompt_manager.color_scheme = new_scheme
481 except:
482 color_switch_err('prompt')
483 else:
484 shell.colors = \
485 shell.prompt_manager.color_scheme_table.active_scheme_name
486 # Set exception colors
487 try:
488 shell.InteractiveTB.set_colors(scheme = new_scheme)
489 shell.SyntaxTB.set_colors(scheme = new_scheme)
490 except:
491 color_switch_err('exception')
600 492
601 %psearch -i a* function
602 -i a* function?
603 ?-i a* function
493 # Set info (for 'object?') colors
494 if shell.color_info:
495 try:
496 shell.inspector.set_active_scheme(new_scheme)
497 except:
498 color_switch_err('object inspector')
499 else:
500 shell.inspector.set_active_scheme('NoColor')
604 501
605 Arguments:
502 def magic_xmode(self,parameter_s = ''):
503 """Switch modes for the exception handlers.
606 504
607 PATTERN
505 Valid modes: Plain, Context and Verbose.
608 506
609 where PATTERN is a string containing * as a wildcard similar to its
610 use in a shell. The pattern is matched in all namespaces on the
611 search path. By default objects starting with a single _ are not
612 matched, many IPython generated objects have a single
613 underscore. The default is case insensitive matching. Matching is
614 also done on the attributes of objects and not only on the objects
615 in a module.
507 If called without arguments, acts as a toggle."""
616 508
617 [OBJECT TYPE]
509 def xmode_switch_err(name):
510 warn('Error changing %s exception modes.\n%s' %
511 (name,sys.exc_info()[1]))
618 512
619 Is the name of a python type from the types module. The name is
620 given in lowercase without the ending type, ex. StringType is
621 written string. By adding a type here only objects matching the
622 given type are matched. Using all here makes the pattern match all
623 types (this is the default).
513 shell = self.shell
514 new_mode = parameter_s.strip().capitalize()
515 try:
516 shell.InteractiveTB.set_mode(mode=new_mode)
517 print 'Exception reporting mode:',shell.InteractiveTB.mode
518 except:
519 xmode_switch_err('user')
624 520
625 Options:
521 def magic_quickref(self,arg):
522 """ Show a quick reference sheet """
523 import IPython.core.usage
524 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
525 page.page(qr)
626 526
627 -a: makes the pattern match even objects whose names start with a
628 single underscore. These names are normally omitted from the
629 search.
527 def magic_doctest_mode(self,parameter_s=''):
528 """Toggle doctest mode on and off.
630 529
631 -i/-c: make the pattern case insensitive/sensitive. If neither of
632 these options are given, the default is read from your configuration
633 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
634 If this option is not specified in your configuration file, IPython's
635 internal default is to do a case sensitive search.
530 This mode is intended to make IPython behave as much as possible like a
531 plain Python shell, from the perspective of how its prompts, exceptions
532 and output look. This makes it easy to copy and paste parts of a
533 session into doctests. It does so by:
636 534
637 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
638 specify can be searched in any of the following namespaces:
639 'builtin', 'user', 'user_global','internal', 'alias', where
640 'builtin' and 'user' are the search defaults. Note that you should
641 not use quotes when specifying namespaces.
535 - Changing the prompts to the classic ``>>>`` ones.
536 - Changing the exception reporting mode to 'Plain'.
537 - Disabling pretty-printing of output.
642 538
643 'Builtin' contains the python module builtin, 'user' contains all
644 user data, 'alias' only contain the shell aliases and no python
645 objects, 'internal' contains objects used by IPython. The
646 'user_global' namespace is only used by embedded IPython instances,
647 and it contains module-level globals. You can add namespaces to the
648 search with -s or exclude them with -e (these options can be given
649 more than once).
539 Note that IPython also supports the pasting of code snippets that have
540 leading '>>>' and '...' prompts in them. This means that you can paste
541 doctests from files or docstrings (even if they have leading
542 whitespace), and the code will execute correctly. You can then use
543 '%history -t' to see the translated history; this will give you the
544 input after removal of all the leading prompts and whitespace, which
545 can be pasted back into an editor.
650 546
651 Examples
652 --------
653 ::
547 With these features, you can switch into this mode easily whenever you
548 need to do testing and changes to doctests, without having to leave
549 your existing IPython session.
550 """
654 551
655 %psearch a* -> objects beginning with an a
656 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
657 %psearch a* function -> all functions beginning with an a
658 %psearch re.e* -> objects beginning with an e in module re
659 %psearch r*.e* -> objects that start with e in modules starting in r
660 %psearch r*.* string -> all strings in modules beginning with r
552 from IPython.utils.ipstruct import Struct
661 553
662 Case sensitive search::
554 # Shorthands
555 shell = self.shell
556 pm = shell.prompt_manager
557 meta = shell.meta
558 disp_formatter = self.shell.display_formatter
559 ptformatter = disp_formatter.formatters['text/plain']
560 # dstore is a data store kept in the instance metadata bag to track any
561 # changes we make, so we can undo them later.
562 dstore = meta.setdefault('doctest_mode',Struct())
563 save_dstore = dstore.setdefault
663 564
664 %psearch -c a* list all object beginning with lower case a
565 # save a few values we'll need to recover later
566 mode = save_dstore('mode',False)
567 save_dstore('rc_pprint',ptformatter.pprint)
568 save_dstore('xmode',shell.InteractiveTB.mode)
569 save_dstore('rc_separate_out',shell.separate_out)
570 save_dstore('rc_separate_out2',shell.separate_out2)
571 save_dstore('rc_prompts_pad_left',pm.justify)
572 save_dstore('rc_separate_in',shell.separate_in)
573 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
574 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
665 575
666 Show objects beginning with a single _::
576 if mode == False:
577 # turn on
578 pm.in_template = '>>> '
579 pm.in2_template = '... '
580 pm.out_template = ''
667 581
668 %psearch -a _* list objects beginning with a single underscore"""
669 try:
670 parameter_s.encode('ascii')
671 except UnicodeEncodeError:
672 print 'Python identifiers can only contain ascii characters.'
673 return
582 # Prompt separators like plain python
583 shell.separate_in = ''
584 shell.separate_out = ''
585 shell.separate_out2 = ''
674 586
675 # default namespaces to be searched
676 def_search = ['user_local', 'user_global', 'builtin']
587 pm.justify = False
677 588
678 # Process options/args
679 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
680 opt = opts.get
681 shell = self.shell
682 psearch = shell.inspector.psearch
589 ptformatter.pprint = False
590 disp_formatter.plain_text_only = True
683 591
684 # select case options
685 if opts.has_key('i'):
686 ignore_case = True
687 elif opts.has_key('c'):
688 ignore_case = False
592 shell.magic('xmode Plain')
689 593 else:
690 ignore_case = not shell.wildcards_case_sensitive
594 # turn off
595 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
691 596
692 # Build list of namespaces to search from user options
693 def_search.extend(opt('s',[]))
694 ns_exclude = ns_exclude=opt('e',[])
695 ns_search = [nm for nm in def_search if nm not in ns_exclude]
597 shell.separate_in = dstore.rc_separate_in
696 598
697 # Call the actual search
698 try:
699 psearch(args,shell.ns_table,ns_search,
700 show_all=opt('a'),ignore_case=ignore_case)
701 except:
702 shell.showtraceback()
599 shell.separate_out = dstore.rc_separate_out
600 shell.separate_out2 = dstore.rc_separate_out2
703 601
704 @skip_doctest
705 def magic_who_ls(self, parameter_s=''):
706 """Return a sorted list of all interactive variables.
602 pm.justify = dstore.rc_prompts_pad_left
707 603
708 If arguments are given, only variables of types matching these
709 arguments are returned.
604 ptformatter.pprint = dstore.rc_pprint
605 disp_formatter.plain_text_only = dstore.rc_plain_text_only
710 606
711 Examples
712 --------
607 shell.magic('xmode ' + dstore.xmode)
713 608
714 Define two variables and list them with who_ls::
609 # Store new mode and inform
610 dstore.mode = bool(1-int(mode))
611 mode_label = ['OFF','ON'][dstore.mode]
612 print 'Doctest mode is:', mode_label
715 613
716 In [1]: alpha = 123
614 def magic_gui(self, parameter_s=''):
615 """Enable or disable IPython GUI event loop integration.
717 616
718 In [2]: beta = 'test'
617 %gui [GUINAME]
719 618
720 In [3]: %who_ls
721 Out[3]: ['alpha', 'beta']
619 This magic replaces IPython's threaded shells that were activated
620 using the (pylab/wthread/etc.) command line flags. GUI toolkits
621 can now be enabled at runtime and keyboard
622 interrupts should work without any problems. The following toolkits
623 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
722 624
723 In [4]: %who_ls int
724 Out[4]: ['alpha']
625 %gui wx # enable wxPython event loop integration
626 %gui qt4|qt # enable PyQt4 event loop integration
627 %gui gtk # enable PyGTK event loop integration
628 %gui gtk3 # enable Gtk3 event loop integration
629 %gui tk # enable Tk event loop integration
630 %gui OSX # enable Cocoa event loop integration
631 # (requires %matplotlib 1.1)
632 %gui # disable all event loop integration
725 633
726 In [5]: %who_ls str
727 Out[5]: ['beta']
634 WARNING: after any of these has been called you can simply create
635 an application object, but DO NOT start the event loop yourself, as
636 we have already handled that.
728 637 """
729
730 user_ns = self.shell.user_ns
731 user_ns_hidden = self.shell.user_ns_hidden
732 out = [ i for i in user_ns
733 if not i.startswith('_') \
734 and not i in user_ns_hidden ]
735
736 typelist = parameter_s.split()
737 if typelist:
738 typeset = set(typelist)
739 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
740
741 out.sort()
742 return out
638 opts, arg = self.parse_options(parameter_s, '')
639 if arg=='': arg = None
640 try:
641 return self.enable_gui(arg)
642 except Exception as e:
643 # print simple error message, rather than traceback if we can't
644 # hook up the GUI
645 error(str(e))
743 646
744 647 @skip_doctest
745 def magic_who(self, parameter_s=''):
746 """Print all interactive variables, with some minimal formatting.
648 def magic_precision(self, s=''):
649 """Set floating point precision for pretty printing.
747 650
748 If any arguments are given, only variables whose type matches one of
749 these are printed. For example::
651 Can set either integer precision or a format string.
750 652
751 %who function str
653 If numpy has been imported and precision is an int,
654 numpy display precision will also be set, via ``numpy.set_printoptions``.
752 655
753 will only list functions and strings, excluding all other types of
754 variables. To find the proper type names, simply use type(var) at a
755 command line to see how python prints type names. For example:
656 If no argument is given, defaults will be restored.
756 657
658 Examples
659 --------
757 660 ::
758 661
759 In [1]: type('hello')\\
760 Out[1]: <type 'str'>
662 In [1]: from math import pi
761 663
762 indicates that the type name for strings is 'str'.
664 In [2]: %precision 3
665 Out[2]: u'%.3f'
763 666
764 ``%who`` always excludes executed names loaded through your configuration
765 file and things which are internal to IPython.
667 In [3]: pi
668 Out[3]: 3.142
766 669
767 This is deliberate, as typically you may load many modules and the
768 purpose of %who is to show you only what you've manually defined.
670 In [4]: %precision %i
671 Out[4]: u'%i'
769 672
770 Examples
771 --------
673 In [5]: pi
674 Out[5]: 3
772 675
773 Define two variables and list them with who::
676 In [6]: %precision %e
677 Out[6]: u'%e'
774 678
775 In [1]: alpha = 123
679 In [7]: pi**10
680 Out[7]: 9.364805e+04
776 681
777 In [2]: beta = 'test'
682 In [8]: %precision
683 Out[8]: u'%r'
778 684
779 In [3]: %who
780 alpha beta
685 In [9]: pi**10
686 Out[9]: 93648.047476082982
687 """
688 ptformatter = self.shell.display_formatter.formatters['text/plain']
689 ptformatter.float_precision = s
690 return ptformatter.float_format
781 691
782 In [4]: %who int
783 alpha
692 @magic_arguments.magic_arguments()
693 @magic_arguments.argument(
694 '-e', '--export', action='store_true', default=False,
695 help='Export IPython history as a notebook. The filename argument '
696 'is used to specify the notebook name and format. For example '
697 'a filename of notebook.ipynb will result in a notebook name '
698 'of "notebook" and a format of "xml". Likewise using a ".json" '
699 'or ".py" file extension will write the notebook in the json '
700 'or py formats.'
701 )
702 @magic_arguments.argument(
703 '-f', '--format',
704 help='Convert an existing IPython notebook to a new format. This option '
705 'specifies the new format and can have the values: xml, json, py. '
706 'The target filename is chosen automatically based on the new '
707 'format. The filename argument gives the name of the source file.'
708 )
709 @magic_arguments.argument(
710 'filename', type=unicode,
711 help='Notebook name or filename'
712 )
713 def magic_notebook(self, s):
714 """Export and convert IPython notebooks.
784 715
785 In [5]: %who str
786 beta
716 This function can export the current IPython history to a notebook file
717 or can convert an existing notebook file into a different format. For
718 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
719 To export the history to "foo.py" do "%notebook -e foo.py". To convert
720 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
721 formats include (json/ipynb, py).
787 722 """
723 args = magic_arguments.parse_argstring(self.magic_notebook, s)
788 724
789 varlist = self.magic_who_ls(parameter_s)
790 if not varlist:
791 if parameter_s:
792 print 'No variables match your requested type.'
725 from IPython.nbformat import current
726 args.filename = unquote_filename(args.filename)
727 if args.export:
728 fname, name, format = current.parse_filename(args.filename)
729 cells = []
730 hist = list(self.shell.history_manager.get_range())
731 for session, prompt_number, input in hist[:-1]:
732 cells.append(current.new_code_cell(prompt_number=prompt_number,
733 input=input))
734 worksheet = current.new_worksheet(cells=cells)
735 nb = current.new_notebook(name=name,worksheets=[worksheet])
736 with io.open(fname, 'w', encoding='utf-8') as f:
737 current.write(nb, f, format);
738 elif args.format is not None:
739 old_fname, old_name, old_format = current.parse_filename(args.filename)
740 new_format = args.format
741 if new_format == u'xml':
742 raise ValueError('Notebooks cannot be written as xml.')
743 elif new_format == u'ipynb' or new_format == u'json':
744 new_fname = old_name + u'.ipynb'
745 new_format = u'json'
746 elif new_format == u'py':
747 new_fname = old_name + u'.py'
793 748 else:
794 print 'Interactive namespace is empty.'
795 return
749 raise ValueError('Invalid notebook format: %s' % new_format)
750 with io.open(old_fname, 'r', encoding='utf-8') as f:
751 nb = current.read(f, old_format)
752 with io.open(new_fname, 'w', encoding='utf-8') as f:
753 current.write(nb, f, new_format)
796 754
797 # if we have variables, move on...
798 count = 0
799 for i in varlist:
800 print i+'\t',
801 count += 1
802 if count > 8:
803 count = 0
804 print
805 print
806 755
807 @skip_doctest
808 def magic_whos(self, parameter_s=''):
809 """Like %who, but gives some extra information about each variable.
756 class CodeMagics(MagicFunctions):
757 """Magics related to code management (loading, saving, editing, ...)."""
810 758
811 The same type filtering of %who can be applied here.
759 def magic_save(self,parameter_s = ''):
760 """Save a set of lines or a macro to a given filename.
812 761
813 For all variables, the type is printed. Additionally it prints:
762 Usage:\\
763 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
814 764
815 - For {},[],(): their length.
765 Options:
816 766
817 - For numpy arrays, a summary with shape, number of
818 elements, typecode and size in memory.
767 -r: use 'raw' input. By default, the 'processed' history is used,
768 so that magics are loaded in their transformed version to valid
769 Python. If this option is given, the raw input as typed as the
770 command line is used instead.
819 771
820 - Everything else: a string representation, snipping their middle if
821 too long.
772 This function uses the same syntax as %history for input ranges,
773 then saves the lines to the filename you specify.
822 774
823 Examples
824 --------
775 It adds a '.py' extension to the file if you don't do so yourself, and
776 it asks for confirmation before overwriting existing files."""
825 777
826 Define two variables and list them with whos::
778 opts,args = self.parse_options(parameter_s,'r',mode='list')
779 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
780 if not fname.endswith('.py'):
781 fname += '.py'
782 if os.path.isfile(fname):
783 ans = raw_input('File `%s` exists. Overwrite (y/[N])? ' % fname)
784 if ans.lower() not in ['y','yes']:
785 print 'Operation cancelled.'
786 return
787 try:
788 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
789 except (TypeError, ValueError) as e:
790 print e.args[0]
791 return
792 with io.open(fname,'w', encoding="utf-8") as f:
793 f.write(u"# coding: utf-8\n")
794 f.write(py3compat.cast_unicode(cmds))
795 print 'The following commands were written to file `%s`:' % fname
796 print cmds
827 797
828 In [1]: alpha = 123
798 def magic_pastebin(self, parameter_s = ''):
799 """Upload code to Github's Gist paste bin, returning the URL.
829 800
830 In [2]: beta = 'test'
801 Usage:\\
802 %pastebin [-d "Custom description"] 1-7
831 803
832 In [3]: %whos
833 Variable Type Data/Info
834 --------------------------------
835 alpha int 123
836 beta str test
804 The argument can be an input history range, a filename, or the name of a
805 string or macro.
806
807 Options:
808
809 -d: Pass a custom description for the gist. The default will say
810 "Pasted from IPython".
837 811 """
812 opts, args = self.parse_options(parameter_s, 'd:')
838 813
839 varnames = self.magic_who_ls(parameter_s)
840 if not varnames:
841 if parameter_s:
842 print 'No variables match your requested type.'
843 else:
844 print 'Interactive namespace is empty.'
814 try:
815 code = self.shell.find_user_code(args)
816 except (ValueError, TypeError) as e:
817 print e.args[0]
845 818 return
846 819
847 # if we have variables, move on...
820 post_data = json.dumps({
821 "description": opts.get('d', "Pasted from IPython"),
822 "public": True,
823 "files": {
824 "file1.py": {
825 "content": code
826 }
827 }
828 }).encode('utf-8')
848 829
849 # for these types, show len() instead of data:
850 seq_types = ['dict', 'list', 'tuple']
830 response = urlopen("https://api.github.com/gists", post_data)
831 response_data = json.loads(response.read().decode('utf-8'))
832 return response_data['html_url']
851 833
852 # for numpy arrays, display summary info
853 ndarray_type = None
854 if 'numpy' in sys.modules:
855 try:
856 from numpy import ndarray
857 except ImportError:
858 pass
859 else:
860 ndarray_type = ndarray.__name__
834 def magic_loadpy(self, arg_s):
835 """Alias of `%load`
861 836
862 # Find all variable names and types so we can figure out column sizes
863 def get_vars(i):
864 return self.shell.user_ns[i]
837 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
838 extension. So it has been renamed simply into %load. You can look at
839 `%load`'s docstring for more info.
840 """
841 self.magic_load(arg_s)
865 842
866 # some types are well known and can be shorter
867 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
868 def type_name(v):
869 tn = type(v).__name__
870 return abbrevs.get(tn,tn)
843 def magic_load(self, arg_s):
844 """Load code into the current frontend.
871 845
872 varlist = map(get_vars,varnames)
846 Usage:\\
847 %load [options] source
873 848
874 typelist = []
875 for vv in varlist:
876 tt = type_name(vv)
849 where source can be a filename, URL, input history range or macro
877 850
878 if tt=='instance':
879 typelist.append( abbrevs.get(str(vv.__class__),
880 str(vv.__class__)))
881 else:
882 typelist.append(tt)
851 Options:
852 --------
853 -y : Don't ask confirmation for loading source above 200 000 characters.
883 854
884 # column labels and # of spaces as separator
885 varlabel = 'Variable'
886 typelabel = 'Type'
887 datalabel = 'Data/Info'
888 colsep = 3
889 # variable format strings
890 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
891 aformat = "%s: %s elems, type `%s`, %s bytes"
892 # find the size of the columns to format the output nicely
893 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
894 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
895 # table header
896 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
897 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
898 # and the table itself
899 kb = 1024
900 Mb = 1048576 # kb**2
901 for vname,var,vtype in zip(varnames,varlist,typelist):
902 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
903 if vtype in seq_types:
904 print "n="+str(len(var))
905 elif vtype == ndarray_type:
906 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
907 if vtype==ndarray_type:
908 # numpy
909 vsize = var.size
910 vbytes = vsize*var.itemsize
911 vdtype = var.dtype
855 This magic command can either take a local filename, a URL, an history
856 range (see %history) or a macro as argument, it will prompt for
857 confirmation before loading source with more than 200 000 characters, unless
858 -y flag is passed or if the frontend does not support raw_input::
912 859
913 if vbytes < 100000:
914 print aformat % (vshape,vsize,vdtype,vbytes)
915 else:
916 print aformat % (vshape,vsize,vdtype,vbytes),
917 if vbytes < Mb:
918 print '(%s kb)' % (vbytes/kb,)
919 else:
920 print '(%s Mb)' % (vbytes/Mb,)
921 else:
860 %load myscript.py
861 %load 7-27
862 %load myMacro
863 %load http://www.example.com/myscript.py
864 """
865 opts,args = self.parse_options(arg_s,'y')
866
867 contents = self.shell.find_user_code(args)
868 l = len(contents)
869
870 # 200 000 is ~ 2500 full 80 caracter lines
871 # so in average, more than 5000 lines
872 if l > 200000 and 'y' not in opts:
922 873 try:
923 vstr = str(var)
924 except UnicodeEncodeError:
925 vstr = unicode(var).encode(DEFAULT_ENCODING,
926 'backslashreplace')
927 except:
928 vstr = "<object with id %d (str() failed)>" % id(var)
929 vstr = vstr.replace('\n','\\n')
930 if len(vstr) < 50:
931 print vstr
932 else:
933 print vstr[:25] + "<...>" + vstr[-25:]
874 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
875 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
876 except StdinNotImplementedError:
877 #asume yes if raw input not implemented
878 ans = True
934 879
935 def magic_reset(self, parameter_s=''):
936 """Resets the namespace by removing all names defined by the user, if
937 called without arguments, or by removing some types of objects, such
938 as everything currently in IPython's In[] and Out[] containers (see
939 the parameters for details).
880 if ans is False :
881 print 'Operation cancelled.'
882 return
940 883
941 Parameters
942 ----------
943 -f : force reset without asking for confirmation.
884 self.set_next_input(contents)
944 885
945 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
946 References to objects may be kept. By default (without this option),
947 we do a 'hard' reset, giving you a new session and removing all
948 references to objects from the current session.
886 def _find_edit_target(self, args, opts, last_call):
887 """Utility method used by magic_edit to find what to edit."""
949 888
950 in : reset input history
889 def make_filename(arg):
890 "Make a filename from the given args"
891 arg = unquote_filename(arg)
892 try:
893 filename = get_py_filename(arg)
894 except IOError:
895 # If it ends with .py but doesn't already exist, assume we want
896 # a new file.
897 if arg.endswith('.py'):
898 filename = arg
899 else:
900 filename = None
901 return filename
951 902
952 out : reset output history
903 # Set a few locals from the options for convenience:
904 opts_prev = 'p' in opts
905 opts_raw = 'r' in opts
953 906
954 dhist : reset directory history
907 # custom exceptions
908 class DataIsObject(Exception): pass
955 909
956 array : reset only variables that are NumPy arrays
910 # Default line number value
911 lineno = opts.get('n',None)
957 912
958 See Also
959 --------
960 magic_reset_selective : invoked as ``%reset_selective``
913 if opts_prev:
914 args = '_%s' % last_call[0]
915 if not self.shell.user_ns.has_key(args):
916 args = last_call[1]
961 917
962 Examples
963 --------
964 ::
918 # use last_call to remember the state of the previous call, but don't
919 # let it be clobbered by successive '-p' calls.
920 try:
921 last_call[0] = self.shell.displayhook.prompt_count
922 if not opts_prev:
923 last_call[1] = args
924 except:
925 pass
965 926
966 In [6]: a = 1
927 # by default this is done with temp files, except when the given
928 # arg is a filename
929 use_temp = True
967 930
968 In [7]: a
969 Out[7]: 1
931 data = ''
970 932
971 In [8]: 'a' in _ip.user_ns
972 Out[8]: True
933 # First, see if the arguments should be a filename.
934 filename = make_filename(args)
935 if filename:
936 use_temp = False
937 elif args:
938 # Mode where user specifies ranges of lines, like in %macro.
939 data = self.shell.extract_input_lines(args, opts_raw)
940 if not data:
941 try:
942 # Load the parameter given as a variable. If not a string,
943 # process it as an object instead (below)
973 944
974 In [9]: %reset -f
945 #print '*** args',args,'type',type(args) # dbg
946 data = eval(args, self.shell.user_ns)
947 if not isinstance(data, basestring):
948 raise DataIsObject
975 949
976 In [1]: 'a' in _ip.user_ns
977 Out[1]: False
950 except (NameError,SyntaxError):
951 # given argument is not a variable, try as a filename
952 filename = make_filename(args)
953 if filename is None:
954 warn("Argument given (%s) can't be found as a variable "
955 "or as a filename." % args)
956 return
957 use_temp = False
978 958
979 In [2]: %reset -f in
980 Flushing input history
959 except DataIsObject:
960 # macros have a special edit function
961 if isinstance(data, Macro):
962 raise MacroToEdit(data)
981 963
982 In [3]: %reset -f dhist in
983 Flushing directory history
984 Flushing input history
964 # For objects, try to edit the file where they are defined
965 try:
966 filename = inspect.getabsfile(data)
967 if 'fakemodule' in filename.lower() and inspect.isclass(data):
968 # class created by %edit? Try to find source
969 # by looking for method definitions instead, the
970 # __module__ in those classes is FakeModule.
971 attrs = [getattr(data, aname) for aname in dir(data)]
972 for attr in attrs:
973 if not inspect.ismethod(attr):
974 continue
975 filename = inspect.getabsfile(attr)
976 if filename and 'fakemodule' not in filename.lower():
977 # change the attribute to be the edit target instead
978 data = attr
979 break
985 980
986 Notes
987 -----
988 Calling this magic from clients that do not implement standard input,
989 such as the ipython notebook interface, will reset the namespace
990 without confirmation.
991 """
992 opts, args = self.parse_options(parameter_s,'sf', mode='list')
993 if 'f' in opts:
994 ans = True
995 else:
981 datafile = 1
982 except TypeError:
983 filename = make_filename(args)
984 datafile = 1
985 warn('Could not find file where `%s` is defined.\n'
986 'Opening a file named `%s`' % (args,filename))
987 # Now, make sure we can actually read the source (if it was in
988 # a temp file it's gone by now).
989 if datafile:
996 990 try:
997 ans = self.shell.ask_yes_no(
998 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
999 except StdinNotImplementedError:
1000 ans = True
1001 if not ans:
1002 print 'Nothing done.'
991 if lineno is None:
992 lineno = inspect.getsourcelines(data)[1]
993 except IOError:
994 filename = make_filename(args)
995 if filename is None:
996 warn('The file `%s` where `%s` was defined cannot '
997 'be read.' % (filename,data))
1003 998 return
999 use_temp = False
1004 1000
1005 if 's' in opts: # Soft reset
1006 user_ns = self.shell.user_ns
1007 for i in self.magic_who_ls():
1008 del(user_ns[i])
1009 elif len(args) == 0: # Hard reset
1010 self.shell.reset(new_session = False)
1011
1012 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1013 ip = self.shell
1014 user_ns = self.shell.user_ns # local lookup, heavily used
1001 if use_temp:
1002 filename = self.shell.mktempfile(data)
1003 print 'IPython will make a temporary file named:',filename
1015 1004
1016 for target in args:
1017 target = target.lower() # make matches case insensitive
1018 if target == 'out':
1019 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1020 self.shell.displayhook.flush()
1005 return filename, lineno, use_temp
1021 1006
1022 elif target == 'in':
1023 print "Flushing input history"
1024 pc = self.shell.displayhook.prompt_count + 1
1025 for n in range(1, pc):
1026 key = '_i'+repr(n)
1027 user_ns.pop(key,None)
1028 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1029 hm = ip.history_manager
1030 # don't delete these, as %save and %macro depending on the length
1031 # of these lists to be preserved
1032 hm.input_hist_parsed[:] = [''] * pc
1033 hm.input_hist_raw[:] = [''] * pc
1034 # hm has internal machinery for _i,_ii,_iii, clear it out
1035 hm._i = hm._ii = hm._iii = hm._i00 = u''
1007 def _edit_macro(self,mname,macro):
1008 """open an editor with the macro data in a file"""
1009 filename = self.shell.mktempfile(macro.value)
1010 self.shell.hooks.editor(filename)
1036 1011
1037 elif target == 'array':
1038 # Support cleaning up numpy arrays
1039 try:
1040 from numpy import ndarray
1041 # This must be done with items and not iteritems because we're
1042 # going to modify the dict in-place.
1043 for x,val in user_ns.items():
1044 if isinstance(val,ndarray):
1045 del user_ns[x]
1046 except ImportError:
1047 print "reset array only works if Numpy is available."
1012 # and make a new macro object, to replace the old one
1013 mfile = open(filename)
1014 mvalue = mfile.read()
1015 mfile.close()
1016 self.shell.user_ns[mname] = Macro(mvalue)
1048 1017
1049 elif target == 'dhist':
1050 print "Flushing directory history"
1051 del user_ns['_dh'][:]
1018 def magic_ed(self,parameter_s=''):
1019 """Alias to %edit."""
1020 return self.magic_edit(parameter_s)
1052 1021
1053 else:
1054 print "Don't know how to reset ",
1055 print target + ", please run `%reset?` for details"
1022 @skip_doctest
1023 def magic_edit(self,parameter_s='',last_call=['','']):
1024 """Bring up an editor and execute the resulting code.
1056 1025
1057 gc.collect()
1026 Usage:
1027 %edit [options] [args]
1058 1028
1059 def magic_reset_selective(self, parameter_s=''):
1060 """Resets the namespace by removing names defined by the user.
1029 %edit runs IPython's editor hook. The default version of this hook is
1030 set to call the editor specified by your $EDITOR environment variable.
1031 If this isn't found, it will default to vi under Linux/Unix and to
1032 notepad under Windows. See the end of this docstring for how to change
1033 the editor hook.
1061 1034
1062 Input/Output history are left around in case you need them.
1035 You can also set the value of this editor via the
1036 ``TerminalInteractiveShell.editor`` option in your configuration file.
1037 This is useful if you wish to use a different editor from your typical
1038 default with IPython (and for Windows users who typically don't set
1039 environment variables).
1063 1040
1064 %reset_selective [-f] regex
1041 This command allows you to conveniently edit multi-line code right in
1042 your IPython session.
1065 1043
1066 No action is taken if regex is not included
1044 If called without arguments, %edit opens up an empty editor with a
1045 temporary file and will execute the contents of this file when you
1046 close it (don't forget to save it!).
1067 1047
1068 Options
1069 -f : force reset without asking for confirmation.
1070 1048
1071 See Also
1072 --------
1073 magic_reset : invoked as ``%reset``
1049 Options:
1074 1050
1075 Examples
1076 --------
1051 -n <number>: open the editor at a specified line number. By default,
1052 the IPython editor hook uses the unix syntax 'editor +N filename', but
1053 you can configure this by providing your own modified hook if your
1054 favorite editor supports line-number specifications with a different
1055 syntax.
1077 1056
1078 We first fully reset the namespace so your output looks identical to
1079 this example for pedagogical reasons; in practice you do not need a
1080 full reset::
1057 -p: this will call the editor with the same data as the previous time
1058 it was used, regardless of how long ago (in your current session) it
1059 was.
1081 1060
1082 In [1]: %reset -f
1061 -r: use 'raw' input. This option only applies to input taken from the
1062 user's history. By default, the 'processed' history is used, so that
1063 magics are loaded in their transformed version to valid Python. If
1064 this option is given, the raw input as typed as the command line is
1065 used instead. When you exit the editor, it will be executed by
1066 IPython's own processor.
1083 1067
1084 Now, with a clean namespace we can make a few variables and use
1085 ``%reset_selective`` to only delete names that match our regexp::
1068 -x: do not execute the edited code immediately upon exit. This is
1069 mainly useful if you are editing programs which need to be called with
1070 command line arguments, which you can then do using %run.
1086 1071
1087 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1088 1072
1089 In [3]: who_ls
1090 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1073 Arguments:
1091 1074
1092 In [4]: %reset_selective -f b[2-3]m
1075 If arguments are given, the following possibilities exist:
1093 1076
1094 In [5]: who_ls
1095 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1077 - If the argument is a filename, IPython will load that into the
1078 editor. It will execute its contents with execfile() when you exit,
1079 loading any code in the file into your interactive namespace.
1096 1080
1097 In [6]: %reset_selective -f d
1081 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
1082 The syntax is the same as in the %history magic.
1098 1083
1099 In [7]: who_ls
1100 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1084 - If the argument is a string variable, its contents are loaded
1085 into the editor. You can thus edit any string which contains
1086 python code (including the result of previous edits).
1101 1087
1102 In [8]: %reset_selective -f c
1088 - If the argument is the name of an object (other than a string),
1089 IPython will try to locate the file where it was defined and open the
1090 editor at the point where it is defined. You can use `%edit function`
1091 to load an editor exactly at the point where 'function' is defined,
1092 edit it and have the file be executed automatically.
1103 1093
1104 In [9]: who_ls
1105 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1094 - If the object is a macro (see %macro for details), this opens up your
1095 specified editor with a temporary file containing the macro's data.
1096 Upon exit, the macro is reloaded with the contents of the file.
1106 1097
1107 In [10]: %reset_selective -f b
1098 Note: opening at an exact line is only supported under Unix, and some
1099 editors (like kedit and gedit up to Gnome 2.8) do not understand the
1100 '+NUMBER' parameter necessary for this feature. Good editors like
1101 (X)Emacs, vi, jed, pico and joe all do.
1108 1102
1109 In [11]: who_ls
1110 Out[11]: ['a']
1103 After executing your code, %edit will return as output the code you
1104 typed in the editor (except when it was an existing file). This way
1105 you can reload the code in further invocations of %edit as a variable,
1106 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
1107 the output.
1111 1108
1112 Notes
1113 -----
1114 Calling this magic from clients that do not implement standard input,
1115 such as the ipython notebook interface, will reset the namespace
1116 without confirmation.
1117 """
1109 Note that %edit is also available through the alias %ed.
1118 1110
1119 opts, regex = self.parse_options(parameter_s,'f')
1111 This is an example of creating a simple function inside the editor and
1112 then modifying it. First, start up the editor::
1120 1113
1121 if opts.has_key('f'):
1122 ans = True
1123 else:
1124 try:
1125 ans = self.shell.ask_yes_no(
1126 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1127 default='n')
1128 except StdinNotImplementedError:
1129 ans = True
1130 if not ans:
1131 print 'Nothing done.'
1132 return
1133 user_ns = self.shell.user_ns
1134 if not regex:
1135 print 'No regex pattern specified. Nothing done.'
1136 return
1137 else:
1138 try:
1139 m = re.compile(regex)
1140 except TypeError:
1141 raise TypeError('regex must be a string or compiled pattern')
1142 for i in self.magic_who_ls():
1143 if m.search(i):
1144 del(user_ns[i])
1114 In [1]: ed
1115 Editing... done. Executing edited code...
1116 Out[1]: 'def foo():\\n print "foo() was defined in an editing
1117 session"\\n'
1145 1118
1146 def magic_xdel(self, parameter_s=''):
1147 """Delete a variable, trying to clear it from anywhere that
1148 IPython's machinery has references to it. By default, this uses
1149 the identity of the named object in the user namespace to remove
1150 references held under other names. The object is also removed
1151 from the output history.
1119 We can then call the function foo()::
1152 1120
1153 Options
1154 -n : Delete the specified name from all namespaces, without
1155 checking their identity.
1156 """
1157 opts, varname = self.parse_options(parameter_s,'n')
1158 try:
1159 self.shell.del_var(varname, ('n' in opts))
1160 except (NameError, ValueError) as e:
1161 print type(e).__name__ +": "+ str(e)
1121 In [2]: foo()
1122 foo() was defined in an editing session
1162 1123
1163 def magic_logstart(self,parameter_s=''):
1164 """Start logging anywhere in a session.
1124 Now we edit foo. IPython automatically loads the editor with the
1125 (temporary) file where foo() was previously defined::
1165 1126
1166 %logstart [-o|-r|-t] [log_name [log_mode]]
1127 In [3]: ed foo
1128 Editing... done. Executing edited code...
1167 1129
1168 If no name is given, it defaults to a file named 'ipython_log.py' in your
1169 current directory, in 'rotate' mode (see below).
1130 And if we call foo() again we get the modified version::
1170 1131
1171 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
1172 history up to that point and then continues logging.
1132 In [4]: foo()
1133 foo() has now been changed!
1173 1134
1174 %logstart takes a second optional parameter: logging mode. This can be one
1175 of (note that the modes are given unquoted):\\
1176 append: well, that says it.\\
1177 backup: rename (if exists) to name~ and start name.\\
1178 global: single logfile in your home dir, appended to.\\
1179 over : overwrite existing log.\\
1180 rotate: create rotating logs name.1~, name.2~, etc.
1135 Here is an example of how to edit a code snippet successive
1136 times. First we call the editor::
1181 1137
1182 Options:
1138 In [5]: ed
1139 Editing... done. Executing edited code...
1140 hello
1141 Out[5]: "print 'hello'\\n"
1183 1142
1184 -o: log also IPython's output. In this mode, all commands which
1185 generate an Out[NN] prompt are recorded to the logfile, right after
1186 their corresponding input line. The output lines are always
1187 prepended with a '#[Out]# ' marker, so that the log remains valid
1188 Python code.
1143 Now we call it again with the previous output (stored in _)::
1189 1144
1190 Since this marker is always the same, filtering only the output from
1191 a log is very easy, using for example a simple awk call::
1145 In [6]: ed _
1146 Editing... done. Executing edited code...
1147 hello world
1148 Out[6]: "print 'hello world'\\n"
1192 1149
1193 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
1150 Now we call it with the output #8 (stored in _8, also as Out[8])::
1194 1151
1195 -r: log 'raw' input. Normally, IPython's logs contain the processed
1196 input, so that user lines are logged in their final form, converted
1197 into valid Python. For example, %Exit is logged as
1198 _ip.magic("Exit"). If the -r flag is given, all input is logged
1199 exactly as typed, with no transformations applied.
1152 In [7]: ed _8
1153 Editing... done. Executing edited code...
1154 hello again
1155 Out[7]: "print 'hello again'\\n"
1200 1156
1201 -t: put timestamps before each input line logged (these are put in
1202 comments)."""
1203 1157
1204 opts,par = self.parse_options(parameter_s,'ort')
1205 log_output = 'o' in opts
1206 log_raw_input = 'r' in opts
1207 timestamp = 't' in opts
1158 Changing the default editor hook:
1208 1159
1209 logger = self.shell.logger
1160 If you wish to write your own editor hook, you can put it in a
1161 configuration file which you load at startup time. The default hook
1162 is defined in the IPython.core.hooks module, and you can use that as a
1163 starting example for further modifications. That file also has
1164 general instructions on how to set a new hook for use once you've
1165 defined it."""
1166 opts,args = self.parse_options(parameter_s,'prxn:')
1210 1167
1211 # if no args are given, the defaults set in the logger constructor by
1212 # ipython remain valid
1213 if par:
1214 1168 try:
1215 logfname,logmode = par.split()
1216 except:
1217 logfname = par
1218 logmode = 'backup'
1219 else:
1220 logfname = logger.logfname
1221 logmode = logger.logmode
1222 # put logfname into rc struct as if it had been called on the command
1223 # line, so it ends up saved in the log header Save it in case we need
1224 # to restore it...
1225 old_logfile = self.shell.logfile
1226 if logfname:
1227 logfname = os.path.expanduser(logfname)
1228 self.shell.logfile = logfname
1169 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
1170 except MacroToEdit as e:
1171 self._edit_macro(args, e.args[0])
1172 return
1229 1173
1230 loghead = '# IPython log file\n\n'
1174 # do actual editing here
1175 print 'Editing...',
1176 sys.stdout.flush()
1231 1177 try:
1232 started = logger.logstart(logfname,loghead,logmode,
1233 log_output,timestamp,log_raw_input)
1234 except:
1235 self.shell.logfile = old_logfile
1236 warn("Couldn't start log: %s" % sys.exc_info()[1])
1237 else:
1238 # log input history up to this point, optionally interleaving
1239 # output if requested
1178 # Quote filenames that may have spaces in them
1179 if ' ' in filename:
1180 filename = "'%s'" % filename
1181 self.shell.hooks.editor(filename,lineno)
1182 except TryNext:
1183 warn('Could not open editor')
1184 return
1240 1185
1241 if timestamp:
1242 # disable timestamping for the previous history, since we've
1243 # lost those already (no time machine here).
1244 logger.timestamp = False
1186 # XXX TODO: should this be generalized for all string vars?
1187 # For now, this is special-cased to blocks created by cpaste
1188 if args.strip() == 'pasted_block':
1189 self.shell.user_ns['pasted_block'] = file_read(filename)
1245 1190
1246 if log_raw_input:
1247 input_hist = self.shell.history_manager.input_hist_raw
1191 if 'x' in opts: # -x prevents actual execution
1192 print
1248 1193 else:
1249 input_hist = self.shell.history_manager.input_hist_parsed
1250
1251 if log_output:
1252 log_write = logger.log_write
1253 output_hist = self.shell.history_manager.output_hist
1254 for n in range(1,len(input_hist)-1):
1255 log_write(input_hist[n].rstrip() + '\n')
1256 if n in output_hist:
1257 log_write(repr(output_hist[n]),'output')
1194 print 'done. Executing edited code...'
1195 if 'r' in opts: # Untranslated IPython code
1196 self.shell.run_cell(file_read(filename),
1197 store_history=False)
1258 1198 else:
1259 logger.log_write('\n'.join(input_hist[1:]))
1260 logger.log_write('\n')
1261 if timestamp:
1262 # re-enable timestamping
1263 logger.timestamp = True
1264
1265 print ('Activating auto-logging. '
1266 'Current session state plus future input saved.')
1267 logger.logstate()
1199 self.shell.safe_execfile(filename, self.shell.user_ns,
1200 self.shell.user_ns)
1268 1201
1269 def magic_logstop(self,parameter_s=''):
1270 """Fully stop logging and close log file.
1202 if is_temp:
1203 try:
1204 return open(filename).read()
1205 except IOError,msg:
1206 if msg.filename == filename:
1207 warn('File not found. Did you forget to save?')
1208 return
1209 else:
1210 self.shell.showtraceback()
1271 1211
1272 In order to start logging again, a new %logstart call needs to be made,
1273 possibly (though not necessarily) with a new filename, mode and other
1274 options."""
1275 self.logger.logstop()
1276 1212
1277 def magic_logoff(self,parameter_s=''):
1278 """Temporarily stop logging.
1213 class ConfigMagics(MagicFunctions):
1279 1214
1280 You must have previously started logging."""
1281 self.shell.logger.switch_log(0)
1215 def __init__(self, shell):
1216 super(ProfileMagics, self).__init__(shell)
1217 self.configurables = []
1282 1218
1283 def magic_logon(self,parameter_s=''):
1284 """Restart logging.
1219 def magic_config(self, s):
1220 """configure IPython
1285 1221
1286 This function is for restarting logging which you've temporarily
1287 stopped with %logoff. For starting logging for the first time, you
1288 must use the %logstart function, which allows you to specify an
1289 optional log filename."""
1222 %config Class[.trait=value]
1290 1223
1291 self.shell.logger.switch_log(1)
1224 This magic exposes most of the IPython config system. Any
1225 Configurable class should be able to be configured with the simple
1226 line::
1292 1227
1293 def magic_logstate(self,parameter_s=''):
1294 """Print the status of the logging system."""
1228 %config Class.trait=value
1295 1229
1296 self.shell.logger.logstate()
1230 Where `value` will be resolved in the user's namespace, if it is an
1231 expression or variable name.
1297 1232
1298 def magic_pdb(self, parameter_s=''):
1299 """Control the automatic calling of the pdb interactive debugger.
1233 Examples
1234 --------
1300 1235
1301 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
1302 argument it works as a toggle.
1236 To see what classes are available for config, pass no arguments::
1303 1237
1304 When an exception is triggered, IPython can optionally call the
1305 interactive pdb debugger after the traceback printout. %pdb toggles
1306 this feature on and off.
1238 In [1]: %config
1239 Available objects for config:
1240 TerminalInteractiveShell
1241 HistoryManager
1242 PrefilterManager
1243 AliasManager
1244 IPCompleter
1245 PromptManager
1246 DisplayFormatter
1307 1247
1308 The initial state of this feature is set in your configuration
1309 file (the option is ``InteractiveShell.pdb``).
1248 To view what is configurable on a given class, just pass the class
1249 name::
1310 1250
1311 If you want to just activate the debugger AFTER an exception has fired,
1312 without having to type '%pdb on' and rerunning your code, you can use
1313 the %debug magic."""
1251 In [2]: %config IPCompleter
1252 IPCompleter options
1253 -----------------
1254 IPCompleter.omit__names=<Enum>
1255 Current: 2
1256 Choices: (0, 1, 2)
1257 Instruct the completer to omit private method names
1258 Specifically, when completing on ``object.<tab>``.
1259 When 2 [default]: all names that start with '_' will be excluded.
1260 When 1: all 'magic' names (``__foo__``) will be excluded.
1261 When 0: nothing will be excluded.
1262 IPCompleter.merge_completions=<CBool>
1263 Current: True
1264 Whether to merge completion results into a single list
1265 If False, only the completion results from the first non-empty completer
1266 will be returned.
1267 IPCompleter.limit_to__all__=<CBool>
1268 Current: False
1269 Instruct the completer to use __all__ for the completion
1270 Specifically, when completing on ``object.<tab>``.
1271 When True: only those names in obj.__all__ will be included.
1272 When False [default]: the __all__ attribute is ignored
1273 IPCompleter.greedy=<CBool>
1274 Current: False
1275 Activate greedy completion
1276 This will enable completion on elements of lists, results of function calls,
1277 etc., but can be unsafe because the code is actually evaluated on TAB.
1314 1278
1315 par = parameter_s.strip().lower()
1279 but the real use is in setting values::
1316 1280
1317 if par:
1318 try:
1319 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
1320 except KeyError:
1321 print ('Incorrect argument. Use on/1, off/0, '
1322 'or nothing for a toggle.')
1323 return
1324 else:
1325 # toggle
1326 new_pdb = not self.shell.call_pdb
1281 In [3]: %config IPCompleter.greedy = True
1327 1282
1328 # set on the shell
1329 self.shell.call_pdb = new_pdb
1330 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1283 and these values are read from the user_ns if they are variables::
1331 1284
1332 def magic_debug(self, parameter_s=''):
1333 """Activate the interactive debugger in post-mortem mode.
1285 In [4]: feeling_greedy=False
1334 1286
1335 If an exception has just occurred, this lets you inspect its stack
1336 frames interactively. Note that this will always work only on the last
1337 traceback that occurred, so you must call this quickly after an
1338 exception that you wish to inspect has fired, because if another one
1339 occurs, it clobbers the previous one.
1287 In [5]: %config IPCompleter.greedy = feeling_greedy
1340 1288
1341 If you want IPython to automatically do this on every exception, see
1342 the %pdb magic for more details.
1343 1289 """
1344 self.shell.debugger(force=True)
1290 from IPython.config.loader import Config
1291 # some IPython objects are Configurable, but do not yet have
1292 # any configurable traits. Exclude them from the effects of
1293 # this magic, as their presence is just noise:
1294 configurables = [ c for c in self.shell.configurables
1295 if c.__class__.class_traits(config=True) ]
1296 classnames = [ c.__class__.__name__ for c in configurables ]
1345 1297
1346 @skip_doctest
1347 def magic_prun(self, parameter_s ='',user_mode=1,
1348 opts=None,arg_lst=None,prog_ns=None):
1298 line = s.strip()
1299 if not line:
1300 # print available configurable names
1301 print "Available objects for config:"
1302 for name in classnames:
1303 print " ", name
1304 return
1305 elif line in classnames:
1306 # `%config TerminalInteractiveShell` will print trait info for
1307 # TerminalInteractiveShell
1308 c = configurables[classnames.index(line)]
1309 cls = c.__class__
1310 help = cls.class_get_help(c)
1311 # strip leading '--' from cl-args:
1312 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
1313 print help
1314 return
1315 elif '=' not in line:
1316 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
1349 1317
1350 """Run a statement through the python code profiler.
1351 1318
1352 Usage:
1353 %prun [options] statement
1319 # otherwise, assume we are setting configurables.
1320 # leave quotes on args when splitting, because we want
1321 # unquoted args to eval in user_ns
1322 cfg = Config()
1323 exec "cfg."+line in locals(), self.shell.user_ns
1354 1324
1355 The given statement (which doesn't require quote marks) is run via the
1356 python profiler in a manner similar to the profile.run() function.
1357 Namespaces are internally managed to work correctly; profile.run
1358 cannot be used in IPython because it makes certain assumptions about
1359 namespaces which do not hold under IPython.
1325 for configurable in configurables:
1326 try:
1327 configurable.update_config(cfg)
1328 except Exception as e:
1329 error(e)
1360 1330
1361 Options:
1362 1331
1363 -l <limit>: you can place restrictions on what or how much of the
1364 profile gets printed. The limit value can be:
1332 class NamespaceMagics(MagicFunctions):
1333 """Magics to manage various aspects of the user's namespace.
1365 1334
1366 * A string: only information for function names containing this string
1367 is printed.
1335 These include listing variables, introspecting into them, etc.
1336 """
1368 1337
1369 * An integer: only these many lines are printed.
1338 def magic_pinfo(self, parameter_s='', namespaces=None):
1339 """Provide detailed information about an object.
1370 1340
1371 * A float (between 0 and 1): this fraction of the report is printed
1372 (for example, use a limit of 0.4 to see the topmost 40% only).
1341 '%pinfo object' is just a synonym for object? or ?object."""
1373 1342
1374 You can combine several limits with repeated use of the option. For
1375 example, '-l __init__ -l 5' will print only the topmost 5 lines of
1376 information about class constructors.
1343 #print 'pinfo par: <%s>' % parameter_s # dbg
1377 1344
1378 -r: return the pstats.Stats object generated by the profiling. This
1379 object has all the information about the profile in it, and you can
1380 later use it for further analysis or in other functions.
1381 1345
1382 -s <key>: sort profile by given key. You can provide more than one key
1383 by using the option several times: '-s key1 -s key2 -s key3...'. The
1384 default sorting key is 'time'.
1346 # detail_level: 0 -> obj? , 1 -> obj??
1347 detail_level = 0
1348 # We need to detect if we got called as 'pinfo pinfo foo', which can
1349 # happen if the user types 'pinfo foo?' at the cmd line.
1350 pinfo,qmark1,oname,qmark2 = \
1351 re.match('(pinfo )?(\?*)(.*?)(\??$)',parameter_s).groups()
1352 if pinfo or qmark1 or qmark2:
1353 detail_level = 1
1354 if "*" in oname:
1355 self.magic_psearch(oname)
1356 else:
1357 self.shell._inspect('pinfo', oname, detail_level=detail_level,
1358 namespaces=namespaces)
1385 1359
1386 The following is copied verbatim from the profile documentation
1387 referenced below:
1360 def magic_pinfo2(self, parameter_s='', namespaces=None):
1361 """Provide extra detailed information about an object.
1388 1362
1389 When more than one key is provided, additional keys are used as
1390 secondary criteria when the there is equality in all keys selected
1391 before them.
1363 '%pinfo2 object' is just a synonym for object?? or ??object."""
1364 self.shell._inspect('pinfo', parameter_s, detail_level=1,
1365 namespaces=namespaces)
1392 1366
1393 Abbreviations can be used for any key names, as long as the
1394 abbreviation is unambiguous. The following are the keys currently
1395 defined:
1367 @skip_doctest
1368 def magic_pdef(self, parameter_s='', namespaces=None):
1369 """Print the definition header for any callable object.
1396 1370
1397 Valid Arg Meaning
1398 "calls" call count
1399 "cumulative" cumulative time
1400 "file" file name
1401 "module" file name
1402 "pcalls" primitive call count
1403 "line" line number
1404 "name" function name
1405 "nfl" name/file/line
1406 "stdname" standard name
1407 "time" internal time
1371 If the object is a class, print the constructor information.
1408 1372
1409 Note that all sorts on statistics are in descending order (placing
1410 most time consuming items first), where as name, file, and line number
1411 searches are in ascending order (i.e., alphabetical). The subtle
1412 distinction between "nfl" and "stdname" is that the standard name is a
1413 sort of the name as printed, which means that the embedded line
1414 numbers get compared in an odd way. For example, lines 3, 20, and 40
1415 would (if the file names were the same) appear in the string order
1416 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
1417 line numbers. In fact, sort_stats("nfl") is the same as
1418 sort_stats("name", "file", "line").
1373 Examples
1374 --------
1375 ::
1419 1376
1420 -T <filename>: save profile results as shown on screen to a text
1421 file. The profile is still shown on screen.
1377 In [3]: %pdef urllib.urlopen
1378 urllib.urlopen(url, data=None, proxies=None)
1379 """
1380 self._inspect('pdef',parameter_s, namespaces)
1422 1381
1423 -D <filename>: save (via dump_stats) profile statistics to given
1424 filename. This data is in a format understood by the pstats module, and
1425 is generated by a call to the dump_stats() method of profile
1426 objects. The profile is still shown on screen.
1382 def magic_pdoc(self, parameter_s='', namespaces=None):
1383 """Print the docstring for an object.
1427 1384
1428 -q: suppress output to the pager. Best used with -T and/or -D above.
1385 If the given object is a class, it will print both the class and the
1386 constructor docstrings."""
1387 self._inspect('pdoc',parameter_s, namespaces)
1429 1388
1430 If you want to run complete programs under the profiler's control, use
1431 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
1432 contains profiler specific options as described here.
1389 def magic_psource(self, parameter_s='', namespaces=None):
1390 """Print (or run through pager) the source code for an object."""
1391 self._inspect('psource',parameter_s, namespaces)
1433 1392
1434 You can read the complete documentation for the profile module with::
1393 def magic_pfile(self, parameter_s=''):
1394 """Print (or run through pager) the file where an object is defined.
1435 1395
1436 In [1]: import profile; profile.help()
1437 """
1396 The file opens at the line where the object definition begins. IPython
1397 will honor the environment variable PAGER if set, and otherwise will
1398 do its best to print the file in a convenient form.
1438 1399
1439 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
1400 If the given argument is not an object currently defined, IPython will
1401 try to interpret it as a filename (automatically adding a .py extension
1402 if needed). You can thus use %pfile as a syntax highlighting code
1403 viewer."""
1440 1404
1441 if user_mode: # regular user call
1442 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
1443 list_all=1, posix=False)
1444 namespace = self.shell.user_ns
1445 else: # called to run a program by %run -p
1446 try:
1447 filename = get_py_filename(arg_lst[0])
1448 except IOError as e:
1405 # first interpret argument as an object name
1406 out = self._inspect('pfile',parameter_s)
1407 # if not, try the input as a filename
1408 if out == 'not found':
1449 1409 try:
1450 msg = str(e)
1451 except UnicodeError:
1452 msg = e.message
1453 error(msg)
1410 filename = get_py_filename(parameter_s)
1411 except IOError,msg:
1412 print msg
1454 1413 return
1414 page.page(self.shell.inspector.format(open(filename).read()))
1455 1415
1456 arg_str = 'execfile(filename,prog_ns)'
1457 namespace = {
1458 'execfile': self.shell.safe_execfile,
1459 'prog_ns': prog_ns,
1460 'filename': filename
1461 }
1416 def magic_psearch(self, parameter_s=''):
1417 """Search for object in namespaces by wildcard.
1462 1418
1463 opts.merge(opts_def)
1419 %psearch [options] PATTERN [OBJECT TYPE]
1464 1420
1465 prof = profile.Profile()
1466 try:
1467 prof = prof.runctx(arg_str,namespace,namespace)
1468 sys_exit = ''
1469 except SystemExit:
1470 sys_exit = """*** SystemExit exception caught in code being profiled."""
1421 Note: ? can be used as a synonym for %psearch, at the beginning or at
1422 the end: both a*? and ?a* are equivalent to '%psearch a*'. Still, the
1423 rest of the command line must be unchanged (options come first), so
1424 for example the following forms are equivalent
1471 1425
1472 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
1426 %psearch -i a* function
1427 -i a* function?
1428 ?-i a* function
1473 1429
1474 lims = opts.l
1475 if lims:
1476 lims = [] # rebuild lims with ints/floats/strings
1477 for lim in opts.l:
1478 try:
1479 lims.append(int(lim))
1480 except ValueError:
1481 try:
1482 lims.append(float(lim))
1483 except ValueError:
1484 lims.append(lim)
1430 Arguments:
1485 1431
1486 # Trap output.
1487 stdout_trap = StringIO()
1432 PATTERN
1488 1433
1489 if hasattr(stats,'stream'):
1490 # In newer versions of python, the stats object has a 'stream'
1491 # attribute to write into.
1492 stats.stream = stdout_trap
1493 stats.print_stats(*lims)
1494 else:
1495 # For older versions, we manually redirect stdout during printing
1496 sys_stdout = sys.stdout
1497 try:
1498 sys.stdout = stdout_trap
1499 stats.print_stats(*lims)
1500 finally:
1501 sys.stdout = sys_stdout
1434 where PATTERN is a string containing * as a wildcard similar to its
1435 use in a shell. The pattern is matched in all namespaces on the
1436 search path. By default objects starting with a single _ are not
1437 matched, many IPython generated objects have a single
1438 underscore. The default is case insensitive matching. Matching is
1439 also done on the attributes of objects and not only on the objects
1440 in a module.
1502 1441
1503 output = stdout_trap.getvalue()
1504 output = output.rstrip()
1442 [OBJECT TYPE]
1505 1443
1506 if 'q' not in opts:
1507 page.page(output)
1508 print sys_exit,
1444 Is the name of a python type from the types module. The name is
1445 given in lowercase without the ending type, ex. StringType is
1446 written string. By adding a type here only objects matching the
1447 given type are matched. Using all here makes the pattern match all
1448 types (this is the default).
1509 1449
1510 dump_file = opts.D[0]
1511 text_file = opts.T[0]
1512 if dump_file:
1513 dump_file = unquote_filename(dump_file)
1514 prof.dump_stats(dump_file)
1515 print '\n*** Profile stats marshalled to file',\
1516 `dump_file`+'.',sys_exit
1517 if text_file:
1518 text_file = unquote_filename(text_file)
1519 pfile = open(text_file,'w')
1520 pfile.write(output)
1521 pfile.close()
1522 print '\n*** Profile printout saved to text file',\
1523 `text_file`+'.',sys_exit
1450 Options:
1524 1451
1525 if opts.has_key('r'):
1526 return stats
1527 else:
1528 return None
1452 -a: makes the pattern match even objects whose names start with a
1453 single underscore. These names are normally omitted from the
1454 search.
1529 1455
1530 @skip_doctest
1531 def magic_run(self, parameter_s ='', runner=None,
1532 file_finder=get_py_filename):
1533 """Run the named file inside IPython as a program.
1456 -i/-c: make the pattern case insensitive/sensitive. If neither of
1457 these options are given, the default is read from your configuration
1458 file, with the option ``InteractiveShell.wildcards_case_sensitive``.
1459 If this option is not specified in your configuration file, IPython's
1460 internal default is to do a case sensitive search.
1534 1461
1535 Usage:\\
1536 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1462 -e/-s NAMESPACE: exclude/search a given namespace. The pattern you
1463 specify can be searched in any of the following namespaces:
1464 'builtin', 'user', 'user_global','internal', 'alias', where
1465 'builtin' and 'user' are the search defaults. Note that you should
1466 not use quotes when specifying namespaces.
1537 1467
1538 Parameters after the filename are passed as command-line arguments to
1539 the program (put in sys.argv). Then, control returns to IPython's
1540 prompt.
1468 'Builtin' contains the python module builtin, 'user' contains all
1469 user data, 'alias' only contain the shell aliases and no python
1470 objects, 'internal' contains objects used by IPython. The
1471 'user_global' namespace is only used by embedded IPython instances,
1472 and it contains module-level globals. You can add namespaces to the
1473 search with -s or exclude them with -e (these options can be given
1474 more than once).
1541 1475
1542 This is similar to running at a system prompt:\\
1543 $ python file args\\
1544 but with the advantage of giving you IPython's tracebacks, and of
1545 loading all variables into your interactive namespace for further use
1546 (unless -p is used, see below).
1476 Examples
1477 --------
1478 ::
1547 1479
1548 The file is executed in a namespace initially consisting only of
1549 __name__=='__main__' and sys.argv constructed as indicated. It thus
1550 sees its environment as if it were being run as a stand-alone program
1551 (except for sharing global objects such as previously imported
1552 modules). But after execution, the IPython interactive namespace gets
1553 updated with all variables defined in the program (except for __name__
1554 and sys.argv). This allows for very convenient loading of code for
1555 interactive work, while giving each program a 'clean sheet' to run in.
1480 %psearch a* -> objects beginning with an a
1481 %psearch -e builtin a* -> objects NOT in the builtin space starting in a
1482 %psearch a* function -> all functions beginning with an a
1483 %psearch re.e* -> objects beginning with an e in module re
1484 %psearch r*.e* -> objects that start with e in modules starting in r
1485 %psearch r*.* string -> all strings in modules beginning with r
1556 1486
1557 Options:
1487 Case sensitive search::
1558 1488
1559 -n: __name__ is NOT set to '__main__', but to the running file's name
1560 without extension (as python does under import). This allows running
1561 scripts and reloading the definitions in them without calling code
1562 protected by an ' if __name__ == "__main__" ' clause.
1489 %psearch -c a* list all object beginning with lower case a
1563 1490
1564 -i: run the file in IPython's namespace instead of an empty one. This
1565 is useful if you are experimenting with code written in a text editor
1566 which depends on variables defined interactively.
1491 Show objects beginning with a single _::
1567 1492
1568 -e: ignore sys.exit() calls or SystemExit exceptions in the script
1569 being run. This is particularly useful if IPython is being used to
1570 run unittests, which always exit with a sys.exit() call. In such
1571 cases you are interested in the output of the test results, not in
1572 seeing a traceback of the unittest module.
1493 %psearch -a _* list objects beginning with a single underscore"""
1494 try:
1495 parameter_s.encode('ascii')
1496 except UnicodeEncodeError:
1497 print 'Python identifiers can only contain ascii characters.'
1498 return
1573 1499
1574 -t: print timing information at the end of the run. IPython will give
1575 you an estimated CPU time consumption for your script, which under
1576 Unix uses the resource module to avoid the wraparound problems of
1577 time.clock(). Under Unix, an estimate of time spent on system tasks
1578 is also given (for Windows platforms this is reported as 0.0).
1500 # default namespaces to be searched
1501 def_search = ['user_local', 'user_global', 'builtin']
1579 1502
1580 If -t is given, an additional -N<N> option can be given, where <N>
1581 must be an integer indicating how many times you want the script to
1582 run. The final timing report will include total and per run results.
1503 # Process options/args
1504 opts,args = self.parse_options(parameter_s,'cias:e:',list_all=True)
1505 opt = opts.get
1506 shell = self.shell
1507 psearch = shell.inspector.psearch
1583 1508
1584 For example (testing the script uniq_stable.py)::
1509 # select case options
1510 if opts.has_key('i'):
1511 ignore_case = True
1512 elif opts.has_key('c'):
1513 ignore_case = False
1514 else:
1515 ignore_case = not shell.wildcards_case_sensitive
1585 1516
1586 In [1]: run -t uniq_stable
1517 # Build list of namespaces to search from user options
1518 def_search.extend(opt('s',[]))
1519 ns_exclude = ns_exclude=opt('e',[])
1520 ns_search = [nm for nm in def_search if nm not in ns_exclude]
1587 1521
1588 IPython CPU timings (estimated):\\
1589 User : 0.19597 s.\\
1590 System: 0.0 s.\\
1522 # Call the actual search
1523 try:
1524 psearch(args,shell.ns_table,ns_search,
1525 show_all=opt('a'),ignore_case=ignore_case)
1526 except:
1527 shell.showtraceback()
1591 1528
1592 In [2]: run -t -N5 uniq_stable
1529 @skip_doctest
1530 def magic_who_ls(self, parameter_s=''):
1531 """Return a sorted list of all interactive variables.
1593 1532
1594 IPython CPU timings (estimated):\\
1595 Total runs performed: 5\\
1596 Times : Total Per run\\
1597 User : 0.910862 s, 0.1821724 s.\\
1598 System: 0.0 s, 0.0 s.
1533 If arguments are given, only variables of types matching these
1534 arguments are returned.
1599 1535
1600 -d: run your program under the control of pdb, the Python debugger.
1601 This allows you to execute your program step by step, watch variables,
1602 etc. Internally, what IPython does is similar to calling:
1536 Examples
1537 --------
1603 1538
1604 pdb.run('execfile("YOURFILENAME")')
1539 Define two variables and list them with who_ls::
1605 1540
1606 with a breakpoint set on line 1 of your file. You can change the line
1607 number for this automatic breakpoint to be <N> by using the -bN option
1608 (where N must be an integer). For example::
1541 In [1]: alpha = 123
1609 1542
1610 %run -d -b40 myscript
1543 In [2]: beta = 'test'
1611 1544
1612 will set the first breakpoint at line 40 in myscript.py. Note that
1613 the first breakpoint must be set on a line which actually does
1614 something (not a comment or docstring) for it to stop execution.
1545 In [3]: %who_ls
1546 Out[3]: ['alpha', 'beta']
1615 1547
1616 When the pdb debugger starts, you will see a (Pdb) prompt. You must
1617 first enter 'c' (without quotes) to start execution up to the first
1618 breakpoint.
1548 In [4]: %who_ls int
1549 Out[4]: ['alpha']
1619 1550
1620 Entering 'help' gives information about the use of the debugger. You
1621 can easily see pdb's full documentation with "import pdb;pdb.help()"
1622 at a prompt.
1551 In [5]: %who_ls str
1552 Out[5]: ['beta']
1553 """
1623 1554
1624 -p: run program under the control of the Python profiler module (which
1625 prints a detailed report of execution times, function calls, etc).
1555 user_ns = self.shell.user_ns
1556 user_ns_hidden = self.shell.user_ns_hidden
1557 out = [ i for i in user_ns
1558 if not i.startswith('_') \
1559 and not i in user_ns_hidden ]
1626 1560
1627 You can pass other options after -p which affect the behavior of the
1628 profiler itself. See the docs for %prun for details.
1561 typelist = parameter_s.split()
1562 if typelist:
1563 typeset = set(typelist)
1564 out = [i for i in out if type(user_ns[i]).__name__ in typeset]
1629 1565
1630 In this mode, the program's variables do NOT propagate back to the
1631 IPython interactive namespace (because they remain in the namespace
1632 where the profiler executes them).
1566 out.sort()
1567 return out
1633 1568
1634 Internally this triggers a call to %prun, see its documentation for
1635 details on the options available specifically for profiling.
1569 @skip_doctest
1570 def magic_who(self, parameter_s=''):
1571 """Print all interactive variables, with some minimal formatting.
1636 1572
1637 There is one special usage for which the text above doesn't apply:
1638 if the filename ends with .ipy, the file is run as ipython script,
1639 just as if the commands were written on IPython prompt.
1573 If any arguments are given, only variables whose type matches one of
1574 these are printed. For example::
1640 1575
1641 -m: specify module name to load instead of script path. Similar to
1642 the -m option for the python interpreter. Use this option last if you
1643 want to combine with other %run options. Unlike the python interpreter
1644 only source modules are allowed no .pyc or .pyo files.
1645 For example::
1576 %who function str
1646 1577
1647 %run -m example
1578 will only list functions and strings, excluding all other types of
1579 variables. To find the proper type names, simply use type(var) at a
1580 command line to see how python prints type names. For example:
1648 1581
1649 will run the example module.
1582 ::
1650 1583
1651 """
1584 In [1]: type('hello')\\
1585 Out[1]: <type 'str'>
1652 1586
1653 # get arguments and set sys.argv for program to be run.
1654 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
1655 mode='list', list_all=1)
1656 if "m" in opts:
1657 modulename = opts["m"][0]
1658 modpath = find_mod(modulename)
1659 if modpath is None:
1660 warn('%r is not a valid modulename on sys.path'%modulename)
1661 return
1662 arg_lst = [modpath] + arg_lst
1663 try:
1664 filename = file_finder(arg_lst[0])
1665 except IndexError:
1666 warn('you must provide at least a filename.')
1667 print '\n%run:\n', oinspect.getdoc(self.magic_run)
1668 return
1669 except IOError as e:
1670 try:
1671 msg = str(e)
1672 except UnicodeError:
1673 msg = e.message
1674 error(msg)
1675 return
1587 indicates that the type name for strings is 'str'.
1676 1588
1677 if filename.lower().endswith('.ipy'):
1678 self.shell.safe_execfile_ipy(filename)
1679 return
1589 ``%who`` always excludes executed names loaded through your configuration
1590 file and things which are internal to IPython.
1680 1591
1681 # Control the response to exit() calls made by the script being run
1682 exit_ignore = 'e' in opts
1592 This is deliberate, as typically you may load many modules and the
1593 purpose of %who is to show you only what you've manually defined.
1683 1594
1684 # Make sure that the running script gets a proper sys.argv as if it
1685 # were run from a system shell.
1686 save_argv = sys.argv # save it for later restoring
1595 Examples
1596 --------
1687 1597
1688 # simulate shell expansion on arguments, at least tilde expansion
1689 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
1598 Define two variables and list them with who::
1690 1599
1691 sys.argv = [filename] + args # put in the proper filename
1692 # protect sys.argv from potential unicode strings on Python 2:
1693 if not py3compat.PY3:
1694 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
1600 In [1]: alpha = 123
1695 1601
1696 if 'i' in opts:
1697 # Run in user's interactive namespace
1698 prog_ns = self.shell.user_ns
1699 __name__save = self.shell.user_ns['__name__']
1700 prog_ns['__name__'] = '__main__'
1701 main_mod = self.shell.new_main_mod(prog_ns)
1702 else:
1703 # Run in a fresh, empty namespace
1704 if 'n' in opts:
1705 name = os.path.splitext(os.path.basename(filename))[0]
1706 else:
1707 name = '__main__'
1602 In [2]: beta = 'test'
1708 1603
1709 main_mod = self.shell.new_main_mod()
1710 prog_ns = main_mod.__dict__
1711 prog_ns['__name__'] = name
1604 In [3]: %who
1605 alpha beta
1712 1606
1713 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
1714 # set the __file__ global in the script's namespace
1715 prog_ns['__file__'] = filename
1607 In [4]: %who int
1608 alpha
1716 1609
1717 # pickle fix. See interactiveshell for an explanation. But we need to make sure
1718 # that, if we overwrite __main__, we replace it at the end
1719 main_mod_name = prog_ns['__name__']
1610 In [5]: %who str
1611 beta
1612 """
1720 1613
1721 if main_mod_name == '__main__':
1722 restore_main = sys.modules['__main__']
1614 varlist = self.magic_who_ls(parameter_s)
1615 if not varlist:
1616 if parameter_s:
1617 print 'No variables match your requested type.'
1723 1618 else:
1724 restore_main = False
1619 print 'Interactive namespace is empty.'
1620 return
1725 1621
1726 # This needs to be undone at the end to prevent holding references to
1727 # every single object ever created.
1728 sys.modules[main_mod_name] = main_mod
1622 # if we have variables, move on...
1623 count = 0
1624 for i in varlist:
1625 print i+'\t',
1626 count += 1
1627 if count > 8:
1628 count = 0
1629 print
1630 print
1729 1631
1730 try:
1731 stats = None
1732 with self.shell.readline_no_record:
1733 if 'p' in opts:
1734 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
1735 else:
1736 if 'd' in opts:
1737 deb = debugger.Pdb(self.shell.colors)
1738 # reset Breakpoint state, which is moronically kept
1739 # in a class
1740 bdb.Breakpoint.next = 1
1741 bdb.Breakpoint.bplist = {}
1742 bdb.Breakpoint.bpbynumber = [None]
1743 # Set an initial breakpoint to stop execution
1744 maxtries = 10
1745 bp = int(opts.get('b', [1])[0])
1746 checkline = deb.checkline(filename, bp)
1747 if not checkline:
1748 for bp in range(bp + 1, bp + maxtries + 1):
1749 if deb.checkline(filename, bp):
1750 break
1632 @skip_doctest
1633 def magic_whos(self, parameter_s=''):
1634 """Like %who, but gives some extra information about each variable.
1635
1636 The same type filtering of %who can be applied here.
1637
1638 For all variables, the type is printed. Additionally it prints:
1639
1640 - For {},[],(): their length.
1641
1642 - For numpy arrays, a summary with shape, number of
1643 elements, typecode and size in memory.
1644
1645 - Everything else: a string representation, snipping their middle if
1646 too long.
1647
1648 Examples
1649 --------
1650
1651 Define two variables and list them with whos::
1652
1653 In [1]: alpha = 123
1654
1655 In [2]: beta = 'test'
1656
1657 In [3]: %whos
1658 Variable Type Data/Info
1659 --------------------------------
1660 alpha int 123
1661 beta str test
1662 """
1663
1664 varnames = self.magic_who_ls(parameter_s)
1665 if not varnames:
1666 if parameter_s:
1667 print 'No variables match your requested type.'
1751 1668 else:
1752 msg = ("\nI failed to find a valid line to set "
1753 "a breakpoint\n"
1754 "after trying up to line: %s.\n"
1755 "Please set a valid breakpoint manually "
1756 "with the -b option." % bp)
1757 error(msg)
1669 print 'Interactive namespace is empty.'
1758 1670 return
1759 # if we find a good linenumber, set the breakpoint
1760 deb.do_break('%s:%s' % (filename, bp))
1761 # Start file run
1762 print "NOTE: Enter 'c' at the",
1763 print "%s prompt to start your script." % deb.prompt
1764 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
1765 try:
1766 deb.run('execfile("%s", prog_ns)' % filename, ns)
1767 1671
1768 except:
1769 etype, value, tb = sys.exc_info()
1770 # Skip three frames in the traceback: the %run one,
1771 # one inside bdb.py, and the command-line typed by the
1772 # user (run by exec in pdb itself).
1773 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
1774 else:
1775 if runner is None:
1776 runner = self.default_runner
1777 if runner is None:
1778 runner = self.shell.safe_execfile
1779 if 't' in opts:
1780 # timed execution
1672 # if we have variables, move on...
1673
1674 # for these types, show len() instead of data:
1675 seq_types = ['dict', 'list', 'tuple']
1676
1677 # for numpy arrays, display summary info
1678 ndarray_type = None
1679 if 'numpy' in sys.modules:
1781 1680 try:
1782 nruns = int(opts['N'][0])
1783 if nruns < 1:
1784 error('Number of runs must be >=1')
1785 return
1786 except (KeyError):
1787 nruns = 1
1788 twall0 = time.time()
1789 if nruns == 1:
1790 t0 = clock2()
1791 runner(filename, prog_ns, prog_ns,
1792 exit_ignore=exit_ignore)
1793 t1 = clock2()
1794 t_usr = t1[0] - t0[0]
1795 t_sys = t1[1] - t0[1]
1796 print "\nIPython CPU timings (estimated):"
1797 print " User : %10.2f s." % t_usr
1798 print " System : %10.2f s." % t_sys
1681 from numpy import ndarray
1682 except ImportError:
1683 pass
1799 1684 else:
1800 runs = range(nruns)
1801 t0 = clock2()
1802 for nr in runs:
1803 runner(filename, prog_ns, prog_ns,
1804 exit_ignore=exit_ignore)
1805 t1 = clock2()
1806 t_usr = t1[0] - t0[0]
1807 t_sys = t1[1] - t0[1]
1808 print "\nIPython CPU timings (estimated):"
1809 print "Total runs performed:", nruns
1810 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
1811 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
1812 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
1813 twall1 = time.time()
1814 print "Wall time: %10.2f s." % (twall1 - twall0)
1685 ndarray_type = ndarray.__name__
1686
1687 # Find all variable names and types so we can figure out column sizes
1688 def get_vars(i):
1689 return self.shell.user_ns[i]
1690
1691 # some types are well known and can be shorter
1692 abbrevs = {'IPython.core.macro.Macro' : 'Macro'}
1693 def type_name(v):
1694 tn = type(v).__name__
1695 return abbrevs.get(tn,tn)
1696
1697 varlist = map(get_vars,varnames)
1698
1699 typelist = []
1700 for vv in varlist:
1701 tt = type_name(vv)
1815 1702
1703 if tt=='instance':
1704 typelist.append( abbrevs.get(str(vv.__class__),
1705 str(vv.__class__)))
1816 1706 else:
1817 # regular execution
1818 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
1707 typelist.append(tt)
1819 1708
1820 if 'i' in opts:
1821 self.shell.user_ns['__name__'] = __name__save
1709 # column labels and # of spaces as separator
1710 varlabel = 'Variable'
1711 typelabel = 'Type'
1712 datalabel = 'Data/Info'
1713 colsep = 3
1714 # variable format strings
1715 vformat = "{0:<{varwidth}}{1:<{typewidth}}"
1716 aformat = "%s: %s elems, type `%s`, %s bytes"
1717 # find the size of the columns to format the output nicely
1718 varwidth = max(max(map(len,varnames)), len(varlabel)) + colsep
1719 typewidth = max(max(map(len,typelist)), len(typelabel)) + colsep
1720 # table header
1721 print varlabel.ljust(varwidth) + typelabel.ljust(typewidth) + \
1722 ' '+datalabel+'\n' + '-'*(varwidth+typewidth+len(datalabel)+1)
1723 # and the table itself
1724 kb = 1024
1725 Mb = 1048576 # kb**2
1726 for vname,var,vtype in zip(varnames,varlist,typelist):
1727 print vformat.format(vname, vtype, varwidth=varwidth, typewidth=typewidth),
1728 if vtype in seq_types:
1729 print "n="+str(len(var))
1730 elif vtype == ndarray_type:
1731 vshape = str(var.shape).replace(',','').replace(' ','x')[1:-1]
1732 if vtype==ndarray_type:
1733 # numpy
1734 vsize = var.size
1735 vbytes = vsize*var.itemsize
1736 vdtype = var.dtype
1737
1738 if vbytes < 100000:
1739 print aformat % (vshape,vsize,vdtype,vbytes)
1822 1740 else:
1823 # The shell MUST hold a reference to prog_ns so after %run
1824 # exits, the python deletion mechanism doesn't zero it out
1825 # (leaving dangling references).
1826 self.shell.cache_main_mod(prog_ns, filename)
1827 # update IPython interactive namespace
1741 print aformat % (vshape,vsize,vdtype,vbytes),
1742 if vbytes < Mb:
1743 print '(%s kb)' % (vbytes/kb,)
1744 else:
1745 print '(%s Mb)' % (vbytes/Mb,)
1746 else:
1747 try:
1748 vstr = str(var)
1749 except UnicodeEncodeError:
1750 vstr = unicode(var).encode(DEFAULT_ENCODING,
1751 'backslashreplace')
1752 except:
1753 vstr = "<object with id %d (str() failed)>" % id(var)
1754 vstr = vstr.replace('\n','\\n')
1755 if len(vstr) < 50:
1756 print vstr
1757 else:
1758 print vstr[:25] + "<...>" + vstr[-25:]
1828 1759
1829 # Some forms of read errors on the file may mean the
1830 # __name__ key was never set; using pop we don't have to
1831 # worry about a possible KeyError.
1832 prog_ns.pop('__name__', None)
1760 def magic_reset(self, parameter_s=''):
1761 """Resets the namespace by removing all names defined by the user, if
1762 called without arguments, or by removing some types of objects, such
1763 as everything currently in IPython's In[] and Out[] containers (see
1764 the parameters for details).
1833 1765
1834 self.shell.user_ns.update(prog_ns)
1835 finally:
1836 # It's a bit of a mystery why, but __builtins__ can change from
1837 # being a module to becoming a dict missing some key data after
1838 # %run. As best I can see, this is NOT something IPython is doing
1839 # at all, and similar problems have been reported before:
1840 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
1841 # Since this seems to be done by the interpreter itself, the best
1842 # we can do is to at least restore __builtins__ for the user on
1843 # exit.
1844 self.shell.user_ns['__builtins__'] = builtin_mod
1766 Parameters
1767 ----------
1768 -f : force reset without asking for confirmation.
1845 1769
1846 # Ensure key global structures are restored
1847 sys.argv = save_argv
1848 if restore_main:
1849 sys.modules['__main__'] = restore_main
1850 else:
1851 # Remove from sys.modules the reference to main_mod we'd
1852 # added. Otherwise it will trap references to objects
1853 # contained therein.
1854 del sys.modules[main_mod_name]
1770 -s : 'Soft' reset: Only clears your namespace, leaving history intact.
1771 References to objects may be kept. By default (without this option),
1772 we do a 'hard' reset, giving you a new session and removing all
1773 references to objects from the current session.
1855 1774
1856 return stats
1775 in : reset input history
1857 1776
1858 @skip_doctest
1859 def magic_timeit(self, parameter_s =''):
1860 """Time execution of a Python statement or expression
1777 out : reset output history
1778
1779 dhist : reset directory history
1780
1781 array : reset only variables that are NumPy arrays
1782
1783 See Also
1784 --------
1785 magic_reset_selective : invoked as ``%reset_selective``
1786
1787 Examples
1788 --------
1789 ::
1790
1791 In [6]: a = 1
1792
1793 In [7]: a
1794 Out[7]: 1
1795
1796 In [8]: 'a' in _ip.user_ns
1797 Out[8]: True
1798
1799 In [9]: %reset -f
1800
1801 In [1]: 'a' in _ip.user_ns
1802 Out[1]: False
1803
1804 In [2]: %reset -f in
1805 Flushing input history
1806
1807 In [3]: %reset -f dhist in
1808 Flushing directory history
1809 Flushing input history
1810
1811 Notes
1812 -----
1813 Calling this magic from clients that do not implement standard input,
1814 such as the ipython notebook interface, will reset the namespace
1815 without confirmation.
1816 """
1817 opts, args = self.parse_options(parameter_s,'sf', mode='list')
1818 if 'f' in opts:
1819 ans = True
1820 else:
1821 try:
1822 ans = self.shell.ask_yes_no(
1823 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ", default='n')
1824 except StdinNotImplementedError:
1825 ans = True
1826 if not ans:
1827 print 'Nothing done.'
1828 return
1829
1830 if 's' in opts: # Soft reset
1831 user_ns = self.shell.user_ns
1832 for i in self.magic_who_ls():
1833 del(user_ns[i])
1834 elif len(args) == 0: # Hard reset
1835 self.shell.reset(new_session = False)
1836
1837 # reset in/out/dhist/array: previously extensinions/clearcmd.py
1838 ip = self.shell
1839 user_ns = self.shell.user_ns # local lookup, heavily used
1840
1841 for target in args:
1842 target = target.lower() # make matches case insensitive
1843 if target == 'out':
1844 print "Flushing output cache (%d entries)" % len(user_ns['_oh'])
1845 self.shell.displayhook.flush()
1846
1847 elif target == 'in':
1848 print "Flushing input history"
1849 pc = self.shell.displayhook.prompt_count + 1
1850 for n in range(1, pc):
1851 key = '_i'+repr(n)
1852 user_ns.pop(key,None)
1853 user_ns.update(dict(_i=u'',_ii=u'',_iii=u''))
1854 hm = ip.history_manager
1855 # don't delete these, as %save and %macro depending on the length
1856 # of these lists to be preserved
1857 hm.input_hist_parsed[:] = [''] * pc
1858 hm.input_hist_raw[:] = [''] * pc
1859 # hm has internal machinery for _i,_ii,_iii, clear it out
1860 hm._i = hm._ii = hm._iii = hm._i00 = u''
1861
1862 elif target == 'array':
1863 # Support cleaning up numpy arrays
1864 try:
1865 from numpy import ndarray
1866 # This must be done with items and not iteritems because we're
1867 # going to modify the dict in-place.
1868 for x,val in user_ns.items():
1869 if isinstance(val,ndarray):
1870 del user_ns[x]
1871 except ImportError:
1872 print "reset array only works if Numpy is available."
1873
1874 elif target == 'dhist':
1875 print "Flushing directory history"
1876 del user_ns['_dh'][:]
1877
1878 else:
1879 print "Don't know how to reset ",
1880 print target + ", please run `%reset?` for details"
1881
1882 gc.collect()
1883
1884 def magic_reset_selective(self, parameter_s=''):
1885 """Resets the namespace by removing names defined by the user.
1886
1887 Input/Output history are left around in case you need them.
1888
1889 %reset_selective [-f] regex
1890
1891 No action is taken if regex is not included
1892
1893 Options
1894 -f : force reset without asking for confirmation.
1895
1896 See Also
1897 --------
1898 magic_reset : invoked as ``%reset``
1899
1900 Examples
1901 --------
1902
1903 We first fully reset the namespace so your output looks identical to
1904 this example for pedagogical reasons; in practice you do not need a
1905 full reset::
1906
1907 In [1]: %reset -f
1908
1909 Now, with a clean namespace we can make a few variables and use
1910 ``%reset_selective`` to only delete names that match our regexp::
1911
1912 In [2]: a=1; b=2; c=3; b1m=4; b2m=5; b3m=6; b4m=7; b2s=8
1913
1914 In [3]: who_ls
1915 Out[3]: ['a', 'b', 'b1m', 'b2m', 'b2s', 'b3m', 'b4m', 'c']
1916
1917 In [4]: %reset_selective -f b[2-3]m
1918
1919 In [5]: who_ls
1920 Out[5]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1921
1922 In [6]: %reset_selective -f d
1923
1924 In [7]: who_ls
1925 Out[7]: ['a', 'b', 'b1m', 'b2s', 'b4m', 'c']
1926
1927 In [8]: %reset_selective -f c
1928
1929 In [9]: who_ls
1930 Out[9]: ['a', 'b', 'b1m', 'b2s', 'b4m']
1931
1932 In [10]: %reset_selective -f b
1933
1934 In [11]: who_ls
1935 Out[11]: ['a']
1936
1937 Notes
1938 -----
1939 Calling this magic from clients that do not implement standard input,
1940 such as the ipython notebook interface, will reset the namespace
1941 without confirmation.
1942 """
1943
1944 opts, regex = self.parse_options(parameter_s,'f')
1945
1946 if opts.has_key('f'):
1947 ans = True
1948 else:
1949 try:
1950 ans = self.shell.ask_yes_no(
1951 "Once deleted, variables cannot be recovered. Proceed (y/[n])? ",
1952 default='n')
1953 except StdinNotImplementedError:
1954 ans = True
1955 if not ans:
1956 print 'Nothing done.'
1957 return
1958 user_ns = self.shell.user_ns
1959 if not regex:
1960 print 'No regex pattern specified. Nothing done.'
1961 return
1962 else:
1963 try:
1964 m = re.compile(regex)
1965 except TypeError:
1966 raise TypeError('regex must be a string or compiled pattern')
1967 for i in self.magic_who_ls():
1968 if m.search(i):
1969 del(user_ns[i])
1970
1971 def magic_xdel(self, parameter_s=''):
1972 """Delete a variable, trying to clear it from anywhere that
1973 IPython's machinery has references to it. By default, this uses
1974 the identity of the named object in the user namespace to remove
1975 references held under other names. The object is also removed
1976 from the output history.
1977
1978 Options
1979 -n : Delete the specified name from all namespaces, without
1980 checking their identity.
1981 """
1982 opts, varname = self.parse_options(parameter_s,'n')
1983 try:
1984 self.shell.del_var(varname, ('n' in opts))
1985 except (NameError, ValueError) as e:
1986 print type(e).__name__ +": "+ str(e)
1987
1988
1989 class ExecutionMagics(MagicFunctions):
1990 """Magics related to code execution, debugging, profiling, etc.
1991
1992 """
1993
1994 def __init__(self, shell):
1995 super(ProfileMagics, self).__init__(shell)
1996 if profile is None:
1997 self.magic_prun = self.profile_missing_notice
1998 # Default execution function used to actually run user code.
1999 self.default_runner = None
2000
2001 def profile_missing_notice(self, *args, **kwargs):
2002 error("""\
2003 The profile module could not be found. It has been removed from the standard
2004 python packages because of its non-free license. To use profiling, install the
2005 python-profiler package from non-free.""")
2006
2007 @skip_doctest
2008 def magic_prun(self, parameter_s ='',user_mode=1,
2009 opts=None,arg_lst=None,prog_ns=None):
2010
2011 """Run a statement through the python code profiler.
2012
2013 Usage:
2014 %prun [options] statement
2015
2016 The given statement (which doesn't require quote marks) is run via the
2017 python profiler in a manner similar to the profile.run() function.
2018 Namespaces are internally managed to work correctly; profile.run
2019 cannot be used in IPython because it makes certain assumptions about
2020 namespaces which do not hold under IPython.
2021
2022 Options:
2023
2024 -l <limit>: you can place restrictions on what or how much of the
2025 profile gets printed. The limit value can be:
2026
2027 * A string: only information for function names containing this string
2028 is printed.
2029
2030 * An integer: only these many lines are printed.
2031
2032 * A float (between 0 and 1): this fraction of the report is printed
2033 (for example, use a limit of 0.4 to see the topmost 40% only).
2034
2035 You can combine several limits with repeated use of the option. For
2036 example, '-l __init__ -l 5' will print only the topmost 5 lines of
2037 information about class constructors.
2038
2039 -r: return the pstats.Stats object generated by the profiling. This
2040 object has all the information about the profile in it, and you can
2041 later use it for further analysis or in other functions.
2042
2043 -s <key>: sort profile by given key. You can provide more than one key
2044 by using the option several times: '-s key1 -s key2 -s key3...'. The
2045 default sorting key is 'time'.
2046
2047 The following is copied verbatim from the profile documentation
2048 referenced below:
2049
2050 When more than one key is provided, additional keys are used as
2051 secondary criteria when the there is equality in all keys selected
2052 before them.
2053
2054 Abbreviations can be used for any key names, as long as the
2055 abbreviation is unambiguous. The following are the keys currently
2056 defined:
2057
2058 Valid Arg Meaning
2059 "calls" call count
2060 "cumulative" cumulative time
2061 "file" file name
2062 "module" file name
2063 "pcalls" primitive call count
2064 "line" line number
2065 "name" function name
2066 "nfl" name/file/line
2067 "stdname" standard name
2068 "time" internal time
2069
2070 Note that all sorts on statistics are in descending order (placing
2071 most time consuming items first), where as name, file, and line number
2072 searches are in ascending order (i.e., alphabetical). The subtle
2073 distinction between "nfl" and "stdname" is that the standard name is a
2074 sort of the name as printed, which means that the embedded line
2075 numbers get compared in an odd way. For example, lines 3, 20, and 40
2076 would (if the file names were the same) appear in the string order
2077 "20" "3" and "40". In contrast, "nfl" does a numeric compare of the
2078 line numbers. In fact, sort_stats("nfl") is the same as
2079 sort_stats("name", "file", "line").
2080
2081 -T <filename>: save profile results as shown on screen to a text
2082 file. The profile is still shown on screen.
2083
2084 -D <filename>: save (via dump_stats) profile statistics to given
2085 filename. This data is in a format understood by the pstats module, and
2086 is generated by a call to the dump_stats() method of profile
2087 objects. The profile is still shown on screen.
2088
2089 -q: suppress output to the pager. Best used with -T and/or -D above.
2090
2091 If you want to run complete programs under the profiler's control, use
2092 '%run -p [prof_opts] filename.py [args to program]' where prof_opts
2093 contains profiler specific options as described here.
2094
2095 You can read the complete documentation for the profile module with::
2096
2097 In [1]: import profile; profile.help()
2098 """
2099
2100 opts_def = Struct(D=[''],l=[],s=['time'],T=[''])
2101
2102 if user_mode: # regular user call
2103 opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
2104 list_all=1, posix=False)
2105 namespace = self.shell.user_ns
2106 else: # called to run a program by %run -p
2107 try:
2108 filename = get_py_filename(arg_lst[0])
2109 except IOError as e:
2110 try:
2111 msg = str(e)
2112 except UnicodeError:
2113 msg = e.message
2114 error(msg)
2115 return
2116
2117 arg_str = 'execfile(filename,prog_ns)'
2118 namespace = {
2119 'execfile': self.shell.safe_execfile,
2120 'prog_ns': prog_ns,
2121 'filename': filename
2122 }
2123
2124 opts.merge(opts_def)
2125
2126 prof = profile.Profile()
2127 try:
2128 prof = prof.runctx(arg_str,namespace,namespace)
2129 sys_exit = ''
2130 except SystemExit:
2131 sys_exit = """*** SystemExit exception caught in code being profiled."""
2132
2133 stats = pstats.Stats(prof).strip_dirs().sort_stats(*opts.s)
2134
2135 lims = opts.l
2136 if lims:
2137 lims = [] # rebuild lims with ints/floats/strings
2138 for lim in opts.l:
2139 try:
2140 lims.append(int(lim))
2141 except ValueError:
2142 try:
2143 lims.append(float(lim))
2144 except ValueError:
2145 lims.append(lim)
2146
2147 # Trap output.
2148 stdout_trap = StringIO()
2149
2150 if hasattr(stats,'stream'):
2151 # In newer versions of python, the stats object has a 'stream'
2152 # attribute to write into.
2153 stats.stream = stdout_trap
2154 stats.print_stats(*lims)
2155 else:
2156 # For older versions, we manually redirect stdout during printing
2157 sys_stdout = sys.stdout
2158 try:
2159 sys.stdout = stdout_trap
2160 stats.print_stats(*lims)
2161 finally:
2162 sys.stdout = sys_stdout
1861 2163
1862 Usage:\\
1863 %timeit [-n<N> -r<R> [-t|-c]] statement
2164 output = stdout_trap.getvalue()
2165 output = output.rstrip()
1864 2166
1865 Time execution of a Python statement or expression using the timeit
1866 module.
2167 if 'q' not in opts:
2168 page.page(output)
2169 print sys_exit,
1867 2170
1868 Options:
1869 -n<N>: execute the given statement <N> times in a loop. If this value
1870 is not given, a fitting value is chosen.
2171 dump_file = opts.D[0]
2172 text_file = opts.T[0]
2173 if dump_file:
2174 dump_file = unquote_filename(dump_file)
2175 prof.dump_stats(dump_file)
2176 print '\n*** Profile stats marshalled to file',\
2177 `dump_file`+'.',sys_exit
2178 if text_file:
2179 text_file = unquote_filename(text_file)
2180 pfile = open(text_file,'w')
2181 pfile.write(output)
2182 pfile.close()
2183 print '\n*** Profile printout saved to text file',\
2184 `text_file`+'.',sys_exit
1871 2185
1872 -r<R>: repeat the loop iteration <R> times and take the best result.
1873 Default: 3
2186 if opts.has_key('r'):
2187 return stats
2188 else:
2189 return None
1874 2190
1875 -t: use time.time to measure the time, which is the default on Unix.
1876 This function measures wall time.
2191 def magic_pdb(self, parameter_s=''):
2192 """Control the automatic calling of the pdb interactive debugger.
1877 2193
1878 -c: use time.clock to measure the time, which is the default on
1879 Windows and measures wall time. On Unix, resource.getrusage is used
1880 instead and returns the CPU user time.
2194 Call as '%pdb on', '%pdb 1', '%pdb off' or '%pdb 0'. If called without
2195 argument it works as a toggle.
1881 2196
1882 -p<P>: use a precision of <P> digits to display the timing result.
1883 Default: 3
2197 When an exception is triggered, IPython can optionally call the
2198 interactive pdb debugger after the traceback printout. %pdb toggles
2199 this feature on and off.
1884 2200
2201 The initial state of this feature is set in your configuration
2202 file (the option is ``InteractiveShell.pdb``).
1885 2203
1886 Examples
1887 --------
1888 ::
2204 If you want to just activate the debugger AFTER an exception has fired,
2205 without having to type '%pdb on' and rerunning your code, you can use
2206 the %debug magic."""
1889 2207
1890 In [1]: %timeit pass
1891 10000000 loops, best of 3: 53.3 ns per loop
2208 par = parameter_s.strip().lower()
1892 2209
1893 In [2]: u = None
2210 if par:
2211 try:
2212 new_pdb = {'off':0,'0':0,'on':1,'1':1}[par]
2213 except KeyError:
2214 print ('Incorrect argument. Use on/1, off/0, '
2215 'or nothing for a toggle.')
2216 return
2217 else:
2218 # toggle
2219 new_pdb = not self.shell.call_pdb
1894 2220
1895 In [3]: %timeit u is None
1896 10000000 loops, best of 3: 184 ns per loop
2221 # set on the shell
2222 self.shell.call_pdb = new_pdb
2223 print 'Automatic pdb calling has been turned',on_off(new_pdb)
1897 2224
1898 In [4]: %timeit -r 4 u == None
1899 1000000 loops, best of 4: 242 ns per loop
2225 def magic_debug(self, parameter_s=''):
2226 """Activate the interactive debugger in post-mortem mode.
1900 2227
1901 In [5]: import time
2228 If an exception has just occurred, this lets you inspect its stack
2229 frames interactively. Note that this will always work only on the last
2230 traceback that occurred, so you must call this quickly after an
2231 exception that you wish to inspect has fired, because if another one
2232 occurs, it clobbers the previous one.
1902 2233
1903 In [6]: %timeit -n1 time.sleep(2)
1904 1 loops, best of 3: 2 s per loop
2234 If you want IPython to automatically do this on every exception, see
2235 the %pdb magic for more details.
2236 """
2237 self.shell.debugger(force=True)
1905 2238
2239 def magic_tb(self, s):
2240 """Print the last traceback with the currently active exception mode.
1906 2241
1907 The times reported by %timeit will be slightly higher than those
1908 reported by the timeit.py script when variables are accessed. This is
1909 due to the fact that %timeit executes the statement in the namespace
1910 of the shell, compared with timeit.py, which uses a single setup
1911 statement to import function or create variables. Generally, the bias
1912 does not matter as long as results from timeit.py are not mixed with
1913 those from %timeit."""
2242 See %xmode for changing exception reporting modes."""
2243 self.shell.showtraceback()
1914 2244
1915 import timeit
1916 import math
2245 @skip_doctest
2246 def magic_run(self, parameter_s ='', runner=None,
2247 file_finder=get_py_filename):
2248 """Run the named file inside IPython as a program.
1917 2249
1918 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
1919 # certain terminals. Until we figure out a robust way of
1920 # auto-detecting if the terminal can deal with it, use plain 'us' for
1921 # microseconds. I am really NOT happy about disabling the proper
1922 # 'micro' prefix, but crashing is worse... If anyone knows what the
1923 # right solution for this is, I'm all ears...
1924 #
1925 # Note: using
1926 #
1927 # s = u'\xb5'
1928 # s.encode(sys.getdefaultencoding())
1929 #
1930 # is not sufficient, as I've seen terminals where that fails but
1931 # print s
1932 #
1933 # succeeds
1934 #
1935 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
2250 Usage:\\
2251 %run [-n -i -t [-N<N>] -d [-b<N>] -p [profile options]] file [args]
1936 2252
1937 #units = [u"s", u"ms",u'\xb5',"ns"]
1938 units = [u"s", u"ms",u'us',"ns"]
2253 Parameters after the filename are passed as command-line arguments to
2254 the program (put in sys.argv). Then, control returns to IPython's
2255 prompt.
1939 2256
1940 scaling = [1, 1e3, 1e6, 1e9]
2257 This is similar to running at a system prompt:\\
2258 $ python file args\\
2259 but with the advantage of giving you IPython's tracebacks, and of
2260 loading all variables into your interactive namespace for further use
2261 (unless -p is used, see below).
1941 2262
1942 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
1943 posix=False, strict=False)
1944 if stmt == "":
1945 return
1946 timefunc = timeit.default_timer
1947 number = int(getattr(opts, "n", 0))
1948 repeat = int(getattr(opts, "r", timeit.default_repeat))
1949 precision = int(getattr(opts, "p", 3))
1950 if hasattr(opts, "t"):
1951 timefunc = time.time
1952 if hasattr(opts, "c"):
1953 timefunc = clock
2263 The file is executed in a namespace initially consisting only of
2264 __name__=='__main__' and sys.argv constructed as indicated. It thus
2265 sees its environment as if it were being run as a stand-alone program
2266 (except for sharing global objects such as previously imported
2267 modules). But after execution, the IPython interactive namespace gets
2268 updated with all variables defined in the program (except for __name__
2269 and sys.argv). This allows for very convenient loading of code for
2270 interactive work, while giving each program a 'clean sheet' to run in.
1954 2271
1955 timer = timeit.Timer(timer=timefunc)
1956 # this code has tight coupling to the inner workings of timeit.Timer,
1957 # but is there a better way to achieve that the code stmt has access
1958 # to the shell namespace?
2272 Options:
1959 2273
1960 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
1961 'setup': "pass"}
1962 # Track compilation time so it can be reported if too long
1963 # Minimum time above which compilation time will be reported
1964 tc_min = 0.1
2274 -n: __name__ is NOT set to '__main__', but to the running file's name
2275 without extension (as python does under import). This allows running
2276 scripts and reloading the definitions in them without calling code
2277 protected by an ' if __name__ == "__main__" ' clause.
1965 2278
1966 t0 = clock()
1967 code = compile(src, "<magic-timeit>", "exec")
1968 tc = clock()-t0
2279 -i: run the file in IPython's namespace instead of an empty one. This
2280 is useful if you are experimenting with code written in a text editor
2281 which depends on variables defined interactively.
1969 2282
1970 ns = {}
1971 exec code in self.shell.user_ns, ns
1972 timer.inner = ns["inner"]
2283 -e: ignore sys.exit() calls or SystemExit exceptions in the script
2284 being run. This is particularly useful if IPython is being used to
2285 run unittests, which always exit with a sys.exit() call. In such
2286 cases you are interested in the output of the test results, not in
2287 seeing a traceback of the unittest module.
1973 2288
1974 if number == 0:
1975 # determine number so that 0.2 <= total time < 2.0
1976 number = 1
1977 for i in range(1, 10):
1978 if timer.timeit(number) >= 0.2:
1979 break
1980 number *= 10
2289 -t: print timing information at the end of the run. IPython will give
2290 you an estimated CPU time consumption for your script, which under
2291 Unix uses the resource module to avoid the wraparound problems of
2292 time.clock(). Under Unix, an estimate of time spent on system tasks
2293 is also given (for Windows platforms this is reported as 0.0).
1981 2294
1982 best = min(timer.repeat(repeat, number)) / number
2295 If -t is given, an additional -N<N> option can be given, where <N>
2296 must be an integer indicating how many times you want the script to
2297 run. The final timing report will include total and per run results.
1983 2298
1984 if best > 0.0 and best < 1000.0:
1985 order = min(-int(math.floor(math.log10(best)) // 3), 3)
1986 elif best >= 1000.0:
1987 order = 0
1988 else:
1989 order = 3
1990 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
1991 precision,
1992 best * scaling[order],
1993 units[order])
1994 if tc > tc_min:
1995 print "Compiler time: %.2f s" % tc
2299 For example (testing the script uniq_stable.py)::
1996 2300
1997 @skip_doctest
1998 @needs_local_scope
1999 def magic_time(self,parameter_s, user_locals):
2000 """Time execution of a Python statement or expression.
2301 In [1]: run -t uniq_stable
2001 2302
2002 The CPU and wall clock times are printed, and the value of the
2003 expression (if any) is returned. Note that under Win32, system time
2004 is always reported as 0, since it can not be measured.
2303 IPython CPU timings (estimated):\\
2304 User : 0.19597 s.\\
2305 System: 0.0 s.\\
2005 2306
2006 This function provides very basic timing functionality. In Python
2007 2.3, the timeit module offers more control and sophistication, so this
2008 could be rewritten to use it (patches welcome).
2307 In [2]: run -t -N5 uniq_stable
2009 2308
2010 Examples
2011 --------
2012 ::
2309 IPython CPU timings (estimated):\\
2310 Total runs performed: 5\\
2311 Times : Total Per run\\
2312 User : 0.910862 s, 0.1821724 s.\\
2313 System: 0.0 s, 0.0 s.
2013 2314
2014 In [1]: time 2**128
2015 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2016 Wall time: 0.00
2017 Out[1]: 340282366920938463463374607431768211456L
2315 -d: run your program under the control of pdb, the Python debugger.
2316 This allows you to execute your program step by step, watch variables,
2317 etc. Internally, what IPython does is similar to calling:
2018 2318
2019 In [2]: n = 1000000
2319 pdb.run('execfile("YOURFILENAME")')
2020 2320
2021 In [3]: time sum(range(n))
2022 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2023 Wall time: 1.37
2024 Out[3]: 499999500000L
2321 with a breakpoint set on line 1 of your file. You can change the line
2322 number for this automatic breakpoint to be <N> by using the -bN option
2323 (where N must be an integer). For example::
2025 2324
2026 In [4]: time print 'hello world'
2027 hello world
2028 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2029 Wall time: 0.00
2325 %run -d -b40 myscript
2030 2326
2031 Note that the time needed by Python to compile the given expression
2032 will be reported if it is more than 0.1s. In this example, the
2033 actual exponentiation is done by Python at compilation time, so while
2034 the expression can take a noticeable amount of time to compute, that
2035 time is purely due to the compilation:
2327 will set the first breakpoint at line 40 in myscript.py. Note that
2328 the first breakpoint must be set on a line which actually does
2329 something (not a comment or docstring) for it to stop execution.
2036 2330
2037 In [5]: time 3**9999;
2038 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2039 Wall time: 0.00 s
2331 When the pdb debugger starts, you will see a (Pdb) prompt. You must
2332 first enter 'c' (without quotes) to start execution up to the first
2333 breakpoint.
2040 2334
2041 In [6]: time 3**999999;
2042 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2043 Wall time: 0.00 s
2044 Compiler : 0.78 s
2045 """
2335 Entering 'help' gives information about the use of the debugger. You
2336 can easily see pdb's full documentation with "import pdb;pdb.help()"
2337 at a prompt.
2046 2338
2047 # fail immediately if the given expression can't be compiled
2339 -p: run program under the control of the Python profiler module (which
2340 prints a detailed report of execution times, function calls, etc).
2048 2341
2049 expr = self.shell.prefilter(parameter_s,False)
2342 You can pass other options after -p which affect the behavior of the
2343 profiler itself. See the docs for %prun for details.
2050 2344
2051 # Minimum time above which compilation time will be reported
2052 tc_min = 0.1
2345 In this mode, the program's variables do NOT propagate back to the
2346 IPython interactive namespace (because they remain in the namespace
2347 where the profiler executes them).
2053 2348
2054 try:
2055 mode = 'eval'
2056 t0 = clock()
2057 code = compile(expr,'<timed eval>',mode)
2058 tc = clock()-t0
2059 except SyntaxError:
2060 mode = 'exec'
2061 t0 = clock()
2062 code = compile(expr,'<timed exec>',mode)
2063 tc = clock()-t0
2064 # skew measurement as little as possible
2065 glob = self.shell.user_ns
2066 wtime = time.time
2067 # time execution
2068 wall_st = wtime()
2069 if mode=='eval':
2070 st = clock2()
2071 out = eval(code, glob, user_locals)
2072 end = clock2()
2073 else:
2074 st = clock2()
2075 exec code in glob, user_locals
2076 end = clock2()
2077 out = None
2078 wall_end = wtime()
2079 # Compute actual times and report
2080 wall_time = wall_end-wall_st
2081 cpu_user = end[0]-st[0]
2082 cpu_sys = end[1]-st[1]
2083 cpu_tot = cpu_user+cpu_sys
2084 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2085 (cpu_user,cpu_sys,cpu_tot)
2086 print "Wall time: %.2f s" % wall_time
2087 if tc > tc_min:
2088 print "Compiler : %.2f s" % tc
2089 return out
2349 Internally this triggers a call to %prun, see its documentation for
2350 details on the options available specifically for profiling.
2090 2351
2091 @skip_doctest
2092 def magic_macro(self,parameter_s = ''):
2093 """Define a macro for future re-execution. It accepts ranges of history,
2094 filenames or string objects.
2352 There is one special usage for which the text above doesn't apply:
2353 if the filename ends with .ipy, the file is run as ipython script,
2354 just as if the commands were written on IPython prompt.
2095 2355
2096 Usage:\\
2097 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2356 -m: specify module name to load instead of script path. Similar to
2357 the -m option for the python interpreter. Use this option last if you
2358 want to combine with other %run options. Unlike the python interpreter
2359 only source modules are allowed no .pyc or .pyo files.
2360 For example::
2098 2361
2099 Options:
2362 %run -m example
2100 2363
2101 -r: use 'raw' input. By default, the 'processed' history is used,
2102 so that magics are loaded in their transformed version to valid
2103 Python. If this option is given, the raw input as typed as the
2104 command line is used instead.
2364 will run the example module.
2105 2365
2106 This will define a global variable called `name` which is a string
2107 made of joining the slices and lines you specify (n1,n2,... numbers
2108 above) from your input history into a single string. This variable
2109 acts like an automatic function which re-executes those lines as if
2110 you had typed them. You just type 'name' at the prompt and the code
2111 executes.
2366 """
2112 2367
2113 The syntax for indicating input ranges is described in %history.
2368 # get arguments and set sys.argv for program to be run.
2369 opts, arg_lst = self.parse_options(parameter_s, 'nidtN:b:pD:l:rs:T:em:',
2370 mode='list', list_all=1)
2371 if "m" in opts:
2372 modulename = opts["m"][0]
2373 modpath = find_mod(modulename)
2374 if modpath is None:
2375 warn('%r is not a valid modulename on sys.path'%modulename)
2376 return
2377 arg_lst = [modpath] + arg_lst
2378 try:
2379 filename = file_finder(arg_lst[0])
2380 except IndexError:
2381 warn('you must provide at least a filename.')
2382 print '\n%run:\n', oinspect.getdoc(self.magic_run)
2383 return
2384 except IOError as e:
2385 try:
2386 msg = str(e)
2387 except UnicodeError:
2388 msg = e.message
2389 error(msg)
2390 return
2114 2391
2115 Note: as a 'hidden' feature, you can also use traditional python slice
2116 notation, where N:M means numbers N through M-1.
2392 if filename.lower().endswith('.ipy'):
2393 self.shell.safe_execfile_ipy(filename)
2394 return
2117 2395
2118 For example, if your history contains (%hist prints it)::
2396 # Control the response to exit() calls made by the script being run
2397 exit_ignore = 'e' in opts
2119 2398
2120 44: x=1
2121 45: y=3
2122 46: z=x+y
2123 47: print x
2124 48: a=5
2125 49: print 'x',x,'y',y
2399 # Make sure that the running script gets a proper sys.argv as if it
2400 # were run from a system shell.
2401 save_argv = sys.argv # save it for later restoring
2126 2402
2127 you can create a macro with lines 44 through 47 (included) and line 49
2128 called my_macro with::
2403 # simulate shell expansion on arguments, at least tilde expansion
2404 args = [ os.path.expanduser(a) for a in arg_lst[1:] ]
2129 2405
2130 In [55]: %macro my_macro 44-47 49
2406 sys.argv = [filename] + args # put in the proper filename
2407 # protect sys.argv from potential unicode strings on Python 2:
2408 if not py3compat.PY3:
2409 sys.argv = [ py3compat.cast_bytes(a) for a in sys.argv ]
2131 2410
2132 Now, typing `my_macro` (without quotes) will re-execute all this code
2133 in one pass.
2411 if 'i' in opts:
2412 # Run in user's interactive namespace
2413 prog_ns = self.shell.user_ns
2414 __name__save = self.shell.user_ns['__name__']
2415 prog_ns['__name__'] = '__main__'
2416 main_mod = self.shell.new_main_mod(prog_ns)
2417 else:
2418 # Run in a fresh, empty namespace
2419 if 'n' in opts:
2420 name = os.path.splitext(os.path.basename(filename))[0]
2421 else:
2422 name = '__main__'
2134 2423
2135 You don't need to give the line-numbers in order, and any given line
2136 number can appear multiple times. You can assemble macros with any
2137 lines from your input history in any order.
2424 main_mod = self.shell.new_main_mod()
2425 prog_ns = main_mod.__dict__
2426 prog_ns['__name__'] = name
2138 2427
2139 The macro is a simple object which holds its value in an attribute,
2140 but IPython's display system checks for macros and executes them as
2141 code instead of printing them when you type their name.
2428 # Since '%run foo' emulates 'python foo.py' at the cmd line, we must
2429 # set the __file__ global in the script's namespace
2430 prog_ns['__file__'] = filename
2142 2431
2143 You can view a macro's contents by explicitly printing it with::
2432 # pickle fix. See interactiveshell for an explanation. But we need to make sure
2433 # that, if we overwrite __main__, we replace it at the end
2434 main_mod_name = prog_ns['__name__']
2144 2435
2145 print macro_name
2436 if main_mod_name == '__main__':
2437 restore_main = sys.modules['__main__']
2438 else:
2439 restore_main = False
2146 2440
2147 """
2148 opts,args = self.parse_options(parameter_s,'r',mode='list')
2149 if not args: # List existing macros
2150 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2151 isinstance(v, Macro))
2152 if len(args) == 1:
2153 raise UsageError(
2154 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2155 name, codefrom = args[0], " ".join(args[1:])
2441 # This needs to be undone at the end to prevent holding references to
2442 # every single object ever created.
2443 sys.modules[main_mod_name] = main_mod
2156 2444
2157 #print 'rng',ranges # dbg
2158 2445 try:
2159 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2160 except (ValueError, TypeError) as e:
2161 print e.args[0]
2446 stats = None
2447 with self.shell.readline_no_record:
2448 if 'p' in opts:
2449 stats = self.magic_prun('', 0, opts, arg_lst, prog_ns)
2450 else:
2451 if 'd' in opts:
2452 deb = debugger.Pdb(self.shell.colors)
2453 # reset Breakpoint state, which is moronically kept
2454 # in a class
2455 bdb.Breakpoint.next = 1
2456 bdb.Breakpoint.bplist = {}
2457 bdb.Breakpoint.bpbynumber = [None]
2458 # Set an initial breakpoint to stop execution
2459 maxtries = 10
2460 bp = int(opts.get('b', [1])[0])
2461 checkline = deb.checkline(filename, bp)
2462 if not checkline:
2463 for bp in range(bp + 1, bp + maxtries + 1):
2464 if deb.checkline(filename, bp):
2465 break
2466 else:
2467 msg = ("\nI failed to find a valid line to set "
2468 "a breakpoint\n"
2469 "after trying up to line: %s.\n"
2470 "Please set a valid breakpoint manually "
2471 "with the -b option." % bp)
2472 error(msg)
2473 return
2474 # if we find a good linenumber, set the breakpoint
2475 deb.do_break('%s:%s' % (filename, bp))
2476 # Start file run
2477 print "NOTE: Enter 'c' at the",
2478 print "%s prompt to start your script." % deb.prompt
2479 ns = {'execfile': py3compat.execfile, 'prog_ns': prog_ns}
2480 try:
2481 deb.run('execfile("%s", prog_ns)' % filename, ns)
2482
2483 except:
2484 etype, value, tb = sys.exc_info()
2485 # Skip three frames in the traceback: the %run one,
2486 # one inside bdb.py, and the command-line typed by the
2487 # user (run by exec in pdb itself).
2488 self.shell.InteractiveTB(etype, value, tb, tb_offset=3)
2489 else:
2490 if runner is None:
2491 runner = self.default_runner
2492 if runner is None:
2493 runner = self.shell.safe_execfile
2494 if 't' in opts:
2495 # timed execution
2496 try:
2497 nruns = int(opts['N'][0])
2498 if nruns < 1:
2499 error('Number of runs must be >=1')
2162 2500 return
2163 macro = Macro(lines)
2164 self.shell.define_macro(name, macro)
2165 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2166 print '=== Macro contents: ==='
2167 print macro,
2168
2169 def magic_save(self,parameter_s = ''):
2170 """Save a set of lines or a macro to a given filename.
2501 except (KeyError):
2502 nruns = 1
2503 twall0 = time.time()
2504 if nruns == 1:
2505 t0 = clock2()
2506 runner(filename, prog_ns, prog_ns,
2507 exit_ignore=exit_ignore)
2508 t1 = clock2()
2509 t_usr = t1[0] - t0[0]
2510 t_sys = t1[1] - t0[1]
2511 print "\nIPython CPU timings (estimated):"
2512 print " User : %10.2f s." % t_usr
2513 print " System : %10.2f s." % t_sys
2514 else:
2515 runs = range(nruns)
2516 t0 = clock2()
2517 for nr in runs:
2518 runner(filename, prog_ns, prog_ns,
2519 exit_ignore=exit_ignore)
2520 t1 = clock2()
2521 t_usr = t1[0] - t0[0]
2522 t_sys = t1[1] - t0[1]
2523 print "\nIPython CPU timings (estimated):"
2524 print "Total runs performed:", nruns
2525 print " Times : %10.2f %10.2f" % ('Total', 'Per run')
2526 print " User : %10.2f s, %10.2f s." % (t_usr, t_usr / nruns)
2527 print " System : %10.2f s, %10.2f s." % (t_sys, t_sys / nruns)
2528 twall1 = time.time()
2529 print "Wall time: %10.2f s." % (twall1 - twall0)
2171 2530
2172 Usage:\\
2173 %save [options] filename n1-n2 n3-n4 ... n5 .. n6 ...
2531 else:
2532 # regular execution
2533 runner(filename, prog_ns, prog_ns, exit_ignore=exit_ignore)
2174 2534
2175 Options:
2535 if 'i' in opts:
2536 self.shell.user_ns['__name__'] = __name__save
2537 else:
2538 # The shell MUST hold a reference to prog_ns so after %run
2539 # exits, the python deletion mechanism doesn't zero it out
2540 # (leaving dangling references).
2541 self.shell.cache_main_mod(prog_ns, filename)
2542 # update IPython interactive namespace
2176 2543
2177 -r: use 'raw' input. By default, the 'processed' history is used,
2178 so that magics are loaded in their transformed version to valid
2179 Python. If this option is given, the raw input as typed as the
2180 command line is used instead.
2544 # Some forms of read errors on the file may mean the
2545 # __name__ key was never set; using pop we don't have to
2546 # worry about a possible KeyError.
2547 prog_ns.pop('__name__', None)
2181 2548
2182 This function uses the same syntax as %history for input ranges,
2183 then saves the lines to the filename you specify.
2549 self.shell.user_ns.update(prog_ns)
2550 finally:
2551 # It's a bit of a mystery why, but __builtins__ can change from
2552 # being a module to becoming a dict missing some key data after
2553 # %run. As best I can see, this is NOT something IPython is doing
2554 # at all, and similar problems have been reported before:
2555 # http://coding.derkeiler.com/Archive/Python/comp.lang.python/2004-10/0188.html
2556 # Since this seems to be done by the interpreter itself, the best
2557 # we can do is to at least restore __builtins__ for the user on
2558 # exit.
2559 self.shell.user_ns['__builtins__'] = builtin_mod
2184 2560
2185 It adds a '.py' extension to the file if you don't do so yourself, and
2186 it asks for confirmation before overwriting existing files."""
2561 # Ensure key global structures are restored
2562 sys.argv = save_argv
2563 if restore_main:
2564 sys.modules['__main__'] = restore_main
2565 else:
2566 # Remove from sys.modules the reference to main_mod we'd
2567 # added. Otherwise it will trap references to objects
2568 # contained therein.
2569 del sys.modules[main_mod_name]
2187 2570
2188 opts,args = self.parse_options(parameter_s,'r',mode='list')
2189 fname, codefrom = unquote_filename(args[0]), " ".join(args[1:])
2190 if not fname.endswith('.py'):
2191 fname += '.py'
2192 if os.path.isfile(fname):
2193 overwrite = self.shell.ask_yes_no('File `%s` exists. Overwrite (y/[N])? ' % fname, default='n')
2194 if not overwrite :
2195 print 'Operation cancelled.'
2196 return
2197 try:
2198 cmds = self.shell.find_user_code(codefrom, 'r' in opts)
2199 except (TypeError, ValueError) as e:
2200 print e.args[0]
2201 return
2202 with io.open(fname,'w', encoding="utf-8") as f:
2203 f.write(u"# coding: utf-8\n")
2204 f.write(py3compat.cast_unicode(cmds))
2205 print 'The following commands were written to file `%s`:' % fname
2206 print cmds
2571 return stats
2207 2572
2208 def magic_pastebin(self, parameter_s = ''):
2209 """Upload code to Github's Gist paste bin, returning the URL.
2573 @skip_doctest
2574 def magic_timeit(self, parameter_s =''):
2575 """Time execution of a Python statement or expression
2210 2576
2211 2577 Usage:\\
2212 %pastebin [-d "Custom description"] 1-7
2578 %timeit [-n<N> -r<R> [-t|-c]] statement
2213 2579
2214 The argument can be an input history range, a filename, or the name of a
2215 string or macro.
2580 Time execution of a Python statement or expression using the timeit
2581 module.
2216 2582
2217 2583 Options:
2584 -n<N>: execute the given statement <N> times in a loop. If this value
2585 is not given, a fitting value is chosen.
2218 2586
2219 -d: Pass a custom description for the gist. The default will say
2220 "Pasted from IPython".
2221 """
2222 opts, args = self.parse_options(parameter_s, 'd:')
2223
2224 try:
2225 code = self.shell.find_user_code(args)
2226 except (ValueError, TypeError) as e:
2227 print e.args[0]
2228 return
2229
2230 post_data = json.dumps({
2231 "description": opts.get('d', "Pasted from IPython"),
2232 "public": True,
2233 "files": {
2234 "file1.py": {
2235 "content": code
2236 }
2237 }
2238 }).encode('utf-8')
2239
2240 response = urlopen("https://api.github.com/gists", post_data)
2241 response_data = json.loads(response.read().decode('utf-8'))
2242 return response_data['html_url']
2243
2244 def magic_loadpy(self, arg_s):
2245 """Alias of `%load`
2587 -r<R>: repeat the loop iteration <R> times and take the best result.
2588 Default: 3
2246 2589
2247 `%loadpy` has gained some flexibility and droped the requirement of a `.py`
2248 extension. So it has been renamed simply into %load. You can look at
2249 `%load`'s docstring for more info.
2250 """
2251 self.magic_load(arg_s)
2590 -t: use time.time to measure the time, which is the default on Unix.
2591 This function measures wall time.
2252 2592
2253 def magic_load(self, arg_s):
2254 """Load code into the current frontend.
2593 -c: use time.clock to measure the time, which is the default on
2594 Windows and measures wall time. On Unix, resource.getrusage is used
2595 instead and returns the CPU user time.
2255 2596
2256 Usage:\\
2257 %load [options] source
2597 -p<P>: use a precision of <P> digits to display the timing result.
2598 Default: 3
2258 2599
2259 where source can be a filename, URL, input history range or macro
2260 2600
2261 Options:
2601 Examples
2262 2602 --------
2263 -y : Don't ask confirmation for loading source above 200 000 characters.
2264
2265 This magic command can either take a local filename, a URL, an history
2266 range (see %history) or a macro as argument, it will prompt for
2267 confirmation before loading source with more than 200 000 characters, unless
2268 -y flag is passed or if the frontend does not support raw_input::
2269
2270 %load myscript.py
2271 %load 7-27
2272 %load myMacro
2273 %load http://www.example.com/myscript.py
2274 """
2275 opts,args = self.parse_options(arg_s,'y')
2276
2277 contents = self.shell.find_user_code(args)
2278 l = len(contents)
2279
2280 # 200 000 is ~ 2500 full 80 caracter lines
2281 # so in average, more than 5000 lines
2282 if l > 200000 and 'y' not in opts:
2283 try:
2284 ans = self.shell.ask_yes_no(("The text you're trying to load seems pretty big"\
2285 " (%d characters). Continue (y/[N]) ?" % l), default='n' )
2286 except StdinNotImplementedError:
2287 #asume yes if raw input not implemented
2288 ans = True
2289
2290 if ans is False :
2291 print 'Operation cancelled.'
2292 return
2603 ::
2293 2604
2294 self.set_next_input(contents)
2605 In [1]: %timeit pass
2606 10000000 loops, best of 3: 53.3 ns per loop
2295 2607
2296 def _find_edit_target(self, args, opts, last_call):
2297 """Utility method used by magic_edit to find what to edit."""
2608 In [2]: u = None
2298 2609
2299 def make_filename(arg):
2300 "Make a filename from the given args"
2301 arg = unquote_filename(arg)
2302 try:
2303 filename = get_py_filename(arg)
2304 except IOError:
2305 # If it ends with .py but doesn't already exist, assume we want
2306 # a new file.
2307 if arg.endswith('.py'):
2308 filename = arg
2309 else:
2310 filename = None
2311 return filename
2610 In [3]: %timeit u is None
2611 10000000 loops, best of 3: 184 ns per loop
2312 2612
2313 # Set a few locals from the options for convenience:
2314 opts_prev = 'p' in opts
2315 opts_raw = 'r' in opts
2613 In [4]: %timeit -r 4 u == None
2614 1000000 loops, best of 4: 242 ns per loop
2316 2615
2317 # custom exceptions
2318 class DataIsObject(Exception): pass
2616 In [5]: import time
2319 2617
2320 # Default line number value
2321 lineno = opts.get('n',None)
2618 In [6]: %timeit -n1 time.sleep(2)
2619 1 loops, best of 3: 2 s per loop
2322 2620
2323 if opts_prev:
2324 args = '_%s' % last_call[0]
2325 if not self.shell.user_ns.has_key(args):
2326 args = last_call[1]
2327 2621
2328 # use last_call to remember the state of the previous call, but don't
2329 # let it be clobbered by successive '-p' calls.
2330 try:
2331 last_call[0] = self.shell.displayhook.prompt_count
2332 if not opts_prev:
2333 last_call[1] = args
2334 except:
2335 pass
2622 The times reported by %timeit will be slightly higher than those
2623 reported by the timeit.py script when variables are accessed. This is
2624 due to the fact that %timeit executes the statement in the namespace
2625 of the shell, compared with timeit.py, which uses a single setup
2626 statement to import function or create variables. Generally, the bias
2627 does not matter as long as results from timeit.py are not mixed with
2628 those from %timeit."""
2336 2629
2337 # by default this is done with temp files, except when the given
2338 # arg is a filename
2339 use_temp = True
2630 import timeit
2631 import math
2340 2632
2341 data = ''
2633 # XXX: Unfortunately the unicode 'micro' symbol can cause problems in
2634 # certain terminals. Until we figure out a robust way of
2635 # auto-detecting if the terminal can deal with it, use plain 'us' for
2636 # microseconds. I am really NOT happy about disabling the proper
2637 # 'micro' prefix, but crashing is worse... If anyone knows what the
2638 # right solution for this is, I'm all ears...
2639 #
2640 # Note: using
2641 #
2642 # s = u'\xb5'
2643 # s.encode(sys.getdefaultencoding())
2644 #
2645 # is not sufficient, as I've seen terminals where that fails but
2646 # print s
2647 #
2648 # succeeds
2649 #
2650 # See bug: https://bugs.launchpad.net/ipython/+bug/348466
2342 2651
2343 # First, see if the arguments should be a filename.
2344 filename = make_filename(args)
2345 if filename:
2346 use_temp = False
2347 elif args:
2348 # Mode where user specifies ranges of lines, like in %macro.
2349 data = self.shell.extract_input_lines(args, opts_raw)
2350 if not data:
2351 try:
2352 # Load the parameter given as a variable. If not a string,
2353 # process it as an object instead (below)
2652 #units = [u"s", u"ms",u'\xb5',"ns"]
2653 units = [u"s", u"ms",u'us',"ns"]
2354 2654
2355 #print '*** args',args,'type',type(args) # dbg
2356 data = eval(args, self.shell.user_ns)
2357 if not isinstance(data, basestring):
2358 raise DataIsObject
2655 scaling = [1, 1e3, 1e6, 1e9]
2359 2656
2360 except (NameError,SyntaxError):
2361 # given argument is not a variable, try as a filename
2362 filename = make_filename(args)
2363 if filename is None:
2364 warn("Argument given (%s) can't be found as a variable "
2365 "or as a filename." % args)
2657 opts, stmt = self.parse_options(parameter_s,'n:r:tcp:',
2658 posix=False, strict=False)
2659 if stmt == "":
2366 2660 return
2367 use_temp = False
2368
2369 except DataIsObject:
2370 # macros have a special edit function
2371 if isinstance(data, Macro):
2372 raise MacroToEdit(data)
2661 timefunc = timeit.default_timer
2662 number = int(getattr(opts, "n", 0))
2663 repeat = int(getattr(opts, "r", timeit.default_repeat))
2664 precision = int(getattr(opts, "p", 3))
2665 if hasattr(opts, "t"):
2666 timefunc = time.time
2667 if hasattr(opts, "c"):
2668 timefunc = clock
2373 2669
2374 # For objects, try to edit the file where they are defined
2375 try:
2376 filename = inspect.getabsfile(data)
2377 if 'fakemodule' in filename.lower() and inspect.isclass(data):
2378 # class created by %edit? Try to find source
2379 # by looking for method definitions instead, the
2380 # __module__ in those classes is FakeModule.
2381 attrs = [getattr(data, aname) for aname in dir(data)]
2382 for attr in attrs:
2383 if not inspect.ismethod(attr):
2384 continue
2385 filename = inspect.getabsfile(attr)
2386 if filename and 'fakemodule' not in filename.lower():
2387 # change the attribute to be the edit target instead
2388 data = attr
2389 break
2670 timer = timeit.Timer(timer=timefunc)
2671 # this code has tight coupling to the inner workings of timeit.Timer,
2672 # but is there a better way to achieve that the code stmt has access
2673 # to the shell namespace?
2390 2674
2391 datafile = 1
2392 except TypeError:
2393 filename = make_filename(args)
2394 datafile = 1
2395 warn('Could not find file where `%s` is defined.\n'
2396 'Opening a file named `%s`' % (args,filename))
2397 # Now, make sure we can actually read the source (if it was in
2398 # a temp file it's gone by now).
2399 if datafile:
2400 try:
2401 if lineno is None:
2402 lineno = inspect.getsourcelines(data)[1]
2403 except IOError:
2404 filename = make_filename(args)
2405 if filename is None:
2406 warn('The file `%s` where `%s` was defined cannot '
2407 'be read.' % (filename,data))
2408 return
2409 use_temp = False
2675 src = timeit.template % {'stmt': timeit.reindent(stmt, 8),
2676 'setup': "pass"}
2677 # Track compilation time so it can be reported if too long
2678 # Minimum time above which compilation time will be reported
2679 tc_min = 0.1
2410 2680
2411 if use_temp:
2412 filename = self.shell.mktempfile(data)
2413 print 'IPython will make a temporary file named:',filename
2681 t0 = clock()
2682 code = compile(src, "<magic-timeit>", "exec")
2683 tc = clock()-t0
2414 2684
2415 return filename, lineno, use_temp
2685 ns = {}
2686 exec code in self.shell.user_ns, ns
2687 timer.inner = ns["inner"]
2416 2688
2417 def _edit_macro(self,mname,macro):
2418 """open an editor with the macro data in a file"""
2419 filename = self.shell.mktempfile(macro.value)
2420 self.shell.hooks.editor(filename)
2689 if number == 0:
2690 # determine number so that 0.2 <= total time < 2.0
2691 number = 1
2692 for i in range(1, 10):
2693 if timer.timeit(number) >= 0.2:
2694 break
2695 number *= 10
2421 2696
2422 # and make a new macro object, to replace the old one
2423 mfile = open(filename)
2424 mvalue = mfile.read()
2425 mfile.close()
2426 self.shell.user_ns[mname] = Macro(mvalue)
2697 best = min(timer.repeat(repeat, number)) / number
2427 2698
2428 def magic_ed(self,parameter_s=''):
2429 """Alias to %edit."""
2430 return self.magic_edit(parameter_s)
2699 if best > 0.0 and best < 1000.0:
2700 order = min(-int(math.floor(math.log10(best)) // 3), 3)
2701 elif best >= 1000.0:
2702 order = 0
2703 else:
2704 order = 3
2705 print u"%d loops, best of %d: %.*g %s per loop" % (number, repeat,
2706 precision,
2707 best * scaling[order],
2708 units[order])
2709 if tc > tc_min:
2710 print "Compiler time: %.2f s" % tc
2431 2711
2432 2712 @skip_doctest
2433 def magic_edit(self,parameter_s='',last_call=['','']):
2434 """Bring up an editor and execute the resulting code.
2435
2436 Usage:
2437 %edit [options] [args]
2438
2439 %edit runs IPython's editor hook. The default version of this hook is
2440 set to call the editor specified by your $EDITOR environment variable.
2441 If this isn't found, it will default to vi under Linux/Unix and to
2442 notepad under Windows. See the end of this docstring for how to change
2443 the editor hook.
2444
2445 You can also set the value of this editor via the
2446 ``TerminalInteractiveShell.editor`` option in your configuration file.
2447 This is useful if you wish to use a different editor from your typical
2448 default with IPython (and for Windows users who typically don't set
2449 environment variables).
2713 @needs_local_scope
2714 def magic_time(self,parameter_s, user_locals):
2715 """Time execution of a Python statement or expression.
2450 2716
2451 This command allows you to conveniently edit multi-line code right in
2452 your IPython session.
2717 The CPU and wall clock times are printed, and the value of the
2718 expression (if any) is returned. Note that under Win32, system time
2719 is always reported as 0, since it can not be measured.
2453 2720
2454 If called without arguments, %edit opens up an empty editor with a
2455 temporary file and will execute the contents of this file when you
2456 close it (don't forget to save it!).
2721 This function provides very basic timing functionality. In Python
2722 2.3, the timeit module offers more control and sophistication, so this
2723 could be rewritten to use it (patches welcome).
2457 2724
2725 Examples
2726 --------
2727 ::
2458 2728
2459 Options:
2729 In [1]: time 2**128
2730 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2731 Wall time: 0.00
2732 Out[1]: 340282366920938463463374607431768211456L
2460 2733
2461 -n <number>: open the editor at a specified line number. By default,
2462 the IPython editor hook uses the unix syntax 'editor +N filename', but
2463 you can configure this by providing your own modified hook if your
2464 favorite editor supports line-number specifications with a different
2465 syntax.
2734 In [2]: n = 1000000
2466 2735
2467 -p: this will call the editor with the same data as the previous time
2468 it was used, regardless of how long ago (in your current session) it
2469 was.
2736 In [3]: time sum(range(n))
2737 CPU times: user 1.20 s, sys: 0.05 s, total: 1.25 s
2738 Wall time: 1.37
2739 Out[3]: 499999500000L
2470 2740
2471 -r: use 'raw' input. This option only applies to input taken from the
2472 user's history. By default, the 'processed' history is used, so that
2473 magics are loaded in their transformed version to valid Python. If
2474 this option is given, the raw input as typed as the command line is
2475 used instead. When you exit the editor, it will be executed by
2476 IPython's own processor.
2741 In [4]: time print 'hello world'
2742 hello world
2743 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2744 Wall time: 0.00
2477 2745
2478 -x: do not execute the edited code immediately upon exit. This is
2479 mainly useful if you are editing programs which need to be called with
2480 command line arguments, which you can then do using %run.
2746 Note that the time needed by Python to compile the given expression
2747 will be reported if it is more than 0.1s. In this example, the
2748 actual exponentiation is done by Python at compilation time, so while
2749 the expression can take a noticeable amount of time to compute, that
2750 time is purely due to the compilation:
2481 2751
2752 In [5]: time 3**9999;
2753 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2754 Wall time: 0.00 s
2482 2755
2483 Arguments:
2756 In [6]: time 3**999999;
2757 CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
2758 Wall time: 0.00 s
2759 Compiler : 0.78 s
2760 """
2484 2761
2485 If arguments are given, the following possibilities exist:
2762 # fail immediately if the given expression can't be compiled
2486 2763
2487 - If the argument is a filename, IPython will load that into the
2488 editor. It will execute its contents with execfile() when you exit,
2489 loading any code in the file into your interactive namespace.
2764 expr = self.shell.prefilter(parameter_s,False)
2490 2765
2491 - The arguments are ranges of input history, e.g. "7 ~1/4-6".
2492 The syntax is the same as in the %history magic.
2766 # Minimum time above which compilation time will be reported
2767 tc_min = 0.1
2493 2768
2494 - If the argument is a string variable, its contents are loaded
2495 into the editor. You can thus edit any string which contains
2496 python code (including the result of previous edits).
2769 try:
2770 mode = 'eval'
2771 t0 = clock()
2772 code = compile(expr,'<timed eval>',mode)
2773 tc = clock()-t0
2774 except SyntaxError:
2775 mode = 'exec'
2776 t0 = clock()
2777 code = compile(expr,'<timed exec>',mode)
2778 tc = clock()-t0
2779 # skew measurement as little as possible
2780 glob = self.shell.user_ns
2781 wtime = time.time
2782 # time execution
2783 wall_st = wtime()
2784 if mode=='eval':
2785 st = clock2()
2786 out = eval(code, glob, user_locals)
2787 end = clock2()
2788 else:
2789 st = clock2()
2790 exec code in glob, user_locals
2791 end = clock2()
2792 out = None
2793 wall_end = wtime()
2794 # Compute actual times and report
2795 wall_time = wall_end-wall_st
2796 cpu_user = end[0]-st[0]
2797 cpu_sys = end[1]-st[1]
2798 cpu_tot = cpu_user+cpu_sys
2799 print "CPU times: user %.2f s, sys: %.2f s, total: %.2f s" % \
2800 (cpu_user,cpu_sys,cpu_tot)
2801 print "Wall time: %.2f s" % wall_time
2802 if tc > tc_min:
2803 print "Compiler : %.2f s" % tc
2804 return out
2497 2805
2498 - If the argument is the name of an object (other than a string),
2499 IPython will try to locate the file where it was defined and open the
2500 editor at the point where it is defined. You can use `%edit function`
2501 to load an editor exactly at the point where 'function' is defined,
2502 edit it and have the file be executed automatically.
2806 @skip_doctest
2807 def magic_macro(self,parameter_s = ''):
2808 """Define a macro for future re-execution. It accepts ranges of history,
2809 filenames or string objects.
2503 2810
2504 - If the object is a macro (see %macro for details), this opens up your
2505 specified editor with a temporary file containing the macro's data.
2506 Upon exit, the macro is reloaded with the contents of the file.
2811 Usage:\\
2812 %macro [options] name n1-n2 n3-n4 ... n5 .. n6 ...
2507 2813
2508 Note: opening at an exact line is only supported under Unix, and some
2509 editors (like kedit and gedit up to Gnome 2.8) do not understand the
2510 '+NUMBER' parameter necessary for this feature. Good editors like
2511 (X)Emacs, vi, jed, pico and joe all do.
2814 Options:
2512 2815
2513 After executing your code, %edit will return as output the code you
2514 typed in the editor (except when it was an existing file). This way
2515 you can reload the code in further invocations of %edit as a variable,
2516 via _<NUMBER> or Out[<NUMBER>], where <NUMBER> is the prompt number of
2517 the output.
2816 -r: use 'raw' input. By default, the 'processed' history is used,
2817 so that magics are loaded in their transformed version to valid
2818 Python. If this option is given, the raw input as typed as the
2819 command line is used instead.
2518 2820
2519 Note that %edit is also available through the alias %ed.
2821 This will define a global variable called `name` which is a string
2822 made of joining the slices and lines you specify (n1,n2,... numbers
2823 above) from your input history into a single string. This variable
2824 acts like an automatic function which re-executes those lines as if
2825 you had typed them. You just type 'name' at the prompt and the code
2826 executes.
2520 2827
2521 This is an example of creating a simple function inside the editor and
2522 then modifying it. First, start up the editor::
2828 The syntax for indicating input ranges is described in %history.
2523 2829
2524 In [1]: ed
2525 Editing... done. Executing edited code...
2526 Out[1]: 'def foo():\\n print "foo() was defined in an editing
2527 session"\\n'
2830 Note: as a 'hidden' feature, you can also use traditional python slice
2831 notation, where N:M means numbers N through M-1.
2528 2832
2529 We can then call the function foo()::
2833 For example, if your history contains (%hist prints it)::
2530 2834
2531 In [2]: foo()
2532 foo() was defined in an editing session
2835 44: x=1
2836 45: y=3
2837 46: z=x+y
2838 47: print x
2839 48: a=5
2840 49: print 'x',x,'y',y
2533 2841
2534 Now we edit foo. IPython automatically loads the editor with the
2535 (temporary) file where foo() was previously defined::
2842 you can create a macro with lines 44 through 47 (included) and line 49
2843 called my_macro with::
2536 2844
2537 In [3]: ed foo
2538 Editing... done. Executing edited code...
2845 In [55]: %macro my_macro 44-47 49
2539 2846
2540 And if we call foo() again we get the modified version::
2847 Now, typing `my_macro` (without quotes) will re-execute all this code
2848 in one pass.
2541 2849
2542 In [4]: foo()
2543 foo() has now been changed!
2850 You don't need to give the line-numbers in order, and any given line
2851 number can appear multiple times. You can assemble macros with any
2852 lines from your input history in any order.
2544 2853
2545 Here is an example of how to edit a code snippet successive
2546 times. First we call the editor::
2854 The macro is a simple object which holds its value in an attribute,
2855 but IPython's display system checks for macros and executes them as
2856 code instead of printing them when you type their name.
2547 2857
2548 In [5]: ed
2549 Editing... done. Executing edited code...
2550 hello
2551 Out[5]: "print 'hello'\\n"
2858 You can view a macro's contents by explicitly printing it with::
2552 2859
2553 Now we call it again with the previous output (stored in _)::
2860 print macro_name
2554 2861
2555 In [6]: ed _
2556 Editing... done. Executing edited code...
2557 hello world
2558 Out[6]: "print 'hello world'\\n"
2862 """
2863 opts,args = self.parse_options(parameter_s,'r',mode='list')
2864 if not args: # List existing macros
2865 return sorted(k for k,v in self.shell.user_ns.iteritems() if\
2866 isinstance(v, Macro))
2867 if len(args) == 1:
2868 raise UsageError(
2869 "%macro insufficient args; usage '%macro name n1-n2 n3-4...")
2870 name, codefrom = args[0], " ".join(args[1:])
2559 2871
2560 Now we call it with the output #8 (stored in _8, also as Out[8])::
2872 #print 'rng',ranges # dbg
2873 try:
2874 lines = self.shell.find_user_code(codefrom, 'r' in opts)
2875 except (ValueError, TypeError) as e:
2876 print e.args[0]
2877 return
2878 macro = Macro(lines)
2879 self.shell.define_macro(name, macro)
2880 print 'Macro `%s` created. To execute, type its name (without quotes).' % name
2881 print '=== Macro contents: ==='
2882 print macro,
2561 2883
2562 In [7]: ed _8
2563 Editing... done. Executing edited code...
2564 hello again
2565 Out[7]: "print 'hello again'\\n"
2566 2884
2885 class AutoMagics(MagicFunctions):
2886 """Magics that control various autoX behaviors."""
2567 2887
2568 Changing the default editor hook:
2888 def __init__(self, shell):
2889 super(ProfileMagics, self).__init__(shell)
2890 # namespace for holding state we may need
2891 self._magic_state = Bunch()
2569 2892
2570 If you wish to write your own editor hook, you can put it in a
2571 configuration file which you load at startup time. The default hook
2572 is defined in the IPython.core.hooks module, and you can use that as a
2573 starting example for further modifications. That file also has
2574 general instructions on how to set a new hook for use once you've
2575 defined it."""
2576 opts,args = self.parse_options(parameter_s,'prxn:')
2893 def magic_automagic(self, parameter_s = ''):
2894 """Make magic functions callable without having to type the initial %.
2577 2895
2578 try:
2579 filename, lineno, is_temp = self._find_edit_target(args, opts, last_call)
2580 except MacroToEdit as e:
2581 self._edit_macro(args, e.args[0])
2582 return
2896 Without argumentsl toggles on/off (when off, you must call it as
2897 %automagic, of course). With arguments it sets the value, and you can
2898 use any of (case insensitive):
2583 2899
2584 # do actual editing here
2585 print 'Editing...',
2586 sys.stdout.flush()
2587 try:
2588 # Quote filenames that may have spaces in them
2589 if ' ' in filename:
2590 filename = "'%s'" % filename
2591 self.shell.hooks.editor(filename,lineno)
2592 except TryNext:
2593 warn('Could not open editor')
2594 return
2900 - on,1,True: to activate
2595 2901
2596 # XXX TODO: should this be generalized for all string vars?
2597 # For now, this is special-cased to blocks created by cpaste
2598 if args.strip() == 'pasted_block':
2599 self.shell.user_ns['pasted_block'] = file_read(filename)
2902 - off,0,False: to deactivate.
2600 2903
2601 if 'x' in opts: # -x prevents actual execution
2602 print
2603 else:
2604 print 'done. Executing edited code...'
2605 if 'r' in opts: # Untranslated IPython code
2606 self.shell.run_cell(file_read(filename),
2607 store_history=False)
2608 else:
2609 self.shell.safe_execfile(filename, self.shell.user_ns,
2610 self.shell.user_ns)
2904 Note that magic functions have lowest priority, so if there's a
2905 variable whose name collides with that of a magic fn, automagic won't
2906 work for that function (you get the variable instead). However, if you
2907 delete the variable (del var), the previously shadowed magic function
2908 becomes visible to automagic again."""
2611 2909
2612 if is_temp:
2613 try:
2614 return open(filename).read()
2615 except IOError,msg:
2616 if msg.filename == filename:
2617 warn('File not found. Did you forget to save?')
2618 return
2910 arg = parameter_s.lower()
2911 if parameter_s in ('on','1','true'):
2912 self.shell.automagic = True
2913 elif parameter_s in ('off','0','false'):
2914 self.shell.automagic = False
2619 2915 else:
2620 self.shell.showtraceback()
2621
2622 def magic_xmode(self,parameter_s = ''):
2623 """Switch modes for the exception handlers.
2916 self.shell.automagic = not self.shell.automagic
2917 print '\n' + Magic.auto_status[self.shell.automagic]
2624 2918
2625 Valid modes: Plain, Context and Verbose.
2919 @skip_doctest
2920 def magic_autocall(self, parameter_s = ''):
2921 """Make functions callable without having to type parentheses.
2626 2922
2627 If called without arguments, acts as a toggle."""
2923 Usage:
2628 2924
2629 def xmode_switch_err(name):
2630 warn('Error changing %s exception modes.\n%s' %
2631 (name,sys.exc_info()[1]))
2925 %autocall [mode]
2632 2926
2633 shell = self.shell
2634 new_mode = parameter_s.strip().capitalize()
2635 try:
2636 shell.InteractiveTB.set_mode(mode=new_mode)
2637 print 'Exception reporting mode:',shell.InteractiveTB.mode
2638 except:
2639 xmode_switch_err('user')
2927 The mode can be one of: 0->Off, 1->Smart, 2->Full. If not given, the
2928 value is toggled on and off (remembering the previous state).
2640 2929
2641 def magic_colors(self,parameter_s = ''):
2642 """Switch color scheme for prompts, info system and exception handlers.
2930 In more detail, these values mean:
2643 2931
2644 Currently implemented schemes: NoColor, Linux, LightBG.
2932 0 -> fully disabled
2645 2933
2646 Color scheme names are not case-sensitive.
2934 1 -> active, but do not apply if there are no arguments on the line.
2647 2935
2648 Examples
2649 --------
2650 To get a plain black and white terminal::
2936 In this mode, you get::
2651 2937
2652 %colors nocolor
2653 """
2938 In [1]: callable
2939 Out[1]: <built-in function callable>
2654 2940
2655 def color_switch_err(name):
2656 warn('Error changing %s color schemes.\n%s' %
2657 (name,sys.exc_info()[1]))
2941 In [2]: callable 'hello'
2942 ------> callable('hello')
2943 Out[2]: False
2658 2944
2945 2 -> Active always. Even if no arguments are present, the callable
2946 object is called::
2659 2947
2660 new_scheme = parameter_s.strip()
2661 if not new_scheme:
2662 raise UsageError(
2663 "%colors: you must specify a color scheme. See '%colors?'")
2664 return
2665 # local shortcut
2666 shell = self.shell
2948 In [2]: float
2949 ------> float()
2950 Out[2]: 0.0
2667 2951
2668 import IPython.utils.rlineimpl as readline
2952 Note that even with autocall off, you can still use '/' at the start of
2953 a line to treat the first argument on the command line as a function
2954 and add parentheses to it::
2669 2955
2670 if not shell.colors_force and \
2671 not readline.have_readline and sys.platform == "win32":
2672 msg = """\
2673 Proper color support under MS Windows requires the pyreadline library.
2674 You can find it at:
2675 http://ipython.org/pyreadline.html
2676 Gary's readline needs the ctypes module, from:
2677 http://starship.python.net/crew/theller/ctypes
2678 (Note that ctypes is already part of Python versions 2.5 and newer).
2956 In [8]: /str 43
2957 ------> str(43)
2958 Out[8]: '43'
2679 2959
2680 Defaulting color scheme to 'NoColor'"""
2681 new_scheme = 'NoColor'
2682 warn(msg)
2960 # all-random (note for auto-testing)
2961 """
2683 2962
2684 # readline option is 0
2685 if not shell.colors_force and not shell.has_readline:
2686 new_scheme = 'NoColor'
2963 if parameter_s:
2964 arg = int(parameter_s)
2965 else:
2966 arg = 'toggle'
2687 2967
2688 # Set prompt colors
2689 try:
2690 shell.prompt_manager.color_scheme = new_scheme
2691 except:
2692 color_switch_err('prompt')
2968 if not arg in (0,1,2,'toggle'):
2969 error('Valid modes: (0->Off, 1->Smart, 2->Full')
2970 return
2971
2972 if arg in (0,1,2):
2973 self.shell.autocall = arg
2974 else: # toggle
2975 if self.shell.autocall:
2976 self._magic_state.autocall_save = self.shell.autocall
2977 self.shell.autocall = 0
2693 2978 else:
2694 shell.colors = \
2695 shell.prompt_manager.color_scheme_table.active_scheme_name
2696 # Set exception colors
2697 2979 try:
2698 shell.InteractiveTB.set_colors(scheme = new_scheme)
2699 shell.SyntaxTB.set_colors(scheme = new_scheme)
2700 except:
2701 color_switch_err('exception')
2980 self.shell.autocall = self._magic_state.autocall_save
2981 except AttributeError:
2982 self.shell.autocall = self._magic_state.autocall_save = 1
2702 2983
2703 # Set info (for 'object?') colors
2704 if shell.color_info:
2705 try:
2706 shell.inspector.set_active_scheme(new_scheme)
2707 except:
2708 color_switch_err('object inspector')
2709 else:
2710 shell.inspector.set_active_scheme('NoColor')
2984 print "Automatic calling is:",['OFF','Smart','Full'][self.shell.autocall]
2711 2985
2712 def magic_pprint(self, parameter_s=''):
2713 """Toggle pretty printing on/off."""
2714 ptformatter = self.shell.display_formatter.formatters['text/plain']
2715 ptformatter.pprint = bool(1 - ptformatter.pprint)
2716 print 'Pretty printing has been turned', \
2717 ['OFF','ON'][ptformatter.pprint]
2718 2986
2719 #......................................................................
2720 # Functions to implement unix shell-type things
2987 class OSMagics(MagicFunctions):
2988 """Magics to interact with the underlying OS (shell-type functionality).
2989 """
2721 2990
2722 2991 @skip_doctest
2723 2992 def magic_alias(self, parameter_s = ''):
@@ -3345,133 +3614,146 b' Defaulting color scheme to \'NoColor\'"""'
3345 3614
3346 3615 page.page(self.shell.pycolorize(cont))
3347 3616
3348 def magic_quickref(self,arg):
3349 """ Show a quick reference sheet """
3350 import IPython.core.usage
3351 qr = IPython.core.usage.quick_reference + self.magic_magic('-brief')
3352 3617
3353 page.page(qr)
3618 class LoggingMagics(MagicFunctions):
3619 """Magics related to all logging machinery."""
3620 def magic_logstart(self,parameter_s=''):
3621 """Start logging anywhere in a session.
3354 3622
3355 def magic_doctest_mode(self,parameter_s=''):
3356 """Toggle doctest mode on and off.
3623 %logstart [-o|-r|-t] [log_name [log_mode]]
3357 3624
3358 This mode is intended to make IPython behave as much as possible like a
3359 plain Python shell, from the perspective of how its prompts, exceptions
3360 and output look. This makes it easy to copy and paste parts of a
3361 session into doctests. It does so by:
3625 If no name is given, it defaults to a file named 'ipython_log.py' in your
3626 current directory, in 'rotate' mode (see below).
3362 3627
3363 - Changing the prompts to the classic ``>>>`` ones.
3364 - Changing the exception reporting mode to 'Plain'.
3365 - Disabling pretty-printing of output.
3628 '%logstart name' saves to file 'name' in 'backup' mode. It saves your
3629 history up to that point and then continues logging.
3366 3630
3367 Note that IPython also supports the pasting of code snippets that have
3368 leading '>>>' and '...' prompts in them. This means that you can paste
3369 doctests from files or docstrings (even if they have leading
3370 whitespace), and the code will execute correctly. You can then use
3371 '%history -t' to see the translated history; this will give you the
3372 input after removal of all the leading prompts and whitespace, which
3373 can be pasted back into an editor.
3631 %logstart takes a second optional parameter: logging mode. This can be one
3632 of (note that the modes are given unquoted):\\
3633 append: well, that says it.\\
3634 backup: rename (if exists) to name~ and start name.\\
3635 global: single logfile in your home dir, appended to.\\
3636 over : overwrite existing log.\\
3637 rotate: create rotating logs name.1~, name.2~, etc.
3374 3638
3375 With these features, you can switch into this mode easily whenever you
3376 need to do testing and changes to doctests, without having to leave
3377 your existing IPython session.
3378 """
3639 Options:
3379 3640
3380 from IPython.utils.ipstruct import Struct
3641 -o: log also IPython's output. In this mode, all commands which
3642 generate an Out[NN] prompt are recorded to the logfile, right after
3643 their corresponding input line. The output lines are always
3644 prepended with a '#[Out]# ' marker, so that the log remains valid
3645 Python code.
3381 3646
3382 # Shorthands
3383 shell = self.shell
3384 pm = shell.prompt_manager
3385 meta = shell.meta
3386 disp_formatter = self.shell.display_formatter
3387 ptformatter = disp_formatter.formatters['text/plain']
3388 # dstore is a data store kept in the instance metadata bag to track any
3389 # changes we make, so we can undo them later.
3390 dstore = meta.setdefault('doctest_mode',Struct())
3391 save_dstore = dstore.setdefault
3647 Since this marker is always the same, filtering only the output from
3648 a log is very easy, using for example a simple awk call::
3392 3649
3393 # save a few values we'll need to recover later
3394 mode = save_dstore('mode',False)
3395 save_dstore('rc_pprint',ptformatter.pprint)
3396 save_dstore('xmode',shell.InteractiveTB.mode)
3397 save_dstore('rc_separate_out',shell.separate_out)
3398 save_dstore('rc_separate_out2',shell.separate_out2)
3399 save_dstore('rc_prompts_pad_left',pm.justify)
3400 save_dstore('rc_separate_in',shell.separate_in)
3401 save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
3402 save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
3650 awk -F'#\\[Out\\]# ' '{if($2) {print $2}}' ipython_log.py
3403 3651
3404 if mode == False:
3405 # turn on
3406 pm.in_template = '>>> '
3407 pm.in2_template = '... '
3408 pm.out_template = ''
3652 -r: log 'raw' input. Normally, IPython's logs contain the processed
3653 input, so that user lines are logged in their final form, converted
3654 into valid Python. For example, %Exit is logged as
3655 _ip.magic("Exit"). If the -r flag is given, all input is logged
3656 exactly as typed, with no transformations applied.
3409 3657
3410 # Prompt separators like plain python
3411 shell.separate_in = ''
3412 shell.separate_out = ''
3413 shell.separate_out2 = ''
3658 -t: put timestamps before each input line logged (these are put in
3659 comments)."""
3414 3660
3415 pm.justify = False
3661 opts,par = self.parse_options(parameter_s,'ort')
3662 log_output = 'o' in opts
3663 log_raw_input = 'r' in opts
3664 timestamp = 't' in opts
3416 3665
3417 ptformatter.pprint = False
3418 disp_formatter.plain_text_only = True
3666 logger = self.shell.logger
3419 3667
3420 shell.magic('xmode Plain')
3668 # if no args are given, the defaults set in the logger constructor by
3669 # ipython remain valid
3670 if par:
3671 try:
3672 logfname,logmode = par.split()
3673 except:
3674 logfname = par
3675 logmode = 'backup'
3421 3676 else:
3422 # turn off
3423 pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
3677 logfname = logger.logfname
3678 logmode = logger.logmode
3679 # put logfname into rc struct as if it had been called on the command
3680 # line, so it ends up saved in the log header Save it in case we need
3681 # to restore it...
3682 old_logfile = self.shell.logfile
3683 if logfname:
3684 logfname = os.path.expanduser(logfname)
3685 self.shell.logfile = logfname
3424 3686
3425 shell.separate_in = dstore.rc_separate_in
3687 loghead = '# IPython log file\n\n'
3688 try:
3689 started = logger.logstart(logfname,loghead,logmode,
3690 log_output,timestamp,log_raw_input)
3691 except:
3692 self.shell.logfile = old_logfile
3693 warn("Couldn't start log: %s" % sys.exc_info()[1])
3694 else:
3695 # log input history up to this point, optionally interleaving
3696 # output if requested
3426 3697
3427 shell.separate_out = dstore.rc_separate_out
3428 shell.separate_out2 = dstore.rc_separate_out2
3698 if timestamp:
3699 # disable timestamping for the previous history, since we've
3700 # lost those already (no time machine here).
3701 logger.timestamp = False
3429 3702
3430 pm.justify = dstore.rc_prompts_pad_left
3703 if log_raw_input:
3704 input_hist = self.shell.history_manager.input_hist_raw
3705 else:
3706 input_hist = self.shell.history_manager.input_hist_parsed
3431 3707
3432 ptformatter.pprint = dstore.rc_pprint
3433 disp_formatter.plain_text_only = dstore.rc_plain_text_only
3708 if log_output:
3709 log_write = logger.log_write
3710 output_hist = self.shell.history_manager.output_hist
3711 for n in range(1,len(input_hist)-1):
3712 log_write(input_hist[n].rstrip() + '\n')
3713 if n in output_hist:
3714 log_write(repr(output_hist[n]),'output')
3715 else:
3716 logger.log_write('\n'.join(input_hist[1:]))
3717 logger.log_write('\n')
3718 if timestamp:
3719 # re-enable timestamping
3720 logger.timestamp = True
3434 3721
3435 shell.magic('xmode ' + dstore.xmode)
3722 print ('Activating auto-logging. '
3723 'Current session state plus future input saved.')
3724 logger.logstate()
3436 3725
3437 # Store new mode and inform
3438 dstore.mode = bool(1-int(mode))
3439 mode_label = ['OFF','ON'][dstore.mode]
3440 print 'Doctest mode is:', mode_label
3726 def magic_logstop(self,parameter_s=''):
3727 """Fully stop logging and close log file.
3441 3728
3442 def magic_gui(self, parameter_s=''):
3443 """Enable or disable IPython GUI event loop integration.
3729 In order to start logging again, a new %logstart call needs to be made,
3730 possibly (though not necessarily) with a new filename, mode and other
3731 options."""
3732 self.logger.logstop()
3444 3733
3445 %gui [GUINAME]
3734 def magic_logoff(self,parameter_s=''):
3735 """Temporarily stop logging.
3446 3736
3447 This magic replaces IPython's threaded shells that were activated
3448 using the (pylab/wthread/etc.) command line flags. GUI toolkits
3449 can now be enabled at runtime and keyboard
3450 interrupts should work without any problems. The following toolkits
3451 are supported: wxPython, PyQt4, PyGTK, Tk and Cocoa (OSX)::
3737 You must have previously started logging."""
3738 self.shell.logger.switch_log(0)
3739
3740 def magic_logon(self,parameter_s=''):
3741 """Restart logging.
3742
3743 This function is for restarting logging which you've temporarily
3744 stopped with %logoff. For starting logging for the first time, you
3745 must use the %logstart function, which allows you to specify an
3746 optional log filename."""
3747
3748 self.shell.logger.switch_log(1)
3452 3749
3453 %gui wx # enable wxPython event loop integration
3454 %gui qt4|qt # enable PyQt4 event loop integration
3455 %gui gtk # enable PyGTK event loop integration
3456 %gui gtk3 # enable Gtk3 event loop integration
3457 %gui tk # enable Tk event loop integration
3458 %gui OSX # enable Cocoa event loop integration
3459 # (requires %matplotlib 1.1)
3460 %gui # disable all event loop integration
3750 def magic_logstate(self,parameter_s=''):
3751 """Print the status of the logging system."""
3461 3752
3462 WARNING: after any of these has been called you can simply create
3463 an application object, but DO NOT start the event loop yourself, as
3464 we have already handled that.
3465 """
3466 opts, arg = self.parse_options(parameter_s, '')
3467 if arg=='': arg = None
3468 try:
3469 return self.enable_gui(arg)
3470 except Exception as e:
3471 # print simple error message, rather than traceback if we can't
3472 # hook up the GUI
3473 error(str(e))
3753 self.shell.logger.logstate()
3474 3754
3755 class ExtensionsMagics(MagicFunctions):
3756 """Magics to manage the IPython extensions system."""
3475 3757 def magic_install_ext(self, parameter_s):
3476 3758 """Download and install an extension from a URL, e.g.::
3477 3759
@@ -3510,6 +3792,9 b' Defaulting color scheme to \'NoColor\'"""'
3510 3792 """Reload an IPython extension by its module name."""
3511 3793 self.shell.extension_manager.reload_extension(module_str)
3512 3794
3795
3796 class DeprecatedMagics(MagicFunctions):
3797 """Magics slated for later removal."""
3513 3798 def magic_install_profiles(self, s):
3514 3799 """%install_profiles has been deprecated."""
3515 3800 print '\n'.join([
@@ -3529,6 +3814,10 b' Defaulting color scheme to \'NoColor\'"""'
3529 3814 "Add `--reset` to overwrite already existing config files with defaults."
3530 3815 ])
3531 3816
3817
3818 class PylabMagics(MagicFunctions):
3819 """Magics related to matplotlib's pylab support"""
3820
3532 3821 @skip_doctest
3533 3822 def magic_pylab(self, s):
3534 3823 """Load numpy and matplotlib to work interactively.
@@ -3589,234 +3878,3 b' Defaulting color scheme to \'NoColor\'"""'
3589 3878 import_all_status = True
3590 3879
3591 3880 self.shell.enable_pylab(s, import_all=import_all_status)
3592
3593 def magic_tb(self, s):
3594 """Print the last traceback with the currently active exception mode.
3595
3596 See %xmode for changing exception reporting modes."""
3597 self.shell.showtraceback()
3598
3599 @skip_doctest
3600 def magic_precision(self, s=''):
3601 """Set floating point precision for pretty printing.
3602
3603 Can set either integer precision or a format string.
3604
3605 If numpy has been imported and precision is an int,
3606 numpy display precision will also be set, via ``numpy.set_printoptions``.
3607
3608 If no argument is given, defaults will be restored.
3609
3610 Examples
3611 --------
3612 ::
3613
3614 In [1]: from math import pi
3615
3616 In [2]: %precision 3
3617 Out[2]: u'%.3f'
3618
3619 In [3]: pi
3620 Out[3]: 3.142
3621
3622 In [4]: %precision %i
3623 Out[4]: u'%i'
3624
3625 In [5]: pi
3626 Out[5]: 3
3627
3628 In [6]: %precision %e
3629 Out[6]: u'%e'
3630
3631 In [7]: pi**10
3632 Out[7]: 9.364805e+04
3633
3634 In [8]: %precision
3635 Out[8]: u'%r'
3636
3637 In [9]: pi**10
3638 Out[9]: 93648.047476082982
3639
3640 """
3641
3642 ptformatter = self.shell.display_formatter.formatters['text/plain']
3643 ptformatter.float_precision = s
3644 return ptformatter.float_format
3645
3646
3647 @magic_arguments.magic_arguments()
3648 @magic_arguments.argument(
3649 '-e', '--export', action='store_true', default=False,
3650 help='Export IPython history as a notebook. The filename argument '
3651 'is used to specify the notebook name and format. For example '
3652 'a filename of notebook.ipynb will result in a notebook name '
3653 'of "notebook" and a format of "xml". Likewise using a ".json" '
3654 'or ".py" file extension will write the notebook in the json '
3655 'or py formats.'
3656 )
3657 @magic_arguments.argument(
3658 '-f', '--format',
3659 help='Convert an existing IPython notebook to a new format. This option '
3660 'specifies the new format and can have the values: xml, json, py. '
3661 'The target filename is chosen automatically based on the new '
3662 'format. The filename argument gives the name of the source file.'
3663 )
3664 @magic_arguments.argument(
3665 'filename', type=unicode,
3666 help='Notebook name or filename'
3667 )
3668 def magic_notebook(self, s):
3669 """Export and convert IPython notebooks.
3670
3671 This function can export the current IPython history to a notebook file
3672 or can convert an existing notebook file into a different format. For
3673 example, to export the history to "foo.ipynb" do "%notebook -e foo.ipynb".
3674 To export the history to "foo.py" do "%notebook -e foo.py". To convert
3675 "foo.ipynb" to "foo.json" do "%notebook -f json foo.ipynb". Possible
3676 formats include (json/ipynb, py).
3677 """
3678 args = magic_arguments.parse_argstring(self.magic_notebook, s)
3679
3680 from IPython.nbformat import current
3681 args.filename = unquote_filename(args.filename)
3682 if args.export:
3683 fname, name, format = current.parse_filename(args.filename)
3684 cells = []
3685 hist = list(self.shell.history_manager.get_range())
3686 for session, prompt_number, input in hist[:-1]:
3687 cells.append(current.new_code_cell(prompt_number=prompt_number,
3688 input=input))
3689 worksheet = current.new_worksheet(cells=cells)
3690 nb = current.new_notebook(name=name,worksheets=[worksheet])
3691 with io.open(fname, 'w', encoding='utf-8') as f:
3692 current.write(nb, f, format);
3693 elif args.format is not None:
3694 old_fname, old_name, old_format = current.parse_filename(args.filename)
3695 new_format = args.format
3696 if new_format == u'xml':
3697 raise ValueError('Notebooks cannot be written as xml.')
3698 elif new_format == u'ipynb' or new_format == u'json':
3699 new_fname = old_name + u'.ipynb'
3700 new_format = u'json'
3701 elif new_format == u'py':
3702 new_fname = old_name + u'.py'
3703 else:
3704 raise ValueError('Invalid notebook format: %s' % new_format)
3705 with io.open(old_fname, 'r', encoding='utf-8') as f:
3706 nb = current.read(f, old_format)
3707 with io.open(new_fname, 'w', encoding='utf-8') as f:
3708 current.write(nb, f, new_format)
3709
3710 def magic_config(self, s):
3711 """configure IPython
3712
3713 %config Class[.trait=value]
3714
3715 This magic exposes most of the IPython config system. Any
3716 Configurable class should be able to be configured with the simple
3717 line::
3718
3719 %config Class.trait=value
3720
3721 Where `value` will be resolved in the user's namespace, if it is an
3722 expression or variable name.
3723
3724 Examples
3725 --------
3726
3727 To see what classes are available for config, pass no arguments::
3728
3729 In [1]: %config
3730 Available objects for config:
3731 TerminalInteractiveShell
3732 HistoryManager
3733 PrefilterManager
3734 AliasManager
3735 IPCompleter
3736 PromptManager
3737 DisplayFormatter
3738
3739 To view what is configurable on a given class, just pass the class
3740 name::
3741
3742 In [2]: %config IPCompleter
3743 IPCompleter options
3744 -----------------
3745 IPCompleter.omit__names=<Enum>
3746 Current: 2
3747 Choices: (0, 1, 2)
3748 Instruct the completer to omit private method names
3749 Specifically, when completing on ``object.<tab>``.
3750 When 2 [default]: all names that start with '_' will be excluded.
3751 When 1: all 'magic' names (``__foo__``) will be excluded.
3752 When 0: nothing will be excluded.
3753 IPCompleter.merge_completions=<CBool>
3754 Current: True
3755 Whether to merge completion results into a single list
3756 If False, only the completion results from the first non-empty completer
3757 will be returned.
3758 IPCompleter.limit_to__all__=<CBool>
3759 Current: False
3760 Instruct the completer to use __all__ for the completion
3761 Specifically, when completing on ``object.<tab>``.
3762 When True: only those names in obj.__all__ will be included.
3763 When False [default]: the __all__ attribute is ignored
3764 IPCompleter.greedy=<CBool>
3765 Current: False
3766 Activate greedy completion
3767 This will enable completion on elements of lists, results of function calls,
3768 etc., but can be unsafe because the code is actually evaluated on TAB.
3769
3770 but the real use is in setting values::
3771
3772 In [3]: %config IPCompleter.greedy = True
3773
3774 and these values are read from the user_ns if they are variables::
3775
3776 In [4]: feeling_greedy=False
3777
3778 In [5]: %config IPCompleter.greedy = feeling_greedy
3779
3780 """
3781 from IPython.config.loader import Config
3782 # some IPython objects are Configurable, but do not yet have
3783 # any configurable traits. Exclude them from the effects of
3784 # this magic, as their presence is just noise:
3785 configurables = [ c for c in self.shell.configurables
3786 if c.__class__.class_traits(config=True) ]
3787 classnames = [ c.__class__.__name__ for c in configurables ]
3788
3789 line = s.strip()
3790 if not line:
3791 # print available configurable names
3792 print "Available objects for config:"
3793 for name in classnames:
3794 print " ", name
3795 return
3796 elif line in classnames:
3797 # `%config TerminalInteractiveShell` will print trait info for
3798 # TerminalInteractiveShell
3799 c = configurables[classnames.index(line)]
3800 cls = c.__class__
3801 help = cls.class_get_help(c)
3802 # strip leading '--' from cl-args:
3803 help = re.sub(re.compile(r'^--', re.MULTILINE), '', help)
3804 print help
3805 return
3806 elif '=' not in line:
3807 raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
3808
3809
3810 # otherwise, assume we are setting configurables.
3811 # leave quotes on args when splitting, because we want
3812 # unquoted args to eval in user_ns
3813 cfg = Config()
3814 exec "cfg."+line in locals(), self.shell.user_ns
3815
3816 for configurable in configurables:
3817 try:
3818 configurable.update_config(cfg)
3819 except Exception as e:
3820 error(e)
3821
3822 # end Magic
General Comments 0
You need to be logged in to leave comments. Login now