sonolus.py 0.12.1__tar.gz → 0.12.2__tar.gz

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sonolus.py
-Version: 0.12.1
+Version: 0.12.2
 Summary: Sonolus engine development in Python
 Project-URL: Documentation, https://sonolus.py.qwewqa.xyz/
 Project-URL: Repository, https://github.com/qwewqa/sonolus.py

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/docs/changelog/index.md

@@ -1,3 +1,11 @@
+### 0.12.2
+
+- Incorrectly declared resources such as Buckets missing an [`@buckets`][sonolus.script.bucket.buckets] decorator now 
+  result in a helpful error message
+- [`Record`][sonolus.script.record.Record] classes can now subclass `ABC` or `Protocol` from the Python standard
+  library
+- Archetypes can now subclass `ABC` or `Protocol` from the Python standard library
+
 ### 0.12.1
 
 - Added support for the `getattr()`, `setattr()`, `hasattr()`, and `sum()` built-in functions

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/pyproject.toml

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

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/sonolus/script/engine.py

@@ -155,6 +155,36 @@ def default_callback() -> Any:
     return 0.0
 
 
+def check_skin(skin: Any):
+    if not hasattr(skin, "_sprites_"):
+        raise ValueError(f"Invalid skin: {skin}. Missing an @skin decorator?")
+
+
+def check_effects(effects: Any):
+    if not hasattr(effects, "_effects_"):
+        raise ValueError(f"Invalid effects: {effects}. Missing an @effects decorator?")
+
+
+def check_particles(particles: Any):
+    if not hasattr(particles, "_particles_"):
+        raise ValueError(f"Invalid particles: {particles}. Missing an @particles decorator?")
+
+
+def check_buckets(buckets: Any):
+    if not hasattr(buckets, "_buckets_"):
+        raise ValueError(f"Invalid buckets: {buckets}. Missing an @buckets decorator?")
+
+
+def check_instructions(instructions: Any):
+    if not hasattr(instructions, "_instructions_"):
+        raise ValueError(f"Invalid instructions: {instructions}. Missing an @instructions decorator?")
+
+
+def check_instruction_icons(instruction_icons: Any):
+    if not hasattr(instruction_icons, "_instruction_icons_"):
+        raise ValueError(f"Invalid instruction icons: {instruction_icons}. Missing an @instruction_icons decorator?")
+
+
 class PlayMode:
     """A play mode definition.
 
@@ -185,6 +215,11 @@ class PlayMode:
             if not issubclass(archetype, PlayArchetype):
                 raise ValueError(f"archetype {archetype} is not a PlayArchetype")
 
+        check_skin(skin)
+        check_effects(effects)
+        check_particles(particles)
+        check_buckets(buckets)
+
 
 class WatchMode:
     """A watch mode definition.
@@ -219,6 +254,11 @@ class WatchMode:
             if not issubclass(archetype, WatchArchetype):
                 raise ValueError(f"archetype {archetype} is not a WatchArchetype")
 
+        check_skin(skin)
+        check_effects(effects)
+        check_particles(particles)
+        check_buckets(buckets)
+
 
 class PreviewMode:
     """A preview mode definition.
@@ -241,6 +281,8 @@ class PreviewMode:
             if not issubclass(archetype, PreviewArchetype):
                 raise ValueError(f"archetype {archetype} is not a PreviewArchetype")
 
+        check_skin(skin)
+
 
 class TutorialMode:
     """A tutorial mode definition.
@@ -277,6 +319,12 @@ class TutorialMode:
         self.navigate = navigate
         self.update = update
 
+        check_skin(skin)
+        check_effects(effects)
+        check_particles(particles)
+        check_instructions(instructions)
+        check_instruction_icons(instruction_icons)
+
 
 def empty_play_mode() -> PlayMode:
     """Create an empty play mode."""

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/sonolus/script/internal/introspection.py

@@ -1,4 +1,5 @@
 import inspect
+from abc import ABC
 from collections.abc import Sequence
 from typing import Annotated
 
@@ -33,6 +34,7 @@ def get_field_specifiers(
             and not callable(value)
             and not hasattr(value, "__func__")
             and not isinstance(value, property)
+            and not (issubclass(cls, ABC) and (hasattr(ABC, key)))
         ):
             raise ValueError(f"Missing annotation for {cls.__name__}.{key}")
     for skipped_key in skip:

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/sonolus/script/record.py

@@ -4,7 +4,7 @@ import inspect
 from abc import ABCMeta
 from collections.abc import Iterable
 from inspect import getmro
-from typing import Any, ClassVar, Self, TypeVar, dataclass_transform, get_origin
+from typing import Any, ClassVar, Protocol, Self, TypeVar, dataclass_transform, get_origin
 
 from sonolus.backend.place import BlockPlace
 from sonolus.script.internal.context import ctx
@@ -21,7 +21,8 @@ from sonolus.script.internal.value import BackingSource, DataValue, Value
 from sonolus.script.num import Num
 
 
-class RecordMeta(ABCMeta):
+# Protocol metaclass is a subclass of ABCMeta, but let's make ABCMeta explicit for clarity
+class RecordMeta(type(Protocol), ABCMeta):
     @meta_fn
     def __pos__[T](cls: type[T]) -> T:
         """Create a zero-initialized record instance."""

{sonolus_py-0.12.1 → sonolus_py-0.12.2}/uv.lock

@@ -727,7 +727,7 @@ wheels = [
 
 [[package]]
 name = "sonolus-py"
-version = "0.12.1"
+version = "0.12.2"
 source = { editable = "." }
 
 [package.dev-dependencies]