Merge pull request #198 from Distributive-Network/philippecaleb/fix/191

fix(JSObjectProxy): do not allow '|' operand on dicts and JSObjectProxys if python version is lower than 3.9

Author: zollqir

include/JSObjectProxy.hh

@@ -129,6 +129,25 @@ public:
    * @return the string representation (a PyUnicodeObject) on success, NULL on failure
    */
   static PyObject *JSObjectProxy_repr(JSObjectProxy *self);
+
+  /**
+   * @brief Set union method
+   *
+   * @param self - The JSObjectProxy
+   * @param other - The other PyObject to be or'd, expected to be dict or JSObjectProxy
+   * @return PyObject* The resulting new dict
+   */
+  static PyObject *JSObjectProxy_or(JSObjectProxy *self, PyObject *other);
+
+  /**
+   * @brief Set union method, in place
+   *
+   * @param self - The JSObjectProxy
+   * @param other - The other PyObject to be or'd, expected to be dict or JSObjectProxy
+   * @return PyObject* The resulting new dict, must be same object as self
+   */
+  static PyObject *JSObjectProxy_ior(JSObjectProxy *self, PyObject *other);
+
 };
 
 
@@ -146,6 +165,11 @@ static PySequenceMethods JSObjectProxy_sequence_methods = {
   .sq_contains = (objobjproc)JSObjectProxyMethodDefinitions::JSObjectProxy_contains
 };
 
+static PyNumberMethods JSObjectProxy_number_methods = {
+  .nb_or = (binaryfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_or,
+  .nb_inplace_or = (binaryfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_ior
+};
+
 /**
  * @brief Struct for the JSObjectProxyType, used by all JSObjectProxy objects
  */

src/JSObjectProxy.cc

@@ -21,6 +21,8 @@
 
 #include <Python.h>
 
+#include <object.h>
+
 JSContext *GLOBAL_CX; /**< pointer to PythonMonkey's JSContext */
 
 bool keyToId(PyObject *key, JS::MutableHandleId idp) {
@@ -258,3 +260,61 @@ PyObject *JSObjectProxyMethodDefinitions::JSObjectProxy_repr(JSObjectProxy *self
   PyDict_DelItem(tsDict, cyclicKey);
   return str;
 }
+
+PyObject *JSObjectProxyMethodDefinitions::JSObjectProxy_or(JSObjectProxy *self, PyObject *other) {
+  #if PY_VERSION_HEX < 0x03090000
+  // | is not supported on dicts in python3.8 or less, so only allow if both
+  // operands are JSObjectProxy
+  if (!PyObject_TypeCheck(self, &JSObjectProxyType) || !PyObject_TypeCheck(other, &JSObjectProxyType)) {
+    Py_RETURN_NOTIMPLEMENTED;
+  }
+  #endif
+  if (!PyDict_Check(self) || !PyDict_Check(other)) {
+    Py_RETURN_NOTIMPLEMENTED;
+  }
+
+  if (!PyObject_TypeCheck(self, &JSObjectProxyType) && PyObject_TypeCheck(other, &JSObjectProxyType)) {
+    return PyDict_Type.tp_as_number->nb_or((PyObject *)&(self->dict), other);
+  } else {
+    JS::Rooted<JS::ValueArray<3>> args(GLOBAL_CX);
+    args[0].setObjectOrNull(JS_NewPlainObject(GLOBAL_CX));
+    args[1].setObjectOrNull(self->jsObject);  // this is null is left operand is real dict
+    JS::RootedValue jValueOther(GLOBAL_CX, jsTypeFactory(GLOBAL_CX, other));
+    args[2].setObject(jValueOther.toObject());
+
+    JS::RootedObject *global = new JS::RootedObject(GLOBAL_CX, JS::GetNonCCWObjectGlobal(self->jsObject));
+
+    // call Object.assign
+    JS::RootedValue Object(GLOBAL_CX);
+    JS_GetProperty(GLOBAL_CX, *global, "Object", &Object);
+
+    JS::RootedObject rootedObject(GLOBAL_CX, Object.toObjectOrNull());
+    JS::RootedValue ret(GLOBAL_CX);
+
+    if (!JS_CallFunctionName(GLOBAL_CX, rootedObject, "assign", args, &ret)) return NULL;
+    return pyTypeFactory(GLOBAL_CX, global, &ret)->getPyObject();
+  }
+}
+
+PyObject *JSObjectProxyMethodDefinitions::JSObjectProxy_ior(JSObjectProxy *self, PyObject *other) {
+  if (!PyDict_Check(self) || !PyDict_Check(other)) {
+    Py_RETURN_NOTIMPLEMENTED;
+  }
+
+  JS::Rooted<JS::ValueArray<2>> args(GLOBAL_CX);
+  args[0].setObjectOrNull(self->jsObject);
+  JS::RootedValue jValueOther(GLOBAL_CX, jsTypeFactory(GLOBAL_CX, other));
+  args[1].setObject(jValueOther.toObject());
+
+  JS::RootedObject *global = new JS::RootedObject(GLOBAL_CX, JS::GetNonCCWObjectGlobal(self->jsObject));
+
+  // call Object.assign
+  JS::RootedValue Object(GLOBAL_CX);
+  JS_GetProperty(GLOBAL_CX, *global, "Object", &Object);
+
+  JS::RootedObject rootedObject(GLOBAL_CX, Object.toObjectOrNull());
+  JS::RootedValue ret(GLOBAL_CX);
+  if (!JS_CallFunctionName(GLOBAL_CX, rootedObject, "assign", args, &ret)) return NULL;
+  Py_INCREF(self);
+  return (PyObject *)self;
+}

src/modules/pythonmonkey/pythonmonkey.cc

@@ -74,6 +74,7 @@ PyTypeObject JSObjectProxyType = {
   .tp_basicsize = sizeof(JSObjectProxy),
   .tp_dealloc = (destructor)JSObjectProxyMethodDefinitions::JSObjectProxy_dealloc,
   .tp_repr = (reprfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_repr,
+  .tp_as_number = &JSObjectProxy_number_methods,
   .tp_as_sequence = &JSObjectProxy_sequence_methods,
   .tp_as_mapping = &JSObjectProxy_mapping_methods,
   .tp_getattro = (getattrofunc)JSObjectProxyMethodDefinitions::JSObjectProxy_get,

tests/python/test_dicts_lists.py

@@ -1,4 +1,5 @@
 import pythonmonkey as pm
+import sys
 
 def test_eval_dicts():
     d = {"a":1}
@@ -137,4 +138,55 @@ def test_eval_objects_jsproxy_does_not_contain():
 
 def test_eval_objects_jsproxy_does_not_contain_value():
     a = pm.eval("({'c':5})")
-    assert not(5 in a)
+    assert not(5 in a)
+
+def test_eval_objects_jsproxy_or():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = pm.eval("({'c':5})")
+    b = pm.eval("({'d':6})")
+    c = a | b
+    assert a == {'c': 5.0}  
+    assert c == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0} 
+
+def test_eval_objects_jsproxy_or_true_dict_right():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = pm.eval("({'c':5})")
+    b = {'d': 6.0}
+    c = a | b
+    assert a == {'c': 5.0}  
+    assert c == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0} 
+
+def test_eval_objects_jsproxy_or_true_dict_left():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = {'c':5}
+    b = pm.eval("({'d':6})")
+    c = a | b
+    assert a == {'c': 5.0}  
+    assert c == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0} 
+
+def test_eval_objects_jsproxy_inplace_or():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = pm.eval("({'c':5})")
+    b = pm.eval("({'d':6})")
+    a |= b
+    assert a == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0}       
+
+def test_eval_objects_jsproxy_inplace_or_true_dict_right():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = pm.eval("({'c':5})")
+    b = {'d':6.0}
+    a |= b
+    assert a == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0}       
+
+def test_eval_objects_jsproxy_inplace_or_true_dict_left():
+  if sys.version_info[0] >= 3 and sys.version_info[1] >= 9: # | is not implemented for dicts in 3.8 or less
+    a = {'c':5.0}
+    b = pm.eval("({'d':6})")
+    a |= b
+    assert a == {'c': 5.0, 'd': 6.0}   
+    assert b == {'d': 6.0}