Add new "diagnose" argument to split the "backtrace" behavior (#49)

CHANGELOG.rst

@@ -1,6 +1,7 @@
 Unreleased
 ==========
 
+- Change the behavior of ``backtrace`` argument so it only extends the stacktrace upward, the display of variables values is now controlled with the new ``diagnose`` argument (`#49 <https://github.com/Delgan/loguru/issues/49>`_)
 - The ``record["exception"]`` attribute is now unpackable as a ``(type, value, traceback)`` tuple
 
 

README.rst

@@ -218,7 +218,7 @@ Logging exceptions that occur in your code is important to track bugs, but it's
 
 The code::
 
-    logger.add("output.log", backtrace=True)  # Set 'False' to avoid leaking sensitive data in prod
+    logger.add("output.log", backtrace=True, diagnose=True)  # Set 'False' to not leak sensitive data in prod
 
     def func(a, b):
         return a / b

docs/resources/migration.rst

@@ -129,7 +129,7 @@ Replacing ``exc_info`` argument
 
 While calling standard logging function, you can pass ``exc_info`` as an argument to add stacktrace to the message. Instead of that, you should use the |opt| method with ``exception`` parameter, replacing ``logger.debug("Debug error:", exc_info=True)`` with ``logger.opt(exception=True).debug("Debug error:")``.
 
-The formatted exception will include the whole stacktrace and variables. To prevent that, make sure to use ``backtrace=False`` while adding your sink.
+The formatted exception will include the whole stacktrace and variables. To prevent that, make sure to use ``backtrace=False`` and ``diagnose=False`` while adding your sink.
 
 
 Replacing ``extra`` argument and ``LoggerAdapter`` objects

loguru/_defaults.py

@@ -40,6 +40,7 @@ def env(key, type_, default=None):
 LOGURU_COLORIZE = env("LOGURU_COLORIZE", bool, None)
 LOGURU_SERIALIZE = env("LOGURU_SERIALIZE", bool, False)
 LOGURU_BACKTRACE = env("LOGURU_BACKTRACE", bool, True)
+LOGURU_DIAGNOSE = env("LOGURU_DIAGNOSE", bool, True)
 LOGURU_ENQUEUE = env("LOGURU_ENQUEUE", bool, False)
 LOGURU_CATCH = env("LOGURU_CATCH", bool, True)
 

loguru/_handler.py

@@ -27,6 +27,7 @@ def __init__(
         colorize,
         serialize,
         backtrace,
+        diagnose,
         catch,
         enqueue,
         encoding,
@@ -42,6 +43,7 @@ def __init__(
         self._colorize = colorize
         self._serialize = serialize
         self._backtrace = backtrace
+        self._diagnose = diagnose
         self._catch = catch
         self._enqueue = enqueue
         self._encoding = encoding
@@ -102,17 +104,23 @@ def emit(self, record, level_color, ansi_message, raw, decorated):
 
             exception = record["exception"]
 
-            if exception:
+            if not exception:
+                error = ""
+            else:
                 type_, value, tb = exception
+
                 if self._backtrace:
                     tb = self._exception_extender.extend_traceback(tb, decorated=decorated)
+
+                if self._diagnose:
                     lines = self._exception_formatter.format_exception(type_, value, tb)
-                    error = self._exception_extender.reformat("".join(lines))
                 else:
                     lines = traceback.format_exception(type_, value, tb)
-                    error = "".join(lines)
-            else:
-                error = ""
+
+                error = "".join(lines)
+
+                if self._backtrace:
+                    error = self._exception_extender.reformat(error)
 
             formatter_record = {**record, **{"exception": error}}
 

loguru/_logger.py

@@ -158,6 +158,7 @@ def add(
         colorize=_defaults.LOGURU_COLORIZE,
         serialize=_defaults.LOGURU_SERIALIZE,
         backtrace=_defaults.LOGURU_BACKTRACE,
+        diagnose=_defaults.LOGURU_DIAGNOSE,
         enqueue=_defaults.LOGURU_ENQUEUE,
         catch=_defaults.LOGURU_CATCH,
         **kwargs
@@ -184,9 +185,12 @@ def add(
             Whether or not the logged message and its records should be first converted to a JSON
             string before being sent to the sink.
         backtrace : |bool|, optional
-            Whether or not the formatted exception should use stack trace to display local variables
-            values and be extended upward beyond the caught frame. This probably should be set to
-            ``False`` in production to avoid leaking sensitive data.
+            Whether or not the exception trace formatted should be extended upward, beyond the
+            catching point, to show the full stacktrace which generated the error.
+        diagnose : |bool|, optional
+            Whether or not the exception trace should display the variables values to eases the
+            debugging. This should be set to ``False`` in production to avoid leaking sensitive
+            data.
         enqueue : |bool|, optional
             Whether or not the messages to be logged should first pass through a multiprocess-safe
             queue before reaching the sink. This is useful while logging to a file through multiple
@@ -540,7 +544,7 @@ def add(
 
         Each of the |add| default parameter can be modified by setting the ``LOGURU_[PARAM]``
         environment variable. For example on Linux: ``export LOGURU_FORMAT="{time} - {message}"``
-        or ``export LOGURU_BACKTRACE=NO``.
+        or ``export LOGURU_DIAGNOSE=NO``.
 
         The default levels' attributes can also be modified by setting the ``LOGURU_[LEVEL]_[ATTR]``
         environment variable. For example, on Windows: ``setx LOGURU_DEBUG_COLOR "<blue>"``
@@ -592,6 +596,7 @@ def add(
                 colorize=colorize,
                 serialize=serialize,
                 backtrace=backtrace,
+                diagnose=diagnose,
                 enqueue=enqueue,
                 catch=catch,
             )
@@ -606,6 +611,7 @@ def add(
                 colorize=colorize,
                 serialize=serialize,
                 backtrace=backtrace,
+                diagnose=diagnose,
                 enqueue=enqueue,
                 catch=catch,
             )
@@ -764,6 +770,7 @@ def filter_func(r):
                 colorize=colorize,
                 serialize=serialize,
                 backtrace=backtrace,
+                diagnose=diagnose,
                 catch=catch,
                 enqueue=enqueue,
                 encoding=encoding,
@@ -836,7 +843,7 @@ def catch(
         using threads to propagate errors to the main logger thread.
 
         Note that the visibility of variables values (which uses the cool `better_exceptions`_
-        library from `@Qix-`_) depends on the ``backtrace`` option of each configured sink.
+        library from `@Qix-`_) depends on the ``diagnose`` option of each configured sink.
 
         The returned object can also be used as a context manager.
 

tests/exceptions/backtrace/chained_expression_direct.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch()

tests/exceptions/backtrace/chained_expression_indirect.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a():

tests/exceptions/backtrace/chaining_first.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch

tests/exceptions/backtrace/chaining_second.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a_decorator():

tests/exceptions/backtrace/chaining_third.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a_decorator():

tests/exceptions/backtrace/enqueue.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, enqueue=True, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, enqueue=True, format="", colorize=False, backtrace=True, diagnose=False)
 
 try:
     1 / 0

tests/exceptions/backtrace/enqueue_with_others_handlers.py

@@ -11,9 +11,9 @@ def check_tb_sink(message):
 
 logger.remove()
 
-logger.add(check_tb_sink, enqueue=False, catch=False)
-logger.add(sys.stderr, enqueue=True, catch=False, format="")
-logger.add(check_tb_sink, enqueue=False, catch=False)
+logger.add(check_tb_sink, enqueue=False, catch=False, backtrace=True, diagnose=False)
+logger.add(sys.stderr, format="", enqueue=True, catch=False, backtrace=True, diagnose=False)
+logger.add(check_tb_sink, enqueue=False, catch=False, backtrace=True, diagnose=False)
 
 try:
     1 / 0

tests/exceptions/backtrace/frame_values_backward.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 k = 2
 

tests/exceptions/backtrace/frame_values_forward.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 k = 2
 

tests/exceptions/backtrace/function.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch()

tests/exceptions/backtrace/head_recursion.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch()

tests/exceptions/backtrace/nested.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a(x):

tests/exceptions/backtrace/nested_wrapping.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def f(i):

tests/exceptions/backtrace/no_tb.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="{message}", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="{message}", colorize=False, backtrace=True, diagnose=False)
 
 
 def f():

tests/exceptions/backtrace/not_enough_arguments.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch

tests/exceptions/backtrace/raising_recursion.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch

tests/exceptions/backtrace/suppressed_expression_direct.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a(x, y):

tests/exceptions/backtrace/suppressed_expression_indirect.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 def a(x, y):

tests/exceptions/backtrace/tail_recursion.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch()

tests/exceptions/backtrace/too_many_arguments.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=False, backtrace=True)
+logger.add(sys.stderr, format="", colorize=False, backtrace=True, diagnose=False)
 
 
 @logger.catch

tests/exceptions/better_exceptions/assertion_error.py → tests/exceptions/diagnose/assertion_error.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 def foo(abc, xyz):

tests/exceptions/better_exceptions/attributes.py → tests/exceptions/diagnose/attributes.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 class Obj:

tests/exceptions/better_exceptions/chained_both.py → tests/exceptions/diagnose/chained_both.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 def div(x, y):

tests/exceptions/better_exceptions/encoding.py → tests/exceptions/diagnose/encoding.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 def _deep(val):

tests/exceptions/better_exceptions/global_variable.py → tests/exceptions/diagnose/global_variable.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 foo = True

tests/exceptions/better_exceptions/indentation_error.py → tests/exceptions/diagnose/indentation_error.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 code = """

tests/exceptions/better_exceptions/multilines_repr.py → tests/exceptions/diagnose/multilines_repr.py

@@ -2,7 +2,7 @@
 from loguru import logger
 
 logger.remove()
-logger.add(sys.stderr, format="", colorize=True, backtrace=True)
+logger.add(sys.stderr, format="", colorize=True, backtrace=False, diagnose=True)
 
 
 class A: