Rename GraalPy-speficic PyDescrObject functions

msimacek · msimacek · commit cbe0c15ac0c7 · 2025-07-22T08:35:45.000+02:00
diff --git a/graalpython/com.oracle.graal.python.cext/include/cpython/descrobject.h b/graalpython/com.oracle.graal.python.cext/include/cpython/descrobject.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2023, Oracle and/or its affiliates.
+/* Copyright (c) 2023, 2025, Oracle and/or its affiliates.
  * Copyright (C) 1996-2023 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -37,8 +37,8 @@ typedef struct {
 
 #define PyDescr_COMMON PyDescrObject d_common
 
-#define PyDescr_TYPE(x) PyDescrObject_GetType((PyObject*)(x))
-#define PyDescr_NAME(x) PyDescrObject_GetName((PyObject*)(x))
+#define PyDescr_TYPE(x) GraalPyDescrObject_GetType((PyObject*)(x))
+#define PyDescr_NAME(x) GraalPyDescrObject_GetName((PyObject*)(x))
 
 typedef struct {
     PyDescr_COMMON;
@@ -67,3 +67,12 @@ PyAPI_DATA(PyTypeObject) _PyMethodWrapper_Type;
 PyAPI_FUNC(PyObject *) PyDescr_NewWrapper(PyTypeObject *,
                                                 struct wrapperbase *, void *);
 PyAPI_FUNC(int) PyDescr_IsData(PyObject *);
+
+// GraalPy public API to replace struct accessors
+PyAPI_FUNC(PyMethodDef*) GraalPyMethodDescrObject_GetMethod(PyObject*);
+PyAPI_FUNC(PyTypeObject*) GraalPyDescrObject_GetType(PyObject*);
+PyAPI_FUNC(PyObject*) GraalPyDescrObject_GetName(PyObject*);
+// Deprecated aliases kept for current versions of Cython
+// Remove in 27.0
+#define PyDescrObject_GetType GraalPyDescrObject_GetType
+#define PyMethodDescrObject_GetMethod GraalPyMethodDescrObject_GetMethod
diff --git a/graalpython/com.oracle.graal.python.cext/include/descrobject.h b/graalpython/com.oracle.graal.python.cext/include/descrobject.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2024, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2025, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -93,11 +93,6 @@ struct PyMemberDef {
 PyAPI_FUNC(PyObject *) PyMember_GetOne(const char *, PyMemberDef *);
 PyAPI_FUNC(int) PyMember_SetOne(char *, PyMemberDef *, PyObject *);
 
-// GraalPy-specific
-PyAPI_FUNC(PyMethodDef*) PyMethodDescrObject_GetMethod(PyObject*);
-PyAPI_FUNC(PyTypeObject*) PyDescrObject_GetType(PyObject*);
-PyAPI_FUNC(PyObject*) PyDescrObject_GetName(PyObject*);
-
 #ifndef Py_LIMITED_API
 #  define Py_CPYTHON_DESCROBJECT_H
 #  include "cpython/descrobject.h"
diff --git a/graalpython/com.oracle.graal.python.cext/src/descrobject.c b/graalpython/com.oracle.graal.python.cext/src/descrobject.c
@@ -63,15 +63,15 @@ PyObject* PyDescr_NewGetSet(PyTypeObject *type, PyGetSetDef *getset) {
 }
 
 
-PyMethodDef* PyMethodDescrObject_GetMethod(PyObject* descr) {
+PyMethodDef* GraalPyMethodDescrObject_GetMethod(PyObject* descr) {
     return GraalPyPrivate_GET_PyMethodDescrObject_d_method(descr);
 }
 
-PyTypeObject* PyDescrObject_GetType(PyObject* descr) {
+PyTypeObject* GraalPyDescrObject_GetType(PyObject* descr) {
     return GraalPyPrivate_GET_PyDescrObject_d_type(descr);
 }
 
-PyObject* PyDescrObject_GetName(PyObject* descr) {
+PyObject* GraalPyDescrObject_GetName(PyObject* descr) {
     return GraalPyPrivate_GET_PyDescrObject_d_name(descr);
 }
 
diff --git a/graalpython/com.oracle.graal.python.processor/src/com/oracle/graal/python/processor/CApiBuiltinsProcessor.java b/graalpython/com.oracle.graal.python.processor/src/com/oracle/graal/python/processor/CApiBuiltinsProcessor.java
@@ -746,12 +746,12 @@ private static Path resolvePath(Path path) {
     private static final String[] ADDITIONAL = new String[]{
                     /*
                      * These PySlice builtins are deprecated and scheduled for removal once we no
-                     * longer support old versions of Cython that use them. Grep all patches before
+                     * longer support versions of Cython that use them. Grep all patches before
                      * removing
                      */
                     "PySlice_Start", "PySlice_Step", "PySlice_Stop",
-                    "PyDescrObject_GetName", "PyDescrObject_GetType", "PyInterpreterState_GetIDFromThreadState",
-                    "PyMethodDescrObject_GetMethod", "PyObject_GetDoc", "PyObject_SetDoc", "_PyFrame_SetLineNumber",
+                    "PyInterpreterState_GetIDFromThreadState",
+                    "PyObject_GetDoc", "PyObject_SetDoc", "_PyFrame_SetLineNumber",
                     "PyCode_GetName",
                     "PyCode_GetFileName", "_PyArray_Resize", "_PyArray_Data",
                     "_PyErr_Occurred", "_PyNamespace_New", "_Py_GetErrorHandler",
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_descr.py b/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_descr.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2020, 2025, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # The Universal Permissive License (UPL), Version 1.0
@@ -75,7 +75,7 @@ def test_new_classmethod(self):
         assert tester.from_param(123) == TestNewClassMethod
 
     def test_new_descr(self):
-        C = CPyExtType("C_", 
+        C = CPyExtType("C_",
                             '''
                             PyTypeObject A_Type = {
                                 PyVarObject_HEAD_INIT(NULL, 0)
@@ -91,7 +91,7 @@ def test_new_descr(self):
                             }
 
                             static PyMethodDef foo_method = {
-                                 "foo", foo, METH_O 
+                                 "foo", foo, METH_O
                             };
 
                             static PyObject* B_new(PyTypeObject* type, PyObject* a, PyObject* b) {
@@ -166,11 +166,11 @@ def test_new_descr(self):
                                 B_Type.tp_base = &PyType_Type;
                                 if (PyType_Ready(&B_Type) < 0)
                                     return NULL;
-                                    
-                                Py_SET_TYPE(&C_Type, &B_Type); 
+
+                                Py_SET_TYPE(&C_Type, &B_Type);
                                 C_Type.tp_base = &A_Type;''',
                             )
-        
+
         class bar(C):
             pass
         assert bar().foo(None) is None
@@ -306,8 +306,8 @@ class TestDescr(CPyExtTestCase):
             if (PyObject_TypeCheck(method, (PyTypeObject *)methoddescr_type)) {
                 PyMethodDescrObject *descr = (PyMethodDescrObject *)method;
 #ifdef GRAALVM_PYTHON
-                PyTypeObject *d_type = PyDescrObject_GetType(method);
-                PyObject *class_method = PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
+                PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
+                PyObject *class_method = PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
 #else
                 PyTypeObject *d_type = descr->d_common.d_type;
                 PyObject *class_method = PyDescr_NewClassMethod(d_type, descr->d_method);
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_functions.py b/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_functions.py
@@ -575,7 +575,7 @@ def test_PyMethodDef(self):
             #define GraalPyCFunction_SetMethodDef(OBJ, VAL) (((PyCFunctionObject*) (OBJ))->m_ml = (VAL))
             #define GraalPyCFunction_GetModule(OBJ) (((PyCFunctionObject*) (OBJ))->m_module)
             #define GraalPyCFunction_SetModule(OBJ, VAL) (((PyCFunctionObject*) (OBJ))->m_module = (VAL))
-            #define PyMethodDescrObject_GetMethod(OBJ) (((PyMethodDescrObject *) (OBJ))->d_method)
+            #define GraalPyMethodDescrObject_GetMethod(OBJ) (((PyMethodDescrObject *) (OBJ))->d_method)
             #endif
 
             static PyObject *native_meth_noargs(PyObject *self, PyObject *dummy) {
@@ -704,7 +704,7 @@ def test_PyMethodDef(self):
                     PyErr_SetString(PyExc_TypeError, "<callable> is not a PyMethodDescrObject (i.e. method_descriptor)");
                     return NULL;
                 }
-                PyMethodDef *def = PyMethodDescrObject_GetMethod(callable);
+                PyMethodDef *def = GraalPyMethodDescrObject_GetMethod(callable);
                 // returns a borrowed ref
                 return _call_PyCFunction(def, callable_self, callable_args, callable_kwargs);
             }
@@ -756,7 +756,7 @@ def test_PyMethodDef(self):
                 if (PyCFunction_Check(callable)) {
                     def = GraalPyCFunction_GetMethodDef(callable);
                 } else if (PyObject_TypeCheck(callable, &PyMethodDescr_Type)) {
-                    def = PyMethodDescrObject_GetMethod(callable);
+                    def = GraalPyMethodDescrObject_GetMethod(callable);
                 } else {
                     PyErr_SetString(PyExc_TypeError, "<callable> is not a PyCFunction (i.e. builtin_method_or_function) "
                                                      "nor a PyMethodDescrObject (i.e. method_descriptor)");
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/CApiFunction.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/CApiFunction.java
@@ -242,8 +242,6 @@ public final class CApiFunction {
     @CApiBuiltin(name = "PyComplex_ImagAsDouble", ret = ArgDescriptor.Double, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyComplex_RealAsDouble", ret = ArgDescriptor.Double, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyContextVar_Get", ret = Int, args = {PyObject, PyObject, PyObjectPtr}, call = CImpl)
-    @CApiBuiltin(name = "PyDescrObject_GetName", ret = PyObject, args = {PyObject}, call = CImpl)
-    @CApiBuiltin(name = "PyDescrObject_GetType", ret = PyTypeObject, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyDescr_IsData", ret = Int, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyDescr_NewClassMethod", ret = PyObject, args = {PyTypeObject, PyMethodDef}, call = CImpl)
     @CApiBuiltin(name = "PyDescr_NewGetSet", ret = PyObject, args = {PyTypeObject, PyGetSetDef}, call = CImpl)
@@ -356,7 +354,6 @@ public final class CApiFunction {
     @CApiBuiltin(name = "PyMem_Realloc", ret = Pointer, args = {Pointer, SIZE_T}, call = CImpl)
     @CApiBuiltin(name = "PyMemoryView_FromBuffer", ret = PyObject, args = {CONST_PY_BUFFER_PTR}, call = CImpl)
     @CApiBuiltin(name = "PyMemoryView_FromMemory", ret = PyObject, args = {CHAR_PTR, Py_ssize_t, Int}, call = CImpl)
-    @CApiBuiltin(name = "PyMethodDescrObject_GetMethod", ret = PyMethodDef, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyMethod_Function", ret = PyObject, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyMethod_Self", ret = PyObject, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyModuleDef_Init", ret = PyObject, args = {PYMODULEDEF_PTR}, call = CImpl)
diff --git a/graalpython/lib-graalpython/patches/Cython-0.29.32.patch b/graalpython/lib-graalpython/patches/Cython-0.29.32.patch
@@ -219,10 +219,10 @@ index b2c67dc..ad80ca4 100644
          PyTypeObject *d_type = descr->d_type;
          #else
 -        PyTypeObject *d_type = descr->d_common.d_type;
-+        PyTypeObject *d_type = PyDescrObject_GetType(method);
++        PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
          #endif
 -        return PyDescr_NewClassMethod(d_type, descr->d_method);
-+        return PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
++        return PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
      }
  #endif
      else if (PyMethod_Check(method)) {
@@ -320,8 +320,8 @@ index 6e7153c..6d766a1 100644
          PyMethodDescrObject *descr = (PyMethodDescrObject*) method;
 -        target->func = descr->d_method->ml_meth;
 -        target->flag = descr->d_method->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
-+        target->func = PyMethodDescrObject_GetMethod(method)->ml_meth;
-+        target->flag = PyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
++        target->func = GraalPyMethodDescrObject_GetMethod(method)->ml_meth;
++        target->flag = GraalPyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
      }
  #endif
      return 0;
diff --git a/graalpython/lib-graalpython/patches/Cython-0.29.37.patch b/graalpython/lib-graalpython/patches/Cython-0.29.37.patch
@@ -237,10 +237,10 @@ index 93f577f..5dac1d7 100644
          PyTypeObject *d_type = descr->d_type;
          #else
 -        PyTypeObject *d_type = descr->d_common.d_type;
-+        PyTypeObject *d_type = PyDescrObject_GetType(method);
++        PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
          #endif
 -        return PyDescr_NewClassMethod(d_type, descr->d_method);
-+        return PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
++        return PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
      }
  #endif
      else if (PyMethod_Check(method)) {
@@ -338,8 +338,8 @@ index 5c4d9e1..4cdd29a 100644
          PyMethodDescrObject *descr = (PyMethodDescrObject*) method;
 -        target->func = descr->d_method->ml_meth;
 -        target->flag = descr->d_method->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
-+        target->func = PyMethodDescrObject_GetMethod(method)->ml_meth;
-+        target->flag = PyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
++        target->func = GraalPyMethodDescrObject_GetMethod(method)->ml_meth;
++        target->flag = GraalPyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
      }
  #endif
      return 0;
diff --git a/graalpython/lib-graalpython/patches/Cython-3.0.10.patch b/graalpython/lib-graalpython/patches/Cython-3.0.10.patch
@@ -214,10 +214,10 @@ index 3ea60f5..18d1842 100644
          PyTypeObject *d_type = descr->d_type;
          #else
 -        PyTypeObject *d_type = descr->d_common.d_type;
-+        PyTypeObject *d_type = PyDescrObject_GetType(method);
++        PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
          #endif
 -        return PyDescr_NewClassMethod(d_type, descr->d_method);
-+        return PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
++        return PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
      }
  #endif
      else if (PyMethod_Check(method)) {
@@ -275,8 +275,8 @@ index 1021edf..6139fd2 100644
          PyMethodDescrObject *descr = (PyMethodDescrObject*) method;
 -        target->func = descr->d_method->ml_meth;
 -        target->flag = descr->d_method->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
-+        target->func = PyMethodDescrObject_GetMethod(method)->ml_meth;
-+        target->flag = PyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
++        target->func = GraalPyMethodDescrObject_GetMethod(method)->ml_meth;
++        target->flag = GraalPyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
      } else
  #endif
      // bound classmethods need special treatment
diff --git a/graalpython/lib-graalpython/patches/catboost-1.2.2.patch b/graalpython/lib-graalpython/patches/catboost-1.2.2.patch
@@ -316,10 +316,10 @@ index 93f577f6..5dac1d70 100644
          PyTypeObject *d_type = descr->d_type;
          #else
 -        PyTypeObject *d_type = descr->d_common.d_type;
-+        PyTypeObject *d_type = PyDescrObject_GetType(method);
++        PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
          #endif
 -        return PyDescr_NewClassMethod(d_type, descr->d_method);
-+        return PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
++        return PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
      }
  #endif
      else if (PyMethod_Check(method)) {
@@ -412,8 +412,8 @@ index a39ad3a0..97f29a9c 100644
          PyMethodDescrObject *descr = (PyMethodDescrObject*) method;
 -        target->func = descr->d_method->ml_meth;
 -        target->flag = descr->d_method->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
-+        target->func = PyMethodDescrObject_GetMethod(method)->ml_meth;
-+        target->flag = PyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
++        target->func = GraalPyMethodDescrObject_GetMethod(method)->ml_meth;
++        target->flag = GraalPyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
      }
  #endif
      return 0;
diff --git a/graalpython/lib-graalpython/patches/catboost-1.2.3.patch b/graalpython/lib-graalpython/patches/catboost-1.2.3.patch
@@ -316,10 +316,10 @@ index 93f577f6..5dac1d70 100644
          PyTypeObject *d_type = descr->d_type;
          #else
 -        PyTypeObject *d_type = descr->d_common.d_type;
-+        PyTypeObject *d_type = PyDescrObject_GetType(method);
++        PyTypeObject *d_type = GraalPyDescrObject_GetType(method);
          #endif
 -        return PyDescr_NewClassMethod(d_type, descr->d_method);
-+        return PyDescr_NewClassMethod(d_type, PyMethodDescrObject_GetMethod(method));
++        return PyDescr_NewClassMethod(d_type, GraalPyMethodDescrObject_GetMethod(method));
      }
  #endif
      else if (PyMethod_Check(method)) {
@@ -412,8 +412,8 @@ index 5c4d9e16..4cdd29aa 100644
          PyMethodDescrObject *descr = (PyMethodDescrObject*) method;
 -        target->func = descr->d_method->ml_meth;
 -        target->flag = descr->d_method->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
-+        target->func = PyMethodDescrObject_GetMethod(method)->ml_meth;
-+        target->flag = PyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
++        target->func = GraalPyMethodDescrObject_GetMethod(method)->ml_meth;
++        target->flag = GraalPyMethodDescrObject_GetMethod(method)->ml_flags & ~(METH_CLASS | METH_STATIC | METH_COEXIST | METH_STACKLESS);
      }
  #endif
      return 0;

Original file line number	Diff line number	Diff line change
`@@ -63,15 +63,15 @@ PyObject* PyDescr_NewGetSet(PyTypeObject type, PyGetSetDef getset) {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`
`66`		`-PyMethodDef* PyMethodDescrObject_GetMethod(PyObject* descr) {`
	`66`	`+PyMethodDef* GraalPyMethodDescrObject_GetMethod(PyObject* descr) {`
`67`	`67`	`return GraalPyPrivate_GET_PyMethodDescrObject_d_method(descr);`
`68`	`68`	`}`
`69`	`69`
`70`		`-PyTypeObject* PyDescrObject_GetType(PyObject* descr) {`
	`70`	`+PyTypeObject* GraalPyDescrObject_GetType(PyObject* descr) {`
`71`	`71`	`return GraalPyPrivate_GET_PyDescrObject_d_type(descr);`
`72`	`72`	`}`
`73`	`73`
`74`		`-PyObject* PyDescrObject_GetName(PyObject* descr) {`
	`74`	`+PyObject* GraalPyDescrObject_GetName(PyObject* descr) {`
`75`	`75`	`return GraalPyPrivate_GET_PyDescrObject_d_name(descr);`
`76`	`76`	`}`
`77`	`77`