Add Py_NewRef() and Py_XNewRef() functions

vstinner · vstinner · commit 8cd990bc5752 · 2020-11-05T15:07:58.000+01:00
diff --git a/README.rst b/README.rst
@@ -31,6 +31,14 @@ Copy the header file in your project and include it using::
 Functions
 =========
 
+Python 3.10
+-----------
+
+::
+
+    PyObject* Py_NewRef(PyObject *obj);
+    PyObject* Py_XNewRef(PyObject *obj);
+
 Python 3.9
 ----------
 
diff --git a/pythoncapi_compat.h b/pythoncapi_compat.h
@@ -15,6 +15,18 @@ extern "C" {
 #include <Python.h>
 #include "frameobject.h"          // PyFrameObject
 
+// bpo-42262 added Py_NewRef() and Py_XNewRef()
+static inline PyObject* Py_NewRef(PyObject *obj)
+{
+    Py_INCREF(obj);
+    return obj;
+}
+
+static inline PyObject* Py_XNewRef(PyObject *obj)
+{
+    Py_XINCREF(obj);
+    return obj;
+}
 
 // bpo-39573: Py_TYPE(), Py_REFCNT() and Py_SIZE() can no longer be used
 // as l-value in Python 3.10.
diff --git a/tests/test_pythoncapi_compat.c b/tests/test_pythoncapi_compat.c
@@ -18,6 +18,17 @@ test_object(PyObject *self, PyObject *ignored)
         return NULL;
     }
 
+    // Py_NewRef() and Py_XNewRef()
+    Py_ssize_t refcnt = Py_REFCNT(obj);
+    PyObject *obj2 = Py_NewRef(obj);
+    assert(Py_REFCNT(obj) == (refcnt + 1));
+    PyObject *obj3 = Py_XNewRef(obj);
+    assert(Py_REFCNT(obj) == (refcnt + 2));
+    assert(Py_XNewRef(NULL) == NULL);
+    Py_DECREF(obj2);
+    Py_DECREF(obj3);
+    assert(Py_REFCNT(obj) == refcnt);
+
     // test Py_SET_REFCNT
     Py_SET_REFCNT(obj, Py_REFCNT(obj));
     // test Py_SET_TYPE
