Add GraalPyCFunction_GetDoc/SetDoc public API

Author: msimacek

graalpython/com.oracle.graal.python.cext/include/methodobject.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2018, 2023, Oracle and/or its affiliates.
+/* Copyright (c) 2018, 2024, Oracle and/or its affiliates.
  * Copyright (C) 1996-2020 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -125,6 +125,10 @@ PyAPI_FUNC(PyObject *) PyCMethod_New(PyMethodDef *, PyObject *,
 #define METH_METHOD 0x0200
 #endif
 
+// GraalPy public API functions
+PyAPI_FUNC(const char*) GraalPyCFunction_GetDoc(PyObject *func);
+PyAPI_FUNC(void) GraalPyCFunction_SetDoc(PyObject *func, const char *doc);
+
 
 #ifndef Py_LIMITED_API
 #  define Py_CPYTHON_METHODOBJECT_H

graalpython/com.oracle.graal.python.cext/src/methodobject.c

@@ -102,3 +102,17 @@ void _PyCFunction_SetModule(PyObject *func, PyObject *mod) {
 void _PyCFunction_SetMethodDef(PyObject *func, PyMethodDef *def) {
     set_PyCFunctionObject_m_ml(func, def);
 }
+
+// GraalPy additions
+const char *
+GraalPyCFunction_GetDoc(PyObject *func) {
+    return PyCFunctionObject_m_ml(func)->ml_doc;
+}
+
+void
+GraalPyCFunction_SetDoc(PyObject *func, const char *doc) {
+    PyCFunctionObject_m_ml(func)->ml_doc = doc;
+    if (points_to_py_handle_space(func)) {
+        GraalPyTruffleCFunction_SetDoc(func, doc);
+    }
+}

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextFuncBuiltins.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 2024, 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
@@ -41,16 +41,27 @@
 package com.oracle.graal.python.builtins.modules.cext;
 
 import static com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiCallPath.Direct;
+import static com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiCallPath.Ignored;
+import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.ConstCharPtrAsTruffleString;
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObject;
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObjectTransfer;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___DOC__;
 
 import com.oracle.graal.python.builtins.PythonBuiltinClassType;
+import com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiBinaryBuiltinNode;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiBuiltin;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiUnaryBuiltinNode;
+import com.oracle.graal.python.builtins.objects.PNone;
+import com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor;
+import com.oracle.graal.python.builtins.objects.function.PBuiltinFunction;
+import com.oracle.graal.python.builtins.objects.method.PBuiltinMethod;
 import com.oracle.graal.python.builtins.objects.method.PDecoratedMethod;
 import com.oracle.graal.python.runtime.object.PythonObjectFactory;
+import com.oracle.truffle.api.CompilerDirectives;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.strings.TruffleString;
 
 public final class PythonCextFuncBuiltins {
 
@@ -73,4 +84,22 @@ static Object staticmethod(Object callable,
             return factory.createClassmethodFromCallableObj(callable);
         }
     }
+
+    @CApiBuiltin(ret = ArgDescriptor.Void, args = {PyObject, ConstCharPtrAsTruffleString}, call = Ignored)
+    abstract static class PyTruffleCFunction_SetDoc extends CApiBinaryBuiltinNode {
+        @Specialization
+        @TruffleBoundary
+        static Object set(Object functionObj, TruffleString doc) {
+            PBuiltinFunction function;
+            if (functionObj instanceof PBuiltinFunction builtinFunction) {
+                function = builtinFunction;
+            } else if (functionObj instanceof PBuiltinMethod builtinMethod) {
+                function = builtinMethod.getBuiltinFunction();
+            } else {
+                throw CompilerDirectives.shouldNotReachHere("Unexpected object passed to GraalPyCFunction_SetDoc");
+            }
+            function.setAttribute(T___DOC__, doc != null ? doc : PNone.NONE);
+            return PNone.NO_VALUE;
+        }
+    }
 }

graalpython/lib-graalpython/modules/autopatch_capi.py

@@ -156,7 +156,7 @@ def consume_whitespace_forward(idx):
                     r'\W(ob_refcnt)\W': (replace_field_access, 'Py_REFCNT(%receiver)'),
                     r'\W(ob_item)\W': (replace_field_access, 'PySequence_Fast_ITEMS((PyObject*)%receiver)'),
                     r'^\s*()(std::)?free\((const_cast<char \*>)?\(?\w+->m_ml->ml_doc\)?\);': (simple_replace, '//'),
-                    r'\W(m_ml\s*->\s*ml_doc)\W': (replace_field_access, 'PyObject_GetDoc((PyObject*)(%receiver))', 'PyObject_SetDoc((PyObject*)(%receiver), %value)'),
+                    r'\W(m_ml\s*->\s*ml_doc)\W': (replace_field_access, 'GraalPyCFunction_GetDoc((PyObject*)(%receiver))', 'GraalPyCFunction_SetDoc((PyObject*)(%receiver), %value)'),
                     # Py_CLEAR/Py_VISIT on a function's module is skipped for us, Java GC takes care of it
                     r'(Py_(?:CLEAR|VISIT)\((?:(?:\(?\([a-zA-Z0-9_]|[a-zA-Z0-9_])(?:[a-zA-Z0-9_]|\)|\*\)|->)*)->m_module\);)': (simple_replace, ''),
                     r'\W(m_ml)\W': (replace_field_access, '_PyCFunction_GetMethodDef((PyObject*)(%receiver))', '_PyCFunction_SetMethodDef((PyObject*)(%receiver), %value)'),