fix: deal with 3rd party libs passing non-str objects to Logger.info etc.

- emit warning to tell 'I silently tried to cast which might fail'
- try to cast to avoid most errors which would in last instance cause
  the regex match to fail

Author: florianschieder

python_logging_filters/__init__.py

@@ -1,5 +1,6 @@
 import logging
 import re
+import warnings
 
 
 class DjangoHttp404LogFilter(logging.Filter):
@@ -33,13 +34,28 @@ class DjangoHttp404LogFilter(logging.Filter):
     PATTERN = re.compile("^Not Found:")
 
     def filter(self, record: logging.LogRecord) -> bool:
-        try:
-            message = record.msg % record.args
-        except TypeError:
-            message = record.msg
+        message = self._format_message(record)
         is_not_found_record = (
             self.PATTERN.match(message) is not None
             and record.levelno == logging.WARNING
             and record.name.startswith("django")
         )
         return not is_not_found_record
+
+    def _format_message(self, record: logging.LogRecord) -> str:
+        if not isinstance(record.msg, str):
+            warnings.warn(self._format_type_warning(record.msg))
+
+        # NOTE: 'record.msg' is typed as 'str' but casted explicitly as some
+        # immature third-party rant passes 'anything' causing the regex pattern
+        # matching in .filter() to fail -.-
+        try:
+            return str(record.msg) % record.args
+        except TypeError:
+            return str(record.msg)
+
+    def _format_type_warning(self, value: object):
+        return (
+            "[DjangoHttp404LogFilter] received non-str object. "
+            f"trying to cast {value.__class__} into str"
+        )

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="python-logging-filters",
-    version="0.1.7",
+    version="0.1.8",
     description="standard python logging filters",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",