Add tests/3-pythonscript-cython-only

Author: touilleMan

tests/3-pythonscript-cython-only/.godot/.gdignore

@@ -0,0 +1 @@
+

tests/3-pythonscript-cython-only/.godot/extension_list.cfg

@@ -0,0 +1 @@
+res://pythonscript.gdextension

tests/3-pythonscript-cython-only/build.py

@@ -0,0 +1,33 @@
+import platform
+from pathlib import Path
+import subprocess
+import shutil
+
+
+PROJECT_DIR = Path(__file__).resolve().parent
+
+
+if platform.system() == "Windows":
+    python_path = PROJECT_DIR / "addons/pythonscript/windows-x86_64/python.exe"
+    lib_pattern = "my.*.pyd"
+elif platform.system() == "Darwin":
+    python_path = PROJECT_DIR / "addons/pythonscript/macos-x86_64/bin/python3"
+    lib_pattern = "my.*.dylib"
+else:
+    assert platform.system() == "Linux"
+    python_path = PROJECT_DIR / "addons/pythonscript/linux-x86_64/bin/python3"
+    lib_pattern = "my.*.so"
+
+cmd = [str(python_path), "setup.py", "build_ext", "--build-lib", str(PROJECT_DIR)]
+print(" ".join(cmd))
+subprocess.check_call(cmd, cwd=PROJECT_DIR)
+
+
+# Finally remove the platform info from the shared library, this is to avoid
+# annoying update everytime we change CPython embedded version.
+lib_candidates = list(PROJECT_DIR.glob(lib_pattern))
+assert len(lib_candidates) == 1, lib_candidates
+lib = lib_candidates[0]
+lib_new_name = f"my{lib.suffix}"
+print(f"rename {lib.name} -> {lib_new_name}")
+shutil.move(lib, lib.parent / lib_new_name)

tests/3-pythonscript-cython-only/main.gd

@@ -0,0 +1,5 @@
+extends Node
+
+func _ready():
+	# Exit godot
+	self.get_tree().quit()

tests/3-pythonscript-cython-only/main.tscn

@@ -0,0 +1,6 @@
+[gd_scene load_steps=2 format=3 uid="uid://2mikyvxkygni"]
+
+[ext_resource type="Script" path="res://main.gd" id="1_2fqr4"]
+
+[node name="Node" type="Node"]
+script = ExtResource( "1_2fqr4" )

tests/3-pythonscript-cython-only/my.pyx

@@ -0,0 +1,52 @@
+# cython: language_level=3
+
+from godot.hazmat.gdapi cimport *
+
+
+def initialize(level):
+    print("MY initialize", level)
+
+
+def deinitialize(level):
+    print("MY deinitialize", level)
+
+
+cdef public void _my_initialize(void *userdata, GDExtensionInitializationLevel p_level) with gil:
+    print("==> _initialize")
+
+
+cdef extern void _my_deinitialize(void *userdata, GDExtensionInitializationLevel p_level) with gil:
+    print("==> _deinitialize")
+
+
+cdef extern GDExtensionBool _my_init(
+    const GDExtensionInterface *p_interface,
+    const GDExtensionClassLibraryPtr p_library,
+    GDExtensionInitialization *r_initialization
+) nogil:
+    # print("==> _my_init")
+    r_initialization.minimum_initialization_level  = GDEXTENSION_INITIALIZATION_SERVERS
+    r_initialization.userdata = NULL
+    #  r_initialization.initialize = _my_initialize
+    #  r_initialization.deinitialize = _my_deinitialize
+    return True
+
+
+cdef extern from * nogil:
+    """
+    #include <godot/gdextension_interface.h>
+    #ifdef _WIN32
+    # define DLL_EXPORT __declspec(dllexport)
+    #else
+    # define DLL_EXPORT
+    #endif
+
+    GDExtensionBool _my_init(const GDExtensionInterface *, const GDExtensionClassLibraryPtr, GDExtensionInitialization *);
+    DLL_EXPORT GDExtensionBool my_init(
+        const GDExtensionInterface *p_interface,
+        const GDExtensionClassLibraryPtr p_library,
+        GDExtensionInitialization *r_initialization
+    ) {
+        return _my_init(p_interface, p_library, r_initialization);
+    }
+    """

tests/3-pythonscript-cython-only/project.godot

@@ -0,0 +1,23 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=5
+
+[application]
+
+run/main_scene="res://main.tscn"
+config/features=PackedStringArray("4.0")
+name="TestProject"
+main_scene="res://main.tscn"
+
+[python_script]
+
+io_streams_capture=false
+verbose=true
+initialize_callback="my:initialize"
+deinitialize_callback="my:deinitialize"

tests/3-pythonscript-cython-only/pythonscript.gdextension

@@ -0,0 +1,11 @@
+[configuration]
+
+entry_symbol = "pythonscript_init"
+
+[libraries]
+
+linux.64="res://addons/pythonscript/linux-x86_64/libpythonscript.so"
+linux.32="res://addons/pythonscript/linux-x86/libpythonscript.so"
+windows.64="res://addons/pythonscript/windows-x86_64/pythonscript.dll"
+windows.32="res://addons/pythonscript/windows-x86/pythonscript.dll"
+macos.64="res://addons/pythonscript/macos-x86_64/libpythonscript.dylib"

tests/3-pythonscript-cython-only/setup.py

@@ -0,0 +1,37 @@
+import platform
+from setuptools import setup
+from Cython.Build import cythonize
+from pathlib import Path
+
+
+# Retrieve `Python.h`'s include dir.
+# In theory setuptools rely on `sysconfig` to find this information, `sysconfig` being
+# generated when Python is installed (typically `make install` after it compilation).
+# However we use python-build-standalone which (as it name imply) provide us with a
+# standalone Python distribution, hence the install step is part of the build process
+# and `sysconfig` provide irrelevant include paths (e.g. on Linux it is done on Docker
+# with install in `/install`)
+# See:
+# - https://github.com/indygreg/python-build-standalone/issues/152
+# - https://gregoryszorc.com/docs/python-build-standalone/main/quirks.html#references-to-build-time-paths
+if platform.system() in ("Linux", "Darwin"):
+    python_include_dir = next(Path(".").parent.glob("addons/pythonscript/*-*/include/python*"))
+elif platform.system() == "Windows":
+    python_include_dir = next(Path(".").parent.glob("addons/pythonscript/*-*/include"))
+else:
+    raise RuntimeError(f"Unsupported platform `{platform.system()}`")
+
+
+# Work around cythonize's `include_path` parameter not configuring the C compiler
+# (see: https://github.com/cython/cython/issues/1480)
+gdextension_api_include_dir = Path("gdextension_api")
+
+
+ext_modules = cythonize("my.pyx")
+ext_modules[0].include_dirs = [
+    python_include_dir,
+    gdextension_api_include_dir,
+]
+setup(
+    ext_modules=ext_modules,
+)