Change exception logging: log exception class name in case of ignore

Author: penguinolog

README.rst

@@ -85,7 +85,7 @@ Argumented usage with arguments from signature:
         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
-        blacklisted_exceptions=None,  # Exceptions to skip in log
+        blacklisted_exceptions=None,  # Exceptions to skip details in log (no traceback, no exception details - just class name)
         log_call_args=True,  # Log call arguments before call
         log_call_args_on_exc=True,  # Log call arguments if exception happens
         log_traceback = True,  # Log traceback if exception happens

doc/source/logwrap.rst

@@ -37,7 +37,7 @@ API: Decorators: `LogWrap` class and `logwrap` function.
         :type blacklisted_names: typing.Optional[typing.Iterable[str]]
         :param blacklisted_exceptions: list of exception,
                                        which should be re-raised without
-                                       producing log record.
+                                       producing traceback and text log record.
         :type blacklisted_exceptions: typing.Optional[typing.Iterable[typing.Type[Exception]]]
         :param log_call_args: log call arguments before executing wrapped function.
         :type log_call_args: bool

logwrap/log_wrap.pxd

@@ -50,4 +50,4 @@ cdef:
             str _get_func_args_repr(self, sig: inspect.Signature, tuple args, dict kwargs)
             void _make_done_record(self, str func_name, result: typing.Any) except *
             void _make_calling_record(self, str name, str arguments, str method=?) except *
-            void _make_exc_record(self, str name, str arguments) except *
+            void _make_exc_record(self, str name, str arguments, Exception exception) except *

logwrap/log_wrap.py

@@ -188,7 +188,8 @@ def __init__(
         :type spec: typing.Optional[typing.Callable]
         :param blacklisted_names: Blacklisted argument names. Arguments with this names will be skipped in log.
         :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-        :param blacklisted_exceptions: list of exception, which should be re-raised without producing log record.
+        :param blacklisted_exceptions: list of exception, which should be re-raised
+               without producing traceback and text log record.
         :type blacklisted_exceptions: typing.Optional[typing.Iterable[typing.Type[Exception]]]
         :param log_call_args: log call arguments before executing wrapped function.
         :type log_call_args: bool
@@ -297,7 +298,7 @@ def blacklisted_names(self) -> typing.List[str]:
 
     @property
     def blacklisted_exceptions(self) -> typing.List[typing.Type[Exception]]:
-        """List of exceptions to re-raise without log.
+        """List of exceptions to re-raise without log traceback and text.
 
         :rtype: typing.List[typing.Type[Exception]]
         """
@@ -535,11 +536,12 @@ def _make_calling_record(self, name: str, arguments: str, method: str = "Calling
         """
         self._logger.log(level=self.log_level, msg=f"{method}: \n{name}({arguments if self.log_call_args else ''})")
 
-    def _make_exc_record(self, name: str, arguments: str) -> None:
+    def _make_exc_record(self, name: str, arguments: str, exception: Exception) -> None:
         """Make log record if exception raised.
 
         :type name: str
         :type arguments: str
+        :type exception: Exception
         """
         exc_info = sys.exc_info()
         stack: traceback.StackSummary = traceback.extract_stack()
@@ -548,15 +550,13 @@ def _make_exc_record(self, name: str, arguments: str) -> None:
         # Make standard traceback string
         tb_text: str = (
             f"Traceback (most recent call last):\n{''.join(traceback.format_list(full_tb))}{''.join(exc_line)}"
+            if self.log_traceback and not isinstance(exception, tuple(self.blacklisted_exceptions))
+            else exception.__class__.__name__
         )
 
         self._logger.log(
             level=self.exc_level,
-            msg=(
-                f"Failed: \n"
-                f"{name}({arguments if self.log_call_args_on_exc else ''})\n"
-                f"{tb_text if self.log_traceback else ''}"
-            ),
+            msg=f"Failed: \n{name}({arguments if self.log_call_args_on_exc else ''})\n{tb_text}",
             exc_info=False,
         )
 
@@ -579,10 +579,8 @@ async def async_wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
                 self._make_calling_record(name=func.__name__, arguments=args_repr, method="Awaiting")
                 result = await func(*args, **kwargs)
                 self._make_done_record(func.__name__, result)
-            except BaseException as e:
-                if isinstance(e, tuple(self.blacklisted_exceptions)):
-                    raise
-                self._make_exc_record(name=func.__name__, arguments=args_repr)
+            except Exception as e:
+                self._make_exc_record(name=func.__name__, arguments=args_repr, exception=e)
                 raise
             return result  # type: ignore
 
@@ -596,10 +594,8 @@ def wrapper(*args: typing.Any, **kwargs: typing.Any) -> typing.Any:
                 self._make_calling_record(name=func.__name__, arguments=args_repr)
                 result = func(*args, **kwargs)
                 self._make_done_record(func.__name__, result)
-            except BaseException as e:
-                if isinstance(e, tuple(self.blacklisted_exceptions)):
-                    raise
-                self._make_exc_record(name=func.__name__, arguments=args_repr)
+            except Exception as e:
+                self._make_exc_record(name=func.__name__, arguments=args_repr, exception=e)
                 raise
             return result
 
@@ -715,7 +711,8 @@ def logwrap(  # noqa: F811
     :type spec: typing.Optional[typing.Callable]
     :param blacklisted_names: Blacklisted argument names. Arguments with this names will be skipped in log.
     :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-    :param blacklisted_exceptions: list of exceptions, which should be re-raised without producing log record.
+    :param blacklisted_exceptions: list of exceptions, which should be re-raised
+                                   without producing traceback and text log record.
     :type blacklisted_exceptions: typing.Optional[typing.Iterable[typing.Type[Exception]]]
     :param log_call_args: log call arguments before executing wrapped function.
     :type log_call_args: bool

logwrap/log_wrap.pyx

@@ -173,7 +173,8 @@ cdef class LogWrap(class_decorator.BaseDecorator):
         :type spec: typing.Optional[typing.Callable]
         :param blacklisted_names: Blacklisted argument names. Arguments with this names will be skipped in log.
         :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-        :param blacklisted_exceptions: list of exception, which should be re-raised without producing log record.
+        :param blacklisted_exceptions: list of exception, which should be re-raised
+               without producing traceback and text log record.
         :type blacklisted_exceptions: typing.Optional[typing.Iterable[typing.Type[Exception]]]
         :param log_call_args: log call arguments before executing wrapped function.
         :type log_call_args: bool
@@ -364,25 +365,30 @@ cdef class LogWrap(class_decorator.BaseDecorator):
                 msg=f"{method}: \n{name}({arguments if self.log_call_args else ''})",
             )
 
-        void _make_exc_record(self, str name, str arguments) except *:
+        void _make_exc_record(self, str name, str arguments, Exception exception) except *:
             """Make log record if exception raised.
 
             :type name: str
             :type arguments: str
+            :type exception: Exception
             """
             exc_info = sys.exc_info()
             stack = traceback.extract_stack()
             full_tb = [elem for elem in stack if elem.filename != _CURRENT_FILE]  # type: typing.List[traceback.FrameSummary]
             exc_line = traceback.format_exception_only(*exc_info[:2])
             # Make standard traceback string
-            cdef str tb_text = "Traceback (most recent call last):\n" + "".join(traceback.format_list(full_tb)) + "".join(exc_line)
+            cdef str tb_text = (
+                f"Traceback (most recent call last):\n{''.join(traceback.format_list(full_tb))}{''.join(exc_line)}"
+                if self.log_traceback and not isinstance(exception, tuple(self.blacklisted_exceptions))
+                else exception.__class__.__name__
+            )
 
             self._logger.log(
                 level=self.exc_level,
                 msg=(
                     f"Failed: \n"
                     f"{name}({arguments if self.log_call_args_on_exc else ''})\n"
-                    f"{tb_text if self.log_traceback else ''}"
+                    f"{tb_text}"
                 ),
                 exc_info=False,
             )
@@ -405,10 +411,8 @@ cdef class LogWrap(class_decorator.BaseDecorator):
                 self._make_calling_record(name=func.__name__, arguments=args_repr, method="Awaiting")
                 result = await func(*args, **kwargs)
                 self._make_done_record(func.__name__, result)
-            except BaseException as e:
-                if isinstance(e, tuple(self.blacklisted_exceptions)):
-                    raise
-                self._make_exc_record(name=func.__name__, arguments=args_repr)
+            except Exception as e:
+                self._make_exc_record(name=func.__name__, arguments=args_repr, exception=e)
                 raise
             return result
 
@@ -421,10 +425,8 @@ cdef class LogWrap(class_decorator.BaseDecorator):
                 self._make_calling_record(name=func.__name__, arguments=args_repr)
                 result = func(*args, **kwargs)
                 self._make_done_record(func.__name__, result)
-            except BaseException as e:
-                if isinstance(e, tuple(self.blacklisted_exceptions)):
-                    raise
-                self._make_exc_record(name=func.__name__, arguments=args_repr)
+            except Exception as e:
+                self._make_exc_record(name=func.__name__, arguments=args_repr, exception=e)
                 raise
             return result
 
@@ -475,7 +477,8 @@ def logwrap(
     :type spec: typing.Optional[typing.Callable]
     :param blacklisted_names: Blacklisted argument names. Arguments with this names will be skipped in log.
     :type blacklisted_names: typing.Optional[typing.Iterable[str]]
-    :param blacklisted_exceptions: list of exceptions, which should be re-raised without producing log record.
+    :param blacklisted_exceptions: list of exceptions, which should be re-raised
+                                   without producing traceback and text log record.
     :type blacklisted_exceptions: typing.Optional[typing.Iterable[typing.Type[Exception]]]
     :param log_call_args: log call arguments before executing wrapped function.
     :type log_call_args: bool

test/test_log_wrap.py

@@ -459,6 +459,7 @@ def func():
                     level=logging.DEBUG,
                     msg="Calling: \nfunc()"
                 ),
+                mock.call(exc_info=False, level=40, msg=f'Failed: \nfunc()\n{TypeError.__name__}')
             ],
             log.mock_calls,
         )

test/test_log_wrap_py3.py

@@ -134,6 +134,7 @@ def func():
                     level=logging.DEBUG,
                     msg="Awaiting: \nfunc()"
                 ),
+                mock.call(exc_info=False, level=40, msg=f'Failed: \nfunc()\n{TypeError.__name__}')
             ],
             log.mock_calls,
         )

test/test_log_wrap_py35.py

@@ -130,6 +130,7 @@ async def func():
                     level=logging.DEBUG,
                     msg="Awaiting: \nfunc()"
                 ),
+                mock.call(exc_info=False, level=40, msg=f'Failed: \nfunc()\n{TypeError.__name__}')
             ],
             log.mock_calls,
         )