Allow blacklisting of argument names

The main reason for blacklisting - security requirements, when
sensitive data should be excluded from log without corruption.

Signed-off-by: Alexey Stepanov <penguinolog@gmail.com>

Author: penguinolog

CHANGELOG.rst

@@ -1,5 +1,9 @@
 CHANGELOG
 =========
+Version 1.3.0
+-------------
+* Allowed to blacklist call arguments
+
 Version 1.2.0
 -------------
 * Fix dict keys length calculation

README.rst

@@ -62,6 +62,7 @@ Argumented usage with arguments from signature:
         exc_level=logging.ERROR,
         max_indent=20,  # forwarded to the pretty_repr
         spec=None,  # use target callable function for spec
+        blacklisted_names=None,  # list argument names, which should be dropped from log
     )
 
 Usage examples:

logwrap/__init__.py

@@ -29,7 +29,7 @@
 from ._repr_utils import pretty_repr
 from ._repr_utils import pretty_str
 
-__version__ = '1.2.0'
+__version__ = '1.3.0'
 
 __all__ = [
     'logwrap',

logwrap/_log_wrap.py

@@ -49,11 +49,12 @@
 comment = "\n{spc:<{indent}}# {{kind!s}}:".format(spc='', indent=indent).format
 
 
-def _get_func_args_repr(sig, args, kwargs, max_indent):
+def _get_func_args_repr(sig, args, kwargs, max_indent, blacklisted_names):
     """Internal helper for reducing complexity of decorator code
 
     :type sig: inspect.Signature
     :type max_indent: int
+    :type blacklisted_names: list
     :rtype: str
     """
 
@@ -63,6 +64,9 @@ def _get_func_args_repr(sig, args, kwargs, max_indent):
 
     last_kind = None
     for param in sig.parameters.values():
+        if param.name in blacklisted_names:
+            continue
+
         if last_kind != param.kind:
             param_str += comment(kind=param.kind)
             last_kind = param.kind
@@ -81,11 +85,12 @@ def _get_func_args_repr(sig, args, kwargs, max_indent):
 
 
 def logwrap(
-        log=_logger,
-        log_level=logging.DEBUG,
-        exc_level=logging.ERROR,
-        max_indent=20,
-        spec=None,
+    log=_logger,
+    log_level=logging.DEBUG,
+    exc_level=logging.ERROR,
+    max_indent=20,
+    spec=None,
+    blacklisted_names=None,
 ):
     """Log function calls and return values
 
@@ -104,9 +109,15 @@ def logwrap(
                  Note: this object should provide fully compatible signature
                  with decorated function, or arguments bind will be failed!
     :type spec: callable
+    :param blacklisted_names: Blacklisted argument names.
+                              Arguments with this names will be skipped in log.
+    :type blacklisted_names: list
     :return: built real decorator
     :rtype: callable
     """
+    if blacklisted_names is None:
+        blacklisted_names = []
+
     def real_decorator(func):
         """Log function calls and return values
 
@@ -131,6 +142,7 @@ def wrapped(*args, **kwargs):
                 args=args,
                 kwargs=kwargs,
                 max_indent=max_indent,
+                blacklisted_names=blacklisted_names
             )
 
             log.log(

setup.py

@@ -26,7 +26,7 @@
 setuptools.setup(
     name='logwrap',
     version=logwrap.__version__,
-    packages=['logwrap'],
+    packages=setuptools.find_packages(),
     classifiers=[
         'Development Status :: 5 - Production/Stable',
 

test/test_log_wrap.py

@@ -470,3 +470,39 @@ def func(arg, darg=1, *args, **kwargs):
                     "    }),\n"
                     "))")
         ))
+
+    def test_args_blacklist(self, logger):
+        new_logger = mock.Mock(spec=logging.Logger, name='logger')
+        log = mock.Mock(name='log')
+        new_logger.attach_mock(log, 'log')
+
+        arg1 = 'test arg 1'
+        arg2 = 'test arg 2'
+
+        @logwrap.logwrap(log=new_logger, blacklisted_names=['test_arg2'])
+        def func(test_arg1, test_arg2):
+            return test_arg1, test_arg2
+
+        result = func(arg1, arg2)
+        self.assertEqual(result, (arg1, arg2))
+        log.assert_has_calls((
+            mock.call(
+                level=logging.DEBUG,
+                msg="Calling: \n"
+                    "'func'(\n"
+                    "    # POSITIONAL_OR_KEYWORD:\n"
+                    "    'test_arg1'={},\n"
+                    ")".format(
+                        logwrap.pretty_repr(
+                            arg1,
+                            indent=8,
+                            no_indent_start=True
+                        )
+                    )
+            ),
+            mock.call(
+                level=logging.DEBUG,
+                msg="Done: 'func' with result:\n{}".format(
+                    logwrap.pretty_repr(result))
+            ),
+        ))