Rename pythonscript -> gdpy

Author: touilleMan

README.rst

@@ -241,7 +241,7 @@ Check Travis or Appveyor links above to see the current status of your platform.
 This command will checkout CPython repo, move to a pinned commit and build
 CPython from source.
 
-It will then generate ``pythonscript/godot/bindings.pyx`` (Godot api bindings)
+It will then generate ``gdpy/godot/bindings.pyx`` (Godot api bindings)
 from GDNative's ``api.json`` and compile it.
 This part is long and really memory demanding so be patient ;-)
 When hacking godot-python you can heavily speedup this step by passing
@@ -305,7 +305,7 @@ First, export the project in .zip format.
 
 Second, extract the .zip in a directory. For sake of example let's say the directory is called :code:`godotpythonproject`.
 
-Third, copy the correct Python environment into this folder (if it hasn't been automatically included in the export). Inside your project folder, you will need to find :code:`/addons/pythonscript/x11-64`, replacing "x11-64" with the correct target system you are deploying to. Copy the entire folder for your system, placing it at the same relative position, e.g. :code:`godotpythonproject/addons/pythonscript/x11-64` if your unzipped directory was "godotpythonproject". Legally speaking you should also copy LICENSE.txt from the pythonscript folder. (The lazy option at this point is to simply copy the entire addons folder from your project to your unzipped directory.)
+Third, copy the correct Python environment into this folder (if it hasn't been automatically included in the export). Inside your project folder, you will need to find :code:`/addons/gdpy/x11-64`, replacing "x11-64" with the correct target system you are deploying to. Copy the entire folder for your system, placing it at the same relative position, e.g. :code:`godotpythonproject/addons/gdpy/x11-64` if your unzipped directory was "godotpythonproject". Legally speaking you should also copy LICENSE.txt from the gdpy folder. (The lazy option at this point is to simply copy the entire addons folder from your project to your unzipped directory.)
 
 Fourth, place a godot release into the directory. The Godot export menu has probably downloaded an appropriate release already, or you can go to Editor -> Manage Export Templates inside Godot to download fresh ones. These are stored in a location which depends on your operating system. For example, on Windows they may be found at :code:`%APPDATA%\Godot\templates\ `; in Linux or OSX it is :code:`~/.godot/templates/`. Copy the file matching your export. (It may matter whether you selected "Export With Debug" when creating the .zip file; choose the debug or release version accordingly.)
 
@@ -317,17 +317,17 @@ See also `this issue <https://github.com/touilleMan/godot-python/issues/146>`_.
 
 In essence, godot-python installs a python interpreter inside your project which can then be distributed as part of the final game. Python packages you want to use need to be installed for that interpreter and of course included in the final release. This can be accomplished by using pip to install packages; however, pip is not provided, so it must be installed too.
 
-First, locate the correct python interpreter. This will be inside your project at :code:`addons\pythonscript\windows-64\python.exe` for 64-bit Windows, :code:`addons/pythonscript/ox-64/bin/python3` for OSX, etc. Then install pip by running:
+First, locate the correct python interpreter. This will be inside your project at :code:`addons\gdpy\windows-64\python.exe` for 64-bit Windows, :code:`addons/gdpy/ox-64/bin/python3` for OSX, etc. Then install pip by running:
 
 .. code-block::
 
-	addons\pythonscript\windows-64\python.exe -m ensurepip
+	addons\gdpy\windows-64\python.exe -m ensurepip
 
 (substituting the correct python for your system). Any other method of installing pip at this location is fine too, and this only needs to be done once. Afterward, any desired packages can be installed by running
 
 .. code-block::
 
-	addons\pythonscript\windows-64\python.exe -m pip install numpy
+	addons\gdpy\windows-64\python.exe -m pip install numpy
 
 again, substituting the correct python executable, and replacing numpy with whatever packages you desire. The package can now be imported in your Python code as normal.
 
@@ -348,7 +348,7 @@ In your :code:`project.godot` file, add the following section::
 In addition to the usual::
 
   [gdnative]
-  singletons=[ "res://pythonscript.gdnlib" ]
+  singletons=[ "res://gdpy.gdnlib" ]
 
 You can use any name for the python file and the class name
 :code:`autoloadpy`.

examples/pong/project.godot

@@ -28,11 +28,11 @@ stretch_2d=true
 
 [editor_plugins]
 
-enabled=PackedStringArray("pythonscript_repl")
+enabled=PackedStringArray("gdpy_repl")
 
 [gdnative]
 
-singletons=["res://pythonscript.gdnlib"]
+singletons=["res://gdpy.gdnlib"]
 
 [input]
 

libgodot/copy_data.py

@@ -17,13 +17,12 @@ def copy_data(build_dir: Path) -> None:
     output_godot_hazmat_dir.mkdir(parents=True, exist_ok=True)
 
     shutil.copy(ROOT_DIR / "src/_gdpy_libgodot.pyx", TARGET_DIR)
-    shutil.copy(build_dir / "src/pythonscript_gdextension_ptrs.c", TARGET_DIR)
+    shutil.copy(build_dir / "src/gdpy_gdextension_ptrs.c", TARGET_DIR)
 
     shutil.copytree(build_dir / "gdextension_api", TARGET_DIR / "gdextension_api")
 
     src_godot_dir = ROOT_DIR / "src/godot"
     shutil.copy(src_godot_dir / "__init__.py", output_godot_dir)
-    shutil.copy(src_godot_dir / "__init__.pyi", output_godot_dir)
     shutil.copy(src_godot_dir / "_lang.pyx", output_godot_dir)
     shutil.copy(src_godot_dir / "_lang_resource_format_loader.pxi", output_godot_dir)
     shutil.copy(src_godot_dir / "_lang_resource_format_saver.pxi", output_godot_dir)

meson.build

@@ -163,9 +163,9 @@ if host_platform.startswith('linux')
         ),
         include_directories: [join_paths(python_prebuild_name, 'python/install/include/python@0@.@1@'.format(cpython_distrib_version_major, cpython_distrib_version_minor))],
     )
-    # e.g. addons/pythonscript/linux-x86_64/lib/python3.9/site-packages
+    # e.g. addons/gdpy/linux-x86_64/lib/python3.9/site-packages
     python_site_packages_install_path = join_paths(
-        'addons/pythonscript',
+        'addons/gdpy',
         host_platform,
         'lib/python@0@.@1@/site-packages'.format(cpython_distrib_version_major, cpython_distrib_version_minor)
     )
@@ -178,9 +178,9 @@ elif host_platform.startswith('macos')
         ),
         include_directories: [join_paths(python_prebuild_name, 'python/install/include/python@0@.@1@'.format(cpython_distrib_version_major, cpython_distrib_version_minor))],
     )
-    # e.g. addons/pythonscript/linux-x86_64/lib/python3.9/site-packages
+    # e.g. addons/gdpy/linux-x86_64/lib/python3.9/site-packages
     python_site_packages_install_path = join_paths(
-        'addons/pythonscript',
+        'addons/gdpy',
         host_platform,
         'lib/python@0@.@1@/site-packages'.format(cpython_distrib_version_major, cpython_distrib_version_minor)
     )
@@ -195,9 +195,9 @@ elif host_platform.startswith('windows')
         ),
         include_directories: [join_paths(python_prebuild_name, 'python/install/include')],
     )
-    # e.g. addons/pythonscript/windows-x86_64/Lib/site-packages
+    # e.g. addons/gdpy/windows-x86_64/Lib/site-packages
     python_site_packages_install_path = join_paths(
-        'addons/pythonscript',
+        'addons/gdpy',
         host_platform,
         'Lib/site-packages'
     )
@@ -208,7 +208,7 @@ endif
 
 install_subdir(
     python_distrib_path,
-    install_dir: join_paths('addons/pythonscript', host_platform),
+    install_dir: join_paths('addons/gdpy', host_platform),
     strip_directory: true,
 )
 if build_machine.system() == 'linux'
@@ -248,7 +248,7 @@ if build_machine.system() == 'linux'
         )
         install_symlink(
             symlink_name,
-            install_dir: join_paths('addons/pythonscript', host_platform, parent_dir),
+            install_dir: join_paths('addons/gdpy', host_platform, parent_dir),
             pointing_to: target_name,
         )
     endforeach
@@ -376,7 +376,7 @@ README.txt
 
 install_data(
     'LICENSE.txt',
-    install_dir: 'addons/pythonscript',
+    install_dir: 'addons/gdpy',
 )
 
 
@@ -390,7 +390,7 @@ custom_target(
     ],
     output: ['.gdignore'],
     install: true,
-    install_dir: 'addons/pythonscript',
+    install_dir: 'addons/gdpy',
 )
 
 
@@ -415,9 +415,9 @@ open("@OUTPUT0@", mode="w", encoding="utf8").write(out)
 
 
 install_data(
-    'misc/release_pythonscript.gdextension',
+    'misc/release_gdpy.gdextension',
     install_dir: '.',
-    rename: 'pythonscript.gdextension',
+    rename: 'gdpy.gdextension',
 )
 
 

misc/release_README.txt

@@ -36,14 +36,14 @@ Pip must be installed first with `ensurepip`:
 
 On Windows:
 ```
-$ <pythonscript_dir>/windows-64/python.exe -m ensurepip  # Only need to do that once
-$ <pythonscript_dir>/windows-64/python.exe -m pip install whatever
+$ <godot_python_dir>/windows-64/python.exe -m ensurepip  # Only need to do that once
+$ <godot_python_dir>/windows-64/python.exe -m pip install whatever
 ```
 
 On Linux/macOS:
 ```
-$ <pythonscript_dir>/x11-64/bin/python3 -m ensurepip  # Only need to do that once
-$ <pythonscript_dir>/x11-64/bin/python3 -m pip install whatever
+$ <godot_python_dir>/x11-64/bin/python3 -m ensurepip  # Only need to do that once
+$ <godot_python_dir>/x11-64/bin/python3 -m pip install whatever
 ```
 
 Note you must use `python -m pip` to invoke pip (using the command `pip`

misc/release_gdpy.gdextension

@@ -0,0 +1,12 @@
+[configuration]
+
+entry_symbol = "gdpy_init"
+compatibility_minimum = "4.1"
+
+[libraries]
+
+linux.64="res://addons/gdpy/linux-x86_64/libgdpy.so"
+linux.32="res://addons/gdpy/linux-x86/libgdpy.so"
+windows.64="res://addons/gdpy/windows-x86_64/gdpy.dll"
+windows.32="res://addons/gdpy/windows-x86/gdpy.dll"
+macos.64="res://addons/gdpy/macos-x86_64/libgdpy.dylib"

misc/release_pythonscript.gdextension

@@ -13,9 +13,6 @@
 import argparse
 import tarfile
 from datetime import datetime
-import os
-import shutil
-from urllib.request import urlretrieve
 from zipfile import ZipFile
 from concurrent.futures import ThreadPoolExecutor
 
@@ -61,24 +58,20 @@ def pipeline_executor(dirs, release_info, platform_name):
         with urlopen(platform_info["url"]) as f:
             release_archive.write_bytes(f.read())
 
-    if not (dirs["pythonscript"] / platform_name).exists():
+    if not (dirs["gdpy"] / platform_name).exists():
         print(f"{platform_name} - Extracting release")
         if platform_info["name"].endswith(".zip"):
             zipobj = ZipFile(release_archive)
             # Only extract platform-specific stuff
             members = (
-                x
-                for x in zipobj.namelist()
-                if x.startswith(f"addons/pythonscript/{platform_name}/")
+                x for x in zipobj.namelist() if x.startswith(f"addons/gdpy/{platform_name}/")
             )
             zipobj.extractall(path=dirs["dist"], members=members)
 
         elif platform_info["name"].endswith(".tar.bz2"):
             tarobj = tarfile.open(release_archive)
             # Only extract platform-specific stuff
-            members = (
-                x for x in tarobj if x.name.startswith(f"./addons/pythonscript/{platform_name}/")
-            )
+            members = (x for x in tarobj if x.name.startswith(f"./addons/gdpy/{platform_name}/"))
             tarobj.extractall(path=dirs["dist"], members=members)
 
         else:
@@ -96,13 +89,11 @@ def orchestrator(dirs, release_info):
 
     print("Add bonuses...")
 
-    (dirs["pythonscript"] / ".gdignore").touch()
+    (dirs["gdpy"] / ".gdignore").touch()
     license_txt = (MISC_DIR / "release_LICENSE.txt").read_text()
-    for entry in ["dist", "pythonscript"]:
+    for entry in ["dist", "gdpy"]:
         (dirs[entry] / "LICENSE.txt").write_text(license_txt)
-    (dirs["dist"] / "pythonscript.gdnlib").write_text(
-        (MISC_DIR / "release_pythonscript.gdnlib").read_text()
-    )
+    (dirs["dist"] / "gdpy.gdnlib").write_text((MISC_DIR / "release_gdpy.gdnlib").read_text())
     (dirs["dist"] / "README.txt").write_text(
         (MISC_DIR / "release_README.txt")
         .read_text()
@@ -118,21 +109,21 @@ def main():
     release_info = get_release_info(args.version)
     print(f"Release version: {release_info['version']}")
 
-    build_dir = Path(f"pythonscript-assetlib-release-{release_info['version']}").resolve()
-    dist_dir = build_dir / f"pythonscript-{release_info['version']}"
+    build_dir = Path(f"gdpy-assetlib-release-{release_info['version']}").resolve()
+    dist_dir = build_dir / f"gdpy-{release_info['version']}"
     addons_dir = dist_dir / "addons"
-    pythonscript_dir = addons_dir / "pythonscript"
+    gdpy_dir = addons_dir / "gdpy"
 
     build_dir.mkdir(exist_ok=True)
     dist_dir.mkdir(exist_ok=True)
     addons_dir.mkdir(exist_ok=True)
-    pythonscript_dir.mkdir(exist_ok=True)
+    gdpy_dir.mkdir(exist_ok=True)
 
     dirs = {
         "build": build_dir,
         "dist": dist_dir,
         "addons": addons_dir,
-        "pythonscript": pythonscript_dir,
+        "gdpy": gdpy_dir,
     }
     orchestrator(dirs, release_info)
 

scripts/assetlib_release.py

@@ -13,7 +13,7 @@
 GODOT_DIR = SRC_DIR / "godot"
 HAZMAT_DIR = GODOT_DIR / "hazmat"
 TARGETS: dict[str, tuple[bool, Path]] = {
-    "pythonscript_gdextension_ptrs.c": (False, SRC_DIR),
+    "gdpy_gdextension_ptrs.c": (False, SRC_DIR),
     "gdptrs.pxd": (False, HAZMAT_DIR),
     "gdtypes.pxd": (False, HAZMAT_DIR),
     "gdapi.pxd": (False, HAZMAT_DIR),

scripts/generate_tmpl.py

@@ -76,7 +76,7 @@ cdef GDExtensionObjectPtr _create_godot_instance(argv: list[str]):
         return libgodot_create_godot_instance(
             len(argv),
             c_argv,
-            _pythonscript_init,
+            _gdpy_init,
             NULL
         )
 
@@ -89,35 +89,35 @@ cdef GDExtensionObjectPtr _create_godot_instance(argv: list[str]):
 #
 
 
-# Those symbols are defined in `pythonscript_gdextension_ptrs.c` which is
+# Those symbols are defined in `gdpy_gdextension_ptrs.c` which is
 # going to be compiled together with this file into a single shared library.
 cdef extern from *:
     """
-    void init_pythonscript_gdextension();
+    void init_gdpy_gdextension();
     """
 
-    const GDExtensionInterfaceGetProcAddress pythonscript_gdptr_get_proc_address
-    const GDExtensionClassLibraryPtr pythonscript_gdptr_library
-    void init_pythonscript_gdextension()
+    const GDExtensionInterfaceGetProcAddress gdpy_gdptr_get_proc_address
+    const GDExtensionClassLibraryPtr gdpy_gdptr_library
+    void init_gdpy_gdextension()
 
 
-cdef GDExtensionBool _pythonscript_init(
+cdef GDExtensionBool _gdpy_init(
     GDExtensionInterfaceGetProcAddress p_get_proc_address,
     GDExtensionClassLibraryPtr p_library,
     GDExtensionInitialization *r_initialization
 ) noexcept with gil:
-    print('[libgodot] pythonscript_init()', flush=True)
+    print('[libgodot] gdpy_init()', flush=True)
 
-    # `pythonscript_gdptr_*` must be set as early as possible given it is never
+    # `gdpy_gdptr_*` must be set as early as possible given it is never
     # null-pointer checked, especially in the Cython modules.
     # Note we start by setting only `get_proc_address`&`library` since it is the
     # minimum we need to check Godot compatibility, and only after that we proceed
     # with the rest of the pointers.
-    pythonscript_gdptr_get_proc_address = p_get_proc_address
-    pythonscript_gdptr_library = p_library
+    gdpy_gdptr_get_proc_address = p_get_proc_address
+    gdpy_gdptr_library = p_library
 
-    # Initialize the rest of the `pythonscript_gdptr_*` pointers
-    init_pythonscript_gdextension()
+    # Initialize the rest of the `gdpy_gdptr_*` pointers
+    init_gdpy_gdextension()
 
     # Initialize as early as possible, this way we can have 3rd party plugins written
     # in Python/Cython that can do things at this level
@@ -131,13 +131,13 @@ cdef void _initialize(void *userdata, GDExtensionInitializationLevel p_level) no
     print(f'[libgodot] _initialize({p_level})', flush=True)
 
     import godot._lang
-    pythonscript_initialize = <void (*)(int)><size_t>godot._lang.pythonscript_initialize_function_ptr
-    pythonscript_initialize(p_level);
+    gdpy_initialize = <void (*)(int)><size_t>godot._lang.gdpy_initialize_function_ptr
+    gdpy_initialize(p_level);
 
 
 cdef void _deinitialize(void *userdata, GDExtensionInitializationLevel p_level) noexcept with gil:
     print(f'[libgodot] _deinitialize({p_level})', flush=True)
 
     import godot._lang
-    pythonscript_deinitialize = <void (*)(int)><size_t>godot._lang.pythonscript_deinitialize_function_ptr
-    pythonscript_deinitialize(p_level);
+    gdpy_deinitialize = <void (*)(int)><size_t>godot._lang.gdpy_deinitialize_function_ptr
+    gdpy_deinitialize(p_level);