add PyOS_FSPath C API

Author: timfel

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

@@ -144,6 +144,7 @@
 #include "pystrtod.h"
 #include "tracemalloc.h"
 #include "genobject.h"
+#include "osmodule.h"
 
 #include "abstract.h"
 

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

@@ -0,0 +1,21 @@
+/* Copyright (c) 2022, Oracle and/or its affiliates.
+ * Copyright (C) 1996-2017 Python Software Foundation
+ *
+ * Licensed under the PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+ */
+/* os module interface */
+
+#ifndef Py_OSMODULE_H
+#define Py_OSMODULE_H
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000
+PyAPI_FUNC(PyObject *) PyOS_FSPath(PyObject *path);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+#endif /* !Py_OSMODULE_H */

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

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2022, 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.
+ */
+#include "capi.h"
+
+UPCALL_ID(PyOS_FSPath);
+PyObject* PyOS_FSPath(PyObject* path) {
+    return UPCALL_CEXT_O(_jls_PyOS_FSPath, native_to_java(path));
+}

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

@@ -38,6 +38,8 @@
 # SOFTWARE.
 
 import sys
+import pathlib
+import os
 from . import CPyExtTestCase, CPyExtFunction, CPyExtFunctionOutVars, unhandled_error_compare, GRAALPYTHON
 import builtins
 __dir__ = __file__.rpartition("/")[0]
@@ -251,7 +253,7 @@ def compile_module(self, name):
             return 0;
         }
         #endif
-        
+
         PyObject* primitive_sharing(PyObject* val) {
             Py_ssize_t val_refcnt = Py_REFCNT(val);
             // assume val's refcnt is X > 0
@@ -319,3 +321,24 @@ def compile_module(self, name):
         callfunction="wrap_PyEval_GetBuiltins",
         cmpfunc=unhandled_error_compare
     )
+
+    test_PyOS_FSPath = CPyExtFunction(
+        lambda args: os.fspath(*args),
+        lambda: (
+            (b"bytespath",),
+            ("stringpath",),
+            (pathlib.Path("pathpath"),),
+            (123,),
+            (object(),),
+        ),
+        callfunction="call_PyOS_FSPath",
+        code="""
+        static PyObject* call_PyOS_FSPath(PyObject* value) {
+            return PyOS_FSPath(value);
+        }
+        """,
+        resultspec="O",
+        argspec="O",
+        arguments=["PyObject* value"],
+        cmpfunc=unhandled_error_compare
+    )

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

@@ -148,6 +148,7 @@
 import com.oracle.graal.python.builtins.modules.cext.PythonCextModuleBuiltins;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextNamespaceBuiltins;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextObjectBuiltins;
+import com.oracle.graal.python.builtins.modules.cext.PythonCextPosixmoduleBuiltins;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextPyLifecycleBuiltins;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextPyStateBuiltins;
 import com.oracle.graal.python.builtins.modules.cext.PythonCextPythonRunBuiltins;
@@ -546,6 +547,7 @@ private static PythonBuiltins[] initializeBuiltins(boolean nativeAccessAllowed)
                         new PythonCextMethodBuiltins(),
                         new PythonCextModuleBuiltins(),
                         new PythonCextObjectBuiltins(),
+                        new PythonCextPosixmoduleBuiltins(),
                         new PythonCextPyLifecycleBuiltins(),
                         new PythonCextPyStateBuiltins(),
                         new PythonCextPythonRunBuiltins(),

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

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2021, 2022, 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.modules.cext;
+
+import java.util.List;
+
+import com.oracle.graal.python.builtins.Builtin;
+import com.oracle.graal.python.builtins.CoreFunctions;
+import com.oracle.graal.python.builtins.Python3Core;
+import com.oracle.graal.python.builtins.PythonBuiltins;
+import com.oracle.graal.python.builtins.objects.cext.capi.CExtNodes.TransformExceptionToNativeNode;
+import com.oracle.graal.python.lib.PyOSFSPathNode;
+import com.oracle.graal.python.nodes.function.PythonBuiltinBaseNode;
+import com.oracle.graal.python.nodes.function.builtins.PythonUnaryBuiltinNode;
+import com.oracle.graal.python.runtime.PythonContext;
+import com.oracle.graal.python.runtime.exception.PException;
+import com.oracle.truffle.api.dsl.Cached;
+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.frame.VirtualFrame;
+
+@CoreFunctions(extendsModule = PythonCextBuiltins.PYTHON_CEXT)
+@GenerateNodeFactory
+public final class PythonCextPosixmoduleBuiltins extends PythonBuiltins {
+
+    @Override
+    protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFactories() {
+        return PythonCextPosixmoduleBuiltinsFactory.getFactories();
+    }
+
+    @Override
+    public void initialize(Python3Core core) {
+        super.initialize(core);
+    }
+
+    @Builtin(name = "PyOS_FSPath", minNumOfPositionalArgs = 1)
+    @GenerateNodeFactory
+    abstract static class PyOS_FSPath extends PythonUnaryBuiltinNode {
+        @Specialization
+        static Object doit(VirtualFrame frame, Object path,
+                        @Cached PyOSFSPathNode fspathNode,
+                        @Cached TransformExceptionToNativeNode transformExceptionToNativeNode) {
+            try {
+                return fspathNode.execute(frame, path);
+            } catch (PException e) {
+                transformExceptionToNativeNode.execute(frame, e);
+                return PythonContext.get(fspathNode).getNativeNull();
+            }
+        }
+    }
+}

mx.graalpython/copyrights/overrides

@@ -118,6 +118,7 @@ graalpython/com.oracle.graal.python.cext/include/cpython/fileobject.h,python.cop
 graalpython/com.oracle.graal.python.cext/include/cpython/initconfig.h,python.copyright
 graalpython/com.oracle.graal.python.cext/include/cpython/object.h,python.copyright
 graalpython/com.oracle.graal.python.cext/include/cpython/objimpl.h,python.copyright
+graalpython/com.oracle.graal.python.cext/include/cpython/osmodule.h,python.copyright
 graalpython/com.oracle.graal.python.cext/include/cpython/pyerrors.h,python.copyright
 graalpython/com.oracle.graal.python.cext/include/cpython/pylifecycle.h,python.copyright
 graalpython/com.oracle.graal.python.cext/include/cpython/pymem.h,python.copyright