module-wrapper - module wrapper Python library (maintenance mode)

Warning

Authors of aioify and module-wrapper decided to discontinue support of
these libraries since the idea: “let’s convert sync libraries to async
ones” works only for some cases. Existing releases of libraries won’t
be removed, but don’t expect any changes since today. Feel free to
fork these libraries, however, we don’t recommend using the automatic
sync-to-async library conversion approach, as unreliable. Instead,
it’s better to run synchronous functions asynchronously using
https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.run_in_executor
or https://anyio.readthedocs.io/en/stable/api.html#running-code-in-worker-threads.

Old documentation

module-wrapper contains wrap function, which is used to wrap module, class, function or another variable
recursively.

Installation

To install from PyPI run:

$ pip install module-wrapper

Usage

Example from aioify:

from functools import wraps, partial
import asyncio
import module_wrapper
__all__ = ['aioify']
def wrap(func):
    @wraps(func)
    async def run(*args, loop=None, executor=None, **kwargs):
        if loop is None:
            loop = asyncio.get_event_loop()
        pfunc = partial(func, *args, **kwargs)
        return await loop.run_in_executor(executor, pfunc)
    return run
def aioify(obj, name=None):
    def create(cls):
        return 'create', wrap(cls)
    return module_wrapper.wrap(obj=obj, wrapper=wrap, methods_to_add={create}, name=name)