calllib 1.4

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
>>> 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': 'noon', 'reason': 'abort'}
>>> for callback in callbacks:
...    calllib.apply(callback, args)  # execute each callback
callback1 called at: noon
callback2 called at: noon reason: abort

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.

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.

Testing

To test, run ‘python setup.py test’. On python >= 3.0, this also runs the doctests.

Change log