Version 3.1.0

* Drop logwrap function. Use class as-is. `logwrap = LogWrap` (No API changes).

Author: penguinolog

CHANGELOG.rst

@@ -1,5 +1,9 @@
 CHANGELOG
 =========
+Version 3.1.0
+-------------
+* Drop logwrap function. Use class as-is. `logwrap = LogWrap` (No API changes).
+
 Version 3.0.2
 -------------
 * Fix package README.

README.rst

@@ -48,7 +48,7 @@ Pros:
 
 This package includes helpers:
 
-* `logwrap` - main helper
+* `logwrap` - main helper. The same is `LogWrap`.
 
 * `LogWrap` - class with `logwrap` implementation. May be used directly.
 
@@ -168,8 +168,6 @@ Limitations:
 
 LogWrap
 -------
-May be used as `logwrap` with possibility to read and change several parameters later.
-
 Example construction and read from test:
 
 .. code-block:: python

doc/source/logwrap.rst

@@ -69,52 +69,3 @@ API: Decorators: `LogWrap` class and `logwrap` function.
 
         :returns: Decorated function. On python 3.3+ awaitable is supported.
         :rtype: typing.Union[typing.Callable, typing.Awaitable]
-
-
-.. py:function:: logwrap(log=logging.getLogger('logwrap'), log_level=logging.DEBUG, exc_level=logging.ERROR, max_indent=20, spec=None, blacklisted_names=None, blacklisted_exceptions=None, log_call_args=True, log_call_args_on_exc=True, log_result_obj=True, )
-
-    :param log: logger object for decorator, by default used 'logwrap'
-    :type log: typing.Union[logging.Logger, typing.Callable]
-    :param log_level: log level for successful calls
-    :type log_level: int
-    :param exc_level: log level for exception cases
-    :type exc_level: int
-    :param max_indent: maximum indent before classic `repr()` call.
-    :type max_indent: int
-    :param spec: callable object used as spec for arguments bind.
-                 This is designed for the special cases only,
-                 when impossible to change signature of target object,
-                 but processed/redirected signature is accessible.
-                 Note: this object should provide fully compatible
-                 signature with decorated function, or arguments bind
-                 will be failed!
-    :type spec: typing.Optional[typing.Callable]
-    :param blacklisted_names: Blacklisted argument names.
-                              Arguments with this names will be skipped in log.
-
-        .. versionadded:: 1.3.0
-    :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-    :param blacklisted_exceptions: list of exception,
-                                   which should be re-raised without
-                                   producing log record.
-
-        .. versionadded:: 2.2.0
-    :type blacklisted_exceptions: typing.Optional[typing.Iterable[Exception]]
-    :param log_call_args: log call arguments before executing wrapped function.
-
-        .. versionadded:: 2.2.0
-    :type log_call_args: bool
-    :param log_call_args_on_exc: log call arguments if exception raised.
-
-        .. versionadded:: 2.2.0
-    :type log_call_args_on_exc: bool
-
-    :param log_result_obj: log result of function call.
-
-        .. versionadded:: 2.2.0
-    :type log_result_obj: bool
-
-    :returns: LogWrap decorator instance
-    :rtype: LogWrap
-
-        .. versionchanged:: 2.2.0

logwrap/__init__.py

@@ -53,7 +53,7 @@
     'pretty_str'
 )
 
-__version__ = '3.0.2'
+__version__ = '3.1.0'
 __author__ = "Alexey Stepanov"
 __author_email__ = 'penguinolog@gmail.com'
 __url__ = 'https://github.com/penguinolog/logwrap'

logwrap/_log_wrap2.py

@@ -23,8 +23,6 @@
 from __future__ import absolute_import
 from __future__ import unicode_literals
 
-import logging
-
 import six
 # noinspection PyUnresolvedReferences
 import funcsigs
@@ -74,63 +72,4 @@ def wrapper(*args, **kwargs):
         return wrapper
 
 
-# pylint: disable=unexpected-keyword-arg, no-value-for-parameter
-def logwrap(
-    log=_log_wrap_shared.logger,
-    log_level=logging.DEBUG,
-    exc_level=logging.ERROR,
-    max_indent=20,
-    spec=None,
-    blacklisted_names=None,
-    blacklisted_exceptions=None,
-    log_call_args=True,
-    log_call_args_on_exc=True,
-    log_result_obj=True,
-):
-    """Log function calls and return values.
-
-    :param log: logger object for decorator, by default used 'logwrap'
-    :type log: typing.Union[logging.Logger, typing.Callable]
-    :param log_level: log level for successful calls
-    :type log_level: int
-    :param exc_level: log level for exception cases
-    :type exc_level: int
-    :param max_indent: maximum indent before classic `repr()` call.
-    :type max_indent: int
-    :param spec: callable object used as spec for arguments bind.
-                 This is designed for the special cases only,
-                 when impossible to change signature of target object,
-                 but processed/redirected signature is accessible.
-                 Note: this object should provide fully compatible signature
-                 with decorated function, or arguments bind will be failed!
-    :type spec: typing.Optional[typing.Callable]
-    :param blacklisted_names: list of exception,
-                              which should be re-raised without
-                              producing log record.
-    :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-    :param blacklisted_exceptions: list of exception,
-                                   which should be re-raised without
-                                   producing log record.
-    :type blacklisted_exceptions: typing.Optional[typing.Iterable[Exception]]
-    :param log_call_args: log call arguments before executing wrapped function.
-    :type log_call_args: bool
-    :param log_call_args_on_exc: log call arguments if exception raised.
-    :type log_call_args_on_exc: bool
-    :param log_result_obj: log result of function call.
-    :type log_result_obj: bool
-    :return: built real decorator.
-    :rtype: _log_wrap_shared.BaseLogWrap
-    """
-    return LogWrap(
-        log=log,
-        log_level=log_level,
-        exc_level=exc_level,
-        max_indent=max_indent,
-        spec=spec,
-        blacklisted_names=blacklisted_names,
-        blacklisted_exceptions=blacklisted_exceptions,
-        log_call_args=log_call_args,
-        log_call_args_on_exc=log_call_args_on_exc,
-        log_result_obj=log_result_obj
-    )
-# pylint: enable=unexpected-keyword-arg, no-value-for-parameter
+logwrap = LogWrap  # lowercase decorator

logwrap/_log_wrap3.py

@@ -27,7 +27,6 @@
 import asyncio
 import functools
 import inspect
-import logging
 import typing
 
 
@@ -36,9 +35,6 @@
 __all__ = ('logwrap', 'LogWrap')
 
 
-DEFAULT_DECORATOR_ARGUMENT = typing.Union[logging.Logger, typing.Callable]
-
-
 class LogWrap(_log_wrap_shared.BaseLogWrap):
     """Python 3.3+ version of LogWrap."""
 
@@ -110,63 +106,4 @@ def wrapper(*args, **kwargs):
         return async_wrapper if asyncio.iscoroutinefunction(func) else wrapper
 
 
-# pylint: disable=unexpected-keyword-arg, no-value-for-parameter
-def logwrap(
-    log: DEFAULT_DECORATOR_ARGUMENT = _log_wrap_shared.logger,
-    log_level: int = logging.DEBUG,
-    exc_level: int = logging.ERROR,
-    max_indent: int = 20,
-    spec: typing.Optional[typing.Callable] = None,
-    blacklisted_names: typing.Optional[typing.List[str]] = None,
-    blacklisted_exceptions: typing.Optional[typing.List[Exception]] = None,
-    log_call_args: bool = True,
-    log_call_args_on_exc: bool = True,
-    log_result_obj: bool = True,
-) -> LogWrap:
-    """Log function calls and return values. Python 3.4+ version.
-
-    :param log: logger object for decorator, by default used 'logwrap'
-    :type log: typing.Union[logging.Logger, typing.Callable]
-    :param log_level: log level for successful calls
-    :type log_level: int
-    :param exc_level: log level for exception cases
-    :type exc_level: int
-    :param max_indent: maximum indent before classic `repr()` call.
-    :type max_indent: int
-    :param spec: callable object used as spec for arguments bind.
-                 This is designed for the special cases only,
-                 when impossible to change signature of target object,
-                 but processed/redirected signature is accessible.
-                 Note: this object should provide fully compatible signature
-                 with decorated function, or arguments bind will be failed!
-    :type spec: typing.Optional[typing.Callable]
-    :param blacklisted_names: list of exception,
-                              which should be re-raised without
-                              producing log record.
-    :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-    :param blacklisted_exceptions: list of exception,
-                                   which should be re-raised without
-                                   producing log record.
-    :type blacklisted_exceptions: typing.Optional[typing.Iterable[Exception]]
-    :param log_call_args: log call arguments before executing wrapped function.
-    :type log_call_args: bool
-    :param log_call_args_on_exc: log call arguments if exception raised.
-    :type log_call_args_on_exc: bool
-    :param log_result_obj: log result of function call.
-    :type log_result_obj: bool
-    :return: built real decorator.
-    :rtype: _log_wrap_shared.BaseLogWrap
-    """
-    return LogWrap(
-        log=log,
-        log_level=log_level,
-        exc_level=exc_level,
-        max_indent=max_indent,
-        spec=spec,
-        blacklisted_names=blacklisted_names,
-        blacklisted_exceptions=blacklisted_exceptions,
-        log_call_args=log_call_args,
-        log_call_args_on_exc=log_call_args_on_exc,
-        log_result_obj=log_result_obj
-    )
-# pylint: enable=unexpected-keyword-arg, no-value-for-parameter
+logwrap = LogWrap  # lowercase decorator

tox.ini

@@ -19,7 +19,6 @@ deps =
     pytest
     pytest-cov
     pytest-html
-    pytest-catchlog
     pytest-sugar
     py{34,35,36}-nocov: Cython
     -r{toxinidir}/CI_REQUIREMENTS.txt
@@ -108,13 +107,6 @@ deps =
     sphinx
 commands = python setup.py build_sphinx
 
-[testenv:upload_docs]
-deps =
-    sphinx
-    sphinx-pypi-upload
-    -r{toxinidir}/CI_REQUIREMENTS.txt
-commands = python setup.py build_sphinx upload_sphinx
-
 [testenv:bandit]
 deps = bandit
 commands = bandit -r logwrap