Align logging.exception signature with that or Python's builtin by adding exc_info.

Abseil Team · copybara-github · commit 8e3ad2ef7275 · 2023-08-24T01:38:09.000-07:00
PiperOrigin-RevId: 559680080
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,11 +26,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com).
     `enum_values` is provided as a single string value. Additionally,
     `EnumParser.enum_values` is now stored as a list copy of the provided
     `enum_values` parameter.
-*   (tesing) Updated `paramaterized.CoopTestCase()` to use Python 3 metaclass
+*   (testing) Updated `paramaterized.CoopTestCase()` to use Python 3 metaclass
     idioms. Most uses of this function continued working during the Python 3
     migration still worked because a Python 2 compatibility `__metaclass__`
     variables also existed. Now pure Python 3 base classes without backwards
     compatibility will work as intended.
+*   `logging.exception` can now take `exc_info` as argument, with default value
+    `True`. Prior to this change setting `exc_info` would raise `KeyError`, this
+    change fixes this behaviour.
 
 ## 1.4.0 (2023-01-11)
 
diff --git a/absl/logging/__init__.py b/absl/logging/__init__.py
@@ -447,9 +447,9 @@ def debug(msg, *args, **kwargs):
   log(DEBUG, msg, *args, **kwargs)
 
 
-def exception(msg, *args, **kwargs):
+def exception(msg, *args, exc_info=True, **kwargs):
   """Logs an exception, with traceback and message."""
-  error(msg, *args, **kwargs, exc_info=True)
+  error(msg, *args, exc_info=exc_info, **kwargs)
 
 
 # Counter to keep track of number of log entries per token.
diff --git a/absl/logging/tests/logging_test.py b/absl/logging/tests/logging_test.py
@@ -819,6 +819,11 @@ def test_exception_dict_format(self):
     # Just verify that this doesn't raise a TypeError.
     logging.exception('%(test)s', {'test': 'Hello world!'})
 
+  def test_exception_with_exc_info(self):
+    # Just verify that this doesn't raise a KeyeError.
+    logging.exception('exc_info=True', exc_info=True)
+    logging.exception('exc_info=False', exc_info=False)
+
   def test_logging_levels(self):
     old_level = logging.get_verbosity()
 
