A library to call Python functions with parameters declared at runtime.
Project description
Overview
calllib provides 2 functions, apply and getargs. These functions are used to call Python functions whose parameters are not known in advance, but are determined at runtime from a mapping of available objects.
This is particularly useful in plug-in frameworks, where you don’t want every callback function to be required to have identical signatures. Instead, each function can take a subset of available parameters.
For example:
from __future__ import print_function from datetime import datetime import calllib def callback1(time): print('callback1 called at:', time) def callback2(time, reason): print('callback2 called at:', time, 'reason:', reason) # register the callbacks callbacks = [callback1, callback2] # elsewhere: compute the total universe of possible # callback arguments args = {'time': datetime.now(), 'reason': 'abort'} for callback in callbacks: calllib.apply(callback, args) # execute each callback
The last line shows that you can call any callback routine without knowing its exact arguments, as long as its arguments are a subset of the available arguments.
apply()
apply(callable, args)
callable - Any callable object that can be inspected with the inspect module.
args - A mapping object, typically a dict, that contains the available arguments that will be passed to callable.
callable is inpsected with getargs and the its parameters are extracted by name. For each parameter the corresponding value is retrieved from args by name and passed to the callable.
apply returns the result of executing callable with the computed arguments.
getargs()
getargs(callable, args)
callable - Any callable object that can be inspected with the inspect module.
args - A mapping object, typically a dict, that contains the available arguments that could be passed to callable.
callable is inspected to determine its parameters. For each parameter the corresponding value is retrieved from args. If a parameter is not found in args callable has a default value for that parameter, the default value is retrieved.
getargs returns a list of actual argument values that would be passed to callable.
Types of callables supported
calllib supports any callable written in Python. This includes functions, bound and unbound methods, classes, and object instances with __call__ members.
Because they are not introspectable by the inspect module, built in Python functions such as len cannot be used with apply.
Default arguments
Functions with default arguments are fully supported by calllib. If an argument is not specified in the args parameter to apply and it has a default, the default value will be used.
Change log
1.0 2011-11-10 Eric V. Smith
Finalized API.
Added tests for derived classes.
0.2 2011-11-10 Eric V. Smith
Allow for classes with no __init__ method.
Normalize test names.
0.1 2011-11-09 Eric V. Smith
Initial release.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file calllib-1.0.tar.gz
.
File metadata
- Download URL: calllib-1.0.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51c5c9ba4f03e3b357b4c8b99eb8e17bb11a7aefebe73d720271974ed7557a5b |
|
MD5 | 245dbb0681a1341ba12f5dba893777c3 |
|
BLAKE2b-256 | 7557998a0031f635ed433203ea38aeeb91466f5763e2db9ec67e459f33f02919 |