gh-115754: Export Py_None, Py_False, Py_True as symbols

vstinner · vstinner · commit 5002f4dcc7f8 · 2024-02-21T17:19:21.000+01:00
In the limited C API and the stable ABI, implement Py_None, Py_False,
Py_True, Py_Ellipsis and Py_NotImplemented constants are symbols.
diff --git a/Doc/data/stable_abi.dat b/Doc/data/stable_abi.dat
diff --git a/Include/boolobject.h b/Include/boolobject.h
@@ -17,9 +17,15 @@ extern "C" {
 PyAPI_DATA(PyLongObject) _Py_FalseStruct;
 PyAPI_DATA(PyLongObject) _Py_TrueStruct;
 
-/* Use these macros */
+// Export symbols in the stable ABI
+PyAPI_DATA(PyLongObject*) Py_False;
+PyAPI_DATA(PyLongObject*) Py_True;
+
+#ifndef Py_LIMITED_API
+// Implement Py_False and Py_True as macros in the non-limited C API
 #define Py_False _PyObject_CAST(&_Py_FalseStruct)
 #define Py_True _PyObject_CAST(&_Py_TrueStruct)
+#endif
 
 // Test if an object is the True singleton, the same as "x is True" in Python.
 PyAPI_FUNC(int) Py_IsTrue(PyObject *x);
diff --git a/Include/object.h b/Include/object.h
@@ -1070,7 +1070,14 @@ _Py_NoneStruct is an object of undefined type which can be used in contexts
 where NULL (nil) is not suitable (since NULL often means 'error').
 */
 PyAPI_DATA(PyObject) _Py_NoneStruct; /* Don't use this directly */
+
+// Export the symbol in the stable ABI
+PyAPI_DATA(PyObject*) Py_None;
+
+#ifndef Py_LIMITED_API
+// Implement Py_None as a macro in the non-limited C API
 #define Py_None (&_Py_NoneStruct)
+#endif
 
 // Test if an object is the None singleton, the same as "x is None" in Python.
 PyAPI_FUNC(int) Py_IsNone(PyObject *x);
@@ -1084,7 +1091,14 @@ Py_NotImplemented is a singleton used to signal that an operation is
 not implemented for a given type combination.
 */
 PyAPI_DATA(PyObject) _Py_NotImplementedStruct; /* Don't use this directly */
+
+// Export the symbol in the stable ABI
+PyAPI_DATA(PyObject*) Py_NotImplemented;
+
+#ifndef Py_LIMITED_API
+// Implement Py_NotImplemented as a macro in the non-limited C API
 #define Py_NotImplemented (&_Py_NotImplementedStruct)
+#endif
 
 /* Macro for returning Py_NotImplemented from a function */
 #define Py_RETURN_NOTIMPLEMENTED return Py_NotImplemented
diff --git a/Include/sliceobject.h b/Include/sliceobject.h
@@ -8,7 +8,13 @@ extern "C" {
 
 PyAPI_DATA(PyObject) _Py_EllipsisObject; /* Don't use this directly */
 
+// Export the symbol in the stable ABI
+PyAPI_DATA(PyObject*) Py_Ellipsis;
+
+#ifndef Py_LIMITED_API
+// Implement Py_Ellipsis as a macro in the non-limited C API
 #define Py_Ellipsis (&_Py_EllipsisObject)
+#endif
 
 /* Slice object interface */
 
diff --git a/Lib/test/test_stable_abi_ctypes.py b/Lib/test/test_stable_abi_ctypes.py
diff --git a/Misc/NEWS.d/next/C API/2024-02-21-10-54-27.gh-issue-115754.RSL-q0.rst b/Misc/NEWS.d/next/C API/2024-02-21-10-54-27.gh-issue-115754.RSL-q0.rst
@@ -0,0 +1,6 @@
+In the limited C API and the stable ABI, implement ``Py_None``, ``Py_False``
+``Py_True``, ``Py_Ellipsis`` and ``Py_NotImplemented`` constants are symbols,
+rather than implementing them as macros. So they can be loaded by dlopen/dlsym
+in an embedded in Python, rather than having to reimplement these macros
+manually. In the non-limited C API, these constants are still implemented as
+macros. Patch by Victor Stinner.
diff --git a/Misc/stable_abi.toml b/Misc/stable_abi.toml
@@ -2496,3 +2496,13 @@
 [typedef.PyCFunctionFastWithKeywords]
     added = '3.13'
     # "abi-only" since 3.10.  (Same story as PyCFunctionFast.)
+[data.Py_False]
+    added = '3.13'
+[data.Py_True]
+    added = '3.13'
+[data.Py_None]
+    added = '3.13'
+[data.Py_Ellipsis]
+    added = '3.13'
+[data.Py_NotImplemented]
+    added = '3.13'
diff --git a/Objects/boolobject.c b/Objects/boolobject.c
@@ -225,3 +225,10 @@ struct _longobject _Py_TrueStruct = {
         { 1 }
     }
 };
+
+// Stable ABI: export symbols
+
+#undef Py_False
+#undef Py_True
+PyLongObject *Py_False = _Py_CAST(PyLongObject*, &_Py_FalseStruct);
+PyLongObject *Py_True = _Py_CAST(PyLongObject*, &_Py_TrueStruct);
diff --git a/Objects/object.c b/Objects/object.c
@@ -2970,3 +2970,10 @@ _Py_SetRefcnt(PyObject *ob, Py_ssize_t refcnt)
 {
     Py_SET_REFCNT(ob, refcnt);
 }
+
+
+// Export symbols in the stable ABI
+#undef Py_None
+#undef Py_NotImplemented
+PyObject *Py_None = &_Py_NoneStruct;
+PyObject *Py_NotImplemented = &_Py_NotImplementedStruct;
diff --git a/Objects/sliceobject.c b/Objects/sliceobject.c
@@ -721,3 +721,8 @@ PyTypeObject PySlice_Type = {
     0,                                          /* tp_alloc */
     slice_new,                                  /* tp_new */
 };
+
+
+// Export the symbol in the stable ABI
+#undef Py_Ellipsis
+PyObject *Py_Ellipsis = &_Py_EllipsisObject;
diff --git a/PC/python3dll.c b/PC/python3dll.c
diff --git a/Tools/build/stable_abi.py b/Tools/build/stable_abi.py
@@ -309,6 +309,18 @@ def test_windows_feature_macros(self):
                         with self.subTest(name):
                             self.assertEqual(feature_macros[name], value)
 
+            def test_constants(self):
+                process = ctypes_test.pythonapi
+                def get_object(name):
+                    return ctypes_test.py_object.in_dll(process, name).value
+
+                self.assertIs(get_object("Py_None"), None)
+                self.assertIs(get_object("Py_False"), False)
+                self.assertIs(get_object("Py_True"), True)
+                self.assertIs(get_object("Py_Ellipsis"), Ellipsis)
+                self.assertIs(get_object("Py_NotImplemented"), NotImplemented)
+
+
         SYMBOL_NAMES = (
     '''))
     items = manifest.select(

Original file line number	Diff line number	Diff line change
`@@ -2970,3 +2970,10 @@ _Py_SetRefcnt(PyObject *ob, Py_ssize_t refcnt)`
`2970`	`2970`	`{`
`2971`	`2971`	`Py_SET_REFCNT(ob, refcnt);`
`2972`	`2972`	`}`
	`2973`	`+`
	`2974`	`+`
	`2975`	`+// Export symbols in the stable ABI`
	`2976`	`+#undef Py_None`
	`2977`	`+#undef Py_NotImplemented`
	`2978`	`+PyObject *Py_None = &_Py_NoneStruct;`
	`2979`	`+PyObject *Py_NotImplemented = &_Py_NotImplementedStruct;`