Changeset 3295

Timestamp:

07/30/2007 06:31:45 AM (1 year ago)

Author:

ed

Message:

Added the loggit function to dBug. It works best as a decorator for any method/function call you want to track in order to determine how often it is called, and the program stack that is leading to that call. It helps to track inefficiencies, such as a form's refresh() being called multiple times from various other objects.

Files:

• trunk/dabo/dBug.py (modified) (2 diffs)
• trunk/dabo/settings.py (modified) (1 diff)

trunk/dabo/dBug.py

@@ -1 +1 @@
-# -*- coding: utf-8 -*-
+import os
+import sys
+import time
-import inspect
-from cStringIO import StringIO
+import dabo
+
-
-def logPoint(msg="", levels=None):
@@ -29 +34 @@
-    # I actually logged the result, but you could also print it:
-    return s
+
+
+def loggit(fnc):
+    """Decorator function to create a log of all methods as they are called. To use
+    it, modify all your methods from:
+    
+        def someMethod(...):
+        
+    to:
+    
+        @loggit
+        def someMethod(...):
+        
+    Be sure to add:
+    
+    from dabo.dBug import loggit
+    
+    to the import statements for every file that uses loggit. You can set the name and
+    location of the log file by overriding the setting for dabo.loggitFile. By default, this
+    value will be 'functionCall.log'.
+    """
+    try:
+        if loggit.fhwr:
+            pass
+    except:
+        # ... open it
+        fname = dabo.loggitFile
+        loggit.fhwr = open(fname, "a")
+    def wrapped(*args, **kwargs):
+        loggit.fhwr.write("\n%s\n" % time.strftime("%Y-%m-%d %H:%M:%S"))
+        loggit.fhwr.write("%s\n" % fnc)
+        if args:
+            loggit.fhwr.write("\tARGS:")
+            for ag in args:
+                try:
+                    loggit.fhwr.write(" %s" % ag)
+                except:
+                    loggit.fhwr.write(" ERR")
+            loggit.fhwr.write("\n")
+        if kwargs:
+            loggit.fhwr.write("\tKWARGS:%s\n" % kwargs)
+        for stk in inspect.stack()[1:-7]:
+            loggit.fhwr.write("\t%s, %s, line %s\n" % (os.path.split(stk[1])[1], stk[3], stk[2]))
+        result = fnc(*args, **kwargs)
+        return result
+    wrapped.__doc__ = fnc.__doc__
+    return wrapped

trunk/dabo/settings.py

@@ -105 +105 @@
-defaultEncoding = "utf-8"
-
+# Default log file for the dabo.dBug.loggit function
+loggitFile = "functionCall.log"
-
-### Settings - end