https://github.com/robotframework-thailand/robotframework-jsonlibrary/issues/59

Author: NorseGaud

AGENT.md

@@ -1,3 +1,4 @@
 # Rules
 
 - Use DRY when possible to not repeat yourself.
+- Run the `run_ci_checks.sh` script anytime you make changes and fix any errors or warnings that it finds.

JSONLib/jsonlib.py

@@ -202,22 +202,25 @@ def delete_object_from_json(self, json_object, json_path):
         return json_object_cpy
 
     @staticmethod
-    def convert_json_to_string(json_object, indent=None):
+    def convert_json_to_string(json_object, indent=None, ensure_ascii=True):
         """Convert JSON object to string
 
         Arguments:
             - json_object: json as a dictionary object.
             - indent: indent level for pretty-printing, see indent argument of
               python's [https://docs.python.org/3/library/json.html#json.dump|json.dump()]
               for details
+            - ensure_ascii: if True (default), escape all non-ASCII characters.
+              If False, non-ASCII characters are preserved in the output.
 
         Return new json_string
 
         Examples:
         | ${json_str}=  |  Convert JSON To String | ${json_obj} |
         | ${json_str}=  |  Convert JSON To String | ${json_obj} | indent=${4} |
+        | ${json_str}=  |  Convert JSON To String | ${json_obj} | indent=${4} | ensure_ascii=False |
         """
-        return json.dumps(json_object, indent=indent)
+        return json.dumps(json_object, indent=indent, ensure_ascii=ensure_ascii)
 
     @staticmethod
     def convert_string_to_json(json_string):

acceptance/JSONLib.robot

@@ -82,6 +82,34 @@ TestConvertJSONToString
     ${json_str}=    Convert Json To String    ${json_obj_input}
     Should Be String    ${json_str}
 
+TestEnsureAsciiDefault
+    [Documentation]  Test that ensure_ascii=True by default (escapes non-ASCII)
+    ${json_obj}=    Create Dictionary    test=über
+    ${json_str}=    Convert Json To String    ${json_obj}
+    Should Contain    ${json_str}    \\u00fc
+    Should Not Contain    ${json_str}    über
+
+TestEnsureAsciiTrue
+    [Documentation]  Test that ensure_ascii=True explicitly escapes non-ASCII
+    ${json_obj}=    Create Dictionary    test=café    greeting=你好
+    ${json_str}=    Convert Json To String    ${json_obj}    ensure_ascii=True
+    Should Contain    ${json_str}    \\u
+    Should Not Contain    ${json_str}    café
+
+TestEnsureAsciiFalse
+    [Documentation]  Test that ensure_ascii=False preserves UTF-8 characters
+    ${json_obj}=    Create Dictionary    test=über    greeting=你好    coffee=café
+    ${json_str}=    Convert Json To String    ${json_obj}    ensure_ascii=False
+    Should Contain    ${json_str}    über
+    Should Contain    ${json_str}    你好
+    Should Contain    ${json_str}    café
+
+TestEnsureAsciiFalseWithIndent
+    [Documentation]  Test that ensure_ascii=False works with indent
+    ${json_obj}=    Create Dictionary    test=über
+    ${json_str}=    Convert Json To String    ${json_obj}    indent=${4}    ensure_ascii=False
+    Should Contain    ${json_str}    über
+
 TestDumpJSONToFile
     [Documentation]    Dumps Json to file
     Dump Json to file    ${TEMPDIR}/sample_dump.json    ${json_obj_input}

docs/index.html

@@ -158,6 +158,49 @@ def test_convert_json_to_string_with_indent(self, json):
         assert len(json_str_as_list := json_str.split("\n")) == 45
         assert json_str_as_list[1][:4] == " " * 4
 
+    def test_convert_json_to_string_ensure_ascii_default(self):
+        """Test that ensure_ascii=True by default (escapes non-ASCII characters)"""
+        json_obj = {"test": "über"}
+        json_str = self.json_library.convert_json_to_string(json_obj)
+        # With ensure_ascii=True, ü should be escaped as \u00fc
+        assert "\\u00fc" in json_str
+        assert "über" not in json_str
+
+    def test_convert_json_to_string_ensure_ascii_true(self):
+        """Test that ensure_ascii=True explicitly escapes non-ASCII characters"""
+        json_obj = {"test": "café", "greeting": "你好"}
+        json_str = self.json_library.convert_json_to_string(json_obj, ensure_ascii=True)
+        # With ensure_ascii=True, non-ASCII characters should be escaped
+        assert "\\u00e9" in json_str  # é
+        assert "café" not in json_str
+        assert "你好" not in json_str
+
+    def test_convert_json_to_string_ensure_ascii_false(self):
+        """Test that ensure_ascii=False preserves UTF-8 characters"""
+        json_obj = {"test": "über", "greeting": "你好", "coffee": "café"}
+        json_str = self.json_library.convert_json_to_string(
+            json_obj, ensure_ascii=False
+        )
+        # With ensure_ascii=False, UTF-8 characters should be preserved
+        assert "über" in json_str
+        assert "你好" in json_str
+        assert "café" in json_str
+        # Should not have escape sequences
+        assert "\\u00fc" not in json_str
+        assert "\\u00e9" not in json_str
+
+    def test_convert_json_to_string_ensure_ascii_false_with_indent(self):
+        """Test that ensure_ascii=False works with indent parameter"""
+        json_obj = {"test": "über", "nested": {"greeting": "你好"}}
+        json_str = self.json_library.convert_json_to_string(
+            json_obj, indent=2, ensure_ascii=False
+        )
+        # With ensure_ascii=False, UTF-8 characters should be preserved
+        assert "über" in json_str
+        assert "你好" in json_str
+        # Should also be properly indented
+        assert "\n" in json_str
+
     def test_convert_string_to_json(self, json):
         json_obj = self.json_library.convert_string_to_json('{"firstName": "John"}')
         assert "firstName" in json_obj