Fix sphinx-doc#7423: crashed when giving a non-string object to logger

tk0miya · Apr 8, 2020 · 1ca2207 · 1ca2207
1 parent 2def1fc
commit 1ca2207
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/CHANGES b/CHANGES
@@ -16,6 +16,8 @@ Features added
 Bugs fixed
 ----------
 
+* #7423: crashed when giving a non-string object to logger
+
 Testing
 --------
 

diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py
@@ -412,7 +412,7 @@ def filter(self, record: logging.LogRecord) -> bool:
                 message = record.msg  # use record.msg itself
 
             if location:
-                raise SphinxWarning(location + ":" + message)
+                raise SphinxWarning(location + ":" + str(message))
             else:
                 raise SphinxWarning(message)
         else:

diff --git a/tests/test_util_logging.py b/tests/test_util_logging.py
@@ -48,6 +48,14 @@ def test_info_and_warning(app, status, warning):
     assert 'message5' in warning.getvalue()
 
 
+def test_Exception(app, status, warning):
+    logging.setup(app, status, warning)
+    logger = logging.getLogger(__name__)
+
+    logger.info(Exception)
+    assert "<class 'Exception'>" in status.getvalue()
+
+
 def test_verbosity_filter(app, status, warning):
     # verbosity = 0: INFO
     app.verbosity = 0