queutils 0.8.4__py3-none-any.whl → 0.9.1__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 .categorycounterqueue import (
+    QCounter as QCounter,
+    CategoryCounterQueue as CategoryCounterQueue,
+)
 
 __all__ = [
     "asyncqueue",
     "countable",
+    "categorycounterqueue",
     "filequeue",
     "iterablequeue",
 ]

queutils/asyncqueue.py

@@ -1,7 +1,7 @@
 # -----------------------------------------------------------
 #  Class AsyncQueue(asyncio.Queue, Generic[T])
 #
-#  asyncio wrapper for non-async queue.Queue. Can be used to create 
+#  asyncio wrapper for non-async queue.Queue. Can be used to create
 #  an asyncio.Queue out of a (non-async) multiprocessing.Queue.
 #
 # -----------------------------------------------------------
@@ -10,7 +10,6 @@ __author__ = "Jylpah"
 __copyright__ = "Copyright 2024, Jylpah <Jylpah@gmail.com>"
 __credits__ = ["Jylpah"]
 __license__ = "MIT"
-# __version__ = "1.0"
 __maintainer__ = "Jylpah"
 __email__ = "Jylpah@gmail.com"
 __status__ = "Production"
@@ -35,18 +34,17 @@ error = logger.error
 
 class AsyncQueue(asyncio.Queue, Generic[T]):
     """
-    Async wrapper for non-async queue.Queue. Can be used to create 
+    Async wrapper for non-async queue.Queue. Can be used to create
     an asyncio.Queue out of a (non-async) multiprocessing.Queue.
     """
 
-    def __init__(self, queue: Queue[T], asleep: float = 0.01):
+    def __init__(self, queue: Queue[T], asleep: float = 0.001):
         self._Q: Queue[T] = queue
         # self._maxsize: int = queue.maxsize
         self._done: int = 0
         self._items: int = 0
         self._sleep: float = asleep
 
-
     @property
     def maxsize(self) -> int:
         """not supported by queue.Queue"""

queutils/categorycounterqueue.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 CategoryCounterQueue 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 CategoryCounterQueue(IterableQueue[tuple[str, int]]):
+    """
+    CategorySummerQueue is a asyncio.Queue for summing up values by category
+    """
+
+    _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 a category value from the queue and sum it"""
+        category: str
+        value: int
+        category, value = await super().get()
+        self._counter[category] += value
+        super().task_done()
+        return (category, value)
+
+    async def send(self, category: str = "count", value: int = 1) -> None:
+        """Send count of a category"""
+        await super().put((category, value))
+        return None
+
+    def get_count(self, category: str = "count") -> int:
+        """Return count of a category"""
+        return self._counter[category]
+
+    def get_counts(self) -> defaultdict[str, int]:
+        """Return counts of all categories"""
+        return self._counter
+
+    async def listen(self) -> defaultdict[str, int]:
+        """Listen for category 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/iterablequeue.py

@@ -1,7 +1,7 @@
 # -----------------------------------------------------------
 #  Class IterableQueue(asyncio.Queue[T], AsyncIterable[T], Countable)
 #
-#  IterableQueue is asyncio.Queue subclass that can be iterated asynchronusly. 
+#  IterableQueue is asyncio.Queue subclass that can be iterated asynchronusly.
 #  IterableQueue terminates automatically when the queue has been
 #  filled and emptied.
 #
@@ -23,7 +23,7 @@ from .countable import Countable
 import logging
 
 # Setup logging
-logger = logging.getLogger()
+logger = logging.getLogger(__name__)
 error = logger.error
 message = logger.warning
 verbose = logger.info
@@ -31,24 +31,26 @@ debug = logger.debug
 
 T = TypeVar("T")
 
+
 class QueueDone(Exception):
     """
     Exception to mark an IterableQueue as filled and emptied i.e. done
     """
+
     pass
 
 
 class IterableQueue(Queue[T], AsyncIterable[T], Countable):
     """
-    IterableQueue is asyncio.Queue subclass that can be iterated asynchronusly. 
-    
+    IterableQueue is asyncio.Queue subclass that can be iterated asynchronusly.
+
     IterableQueue terminates automatically when the queue has been
     filled and emptied. Supports:
     - asyncio.Queue() interface, _nowait() methods are experimental
     - AsyncIterable(): async for item in queue:
     - Automatic termination of the consumers when the queue has been emptied with QueueDone exception
     - Producers must be registered with add_producer() and they must notify the queue
-      with finish() once they have finished adding items 
+      with finish() once they have finished adding items
     - Countable interface to count number of items task_done() through 'count' property
     - Countable property can be disabled with count_items=False. This is useful when you
     want to sum the count of multiple IterableQueues
@@ -74,16 +76,16 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
 
     @property
     def is_filled(self) -> bool:
-        """"
-        True if all the producers finished filling the queue. 
+        """ "
+        True if all the producers finished filling the queue.
         New items cannot be added to a filled queue nor can new producers can be added.
         """
         return self._filled.is_set()
-    
+
     @property
     def is_done(self) -> bool:
         """
-        Has the queue been filled, emptied and all the items have been marked with task_done() 
+        Has the queue been filled, emptied and all the items have been marked with task_done()
         """
         return self.is_filled and self.empty() and not self.has_wip
 
@@ -91,7 +93,6 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
     def maxsize(self) -> int:
         return self._Q.maxsize
 
-
     def full(self) -> bool:
         """
         True if the queue is full
@@ -122,8 +123,8 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
     @property
     def wip(self) -> int:
         """
-        Number of items in progress i.e. items that have been 
-        read from the queue, but not marked with task_done() 
+        Number of items in progress i.e. items that have been
+        read from the queue, but not marked with task_done()
         """
         return self._wip
 
@@ -236,7 +237,7 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
     def get_nowait(self) -> T:
         """
         Experimental asyncio.Queue.get_nowait() implementation
-        """        
+        """
         item: T | None = self._Q.get_nowait()
         if item is None:
             self._empty.set()

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: queutils
-Version: 0.8.4
+Version: 0.9.1
 Summary: Handy Python Queue utilies
 Project-URL: Homepage, https://github.com/Jylpah/queutils
 Project-URL: Bug Tracker, https://github.com/Jylpah/queutils/issues
@@ -14,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'
@@ -25,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)

queutils-0.9.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+queutils/__init__.py,sha256=buANyRlxO1x4G_EBE3tYFpPtZGSepJDKRkWl-zKct1M,453
+queutils/asyncqueue.py,sha256=GZRmlWTBQoKzTf7xr4MI-qhNqvIiaNWswAxFokP91Lg,2789
+queutils/categorycounterqueue.py,sha256=Ku5pAJXSsoNyUsuWkQe9w7SaPeiPwPHFMdZFqA0LtBw,3097
+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.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.8.4.dist-info → queutils-0.9.1.dist-info}/WHEEL

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

queutils-0.8.4.dist-info/RECORD

@@ -1,10 +0,0 @@
-queutils/__init__.py,sha256=MboAom80iQTQURz0liGv_f2ae2Np8YA5ORX1LwsNa50,311
-queutils/asyncqueue.py,sha256=cZPrXJgRCK0iOtE6k-VTzA9kcDDg818h9v0cwYzm2g0,2813
-queutils/countable.py,sha256=YSi7ILf9CuB5Tm3T4UUMEFlveqzqcmomfqJAlLGHEz8,172
-queutils/filequeue.py,sha256=q2ly9H-lSCq6xuOqT1IlWgyCVyLoZiKbc0NuzmkF4aw,5360
-queutils/iterablequeue.py,sha256=hygOtgRRuqaPebcK27Ixm_KOOW0MnlKmBNcYreQoWOA,8677
-queutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-queutils-0.8.4.dist-info/METADATA,sha256=kIu1OwdfGdiStIcU4DjLjkCfbvtEHMxBirj16Ba98gc,4191
-queutils-0.8.4.dist-info/WHEEL,sha256=uNdcs2TADwSd5pVaP0Z_kcjcvvTUklh2S7bxZMF8Uj0,87
-queutils-0.8.4.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
-queutils-0.8.4.dist-info/RECORD,,