Merge branch 'main' into Xmader/fix/JSObjectProxy-as-dict

Xmader · web-flow · commit 0f06ca12e735 · 2023-07-19T14:49:08.000-04:00
diff --git a/.github/ISSUE_TEMPLATE/bug_pythonmonkey.yaml b/.github/ISSUE_TEMPLATE/bug_pythonmonkey.yaml
@@ -0,0 +1,80 @@
+name: File a Bug Report for PythonMonkey
+description: Use this template to report PythonMonkey-related issues. Thank you so much for making an issue!
+body:
+  - type: dropdown
+    id: issue-type
+    attributes:
+      label: Issue type
+      description: What type of issue would you like to report?
+      multiple: false
+      options:
+        - Bug
+        - Build/Install
+        - Performance
+        - Support
+        - Documentation Bug / Error
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: source
+    attributes:
+      label: How did you install PythonMonkey?
+      options:
+        - Source
+        - Installed from pip
+        - Other (Please specify in additional info)
+
+  - type: input
+    id: OS
+    attributes:
+      label: OS platform and distribution
+      placeholder: e.g., Linux Ubuntu 22.04
+
+  - type: input
+    id: Python
+    attributes:
+      label: Python version (`python --version`)
+      placeholder: e.g., 3.9
+
+  - type: input
+    id: PythonMonkey
+    attributes:
+      label: PythonMonkey version (`pip show pythonmonkey`)
+      placeholder: 0.2.0 or 0.0.1.dev997+1eb883
+      description: You can also get this with `pmjs --version`.
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Bug Description
+      description: Please provide a clear and concise description of what the bug is.
+
+  - type: textarea
+    id: code-to-reproduce
+    attributes:
+      label: Standalone code to reproduce the issue
+      description: Provide a reproducible test case that is the bare minimum necessary to generate the problem.
+      value:
+      render: shell
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output or backtrace
+      description: Please copy and paste any relevant log output.
+      render: shell
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional info if applicable
+      description: Anything else to add.
+      render: shell
+
+  - type: input
+    id: branch
+    attributes:
+      label: What branch of PythonMonkey were you developing on? (If applicable)
+      placeholder: main
diff --git a/.github/ISSUE_TEMPLATE/feature_pythonmonkey.yaml b/.github/ISSUE_TEMPLATE/feature_pythonmonkey.yaml
@@ -0,0 +1,18 @@
+name: Make a Feature Request for PythonMonkey 
+description: Use this template to make feature requests for PythonMonkey. Thank you so much for making an issue!
+body:
+
+  - type: textarea
+    id: feature-body
+    attributes:
+      label: Describe your feature request here.
+      description: Feel free to include diagrams drawings or anything else to help explain it.
+
+  - type: textarea
+    id: feature-code
+    attributes:
+      label: Code example
+      description: Provide a code example of this feature if applicable.
+      value:
+      render: shell
+
diff --git a/README.md b/README.md
@@ -307,7 +307,7 @@ If you are having trouble with the CommonJS require function, set environment va
 - the `-r` option can be used to load a module before your program or the REPL runs
 - the `-e` option can be used evaluate code -- e.g. define global variables -- before your program or the REPL runs
 - The REPL can evaluate Python expressions, storing them in variables named `$1`, `$2`, etc. ```
-# ./pmjs
+# pmjs
 Welcome to PythonMonkey v0.2.0.
 Type ".help" for more information.
 > .python import sys
diff --git a/include/pyTypeFactory.hh b/include/pyTypeFactory.hh
@@ -49,6 +49,6 @@ PyType *pyTypeFactorySafe(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Ro
  * @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
diff --git a/peter-jr b/peter-jr
@@ -46,7 +46,7 @@ fi
 [ "${1:-}" ] || set "${topDir}/tests/js"
 testLocations=("$@")
 
-export PMJS="${topDir}/pmjs"
+export PMJS="pmjs"
 
 function panic()
 {
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,7 +43,10 @@ bump = true
 
 [tool.poetry.build]
 script = "build.py"
-generate-setup-file = false 
+generate-setup-file = false
+
+[tool.poetry.scripts]
+pmjs = "pythonmonkey.cli.pmjs:main"
 
 
 [tool.poetry.group.dev.dependencies]
diff --git a/python/pythonmonkey/builtin_modules/util.js b/python/pythonmonkey/builtin_modules/util.js
@@ -1,5 +1,8 @@
 /**
  * @file     util.js
+ *           Node.js-style util.inspect implementation, largely based on 
+ *           https://github.com/nodejs/node/blob/v8.17.0/lib/util.js. 
+ *
  * @author   Tom Tang <xmader@distributive.network>
  * @date     June 2023
  */
@@ -532,7 +535,8 @@ function formatValue(ctx, value, recurseTimes, ln) {
       // Make error with message first say the error
       if (keyLength === 0)
         return formatError(ctx, value);
-      base = ` ${formatError(ctx, value)}`;
+      base = ` ${formatError(ctx, value)}\n`;
+      braces.length=0;
     } else if (isAnyArrayBuffer(value)) {
       // Fast path for ArrayBuffer and SharedArrayBuffer.
       // Can't do the same for DataView because it has a non-primitive
@@ -647,10 +651,11 @@ function formatError(ctx, error)
         .split('\n')
         .filter(a => a.length > 0)
         .map(a => `    ${a}`);
-  return (`${error.name}: ${error.message}\n`
-          + stackEls[0] + '\n'
-          + style(stackEls.slice(1).join('\n'))
-         );
+  const retstr =
+        `${error.name}: ${error.message}\n`
+        + stackEls[0] + '\n'
+        + style(stackEls.slice(1).join('\n'));
+  return retstr;
 }
 
 function formatObject(ctx, value, recurseTimes, keys) {
@@ -871,7 +876,12 @@ function reduceToSingleString(ctx, output, base, braces, addLn) {
       }
     }
     if (length <= breakLength)
-      return `${braces[0]}${base} ${join(output, ', ')} ${braces[1]}`;
+    {
+      if (braces.length)
+        return `${braces[0]}${base} ${join(output, ', ')} ${braces[1]}`;
+      else
+        return `${base} ${join(output, ', ')}`;
+    }
   }
   // If the opening "brace" is too large, like in the case of "Set {",
   // we need to force the first item to be on the next line or the
@@ -881,6 +891,7 @@ function reduceToSingleString(ctx, output, base, braces, addLn) {
   const ln = base === '' && braces[0].length === 1 ?
     ' ' : `${base}\n${indentation}  `;
   const str = join(output, `,\n${indentation}  `);
+
   return `${extraLn}${braces[0]}${ln}${str} ${braces[1]}`;
 }
 
diff --git a/python/pythonmonkey/cli/__init__.py b/python/pythonmonkey/cli/__init__.py
diff --git a/python/pythonmonkey/cli/pmjs.py b/python/pythonmonkey/cli/pmjs.py
@@ -290,7 +290,7 @@ def initGlobalThis():
 
     require = pm.createRequire(os.path.abspath(os.getcwd() + '/__pmjs_virtual__'), requirePath)
     globalThis.require = require
-    globalInitModule = require(os.path.dirname(__file__) + "/pmjs-lib/global-init") # module load has side-effects
+    globalInitModule = require(os.path.dirname(__file__) + "/../lib/pmjs/global-init") # module load has side-effects
     argvBuilder = globalInitModule.makeArgvBuilder()
     for arg in sys.argv:
         argvBuilder(arg); # list=>Array not working yet
diff --git a/python/pythonmonkey/lib/pmjs/global-init.js b/python/pythonmonkey/lib/pmjs/global-init.js
diff --git a/python/pythonmonkey/require.py b/python/pythonmonkey/require.py
@@ -48,7 +48,8 @@
 globalThis.python.pythonMonkey.dir = os.path.dirname(__file__)
 #globalThis.python.pythonMonkey.version = pm.__version__
 #globalThis.python.pythonMonkey.module = pm
-globalThis.python.pythonMonkey.isCompilableUnit = pm.isCompilableUnit;
+globalThis.python.pythonMonkey.isCompilableUnit = pm.isCompilableUnit
+globalThis.python.pythonMonkey.nodeModules = node_modules
 globalThis.python.print  = print
 globalThis.python.stdout.write = sys.stdout.write
 globalThis.python.stderr.write = sys.stderr.write
@@ -272,10 +273,15 @@ def _createRequireInner(*args):
     module.exports = python.load(filename);
   }
 
+  if (moduleCache[filename])
+    return moduleCache[filename].require;
+
   const module = new CtxModule(globalThis, filename, moduleCache);
+  moduleCache[filename] = module;
   for (let path of python.paths)
     module.paths.push(path + '/node_modules');
   module.require.path.push(python.pythonMonkey.dir + '/builtin_modules');
+  module.require.path.push(python.pythonMonkey.nodeModules);
   module.require.extensions['.py'] = loadPythonModule;
 
   if (isMain)
diff --git a/src/PromiseType.cc b/src/PromiseType.cc
@@ -140,14 +140,8 @@ JSObject *PromiseType::toJsPromise(JSContext *cx) {
 }
 
 bool PythonAwaitable_Check(PyObject *obj) {
-  // result = inspect.isawaitable(obj)
-  //    see https://docs.python.org/3.9/library/inspect.html#inspect.isawaitable
-  //        https://github.com/python/cpython/blob/3.9/Lib/inspect.py#L230-L235
-  PyObject *inspect = PyImport_ImportModule("inspect");
-  PyObject *result = PyObject_CallMethod(inspect, "isawaitable", "O", obj); // https://docs.python.org/3/c-api/arg.html#c.Py_BuildValue
-  bool isAwaitable = result == Py_True;
-  // cleanup
-  Py_DECREF(inspect);
-  Py_DECREF(result);
+  // see https://docs.python.org/3/c-api/typeobj.html#c.PyAsyncMethods
+  PyTypeObject *tp = Py_TYPE(obj);
+  bool isAwaitable = tp->tp_as_async != NULL && tp->tp_as_async->am_await != NULL;
   return isAwaitable;
 }
diff --git a/src/jsTypeFactory.cc b/src/jsTypeFactory.cc
@@ -117,6 +117,12 @@ JS::Value jsTypeFactory(JSContext *cx, PyObject *object) {
     }
     memoizePyTypeAndGCThing(new StrType(object), returnType);
   }
+  else if (PyCFunction_Check(object) && PyCFunction_GetFunction(object) == callJSFunc) {
+    // If it's a wrapped JS function by us, return the underlying JS function rather than wrapping it again
+    PyObject *jsCxThisFuncTuple = PyCFunction_GetSelf(object);
+    JS::RootedValue *jsFunc = (JS::RootedValue *)PyLong_AsVoidPtr(PyTuple_GetItem(jsCxThisFuncTuple, 2));
+    returnType.set(*jsFunc);
+  }
   else if (PyFunction_Check(object) || PyCFunction_Check(object)) {
     // can't determine number of arguments for PyCFunctions, so just assume potentially unbounded
     uint16_t nargs = 0;
@@ -196,6 +202,21 @@ JS::Value jsTypeFactorySafe(JSContext *cx, PyObject *object) {
   return v;
 }
 
+void setPyException(JSContext *cx) {
+  // Python `exit` and `sys.exit` only raise a SystemExit exception to end the program
+  // We definitely don't want to catch it in JS
+  if (PyErr_ExceptionMatches(PyExc_SystemExit)) {
+    return;
+  }
+
+  PyObject *type, *value, *traceback;
+  PyErr_Fetch(&type, &value, &traceback); // also clears the error indicator
+
+  JSObject *jsException = ExceptionType(value).toJsError(cx);
+  JS::RootedValue jsExceptionValue(cx, JS::ObjectValue(*jsException));
+  JS_SetPendingException(cx, jsExceptionValue);
+}
+
 bool callPyFunc(JSContext *cx, unsigned int argc, JS::Value *vp) {
   JS::CallArgs callargs = JS::CallArgsFromVp(argc, vp);
 
@@ -213,6 +234,7 @@ bool callPyFunc(JSContext *cx, unsigned int argc, JS::Value *vp) {
     PyObject *pyRval = _PyObject_CallNoArg(pyFunc); // in Python 3.8, the API is only available under the name with a leading underscore
     #endif
     if (PyErr_Occurred()) { // Check if an exception has already been set in Python error stack
+      setPyException(cx);
       return false;
     }
     // @TODO (Caleb Aikens) need to check for python exceptions here
@@ -225,16 +247,21 @@ bool callPyFunc(JSContext *cx, unsigned int argc, JS::Value *vp) {
   for (size_t i = 0; i < callargs.length(); i++) {
     JS::RootedValue *jsArg = new JS::RootedValue(cx, callargs[i]);
     PyType *pyArg = pyTypeFactory(cx, thisv, jsArg);
-    PyTuple_SetItem(pyArgs, i, pyArg->getPyObject());
+    if (!pyArg) return false; // error occurred
+    PyObject *pyArgObj = pyArg->getPyObject();
+    if (!pyArgObj) return false; // error occurred
+    PyTuple_SetItem(pyArgs, i, pyArgObj);
   }
 
   PyObject *pyRval = PyObject_Call(pyFunc, pyArgs, NULL);
   if (PyErr_Occurred()) {
+    setPyException(cx);
     return false;
   }
   // @TODO (Caleb Aikens) need to check for python exceptions here
   callargs.rval().set(jsTypeFactory(cx, pyRval));
   if (PyErr_Occurred()) {
+    setPyException(cx);
     return false;
   }
 
diff --git a/src/pyTypeFactory.cc b/src/pyTypeFactory.cc
@@ -32,6 +32,7 @@
 #include "include/modules/pythonmonkey/pythonmonkey.hh"
 
 #include <jsapi.h>
+#include <jsfriendapi.h>
 #include <js/Object.h>
 #include <js/ValueArray.h>
 
@@ -123,9 +124,16 @@ PyType *pyTypeFactory(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Rooted
         return new ExceptionType(cx, obj);
       }
     case js::ESClass::Function: {
-        // FIXME (Tom Tang): `jsCxThisFuncTuple` and the tuple items are not going to be GCed
-        PyObject *jsCxThisFuncTuple = PyTuple_Pack(3, PyLong_FromVoidPtr(cx), PyLong_FromVoidPtr(thisObj), PyLong_FromVoidPtr(rval));
-        PyObject *pyFunc = PyCFunction_New(&callJSFuncDef, jsCxThisFuncTuple);
+        PyObject *pyFunc;
+        if (JS_IsNativeFunction(obj, callPyFunc)) { // It's a wrapped python function by us
+          // Get the underlying python function from the 0th reserved slot
+          JS::Value pyFuncVal = js::GetFunctionNativeReserved(obj, 0);
+          pyFunc = (PyObject *)(pyFuncVal.toPrivate());
+        } else {
+          // FIXME (Tom Tang): `jsCxThisFuncTuple` and the tuple items are not going to be GCed
+          PyObject *jsCxThisFuncTuple = PyTuple_Pack(3, PyLong_FromVoidPtr(cx), PyLong_FromVoidPtr(thisObj), PyLong_FromVoidPtr(rval));
+          pyFunc = PyCFunction_New(&callJSFuncDef, jsCxThisFuncTuple);
+        }
         FuncType *f = new FuncType(pyFunc);
         memoizePyTypeAndGCThing(f, *rval); // TODO (Caleb Aikens) consider putting this in the FuncType constructor
         return f;
@@ -178,7 +186,7 @@ PyType *pyTypeFactorySafe(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Ro
   return v;
 }
 
-static PyObject *callJSFunc(PyObject *jsCxThisFuncTuple, PyObject *args) {
+PyObject *callJSFunc(PyObject *jsCxThisFuncTuple, PyObject *args) {
   // TODO (Caleb Aikens) convert PyObject *args to JS::Rooted<JS::ValueArray> JSargs
   JSContext *cx = (JSContext *)PyLong_AsVoidPtr(PyTuple_GetItem(jsCxThisFuncTuple, 0));
   JS::RootedObject *thisObj = (JS::RootedObject *)PyLong_AsVoidPtr(PyTuple_GetItem(jsCxThisFuncTuple, 1));
diff --git a/tests/js/commonjs-modules.bash b/tests/js/commonjs-modules.bash
@@ -19,7 +19,7 @@ runTest()
   set -o pipefail
   echo -n "${testName}: "
 
-  PMJS_PATH="`pwd`" ../../../../../../pmjs -e 'print=python.print' program.js\
+  PMJS_PATH="`pwd`" pmjs -e 'print=python.print' program.js\
   | while read word rest
     do
       case "$word" in
diff --git a/tests/js/console-stdio.bash b/tests/js/console-stdio.bash
@@ -17,7 +17,7 @@ panic()
 
 cd `dirname "$0"` || panic "could not change to test directory"
 
-"${PMJS:-../../pmjs}" \
+"${PMJS:-pmjs}" \
 -e 'console.log("stdout")' \
 -e 'console.debug("stdout")' \
 -e 'console.info("stdout")' \
@@ -30,7 +30,7 @@ cd `dirname "$0"` || panic "could not change to test directory"
     break
   done || exit $?
 
-"${PMJS:-../../pmjs}" \
+"${PMJS:-pmjs}" \
 -e 'console.error("stderr")' \
 -e 'console.warn("stderr")' \
 < /dev/null 2>&1 \
diff --git a/tests/js/pmjs-eopt.bash b/tests/js/pmjs-eopt.bash
@@ -17,7 +17,7 @@ panic()
 
 cd `dirname "$0"` || panic "could not change to test directory"
 
-"${PMJS:-../../pmjs}" -e 'console.log("OKAY")' < /dev/null |\
+"${PMJS:-pmjs}" -e 'console.log("OKAY")' < /dev/null |\
 while read keyword rest
 do
   case "$keyword" in
diff --git a/tests/js/pmjs-global-arguments.bash b/tests/js/pmjs-global-arguments.bash
@@ -19,7 +19,7 @@ panic()
 cd `dirname "$0"` || panic "could not change to test directory"
 
 argc=0
-"${PMJS:-../../pmjs}" program.js abc easy as one two three |\
+"${PMJS:-pmjs}" program.js abc easy as one two three |\
 while read keyword rest
 do
   case "$keyword" in
diff --git a/tests/js/pmjs-interactive-smoke.bash b/tests/js/pmjs-interactive-smoke.bash
diff --git a/tests/js/pmjs-popt.bash b/tests/js/pmjs-popt.bash
diff --git a/tests/js/pmjs-require-cache.bash b/tests/js/pmjs-require-cache.bash
diff --git a/tests/js/pmjs-ropt.bash b/tests/js/pmjs-ropt.bash
diff --git a/tests/python/test_pythonmonkey_eval.py b/tests/python/test_pythonmonkey_eval.py

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ fi`
`46`	`46`	`[ "${1:-}" ] \|\| set "${topDir}/tests/js"`
`47`	`47`	`testLocations=("$@")`
`48`	`48`
`49`		`-export PMJS="${topDir}/pmjs"`
	`49`	`+export PMJS="pmjs"`
`50`	`50`
`51`	`51`	`function panic()`
`52`	`52`	`{`