Common interface for archive manipulation
Project description
decoutils: Utilities for writing decorators
Rationale
Python decorators are very useful. However, writing decorators with arguments is not straightforward. Take the following function as an example:
register_plugin(plugin, arg1=1):
print('registering ', plugin.__name__, ' with arg1=', arg1)
This function registers a input function somewhere in the system. If this function could work as a decorator, that will be convinient. In order to make it a decorator, we just need it to return the input plugin trivially:
register_plugin(plugin, arg1=1):
print('registering ', plugin.__name__, ' with arg1=', arg1)
return plugin
@register_plugin
def plugin1(): pass
It is pretty easy so far. What if we want register_plugin works as a decorator with arguments? That's to say, we want to use it as:
@register_plugin(arg1=2)
def plugin2(): pass
In order to accomplish this goal, we need to wrap the function register_plugin so that it return a decorated plugin if the first input is a callable object, otherwise return a decorator with arguments. The decoutils.decorator_with_arguments is intend to abstract that wrapping, so that we can reuse it.
Installation
Install from PyPI
pip install decoutils
Install from Anaconda
conda install -c liyugong decoutils
Simple example
Basically, decorator_with_arguments enables a ordinary decorator function to be a decorator with arguments.
@decorator_with_arguments
def register_plugin(plugin, arg1=1):
print('registering ', plugin.__name__, ' with arg1=', arg1)
return plugin
@register_plugin(arg1=10)
def plugin1(): pass
Moreover, decorator_with_arguments itself is also a decorator with arguments: one argument return_original which can be used to convert a non-decorator function to be a decorator
@decorator_with_arguments
def register_plugin(plugin, arg1=1):
print('registering ', plugin.__name__, ' with arg1=', arg1)
# Note here the function does not return the plugin, so it cannot work as a decorator originally
@register_plugin(arg1=10)
def plugin1(): pass
return_original control whether the resultant decorator return the original plugin, or the result of function register_plugin.
License
The compfile package is released under the MIT License
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 Distribution
Hashes for decoutils-0.0.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d91f2ab2fb671ead6544a6eaaf000b27f865e12570538208cb0f70aa61fd842d |
|
MD5 | 49f0a29fa5dd45c85e21fe31e2ab3dc6 |
|
BLAKE2b-256 | 2e3b01f36a337136b3954bf515004b0123f3a5cb8dc0f317871495b1fd0f36f2 |