Merge pull request #95 from sagaru/master

Reporting for memory_profiler

Author: fabianp

README.rst

@@ -227,6 +227,47 @@ args, kw)``. For example::
 This will execute the code `f(1, n=int(1e6))` and return the memory
 consumption during this execution.
 
+=====
+ REPORTING
+=====
+
+The output can be redirected to a log file by passing IO stream as
+parameter to the decorator like @profile(stream=fp)
+
+    >>> fp=open('memory_profiler.log','w+')
+    >>> @profile(stream=fp)
+    >>> def my_func():
+        ...     a = [1] * (10 ** 6)
+        ...     b = [2] * (2 * 10 ** 7)
+        ...     del b
+        ...     return a
+
+    For details refer: examples/reporting_file.py
+
+``Reporting via logger Module:``
+
+Sometime it would be very convenient to use logger module specially
+when we need to use RotatingFileHandler.
+
+The output can be redirected to logger module by simply making use of
+LogFile of memory profiler module.
+
+    >>> from memory_profiler import LogFile
+    >>> import sys
+    >>> sys.stdout = LogFile('memory_profile_log')
+
+``Customised reporting:``
+
+Sending everything to the log file while running the memory_profiler
+could be cumbersome and one can choose only entries with increments
+by passing True to reportIncrementFlag, where reportIncrementFlag is
+a parameter to LogFile class of memory profiler module.
+
+    >>> from memory_profiler import LogFile
+    >>> import sys
+    >>> sys.stdout = LogFile('memory_profile_log', reportIncrementFlag=False)
+
+    For details refer: examples/reporting_logger.py
 
 =====================
  IPython integration
@@ -348,6 +389,8 @@ cleanup.
 
 `Thomas Kluyver <https://github.com/takluyver>`_ added the IPython extension.
 
+`Sagar UDAY KUMAR <https://github.com/sagaru>`_ added Report generation feature and examples.
+
 
 =========
  License

examples/example.py

@@ -1,4 +1,4 @@
-
+from memory_profiler import profile
 @profile
 def my_func():
     a = [1] * (10 ** 6)

examples/reporting_file.py

@@ -0,0 +1,21 @@
+from memory_profiler import profile
+
+f=open('hi.txt','w+')
+
+@profile(stream=f)
+def my_func():
+    a = [1] * (10 ** 6)
+    b = [2] * (2 * 10 ** 7)
+    del b
+    return a
+
+@profile(stream=f)
+def my_func1():
+    a = [2] * (10 ** 6)
+    b = [3] * (2 * 10 ** 7)
+    del b
+    return a
+
+if __name__ == '__main__':
+    my_func()
+    my_func1()

examples/reporting_logger.py

@@ -0,0 +1,39 @@
+from memory_profiler import profile
+import logging
+
+# create logger
+logger = logging.getLogger('memory_profile_log')
+logger.setLevel(logging.DEBUG)
+
+# create file handler which logs even debug messages
+fh = logging.FileHandler("memory_profile.log")
+fh.setLevel(logging.DEBUG)
+
+# create formatter
+formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
+fh.setFormatter(formatter)
+
+# add the handlers to the logger
+logger.addHandler(fh)
+
+from memory_profiler import LogFile
+import sys
+sys.stdout = LogFile('memory_profile_log', reportIncrementFlag=False)
+
+@profile
+def my_func():
+    a = [1] * (10 ** 6)
+    b = [2] * (2 * 10 ** 7)
+    del b
+    return a
+
+@profile
+def my_func1():
+    a = [2] * (10 ** 6)
+    b = [3] * (2 * 10 ** 7)
+    del b
+    return a
+
+if __name__ == '__main__':
+    my_func()
+    my_func1()

memory_profiler.py

@@ -16,6 +16,7 @@
 import inspect
 import subprocess
 from copy import copy
+import logging
 
 # TODO: provide alternative when multprocessing is not available
 try:
@@ -808,6 +809,33 @@ def inner_wrapper(f):
             return profile(f, stream=stream, precision=precision)
         return inner_wrapper
 
+class LogFile(object):
+    """File-like object to log text using the `logging` module and the log report can be customised."""
+
+    def __init__(self, name=None, reportIncrementFlag=False):
+        """
+        :param name: name of the logger module
+               reportIncrementFlag: This must be set to True if only the steps with memory increments are to be reported
+
+        :type self: object
+              name: string
+              reportIncrementFlag: bool
+        """
+        self.logger = logging.getLogger(name)
+        self.reportIncrementFlag = reportIncrementFlag
+
+    def write(self, msg, level=logging.INFO):
+        if self.reportIncrementFlag:
+            if "MiB" in msg and float(msg.split("MiB")[1].strip())>0:
+                self.logger.log(level, msg)
+            elif msg.__contains__("Filename:") or msg.__contains__("Line Contents"):
+                self.logger.log(level, msg)
+        else:
+            self.logger.log(level, msg)
+
+    def flush(self):
+        for handler in self.logger.handlers:
+            handler.flush()
 
 if __name__ == '__main__':
     from optparse import OptionParser