====

toro

.. image:: https://raw.github.com/ajdavis/toro/master/doc/_static/toro.png

:Info: Synchronization primitives for Tornado coroutines. :Author: A. Jesse Jiryu Davis

Documentation: https://toro.readthedocs.io/

.. important:: Toro is completed and deprecated; its features have been merged into Tornado. Development of locks and queues for Tornado coroutines continues in Tornado itself.

.. image:: https://travis-ci.org/ajdavis/toro.png :target: https://travis-ci.org/ajdavis/toro

About

A set of locking and synchronizing primitives analogous to those in Python's

threading module

coros

gen.engine

.. _threading module: http://docs.python.org/library/threading.html

.. _coros: http://www.gevent.org/gevent.coros.html

.. _gen.engine: http://www.tornadoweb.org/documentation/gen.html

Dependencies

Tornado_ >= version 3.0.

.. _Tornado: http://www.tornadoweb.org/

Examples

Here's a basic example (for more see the examples section of the docs):

.. code-block:: python

from tornado import ioloop, gen
import toro

q = toro.JoinableQueue(maxsize=3)
@gen.coroutine
def consumer():
    while True:
        item = yield q.get()
        try:
            print 'Doing work on', item
        finally:
            q.task_done()
@gen.coroutine
def producer():
    for item in range(10):
        yield q.put(item)
producer()
consumer()
loop = ioloop.IOLoop.instance()
block until all tasks are done
q.join().add_done_callback(loop.stop)
loop.start()

Documentation

You will need Sphinx_ and GraphViz_ installed to generate the documentation. Documentation can be generated like:

.. code-block:: console

$ sphinx-build doc build

.. _Sphinx: http://sphinx.pocoo.org/

.. _GraphViz: http://www.graphviz.org/

Testing

Run

python setup.py test

Toro boasts 100% code coverage, including branch-coverage!