Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to wrap (monkey patch) @classmethod

I want to monkey patch one single classmethod, keeping old functionality. Consider my code to get the idea. Here is my code (pretty synthetic example).

#!/usr/bin/env python

class A:

  @classmethod
  def foo(kls, param):
    print 'A.foo called, param is ' + param

  def bar(self, param):
    print 'A.bar called, param is ' + param


a = A()
a.foo('param_foo')
a.bar('param_bar')

# Patching things

def bar_wrapper(wrapped_func):
  def _w(*args, **kwargs):
    print '<bar_wrap>'
    wrapped_func(*args, **kwargs)
    print '</bar_wrap>'
  return _w

def foo_wrapper(wrapped_func):
  # Something missing here?
  def _w(*args, **kwargs):
    print '<foo_wrap>'
    wrapped_func(*args, **kwargs)
    print '</foo_wrap>'
  return _w

# Everything is pretty ok
A.bar = bar_wrapper(A.bar)
a.bar('is_is_wrapped?')

# Failed to wrap @classmethod
A.foo = foo_wrapper(A.foo)
A.foo('another_wrap_test')

This is what I expect to output:

A.foo called, param is param_foo
A.bar called, param is param_bar
<bar_wrap>
A.bar called, param is is_is_wrapped?
</bar_wrap>
<foo_wrap>
A.foo called, param is another_wrap_test
</foo_wrap>

And this is what I get:

A.foo called, param is param_foo
A.bar called, param is param_bar
<bar_wrap>
A.bar called, param is is_is_wrapped?
</bar_wrap>
Traceback (most recent call last):
  File "./pytest.py", line 39, in <module>
    A.foo('another_wrap_test')
TypeError: unbound method _w() must be called with A instance as first argument (got str instance instead)

Seems like one parameter (class-param) was lost during wrapping. Or I just don't the idea of decorating functions?

Thanks in advance.

like image 953
defance Avatar asked Nov 21 '13 12:11

defance


People also ask

Where do I put my monkey patch?

There is no set rule on this. Technically you can open it (the class; and add your method) anywhere. I usually make a special file called monkey_patches. rb and put it in config/initializers or in a misc folder in my Rails app so if theres ever a conflict I know where to look.

What is monkey patching give example?

In Python, the term monkey patch refers to dynamic (or run-time) modifications of a class or module. In Python, we can actually change the behavior of code at run-time. We use above module (monk) in below code and change behavior of func() at run-time by assigning different value.

Why is it called monkey patching?

Etymology. The term monkey patch seems to have come from an earlier term, guerrilla patch, which referred to changing code sneakily – and possibly incompatibly with other such patches – at runtime. The word guerrilla, nearly homophonous with gorilla, became monkey, possibly to make the patch sound less intimidating.

When to use monkey patching in Python?

While working on a real-time project, it might so happen that the third-party library is not working well. In order to change it from our project end, monkey patching becomes very useful. With monkey patching, we tend to change a particular code at runtime so that it behaves differently.


1 Answers

When you access a method on a class, it is wrapped at that moment; methods act as descriptors here.

You may want to unwrap the method again, returning a wrapped wrapper:

def foo_wrapper(wrapped_func):
    wrapped_func = wrapped_func.__func__
    def _w(*args, **kwargs):
        print '<foo_wrap>'
        wrapped_func(*args, **kwargs)
        print '</foo_wrap>'
    return classmethod(_w)

Now the returned decorator is itself a class method, and wrapping works:

>>> class A:
...     @classmethod
...     def foo(kls, param):
...         print 'A.foo called, param is ' + param
... 
>>> def foo_wrapper(wrapped_func):
...     wrapped_func = wrapped_func.__func__
...     def _w(*args, **kwargs):
...         print '<foo_wrap>'
...         wrapped_func(*args, **kwargs)
...         print '</foo_wrap>'
...     return classmethod(_w)
... 
>>> A.foo = foo_wrapper(A.foo)
>>> A.foo('bar')
<foo_wrap>
A.foo called, param is bar
</foo_wrap>
like image 167
Martijn Pieters Avatar answered Sep 18 '22 09:09

Martijn Pieters