Add improved logging

Author: chrisburr

formulate/expression.py

@@ -4,6 +4,7 @@
 from __future__ import print_function
 
 from .identifiers import IDs
+from .logging import add_logging
 
 
 __all__ = [
@@ -237,6 +238,7 @@ def id(self):
     def args(self):
         return self._args
 
+    @add_logging(ignore_args=[1, 2])
     def to_string(self, config, constants):
         if isinstance(self.args[0], SingleComponent):
             assert len(self.args) == 1, self.args
@@ -261,6 +263,7 @@ def __str__(self):
     def name(self):
         return self._name
 
+    @add_logging(ignore_args=[1, 2])
     def to_string(self, config, constants):
         return self.name
 
@@ -280,5 +283,6 @@ def __str__(self):
     def id(self):
         return self._id
 
+    @add_logging(ignore_args=[1, 2])
     def to_string(self, config, constants):
         return str(constants[self.id].value)

formulate/logging.py

@@ -3,14 +3,59 @@
 from __future__ import division
 from __future__ import print_function
 
+from functools import wraps
+import string
 import logging
+import random
 
 
 __all__ = [
-    'logger'
+    'logger',
+    'add_logging',
 ]
 
 
+def get_identifier():
+    return''.join(random.choice(string.ascii_uppercase + string.digits)
+                  for i in range(5))
+
+
+def add_logging(func=None, *, ignore_args=None, ignore_kwargs=None):
+    """Decorator to add logging to a method
+
+    Parameters
+    ----------
+    func : function
+        Function to decorate
+    ignore_args : list
+        Indices of the arguments to ignore
+    ignore_kwargs : list
+        Names of the keyword arguments to ignore
+    """
+    def real_decorator(func):
+        @wraps(func)
+        def new_func(*args, **kwargs):
+            my_id = get_identifier()
+            try:
+                func_name = func.__qualname__
+            except AttributeError:
+                # Python 2 doesn't have __qualname__
+                func_name = func.__name__
+            # Don't log arguments which should be ignored
+            _args = [a for i, a in enumerate(args) if ignore_args and i not in ignore_args]
+            _kwargs = {k: v for k, v in kwargs.items() if ignore_kwargs and k not in ignore_kwargs}
+            logger.debug(my_id+' Calling '+func_name+' with '+repr(_args)+' and '+repr(_kwargs))
+            result = func(*args, **kwargs)
+            logger.debug(my_id+'  - Got result '+repr(result))
+            return result
+        return new_func
+
+    if func is None:
+        return real_decorator
+    else:
+        return real_decorator(func)
+
+
 LOGGER_NAME = 'formulate'
 
 try:

formulate/parser.py

@@ -5,14 +5,13 @@
 from __future__ import print_function
 
 from collections import defaultdict
-from functools import wraps
 
 import pyparsing
 from pyparsing import Literal, Suppress, pyparsing_common, opAssoc, Word
 
 from .expression import Expression, Variable, Constant, ExpressionComponent
 from .identifiers import order_of_operations
-from .logging import logger
+from .logging import logger, add_logging
 
 
 __all__ = [
@@ -24,21 +23,6 @@
 ]
 
 
-def add_logging(func):
-    @wraps(func)
-    def new_func(*args, **kwargs):
-        try:
-            func_name = func.__qualname__
-        except AttributeError:
-            # Python 2 doesn't have __qualname__
-            func_name = func.__name__
-        logger.debug('Calling '+func_name+' with '+repr(args)+' and '+repr(kwargs))
-        result = func(*args, **kwargs)
-        logger.debug(' - Got result '+repr(result))
-        return result
-    return new_func
-
-
 class PConstant(object):
     def __init__(self, id, value):
         """Represents a constant
@@ -81,6 +65,7 @@ def get_parser(self, EXPRESSION):
             # TODO Detect constants?
             return None
 
+    @add_logging
     def to_string(self):
         return str(self.value)
 
@@ -146,6 +131,7 @@ def _parse_action(self, string, location, result):
         # TODO Replace with logging decorator
         return self(*result)
 
+    @add_logging(ignore_args=[2, 3])
     def to_string(self, expression, config, constants):
         args = []
         for arg in expression.args:
@@ -225,6 +211,7 @@ def _parse_action(self, string, location, result):
         assert len(result) >= 2 or self._rhs_only, result
         return self(*result)
 
+    @add_logging(ignore_args=[2, 3])
     def to_string(self, expression, config, constants):
         args = []
         for arg in expression.args: