queutils 0.8.5__py3-none-any.whl → 0.9.3__py3-none-any.whl

queutils/__init__.py

@@ -2,10 +2,15 @@ from .countable import Countable as Countable
 from .asyncqueue import AsyncQueue as AsyncQueue
 from .iterablequeue import IterableQueue as IterableQueue, QueueDone as QueueDone
 from .filequeue import FileQueue as FileQueue
+from .eventcounterqueue import (
+    QCounter as QCounter,
+    EventCounterQueue as EventCounterQueue,
+)
 
 __all__ = [
     "asyncqueue",
     "countable",
+    "eventcounterqueue",
     "filequeue",
     "iterablequeue",
 ]

queutils/eventcounterqueue.py

@@ -0,0 +1,116 @@
+from asyncio import Queue
+from typing import TypeVar
+from deprecated import deprecated
+from .countable import Countable
+from .iterablequeue import IterableQueue, QueueDone
+from collections import defaultdict
+import logging
+
+logger = logging.getLogger()
+error = logger.error
+message = logger.warning
+verbose = logger.info
+debug = logger.debug
+
+###########################################
+#
+# class CounterQueue
+#
+###########################################
+T = TypeVar("T")
+
+
+@deprecated(version="0.9.1", reason="Use EventCounterQueue instead")
+class CounterQueue(Queue[T], Countable):
+    """
+    CounterQueue is a asyncio.Queue for counting items
+    """
+
+    _counter: int
+    _count_items: bool
+    _batch: int
+
+    def __init__(
+        self, *args, count_items: bool = True, batch: int = 1, **kwargs
+    ) -> None:
+        super().__init__(*args, **kwargs)
+        self._counter = 0
+        self._count_items = count_items
+        self._batch = batch
+
+    def task_done(self) -> None:
+        super().task_done()
+        if self._count_items:
+            self._counter += 1
+        return None
+
+    @property
+    def count(self) -> int:
+        """Return number of completed tasks"""
+        return self._counter * self._batch
+
+    @property
+    def count_items(self) -> bool:
+        """Whether or not count items"""
+        return self._count_items
+
+
+class EventCounterQueue(IterableQueue[tuple[str, int]]):
+    """
+    EventCounterQueue is a asyncio.Queue for counting events by name
+    """
+
+    _counter: defaultdict[str, int]
+    _batch: int
+
+    def __init__(self, *args, batch: int = 1, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self._batch = batch
+        self._counter = defaultdict(int)
+
+    async def receive(self) -> tuple[str, int]:
+        """Receive an event value from the queue and sum it"""
+        event: str
+        value: int
+        event, value = await super().get()
+        self._counter[event] += value
+        super().task_done()
+        return (event, value)
+
+    async def send(self, event: str = "count", value: int = 1) -> None:
+        """Send count of an event"""
+        await super().put((event, value))
+        return None
+
+    def get_count(self, event: str = "count") -> int:
+        """Return count for an event"""
+        return self._counter[event]
+
+    def get_counts(self) -> defaultdict[str, int]:
+        """Return counts of all events"""
+        return self._counter
+
+    async def listen(self) -> defaultdict[str, int]:
+        """Listen for event values"""
+        try:
+            while True:
+                await self.receive()
+        except QueueDone:
+            pass
+        return self.get_counts()
+
+
+class QCounter:
+    def __init__(self, Q: Queue[int]):
+        self._count = 0
+        self._Q: Queue[int] = Q
+
+    @property
+    def count(self) -> int:
+        return self._count
+
+    async def start(self) -> None:
+        """Read and count items from Q"""
+        while True:
+            self._count += await self._Q.get()
+            self._Q.task_done()

{queutils-0.8.5.dist-info → queutils-0.9.3.dist-info}/METADATA

@@ -1,10 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: queutils
-Version: 0.8.5
+Version: 0.9.3
 Summary: Handy Python Queue utilies
 Project-URL: Homepage, https://github.com/Jylpah/queutils
 Project-URL: Bug Tracker, https://github.com/Jylpah/queutils/issues
 Author-email: Jylpah <jylpah@gmail.com>
+License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: AsyncIO
 Classifier: License :: OSI Approved :: MIT License
@@ -13,6 +14,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.11
 Requires-Dist: aioconsole>=0.6
+Requires-Dist: deprecated>=1.2.18
 Provides-Extra: dev
 Requires-Dist: build>=0.10; extra == 'dev'
 Requires-Dist: hatchling>=1.22.4; extra == 'dev'
@@ -24,6 +26,7 @@ Requires-Dist: pytest-datafiles>=3.0; extra == 'dev'
 Requires-Dist: pytest-timeout>=2.2; extra == 'dev'
 Requires-Dist: pytest>=8.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.9; extra == 'dev'
+Requires-Dist: types-deprecated>=1.2.15; extra == 'dev'
 Description-Content-Type: text/markdown
 
 [![Python package](https://github.com/Jylpah/queutils/actions/workflows/python-package.yml/badge.svg)](https://github.com/Jylpah/queutils/actions/workflows/python-package.yml)  [![codecov](https://codecov.io/gh/Jylpah/queutils/graph/badge.svg?token=rMKdbfHOFs)](https://codecov.io/gh/Jylpah/queutils)
@@ -32,14 +35,15 @@ Description-Content-Type: text/markdown
 
 Queutils *[Queue Utils]* is a package of handy Python queue classes:
 
-- **[AsyncQueue](docs/asyncqueue.md)** - An `async` wrapper for non-async `queue.Queue`
-- **[IterableQueue](docs/iterablequeue.md)** - An `AsyncIterable` queue that terminates when finished
-- **[FileQueue](docs/filequeue.md)** - Builds an iterable queue of filenames from files/dirs given as input
+- **AsyncQueue** - An `async` wrapper for non-async `queue.Queue`
+- **IterableQueue** - An `AsyncIterable` queue that terminates when finished
+- **EventCounterQueue** - An `IterableQueue` for counting events in `async` threads
+- **FileQueue** - Builds an iterable queue of filenames from files/dirs given as input
 
 
 # AsyncQueue
 
-[`AsyncQueue`](docs/asyncqueue.md) is a async wrapper for non-async `queue.Queue`. It can be used to create 
+`AsyncQueue` is a async wrapper for non-async `queue.Queue`. It can be used to create 
 an `asyncio.Queue` compatible interface to a (non-async) managed `multiprocessing.Queue` and thus enable `async` code in parent/child processes to communicate over  `multiprocessing.Queue` as it were an `asyncio.Queue`. 
 
 ## Features 
@@ -51,7 +55,7 @@ an `asyncio.Queue` compatible interface to a (non-async) managed `multiprocessin
 
 # IterableQueue
 
-[`IterableQueue`](docs/iterablequeue.md) is an `asyncio.Queue` subclass that is `AsyncIterable[T]` i.e. it can be 
+`IterableQueue` is an `asyncio.Queue` subclass that is `AsyncIterable[T]` i.e. it can be 
 iterated in `async for` loop. `IterableQueue` terminates automatically when the queue has been filled and emptied. 
 
 The `IterableQueue` requires "producers" (functions adding items to the queue) to register themselves and it 
@@ -71,9 +75,19 @@ producers are "finished", the queue enters into "filled" state and no new items
 - Countable property can be disabled with count_items=False. This is useful when you
     want to sum the count of multiple IterableQueues 
 
+# EventCounterQueue
+
+`EventCounterQueue` can be used to count named events (default event is `count`) between `async` threads. `async` worker threads call `queue.send(event="event_name", N=amount)`. The receving end can either `receive()` a single event or `listen()` all  events and return `collections.defaultdict[str, int]` as a result.
+
+## Features
+
+- Supports multiple producers and a single listener
+- Default event is `count`
+
+
 # FileQueue
 
-[`FileQueue`](docs/filequeue.md) builds a queue (`IterableQueue[pathlib.Path]`) of the matching 
+`FileQueue` builds a queue (`IterableQueue[pathlib.Path]`) of the matching 
 files found based on search parameters given. It can search both list of files or directories or 
 mixed. Async method `FileQueue.mk_queue()` searches subdirectories of given directories.  
 

queutils-0.9.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+queutils/__init__.py,sha256=rbDSh9513Dday-MfWzPOUfN7Aj2x4IqrvCmKbBj7has,441
+queutils/asyncqueue.py,sha256=GZRmlWTBQoKzTf7xr4MI-qhNqvIiaNWswAxFokP91Lg,2789
+queutils/countable.py,sha256=YSi7ILf9CuB5Tm3T4UUMEFlveqzqcmomfqJAlLGHEz8,172
+queutils/eventcounterqueue.py,sha256=NjT8FqEskZhjmus7L333DZU9kXoZCNsn7ydCI5HSe1U,3047
+queutils/filequeue.py,sha256=q2ly9H-lSCq6xuOqT1IlWgyCVyLoZiKbc0NuzmkF4aw,5360
+queutils/iterablequeue.py,sha256=ZXwa9040yTawL1DMMNBXgQKiYr32nmzuSbgi-raAtZc,8664
+queutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+queutils-0.9.3.dist-info/METADATA,sha256=VGe0K6t0aepLD6DlXlwjFiifK8IUZfcmQlOUXVCKFbA,4664
+queutils-0.9.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+queutils-0.9.3.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
+queutils-0.9.3.dist-info/RECORD,,

{queutils-0.8.5.dist-info → queutils-0.9.3.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

queutils-0.8.5.dist-info/RECORD

@@ -1,10 +0,0 @@
-queutils/__init__.py,sha256=MboAom80iQTQURz0liGv_f2ae2Np8YA5ORX1LwsNa50,311
-queutils/asyncqueue.py,sha256=GZRmlWTBQoKzTf7xr4MI-qhNqvIiaNWswAxFokP91Lg,2789
-queutils/countable.py,sha256=YSi7ILf9CuB5Tm3T4UUMEFlveqzqcmomfqJAlLGHEz8,172
-queutils/filequeue.py,sha256=q2ly9H-lSCq6xuOqT1IlWgyCVyLoZiKbc0NuzmkF4aw,5360
-queutils/iterablequeue.py,sha256=ZXwa9040yTawL1DMMNBXgQKiYr32nmzuSbgi-raAtZc,8664
-queutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-queutils-0.8.5.dist-info/METADATA,sha256=6sJ7O4naraaat7-8ZFeTD9c_r1RFM9uDtkotLuX6aq0,4169
-queutils-0.8.5.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-queutils-0.8.5.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
-queutils-0.8.5.dist-info/RECORD,,