aqueue

.. teaser-begin

========== aqueue

aqueue is an async task queue with live progress display.

You put items (tasks) in, and they get processed, possibly creating more items which get processed, and so on, until all items are completed. A typical use case would be to scrape a website.

Meanwhile, a nice visualization of the queue's goings-on is displayed in the terminal.

.. image:: https://raw.githubusercontent.com/t-mart/aqueue/master/docs/_static/demo.gif :alt: Demonstration of aqueue

.. note::

aqueue, or any asynchronous framework, is only going to be helpful if you're performing I/O-bound work.

Installation

aqueue is a Python package hosted on PyPI <https://pypi.org/project/aqueue/>. The recommended installation method is pip <https://pip.pypa.io/en/stable/>-installing into a virtual environment:

.. code-block:: shell

pip install aqueue

Getting Started

There's two things you need to do to use aqueue:

1. Implement your Item <https://t-mart.github.io/aqueue/#items>_ subclasses.
2. Start your queue <https://t-mart.github.io/aqueue/#starting-your-queue>_ with one of those items.

.. teaser-end

Example

If you had a hierarchy of items like this...

.. image:: docs/_static/simple-diagram.png :alt: Simple item hierarchy with one root item and many children items stemming from it.

Then, you might process it with aqueue like this...

.. code-block:: python

import aqueue

class RootItem(aqueue.Item): async def process(self) -> aqueue.ProcessRetVal: # display what we're doing in the worker status panel self.set_worker_desc("Processing RootItem")

     # make an HTTP request, parse it, etc
     ...

     # when you discover more items you want to process, enqueue them by yield-ing
     # them:
     for _ in range(3):
           yield ChildItem()

  async def after_children_processed(self) -> None:
     # run this method when this Item and all other Items it enqueued are done
     print("All done!")

class ChildItem(aqueue.Item):

  # track the enqueueing and completion of these items in the overall panel
  track_overall: bool = True

  async def process(self) -> aqueue.ProcessRetVal:
     self.set_worker_desc("Processing ChildItem")
     # this child item has no further children to enqueue, so it doesn't yield
     # anything

if name == "main": aqueue.run_queue( initial_items=[RootItem()], num_workers=2, )

.. -project-information-

Project Information

• License: MIT <https://choosealicense.com/licenses/mit/>_
• PyPI: https://pypi.org/project/aqueue/
• Source Code: https://github.com/t-mart/aqueue
• Documentation: https://t-mart.github.io/aqueue/
• Supported Python Versions: 3.10 and later