fix: python2 UnicodeDecodeError

Author: MyColorfulDays

README.md

@@ -19,7 +19,7 @@ Table of Contents
 
 **jsonformatter** is a formatter for python output json log,  you can easily output **LogStash** needed log format or other **custom** json format  and  you can easily **custom(add/replace)** `LogRecord` attribute.
 
-**Python 2.7** and **python 3** are supported from version 0.2.0,  if you are using a version lower than 0.2.0,  **python 3** is only supported.
+**Python 2.7** and **python 3** are supported from version 0.2.X,  if you are using a version lower than 0.2.X,  **python 3** is only supported.
 
 
 

jsonformatter/jsonformatter.py

@@ -37,7 +37,7 @@ def usesTime(self):
         return self._fmt.find(self.asctime_search) >= 0
 
     def format(self, record):
-        return self._fmt % record.__dict__
+        return str(self._fmt) % record.__dict__
 
 
 class StrFormatStyle(PercentStyle):
@@ -46,7 +46,7 @@ class StrFormatStyle(PercentStyle):
     asctime_search = '{asctime'
 
     def format(self, record):
-        return self._fmt.format(**record.__dict__)
+        return str(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(v)
+            self._tpl[v] = Template(str(v))
 
     def usesTime(self):
         fmt = self._fmt
@@ -147,7 +147,7 @@ def checkRecordCustomAttrs(self, record_custom_attrs):
         else:
             return
 
-    def __init__(self, fmt=BASIC_FORMAT, datefmt=None, style='%', record_custom_attrs=None, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, default=None, sort_keys=False, **kw):
+    def __init__(self, fmt=BASIC_FORMAT, datefmt=None, style='%', record_custom_attrs=None, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, cls=None, indent=None, separators=None, encoding='utf-8', default=None, sort_keys=False, **kw):
         """
         If ``record_custom_attrs`` is not ``None``, it must be a ``dict`` type, the key of dict will be setted as LogRecord's attribute, the value of key must be a callable object and without parameters, it returned obj will be setted as attribute's value of LogRecord.
 
@@ -178,6 +178,8 @@ def __init__(self, fmt=BASIC_FORMAT, datefmt=None, style='%', record_custom_attr
         ``(',', ': ')`` otherwise.  To get the most compact JSON representation,
         you should specify ``(',', ':')`` to eliminate whitespace.
 
+        ``encoding`` is the character encoding for str instances, only supported by python 2.7, default is UTF-8.
+
         ``default(obj)`` is a function that should return a serializable version
         of obj or raise TypeError. The default simply raises TypeError.
 
@@ -191,6 +193,7 @@ def __init__(self, fmt=BASIC_FORMAT, datefmt=None, style='%', record_custom_attr
         """
         # compatible python2 start
         if sys.version_info < (3, 0):
+            kw.update(encoding=encoding)
             logging.Formatter.__init__(
                 self, fmt='', datefmt=datefmt)
 

setup.py

@@ -13,7 +13,7 @@
 
 setup(
     name='jsonformatter',
-    version='0.2.1',
+    version='0.2.2',
     description=(
         'Python log in json format.'
     ),

test/test.py

@@ -141,6 +141,45 @@ def test_template_style(self):
 
         root.info("test %s style", 'template')
 
+    def test_percent_style_unicode(self):
+        root = logging.getLogger()
+        root.setLevel(logging.INFO)
+
+        formatter = JsonFormatter("""{"log":"%(message)s"}""", style="%")
+
+        sh = logging.StreamHandler()
+        sh.setFormatter(formatter)
+        sh.setLevel(logging.INFO)
+
+        root.addHandler(sh)
+        root.info('test percent style unicode: %s', '中文')
+
+    def test_format_style_unicode(self):
+        root = logging.getLogger()
+        root.setLevel(logging.INFO)
+
+        formatter = JsonFormatter("""{"log":"{message}"}""", style="{")
+
+        sh = logging.StreamHandler()
+        sh.setFormatter(formatter)
+        sh.setLevel(logging.INFO)
+
+        root.addHandler(sh)
+        root.info('test format style unicode: %s', '中文')
+
+    def test_template_style_unicode(self):
+        root = logging.getLogger()
+        root.setLevel(logging.INFO)
+
+        formatter = JsonFormatter("""{"log":"${message}"}""", style="$")
+
+        sh = logging.StreamHandler()
+        sh.setFormatter(formatter)
+        sh.setLevel(logging.INFO)
+
+        root.addHandler(sh)
+        root.info('test template style unicode: %s', '中文')
+
     def test_dict_format(self):
         DICT_FORMAT = {
             "name": "name",