Metadata-Version: 2.1
Name: module-wrapper
Version: 0.3.2
Summary: Module wrapper Python library
Home-page: https://github.com/rominf/module-wrapper
License: Apache-2.0
Keywords: module,wrapper,proxy,decorator
Author: Roman Inflianskas
Author-email: infroma@gmail.com
Requires-Python: >=3.6,<3.10
Classifier: Development Status :: 7 - Inactive
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: stdlib_list (>=0.8.0,<0.9.0)
Project-URL: Repository, https://github.com/rominf/module-wrapper
Description-Content-Type: text/markdown

# module-wrapper - module wrapper Python library (maintenance mode)
[![License](https://img.shields.io/pypi/l/module-wrapper.svg)](https://www.apache.org/licenses/LICENSE-2.0)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/module-wrapper.svg)
[![PyPI](https://img.shields.io/pypi/v/module-wrapper.svg)](https://pypi.org/project/module-wrapper/)
[![Documentation Status](https://img.shields.io/readthedocs/module-wrapper.svg)](http://module-wrapper.readthedocs.io/en/latest/)
 
# 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](https://pypi.org/project/module-wrapper/) run:
```shell
$ pip install module-wrapper
```

## Usage
Example from [aioify](https://github.com/yifeikong/aioify):
```pyhton
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)
```

