[GR-63688][GR-63689] Add sys.graalpy_version_info

msimacek · msimacek · commit eedf8f0bd9e8 · 2025-04-02T08:16:22.000Z
PullRequest: graalpython/3742
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ This changelog summarizes major changes between GraalVM versions of the Python
 language runtime. The main focus is on user-observable behavior of the engine.
 
 ## Version 25.0.0
+* `sys.implementation.version` now returns the GraalPy version instead of the Python version it implements. Also available as `sys.graalpy_version_info` for better discoverability by people already familiar with PyPy and its `sys.pypy_version_info`.
+* `GRAALPY_VERSION_NUM` C macro now inlcudes the release level and serial number at the end to conform to the `hexversion` format. This shouldn't break any existing comparisons.
 * `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.
 
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_misc.py b/graalpython/com.oracle.graal.python.test/src/tests/cpyext/test_misc.py
@@ -359,14 +359,12 @@ def test_graalpy_version():
         {"get_version_num", (PyCFunction)get_version_num, METH_NOARGS | METH_STATIC, ""}
         ''',
     )
-    expected_version = __graalpython__.get_graalvm_version().removesuffix('-dev')
-    assert tester.get_version_str() == expected_version
-    parts = [int(v) for v in expected_version.split('.')] + [0]
-    expected_num = 0
-    for i in range(3):
-        expected_num <<= 8
-        expected_num |= parts[i]
-    assert tester.get_version_num() == expected_num
+    version = sys.implementation.version
+    assert tester.get_version_str() == f'{version.major}.{version.minor}.{version.micro}'
+    assert tester.get_version_num() == sys.implementation.hexversion
+    # This is an anti-backport trap. The commit that changed the hexversion format should not be backported because
+    # existing projects might already contain tests for the next feature release in the old format (pybind11 does)
+    assert version.major >= 25
 
 
 def test_unicode_docstring():
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/PythonOS.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/PythonOS.java
@@ -1,5 +1,5 @@
 /*
- * 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
@@ -45,25 +45,31 @@
 import com.oracle.truffle.api.strings.TruffleString;
 
 public enum PythonOS {
-    PLATFORM_JAVA("java"),
-    PLATFORM_CYGWIN("cygwin"),
-    PLATFORM_LINUX("linux"),
-    PLATFORM_DARWIN("darwin"),
-    PLATFORM_WIN32("win32"),
-    PLATFORM_SUNOS("sunos"),
-    PLATFORM_FREEBSD("freebsd"),
-    PLATFORM_ANY(null);
+    PLATFORM_JAVA("java", "Java"),
+    PLATFORM_CYGWIN("cygwin", "CYGWIN"),
+    PLATFORM_LINUX("linux", "Linux"),
+    PLATFORM_DARWIN("darwin", "Darwin"),
+    PLATFORM_WIN32("win32", "Windows"),
+    PLATFORM_SUNOS("sunos", "SunOS"),
+    PLATFORM_FREEBSD("freebsd", "FreeBSD"),
+    PLATFORM_ANY(null, null);
 
     private final TruffleString name;
+    private final TruffleString uname;
 
-    PythonOS(String name) {
+    PythonOS(String name, String uname) {
         this.name = toTruffleStringUncached(name);
+        this.uname = toTruffleStringUncached(uname);
     }
 
     public TruffleString getName() {
         return name;
     }
 
+    public TruffleString getUname() {
+        return uname;
+    }
+
     private static final PythonOS current;
 
     static {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/SysModuleBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/SysModuleBuiltins.java
@@ -41,6 +41,8 @@
 package com.oracle.graal.python.builtins.modules;
 
 import static com.oracle.graal.python.PythonLanguage.J_GRAALPYTHON_ID;
+import static com.oracle.graal.python.PythonLanguage.RELEASE_LEVEL;
+import static com.oracle.graal.python.PythonLanguage.RELEASE_SERIAL;
 import static com.oracle.graal.python.PythonLanguage.T_GRAALPYTHON_ID;
 import static com.oracle.graal.python.builtins.PythonBuiltinClassType.AttributeError;
 import static com.oracle.graal.python.builtins.PythonBuiltinClassType.DeprecationWarning;
@@ -506,16 +508,16 @@ protected List<? extends NodeFactory<? extends PythonBuiltinBaseNode>> getNodeFa
         return SysModuleBuiltinsFactory.getFactories();
     }
 
-    private static PSimpleNamespace makeImplementation(PythonLanguage language, PTuple versionInfo, TruffleString gmultiarch) {
+    private static PSimpleNamespace makeImplementation(PythonLanguage language, PTuple graalpyVersionInfo, TruffleString gmultiarch) {
         final PSimpleNamespace ns = PFactory.createSimpleNamespace(language);
         ns.setAttribute(tsLiteral("name"), T_GRAALPYTHON_ID);
         /*- 'cache_tag' must match the format of mx.graalpython/mx_graalpython.py:graalpy_ext */
         ns.setAttribute(T_CACHE_TAG, toTruffleStringUncached(J_GRAALPYTHON_ID +
                         PythonLanguage.GRAALVM_MAJOR + PythonLanguage.GRAALVM_MINOR + PythonLanguage.DEV_TAG +
                         "-" + PythonLanguage.MAJOR + PythonLanguage.MINOR));
-        ns.setAttribute(T_VERSION, versionInfo);
+        ns.setAttribute(T_VERSION, graalpyVersionInfo);
         ns.setAttribute(T__MULTIARCH, gmultiarch);
-        ns.setAttribute(tsLiteral("hexversion"), PythonLanguage.VERSION_HEX);
+        ns.setAttribute(tsLiteral("hexversion"), PythonLanguage.GRAALVM_MAJOR << 24 | PythonLanguage.GRAALVM_MINOR << 16 | PythonLanguage.GRAALVM_MICRO << 8 | RELEASE_LEVEL << 4 | RELEASE_SERIAL);
         return ns;
     }
 
@@ -588,7 +590,10 @@ public void initialize(Python3Core core) {
         addBuiltinConstant(T_STDOUT, PNone.NONE);
         addBuiltinConstant(T_STDERR, PNone.NONE);
 
-        addBuiltinConstant("implementation", makeImplementation(language, versionInfo, gmultiarch));
+        PTuple graalpyVersion = PFactory.createStructSeq(language, VERSION_INFO_DESC, PythonLanguage.GRAALVM_MAJOR, PythonLanguage.GRAALVM_MINOR, PythonLanguage.GRAALVM_MICRO,
+                        PythonLanguage.RELEASE_LEVEL_STRING, PythonLanguage.RELEASE_SERIAL);
+        addBuiltinConstant("graalpy_version_info", graalpyVersion);
+        addBuiltinConstant("implementation", makeImplementation(language, graalpyVersion, gmultiarch));
         addBuiltinConstant("hexversion", PythonLanguage.VERSION_HEX);
 
         if (os == PLATFORM_WIN32) {
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
@@ -504,6 +504,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'");
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java
@@ -210,7 +210,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Level;
 
-import com.oracle.truffle.api.TruffleOptions;
 import org.graalvm.nativeimage.ImageInfo;
 import org.graalvm.nativeimage.ProcessProperties;
 import org.graalvm.polyglot.io.ProcessHandler.Redirect;
@@ -252,6 +251,7 @@
 import com.oracle.truffle.api.TruffleLanguage;
 import com.oracle.truffle.api.TruffleLanguage.Env;
 import com.oracle.truffle.api.TruffleLogger;
+import com.oracle.truffle.api.TruffleOptions;
 import com.oracle.truffle.api.TruffleSafepoint;
 import com.oracle.truffle.api.dsl.Bind;
 import com.oracle.truffle.api.dsl.Cached;
@@ -1290,7 +1290,7 @@ private static int posixPermissionsToMode(int inputMode, final Set<PosixFilePerm
     @SuppressWarnings("static-method")
     public Object[] uname(
                     @Shared("js2ts") @Cached TruffleString.FromJavaStringNode fromJavaStringNode) {
-        return new Object[]{getPythonOS().getName(), fromJavaStringNode.execute(getHostName(withoutIOSocket), TS_ENCODING),
+        return new Object[]{getPythonOS().getUname(), fromJavaStringNode.execute(getHostName(withoutIOSocket), TS_ENCODING),
                         fromJavaStringNode.execute(getOsVersion(), TS_ENCODING), T_EMPTY_STRING, PythonUtils.getPythonArch()};
     }
 
diff --git a/mx.graalpython/mx_graalpython.py b/mx.graalpython/mx_graalpython.py
@@ -1861,6 +1861,8 @@ def graal_version_short(variant=None, **kwargs):
         for i in range(3):
             num <<= 8
             num |= int(parts[i]) if i < len(parts) else 0
+        num <<= 8
+        num |= release_level('int') << 4
         return hex(num)
     else:
         return '.'.join(GRAAL_VERSION.split('.')[:3])
@@ -1871,14 +1873,16 @@ def release_level(variant=None):
     level = 'alpha'
     if SUITE.suiteDict['release']:
         level = 'final'
-    if variant == 'binary':
+    if variant in ('binary', 'int'):
         level_num = {
             'alpha': 0xA,
             'beta': 0xB,
             'candidate': 0xC,
             'final': 0xF,
         }[level]
-        return chr(level_num + ord(VERSION_BASE))
+        if variant == 'binary':
+            return chr(level_num + ord(VERSION_BASE))
+        return level_num
     return level
 
 

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)`