ez-a-sync 0.32.29__cp310-cp310-win32.whl

a_sync/primitives/locks/counter.pxd

@@ -0,0 +1,12 @@
+
+from a_sync.primitives._debug cimport _DebugDaemonMixin
+from a_sync.primitives.locks.event cimport CythonEvent as Event
+
+cdef class CounterLock(_DebugDaemonMixin):
+    cdef char* __name
+    cdef long long _value
+    cdef list _heap
+    cdef dict[long long, Event] _events
+    cpdef bint is_ready(self, long long v)
+    cdef inline bint c_is_ready(self, long long v)
+    cpdef void set(self, long long value)

a_sync/primitives/locks/counter.pyi

@@ -0,0 +1,151 @@
+from _typeshed import Incomplete
+from a_sync.primitives._debug import _DebugDaemonMixin
+from a_sync.primitives.locks import Event
+from typing import Iterable, Optional
+
+class CounterLock(_DebugDaemonMixin):
+    """
+    An async primitive that uses an internal counter to manage task synchronization.
+
+    A coroutine can `await counter.wait_for(3)` and it will wait until the internal counter >= 3.
+    If some other task executes `counter.value = 5` or `counter.set(5)`, the first coroutine will proceed as 5 >= 3.
+
+    The internal counter can only be set to a value greater than the current value.
+
+    See Also:
+        :class:`CounterLockCluster` for managing multiple :class:`CounterLock` instances.
+    """
+
+    is_ready: Incomplete
+    def __init__(self, start_value: int = 0, name: Optional[str] = None) -> None:
+        """
+        Initializes the :class:`CounterLock` with a starting value and an optional name.
+
+        Args:
+            start_value: The initial value of the counter.
+            name: An optional name for the counter, used in debug logs.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0, name="example_counter")
+            >>> counter.value
+            0
+        """
+
+    async def wait_for(self, value: int) -> bool:
+        """
+        Waits until the counter reaches or exceeds the specified value.
+
+        This method will ensure the debug daemon is running if the counter is not ready.
+
+        Args:
+            value: The value to wait for.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> await counter.wait_for(5)  # This will block until counter.value >= 5
+
+        See Also:
+            :meth:`CounterLock.set` to set the counter value.
+        """
+
+    def set(self, value: int) -> None:
+        """
+        Sets the counter to the specified value.
+
+        This method internally uses the `value` property to enforce that the new value must be strictly greater than the current value.
+
+        Args:
+            value: The value to set the counter to. Must be strictly greater than the current value.
+
+        Raises:
+            ValueError: If the new value is less than or equal to the current value.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.set(5)
+            >>> counter.value
+            5
+
+        See Also:
+            :meth:`CounterLock.value` for direct value assignment.
+        """
+
+    @property
+    def value(self) -> int:
+        """
+        Gets the current value of the counter.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.value
+            0
+        """
+
+    @value.setter
+    def value(self, value: int) -> None:
+        """
+        Sets the counter to a new value, waking up any waiters if the value increases beyond the value they are awaiting.
+
+        Args:
+            value: The new value of the counter.
+
+        Raises:
+            ValueError: If the new value is less than the current value.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.value = 5
+            >>> counter.value
+            5
+            >>> counter.value = 3
+            Traceback (most recent call last):
+            ...
+            ValueError: You cannot decrease the value.
+        """
+
+    async def _debug_daemon(self) -> None:
+        """
+        Periodically logs debug information about the counter state and waiters.
+
+        This method is used internally to provide debugging information when debug logging is enabled.
+
+        This code will only run if `self.logger.isEnabledFor(logging.DEBUG)` is True. You do not need to include any level checks in your custom implementations.
+        """
+
+class CounterLockCluster:
+    """
+    An asyncio primitive that represents a collection of :class:`CounterLock` objects.
+
+    `wait_for(i)` will wait until the value of all :class:`CounterLock` objects is >= i.
+
+    See Also:
+        :class:`CounterLock` for managing individual counters.
+    """
+
+    locks: Incomplete
+    def __init__(self, counter_locks: Iterable[CounterLock]) -> None:
+        """
+        Initializes the :class:`CounterLockCluster` with a collection of :class:`CounterLock` objects.
+
+        Args:
+            counter_locks: The :class:`CounterLock` objects to manage.
+
+        Examples:
+            >>> lock1 = CounterLock(start_value=0)
+            >>> lock2 = CounterLock(start_value=0)
+            >>> cluster = CounterLockCluster([lock1, lock2])
+        """
+
+    async def wait_for(self, value: int) -> bool:
+        """
+        Waits until the value of all :class:`CounterLock` objects in the cluster reaches or exceeds the specified value.
+
+        Args:
+            value: The value to wait for.
+
+        Examples:
+            >>> lock1 = CounterLock(start_value=0)
+            >>> lock2 = CounterLock(start_value=0)
+            >>> cluster = CounterLockCluster([lock1, lock2])
+            >>> await cluster.wait_for(5)  # This will block until all locks have value >= 5
+        """

a_sync/primitives/locks/counter.pyx

@@ -0,0 +1,260 @@
+"""
+This module provides two specialized async flow management classes, :class:`CounterLock` and :class:`CounterLockCluster`.
+
+These primitives manage synchronization of tasks that must wait for an internal counter to reach a specific value.
+"""
+
+from asyncio import sleep
+from heapq import heappop, heappush
+from libc.string cimport strcpy
+from libc.stdlib cimport malloc, free
+from libc.time cimport time
+from typing import Iterable
+
+from a_sync.asyncio cimport cigather
+from a_sync.primitives._debug cimport _DebugDaemonMixin
+from a_sync.primitives.locks.event cimport CythonEvent as Event
+
+cdef extern from "time.h":
+    ctypedef long time_t
+
+
+cdef class CounterLock(_DebugDaemonMixin):
+    """
+    An async primitive that uses an internal counter to manage task synchronization.
+
+    A coroutine can `await counter.wait_for(3)` and it will wait until the internal counter >= 3.
+    If some other task executes `counter.value = 5` or `counter.set(5)`, the first coroutine will proceed as 5 >= 3.
+
+    The internal counter can only be set to a value greater than the current value.
+
+    See Also:
+        :class:`CounterLockCluster` for managing multiple :class:`CounterLock` instances.
+    """
+
+    def __cinit__(self):
+        self._events = {}
+        """A dictionary that maps each awaited value to an :class:`Event` that manages the waiters for that value."""
+
+        self._heap = []
+
+    def __init__(self, start_value: int = 0, str name = ""):
+        """
+        Initializes the :class:`CounterLock` with a starting value and an optional name.
+
+        Args:
+            start_value: The initial value of the counter.
+            name: An optional name for the counter, used in debug logs.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0, name="example_counter")
+            >>> counter.value
+            0
+        """
+        # we need a constant to coerce to char*
+        cdef bytes encoded_name = name.encode("utf-8")
+        cdef Py_ssize_t length = len(encoded_name)
+
+        # Allocate memory for the char* and add 1 for the null character
+        self.__name = <char*>malloc(length + 1)
+        """An optional name for the counter, used in debug logs."""
+
+        if self.__name == NULL:
+            raise MemoryError("Failed to allocate memory for __name.")
+        # Copy the bytes data into the char*
+        strcpy(self.__name, encoded_name)
+
+        self._value = start_value
+        """The current value of the counter."""
+
+    def __dealloc__(self):
+        # Free the memory allocated for __name
+        if self.__name is not NULL:
+            free(self.__name)
+
+    def __repr__(self) -> str:
+        """
+        Returns a string representation of the :class:`CounterLock` instance.
+
+        The representation includes the name, current value, and the number of waiters for each awaited value.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0, name="example_counter")
+            >>> repr(counter)
+            '<CounterLock name=example_counter value=0 waiters={}>'
+        """
+        cdef dict[long long, Event] events = self._events
+        cdef dict[long long, Py_ssize_t] waiters = {v: len((<Event>events[v])._waiters) for v in self._heap}
+        cdef str name = self.__name.decode("utf-8")
+        if name:
+            return "<CounterLock name={} value={} waiters={}>".format(self.__name.decode("utf-8"), self._value, waiters)
+        else:
+            return "<CounterLock value={} waiters={}>".format(self._value, waiters)
+
+    cpdef bint is_ready(self, long long v):
+        """A function that indicates whether the current counter value is greater than or equal to a given value."""
+        return self._value >= v
+    
+    cdef inline bint c_is_ready(self, long long v):
+        return self._value >= v
+
+    async def wait_for(self, long long value) -> bint:
+        """
+        Waits until the counter reaches or exceeds the specified value.
+
+        This method will ensure the debug daemon is running if the counter is not ready.
+
+        Args:
+            value: The value to wait for.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> await counter.wait_for(5)  # This will block until counter.value >= 5
+
+        See Also:
+            :meth:`CounterLock.set` to set the counter value.
+        """
+        cdef Event event
+        if not self.c_is_ready(value):
+            event = self._events.get(value)
+            if event is None:
+                event = Event()
+                self._events[value] = event
+                heappush(self._heap, value)
+            self._c_ensure_debug_daemon((),{})
+            await event.c_wait()
+        return True
+
+    cpdef void set(self, long long value):
+        """
+        Sets the counter to the specified value.
+
+        This method internally uses the `value` property to enforce that the new value must be strictly greater than the current value.
+
+        Args:
+            value: The value to set the counter to. Must be strictly greater than the current value.
+
+        Raises:
+            ValueError: If the new value is less than or equal to the current value.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.set(5)
+            >>> counter.value
+            5
+
+        See Also:
+            :meth:`CounterLock.value` for direct value assignment.
+        """
+        cdef long long key
+        if value > self._value:
+            self._value = value
+            while self._heap:
+                key = heappop(self._heap)
+                if key <= self._value:
+                    (<Event>self._events.pop(key)).set()
+                else:
+                    heappush(self._heap, key)
+                    return
+        elif value < self._value:
+            raise ValueError("You cannot decrease the value.")
+
+    @property
+    def value(self) -> int:
+        """
+        Gets the current value of the counter.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.value
+            0
+        """
+        return self._value
+
+    @value.setter
+    def value(self, long long value) -> None:
+        """
+        Sets the counter to a new value, waking up any waiters if the value increases beyond the value they are awaiting.
+
+        Args:
+            value: The new value of the counter.
+
+        Raises:
+            ValueError: If the new value is less than the current value.
+
+        Examples:
+            >>> counter = CounterLock(start_value=0)
+            >>> counter.value = 5
+            >>> counter.value
+            5
+            >>> counter.value = 3
+            Traceback (most recent call last):
+            ...
+            ValueError: You cannot decrease the value.
+        """
+        self.set(value)
+
+    @property
+    def _name(self) -> str:
+        return self.__name.decode("utf-8")
+
+    async def _debug_daemon(self) -> None:
+        """
+        Periodically logs debug information about the counter state and waiters.
+
+        This method is used internally to provide debugging information when debug logging is enabled.
+
+        This code will only run if `self.logger.isEnabledFor(logging.DEBUG)` is True. You do not need to include any level checks in your custom implementations.
+        """
+        cdef time_t start, now 
+        start = time(NULL)
+        await sleep(300)
+        while self._events:
+            now = time(NULL)
+            self.get_logger().debug(
+                "%s is still locked after %.2fm", self, (now - start) / 60
+            )
+            await sleep(300)
+
+
+class CounterLockCluster:
+    """
+    An asyncio primitive that represents a collection of :class:`CounterLock` objects.
+
+    `wait_for(i)` will wait until the value of all :class:`CounterLock` objects is >= i.
+
+    See Also:
+        :class:`CounterLock` for managing individual counters.
+    """
+
+    __slots__ = ("locks",)
+
+    def __init__(self, counter_locks: Iterable[CounterLock]) -> None:
+        """
+        Initializes the :class:`CounterLockCluster` with a collection of :class:`CounterLock` objects.
+
+        Args:
+            counter_locks: The :class:`CounterLock` objects to manage.
+
+        Examples:
+            >>> lock1 = CounterLock(start_value=0)
+            >>> lock2 = CounterLock(start_value=0)
+            >>> cluster = CounterLockCluster([lock1, lock2])
+        """
+        self.locks = list(counter_locks)
+
+    async def wait_for(self, value: int) -> bint:
+        """
+        Waits until the value of all :class:`CounterLock` objects in the cluster reaches or exceeds the specified value.
+
+        Args:
+            value: The value to wait for.
+
+        Examples:
+            >>> lock1 = CounterLock(start_value=0)
+            >>> lock2 = CounterLock(start_value=0)
+            >>> cluster = CounterLockCluster([lock1, lock2])
+            >>> await cluster.wait_for(5)  # This will block until all locks have value >= 5
+        """
+        await cigather(counter_lock.wait_for(value) for counter_lock in self.locks)
+        return True