sonolus.py 0.1.5__tar.gz → 0.1.6__tar.gz

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sonolus.py
-Version: 0.1.5
+Version: 0.1.6
 Summary: Sonolus engine development in Python
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/docs/concepts/cli.md

@@ -14,3 +14,15 @@ To build the project, run the following command in the root directory of your pr
 ```bash
 sonolus-py build
 ```
+
+## Outputting the level schema
+To output the level schema of the project, run the following command in the root directory of your project:
+
+```bash
+sonolus-py schema
+```
+
+## Programmatic usage
+The same functionality can be accessed programmatically as methods of a project.
+
+See [Project][sonolus.script.project.Project] for more information.

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sonolus.py"
-version = "0.1.5"
+version = "0.1.6"
 description = "Sonolus engine development in Python"
 readme = "README.md"
 requires-python = ">=3.13"

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/sonolus/build/cli.py

@@ -2,6 +2,7 @@ import argparse
 import contextlib
 import http.server
 import importlib
+import json
 import shutil
 import socket
 import socketserver
@@ -11,7 +12,7 @@ from time import perf_counter
 
 from sonolus.build.engine import package_engine
 from sonolus.build.level import package_level_data
-from sonolus.build.project import build_project_to_collection
+from sonolus.build.project import build_project_to_collection, get_project_schema
 from sonolus.script.project import Project
 
 
@@ -147,6 +148,14 @@ def main():
     dev_parser.add_argument("--build-dir", type=str, default="./build")
     dev_parser.add_argument("--port", type=int, default=8000)
 
+    schema_parser = subparsers.add_parser("schema")
+    schema_parser.add_argument(
+        "module",
+        type=str,
+        nargs="?",
+        help="Module path (e.g., 'module.name'). If omitted, will auto-detect if only one module exists.",
+    )
+
     args = parser.parse_args()
 
     if not args.module:
@@ -161,16 +170,18 @@ def main():
     if project is None:
         sys.exit(1)
 
-    build_dir = Path(args.build_dir)
-
     if args.command == "build":
+        build_dir = Path(args.build_dir)
         start_time = perf_counter()
         build_project(project, build_dir)
         end_time = perf_counter()
         print(f"Project built successfully to '{build_dir.resolve()}' in {end_time - start_time:.2f}s")
     elif args.command == "dev":
+        build_dir = Path(args.build_dir)
         start_time = perf_counter()
         build_collection(project, build_dir)
         end_time = perf_counter()
         print(f"Build finished in {end_time - start_time:.2f}s")
         run_server(build_dir / "site", port=args.port)
+    elif args.command == "schema":
+        print(json.dumps(get_project_schema(project), indent=2))

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/sonolus/build/project.py

@@ -5,7 +5,7 @@ from sonolus.build.engine import package_engine
 from sonolus.build.level import package_level_data
 from sonolus.script.engine import Engine
 from sonolus.script.level import Level
-from sonolus.script.project import Project
+from sonolus.script.project import Project, ProjectSchema
 
 BLANK_PNG = (
     b"\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x01\x00\x00\x00\x01\x01\x00\x00\x00\x007n\xf9$"
@@ -92,3 +92,32 @@ def load_resources_files_to_collection(base_path: Path) -> Collection:
         collection.load_from_scp(path)
     collection.load_from_source(base_path)
     return collection
+
+
+def get_project_schema(project: Project) -> ProjectSchema:
+    by_archetype: dict[str, dict[str, bool]] = {}
+    for archetype in project.engine.data.play.archetypes:
+        fields = by_archetype.setdefault(archetype.name, {})
+        # If a field is exported, we should exclude it if it's imported in watch mode
+        for field in archetype._exported_keys_:
+            fields[field] = False
+        for field in archetype._imported_keys_:
+            fields[field] = True
+    for archetype in project.engine.data.watch.archetypes:
+        fields = by_archetype.setdefault(archetype.name, {})
+        for field in archetype._imported_keys_:
+            if field not in fields:
+                fields[field] = True
+    for archetype in project.engine.data.preview.archetypes:
+        fields = by_archetype.setdefault(archetype.name, {})
+        for field in archetype._imported_keys_:
+            fields[field] = True
+    return {
+        "archetypes": [
+            {
+                "name": name,
+                "fields": [*fields],
+            }
+            for name, fields in by_archetype.items()
+        ]
+    }

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/sonolus/script/archetype.py

@@ -5,7 +5,7 @@ from collections.abc import Callable
 from dataclasses import dataclass
 from enum import Enum, StrEnum
 from types import FunctionType
-from typing import Annotated, Any, ClassVar, Self, get_origin
+from typing import Annotated, Any, ClassVar, Self, TypedDict, get_origin
 
 from sonolus.backend.ir import IRConst, IRInstr
 from sonolus.backend.mode import Mode
@@ -307,6 +307,11 @@ class _ArchetypeLevelData:
 type _ArchetypeData = _ArchetypeSelfData | _ArchetypeReferenceData | _ArchetypeLevelData
 
 
+class ArchetypeSchema(TypedDict):
+    name: str
+    fields: list[str]
+
+
 class _BaseArchetype:
     _is_comptime_value_ = True
 
@@ -401,6 +406,10 @@ class _BaseArchetype:
             data.extend(field.type._accept_(bound.arguments[field.name] or zeros(field.type))._to_list_())
         native_call(Op.Spawn, archetype_id, *(Num(x) for x in data))
 
+    @classmethod
+    def schema(cls) -> ArchetypeSchema:
+        return {"name": cls.name or "unnamed", "fields": list(cls._imported_fields_)}
+
     def _level_data_entries(self, level_refs: dict[Any, int] | None = None):
         if not isinstance(self._data_, _ArchetypeLevelData):
             raise RuntimeError("Entity is not level data")

sonolus_py-0.1.6/sonolus/script/project.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from os import PathLike
+from pathlib import Path
+from typing import Self, TypedDict
+
+from sonolus.script.archetype import ArchetypeSchema
+from sonolus.script.engine import Engine
+from sonolus.script.level import Level
+
+
+class Project:
+    """A Sonolus.py project.
+
+    Args:
+        engine: The engine of the project.
+        levels: The levels of the project.
+        resources: The path to the resources of the project.
+    """
+
+    def __init__(
+        self,
+        engine: Engine,
+        levels: list[Level] | None = None,
+        resources: PathLike | None = None,
+    ):
+        self.engine = engine
+        self.levels = levels or []
+        self.resources = Path(resources or "resources")
+
+    def with_levels(self, levels: list[Level]) -> Self:
+        """Create a new project with the specified levels.
+
+        Args:
+            levels: The levels of the project.
+
+        Returns:
+            The new project.
+        """
+        return Project(self.engine, levels, self.resources)
+
+    def dev(self, build_dir: PathLike, port: int = 8080):
+        """Start a development server for the project.
+
+        Args:
+            build_dir: The path to the build directory.
+            port: The port of the development server.
+        """
+        from sonolus.build.cli import build_collection, run_server
+
+        build_collection(self, Path(build_dir))
+        run_server(Path(build_dir) / "site", port=port)
+
+    def build(self, build_dir: PathLike):
+        """Build the project.
+
+        Args:
+            build_dir: The path to the build directory.
+        """
+        from sonolus.build.cli import build_project
+
+        build_project(self, Path(build_dir))
+
+    def schema(self) -> ProjectSchema:
+        """Generate the schema of the project.
+
+        Returns:
+            The schema of the project.
+        """
+        from sonolus.build.project import get_project_schema
+
+        return get_project_schema(self)
+
+
+class ProjectSchema(TypedDict):
+    archetypes: list[ArchetypeSchema]

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/sonolus/script/sprite.py

@@ -353,9 +353,7 @@ class StandardSprite:
     SIMULTANEOUS_CONNECTION_PURPLE = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_PURPLE")]
     SIMULTANEOUS_CONNECTION_CYAN = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_CYAN")]
 
-    SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS = Annotated[
-        Sprite, sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS")
-    ]
+    SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_NEUTRAL_SEAMLESS")]
     SIMULTANEOUS_CONNECTION_RED_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_RED_SEAMLESS")]
     SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_GREEN_SEAMLESS")]
     SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS = Annotated[Sprite, sprite("#SIMULTANEOUS_CONNECTION_BLUE_SEAMLESS")]

{sonolus_py-0.1.5 → sonolus_py-0.1.6}/uv.lock

@@ -628,7 +628,7 @@ wheels = [
 
 [[package]]
 name = "sonolus-py"
-version = "0.1.5"
+version = "0.1.6"
 source = { editable = "." }
 
 [package.dev-dependencies]

sonolus_py-0.1.5/sonolus/script/project.py

@@ -1,25 +0,0 @@
-from os import PathLike
-from pathlib import Path
-
-from sonolus.script.engine import Engine
-from sonolus.script.level import Level
-
-
-class Project:
-    """A Sonolus.py project.
-
-    Args:
-        engine: The engine of the project.
-        levels: The levels of the project.
-        resources: The path to the resources of the project.
-    """
-
-    def __init__(
-        self,
-        engine: Engine,
-        levels: list[Level] | None = None,
-        resources: PathLike | None = None,
-    ):
-        self.engine = engine
-        self.levels = levels or []
-        self.resources = Path(resources or "resources")