Syncer is an async-to-sync converter for python.
- PyPI: https://pypi.python.org/pypi/syncer/
- Documentation: https://miyakogi.github.io/syncer/
- Source code: https://github.com/miyakogi/syncer/
Sometimes (mainly in test) we need to convert asynchronous functions to normal,
synchronous functions and run them synchronously. It can be done by
ayncio.get_event_loop().run_until_complete(), but it's quite long...
Syncer makes this conversion easy.
- Convert async-function (defined by
aync def) to normal (synchronous) function - Evaluate coroutines synchronously
At the command line:
$ pip install syncer
This module has only one function: syncer.sync.
from syncer import sync
async def async_fun():
...
return 1
b = sync(async_fun) # now b is synchronous
assert 1 == b()To test the above async_fun in asynchronous test functions:
import unittest
class TestA(unittest.TestCase):
# ``sync`` can be used as decorator.
# The decorated function becomes synchronous.
@sync
async def test_async_fun(self):
self.assertEqual(await async_fun(), 1)Or, keep test functions synchronous and get results synchronously:
class TestA(unittest.TestCase):
def test_async_fun(self):
# run coroutine and return the result
self.assertEqual(sync(async_fun()), 1)
# This is equivalent to below, just a shortcut
self.assertEqual(
asyncio.get_event_loop().run_until_complete(async_fun()), 1)More examples/use-cases will be found in test.
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.