Differences between revisions 1 and 2
Revision 1 as of 2005-05-05 02:23:10
Size: 1496
Editor: G9389
Comment:
Revision 2 as of 2005-05-05 02:25:55
Size: 1506
Editor: G9389
Comment:
Deletions are marked like this. Additions are marked like this.
Line 13: Line 13:
{{{#python {{{#!python
Line 25: Line 25:
{{{#python {{{#!python
Line 38: Line 38:
{{{ {{{#!python

FunctionWrapper is a design pattern used when dealing with relatively complicated functions. The wrapper function typically performs some prologue and epilogue tasks like

  • allocating and disposing resources
  • checking pre- and post-conditions
  • caching / recycling a result of a slow computation

but otherwise it should be fully compatible with the wrapped function, so it can be used instead of it. (This is related to the DecoratorPattern.)

As of Python 2.1 and the introduction of nested scopes, wrapping a function is easy:

Toggle line numbers
   1 def wrap(func, pre, post):
   2    def call(*args, **kwargs):
   3       pre(func, *args, **kwargs)
   4       result = func(*args, **kwargs)
   5       post(func, *args, **kwargs)
   6       return result
   7    return call

Now, let's wrap something up:

Toggle line numbers
   1 def trace_in(func, *args, **kwargs):
   2    print "Entering function",  func.__name__
   3 
   4 def trace_out(func, *args, **kwargs):
   5    print "Leaving function", func.__name__
   6 
   7 def calc(x, y):
   8    return x + y

The wrapping effect is:

Toggle line numbers
   1 >>> f = wrap(calc, trace_in, trace_out)
   2 >>> print calc(1, 2)
   3 3
   4 >>> print f(1, 2)
   5 Entering function calc
   6 Leaving function calc
   7 3

Of course, a wrapper would normally perform some more useful task. Have a look [http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/412719 here] for a recipe how to wrap a function that processes files so that the result is recycled from a cache file if appropriate.

FunctionWrappers (last edited 2008-11-15 14:00:47 by localhost)

Unable to edit the page? See the FrontPage for instructions.