[Python-checkins] gh-84436: Add integration C API tests for immortal objects (gh-103962)

[corona10]

https://github.com/python/cpython/commit/d81ca7ec029ba05084751c8df64292bb48f4f30f
commit: d81ca7ec029ba05084751c8df64292bb48f4f30f
branch: main
author: Dong-hee Na <donghee.na at python.org>
committer: corona10 <donghee.na92 at gmail.com>
date: 2023-05-03T00:05:30+09:00
summary:

gh-84436: Add integration C API tests for immortal objects (gh-103962)

files:
A Lib/test/test_capi/test_immortal.py
A Modules/_testcapi/immortal.c
M Modules/Setup.stdlib.in
M Modules/_testcapi/parts.h
M Modules/_testcapimodule.c
M PCbuild/_testcapi.vcxproj

diff --git a/Lib/test/test_capi/test_immortal.py b/Lib/test/test_capi/test_immortal.py
new file mode 100644
index 000000000000..ef5d32b7f019
--- /dev/null
+++ b/Lib/test/test_capi/test_immortal.py
@@ -0,0 +1,16 @@
+import unittest
+from test.support import import_helper
+
+_testcapi = import_helper.import_module('_testcapi')
+
+
+class TestCAPI(unittest.TestCase):
+    def test_immortal_builtins(self):
+        _testcapi.test_immortal_builtins()
+
+    def test_immortal_small_ints(self):
+        _testcapi.test_immortal_small_ints()
+
+
+if __name__ == "__main__":
+    unittest.main()
diff --git a/Modules/Setup.stdlib.in b/Modules/Setup.stdlib.in
index fe1b9f8f5380..a90c1e96ef02 100644
--- a/Modules/Setup.stdlib.in
+++ b/Modules/Setup.stdlib.in
@@ -169,7 +169,7 @@
 @MODULE__XXTESTFUZZ_TRUE at _xxtestfuzz _xxtestfuzz/_xxtestfuzz.c _xxtestfuzz/fuzzer.c
 @MODULE__TESTBUFFER_TRUE at _testbuffer _testbuffer.c
 @MODULE__TESTINTERNALCAPI_TRUE at _testinternalcapi _testinternalcapi.c
- at MODULE__TESTCAPI_TRUE@_testcapi _testcapimodule.c _testcapi/vectorcall.c _testcapi/vectorcall_limited.c _testcapi/heaptype.c _testcapi/unicode.c _testcapi/getargs.c _testcapi/pytime.c _testcapi/datetime.c _testcapi/docstring.c _testcapi/mem.c _testcapi/watchers.c _testcapi/long.c _testcapi/float.c _testcapi/structmember.c _testcapi/exceptions.c _testcapi/code.c _testcapi/pyos.c
+ at MODULE__TESTCAPI_TRUE@_testcapi _testcapimodule.c _testcapi/vectorcall.c _testcapi/vectorcall_limited.c _testcapi/heaptype.c _testcapi/unicode.c _testcapi/getargs.c _testcapi/pytime.c _testcapi/datetime.c _testcapi/docstring.c _testcapi/mem.c _testcapi/watchers.c _testcapi/long.c _testcapi/float.c _testcapi/structmember.c _testcapi/exceptions.c _testcapi/code.c _testcapi/pyos.c _testcapi/immortal.c
 @MODULE__TESTCLINIC_TRUE at _testclinic _testclinic.c
 
 # Some testing modules MUST be built as shared libraries.
diff --git a/Modules/_testcapi/immortal.c b/Modules/_testcapi/immortal.c
new file mode 100644
index 000000000000..10e1733d08a9
--- /dev/null
+++ b/Modules/_testcapi/immortal.c
@@ -0,0 +1,47 @@
+#include "parts.h"
+
+int verify_immortality(PyObject *object) 
+{
+    assert(_Py_IsImmortal(object));
+    Py_ssize_t old_count = Py_REFCNT(object);
+    for (int j = 0; j < 10000; j++) {
+        Py_DECREF(object);
+    }
+    Py_ssize_t current_count = Py_REFCNT(object);
+    return old_count == current_count;
+}
+
+static PyObject *
+test_immortal_builtins(PyObject *self, PyObject *Py_UNUSED(ignored))
+{
+    PyObject *objects[] = {Py_True, Py_False, Py_None, Py_Ellipsis};
+    Py_ssize_t n = Py_ARRAY_LENGTH(objects);
+    for (Py_ssize_t i = 0; i < n; i++) {
+        assert(verify_immortality(objects[i]));
+    }
+    Py_RETURN_NONE;
+}
+
+static PyObject *
+test_immortal_small_ints(PyObject *self, PyObject *Py_UNUSED(ignored))
+{
+    for (int i = -5; i <= 256; i++) {
+        assert(verify_immortality(PyLong_FromLong(i)));
+    }
+    Py_RETURN_NONE;
+}
+
+static PyMethodDef test_methods[] = {
+    {"test_immortal_builtins",   test_immortal_builtins,     METH_NOARGS},
+    {"test_immortal_small_ints", test_immortal_small_ints,   METH_NOARGS},
+    {NULL},
+};
+
+int
+_PyTestCapi_Init_Immortal(PyObject *mod)
+{
+    if (PyModule_AddFunctions(mod, test_methods) < 0) {
+        return -1;
+    }
+    return 0;
+}
diff --git a/Modules/_testcapi/parts.h b/Modules/_testcapi/parts.h
index 60ec81dad2ba..4d2d6832a827 100644
--- a/Modules/_testcapi/parts.h
+++ b/Modules/_testcapi/parts.h
@@ -39,6 +39,7 @@ int _PyTestCapi_Init_Structmember(PyObject *module);
 int _PyTestCapi_Init_Exceptions(PyObject *module);
 int _PyTestCapi_Init_Code(PyObject *module);
 int _PyTestCapi_Init_PyOS(PyObject *module);
+int _PyTestCapi_Init_Immortal(PyObject *module);
 
 #ifdef LIMITED_API_AVAILABLE
 int _PyTestCapi_Init_VectorcallLimited(PyObject *module);
diff --git a/Modules/_testcapimodule.c b/Modules/_testcapimodule.c
index a5d23b1b3d50..30b8b6c6b3a8 100644
--- a/Modules/_testcapimodule.c
+++ b/Modules/_testcapimodule.c
@@ -4313,6 +4313,9 @@ PyInit__testcapi(void)
     if (_PyTestCapi_Init_PyOS(m) < 0) {
         return NULL;
     }
+    if (_PyTestCapi_Init_Immortal(m) < 0) {
+        return NULL;
+    }
 
 #ifndef LIMITED_API_AVAILABLE
     PyModule_AddObjectRef(m, "LIMITED_API_AVAILABLE", Py_False);
diff --git a/PCbuild/_testcapi.vcxproj b/PCbuild/_testcapi.vcxproj
index 439cd687fda6..21941247eb96 100644
--- a/PCbuild/_testcapi.vcxproj
+++ b/PCbuild/_testcapi.vcxproj
@@ -110,6 +110,7 @@
     <ClCompile Include="..\Modules\_testcapi\exceptions.c" />
     <ClCompile Include="..\Modules\_testcapi\code.c" />
     <ClCompile Include="..\Modules\_testcapi\pyos.c" />
+    <ClCompile Include="..\Modules\_testcapi\immortal.c" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="..\PC\python_nt.rc" />