Changeset 1003 in lmdz_wrf for trunk

Timestamp:

Aug 11, 2016, 11:44:38 AM (9 years ago)

Author:

lfita

Message:

Adding `Capturing': Class to capture the standard output from a function

File:

• trunk/tools/generic_tools.py (modified) (3 diffs)

trunk/tools/generic_tools.py

@@ -4 +4 @@
 import re
 import numpy.ma as ma
+from cStringIO import StringIO
+import sys
 
 main = 'nc_var_tools.py'
@@ -24 +26 @@
 
 ####### Content
+# Capturing: Class to capture the standard output from a function
 # CFmonthU_daysU: Function to transform from a CF date series with units as 'months since [DATE]' to 'days since [DATE]'
 # CFvar_DIAGvar: Function to provide which model diagnostic values can provide a CF-variable from ASCII file
@@ -8262 +8265 @@
     return dictv
 
+class Capturing(list):
+    """ Class to capture the standard output from a function
+      from: http://stackoverflow.com/questions/16571150/how-to-capture-stdout-output-from-a-python-function-call
+      Usage:
+
+      'output' is now a list containing the lines printed by the function call.
+      >>> romdict = {'i': 1, 'ii': 2, 'iii': 3, 'iv': 4, 'v':5, 'vi':6, 'vii':7, 'viii':8, 'ix': 9, 'x':10}
+      >>> with Capturing() as output:
+      >>>    printing_dictionary(romdict)
+      >>> print output
+      ['    # i: 1', '    # ii: 2', '    # iii: 3', '    # iv: 4']
+    """
+    def __enter__(self):
+        self._stdout = sys.stdout
+        sys.stdout = self._stringio = StringIO()
+        return self
+    def __exit__(self, *args):
+        self.extend(self._stringio.getvalue().splitlines())
+        sys.stdout = self._stdout
+
 #quit()