fix: python2 json dumps UnicodeDecodeError

Author: MyColorfulDays

jsonformatter/jsonformatter.py

@@ -37,7 +37,7 @@ def usesTime(self):
         return self._fmt.find(self.asctime_search) >= 0
 
     def format(self, record):
-        return str(self._fmt) % record.__dict__
+        return self._fmt % record.__dict__
 
 
 class StrFormatStyle(PercentStyle):
@@ -46,7 +46,7 @@ class StrFormatStyle(PercentStyle):
     asctime_search = '{asctime'
 
     def format(self, record):
-        return str(self._fmt).format(**record.__dict__)
+        return self._fmt.format(**record.__dict__)
 
 
 class StringTemplateStyle(PercentStyle):
@@ -58,7 +58,7 @@ def __init__(self, fmt):
         PercentStyle.__init__(self, fmt)
         self._tpl = {}
         for _, v in fmt.items():
-            self._tpl[v] = Template(str(v))
+            self._tpl[v] = Template(v)
 
     def usesTime(self):
         fmt = self._fmt
@@ -220,6 +220,7 @@ def __init__(self, fmt=BASIC_FORMAT, datefmt=None, style='%', record_custom_attr
         self.cls = cls
         self.indent = indent
         self.separators = separators
+        self.encoding = encoding
         self.default = default
         self.sort_keys = sort_keys
         self.kw = kw
@@ -262,10 +263,10 @@ def formatMessage(self, record):
     def format(self, record):
         result = dictionary()
 
-        # store `record` origin attributes start
+        # store `record` origin attributes, prevent other formatter use record error start
         _msg, _args = record.msg, record.args
         record.msg, record.args = '', tuple()
-        # store `record` origin attributes end
+        # store `record` origin attributes, prevent other formatter use record error end
 
         self.setRecordMessage(record, _msg, _args)
 
@@ -274,6 +275,13 @@ def format(self, record):
         if self.record_custom_attrs:
             self.setRecordCustomAttrs(record)
 
+        # compatible python2 start
+        if sys.version_info < (3, 0):
+            for k, v in record.__dict__.items():
+                if isinstance(v, str):
+                    record.__dict__.update({k: v.decode(self.encoding)})
+        # compatible python2 end
+
         for k, v in self.json_fmt.items():
             # this is for keeping `record` attribute `type`
             if v in record.__dict__:
@@ -284,8 +292,8 @@ def format(self, record):
                 result[k] = self.formatMessage(record)
         self._style._fmt = ''
 
-        # apply `record` origin attributes start
+        # apply `record` origin attributes, prevent other formatter use record error start
         record.msg, record.args = _msg, _args
-        # apply `record` origin attributes end
+        # apply `record` origin attributes, prevent other formatter use record error end
 
         return json.dumps(result, skipkeys=self.skipkeys, ensure_ascii=self.ensure_ascii, check_circular=self.check_circular, allow_nan=self.allow_nan, cls=self.cls, indent=self.indent, separators=self.separators, default=self.default, sort_keys=self.sort_keys, **self.kw)

setup.py

@@ -8,16 +8,28 @@
 Github: https://github.com/yourname
 Description: setup.py
 """
-
+import sys
 from setuptools import setup
 
+long_description = ''
+
+try:
+    if 'win' in sys.platform and sys.version_info >= (3, 0):
+        with open('README.md', encoding='utf-8') as r:
+            long_description = r.read()
+    else:
+        with open('README.md') as r:
+            long_description = r.read()
+except Exception as e:
+    pass
+
 setup(
     name='jsonformatter',
-    version='0.2.2',
+    version='0.2.3',
     description=(
         'Python log in json format.'
     ),
-    long_description=open('README.md').read(),
+    long_description=long_description,
     long_description_content_type="text/markdown",
     platforms=["all"],
     classifiers=[

test/test.py

@@ -145,7 +145,8 @@ def test_percent_style_unicode(self):
         root = logging.getLogger()
         root.setLevel(logging.INFO)
 
-        formatter = JsonFormatter("""{"log":"%(message)s"}""", style="%")
+        formatter = JsonFormatter(
+            """{"log":"%(message)s"}""", style="%", ensure_ascii=False)
 
         sh = logging.StreamHandler()
         sh.setFormatter(formatter)
@@ -158,7 +159,8 @@ def test_format_style_unicode(self):
         root = logging.getLogger()
         root.setLevel(logging.INFO)
 
-        formatter = JsonFormatter("""{"log":"{message}"}""", style="{")
+        formatter = JsonFormatter(
+            """{"log":"{message}"}""", style="{", ensure_ascii=False)
 
         sh = logging.StreamHandler()
         sh.setFormatter(formatter)
@@ -171,7 +173,8 @@ def test_template_style_unicode(self):
         root = logging.getLogger()
         root.setLevel(logging.INFO)
 
-        formatter = JsonFormatter("""{"log":"${message}"}""", style="$")
+        formatter = JsonFormatter(
+            """{"log":"${message}"}""", style="$", ensure_ascii=False)
 
         sh = logging.StreamHandler()
         sh.setFormatter(formatter)