fix: add ExtendJSONEncoder to safely dump json data with python object, such as MultipartEncoder

docs/CHANGELOG.md

@@ -10,6 +10,7 @@
 **Fixed**
 
 - fix: ensure upload ready
+- fix: add ExtendJSONEncoder to safely dump json data with python object, such as MultipartEncoder
 
 ## 3.0.9 (2020-06-07)
 

httprunner/compat.py

@@ -264,7 +264,7 @@ import time
 import pytest
 from loguru import logger
 
-from httprunner.utils import get_platform
+from httprunner.utils import get_platform, ExtendJSONEncoder
 
 
 @pytest.fixture(scope="session", autouse=True)
@@ -316,7 +316,7 @@ def session_fixture(request):
     os.makedirs(summary_dir, exist_ok=True)
 
     with open(summary_path, "w", encoding="utf-8") as f:
-        json.dump(summary, f, indent=4)
+        json.dump(summary, f, indent=4, ensure_ascii=False, cls=ExtendJSONEncoder)
 
     logger.info(f"generated task summary: {summary_path}")
 

httprunner/utils.py

@@ -212,3 +212,14 @@ def ensure_file_path_valid(file_path: Text) -> Text:
 
     new_file_path = os.path.join(os.getcwd(), f"{os.sep.join(path_names)}{file_suffix}")
     return new_file_path
+
+
+class ExtendJSONEncoder(json.JSONEncoder):
+    """ especially used to safely dump json data with python object, such as MultipartEncoder
+    """
+
+    def default(self, obj):
+        try:
+            return super(ExtendJSONEncoder, self).default(obj)
+        except (UnicodeDecodeError, TypeError):
+            return repr(obj)

tests/utils_test.py

@@ -1,8 +1,10 @@
+import decimal
+import json
 import os
 import unittest
 
 from httprunner import loader, utils
-from httprunner.utils import ensure_file_path_valid
+from httprunner.utils import ensure_file_path_valid, ExtendJSONEncoder
 
 
 class TestUtils(unittest.TestCase):
@@ -116,3 +118,14 @@ class TestUtils(unittest.TestCase):
             ensure_file_path_valid("examples/postman_echo/request_methods/"),
             os.path.join(os.getcwd(), "examples/postman_echo/request_methods"),
         )
+
+    def test_safe_dump_json(self):
+        class A(object):
+            pass
+
+        data = {"a": A(), "b": decimal.Decimal("1.45")}
+
+        with self.assertRaises(TypeError):
+            json.dumps(data)
+
+        json.dumps(data, cls=ExtendJSONEncoder)