refactor(string): remove pm.asUCS4 method as encoding conversion is done automatically

Author: Xmader

include/modules/pythonmonkey/pythonmonkey.hh

@@ -64,15 +64,6 @@ void handleSharedPythonMonkeyMemory(JSContext *cx, JSGCStatus status, JS::GCReas
  */
 static PyObject *collect(PyObject *self, PyObject *args);
 
-/**
- * @brief Function exposed by the python module to convert UTF16 strings to UCS4 strings
- *
- * @param self - Pointer to the module object
- * @param args - Pointer to the python tuple of arguments (expected to contain a UTF16-encoded string as the first element)
- * @return PyObject* - A new python string in UCS4 encoding
- */
-static PyObject *asUCS4(PyObject *self, PyObject *args);
-
 /**
  * @brief Function exposed by the python module for evaluating arbitrary JS code
  *

python/pythonmonkey/pythonmonkey.pyi

@@ -16,15 +16,6 @@ def collect() -> None:
     Calls the spidermonkey garbage collector
     """
 
-@_typing.overload
-def asUCS4(utf16_str: str, /) -> str:
-    """
-    Expects a python string in UTF16 encoding, and returns a new equivalent string in UCS4.
-    Undefined behaviour if the string is not in UTF16.
-    """
-@_typing.overload
-def asUCS4(anything_else: _typing.Any, /) -> _typing.NoReturn: ...
-
 class bigint(int):
     """
     Representing JavaScript BigInt in Python

src/modules/pythonmonkey/pythonmonkey.cc

@@ -142,21 +142,6 @@ static PyObject *collect(PyObject *self, PyObject *args) {
   Py_RETURN_NONE;
 }
 
-static PyObject *asUCS4(PyObject *self, PyObject *args) {
-  PyObject *str = PyTuple_GetItem(args, 0);
-  if (!PyUnicode_Check(str)) {
-    PyErr_SetString(PyExc_TypeError, "pythonmonkey.asUCS4 expects a string as its first argument");
-    return NULL;
-  }
-
-  PyObject *ucs4Str = StrType::asUCS4(str);
-  if (!ucs4Str) {
-    PyErr_SetString(PyExc_UnicodeTranslateError, "string contains an unpaired surrogates");
-    return NULL;
-  }
-  return ucs4Str;
-}
-
 static bool getEvalOption(PyObject *evalOptions, const char *optionName, const char **s_p) {
   PyObject *value;
 
@@ -287,7 +272,6 @@ PyMethodDef PythonMonkeyMethods[] = {
   {"eval", eval, METH_VARARGS, "Javascript evaluator in Python"},
   {"isCompilableUnit", isCompilableUnit, METH_VARARGS, "Hint if a string might be compilable Javascript"},
   {"collect", collect, METH_VARARGS, "Calls the spidermonkey garbage collector"},
-  {"asUCS4", asUCS4, METH_VARARGS, "Expects a python string in UTF16 encoding, and returns a new equivalent string in UCS4. Undefined behaviour if the string is not in UTF16."},
   {NULL, NULL, 0, NULL}
 };
 

tests/python/test_pythonmonkey_eval.py

@@ -201,7 +201,7 @@ def test_eval_functions_ucs4_string_args():
             codepoint = random.randint(0x010000, 0x10FFFF)
             string2 += chr(codepoint)
 
-        assert pm.asUCS4(concatenate(string1, string2)) == (string1 + string2)
+        assert concatenate(string1, string2) == (string1 + string2)
 
 def test_eval_functions_roundtrip():
     # BF-60 https://github.com/Distributive-Network/PythonMonkey/pull/18

tests/python/test_strings.py

@@ -29,8 +29,7 @@ def test_eval_unpaired_surrogate_string_matches_evaluated_string():
 
 def test_eval_ucs4_string_matches_evaluated_string():
     py_ucs4_string = "🀄🀛🜢"
-    js_utf16_string = pm.eval(repr(py_ucs4_string))
-    js_ucs4_string = pm.asUCS4(js_utf16_string)
+    js_ucs4_string = pm.eval(repr(py_ucs4_string))
     assert py_ucs4_string == js_ucs4_string
 
 def test_eval_latin1_string_fuzztest():
@@ -111,8 +110,7 @@ def test_eval_ucs4_string_fuzztest():
         INITIAL_STRING = string1
         m = 10
         for _ in range(m):
-            utf16_string2 = pm.eval("'" + string1 + "'")
-            string2 = pm.asUCS4(utf16_string2)
+            string2 = pm.eval("'" + string1 + "'")
             assert len(string1) == length
             assert len(string2) == length
             assert len(string1) == len(string2)
@@ -158,8 +156,7 @@ def test_eval_boxed_unpaired_surrogate_string_matches_evaluated_string():
 
 def test_eval_boxed_ucs4_string_matches_evaluated_string():
     py_ucs4_string = "🀄🀛🜢"
-    js_utf16_string = pm.eval(f'new String({repr(py_ucs4_string)})')
-    js_ucs4_string = pm.asUCS4(js_utf16_string)
+    js_ucs4_string = pm.eval(f'new String({repr(py_ucs4_string)})')
     assert py_ucs4_string == js_ucs4_string
 
 def test_eval_boxed_latin1_string_fuzztest():
@@ -240,8 +237,7 @@ def test_eval_boxed_ucs4_string_fuzztest():
         INITIAL_STRING = string1
         m = 10
         for _ in range(m):
-            utf16_string2 = pm.eval(f'new String("{string1}")')
-            string2 = pm.asUCS4(utf16_string2)
+            string2 = pm.eval(f'new String("{string1}")')
             assert len(string1) == length
             assert len(string2) == length
             assert len(string1) == len(string2)