https://github.com/rominf/module-wrapper

Module wrapper Python library
https://github.com/rominf/module-wrapper

decorator lib library module proxy python wrapper

Last synced: 6 months ago
JSON representation

Module wrapper Python library

• Host: GitHub
• URL: https://github.com/rominf/module-wrapper
• Owner: rominf
• License: apache-2.0
• Archived: true
• Created: 2018-09-23T07:09:09.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-04-04T13:23:42.000Z (about 4 years ago)
• Last Synced: 2025-10-07T02:02:07.512Z (9 months ago)
• Topics: decorator, lib, library, module, proxy, python, wrapper
• Language: Python
• Size: 57.6 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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)

```