Add 'quiet' option to suppress screen output during %prun calls, edited dochelp

IPython/core/magic.py

@@ -92,7 +92,7 @@ def needs_local_scope(func):
     func.needs_local_scope = True
     return func
 
-    
+
 # Used for exception handling in magic_edit
 class MacroToEdit(ValueError): pass
 
@@ -1314,7 +1314,7 @@ def magic_prun(self, parameter_s ='',user_mode=1,
         object has all the information about the profile in it, and you can
         later use it for further analysis or in other functions.
 
-       -s <key>: sort profile by given key. You can provide more than one key
+        -s <key>: sort profile by given key. You can provide more than one key
         by using the option several times: '-s key1 -s key2 -s key3...'. The
         default sorting key is 'time'.
 
@@ -1360,6 +1360,8 @@ def magic_prun(self, parameter_s ='',user_mode=1,
         is generated by a call to the dump_stats() method of profile
         objects. The profile is still shown on screen.
 
+        -q: suppress output to the screen.  Best used with -T or -D above.
+
         If you want to run complete programs under the profiler's control, use
         '%run -p [prof_opts] filename.py [args to program]' where prof_opts
         contains profiler specific options as described here.
@@ -1374,7 +1376,7 @@ def magic_prun(self, parameter_s ='',user_mode=1,
         parameter_s = parameter_s.replace('"',r'\"').replace("'",r"\'")
 
         if user_mode:  # regular user call
-            opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:',
+            opts,arg_str = self.parse_options(parameter_s,'D:l:rs:T:q',
                                               list_all=1)
             namespace = self.shell.user_ns
         else:  # called to run a program by %run -p
@@ -1438,7 +1440,8 @@ def magic_prun(self, parameter_s ='',user_mode=1,
         output = stdout_trap.getvalue()
         output = output.rstrip()
 
-        page.page(output)
+        if not opts.has_key('q'):
+            page.page(output)
         print sys_exit,
 
         dump_file = opts.D[0]
@@ -2175,11 +2178,11 @@ def magic_loadpy(self, arg_s):
             linesource = fileobj.read().decode('utf-8', 'replace').splitlines()
         else:
             fileobj = linesource = open(arg_s)
-        
+
         # Strip out encoding declarations
         lines = [l for l in linesource if not _encoding_declaration_re.match(l)]
         fileobj.close()
-        
+
         self.set_next_input(os.linesep.join(lines))
 
     def _find_edit_target(self, args, opts, last_call):
@@ -3332,7 +3335,7 @@ def magic_gui(self, parameter_s=''):
             %gui gtk     # enable PyGTK event loop integration
             %gui tk      # enable Tk event loop integration
             %gui OSX     # enable Cocoa event loop integration
-                         # (requires %matplotlib 1.1) 
+                         # (requires %matplotlib 1.1)
             %gui         # disable all event loop integration
 
         WARNING:  after any of these has been called you can simply create
@@ -3367,7 +3370,7 @@ def magic_install_profiles(self, s):
             "Use `ipython profile list` to view available profiles.",
             "Requesting a profile with `ipython profile create <name>`",
             "or `ipython --profile=<name>` will start with the bundled",
-            "profile of that name if it exists." 
+            "profile of that name if it exists."
         ])
 
     def magic_install_default_config(self, s):
@@ -3406,7 +3409,7 @@ def magic_pylab(self, s):
 
             # enable SVG figures, necessary for SVG+XHTML export in the qtconsole
             In [1]: %config InlineBackend.figure_format = 'svg'
-            
+
             # change the behavior of closing all figures at the end of each
             # execution (cell), or allowing reuse of active figures across
             # cells:
@@ -3572,21 +3575,21 @@ def magic_notebook(self, s):
 
     def magic_config(self, s):
         """configure IPython
-        
+
             %config Class[.trait=value]
-        
+
         This magic exposes most of the IPython config system. Any
         Configurable class should be able to be configured with the simple
         line::
-        
+
             %config Class.trait=value
-        
+
         Where `value` will be resolved in the user's namespace, if it is an
         expression or variable name.
-        
+
         Examples
         --------
-        
+
         To see what classes are availabe for config, pass no arguments::
 
             In [1]: %config
@@ -3640,7 +3643,7 @@ def magic_config(self, s):
         # this magic, as their presence is just noise:
         configurables = [ c for c in self.configurables if c.__class__.class_traits(config=True) ]
         classnames = [ c.__class__.__name__ for c in configurables ]
-        
+
         line = s.strip()
         if not line:
             # print available configurable names
@@ -3660,14 +3663,14 @@ def magic_config(self, s):
             return
         elif '=' not in line:
             raise UsageError("Invalid config statement: %r, should be Class.trait = value" % line)
-            
-        
+
+
         # otherwise, assume we are setting configurables.
         # leave quotes on args when splitting, because we want
         # unquoted args to eval in user_ns
         cfg = Config()
         exec "cfg."+line in locals(), self.user_ns
-        
+
         for configurable in configurables:
             try:
                 configurable.update_config(cfg)