Merge branch 'wes/module-system' into Xmader/feat/post-install-npm

Author: Xmader

CMakeLists.txt

@@ -1,6 +1,6 @@
 # Copyright (c) 2022 Distributive Inc. All Rights Reserved.
 
-cmake_minimum_required(VERSION 3.4...3.18) # Set minimum cmake version
+cmake_minimum_required(VERSION 3.25) # Set minimum cmake version
 
 project("PythonMonkey"
   DESCRIPTION "A tool for Javascript-Python interoperability."

include/JSObjectProxy.hh

@@ -57,15 +57,6 @@ public:
    */
   static int JSObjectProxy_init(JSObjectProxy *self, PyObject *args, PyObject *kwds);
 
-  /**
-   * @brief Helper function for JSObjectProxy_init
-   *
-   * @param jsObject - The underlying backing store JSObject for the JSObjectProxy
-   * @param dict - The python dict to be converted into a JSObjectProxy
-   * @param subValsMap - A map of PyObject to JS::Value pairs, representing values that have been visited so far
-   */
-  static void JSObjectProxy_init_helper(JS::HandleObject jsObject, PyObject *dict, std::unordered_map<PyObject *, JS::RootedValue *> &subValsMap);
-
   /**
    * @brief Length method (.mp_length), returns the number of key-value pairs in the JSObject, used by the python len() method
    *
@@ -121,16 +112,6 @@ 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 Function to satisfy the python GC. See comment in function implementation for more details
-   *
-   * @param self - unused
-   * @param visit - unused
-   * @param arg - unused
-   * @return int - always 0
-   */
-  static int JSObjectProxy_traverse(JSObjectProxy *self, visitproc visit, void *arg);
 };
 
 
@@ -146,22 +127,5 @@ static PyMappingMethods JSObjectProxy_mapping_methods = {
 
 /**
  * @brief Struct for the JSObjectProxyType, used by all JSObjectProxy objects
- *
  */
-static PyTypeObject JSObjectProxyType = {
-  .ob_base = PyVarObject_HEAD_INIT(&PyType_Type, 0)
-  .tp_name = "pythonmonkey.JSObjectProxy",
-  .tp_basicsize = sizeof(JSObjectProxy),
-  .tp_dealloc = (destructor)JSObjectProxyMethodDefinitions::JSObjectProxy_dealloc,
-  .tp_as_mapping = &JSObjectProxy_mapping_methods,
-  .tp_getattro = (getattrofunc)JSObjectProxyMethodDefinitions::JSObjectProxy_get,
-  .tp_setattro = (setattrofunc)JSObjectProxyMethodDefinitions::JSObjectProxy_assign,
-  .tp_flags = Py_TPFLAGS_DEFAULT
-  | Py_TPFLAGS_DICT_SUBCLASS,  // https://docs.python.org/3/c-api/typeobj.html#Py_TPFLAGS_DICT_SUBCLASS
-  .tp_doc = PyDoc_STR("Javascript Object proxy dict"),
-  .tp_traverse = (traverseproc)JSObjectProxyMethodDefinitions::JSObjectProxy_traverse,
-  .tp_richcompare = (richcmpfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_richcompare,
-  .tp_base = &PyDict_Type,
-  .tp_init = (initproc)JSObjectProxyMethodDefinitions::JSObjectProxy_init,
-  .tp_new = JSObjectProxyMethodDefinitions::JSObjectProxy_new,
-};
+extern PyTypeObject JSObjectProxyType;

include/PyProxyHandler.hh

@@ -17,14 +17,26 @@
 
 #include <Python.h>
 
+/**
+ * @brief base class for PyProxyHandler and PyListProxyHandler
+ */
+struct PyBaseProxyHandler : public js::BaseProxyHandler {
+public:
+  PyBaseProxyHandler(PyObject *pyObj) : js::BaseProxyHandler(NULL), pyObject(pyObj) {};
+  PyObject *pyObject; // @TODO (Caleb Aikens) Consider putting this in a private slot
+
+  bool getPrototypeIfOrdinary(JSContext *cx, JS::HandleObject proxy, bool *isOrdinary, JS::MutableHandleObject protop) const override final;
+  bool preventExtensions(JSContext *cx, JS::HandleObject proxy, JS::ObjectOpResult &result) const override final;
+  bool isExtensible(JSContext *cx, JS::HandleObject proxy, bool *extensible) const override final;
+};
+
 /**
  * @brief This struct is the ProxyHandler for JS Proxy Objects pythonmonkey creates to handle coercion from python dicts to JS Objects
  *
  */
-struct PyProxyHandler : public js::BaseProxyHandler {
+struct PyProxyHandler : public PyBaseProxyHandler {
 public:
-  PyProxyHandler(PyObject *pyObject);
-  PyObject *pyObject; // @TODO (Caleb Aikens) Consider putting this in a private slot
+  PyProxyHandler(PyObject *pyObj) : PyBaseProxyHandler(pyObj) {};
 
   /**
    * @brief [[OwnPropertyKeys]]
@@ -142,16 +154,29 @@ public:
   bool defineProperty(JSContext *cx, JS::HandleObject proxy,
     JS::HandleId id,
     JS::Handle<JS::PropertyDescriptor> desc,
-    JS::ObjectOpResult &result) const override {};
+    JS::ObjectOpResult &result) const override;
+};
+
+/**
+ * @brief This struct is the ProxyHandler for JS Proxy Objects pythonmonkey creates
+ *    to handle coercion from python lists to JS Array-like objects
+ */
+struct PyListProxyHandler : public PyBaseProxyHandler {
+public:
+  PyListProxyHandler(PyObject *pyObj) : PyBaseProxyHandler(pyObj) {};
 
-  bool getPrototypeIfOrdinary(JSContext *cx, JS::HandleObject proxy,
-    bool *isOrdinary,
-    JS::MutableHandleObject protop) const override {};
+  bool getOwnPropertyDescriptor(
+    JSContext *cx, JS::HandleObject proxy, JS::HandleId id,
+    JS::MutableHandle<mozilla::Maybe<JS::PropertyDescriptor>> desc
+  ) const override;
+
+  bool defineProperty(
+    JSContext *cx, JS::HandleObject proxy, JS::HandleId id,
+    JS::Handle<JS::PropertyDescriptor> desc, JS::ObjectOpResult &result
+  ) const override;
 
-  bool preventExtensions(JSContext *cx, JS::HandleObject proxy,
-    JS::ObjectOpResult &result) const override {};
-  bool isExtensible(JSContext *cx, JS::HandleObject proxy,
-    bool *extensible) const override {};
+  bool ownPropertyKeys(JSContext *cx, JS::HandleObject proxy, JS::MutableHandleIdVector props) const override;
+  bool delete_(JSContext *cx, JS::HandleObject proxy, JS::HandleId id, JS::ObjectOpResult &result) const override;
 };
 
 #endif

include/modules/pythonmonkey/pythonmonkey.hh

@@ -45,14 +45,6 @@ static void cleanup();
  */
 void memoizePyTypeAndGCThing(PyType *pyType, JS::Handle<JS::Value> GCThing);
 
-/**
- * @brief This function checks if a given GCThing is memoized, and returns the related python object if so, or NULL otherwise
- *
- * @param GCThing - The GCThing to be checked
- * @return PyType* - Pointer to related python object wrapped in a PyType, or NULL if GCThing is not memoized
- */
-PyType *checkJSMemo(JS::Handle<JS::Value> GCThing);
-
 /**
  * @brief Callback function passed to JS_SetGCCallback to handle PythonMonkey shared memory
  *

python/pythonmonkey/pythonmonkey.pyi

@@ -6,7 +6,7 @@ stub file for type hints & documentations for the native module
 import typing as _typing
 
 # pylint: disable=redefined-builtin
-def eval(code: str) -> _typing.Any:
+def eval(code: str, /) -> _typing.Any:
     """
     JavaScript evaluator in Python
     """
@@ -17,13 +17,13 @@ def collect() -> None:
     """
 
 @_typing.overload
-def asUCS4(utf16_str: str) -> str:
+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: ...
+def asUCS4(anything_else: _typing.Any, /) -> _typing.NoReturn: ...
 
 class bigint(int):
     """
@@ -35,6 +35,12 @@ class SpiderMonkeyError(Exception):
     Representing a corresponding JS Error in Python
     """
 
+class JSObjectProxy(dict):
+    """
+    JavaScript Object proxy dict
+    """
+    def __init__(self) -> None: ...
+
 null = _typing.Annotated[
     _typing.NewType("pythonmonkey.null", object),
     "Representing the JS null type in Python using a singleton object",

src/DictType.cc

@@ -7,7 +7,6 @@
 
 #include <jsfriendapi.h>
 #include <jsapi.h>
-#include <js/Equality.h>
 
 #include <Python.h>
 
@@ -20,7 +19,7 @@ DictType::DictType() {
 DictType::DictType(PyObject *object) : PyType(object) {}
 
 DictType::DictType(JSContext *cx, JS::Handle<JS::Value> jsObject) {
-  JSObjectProxy *proxy = PyObject_New(JSObjectProxy, &JSObjectProxyType);
+  JSObjectProxy *proxy = (JSObjectProxy *)PyObject_CallObject((PyObject *)&JSObjectProxyType, NULL);
   JS::RootedObject obj(cx);
   JS_ValueToObject(cx, jsObject, &obj);
   proxy->jsObject.set(obj);