sonolus.py 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

sonolus/script/containers.py

@@ -1,16 +1,33 @@
 from __future__ import annotations
 
 from sonolus.script.array import Array
+from sonolus.script.array_like import ArrayLike
 from sonolus.script.debug import error
-from sonolus.script.iterator import ArrayLike, SonolusIterator
-from sonolus.script.range import Range
+from sonolus.script.iterator import SonolusIterator
 from sonolus.script.record import Record
 from sonolus.script.values import alloc, copy
 
 
 class Pair[T, U](Record):
+    """A generic pair of values.
+
+    Usage:
+        ```python
+        Pair[T, U](first: T, second: U)
+        ```
+
+    Examples:
+        ```python
+        pair = Pair(1, 2)
+        pair = Pair[int, Pair[int, int]](1, Pair(2, 3))
+        ```
+    """
+
     first: T
+    """The first value."""
+
     second: U
+    """The second value."""
 
     def __lt__(self, other):
         if self.first == other.first:
@@ -34,46 +51,100 @@ class Pair[T, U](Record):
 
 
 class VarArray[T, Capacity](Record, ArrayLike[T]):
+    """An array with a variable size and fixed maximum capacity.
+
+    Usage:
+        ```python
+        VarArray[T, Capacity].new()  # Create a new empty array
+        ```
+
+    Examples:
+        ```python
+        array = VarArray[int, 10].new()
+        array.append(1)
+        ```
+    """
+
     _size: int
     _array: Array[T, Capacity]
 
     @classmethod
     def new(cls):
-        element_type = cls._get_type_arg_(T)
-        capacity = cls._get_type_arg_(Capacity)
+        """Create a new empty array."""
+        element_type = cls.type_var_value(T)
+        capacity = cls.type_var_value(Capacity)
         return cls(0, alloc(Array[element_type, capacity]))
 
-    def size(self) -> int:
+    def __len__(self) -> int:
+        """Return the number of elements in the array."""
         return self._size
 
     @classmethod
     def capacity(cls) -> int:
-        return cls._get_type_arg_(Capacity)
+        """Return the maximum number of elements the array can hold."""
+        return cls.type_var_value(Capacity)
 
     def is_full(self) -> bool:
+        """Return whether the array is full."""
         return self._size == self.capacity()
 
     def __getitem__(self, item) -> T:
+        """Return the element at the given index.
+
+        The returned value continues to be part of the array.
+        Future modifications to the array will affect the returned value.
+
+        Note:
+            Future modifications to the array may cause unexpected changes to the returned value.
+            If the array may be modified in the future, it's recommended to make a copy of the value.
+
+            For example:
+            ```python
+            a = VarArray[Pair, 10].new()
+            a.append(Pair(1, 2))
+            a.append(Pair(3, 4))
+            a.append(Pair(5, 6))
+            p = a[1]
+            a.pop(0)  # Elements are shifted back
+            assert p == Pair(5, 6)  # The value of p has changed
+            ```
+        """
         return self._array[item]
 
     def __setitem__(self, key: int, value: T):
+        """Update the element at the given index."""
         self._array[key] = value
 
+    def __delitem__(self, key: int):
+        """Remove the element at the given index."""
+        self.pop(key)
+
     def append(self, value: T):
-        """Appends a copy of the given value to the end of the array."""
-        assert self._size < self._array.size()
+        """Append a copy of the given value to the end of the array.
+
+        Args:
+            value: The value to append.
+        """
+        assert self._size < len(self._array)
         self._array[self._size] = value
         self._size += 1
 
     def extend(self, values: ArrayLike[T]):
-        """Appends copies of the values in the given array to the end of the array."""
+        """Appends copies of the values in the given array to the end of the array.
+
+        Args:
+            values: The values to append.
+        """
         for value in values:
             self.append(value)
 
     def pop(self, index: int | None = None) -> T:
-        """Removes and returns a copy of the value at the given index.
+        """Remove and return a copy of the value at the given index.
 
         Preserves the relative order of the elements.
+
+        Args:
+            index: The index of the value to remove. If None, the last element is removed.
         """
         if index is None:
             index = self._size - 1
@@ -81,35 +152,48 @@ class VarArray[T, Capacity](Record, ArrayLike[T]):
         value = copy(self._array[index])
         self._size -= 1
         if index < self._size:
-            for i in Range(index, self._size):
+            for i in range(index, self._size):
                 self._array[i] = self._array[i + 1]
         return value
 
     def insert(self, index: int, value: T):
-        """Inserts a copy of the given value at the given index.
+        """Insert a copy of the given value at the given index.
 
         Preserves the relative order of the elements.
+
+        Args:
+            index: The index at which to insert the value. Must be in the range [0, size].
+            value: The value to insert.
         """
         assert 0 <= index <= self._size
-        assert self._size < self._array.size()
+        assert self._size < len(self._array)
         self._size += 1
-        for i in Range(self._size - 1, index, -1):
+        for i in range(self._size - 1, index, -1):
             self._array[i] = self._array[i - 1]
         self._array[index] = value
 
     def remove(self, value: T) -> bool:
-        """Removes the first occurrence of the given value, returning whether the value was removed.
+        """Remove the first occurrence of the given value, returning whether the value was removed.
 
         Preserves the relative order of the elements.
+
+        Args:
+            value: The value to remove
+
+        Returns:
+            True if the value was removed, False otherwise.
         """
-        index = self.index_of(value)
+        index = self.index(value)
         if index < 0:
             return False
         self.pop(index)
         return True
 
     def clear(self):
-        """Sets size to zero."""
+        """Clear the array, removing all elements.
+
+        References to elements are not immediately changed, but future insertions may overwrite them.
+        """
         self._size = 0
 
     def set_add(self, value: T) -> bool:
@@ -117,8 +201,14 @@ class VarArray[T, Capacity](Record, ArrayLike[T]):
 
         If the value is already present, the array is not modified.
         If the array is full, the value is not added.
+
+        Args:
+            value: The value to add
+
+        Returns:
+            True if the value was added, False otherwise.
         """
-        if self._size >= self._array.size():
+        if self._size >= len(self._array):
             return False
         if value in self:
             return False
@@ -129,8 +219,14 @@ class VarArray[T, Capacity](Record, ArrayLike[T]):
         """Removes the first occurrence of the given value, returning whether the value was removed.
 
         Does not preserve the relative order of the elements.
+
+        Args:
+            value: The value to remove
+
+        Returns:
+            True if the value was removed, False otherwise.
         """
-        index = self.index_of(value)
+        index = self.index(value)
         if index < 0:
             return False
         if index < self._size - 1:
@@ -138,11 +234,18 @@ class VarArray[T, Capacity](Record, ArrayLike[T]):
         self._size -= 1
         return True
 
+    def __iadd__(self, other):
+        """Appends copies of the values in the given array to the end of the array."""
+        self.extend(other)
+        return self
+
     def __eq__(self, other):
-        if self.size() != other.size():
+        if not isinstance(other, ArrayLike):
+            return False
+        if len(self) != len(other):
             return False
         i = 0
-        while i < self.size():
+        while i < len(self):
             if self[i] != other[i]:
                 return False
             i += 1
@@ -155,69 +258,144 @@ class VarArray[T, Capacity](Record, ArrayLike[T]):
         raise TypeError("unhashable type: 'VarArray'")
 
 
-class ArrayMapEntry[K, V](Record):
+class _ArrayMapEntry[K, V](Record):
     key: K
     value: V
 
 
 class ArrayMap[K, V, Capacity](Record):
+    """A map implemented as an array of key-value pairs with a fixed maximum capacity.
+
+    Usage:
+        ```python
+        ArrayMap[K, V, Capacity].new()  # Create a new empty map
+        ```
+
+    Examples:
+        ```python
+        map = ArrayMap[int, int, 10].new()
+        map[1] = 2
+        map[3] = 4
+        assert 1 in map
+        assert 2 not in map
+        assert map[3] == 4
+        ```
+    """
+
     _size: int
-    _array: Array[ArrayMapEntry[K, V], Capacity]
+    _array: Array[_ArrayMapEntry[K, V], Capacity]
 
     @classmethod
     def new(cls):
-        key_type = cls._get_type_arg_(K)
-        value_type = cls._get_type_arg_(V)
-        capacity = cls._get_type_arg_(Capacity)
-        return cls(0, alloc(Array[ArrayMapEntry[key_type, value_type], capacity]))
-
-    def size(self) -> int:
+        """Create a new empty map."""
+        key_type = cls.type_var_value(K)
+        value_type = cls.type_var_value(V)
+        capacity = cls.type_var_value(Capacity)
+        return cls(0, alloc(Array[_ArrayMapEntry[key_type, value_type], capacity]))
+
+    def __len__(self) -> int:
+        """Return the number of key-value pairs in the map."""
         return self._size
 
     @classmethod
     def capacity(cls) -> int:
-        return cls._get_type_arg_(Capacity)
+        """Return the maximum number of key-value pairs the map can hold."""
+        return cls.type_var_value(Capacity)
 
     def is_full(self) -> bool:
+        """Return whether the map is full."""
         return self._size == self.capacity()
 
     def keys(self) -> SonolusIterator[K]:
+        """Return an iterator over the keys in the map."""
         return _ArrayMapKeyIterator(self, 0)
 
     def values(self) -> SonolusIterator[V]:
-        return ArrayMapValueIterator(self, 0)
+        """Return an iterator over the values in the map."""
+        return _ArrayMapValueIterator(self, 0)
 
     def items(self) -> SonolusIterator[tuple[K, V]]:
-        return ArrayMapEntryIterator(self, 0)
+        """Return an iterator over the key-value pairs in the map."""
+        return _ArrayMapEntryIterator(self, 0)
 
     def __iter__(self):
+        """Return an iterator over the keys in the map."""
         return self.keys()
 
     def __getitem__(self, key: K) -> V:
-        for i in Range(self._size):
+        """Return the value associated with the given key.
+
+        Must be called with a key that is present in the map.
+
+        The returned value continues to be part of the map.
+        Future modifications to the map will affect the returned value.
+
+        Notes:
+            Future modifications to the map may cause unexpected changes to the returned value.
+            If the map may be modified in the future, it's recommended to make a copy of the value.
+
+            For example:
+            ```python
+            map = ArrayMap[int, Pair[int, int], 10].new()
+            map[1] = Pair(2, 3)
+            map[3] = Pair(4, 5)
+            map[5] = Pair(6, 7)
+            p = map[3]
+            map.pop(1)
+            # The value of `p` may now be different
+            ```
+        """
+        for i in range(self._size):
             entry = self._array[i]
             if entry.key == key:
                 return entry.value
         error()
 
     def __setitem__(self, key: K, value: V):
-        for i in Range(self._size):
+        """Associate the given key with the given value.
+
+        If the key is already present in the map, the value is updated.
+        Must not be called if the map is full.
+
+        Args:
+            key: The key to associate with the value.
+            value: The value to associate with the key
+        """
+        for i in range(self._size):
             entry = self._array[i]
             if entry.key == key:
                 entry.value = value
                 return
-        # assert self._size < self.capacity()
-        self._array[self._size] = ArrayMapEntry(key, value)
+        assert self._size < self.capacity()
+        self._array[self._size] = _ArrayMapEntry(key, value)
         self._size += 1
 
     def __contains__(self, key: K) -> bool:
-        for i in Range(self._size):  # noqa: SIM110
+        """Return whether the given key is present in the map.
+
+        Args:
+            key: The key to check for
+
+        Returns:
+            True if the key is present, False otherwise.
+        """
+        for i in range(self._size):  # noqa: SIM110
             if self._array[i].key == key:
                 return True
         return False
 
     def pop(self, key: K) -> V:
-        for i in Range(self._size):
+        """Remove and return a copy of the value associated with the given key.
+
+        Must be called with a key that is present in the map.
+
+        Args:
+            key: The key to remove
+
+        Returns:
+            The value associated with the key
+        """
+        for i in range(self._size):
             entry = self._array[i]
             if entry.key == key:
                 value = copy(entry.value)
@@ -228,6 +406,7 @@ class ArrayMap[K, V, Capacity](Record):
         error()
 
     def clear(self):
+        """Clear the map, removing all key-value pairs."""
         self._size = 0
 
 
@@ -236,35 +415,39 @@ class _ArrayMapKeyIterator[K, V, Capacity](Record, SonolusIterator):
     _index: int
 
     def has_next(self) -> bool:
-        return self._index < self._map.size()
+        return self._index < len(self._map)
+
+    def get(self) -> K:
+        return self._map._array[self._index].key
 
-    def next(self) -> K:
-        key = self._map._array[self._index].key
+    def advance(self):
         self._index += 1
-        return key
 
 
-class ArrayMapValueIterator[K, V, Capacity](Record, SonolusIterator):
+class _ArrayMapValueIterator[K, V, Capacity](Record, SonolusIterator):
     _map: ArrayMap[K, V, Capacity]
     _index: int
 
     def has_next(self) -> bool:
-        return self._index < self._map.size()
+        return self._index < len(self._map)
 
-    def next(self) -> V:
-        value = self._map._array[self._index].value
+    def get(self) -> V:
+        return self._map._array[self._index].value
+
+    def advance(self):
         self._index += 1
-        return value
 
 
-class ArrayMapEntryIterator[K, V, Capacity](Record, SonolusIterator):
+class _ArrayMapEntryIterator[K, V, Capacity](Record, SonolusIterator):
     _map: ArrayMap[K, V, Capacity]
     _index: int
 
     def has_next(self) -> bool:
-        return self._index < self._map.size()
+        return self._index < len(self._map)
 
-    def next(self) -> tuple[K, V]:
+    def get(self) -> tuple[K, V]:
         entry = self._map._array[self._index]
-        self._index += 1
         return entry.key, entry.value
+
+    def advance(self):
+        self._index += 1

sonolus/script/debug.py

@@ -2,24 +2,22 @@ from collections.abc import Callable
 from contextvars import ContextVar
 from typing import Any, Never
 
-from sonolus.backend.flow import cfg_to_mermaid
 from sonolus.backend.mode import Mode
 from sonolus.backend.ops import Op
-from sonolus.backend.passes import CompilerPass, run_passes
-from sonolus.backend.simplify import CoalesceFlow
-from sonolus.script.comptime import Comptime
+from sonolus.backend.optimize.flow import cfg_to_mermaid
+from sonolus.backend.optimize.passes import CompilerPass, run_passes
+from sonolus.backend.optimize.simplify import CoalesceFlow
 from sonolus.script.internal.context import GlobalContextState, ctx, set_ctx
 from sonolus.script.internal.impl import meta_fn, validate_value
 from sonolus.script.internal.native import native_function
 from sonolus.script.num import Num
-from sonolus.script.values import with_default
 
 debug_log_callback = ContextVar[Callable[[Num], None]]("debug_log_callback")
 
 
 @meta_fn
 def error(message: str | None = None) -> None:
-    message = Comptime._accept_(message)._as_py_() if message is not None else "Error"
+    message = message._as_py_() if message is not None else "Error"
     if not isinstance(message, str):
         raise ValueError("Expected a string")
     if ctx():
@@ -32,6 +30,7 @@ def error(message: str | None = None) -> None:
 
 @meta_fn
 def debug_log(value: Num):
+    """Log a value in debug mode."""
     if debug_log_callback.get(None):
         return debug_log_callback.get()(value)
     else:
@@ -46,17 +45,18 @@ def _debug_log(value: Num):
 
 @native_function(Op.DebugPause)
 def debug_pause():
+    """Pause the game if in debug mode."""
     input("[DEBUG] Paused")
 
 
 def assert_true(value: Num, message: str | None = None):
-    message = with_default(message, "Assertion failed")
+    message = message if message is not None else "Assertion failed"
     if not value:
         error(message)
 
 
 def assert_false(value: Num, message: str | None = None):
-    message = with_default(message, "Assertion failed")
+    message = message if message is not None else "Assertion failed"
     if value:
         error(message)