.. _api:

Developer Interface
===================

.. module:: zrq

Decorators
----------

.. autodecorator:: task()
.. autodecorator:: zrq.Queue::task()

Task
----

.. autoclass:: Task
   :members:

Queue
-----

.. autoclass:: Queue
   :members:
   :inherited-members:
   :show-inheritance:

.. autoclass:: zrq.queue::ProducableQueue
   :show-inheritance:

.. autoclass:: zrq.queue::ConsumableQueue
   :show-inheritance:

.. autoclass:: zrq.queue::BaseQueue

Stream
------

.. autoclass:: zrq.stream::Stream
   :members:
   :undoc-members:

Typing
------

.. automodule:: zrq.typing
   :members:
   :undoc-members:
   :imported-members:
   :inherited-members:
   :member-order: alphabetical
   :exclude-members: AsyncGenerator, Any, FrameType, Mapping, ParamSpec, Sequence, TypedDict

   .. autodata:: Any
   .. intersphinx: forces Any to appear as a data structure instead of a class

   .. autoclass:: FrameType

   .. autoclass:: TypedDict()
   .. intersphinx: forces typing.TypedDict to appear as a class instead of a func

   .. autoclass:: AsyncGenerator
      :no-members:

   .. autoclass:: Mapping
      :no-members:

   .. autoclass:: ParamSpec
      :no-members:   

   .. autoclass:: Sequence
      :no-members:

Context
-------

.. automodule:: zrq.context
   :members:

Exceptions
----------

.. automodule:: zrq.exceptions
   :members:
   :show-inheritance:

Operational Interface
=====================

A CLI is provided for day-to-day operations.

Entrypoint
----------

.. argparse::
   :module: zrq.cli.main
   :func: setup_parser
   :prog: zrq
   :nosubcommands:

Queue
-----

zrq queue list
^^^^^^^^^^^^^^

.. argparse::
   :module: zrq.cli.main
   :func: setup_parser
   :prog: zrq
   :path: queue list

zrq queue size
^^^^^^^^^^^^^^

.. argparse::
   :module: zrq.cli.main
   :func: setup_parser
   :prog: zrq
   :path: queue size

Worker
------

.. argparse::
   :module: zrq.cli.main
   :func: setup_parser
   :prog: zrq
   :path: worker