Metadata-Version: 2.1
Name: janus
Version: 1.0.0
Summary: Mixed sync-async queue to interoperate between asyncio tasks and classic threads
Home-page: https://github.com/aio-libs/janus
Author: Andrew Svetlov <andrew.svetlov@gmail.com>
Author-email: andrew.svetlov@gmail.com
License: Apache 2
Project-URL: Chat: Gitter, https://gitter.im/aio-libs/Lobby
Project-URL: CI: GitHub Actions, https://github.com/aio-libs/janus/actions/workflows/ci.yml
Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/janus
Project-URL: GitHub: issues, https://github.com/aio-libs/janus/issues
Project-URL: GitHub: repo, https://github.com/aio-libs/janus
Description: =======
         janus
        =======
        .. image:: https://github.com/aio-libs/janus/actions/workflows/ci.yml/badge.svg
            :target: https://github.com/aio-libs/janus/actions/workflows/ci.yml
        .. image:: https://codecov.io/gh/aio-libs/janus/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/aio-libs/janus
        .. image:: https://img.shields.io/pypi/v/janus.svg
            :target: https://pypi.python.org/pypi/janus
        .. image:: https://badges.gitter.im/Join%20Chat.svg
            :target: https://gitter.im/aio-libs/Lobby
            :alt: Chat on Gitter
        
        
        
        Mixed sync-async queue, supposed to be used for communicating between
        classic synchronous (threaded) code and asynchronous (in terms of
        asyncio_) one.
        
        Like `Janus god <https://en.wikipedia.org/wiki/Janus>`_ the queue
        object from the library has two faces: synchronous and asynchronous
        interface.
        
        Synchronous is fully compatible with `standard queue
        <https://docs.python.org/3/library/queue.html>`_, asynchronous one
        follows `asyncio queue design
        <https://docs.python.org/3/library/asyncio-queue.html>`_.
        
        Usage example (Python 3.7+)
        ===========================
        
        .. code:: python
        
            import asyncio
            import janus
        
        
            def threaded(sync_q: janus.SyncQueue[int]) -> None:
                for i in range(100):
                    sync_q.put(i)
                sync_q.join()
        
        
            async def async_coro(async_q: janus.AsyncQueue[int]) -> None:
                for i in range(100):
                    val = await async_q.get()
                    assert val == i
                    async_q.task_done()
        
        
            async def main() -> None:
                queue: janus.Queue[int] = janus.Queue()
                loop = asyncio.get_running_loop()
                fut = loop.run_in_executor(None, threaded, queue.sync_q)
                await async_coro(queue.async_q)
                await fut
                queue.close()
                await queue.wait_closed()
        
        
            asyncio.run(main())
        
        
        Usage example (Python 3.5 and 3.6)
        ==================================
        
        .. code:: python
        
            import asyncio
            import janus
        
            loop = asyncio.get_event_loop()
        
        
            def threaded(sync_q):
                for i in range(100):
                    sync_q.put(i)
                sync_q.join()
        
        
            async def async_coro(async_q):
                for i in range(100):
                    val = await async_q.get()
                    assert val == i
                    async_q.task_done()
        
        
            async def main():
                queue = janus.Queue()
                fut = loop.run_in_executor(None, threaded, queue.sync_q)
                await async_coro(queue.async_q)
                await fut
                queue.close()
                await queue.wait_closed()
        
            try:
                loop.run_until_complete(main())
            finally:
                loop.close()
        
        
        Communication channels
        ======================
        
        GitHub Discussions: https://github.com/aio-libs/janus/discussions
        
        Feel free to post your questions and ideas here.
        
        *gitter chat* https://gitter.im/aio-libs/Lobby
        
        
        License
        =======
        
        ``janus`` library is offered under Apache 2 license.
        
        Thanks
        ======
        
        The library development is sponsored by DataRobot (https://datarobot.com)
        
        .. _asyncio: https://docs.python.org/3/library/asyncio.html
        
Keywords: janus,queue,asyncio
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
