queutils 0.10.0__py3-none-any.whl → 0.11.0__py3-none-any.whl

queutils/iterablequeue.py

@@ -50,7 +50,7 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
     - 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_producer() once they have finished adding items
     - Countable interface to count number of items task_done() through 'count' property
 
     IterableQueue stages:
@@ -82,6 +82,17 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
 
         self._empty.clear()  # this will be tested only after queue is filled
 
+    @classmethod
+    def from_queue(cls, Q: Queue[Optional[T]]) -> "IterableQueue[T]":
+        """
+        Create IterableQueue from existing asyncio.Queue
+        """
+        if not isinstance(Q, Queue):
+            raise TypeError("Q must be an instance of asyncio.Queue")
+        iq: IterableQueue[T] = cls(maxsize=Q.maxsize)
+        iq._Q = Q
+        return iq
+
     @property
     def is_filled(self) -> bool:
         """ "
@@ -166,7 +177,7 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
         """
         Producer has finished adding items to the queue.
         Once the last producers has finished, the queue is_filled.
-        - all: finish() queue for all producers at once
+        - all: finish_producer() queue for all producers at once
 
         Return True if the last producer is 'finished'
         """
@@ -177,7 +188,7 @@ class IterableQueue(Queue[T], AsyncIterable[T], Countable):
             self._producers -= 1
 
             if self._producers < 0:
-                raise ValueError("Too many finish() calls")
+                raise ValueError("Too many finish_producer() calls")
             elif all or self._producers == 0:
                 self._filled.set()
                 self._producers = 0

{queutils-0.10.0.dist-info → queutils-0.11.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: queutils
-Version: 0.10.0
+Version: 0.11.0
 Summary: Handy Python Queue utilies
 Project-URL: Homepage, https://github.com/Jylpah/queutils
 Project-URL: Bug Tracker, https://github.com/Jylpah/queutils/issues
@@ -58,11 +58,10 @@ an `asyncio.Queue` compatible interface to a (non-async) managed `multiprocessin
 `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 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 
-`raise QueueDone` exception. 
+The `IterableQueue` requires "producers" (functions adding items to the queue) to register themselves with `add_producer()` call. It keeps count of registered producers. When a producer "finishes" adding items to the queue, 
+it needs to unregister itself with `finish_producer()` call. Once all the registered 
+producers are "finished", the queue enters into "filled" state and no new items can be added. Once a "filled" queue has been emptied, the queue becomes "done" and 
+all new `get()` calls to the queue will `raise QueueDone` exception. 
     
 ## Features
 
@@ -70,7 +69,7 @@ producers are "finished", the queue enters into "filled" state and no new items
 - `AsyncIterable` support: `async for item in queue:`
 - Automatic termination of the consumers with `QueueDone` exception when the queue has been emptied 
 - Producers must be registered with `add_producer()` and they must notify the queue
-  with `finish()` once they have finished adding items 
+  with `finish_producer()` once they have finished adding items 
 - Countable interface to count number of items task_done() through `count` property
 
 # EventCounterQueue

{queutils-0.10.0.dist-info → queutils-0.11.0.dist-info}/RECORD

@@ -4,9 +4,9 @@ queutils/awrap.py,sha256=QydWBLmyNIHpYrRwVFn1RWjbQKRnJr61u-DYl7d3F7w,1293
 queutils/countable.py,sha256=YSi7ILf9CuB5Tm3T4UUMEFlveqzqcmomfqJAlLGHEz8,172
 queutils/eventcounterqueue.py,sha256=9CvgfnWmvXrMr3h-RiQyIVIBXqOnGvohql_ADvdlmxo,2913
 queutils/filequeue.py,sha256=J_UK3VHKaM4ELFzedtj6lDmlXas8O732aC0nO8zNzNo,5256
-queutils/iterablequeue.py,sha256=_aAtitQROpUHglcmGCAJkOErqDjibbiALp2ewnzf2U8,8699
+queutils/iterablequeue.py,sha256=_crzGtifm0cmxQuyOF5grVveJjkUp4eR22RRMZqqOM0,9092
 queutils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-queutils-0.10.0.dist-info/METADATA,sha256=_6RN7Pde53fUpvEOgVn7Y3LV-EkVfeGtX4OfB9N3SLc,4630
-queutils-0.10.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-queutils-0.10.0.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
-queutils-0.10.0.dist-info/RECORD,,
+queutils-0.11.0.dist-info/METADATA,sha256=etPt_8pP0P8k6FVEQVetf_j92Rz4mYCTx1aR4sDxTvM,4708
+queutils-0.11.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+queutils-0.11.0.dist-info/licenses/LICENSE,sha256=J1zeIKU2JVQmhwO2hHQDK8WR6zjVZ-wX8r7ZlL45AbI,1063
+queutils-0.11.0.dist-info/RECORD,,