Merge branch 'python' into development

Author: Bentroen

.gitattributes

@@ -0,0 +1,4 @@
+extensions/pygml/*.dll filter=lfs diff=lfs merge=lfs -text
+extensions/pygml/*.zip filter=lfs diff=lfs merge=lfs -text
+datafiles/ffmpeg.exe filter=lfs diff=lfs merge=lfs -text
+datafiles/ffprobe.exe filter=lfs diff=lfs merge=lfs -text

Minecraft Note Block Studio.yyp

@@ -0,0 +1,2 @@
+.venv/
+Lib/

datafiles/Data/Python/.gitignore

@@ -0,0 +1,23 @@
+{
+  "python.defaultInterpreterPath": "${workspaceFolder}/.venv",
+  "python.formatting.provider": "black",
+  "python.languageServer": "Pylance",
+  "python.linting.enabled": false,
+  "python.linting.pylintEnabled": false,
+  "python.linting.banditEnabled": false,
+  "python.linting.flake8Enabled": false,
+  "python.linting.mypyEnabled": false,
+  "python.linting.prospectorEnabled": false,
+  "python.linting.pycodestyleEnabled": false,
+  "python.linting.pydocstyleEnabled": false,
+  "python.linting.pylamaEnabled": false,
+  "[python]": {
+    "editor.tabSize": 4,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": false,
+    "editor.formatOnPaste": false,
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": true
+    }
+  }
+}

datafiles/Data/Python/.vscode/settings.json

@@ -0,0 +1,28 @@
+# Python extensions for Open Note Block Studio
+
+This is a subproject of Open Note Block Studio, which holds the Python modules used for various export functions, as well as scripts for managing dependencies and packaging.
+
+## Building
+
+1. Make sure to install [Git LFS](https://git-lfs.github.com/) before cloning the project and/or contributing.
+
+2. Make sure to install the **exact** Python version that `GMPython` was compiled with. This is currently 3.8.10 (32-bit). ([download](https://www.python.org/downloads/release/python-3810/))
+
+3. This subproject uses [poetry](https://python-poetry.org/) for managing dependencies. Make sure to install it, and run the following command with the subproject's root (`datafiles/Data/Python`) as your current working directory:
+
+   ```shell
+   $ poetry env use 3.8 # if you have more than one Python version installed
+   $ poetry install --no-dev
+   ```
+
+4. Run `package.py`:
+
+   ```shell
+   $ python package.py
+   ```
+
+   This will delete the virtual environment created on the last step, and prepare all dependencies to be packaged with Note Block Studio's executable.
+
+5. Open the project in GameMaker, and save it so the included files are registered. **Do NOT commit the changes to the project file.**
+
+6. You can now build the project in GameMaker!

datafiles/Data/Python/README.md

@@ -0,0 +1,25 @@
+import subprocess
+
+
+def patch_arguments(function, **patched_kwargs):
+    def decorate_name(*args, **kwargs):
+        kwargs.update(patched_kwargs)
+        return function(*args, **kwargs)
+
+    return decorate_name
+
+
+def main(*args, **kwargs):
+
+    # Monkey-patch to avoid ffmpeg/ffprobe calls opening console window
+    subprocess.Popen = patch_arguments(
+        subprocess.Popen, creationflags=subprocess.CREATE_NO_WINDOW
+    )
+
+    import nbswave
+
+    nbswave.render_audio(*args, **kwargs)
+
+
+if __name__ == "__main__":
+    main()

datafiles/Data/Python/audio_export.py

@@ -0,0 +1,127 @@
+import compileall
+import os
+import shutil
+import sys
+import zipfile
+from pathlib import Path
+
+
+PYTHON_VERSION = "3.8.10"
+
+
+DO_NOT_ADD = [
+    "__pycache__",
+    "_distutils_hack",
+    "pip",
+    "pkg_resources",
+    "setuptools",
+    "wheel",
+    "_virtualenv.py",
+]
+
+BLACKLIST = ["numpy"]  # Special case - can't be loaded from ZIP
+
+DO_NOT_ADD.extend(BLACKLIST)
+
+
+ENV_PATH = Path(".venv")
+LIB_PATH = Path(ENV_PATH, "Lib", "site-packages")
+
+OUT_PATH = Path("Lib", "site-packages")
+ZIP_PATH = Path("Lib", "site-packages.zip")
+REL_PATH = Path("Data", "Python", OUT_PATH)
+
+
+def pack_filter(path):
+    fn = os.path.basename(path)
+    return not (fn in DO_NOT_ADD or ".dist-info" in fn)
+
+
+copy_filter = shutil.ignore_patterns("__pycache__")
+
+
+def main():
+
+    # Check if the Python version is correct
+    py_version = ".".join(str(s) for s in sys.version_info[:3])
+    if py_version != PYTHON_VERSION:
+        raise RuntimeError(
+            f"This script must be run in Python {PYTHON_VERSION} "
+            f"(you're running {py_version})"
+        )
+
+    # Check the script is being run from the right subdirectory
+    cwd = Path.cwd()
+    if not cwd.parts[-3:] == ("datafiles", "Data", "Python"):
+        raise RuntimeWarning(
+            "This script must be run from the datafiles/Data/Python "
+            "subfolder in the Open Note Block Studio root directory."
+        )
+
+    if not os.path.exists(ENV_PATH):
+        raise FileNotFoundError(
+            "The .venv directory was not found. Have you ran"
+            "poetry install before running this script?"
+        )
+
+    # Delete previous build directory
+    if Path.exists(OUT_PATH):
+        print("Removing output directory")
+        shutil.rmtree(OUT_PATH)
+
+    # Create output directory
+    os.makedirs(OUT_PATH)
+
+    # Package dependencies
+    package_count = 0
+    with zipfile.PyZipFile(ZIP_PATH, mode="w") as zip_file:
+        for path in os.listdir(LIB_PATH):
+            lib_name = os.path.basename(path)
+            lib_path = Path(LIB_PATH, lib_name)
+
+            # Pre-compile all modules without absolute paths
+            path_prefix = REL_PATH
+            if os.path.isdir(lib_path):
+                compileall.compile_dir(
+                    lib_path, ddir=path_prefix, force=True, quiet=2, legacy=True
+                )
+            else:
+                compileall.compile_file(
+                    str(lib_path), ddir=path_prefix, force=True, quiet=2, legacy=True
+                )
+
+            # Write to ZIP
+            try:
+                zip_file.writepy(lib_path, filterfunc=pack_filter)
+            except RuntimeError:  # only directories or .py files accepted
+                continue
+            else:
+                if pack_filter(lib_path):
+                    print(f"Packaging {lib_name}")
+                    package_count += 1
+
+    # Handle special cases
+    for lib_name in BLACKLIST:
+        print(f"Packaging {lib_name}")
+        package_count += 1
+        inpath = Path(LIB_PATH, lib_name)
+        outpath = Path(OUT_PATH, lib_name)
+        shutil.copytree(inpath, outpath, ignore=copy_filter)
+        compileall.compile_dir(
+            outpath, ddir=REL_PATH, force=True, quiet=True, legacy=True
+        )
+        # Remove corresponding .py files
+        for root, _, files in os.walk(outpath):
+            for filename in files:
+                if filename.endswith(".py"):
+                    os.remove(os.path.join(root, filename))
+
+    # Delete virtual environment
+    print("Removing virtual environment")
+    shutil.rmtree(ENV_PATH)
+
+    print(f"Done! {package_count} packages were added.")
+
+
+if __name__ == "__main__":
+    main()