Merge branch 'main' into feature/js-test-coverage

Author: Xmader

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/python/pminit/pythonmonkey" # Location of package manifests
+    schedule:
+      interval: "weekly"

include/JSObjectProxy.hh

@@ -112,6 +112,22 @@ public:
    * @return bool - Whether the compared objects are equal or not
    */
   static bool JSObjectProxy_richcompare_helper(JSObjectProxy *self, PyObject *other, std::unordered_map<PyObject *, PyObject *> &visited);
+
+  /**
+   * @brief Return an iterator object to make JSObjectProxy iterable, emitting (key, value) tuples
+   *
+   * @param self - The JSObjectProxy
+   * @return PyObject* - iterator object
+   */
+  static PyObject *JSObjectProxy_iter(JSObjectProxy *self);
+
+  /**
+   * @brief Compute a string representation of the JSObjectProxy
+   *
+   * @param self - The JSObjectProxy
+   * @return the string representation (a PyUnicodeObject) on success, NULL on failure
+   */
+  static PyObject *JSObjectProxy_repr(JSObjectProxy *self);
 };
 
 

include/PyProxyHandler.hh

@@ -181,4 +181,9 @@ public:
   bool delete_(JSContext *cx, JS::HandleObject proxy, JS::HandleId id, JS::ObjectOpResult &result) const override;
 };
 
+/**
+ * @brief Convert jsid to a PyObject to be used as dict keys
+ */
+PyObject *idToKey(JSContext *cx, JS::HandleId id);
+
 #endif

include/StrType.hh

@@ -50,7 +50,7 @@ public:
    * @return PyObject* - the UCS4-encoding of the pyObject string
    *
    */
-  PyObject *asUCS4();
+  static PyObject *asUCS4(PyObject *pyObject);
 };
 
 #endif

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
  *

include/pyTypeFactory.hh

@@ -36,6 +36,11 @@ PyType *pyTypeFactory(PyObject *object);
  * @return PyType* - Pointer to a PyType object corresponding to the JS::Value
  */
 PyType *pyTypeFactory(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Rooted<JS::Value> *rval);
+/**
+ * @brief same to pyTypeFactory, but it's guaranteed that no error would be set on the Python error stack, instead
+ * return `pythonmonkey.null` on error
+ */
+PyType *pyTypeFactorySafe(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Rooted<JS::Value> *rval);
 
 /**
  * @brief Helper function for pyTypeFactory to create FuncTypes through PyCFunction_New
@@ -44,6 +49,6 @@ PyType *pyTypeFactory(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Rooted
  * @param args - Pointer to a PyTupleObject containing the arguments to the python function
  * @return PyObject* - The result of the JSFunction called with args coerced to JS types, coerced back to a PyObject type, or NULL if coercion wasn't possible
  */
-static PyObject *callJSFunc(PyObject *JSFuncAddress, PyObject *args);
+PyObject *callJSFunc(PyObject *JSFuncAddress, PyObject *args);
 
 #endif

python/pythonmonkey/__init__.py

@@ -9,3 +9,18 @@
 # Load the module by default to make `console`/`atob`/`btoa` globally available
 require("console")
 require("base64")
+
+# Add the `.keys()` method on `Object.prototype` to get JSObjectProxy dict() conversion working
+# Conversion from a dict-subclass to a strict dict by `dict(subclass)` internally calls the .keys() method to read the dictionary keys, 
+# but .keys on a JSObjectProxy can only come from the JS side
+pm.eval("""
+(makeList) => {
+  const keysMethod = {
+    get() {
+      return () => makeList(...Object.keys(this))
+    }
+  }
+  Object.defineProperty(Object.prototype, "keys", keysMethod)
+  Object.defineProperty(Array.prototype, "keys", keysMethod)
+}
+""")(lambda *args: list(args))

python/pythonmonkey/cli/pmjs.py

@@ -6,7 +6,7 @@
 import sys, os, readline, signal, getopt
 import pythonmonkey as pm
 globalThis = pm.eval("globalThis")
-evalOptions = { 'strict': False }
+evalOpts = { 'filename': __file__, 'fromPythonFrame': True, 'strict': False }
 
 if (os.getenv('PMJS_PATH')):
     requirePath = list(map(os.path.abspath, os.getenv('PMJS_PATH').split(':')))
@@ -42,12 +42,23 @@
   }
 
   if (cmd === '')
+  {
     return;
+  }
+  
+  try {
+    if (arguments[0] === 'from' || arguments[0] === 'import')
+    {
+      return python.exec(cmd);
+    }
 
-  if (arguments[0] === 'from' || arguments[0] === 'import')
-    return python.exec(cmd);
-
-  const retval = python.eval(cmd);
+    const retval = python.eval(cmd);
+  }
+  catch(error) {
+    globalThis._error = error;
+    return util.inspect(error);
+  }
+  
   pythonCmd.serial = (pythonCmd.serial || 0) + 1;
   globalThis['$' + pythonCmd.serial] = retval;
   python.stdout.write('$' + pythonCmd.serial + ' = ');
@@ -130,7 +141,7 @@
     return util.inspect(error);
   }
 }
-""");
+""", evalOpts);
 
 def repl():
     """
@@ -322,21 +333,20 @@ def main():
             print(pm.__version__)
             sys.exit()
         elif o in ("--use-strict"):
-            evalOptions['strict'] = True
+            evalOpts['strict'] = True
         elif o in ("-h", "--help"):
             usage()
             sys.exit()
         elif o in ("-i", "--interactive"):
             forceRepl = True
         elif o in ("-e", "--eval"):
-            pm.eval(a, evalOptions)
+            pm.eval(a, evalOpts)
             enterRepl = False
         elif o in ("-p", "--print"):
-            print(pm.eval(a, evalOptions))
+            print(pm.eval(a, evalOpts))
             enterRepl = False
         elif o in ("-r", "--require"):
             globalThis.require(a)
-            #            pm.eval('require')(a)
         else:
             assert False, "unhandled option"
 

python/pythonmonkey/pythonmonkey.pyi

@@ -5,8 +5,19 @@ stub file for type hints & documentations for the native module
 
 import typing as _typing
 
+class EvalOptions(_typing.TypedDict, total=False):
+    filename: str
+    lineno: int
+    column: int
+    mutedErrors: bool
+    noScriptRval: bool
+    selfHosting: bool
+    strict: bool
+    module: bool
+    fromPythonFrame: bool
+
 # pylint: disable=redefined-builtin
-def eval(code: str, /) -> _typing.Any:
+def eval(code: str, evalOpts: EvalOptions = {}, /) -> _typing.Any:
     """
     JavaScript evaluator in Python
     """
@@ -16,15 +27,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

python/pythonmonkey/require.py

@@ -40,10 +40,11 @@
     "node_modules"
   )
 )
+evalOpts = { 'filename': __file__, 'fromPythonFrame': True }
 
 # Add some python functions to the global python object for code in this file to use.
-globalThis = pm.eval("globalThis;")
-pm.eval("globalThis.python = { pythonMonkey: {}, stdout: {}, stderr: {} }")
+globalThis = pm.eval("globalThis;", evalOpts)
+pm.eval("globalThis.python = { pythonMonkey: {}, stdout: {}, stderr: {} }", evalOpts);
 globalThis.pmEval = pm.eval
 globalThis.python.pythonMonkey.dir = os.path.dirname(__file__)
 #globalThis.python.pythonMonkey.version = pm.__version__
@@ -59,15 +60,15 @@
 globalThis.python.exec = exec
 globalThis.python.getenv = os.getenv
 globalThis.python.paths  = ':'.join(sys.path)
-pm.eval("python.paths = python.paths.split(':');"); # fix when pm supports arrays
+pm.eval("python.paths = python.paths.split(':');", evalOpts); # fix when pm supports arrays
 
 globalThis.python.exit = pm.eval("""'use strict';
 (exit) => function pythonExitWrapper(exitCode) {
   if (typeof exitCode === 'number')
     exitCode = BigInt(Math.floor(exitCode));
   exit(exitCode);
 }
-""")(sys.exit);
+""", evalOpts)(sys.exit);
 
 # bootstrap is effectively a scoping object which keeps us from polluting the global JS scope.
 # The idea is that we hold a reference to the bootstrap object in Python-load, for use by the
@@ -78,7 +79,7 @@
 
 const bootstrap = {
   modules: {
-    vm: { runInContext: eval },
+    vm: {},
     'ctx-module': {},
   },
 }
@@ -92,7 +93,7 @@
   throw new Error('module not found: ' + mid);
 }
 
-bootstrap.modules.vm.runInContext_broken = function runInContext(code, _unused_contextifiedObject, options)
+bootstrap.modules.vm.runInContext = function runInContext(code, _unused_contextifiedObject, options)
 {
   var evalOptions = {};
 
@@ -169,7 +170,7 @@
 globalThis.bootstrap = bootstrap;
 
 return bootstrap;
-})(globalThis.python)""")
+})(globalThis.python)""", evalOpts)
 
 def statSync_inner(filename: str) -> Union[Dict[str, int], bool]:
     """
@@ -208,15 +209,18 @@ def existsSync(filename: str) -> bool:
 # require and exports symbols injected from the bootstrap object above. Current PythonMonkey bugs
 # prevent us from injecting names properly so they are stolen from trail left behind in the global
 # scope until that can be fixed.
+#
+# lineno should be -5 but jsapi 102 uses unsigned line numbers, so we take the newlines out of the
+# wrapper prologue to make stack traces line up.
 with open(node_modules + "/ctx-module/ctx-module.js", "r") as ctxModuleSource:
     initCtxModule = pm.eval("""'use strict';
 (function moduleWrapper_forCtxModule(broken_require, broken_exports)
 {
   const require = bootstrap.require;
   const exports = bootstrap.modules['ctx-module'];
-""" + ctxModuleSource.read() + """
+""".replace("\n", " ") + "\n" + ctxModuleSource.read() + """
 })
-""");
+""", { 'filename': node_modules + "/ctx-module/ctx-module.js", 'lineno': 0 });
 #broken initCtxModule(bootstrap.require, bootstrap.modules['ctx-module'].exports)
 initCtxModule();
 
@@ -298,7 +302,7 @@ def _createRequireInner(*args):
     module.require.path.splice(module.require.path.length, 0, ...(extraPaths.split(':')));
 
   return module.require;
-})""")(*args)
+})""", evalOpts)(*args)
 
 def createRequire(filename, extraPaths: Union[List[str], Literal[False]] = False, isMain = False):
     """
@@ -331,7 +335,7 @@ def runProgramModule(filename, argv, extraPaths=[]):
     globalThis.__filename = fullFilename;
     globalThis.__dirname = os.path.dirname(fullFilename);
     with open(fullFilename, encoding="utf-8", mode="r") as mainModuleSource:
-        pm.eval(mainModuleSource.read())
+        pm.eval(mainModuleSource.read(), {'filename': fullFilename})
 
 def require(moduleIdentifier: str):
     # Retrieve the caller’s filename from the call stack