queutils 0.9.1__py3-none-any.whl → 0.9.4__py3-none-any.whl

queutils/__init__.py

@@ -2,15 +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 .categorycounterqueue import (
+from .eventcounterqueue import (
     QCounter as QCounter,
-    CategoryCounterQueue as CategoryCounterQueue,
+    EventCounterQueue as EventCounterQueue,
 )
 
 __all__ = [
     "asyncqueue",
     "countable",
-    "categorycounterqueue",
+    "eventcounterqueue",
     "filequeue",
     "iterablequeue",
 ]

queutils/{categorycounterqueue.py → eventcounterqueue.py}

@@ -20,7 +20,7 @@ debug = logger.debug
 T = TypeVar("T")
 
 
-@deprecated(version="0.9.1", reason="Use CategoryCounterQueue instead")
+@deprecated(version="0.9.1", reason="Use EventCounterQueue instead")
 class CounterQueue(Queue[T], Countable):
     """
     CounterQueue is a asyncio.Queue for counting items
@@ -55,9 +55,9 @@ class CounterQueue(Queue[T], Countable):
         return self._count_items
 
 
-class CategoryCounterQueue(IterableQueue[tuple[str, int]]):
+class EventCounterQueue(IterableQueue[tuple[str, int]]):
     """
-    CategorySummerQueue is a asyncio.Queue for summing up values by category
+    EventCounterQueue is a asyncio.Queue for counting events by name
     """
 
     _counter: defaultdict[str, int]
@@ -69,29 +69,29 @@ class CategoryCounterQueue(IterableQueue[tuple[str, int]]):
         self._counter = defaultdict(int)
 
     async def receive(self) -> tuple[str, int]:
-        """Receive a category value from the queue and sum it"""
-        category: str
+        """Receive an event value from the queue and sum it"""
+        event: str
         value: int
-        category, value = await super().get()
-        self._counter[category] += value
+        event, value = await super().get()
+        self._counter[event] += value
         super().task_done()
-        return (category, value)
+        return (event, value)
 
-    async def send(self, category: str = "count", value: int = 1) -> None:
-        """Send count of a category"""
-        await super().put((category, 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, category: str = "count") -> int:
-        """Return count of a category"""
-        return self._counter[category]
+    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 categories"""
+        """Return counts of all events"""
         return self._counter
 
     async def listen(self) -> defaultdict[str, int]:
-        """Listen for category values"""
+        """Listen for event values"""
         try:
             while True:
                 await self.receive()

{queutils-0.9.1.dist-info → queutils-0.9.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: queutils
-Version: 0.9.1
+Version: 0.9.4
 Summary: Handy Python Queue utilies
 Project-URL: Homepage, https://github.com/Jylpah/queutils
 Project-URL: Bug Tracker, https://github.com/Jylpah/queutils/issues
@@ -35,15 +35,16 @@ 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 `IterableQueue[pathlib.Path]` 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 
-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`. 
+`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`. Uses `sleep()` for `get()`/`put()` if the queue is empty/full.
 
 ## Features 
 
@@ -54,10 +55,10 @@ 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 
+The `IterableQueue` requires "producers" (functions adding items to the queue) to register themselves with `add_producer()` call and it 
 keeps count of registered producers which are "finished" adding items to the queue. Once all the registered 
 producers are "finished", the queue enters into "filled" state and no new items can be added. Once an 
 "filled" queue is emptied, the queue becomes "done" and all new `get()` calls to the queue will 
@@ -74,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.1.dist-info → queutils-0.9.4.dist-info}/RECORD

@@ -1,11 +1,11 @@
-queutils/__init__.py,sha256=buANyRlxO1x4G_EBE3tYFpPtZGSepJDKRkWl-zKct1M,453
+queutils/__init__.py,sha256=rbDSh9513Dday-MfWzPOUfN7Aj2x4IqrvCmKbBj7has,441
 queutils/asyncqueue.py,sha256=GZRmlWTBQoKzTf7xr4MI-qhNqvIiaNWswAxFokP91Lg,2789
-queutils/categorycounterqueue.py,sha256=Ku5pAJXSsoNyUsuWkQe9w7SaPeiPwPHFMdZFqA0LtBw,3097
 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.1.dist-info/METADATA,sha256=zT3br-kHUXjDGp2QhPxW_K-EvP212VUYWZNbjTb-MUA,4281
-queutils-0.9.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-queutils-0.9.1.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
-queutils-0.9.1.dist-info/RECORD,,
+queutils-0.9.4.dist-info/METADATA,sha256=v3MC3cKun7jnGfnR9WFs7PYQHiCEDu398YBBVEWVcqE,4768
+queutils-0.9.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+queutils-0.9.4.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
+queutils-0.9.4.dist-info/RECORD,,