Implement PyModule_GetFilenameObject

msimacek · msimacek · commit ab81526eb266 · 2025-03-31T11:53:22.000+02:00
Fixes #488
diff --git a/graalpython/com.oracle.graal.python.cext/src/moduleobject.c b/graalpython/com.oracle.graal.python.cext/src/moduleobject.c
@@ -574,6 +574,7 @@ PyModule_GetFilenameObject(PyObject *m)
     Py_INCREF(fileobj);
     return fileobj;
 }
+#endif // GraalPy change
 
 const char *
 PyModule_GetFilename(PyObject *m)
@@ -587,7 +588,6 @@ PyModule_GetFilename(PyObject *m)
     Py_DECREF(fileobj);   /* module dict has still a reference */
     return utf8;
 }
-#endif // GraalPy change
 
 PyModuleDef*
 PyModule_GetDef(PyObject* m)
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_module.py b/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_module.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2021, 2024, 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
@@ -54,6 +54,22 @@ def _reference_add_object(args):
     args[0].__dict__[args[1]] = args[2]
     return 0
 
+
+def _reference_get_filename(args):
+    if not isinstance(args[0], ModuleType):
+        raise TypeError
+    file = getattr(args[0], '__file__', None)
+    if isinstance(file, str):
+        return file
+    raise SystemError
+
+
+module_with_file = ModuleType("module")
+module_with_file.__file__ = 'file.py'
+module_with_broken_file = ModuleType("module")
+module_with_broken_file.__file__ = 1
+
+
 class TestPyModule(CPyExtTestCase):
 
     test_PyModule_Check = CPyExtFunction(
@@ -175,3 +191,31 @@ class TestPyModule(CPyExtTestCase):
         arguments=["PyObject* m", "const char* k", "PyObject* v"],
         cmpfunc=unhandled_error_compare
     )
+
+    test_PyModule_GetFilenameObject = CPyExtFunction(
+        _reference_get_filename,
+        lambda: (
+            (module_with_file,),
+            (module_with_broken_file,),
+            (ModuleType("no-file"),),
+            (1,),
+        ),
+        resultspec="O",
+        argspec='O',
+        arguments=["PyObject* m"],
+        cmpfunc=unhandled_error_compare
+    )
+
+    test_PyModule_GetFilename = CPyExtFunction(
+        _reference_get_filename,
+        lambda: (
+            (module_with_file,),
+            (module_with_broken_file,),
+            (ModuleType("no-file"),),
+            (1,),
+        ),
+        resultspec="s",
+        argspec='O',
+        arguments=["PyObject* m"],
+        cmpfunc=unhandled_error_compare
+    )
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextModuleBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/cext/PythonCextModuleBuiltins.java
@@ -53,6 +53,7 @@
 import static com.oracle.graal.python.builtins.objects.cext.capi.transitions.ArgDescriptor.PyObjectTransfer;
 import static com.oracle.graal.python.nodes.ErrorMessages.S_NEEDS_S_AS_FIRST_ARG;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___DOC__;
+import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___FILE__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___NAME__;
 import static com.oracle.graal.python.nodes.SpecialAttributeNames.T___PACKAGE__;
 import static com.oracle.graal.python.util.PythonUtils.TS_ENCODING;
@@ -65,6 +66,7 @@
 import com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiTernaryBuiltinNode;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextBuiltins.CApiUnaryBuiltinNode;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextMethodBuiltins.CFunctionNewExMethodNode;
+import com.oracle.graal.python.builtins.objects.PNone;
 import com.oracle.graal.python.builtins.objects.cext.capi.ExternalFunctionNodes.CheckPrimitiveFunctionResultNode;
 import com.oracle.graal.python.builtins.objects.cext.capi.ExternalFunctionNodes.ExternalFunctionInvokeNode;
 import com.oracle.graal.python.builtins.objects.cext.capi.ExternalFunctionNodes.PExternalFunctionWrapper;
@@ -94,6 +96,7 @@
 import com.oracle.truffle.api.dsl.Bind;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Cached.Shared;
+import com.oracle.truffle.api.dsl.Fallback;
 import com.oracle.truffle.api.dsl.ImportStatic;
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.interop.InteropLibrary;
@@ -297,4 +300,26 @@ static int doGeneric(PythonModule self, Object visitFun, Object arg,
             return 0;
         }
     }
+
+    @CApiBuiltin(ret = PyObjectTransfer, args = {PyObject}, call = Direct)
+    abstract static class PyModule_GetFilenameObject extends CApiUnaryBuiltinNode {
+        @Specialization
+        static Object getFilename(PythonModule module,
+                        @Bind Node inliningTarget,
+                        @Cached ReadAttributeFromObjectNode read,
+                        @Cached PyUnicodeCheckNode check,
+                        @Cached PRaiseNode raiseNode) {
+            Object file = read.execute(module, T___FILE__);
+            if (file != PNone.NO_VALUE && check.execute(inliningTarget, file)) {
+                return file;
+            }
+            throw raiseNode.raise(inliningTarget, SystemError, ErrorMessages.MODULE_FILENAME_MISSING);
+        }
+
+        @Fallback
+        static Object error(@SuppressWarnings("unused") Object module,
+                        @Bind Node inliningTarget) {
+            throw PRaiseNode.raiseStatic(inliningTarget, TypeError, ErrorMessages.BAD_ARG_TO_INTERNAL_FUNC);
+        }
+    }
 }
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
@@ -350,6 +350,7 @@ public final class CApiFunction {
     @CApiBuiltin(name = "PyModule_ExecDef", ret = Int, args = {PyObject, PyModuleDef}, call = CImpl)
     @CApiBuiltin(name = "PyModule_GetDef", ret = PyModuleDef, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyModule_GetDict", ret = PyObject, args = {PyObject}, call = CImpl)
+    @CApiBuiltin(name = "PyModule_GetFilename", ret = ConstCharPtrAsTruffleString, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyModule_GetName", ret = ConstCharPtrAsTruffleString, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyModule_GetState", ret = Pointer, args = {PyObject}, call = CImpl)
     @CApiBuiltin(name = "PyNumber_Absolute", ret = PyObject, args = {PyObject}, call = CImpl)
@@ -827,8 +828,6 @@ public final class CApiFunction {
     @CApiBuiltin(name = "PyMem_SetupDebugHooks", ret = Void, args = {}, call = NotImplemented)
     @CApiBuiltin(name = "PyMember_GetOne", ret = PyObject, args = {ConstCharPtrAsTruffleString, PyMemberDef}, call = NotImplemented)
     @CApiBuiltin(name = "PyMember_SetOne", ret = Int, args = {CHAR_PTR, PyMemberDef, PyObject}, call = NotImplemented)
-    @CApiBuiltin(name = "PyModule_GetFilename", ret = ConstCharPtrAsTruffleString, args = {PyObject}, call = NotImplemented)
-    @CApiBuiltin(name = "PyModule_GetFilenameObject", ret = PyObject, args = {PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "PyODict_DelItem", ret = Int, args = {PyObject, PyObject}, call = NotImplemented)
     @CApiBuiltin(name = "PyODict_New", ret = PyObject, args = {}, call = NotImplemented)
     @CApiBuiltin(name = "PyODict_SetItem", ret = Int, args = {PyObject, PyObject, PyObject}, call = NotImplemented)
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/ErrorMessages.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/nodes/ErrorMessages.java
@@ -502,6 +502,7 @@ public abstract class ErrorMessages {
     public static final TruffleString MISSING_S = tsLiteral("Missing %s");
     public static final TruffleString S_MISSING_REQUIRED_ARG_POS_D = tsLiteral("%s missing required argument (pos %d)");
     public static final TruffleString MMAP_INDEX_OUT_OF_RANGE = tsLiteral("mmap index out of range");
+    public static final TruffleString MODULE_FILENAME_MISSING = tsLiteral("module filename missing");
     public static final TruffleString MODULE_HAS_NO_ATTR_S = tsLiteral("module has no attribute '%s'");
     public static final TruffleString MODULE_PARTIALLY_INITIALIZED_S_HAS_NO_ATTR_S = tsLiteral("partially initialized module '%s' has no attribute '%s' (most likely due to a circular import)");
     public static final TruffleString MODULE_S_HAS_NO_ATTR_S = tsLiteral("module '%s' has no attribute '%s'");

Original file line number	Diff line number	Diff line change
`@@ -574,6 +574,7 @@ PyModule_GetFilenameObject(PyObject *m)`
`574`	`574`	`Py_INCREF(fileobj);`
`575`	`575`	`return fileobj;`
`576`	`576`	`}`
	`577`	`+#endif // GraalPy change`
`577`	`578`
`578`	`579`	`const char *`
`579`	`580`	`PyModule_GetFilename(PyObject *m)`
`@@ -587,7 +588,6 @@ PyModule_GetFilename(PyObject *m)`
`587`	`588`	`Py_DECREF(fileobj); /* module dict has still a reference */`
`588`	`589`	`return utf8;`
`589`	`590`	`}`
`590`		`-#endif // GraalPy change`
`591`	`591`
`592`	`592`	`PyModuleDef*`
`593`	`593`	`PyModule_GetDef(PyObject* m)`