{"author":"Andrew Svetlov ","author_email":"andrew.svetlov@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Framework :: AsyncIO","Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: MacOS :: MacOS X","Operating System :: Microsoft :: Windows","Operating System :: POSIX","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Topic :: Software Development :: Libraries"],"description":"=======\n janus\n=======\n.. image:: https://github.com/aio-libs/janus/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/aio-libs/janus/actions/workflows/ci.yml\n.. image:: https://codecov.io/gh/aio-libs/janus/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/aio-libs/janus\n.. image:: https://img.shields.io/pypi/v/janus.svg\n :target: https://pypi.python.org/pypi/janus\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n :target: https://gitter.im/aio-libs/Lobby\n :alt: Chat on Gitter\n\n\n\nMixed sync-async queue, supposed to be used for communicating between\nclassic synchronous (threaded) code and asynchronous (in terms of\n`asyncio `_) one.\n\nLike `Janus god `_ the queue\nobject from the library has two faces: synchronous and asynchronous\ninterface.\n\nSynchronous is fully compatible with `standard queue\n`_, asynchronous one\nfollows `asyncio queue design\n`_.\n\nUsage\n=====\n\nThree queues are available:\n\n* ``Queue``\n* ``LifoQueue``\n* ``PriorityQueue``\n\nEach has two properties: ``sync_q`` and ``async_q``.\n\nUse the first to get synchronous interface and the second to get asynchronous\none.\n\n\nExample\n-------\n\n.. code:: python\n\n import asyncio\n import janus\n\n\n def threaded(sync_q: janus.SyncQueue[int]) -> None:\n for i in range(100):\n sync_q.put(i)\n sync_q.join()\n\n\n async def async_coro(async_q: janus.AsyncQueue[int]) -> None:\n for i in range(100):\n val = await async_q.get()\n assert val == i\n async_q.task_done()\n\n\n async def main() -> None:\n queue: janus.Queue[int] = janus.Queue()\n loop = asyncio.get_running_loop()\n fut = loop.run_in_executor(None, threaded, queue.sync_q)\n await async_coro(queue.async_q)\n await fut\n await queue.aclose()\n\n\n asyncio.run(main())\n\n\nLimitations\n===========\n\nThis library is built using a classic thread-safe design. The design is\ntime-tested, but has some limitations.\n\n* Once you are done working with a queue, you must properly close it using\n ``aclose()``. This is because this library creates new tasks to notify other\n threads. If you do not properly close the queue,\n `asyncio may generate error messages\n `_.\n* The library has quite good performance only when used as intended, that is,\n for communication between synchronous code and asynchronous one.\n For sync-only and async-only cases, use queues from\n `queue `_ and\n `asyncio queue `_ modules,\n otherwise `the slowdown can be significant\n `_.\n* You cannot use queues for communicating between two different event loops\n because, like all asyncio primitives, they bind to the current one.\n\nDevelopment status is production/stable. The ``janus`` library is maintained to\nsupport the latest versions of Python and fixes, but no major changes will be\nmade. If your application is performance-sensitive, or if you need any new\nfeatures such as ``anyio`` support, try the experimental\n`culsans `_ library as an alternative.\n\n\nCommunication channels\n======================\n\nGitHub Discussions: https://github.com/aio-libs/janus/discussions\n\nFeel free to post your questions and ideas here.\n\n*gitter chat* https://gitter.im/aio-libs/Lobby\n\n\nLicense\n=======\n\n``janus`` library is offered under Apache 2 license.\n\nThanks\n======\n\nThe library development is sponsored by DataRobot (https://datarobot.com)\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/aio-libs/janus","keywords":"janus, queue, asyncio","license":"Apache 2","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"janus","package_url":"https://pypi.org/project/janus/","platform":null,"project_url":"https://pypi.org/project/janus/","project_urls":{"CI: GitHub Actions":"https://github.com/aio-libs/janus/actions/workflows/ci.yml","Chat: Gitter":"https://gitter.im/aio-libs/Lobby","Coverage: codecov":"https://codecov.io/github/aio-libs/janus","GitHub: issues":"https://github.com/aio-libs/janus/issues","GitHub: repo":"https://github.com/aio-libs/janus","Homepage":"https://github.com/aio-libs/janus"},"provides_extra":null,"release_url":"https://pypi.org/project/janus/2.0.0/","requires_dist":null,"requires_python":">=3.9","summary":"Mixed sync-async queue to interoperate between asyncio tasks and classic threads","version":"2.0.0","yanked":false,"yanked_reason":null}

Package search

janus

project_urls

Dependencies

All package metadata

Releases