queutils 0.8.2__tar.gz → 0.8.4__tar.gz

{queutils-0.8.2 → queutils-0.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: queutils
-Version: 0.8.2
+Version: 0.8.4
 Summary: Handy Python Queue utilies
 Project-URL: Homepage, https://github.com/Jylpah/queutils
 Project-URL: Bug Tracker, https://github.com/Jylpah/queutils/issues
@@ -31,7 +31,7 @@ Description-Content-Type: text/markdown
 
 # Queutils
 
-Queutils *[Queue Utils]* is a package if handy Python queue classes:
+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
@@ -41,7 +41,7 @@ Queutils *[Queue Utils]* is a package if handy Python queue classes:
 # AsyncQueue
 
 [`AsyncQueue`](docs/asyncqueue.md) is a async wrapper for non-async `queue.Queue`. It can be used to create 
-an `asyncio.Queue` compatible out of a (non-async) `multiprocessing.Queue`. This is handy to have `async` code running in `multiprocessing` processes and yet be able to communicate with the parent via (non-async) managed `multiprocessing.Queue` queue. 
+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 
 
@@ -54,6 +54,12 @@ an `asyncio.Queue` compatible out of a (non-async) `multiprocessing.Queue`. This
 
 [`IterableQueue`](docs/iterablequeue.md) 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 
+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. 
     
 ## Features
 
@@ -68,7 +74,9 @@ iterated in `async for` loop. `IterableQueue` terminates automatically when the
 
 # FileQueue
 
-[`FileQueue`](docs/filequeue.md) 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.  
+[`FileQueue`](docs/filequeue.md) 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.  
 
 ## Features
 

{queutils-0.8.2 → queutils-0.8.4}/README.md

@@ -2,7 +2,7 @@
 
 # Queutils
 
-Queutils *[Queue Utils]* is a package if handy Python queue classes:
+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
@@ -12,7 +12,7 @@ Queutils *[Queue Utils]* is a package if handy Python queue classes:
 # AsyncQueue
 
 [`AsyncQueue`](docs/asyncqueue.md) is a async wrapper for non-async `queue.Queue`. It can be used to create 
-an `asyncio.Queue` compatible out of a (non-async) `multiprocessing.Queue`. This is handy to have `async` code running in `multiprocessing` processes and yet be able to communicate with the parent via (non-async) managed `multiprocessing.Queue` queue. 
+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 
 
@@ -25,6 +25,12 @@ an `asyncio.Queue` compatible out of a (non-async) `multiprocessing.Queue`. This
 
 [`IterableQueue`](docs/iterablequeue.md) 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 
+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. 
     
 ## Features
 
@@ -39,7 +45,9 @@ iterated in `async for` loop. `IterableQueue` terminates automatically when the
 
 # FileQueue
 
-[`FileQueue`](docs/filequeue.md) 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.  
+[`FileQueue`](docs/filequeue.md) 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.  
 
 ## Features
 

{queutils-0.8.2 → queutils-0.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "queutils"
-version = "0.8.2"
+version = "0.8.4"
 authors = [{ name = "Jylpah", email = "jylpah@gmail.com" }]
 description = "Handy Python Queue utilies"
 readme = "README.md"
@@ -49,7 +49,7 @@ exclude = ['tmp']
 mypy_path = ['src', 'demos']
 
 [tool.ruff]
-include = ["pyproject.toml", "src/**/*.py", "tests/**/*.py"]
+include = ["pyproject.toml", "src/**/*.py", "tests/**/*.py", "demos/**/*.py"]
 indent-width = 4
 extend-include = ["*.ipynb"]
 extend-exclude = [".venv", ".vscode"]