Async to sync converter
Project description
Syncer
Syncer is an async-to-sync converter for python.
Documentation: https://miyakogi.github.io/syncer/
Source code: https://github.com/miyakogi/syncer/
Features
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 coroutine-function (defined by aync def) to normal (synchronous) function
Run coroutines synchronously
Support both async def and decorator (@asyncio.coroutine) style
Install
At the command line:
$ pip install syncer
Usage
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)
License
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for syncer-1.0.0.linux-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64194237bbd0f9f9a28e78a4e224a3df127d9208dee5b5d39d4087b2b4f0cc98 |
|
MD5 | 1a84cc0d713b41b6808114ec35c04853 |
|
BLAKE2b-256 | dc02b3b805ba6959588638a42a48b5b20b9e59ea442c03a4821e677ff2e2d55d |