Merge pull request #9401 from rtibbles/windows_unicode_logging

Ensure all file handlers use utf-8 encoding.
learningequality · May 12, 2022 · 83d2311 · 83d2311
2 parents 124bc32 + bca52a5
commit 83d2311
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/kolibri/utils/env.py b/kolibri/utils/env.py
@@ -11,13 +11,12 @@
     # TODO: Move version tools to build tools, so we don't have to do this
     from colorlog import ColoredFormatter
     from colorlog import getLogger
-    from colorlog import StreamHandler
 except ImportError:
-    StreamHandler = None
     getLogger = None
     ColoredFormatter = None
 
 from .logger import LOG_COLORS
+from .logger import EncodingStreamHandler as StreamHandler
 from kolibri.utils.compat import monkey_patch_collections
 
 

diff --git a/kolibri/utils/logger.py b/kolibri/utils/logger.py
@@ -17,6 +17,39 @@
 }
 
 
+class EncodingStreamHandler(logging.StreamHandler):
+    """
+    A custom stream handler that encodes the log message to the specified encoding.
+    """
+
+    terminator = "\n"
+
+    def __init__(self, stream=None, encoding="utf-8"):
+        super(EncodingStreamHandler, self).__init__(stream)
+        self.encoding = encoding
+
+    def emit(self, record):
+        """
+        Vendored and modified from:
+        https://github.com/python/cpython/blob/main/Lib/logging/__init__.py#L1098
+        """
+        try:
+            msg = self.format(record)
+            stream = self.stream
+            # issue 35046: merged two stream.writes into one.
+            text = msg + self.terminator
+            if self.encoding and hasattr(stream, "buffer"):
+                bytes_to_write = text.encode(self.encoding)
+                stream.buffer.write(bytes_to_write)
+            else:
+                stream.write(text)
+            self.flush()
+        except RuntimeError:  # See issue 36272
+            raise
+        except Exception:
+            self.handleError(record)
+
+
 class KolibriTimedRotatingFileHandler(TimedRotatingFileHandler):
     """
     A custom TimedRotatingFileHandler that overrides two methods, getFilesToDelete
@@ -172,14 +205,14 @@ def get_default_logging_config(LOG_ROOT, debug=False, debug_database=False):
         "handlers": {
             "console-error": {
                 "level": "ERROR",
-                "class": "logging.StreamHandler",
+                "class": "kolibri.utils.logger.EncodingStreamHandler",
                 "formatter": "color",
                 "stream": "ext://sys.stderr",
             },
             "console": {
                 "level": DEFAULT_LEVEL,
                 "filters": ["no_exceptions"],
-                "class": "logging.StreamHandler",
+                "class": "kolibri.utils.logger.EncodingStreamHandler",
                 "formatter": "color",
                 "stream": "ext://sys.stdout",
             },
@@ -191,13 +224,15 @@ def get_default_logging_config(LOG_ROOT, debug=False, debug_database=False):
                 "formatter": "simple_date",
                 "when": "midnight",
                 "backupCount": 30,
+                "encoding": "utf-8",
             },
             "file_debug": {
                 "level": "DEBUG",
                 "filters": ["require_debug_true"],
                 "class": "logging.FileHandler",
                 "filename": os.path.join(LOG_ROOT, "debug.txt"),
                 "formatter": "simple_date",
+                "encoding": "utf-8",
             },
         },
         "loggers": {