[GR-62548] Better langchain interop.

timfel · timfel · commit 74c015727373 · 2025-02-26T00:45:58.000Z
PullRequest: graalpython/3701
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ language runtime. The main focus is on user-observable behavior of the engine.
 
 ## Version 25.0.0
 * `dir(foreign_object)` now returns both foreign methods and Python methods (it used to return only foreign methods).
+* Support `__name__`, `__doc__`, `__text_signature__` fields on foreign executables to serve as their proper counterparts on the Python side. This is useful to, for example, use Java functional interfaces in lieu of Python functions for things like LangChain's `@tool` annotation that want to inspect the underlying function.
 
 ## Version 24.2.0
 * Updated developer metadata of Maven artifacts.
diff --git a/graalpython/com.oracle.graal.python.cext/src/object.c b/graalpython/com.oracle.graal.python.cext/src/object.c
@@ -2369,6 +2369,15 @@ _PyTrash_cond(PyObject *op, destructor dealloc)
     return Py_TYPE(op)->tp_dealloc == dealloc;
 }
 
+// Begin GraalPy change
+#if ((__linux__ && __GNU_LIBRARY__) || __APPLE__)
+#include <execinfo.h>
+static void bt() {
+    void* stack[8];
+    backtrace_symbols_fd(stack, backtrace(stack, 8), stderr);
+}
+#endif
+// End GraalPy change
 
 void _Py_NO_RETURN
 _PyObject_AssertFailed(PyObject *obj, const char *expr, const char *msg,
@@ -2394,14 +2403,22 @@ _PyObject_AssertFailed(PyObject *obj, const char *expr, const char *msg,
     fprintf(stderr, "\n");
     fflush(stderr);
 
-#if 0 // GraalPy change
+    // Begin GraalPy change
+#if ((__linux__ && __GNU_LIBRARY__) || __APPLE__)
+    fprintf(stderr, "Native backtrace:\n");
+    bt();
+    fflush(stderr);
+#endif
+    // End GraalPy change
+
     if (_PyObject_IsFreed(obj)) {
         /* It seems like the object memory has been freed:
            don't access it to prevent a segmentation fault. */
         fprintf(stderr, "<object at %p is freed>\n", obj);
         fflush(stderr);
     }
     else {
+#if 0 // GraalPy change
         /* Display the traceback where the object has been allocated.
            Do it before dumping repr(obj), since repr() is more likely
            to crash than dumping the traceback. */
@@ -2418,14 +2435,11 @@ _PyObject_AssertFailed(PyObject *obj, const char *expr, const char *msg,
 #endif // GraalPy change
         /* This might succeed or fail, but we're about to abort, so at least
            try to provide any extra info we can: */
-        if (obj) // GraalPy change, guard call to _PyObject_Dump
         _PyObject_Dump(obj);
 
-#if 0 // GraalPy change
         fprintf(stderr, "\n");
         fflush(stderr);
     }
-#endif // GraalPy change
 
     Py_FatalError("_PyObject_AssertFailed");
 }
diff --git a/graalpython/com.oracle.graal.python.test.integration/src/com/oracle/graal/python/test/integration/interop/JavaInteropTest.java b/graalpython/com.oracle.graal.python.test.integration/src/com/oracle/graal/python/test/integration/interop/JavaInteropTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2017, 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
@@ -839,6 +839,46 @@ class Bar(Foo):
             assertEquals(object.getMetaSimpleName(), "object");
             assertFalse(object.hasMetaParents());
         }
+
+        public static class MyFunction implements java.util.function.Function<String, String> {
+            public String __text_signature__ = "(string) -> str";
+
+            @Override
+            public String apply(String s) {
+                return s;
+            }
+        }
+
+        public static class MyFunctionWithCustomName implements java.util.function.Function<String, String> {
+            public String __text_signature__ = "(string) -> str";
+            public String __name__ = "myfunc";
+
+            @Override
+            public String apply(String s) {
+                return s;
+            }
+        }
+
+        public static class MyFunctionWithIncorrectSignature implements java.util.function.Function<String, String> {
+            public String __text_signature__ = "[I;java.lang.String;";
+
+            @Override
+            public String apply(String s) {
+                return s;
+            }
+        }
+
+        @Test
+        public void javaExecutablesAsPythonFunctions() {
+            Value inspectSignature = context.eval("python", "import inspect; inspect.signature");
+            assertEquals("<Signature (string)>", inspectSignature.execute(new MyFunction()).toString());
+
+            Value signature = context.eval("python", "lambda f: f.__text_signature__");
+            assertEquals(new MyFunctionWithIncorrectSignature().__text_signature__, signature.execute(new MyFunctionWithIncorrectSignature()).asString());
+
+            Value name = context.eval("python", "lambda f: f.__name__");
+            assertEquals(new MyFunctionWithCustomName().__name__, name.execute(new MyFunctionWithCustomName()).asString());
+        }
     }
 
     @RunWith(Parameterized.class)
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextObjectBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextObjectBuiltins.java
@@ -49,6 +49,7 @@
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.Pointer;
 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.PyObjectConstPtr;
+import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObjectRawPointer;
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObjectTransfer;
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObjectWrapper;
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyThreadState;
@@ -599,6 +600,15 @@ static PNone set(PSequence obj, long size,
         }
     }
 
+    @CApiBuiltin(ret = Int, args = {PyObjectRawPointer}, call = Direct)
+    abstract static class _PyObject_IsFreed extends CApiUnaryBuiltinNode {
+        @Specialization
+        int doGeneric(Object pointer,
+                        @Cached ToPythonWrapperNode toPythonWrapperNode) {
+            return toPythonWrapperNode.executeWrapper(pointer, false) == null ? 1 : 0;
+        }
+    }
+
     @CApiBuiltin(ret = Void, args = {PyObjectWrapper}, call = Direct)
     abstract static class _PyObject_Dump extends CApiUnaryBuiltinNode {
 
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
@@ -1119,7 +1119,6 @@ public final class CApiFunction {
     @CApiBuiltin(name = "_PyObject_GetState", ret = PyObject, args = {PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "_PyObject_HasLen", ret = Int, args = {PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "_PyObject_IsAbstract", ret = Int, args = {PyObject}, call = NotImplemented)
-    @CApiBuiltin(name = "_PyObject_IsFreed", ret = Int, args = {PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "_PyObject_LookupSpecialId", ret = PyObject, args = {PyObject, PY_IDENTIFIER}, call = NotImplemented)
     @CApiBuiltin(name = "_PyObject_RealIsInstance", ret = Int, args = {PyObject, PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "_PyObject_RealIsSubclass", ret = Int, args = {PyObject, PyObject}, call = NotImplemented)
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/transitions/ArgDescriptor.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/transitions/ArgDescriptor.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2022, 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
@@ -145,6 +145,7 @@ public enum ArgDescriptor {
     PyMethodObject(ArgBehavior.PyObject, "PyMethodObject*"),
     PyInstanceMethodObject(ArgBehavior.PyObject, "PyInstanceMethodObject*"),
     PyObjectTransfer(ArgBehavior.PyObject, "PyObject*", true),
+    PyObjectRawPointer(ArgBehavior.Pointer, "PyObject*"),
     Pointer(ArgBehavior.Pointer, "void*"),
     Py_ssize_t(ArgBehavior.Int64, "Py_ssize_t"),
     Py_hash_t(ArgBehavior.Int64, "Py_hash_t"),
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/transitions/CApiTransitions.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/cext/capi/transitions/CApiTransitions.java
@@ -1895,7 +1895,7 @@ static PythonNativeWrapper doGeneric(Node inliningTarget, long pointer, boolean
                 IdReference<?> lookup = nativeLookupGet(nativeContext, pointer);
                 if (isNativeProfile.profile(inliningTarget, lookup != null)) {
                     Object ref = lookup.get();
-                    if (ref == null) {
+                    if (strict && ref == null) {
                         CompilerDirectives.transferToInterpreterAndInvalidate();
                         throw CompilerDirectives.shouldNotReachHere("reference was collected: " + Long.toHexString(pointer));
                     }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/foreign/ForeignExecutableBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/foreign/ForeignExecutableBuiltins.java
@@ -26,6 +26,9 @@
 
 package com.oracle.graal.python.builtins.objects.foreign;
 
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___DOC__;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___NAME__;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___NAME__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.J___CALL__;
 
 import java.util.List;
@@ -35,16 +38,17 @@
 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.PNone;
 import com.oracle.graal.python.nodes.ErrorMessages;
 import com.oracle.graal.python.nodes.PRaiseNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
 import com.oracle.graal.python.nodes.function.PythonBuiltinNode;
+import com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode;
 import com.oracle.graal.python.nodes.interop.PForeignToPTypeNode;
 import com.oracle.graal.python.runtime.ExecutionContext.IndirectCallContext;
 import com.oracle.graal.python.runtime.GilNode;
 import com.oracle.graal.python.runtime.IndirectCallData;
 import com.oracle.graal.python.runtime.PythonContext;
-import com.oracle.graal.python.runtime.exception.PythonErrorType;
 import com.oracle.truffle.api.CompilerDirectives;
 import com.oracle.truffle.api.dsl.Bind;
 import com.oracle.truffle.api.dsl.Cached;
@@ -54,6 +58,7 @@
 import com.oracle.truffle.api.frame.VirtualFrame;
 import com.oracle.truffle.api.interop.ArityException;
 import com.oracle.truffle.api.interop.InteropLibrary;
+import com.oracle.truffle.api.interop.UnknownIdentifierException;
 import com.oracle.truffle.api.interop.UnsupportedMessageException;
 import com.oracle.truffle.api.interop.UnsupportedTypeException;
 import com.oracle.truffle.api.library.CachedLibrary;
@@ -66,12 +71,56 @@ protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFa
         return ForeignExecutableBuiltinsFactory.getFactories();
     }
 
+    @Builtin(name = J___NAME__, minNumOfPositionalArgs = 1, isGetter = true)
+    @GenerateNodeFactory
+    public abstract static class NameNode extends PythonUnaryBuiltinNode {
+        @Specialization
+        static Object getName(Object self,
+                        @Bind("this") Node inliningTarget,
+                        @Cached PRaiseNode raiseNode,
+                        @Cached PForeignToPTypeNode toPythonNode,
+                        @CachedLibrary(limit = "2") InteropLibrary lib) {
+            try {
+                if (lib.isMemberReadable(self, J___NAME__)) {
+                    return toPythonNode.executeConvert(lib.readMember(self, J___NAME__));
+                } else if (lib.hasExecutableName(self)) {
+                    return toPythonNode.executeConvert(lib.getExecutableName(self));
+                } else {
+                    throw raiseNode.raise(inliningTarget, PythonBuiltinClassType.AttributeError, ErrorMessages.OBJ_P_HAS_NO_ATTR_S, self, T___NAME__);
+                }
+            } catch (UnsupportedMessageException | UnknownIdentifierException e) {
+                throw CompilerDirectives.shouldNotReachHere(e);
+            }
+        }
+    }
+
+    @Builtin(name = J___DOC__, minNumOfPositionalArgs = 1, isGetter = true)
+    @GenerateNodeFactory
+    public abstract static class DocNode extends PythonUnaryBuiltinNode {
+        @Specialization
+        static Object getName(Object self,
+                        @Bind("this") Node inliningTarget,
+                        @Cached PRaiseNode raiseNode,
+                        @Cached PForeignToPTypeNode toPythonNode,
+                        @CachedLibrary(limit = "2") InteropLibrary lib) {
+            if (lib.isMemberReadable(self, J___DOC__)) {
+                try {
+                    return toPythonNode.executeConvert(lib.readMember(self, J___DOC__));
+                } catch (UnsupportedMessageException | UnknownIdentifierException e) {
+                    throw CompilerDirectives.shouldNotReachHere(e);
+                }
+            } else {
+                return PNone.NONE;
+            }
+        }
+    }
+
     @Builtin(name = J___CALL__, minNumOfPositionalArgs = 1, takesVarArgs = true)
     @GenerateNodeFactory
     public abstract static class CallNode extends PythonBuiltinNode {
         @Specialization
         static Object doInteropCall(VirtualFrame frame, Object callee, Object[] arguments,
-                        @SuppressWarnings("unused") @Bind("this") Node inliningTarget,
+                        @Bind("this") Node inliningTarget,
                         @Cached("createFor(this)") IndirectCallData indirectCallData,
                         @CachedLibrary(limit = "4") InteropLibrary lib,
                         @Cached PForeignToPTypeNode toPTypeNode,
@@ -89,7 +138,7 @@ static Object doInteropCall(VirtualFrame frame, Object callee, Object[] argument
                     IndirectCallContext.exit(frame, language, context, state);
                 }
             } catch (ArityException | UnsupportedTypeException e) {
-                throw raiseNode.raise(inliningTarget, PythonErrorType.TypeError, ErrorMessages.INVALID_INSTANTIATION_OF_FOREIGN_OBJ);
+                throw raiseNode.raise(inliningTarget, PythonBuiltinClassType.TypeError, ErrorMessages.INVALID_INSTANTIATION_OF_FOREIGN_OBJ);
             } catch (UnsupportedMessageException e) {
                 throw CompilerDirectives.shouldNotReachHere(e);
             }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/function/BuiltinFunctionBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/function/BuiltinFunctionBuiltins.java
@@ -31,7 +31,7 @@
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___NAME__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___QUALNAME__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___SIGNATURE__;
-import static com.oracle.graal.python.nodes.SpecialAttributeNames.T__SIGNATURE__;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___SIGNATURE__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.J___OBJCLASS__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.J___REDUCE__;
 import static com.oracle.graal.python.nodes.function.BuiltinFunctionRootNode.T_DOLLAR_DECL_TYPE;
@@ -148,7 +148,7 @@ public abstract static class SignatureNode extends PythonUnaryBuiltinNode {
         static Object doIt(PBuiltinFunction fun,
                         @Bind("this") Node inliningTarget) {
             if (fun.getSignature().isHidden()) {
-                throw PRaiseNode.raiseStatic(inliningTarget, AttributeError, ErrorMessages.HAS_NO_ATTR, fun, T__SIGNATURE__);
+                throw PRaiseNode.raiseStatic(inliningTarget, AttributeError, ErrorMessages.HAS_NO_ATTR, fun, T___SIGNATURE__);
             }
             return createInspectSignature(fun.getSignature(), false);
         }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/method/BuiltinFunctionOrMethodBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/objects/method/BuiltinFunctionOrMethodBuiltins.java
@@ -42,7 +42,7 @@
 
 import static com.oracle.graal.python.builtins.PythonBuiltinClassType.AttributeError;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.J___SIGNATURE__;
-import static com.oracle.graal.python.nodes.SpecialAttributeNames.T__SIGNATURE__;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___SIGNATURE__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___NAME__;
 import static com.oracle.graal.python.nodes.SpecialMethodNames.J___REPR__;
 
@@ -152,7 +152,7 @@ public Object doIt(Object fun,
                         @Bind("this") Node inliningTarget) {
             Signature signature = GetSignatureNode.executeUncached(fun);
             if (signature.isHidden()) {
-                throw PRaiseNode.raiseStatic(inliningTarget, AttributeError, ErrorMessages.HAS_NO_ATTR, fun, T__SIGNATURE__);
+                throw PRaiseNode.raiseStatic(inliningTarget, AttributeError, ErrorMessages.HAS_NO_ATTR, fun, T___SIGNATURE__);
             }
             return BuiltinFunctionBuiltins.SignatureNode.createInspectSignature(signature, true);
         }
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/BuiltinNames.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/BuiltinNames.java
@@ -1,5 +1,5 @@
 /*
- * 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
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/SpecialAttributeNames.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/SpecialAttributeNames.java
@@ -1,5 +1,5 @@
 /*
- * 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
@@ -120,7 +120,7 @@ public abstract class SpecialAttributeNames {
     public static final TruffleString T___TEXT_SIGNATURE__ = tsLiteral(J___TEXT_SIGNATURE__);
 
     public static final String J___SIGNATURE__ = "__signature__";
-    public static final TruffleString T__SIGNATURE__ = tsLiteral(J___SIGNATURE__);
+    public static final TruffleString T___SIGNATURE__ = tsLiteral(J___SIGNATURE__);
 
     public static final String J___TRACEBACK__ = "__traceback__";
     public static final TruffleString T___TRACEBACK__ = tsLiteral(J___TRACEBACK__);
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/SpecialMethodNames.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/SpecialMethodNames.java
@@ -1,5 +1,5 @@
 /*
- * 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
diff --git a/graalpython/lib-graalpython/patches/jq-1.8.0.patch b/graalpython/lib-graalpython/patches/jq-1.8.0.patch
diff --git a/graalpython/lib-graalpython/patches/metadata.toml b/graalpython/lib-graalpython/patches/metadata.toml
diff --git a/graalpython/lib-graalpython/patches/pandas-2.2.3.patch b/graalpython/lib-graalpython/patches/pandas-2.2.3.patch
diff --git a/graalpython/lib-python/3/inspect.py b/graalpython/lib-python/3/inspect.py

Original file line number	Diff line number	Diff line change
`@@ -1895,7 +1895,7 @@ static PythonNativeWrapper doGeneric(Node inliningTarget, long pointer, boolean`
`1895`	`1895`	`IdReference<?> lookup = nativeLookupGet(nativeContext, pointer);`
`1896`	`1896`	`if (isNativeProfile.profile(inliningTarget, lookup != null)) {`
`1897`	`1897`	`Object ref = lookup.get();`
`1898`		`- if (ref == null) {`
	`1898`	`+ if (strict && ref == null) {`
`1899`	`1899`	`CompilerDirectives.transferToInterpreterAndInvalidate();`
`1900`	`1900`	`throw CompilerDirectives.shouldNotReachHere("reference was collected: " + Long.toHexString(pointer));`
`1901`	`1901`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.`
	`2`	`+ * Copyright (c) 2018, 2025, Oracle and/or its affiliates. All rights reserved.`
`3`	`3`	`* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.`
`4`	`4`	`*`
`5`	`5`	`* The Universal Permissive License (UPL), Version 1.0`