Add capsule repr

Author: msimacek

graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_capsule.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 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
@@ -37,12 +37,21 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 import gc
+import re
+
 import os
 import time
 
 from . import CPyExtTestCase, CPyExtFunction, unhandled_error_compare, CPyExtType
 
 
+def _capsule_repr_cmpfunc(a, b):
+    if isinstance(a, str) and (b, str):
+        a = re.sub("0x[a-f0-9]+", "0xaaa", a)
+        b = re.sub("0x[a-f0-9]+", "0xaaa", b)
+    return unhandled_error_compare(a, b)
+
+
 class TestPyCapsule(CPyExtTestCase):
     test_PyCapsule_CheckExact = CPyExtFunction(
         lambda args: True,
@@ -150,6 +159,24 @@ class TestPyCapsule(CPyExtTestCase):
         cmpfunc=unhandled_error_compare
     )
 
+    test_PyCapsule__repr__ = CPyExtFunction(
+        lambda args: f'<capsule object "{args[0]}" at 0xaaaa>',
+        lambda: (
+            ("hello", 0xDEADBEEF),
+        ),
+        code='''
+        PyObject* wrap_PyCapsule__repr__(char * name, Py_ssize_t ptr) {
+            PyObject* capsule = PyCapsule_New((void*)ptr, name, NULL);
+            return PyObject_Repr(capsule);
+        }
+        ''',
+        resultspec="O",
+        argspec='sn',
+        arguments=["char* name", "Py_ssize_t ptr"],
+        callfunction="wrap_PyCapsule__repr__",
+        cmpfunc=_capsule_repr_cmpfunc,
+    )
+
     if os.environ.get('GRAALPYTEST_RUN_GC_TESTS'):
         def test_capsule_destructor(self):
             Tester = CPyExtType(
@@ -161,7 +188,7 @@ def test_capsule_destructor(self):
                     PyDict_SetItemString(contents, "destructor_was_here", Py_NewRef(Py_True));
                     Py_DECREF(contents);
                 }
-                
+
                 static PyObject* create_capsule(PyObject* unused, PyObject* contents) {
                     return PyCapsule_New(Py_NewRef(contents), "capsule", capsule_destructor);
                 }

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/PythonBuiltinClassType.java

@@ -269,6 +269,7 @@
 import com.oracle.graal.python.builtins.objects.thread.ThreadLocalBuiltins;
 import com.oracle.graal.python.builtins.objects.tokenize.TokenizerIterBuiltins;
 import com.oracle.graal.python.builtins.objects.traceback.TracebackBuiltins;
+import com.oracle.graal.python.builtins.objects.tuple.CapsuleBuiltins;
 import com.oracle.graal.python.builtins.objects.tuple.InstantiableStructSequenceBuiltins;
 import com.oracle.graal.python.builtins.objects.tuple.StructSequenceBuiltins;
 import com.oracle.graal.python.builtins.objects.tuple.TupleBuiltins;
@@ -1251,7 +1252,7 @@ def takewhile(predicate, iterable):
     // CPython uses separate keys, values, items python types for the iterators.
     ContextIterator("context_iterator", PythonObject, newBuilder().publishInModule(J__CONTEXTVARS).slots(ContextIteratorBuiltins.SLOTS)),
 
-    Capsule("PyCapsule", PythonObject, newBuilder().basetype()),
+    Capsule("PyCapsule", PythonObject, newBuilder().basetype().slots(CapsuleBuiltins.SLOTS)),
 
     PTokenizerIter("TokenizerIter", PythonObject, newBuilder().publishInModule("_tokenize").basetype().slots(TokenizerIterBuiltins.SLOTS)),
 

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/structs/CStructAccess.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 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
@@ -354,6 +354,10 @@ static int readManaged(Object pointer, long offset,
         protected static boolean isCharSigned() {
             return CConstants.CHAR_MIN.longValue() < 0;
         }
+
+        public static ReadByteNode getUncached() {
+            return CStructAccessFactory.ReadByteNodeGen.getUncached();
+        }
     }
 
     @ImportStatic(PGuards.class)

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/tuple/CapsuleBuiltins.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 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
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+package com.oracle.graal.python.builtins.objects.tuple;
+
+import static com.oracle.graal.python.util.PythonUtils.TS_ENCODING;
+
+import java.util.Collections;
+import java.util.List;
+
+import com.oracle.graal.python.annotations.Slot;
+import com.oracle.graal.python.annotations.Slot.SlotKind;
+import com.oracle.graal.python.builtins.CoreFunctions;
+import com.oracle.graal.python.builtins.PythonBuiltinClassType;
+import com.oracle.graal.python.builtins.PythonBuiltins;
+import com.oracle.graal.python.builtins.objects.capsule.PyCapsule;
+import com.oracle.graal.python.builtins.objects.cext.PythonAbstractNativeObject;
+import com.oracle.graal.python.builtins.objects.cext.structs.CStructAccess;
+import com.oracle.graal.python.builtins.objects.type.TpSlots;
+import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
+import com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode;
+import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
+import com.oracle.truffle.api.dsl.GenerateNodeFactory;
+import com.oracle.truffle.api.dsl.NodeFactory;
+import com.oracle.truffle.api.dsl.Specialization;
+import com.oracle.truffle.api.interop.InteropLibrary;
+import com.oracle.truffle.api.strings.TruffleString;
+
+@CoreFunctions(extendClasses = PythonBuiltinClassType.Capsule)
+public class CapsuleBuiltins extends PythonBuiltins {
+
+    public static final TpSlots SLOTS = CapsuleBuiltinsSlotsGen.SLOTS;
+
+    @Override
+    protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFactories() {
+        return Collections.emptyList();
+    }
+
+    @Slot(value = SlotKind.tp_repr, isComplex = true)
+    @GenerateNodeFactory
+    abstract static class ReprNode extends PythonUnaryBuiltinNode {
+
+        @Specialization
+        @TruffleBoundary
+        static Object repr(PyCapsule self) {
+            String name;
+            if (self.getNamePtr() == null || InteropLibrary.getUncached().isNull(self.getNamePtr())) {
+                name = "NULL";
+            } else {
+                StringBuilder builder = new StringBuilder("\"");
+                int i = 0;
+                byte b;
+                while ((b = CStructAccess.ReadByteNode.getUncached().readArrayElement(self.getNamePtr(), i++)) != 0) {
+                    builder.append((char) b);
+                }
+                builder.append('"');
+                name = builder.toString();
+            }
+            return TruffleString.fromJavaStringUncached(String.format("<capsule object %s at 0x%s>", name, PythonAbstractNativeObject.systemHashCodeAsHexString(self)), TS_ENCODING);
+        }
+    }
+}