[GR-63044] Implement tp_repr and tp_str slots

PullRequest: graalpython/3723

Author: msimacek

graalpython/com.oracle.graal.python.annotations/src/com/oracle/graal/python/annotations/Slot.java

@@ -196,7 +196,11 @@ enum SlotKind {
         /** iter(obj) */
         tp_iter("__iter__"),
         /** next(obj) */
-        tp_iternext("__next__");
+        tp_iternext("__next__"),
+        /** str(obj) */
+        tp_str("__str__"),
+        /** repr(obj) */
+        tp_repr("__repr__");
 
         SlotKind(@SuppressWarnings("unused") String specialMethods) {
         }

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

@@ -1,4 +1,4 @@
-/* Copyright (c) 2024, Oracle and/or its affiliates.
+/* Copyright (c) 2024, 2025, Oracle and/or its affiliates.
  * Copyright (C) 1996-2022 Python Software Foundation
  *
  * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
@@ -385,6 +385,7 @@ static PyMethodDef structseq_methods[] = {
     {"__reduce__", (PyCFunction)structseq_reduce, METH_NOARGS, NULL},
     {NULL, NULL}
 };
+#endif // GraalPy change
 
 static Py_ssize_t
 count_members(PyStructSequence_Desc *desc, Py_ssize_t *n_unnamed_members) {
@@ -399,6 +400,7 @@ count_members(PyStructSequence_Desc *desc, Py_ssize_t *n_unnamed_members) {
     return i;
 }
 
+#if 0 // GraalPy change
 static int
 initialize_structseq_dict(PyStructSequence_Desc *desc, PyObject* dict,
                           Py_ssize_t n_members, Py_ssize_t n_unnamed_members) {
@@ -455,6 +457,7 @@ initialize_structseq_dict(PyStructSequence_Desc *desc, PyObject* dict,
     Py_DECREF(keys);
     return -1;
 }
+#endif // GraalPy change
 
 static void
 initialize_members(PyStructSequence_Desc *desc, PyMemberDef* members,
@@ -478,7 +481,6 @@ initialize_members(PyStructSequence_Desc *desc, PyMemberDef* members,
     }
     members[k].name = NULL;
 }
-#endif // GraalPy change
 
 
 int
@@ -518,7 +520,6 @@ _PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc,
     type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | tp_flags;
     type->tp_traverse = (traverseproc) structseq_traverse;
 
-#if 0 // GraalPy change: initialize members in an upcall later
     n_members = count_members(desc, &n_unnamed_members);
     members = PyMem_NEW(PyMemberDef, n_members - n_unnamed_members + 1);
     if (members == NULL) {
@@ -527,9 +528,6 @@ _PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc,
     }
     initialize_members(desc, members, n_members);
     type->tp_members = members;
-#else // GraalPy change
-    type->tp_members = NULL;
-#endif // GraalPy change
 
     if (PyType_Ready(type) < 0) {
         // GraalPy change: not initialized

graalpython/com.oracle.graal.python.processor/src/com/oracle/graal/python/processor/SlotsMapping.java

@@ -53,7 +53,7 @@ static String getSlotBaseClass(Slot s) {
         return switch (s.value()) {
             case nb_bool -> "TpSlotInquiry.TpSlotInquiryBuiltin";
             case nb_index, nb_int, nb_float, nb_absolute, nb_positive, nb_negative, nb_invert,
-                            tp_iter ->
+                            tp_iter, tp_str, tp_repr ->
                 "TpSlotUnaryFunc.TpSlotUnaryFuncBuiltin";
             case nb_add, nb_subtract, nb_multiply, nb_remainder, nb_divmod, nb_lshift, nb_rshift, nb_and, nb_xor, nb_or,
                             nb_floor_divide, nb_true_divide, nb_matrix_multiply ->
@@ -85,7 +85,7 @@ static String getSlotNodeBaseClass(Slot s) {
             case tp_descr_get -> "com.oracle.graal.python.builtins.objects.type.slots.TpSlotDescrGet.DescrGetBuiltinNode";
             case nb_bool -> "com.oracle.graal.python.builtins.objects.type.slots.TpSlotInquiry.NbBoolBuiltinNode";
             case nb_index, nb_int, nb_float, nb_absolute, nb_positive, nb_negative, nb_invert,
-                            tp_iter, tp_iternext ->
+                            tp_iter, tp_iternext, tp_str, tp_repr ->
                 "com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode";
             case nb_add, nb_subtract, nb_multiply, nb_remainder, nb_divmod, nb_lshift, nb_rshift, nb_and, nb_xor, nb_or,
                             nb_floor_divide, nb_true_divide, nb_matrix_multiply ->
@@ -181,6 +181,8 @@ public static String getExtraCtorArgs(TpSlotData slot) {
             case sq_inplace_concat -> ", com.oracle.graal.python.nodes.SpecialMethodNames.J___IADD__";
             case sq_inplace_repeat -> ", com.oracle.graal.python.nodes.SpecialMethodNames.J___IMUL__";
             case tp_iter -> ", com.oracle.graal.python.nodes.SpecialMethodNames.J___ITER__";
+            case tp_str -> ", com.oracle.graal.python.nodes.SpecialMethodNames.J___STR__";
+            case tp_repr -> ", com.oracle.graal.python.nodes.SpecialMethodNames.J___REPR__";
             default -> "";
         };
     }

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

@@ -1,4 +1,4 @@
-# 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
@@ -48,6 +48,7 @@ def test_properties(self):
                                static PyStructSequence_Field typeinfo_fields[] = {
                                    {"element0",      "The first element."},
                                    {"element1",      "The second element."},
+                                   {"element2",      "The third element."},
                                    {NULL, NULL,}
                                };
 
@@ -69,11 +70,18 @@ def test_properties(self):
                                           )
         assert TestPyStructSequence.__doc__ == "Information about some custom struct type"
 
-        tester = TestPyStructSequence(("hello", "world"))
+        tester = TestPyStructSequence(("hello", "world"), {"element2": 1})
         assert hasattr(tester, "element0")
         assert hasattr(tester, "element1")
         assert tester.element0 == "hello"
         assert tester.element1 == "world"
+        assert tester.element2 == 1
+        assert len(tester) == 2
+        assert tuple(tester) == ("hello", "world")
+        assert repr(tester) == "TestPyStructSequenceTypes.TestPyStructSequence(element0='hello', element1='world')"
+        assert tester.__repr__() == "TestPyStructSequenceTypes.TestPyStructSequence(element0='hello', element1='world')"
+        assert tester.__reduce__() == (TestPyStructSequence, (('hello', 'world'), {'element2': 1}))
+        assert tester.__reduce__.__qualname__ == "TestPyStructSequence.__reduce__"
 
     def test_structseq_newtype(self):
         TestPyStructSequenceNewType = CPyExtType("TestPyStructSequenceNewType", """

graalpython/com.oracle.graal.python.test/src/tests/test_structseq.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2021, 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
@@ -79,7 +79,8 @@ def test_constructor_err(self):
         with self.assertRaisesRegex(TypeError, r'os.stat_result\(\) takes an at most \d+-sequence \(30-sequence given\)'):
             posix.stat_result((1,) * 30)
         with self.assertRaisesRegex(TypeError, r'cannot create \'sys.flags\' instances'):
-            type(sys.flags)()
+            # GraalPy change: add argument to avoid hitting the argument error first
+            type(sys.flags)(())
 
     def test_no_subclass(self):
         with self.assertRaises(TypeError):

graalpython/com.oracle.graal.python/src/com/oracle/graal/python/PythonLanguage.java

@@ -37,7 +37,6 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.lang.invoke.VarHandle;
-import java.lang.ref.WeakReference;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.InvalidPathException;
 import java.util.ArrayList;
@@ -71,9 +70,6 @@
 import com.oracle.graal.python.builtins.objects.module.PythonModule;
 import com.oracle.graal.python.builtins.objects.object.PythonObject;
 import com.oracle.graal.python.builtins.objects.tuple.StructSequence;
-import com.oracle.graal.python.builtins.objects.tuple.StructSequence.BuiltinTypeDescriptor;
-import com.oracle.graal.python.builtins.objects.tuple.StructSequence.Descriptor;
-import com.oracle.graal.python.builtins.objects.tuple.StructSequence.DescriptorCallTargets;
 import com.oracle.graal.python.builtins.objects.type.MroShape;
 import com.oracle.graal.python.builtins.objects.type.PythonAbstractClass;
 import com.oracle.graal.python.builtins.objects.type.PythonManagedClass;
@@ -363,46 +359,6 @@ public boolean isSingleContext() {
 
     @CompilationFinal(dimensions = 1) private final RootCallTarget[] builtinSlotsCallTargets;
 
-    /**
-     * Weak hash map of call targets for builtin functions associated with named tuples generated at
-     * runtime from C extensions. We hold the cached call targets also weakly, because otherwise we
-     * would have a cycle from the value (call targets reference builtin nodes which wrap the
-     * descriptor) to the key. The key should be GC'ed when the corresponding generated named tuple
-     * class is GC'ed.
-     */
-    private final WeakHashMap<StructSequence.Descriptor, WeakReference<StructSequence.DescriptorCallTargets>> structSequenceTargets = new WeakHashMap<>();
-
-    /**
-     * The same as {@link #structSequenceTargets}, but for builtin named tuples. There is a bounded
-     * statically known number of builtin named tuples.
-     */
-    private final ConcurrentHashMap<StructSequence.Descriptor, StructSequence.DescriptorCallTargets> structSequenceBuiltinTargets = new ConcurrentHashMap<>();
-
-    public StructSequence.DescriptorCallTargets getOrCreateStructSequenceCallTargets(StructSequence.Descriptor descriptor,
-                    Function<StructSequence.Descriptor, StructSequence.DescriptorCallTargets> factory) {
-        if (singleContext) {
-            return factory.apply(descriptor);
-        }
-        if (descriptor instanceof BuiltinTypeDescriptor builtinDescriptor) {
-            // There must be finite set of objects initialized in static final fields, no need for a
-            // weak map
-            return structSequenceBuiltinTargets.computeIfAbsent(builtinDescriptor, factory);
-        }
-        return getOrCreateStructSeqNonBuiltinTargets(descriptor, factory);
-    }
-
-    private DescriptorCallTargets getOrCreateStructSeqNonBuiltinTargets(Descriptor descriptor, Function<Descriptor, DescriptorCallTargets> factory) {
-        synchronized (structSequenceTargets) {
-            WeakReference<DescriptorCallTargets> weakResult = structSequenceTargets.computeIfAbsent(descriptor, d -> new WeakReference<>(factory.apply(d)));
-            DescriptorCallTargets result = weakResult.get();
-            if (result == null) {
-                result = factory.apply(descriptor);
-                structSequenceTargets.put(descriptor, new WeakReference<>(result));
-            }
-            return result;
-        }
-    }
-
     /**
      * We cannot initialize call targets in language ctor and the next suitable hook is context
      * initialization, but that is called multiple times. We use this flag to run the language
@@ -482,7 +438,6 @@ protected void finalizeContext(PythonContext context) {
         context.finalizeContext();
         super.finalizeContext(context);
         // trigger cleanup of stale entries in weak hash maps
-        structSequenceTargets.size();
         indirectCallDataMap.size();
     }
 

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

@@ -37,7 +37,6 @@
 import static com.oracle.graal.python.nodes.BuiltinNames.T___BUILTINS__;
 import static com.oracle.graal.python.nodes.BuiltinNames.T___IMPORT__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___PACKAGE__;
-import static com.oracle.graal.python.nodes.SpecialMethodNames.T___REPR__;
 import static com.oracle.graal.python.nodes.StringLiterals.J_PY_EXTENSION;
 import static com.oracle.graal.python.nodes.StringLiterals.T_DOT;
 import static com.oracle.graal.python.nodes.StringLiterals.T_GRAALPYTHON;
@@ -312,6 +311,7 @@
 import com.oracle.graal.python.builtins.objects.method.BuiltinClassmethodBuiltins;
 import com.oracle.graal.python.builtins.objects.method.BuiltinFunctionOrMethodBuiltins;
 import com.oracle.graal.python.builtins.objects.method.ClassmethodBuiltins;
+import com.oracle.graal.python.builtins.objects.method.ClassmethodCommonBuiltins;
 import com.oracle.graal.python.builtins.objects.method.DecoratedMethodBuiltins;
 import com.oracle.graal.python.builtins.objects.method.InstancemethodBuiltins;
 import com.oracle.graal.python.builtins.objects.method.MethodBuiltins;
@@ -355,6 +355,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.StructSequenceBuiltins;
 import com.oracle.graal.python.builtins.objects.tuple.TupleBuiltins;
 import com.oracle.graal.python.builtins.objects.tuple.TupleGetterBuiltins;
 import com.oracle.graal.python.builtins.objects.type.PythonBuiltinClass;
@@ -462,6 +463,7 @@ private static PythonBuiltins[] initializeBuiltins(TruffleLanguage.Env env) {
                         new BuiltinFunctions(),
                         new DecoratedMethodBuiltins(),
                         new ClassmethodBuiltins(),
+                        new ClassmethodCommonBuiltins(),
                         new StaticmethodBuiltins(),
                         new InstancemethodBuiltins(),
                         new SimpleNamespaceBuiltins(),
@@ -491,6 +493,7 @@ private static PythonBuiltins[] initializeBuiltins(TruffleLanguage.Env env) {
                         new RangeBuiltins(),
                         new SliceBuiltins(),
                         new TupleBuiltins(),
+                        new StructSequenceBuiltins(),
                         new StringBuiltins(),
                         new BaseSetBuiltins(),
                         new SetBuiltins(),
@@ -961,11 +964,6 @@ private void initializeImportlib() {
         importFunc = (PFunction) __import__;
         importlib = bootstrap;
 
-        PythonBuiltinClass moduleType = lookupType(PythonBuiltinClassType.PythonModule);
-        writeNode.execute(moduleType, T___REPR__, readNode.execute(bootstrap, toTruffleStringUncached("_module_repr")));
-
-        SpecialMethodSlot.reinitializeSpecialMethodSlots(moduleType, getLanguage());
-
         // see CPython's init_importlib_external
         callNode.execute(null, null, bootstrap, toTruffleStringUncached("_install_external_importers"));
         if (!PythonImageBuildOptions.WITHOUT_COMPRESSION_LIBRARIES) {