Merge pull request #321 from Distributive-Network/philippe/fix-320

Fix PyTypeFactory return type memory leak

Author: philippedistributive

include/BoolType.hh

@@ -1,30 +1,24 @@
 /**
  * @file BoolType.hh
- * @author Caleb Aikens ([email protected])
+ * @author Caleb Aikens ([email protected]) and Philippe Laporte ([email protected])
  * @brief Struct for representing python bools
  * @date 2022-12-02
  *
- * @copyright Copyright (c) 2022 Distributive Corp.
+ * @copyright Copyright (c) 2022,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_BoolType_
 #define PythonMonkey_BoolType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <Python.h>
 
 /**
- * @brief This struct represents the 'bool' type in Python, which is represented as a 'long' in C++. It inherits from the PyType struct
+ * @brief This struct represents the 'bool' type in Python, which is represented as a 'long' in C++
  */
-struct BoolType : public PyType {
+struct BoolType {
 public:
-  BoolType(PyObject *object);
-  BoolType(long n);
-  const TYPE returnType = TYPE::BOOL;
-  long getValue() const;
+  static PyObject *getPyObject(long n);
 };
 
 #endif

include/BufferType.hh

@@ -1,45 +1,40 @@
 /**
  * @file BufferType.hh
- * @author Tom Tang ([email protected])
+ * @author Tom Tang ([email protected]) and Philippe Laporte ([email protected])
  * @brief Struct for representing ArrayBuffers
  * @date 2023-04-27
  *
- * @copyright Copyright (c) 2023 Distributive Corp.
+ * @copyright Copyright (c) 2023,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_BufferType_
 #define PythonMonkey_BufferType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 #include <js/ScalarType.h>
 
 #include <Python.h>
 
-struct BufferType : public PyType {
+struct BufferType {
 public:
-  BufferType(PyObject *object);
-
   /**
    * @brief Construct a new BufferType object from a JS TypedArray or ArrayBuffer, as a Python [memoryview](https://docs.python.org/3.9/c-api/memoryview.html) object
    *
    * @param cx - javascript context pointer
    * @param bufObj - JS object to be coerced
+   *
+   * @returns PyObject* pointer to the resulting PyObject
    */
-  BufferType(JSContext *cx, JS::HandleObject bufObj);
-
-  const TYPE returnType = TYPE::BUFFER;
+  static PyObject *getPyObject(JSContext *cx, JS::HandleObject bufObj);
 
   /**
    * @brief Convert a Python object that [provides the buffer interface](https://docs.python.org/3.9/c-api/typeobj.html#buffer-object-structures) to JS TypedArray.
    * The subtype (Uint8Array, Float64Array, ...) is automatically determined by the Python buffer's [format](https://docs.python.org/3.9/c-api/buffer.html#c.Py_buffer.format)
    *
    * @param cx - javascript context pointer
    */
-  JSObject *toJsTypedArray(JSContext *cx);
+  static JSObject *toJsTypedArray(JSContext *cx, PyObject *pyObject);
 
   /**
    * @returns Is the given JS object either a TypedArray or an ArrayBuffer?

include/DateType.hh

@@ -1,43 +1,37 @@
 /**
  * @file DateType.hh
- * @author Caleb Aikens ([email protected])
+ * @author Caleb Aikens ([email protected]) and Philippe Laporte ([email protected])
  * @brief Struct for representing python dates
  * @date 2022-12-21
  *
- * @copyright Copyright (c) 2022 Distributive Corp.
+ * @copyright Copyright (c) 2022,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_DateType_
 #define PythonMonkey_DateType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 #include <js/Date.h>
 
 #include <Python.h>
 
 /**
- * @brief This struct represents the 'datetime' type in Python from the datetime module, which is represented as a 'Date' object in JS. It inherits from the PyType struct
+ * @brief This struct represents the 'datetime' type in Python from the datetime module, which is represented as a 'Date' object in JS
  */
-struct DateType : public PyType {
+struct DateType {
 public:
-  DateType(PyObject *object);
   /**
    * @brief Convert a JS Date object to Python datetime
    */
-  DateType(JSContext *cx, JS::HandleObject dateObj);
-
-  const TYPE returnType = TYPE::DATE;
+  static PyObject *getPyObject(JSContext *cx, JS::HandleObject dateObj);
 
   /**
    * @brief Convert a Python datetime object to JS Date
    *
    * @param cx - javascript context pointer
    */
-  JSObject *toJsDate(JSContext *cx);
+  static JSObject *toJsDate(JSContext *cx, PyObject *pyObject);
 };
 
 #endif

include/DictType.hh

@@ -1,42 +1,36 @@
 /**
  * @file DictType.hh
- * @author Caleb Aikens ([email protected]) & Giovanni Tedesco ([email protected])
+ * @author Caleb Aikens ([email protected]), Giovanni Tedesco (giovanni@distributive.network) and Philippe Laporte (philippe@distributive.network)
  * @brief Struct representing python dictionaries
  * @date 2022-08-10
  *
- * @copyright Copyright (c) 2022 Distributive Corp.
+ * @copyright Copyright (c) 2022,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_DictType_
 #define PythonMonkey_DictType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 
 #include <Python.h>
 
 /**
- * @brief This struct represents a dictionary in python. It derives from the PyType struct
+ * @brief This struct represents a dictionary in python.
  *
  * @author Giovanni
  */
-struct DictType : public PyType {
+struct DictType {
 public:
-  DictType();
-  DictType(PyObject *object);
-
   /**
    * @brief Construct a new DictType object from a JSObject.
    *
    * @param cx - pointer to the JSContext
    * @param jsObject - pointer to the JSObject to be coerced
+   *
+   * @returns PyObject* pointer to the resulting PyObject
    */
-  DictType(JSContext *cx, JS::Handle<JS::Value> jsObject);
-
-  const TYPE returnType = TYPE::DICT;
+  static PyObject *getPyObject(JSContext *cx, JS::Handle<JS::Value> jsObject);
 };
 
 #endif

include/ExceptionType.hh

@@ -4,34 +4,31 @@
  * @brief Struct for representing Python Exception objects from a corresponding JS Error object
  * @date 2023-04-11
  *
- * @copyright Copyright (c) 2023-2024 Distributive Corp.
+ * @copyright Copyright (c) 2023,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_ExceptionType_
 #define PythonMonkey_ExceptionType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 
 #include <Python.h>
 
 /**
  * @brief This struct represents a Python Exception object from the corresponding JS Error object
  */
-struct ExceptionType : public PyType {
+struct ExceptionType {
 public:
   /**
    * @brief Construct a new SpiderMonkeyError from the JS Error object.
    *
    * @param cx - javascript context pointer
    * @param error - JS Error object to be converted
+   *
+   * @returns PyObject* pointer to the resulting PyObject
    */
-  ExceptionType(JSContext *cx, JS::HandleObject error);
-
-  const TYPE returnType = TYPE::EXCEPTION;
+  static PyObject *getPyObject(JSContext *cx, JS::HandleObject error);
 
   /**
    * @brief Convert a python Exception object to a JS Error object

include/FloatType.hh

@@ -1,31 +1,24 @@
 /**
  * @file FloatType.hh
- * @author Caleb Aikens ([email protected])
+ * @author Caleb Aikens ([email protected]) and Philippe Laporte ([email protected])
  * @brief Struct for representing python floats
  * @date 2022-12-02
  *
- * @copyright Copyright (c) 2022 Distributive Corp.
+ * @copyright Copyright (c) 2022,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_FloatType_
 #define PythonMonkey_FloatType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <Python.h>
 
 /**
- * @brief This struct represents the 'float' type in Python, which is represented as a 'double' in C++. It inherits from the PyType struct
+ * @brief This struct represents the 'float' type in Python, which is represented as a 'double' in C++
  */
-struct FloatType : public PyType {
+struct FloatType {
 public:
-  FloatType(PyObject *object);
-  FloatType(long n);
-  FloatType(double n);
-  const TYPE returnType = TYPE::FLOAT;
-  double getValue() const;
+  static PyObject *getPyObject(double n);
 };
 
 #endif

include/FuncType.hh

@@ -1,32 +1,26 @@
 /**
  * @file FuncType.hh
- * @author Caleb Aikens ([email protected]) & Giovanni Tedesco ([email protected])
+ * @author Caleb Aikens ([email protected]), Giovanni Tedesco (giovanni@distributive.network) and Philippe Laporte (philippe@distributive.network)
  * @brief Struct representing python functions
  * @date 2022-08-08
  *
- * @copyright Copyright (c) 2022 Distributive Corp.
+ * @copyright Copyright (c) 2022,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_FuncType_
 #define PythonMonkey_FuncType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 
 #include <Python.h>
 
 /**
- * @brief This struct represents the 'function' type in Python. It inherits from the PyType struct
+ * @brief This struct represents the 'function' type in Python
  */
-struct FuncType : public PyType {
+struct FuncType {
 public:
-  FuncType(PyObject *object);
-  FuncType(JSContext *cx, JS::HandleValue fval);
-  const TYPE returnType = TYPE::FUNC;
-  const char *getValue() const;
+  static PyObject *getPyObject(JSContext *cx, JS::HandleValue fval);
 };
 
 #endif

include/IntType.hh

@@ -1,47 +1,41 @@
 /**
  * @file IntType.hh
- * @author Caleb Aikens ([email protected]) & Giovanni Tedesco ([email protected]) & Tom Tang ([email protected])
+ * @author Caleb Aikens ([email protected]), Giovanni Tedesco ([email protected]), Tom Tang (xmader@distributive.network) and Philippe Laporte (philippe@distributive.network)
  * @brief Struct for representing python ints
  * @date 2023-03-16
  *
- * @copyright Copyright (c) 2023 Distributive Corp.
+ * @copyright Copyright (c) 2023,2024 Distributive Corp.
  *
  */
 
 #ifndef PythonMonkey_IntType_
 #define PythonMonkey_IntType_
 
-#include "PyType.hh"
-#include "TypeEnum.hh"
-
 #include <jsapi.h>
 
 #include <Python.h>
 
 /**
- * @brief This struct represents the 'int' type (arbitrary-precision) in Python. It inherits from the PyType struct
+ * @brief This struct represents the 'int' type (arbitrary-precision) in Python
  */
-struct IntType : public PyType {
+struct IntType {
 public:
-  IntType(PyObject *object);
-  IntType(long n);
-
   /**
-   * @brief Construct a new IntType object from a JS::BigInt.
+   * @brief Construct a new PyObject from a JS::BigInt.
    *
    * @param cx - javascript context pointer
    * @param bigint - JS::BigInt pointer
+   *
+   * @returns PyObject* pointer to the resulting PyObject
    */
-  IntType(JSContext *cx, JS::BigInt *bigint);
-
-  const TYPE returnType = TYPE::INT;
+  static PyObject *getPyObject(JSContext *cx, JS::BigInt *bigint);
 
   /**
    * @brief Convert the IntType object to a JS::BigInt
    *
    * @param cx - javascript context pointer
    */
-  JS::BigInt *toJsBigInt(JSContext *cx);
+  static JS::BigInt *toJsBigInt(JSContext *cx, PyObject *pyObject);
 };
 
 #endif

include/JSArrayIterProxy.hh

@@ -57,6 +57,14 @@ public:
    */
   static int JSArrayIterProxy_traverse(JSArrayIterProxy *self, visitproc visit, void *arg);
 
+  /**
+   * @brief .tp_clear method
+   *
+   * @param self - The JSArrayIterProxy
+   * @return 0 on success
+   */
+  static int JSArrayIterProxy_clear(JSArrayIterProxy *self);
+
   /**
    * @brief .tp_iter method
    *