将方法添加到现有对象实例

时间:2008-08-04 02:17:52

标签: python oop methods monkeypatching

我已经读过可以在Python中向现有对象(即不在类定义中)添加方法。

我知道这样做并不总是好事。但是人们怎么可能这样做呢?

18 个答案:

答案 0 :(得分:829)

在Python中,函数和绑定方法之间存在差异。

>>> def foo():
...     print "foo"
...
>>> class A:
...     def bar( self ):
...         print "bar"
...
>>> a = A()
>>> foo
<function foo at 0x00A98D70>
>>> a.bar
<bound method A.bar of <__main__.A instance at 0x00A9BC88>>
>>>

绑定方法已经被绑定(如何描述)一个实例,并且只要调用该方法,该实例就会作为第一个参数传递。

作为类属性(与实例相对)的可调用对象仍然是未绑定的,因此您可以随时修改类定义:

>>> def fooFighters( self ):
...     print "fooFighters"
...
>>> A.fooFighters = fooFighters
>>> a2 = A()
>>> a2.fooFighters
<bound method A.fooFighters of <__main__.A instance at 0x00A9BEB8>>
>>> a2.fooFighters()
fooFighters

以前定义的实例也会更新(只要它们没有覆盖属性本身):

>>> a.fooFighters()
fooFighters

如果要将方法附加到单个实例,则会出现问题:

>>> def barFighters( self ):
...     print "barFighters"
...
>>> a.barFighters = barFighters
>>> a.barFighters()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: barFighters() takes exactly 1 argument (0 given)

当函数直接附加到实例时,该函数不会自动绑定:

>>> a.barFighters
<function barFighters at 0x00A98EF0>

要绑定它,我们可以使用MethodType function in the types module

>>> import types
>>> a.barFighters = types.MethodType( barFighters, a )
>>> a.barFighters
<bound method ?.barFighters of <__main__.A instance at 0x00A9BC88>>
>>> a.barFighters()
barFighters

这次班级的其他实例没有受到影响:

>>> a2.barFighters()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: A instance has no attribute 'barFighters'

通过阅读descriptorsmetaclass programming,可以找到更多信息。

答案 1 :(得分:91)

模块 new 自python 2.6以来已被弃用,并在3.0中删除,使用类型

请参阅http://docs.python.org/library/new.html

在下面的示例中,我故意从patch_me()函数中删除了返回值。 我认为给出返回值可能会让人相信补丁返回一个新对象,这不是真的 - 它会修改传入的对象。可能这有助于更有纪律地使用monkeypatching。

import types

class A(object):#but seems to work for old style objects too
    pass

def patch_me(target):
    def method(target,x):
        print "x=",x
        print "called from", target
    target.method = types.MethodType(method,target)
    #add more if needed

a = A()
print a
#out: <__main__.A object at 0x2b73ac88bfd0>  
patch_me(a)    #patch instance
a.method(5)
#out: x= 5
#out: called from <__main__.A object at 0x2b73ac88bfd0>
patch_me(A)
A.method(6)        #can patch class too
#out: x= 6
#out: called from <class '__main__.A'>

答案 2 :(得分:67)

前言 - 关于兼容性的说明:其他答案可能只适用于Python 2 - 这个答案应该在Python 2和3中运行得非常好。如果只编写Python 3,你可能会遗漏明确继承自object,但否则代码应该保持不变。

  

将方法添加到现有对象实例

     

我已经读过可以在Python中向现有对象(例如,不在类定义中)添加方法。

     

我知道这样做并不总是一个好的决定。 但是,人们怎么可能这样做?

是的,有可能 - 但不推荐

我不推荐这个。这是一个坏主意。不要这样做。

以下是几个原因:

  • 您将为每个执行此操作的实例添加绑定对象。如果你经常这么做,你可能会浪费很多记忆。绑定方法通常仅在其调用的短持续时间内创建,然后在自动垃圾收集时停止存在。如果您手动执行此操作,则您将具有引用绑定方法的名称绑定 - 这将阻止其在使用时进行垃圾回收。
  • 给定类型的对象实例通常在该类型的所有对象上都有其方法。如果在其他地方添加方法,则某些实例将具有这些方法,而其他实例则不会。程序员不会期望这样做,并且您可能会违反rule of least surprise
  • 由于还有其他很好的理由不这样做,如果你这样做,你还会给自己一个不好的声誉。

因此,我建议你不要这样做,除非你有充分的理由。 最好在类定义中定义正确的方法 less ,最好直接对类进行修补,如下所示:

Foo.sample_method = sample_method

然而,既然它具有启发性,我将向您展示一些方法。

如何做到

这里有一些设置代码。我们需要一个类定义。它可以导入,但它确实无关紧要。

class Foo(object):
    '''An empty class to demonstrate adding a method to an instance'''

创建一个实例:

foo = Foo()

创建一个添加到其中的方法:

def sample_method(self, bar, baz):
    print(bar + baz)

方法无效(0) - 使用描述符方法__get__

函数上的虚线查找使用实例调用函数的__get__方法,将对象绑定到方法,从而创建一个绑定方法。&#34;

foo.sample_method = sample_method.__get__(foo)

现在:

>>> foo.sample_method(1,2)
3

方法一 - types.MethodType

首先,导入类型,我们将从中获取方法构造函数:

import types

现在我们将该方法添加到实例中。为此,我们需要types模块中的MethodType构造函数(我们在上面导入)。

types.MethodType的参数签名是(function, instance, class)

foo.sample_method = types.MethodType(sample_method, foo, Foo)

和用法:

>>> foo.sample_method(1,2)
3

方法二:词法绑定

首先,我们创建一个包装函数,将方法绑定到实例:

def bind(instance, method):
    def binding_scope_fn(*args, **kwargs): 
        return method(instance, *args, **kwargs)
    return binding_scope_fn

用法:

>>> foo.sample_method = bind(foo, sample_method)    
>>> foo.sample_method(1,2)
3

方法三:functools.partial

部分函数将第一个参数应用于函数(以及可选的关键字参数),稍后可以使用其余参数调用(并覆盖关键字参数)。因此:

>>> from functools import partial
>>> foo.sample_method = partial(sample_method, foo)
>>> foo.sample_method(1,2)
3    

当您认为绑定方法是实例的部分函数时,这是有意义的。

未绑定功能作为对象属性 - 为什么这不起作用:

如果我们尝试以与将它添加到类相同的方式添加sample_method,它将从实例中解除绑定,并且不会将隐式self作为第一个参数。

>>> foo.sample_method = sample_method
>>> foo.sample_method(1,2)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: sample_method() takes exactly 3 arguments (2 given)

我们可以通过显式传递实例(或任何东西,因为这个方法实际上并没有使用self参数变量)来使未绑定函数工作,但它与预期的签名不一致其他实例(如果我们正在修补此实例):

>>> foo.sample_method(foo, 1, 2)
3

结论

您现在已经了解了可以做到这一点的几种方法,但严肃地说 - 不要这样做。

答案 3 :(得分:32)

我认为上述答案错过了关键点。

让我们有一个方法:

class A(object):
    def m(self):
        pass

现在,让我们在ipython中使用它:

In [2]: A.m
Out[2]: <unbound method A.m>

好的,所以 m()会以某种方式成为 A 的未绑定方法。但它真的是那样的吗?

In [5]: A.__dict__['m']
Out[5]: <function m at 0xa66b8b4>

事实证明 m()只是一个函数,它的引用被添加到 A 类字典中 - 没有什么魔力。那么为什么 A.m 给我们一个未绑定的方法?这是因为点不会转换为简单的字典查找。事实上,调用A .__ class __.__ getattribute __(A,'m'):

In [11]: class MetaA(type):
   ....:     def __getattribute__(self, attr_name):
   ....:         print str(self), '-', attr_name

In [12]: class A(object):
   ....:     __metaclass__ = MetaA

In [23]: A.m
<class '__main__.A'> - m
<class '__main__.A'> - m

现在,我不确定为什么最后一行打印两次,但仍然很清楚那里发生了什么。

现在,默认的__getattribute__所做的是它检查该属性是否是所谓的descriptor,即它是否实现了一个特殊的__get__方法。如果它实现了该方法,那么返回的是调用__get__方法的结果。回到我们的 A 类的第一个版本,这就是我们所拥有的:

In [28]: A.__dict__['m'].__get__(None, A)
Out[28]: <unbound method A.m>

因为Python函数实现了描述符协议,如果它们代表一个对象被调用,它们会在__get__方法中将它们绑定到该对象。

好的,那么如何将方法添加到现有对象?假设您不介意修补类,它就像:

一样简单
B.m = m

然后 B.m “成为”一个未绑定的方法,这要归功于描述符魔术。

如果你想只为一个对象添加一个方法,那么你必须使用types.MethodType:

自己模拟机器。
b.m = types.MethodType(m, b)

顺便说一下:

In [2]: A.m
Out[2]: <unbound method A.m>

In [59]: type(A.m)
Out[59]: <type 'instancemethod'>

In [60]: type(b.m)
Out[60]: <type 'instancemethod'>

In [61]: types.MethodType
Out[61]: <type 'instancemethod'>

答案 4 :(得分:16)

在Python中,猴子修补通常可以通过用自己的方法覆盖类或函数签名来实现。以下是Zope Wiki

中的示例
from SomeOtherProduct.SomeModule import SomeClass
def speak(self):
   return "ook ook eee eee eee!"
SomeClass.speak = speak

该代码将覆盖/创建一个名为speak的方法。在杰夫阿特伍德的recent post on monkey patching。他在C#3.0中展示了一个例子,它是我用于工作的当前语言。

答案 5 :(得分:9)

至少有两种方法可以将方法附加到没有types.MethodType的实例:

>>> class A:
...  def m(self):
...   print 'im m, invoked with: ', self

>>> a = A()
>>> a.m()
im m, invoked with:  <__main__.A instance at 0x973ec6c>
>>> a.m
<bound method A.m of <__main__.A instance at 0x973ec6c>>
>>> 
>>> def foo(firstargument):
...  print 'im foo, invoked with: ', firstargument

>>> foo
<function foo at 0x978548c>

1:

>>> a.foo = foo.__get__(a, A) # or foo.__get__(a, type(a))
>>> a.foo()
im foo, invoked with:  <__main__.A instance at 0x973ec6c>
>>> a.foo
<bound method A.foo of <__main__.A instance at 0x973ec6c>>

2:

>>> instancemethod = type(A.m)
>>> instancemethod
<type 'instancemethod'>
>>> a.foo2 = instancemethod(foo, a, type(a))
>>> a.foo2()
im foo, invoked with:  <__main__.A instance at 0x973ec6c>
>>> a.foo2
<bound method instance.foo of <__main__.A instance at 0x973ec6c>>

有用的链接:
Data model - invoking descriptors
Descriptor HowTo Guide - invoking descriptors

答案 6 :(得分:8)

您可以使用lambda将方法绑定到实例:

def run(self):
    print self._instanceString

class A(object):
    def __init__(self):
        self._instanceString = "This is instance string"

a = A()
a.run = lambda: run(a)
a.run()

输出:

This is instance string

答案 7 :(得分:6)

由于这个问题要求非Python版本,这里是JavaScript:

a.methodname = function () { console.log("Yay, a new method!") }

答案 8 :(得分:6)

我相信你正在寻找的是setattr。 用它来设置对象的属性。

>>> def printme(s): print repr(s)
>>> class A: pass
>>> setattr(A,'printme',printme)
>>> a = A()
>>> a.printme() # s becomes the implicit 'self' variable
< __ main __ . A instance at 0xABCDEFG>

答案 9 :(得分:5)

整合Jason Pratt和社区维基的答案,看看不同绑定方法的结果:

特别注意如何将绑定函数添加为类方法 ,但引用范围不正确。

#!/usr/bin/python -u
import types
import inspect

## dynamically adding methods to a unique instance of a class


# get a list of a class's method type attributes
def listattr(c):
    for m in [(n, v) for n, v in inspect.getmembers(c, inspect.ismethod) if isinstance(v,types.MethodType)]:
        print m[0], m[1]

# externally bind a function as a method of an instance of a class
def ADDMETHOD(c, method, name):
    c.__dict__[name] = types.MethodType(method, c)

class C():
    r = 10 # class attribute variable to test bound scope

    def __init__(self):
        pass

    #internally bind a function as a method of self's class -- note that this one has issues!
    def addmethod(self, method, name):
        self.__dict__[name] = types.MethodType( method, self.__class__ )

    # predfined function to compare with
    def f0(self, x):
        print 'f0\tx = %d\tr = %d' % ( x, self.r)

a = C() # created before modified instnace
b = C() # modified instnace


def f1(self, x): # bind internally
    print 'f1\tx = %d\tr = %d' % ( x, self.r )
def f2( self, x): # add to class instance's .__dict__ as method type
    print 'f2\tx = %d\tr = %d' % ( x, self.r )
def f3( self, x): # assign to class as method type
    print 'f3\tx = %d\tr = %d' % ( x, self.r )
def f4( self, x): # add to class instance's .__dict__ using a general function
    print 'f4\tx = %d\tr = %d' % ( x, self.r )


b.addmethod(f1, 'f1')
b.__dict__['f2'] = types.MethodType( f2, b)
b.f3 = types.MethodType( f3, b)
ADDMETHOD(b, f4, 'f4')


b.f0(0) # OUT: f0   x = 0   r = 10
b.f1(1) # OUT: f1   x = 1   r = 10
b.f2(2) # OUT: f2   x = 2   r = 10
b.f3(3) # OUT: f3   x = 3   r = 10
b.f4(4) # OUT: f4   x = 4   r = 10


k = 2
print 'changing b.r from {0} to {1}'.format(b.r, k)
b.r = k
print 'new b.r = {0}'.format(b.r)

b.f0(0) # OUT: f0   x = 0   r = 2
b.f1(1) # OUT: f1   x = 1   r = 10  !!!!!!!!!
b.f2(2) # OUT: f2   x = 2   r = 2
b.f3(3) # OUT: f3   x = 3   r = 2
b.f4(4) # OUT: f4   x = 4   r = 2

c = C() # created after modifying instance

# let's have a look at each instance's method type attributes
print '\nattributes of a:'
listattr(a)
# OUT:
# attributes of a:
# __init__ <bound method C.__init__ of <__main__.C instance at 0x000000000230FD88>>
# addmethod <bound method C.addmethod of <__main__.C instance at 0x000000000230FD88>>
# f0 <bound method C.f0 of <__main__.C instance at 0x000000000230FD88>>

print '\nattributes of b:'
listattr(b)
# OUT:
# attributes of b:
# __init__ <bound method C.__init__ of <__main__.C instance at 0x000000000230FE08>>
# addmethod <bound method C.addmethod of <__main__.C instance at 0x000000000230FE08>>
# f0 <bound method C.f0 of <__main__.C instance at 0x000000000230FE08>>
# f1 <bound method ?.f1 of <class __main__.C at 0x000000000237AB28>>
# f2 <bound method ?.f2 of <__main__.C instance at 0x000000000230FE08>>
# f3 <bound method ?.f3 of <__main__.C instance at 0x000000000230FE08>>
# f4 <bound method ?.f4 of <__main__.C instance at 0x000000000230FE08>>

print '\nattributes of c:'
listattr(c)
# OUT:
# attributes of c:
# __init__ <bound method C.__init__ of <__main__.C instance at 0x0000000002313108>>
# addmethod <bound method C.addmethod of <__main__.C instance at 0x0000000002313108>>
# f0 <bound method C.f0 of <__main__.C instance at 0x0000000002313108>>

就个人而言,我更喜欢外部ADDMETHOD函数路由,因为它允许我在迭代器中动态分配新的方法名称。

def y(self, x):
    pass
d = C()
for i in range(1,5):
    ADDMETHOD(d, y, 'f%d' % i)
print '\nattributes of d:'
listattr(d)
# OUT:
# attributes of d:
# __init__ <bound method C.__init__ of <__main__.C instance at 0x0000000002303508>>
# addmethod <bound method C.addmethod of <__main__.C instance at 0x0000000002303508>>
# f0 <bound method C.f0 of <__main__.C instance at 0x0000000002303508>>
# f1 <bound method ?.y of <__main__.C instance at 0x0000000002303508>>
# f2 <bound method ?.y of <__main__.C instance at 0x0000000002303508>>
# f3 <bound method ?.y of <__main__.C instance at 0x0000000002303508>>
# f4 <bound method ?.y of <__main__.C instance at 0x0000000002303508>>

答案 10 :(得分:5)

你们应该真正看看forbidden fruit,它是一个python库,它支持猴子修补任何python类,甚至是字符串。

答案 11 :(得分:5)

这实际上是&#34; Jason Pratt&#34;

答案的补充

尽管Jasons的回答有效,但只有在想要向类中添加函数时它才有效。 当我尝试从.py源代码文件重新加载现有方法时,它对我不起作用。

我花了很长时间才找到解决方法,但诀窍似乎很简单...... 1.st从源代码文件中导入代码 2.强行重装 3.rd使用types.FunctionType(...)将导入和绑定的方法转换为函数 您还可以传递当前的全局变量,因为重新加载的方法将位于不同的命名空间中 现在你可以继续按照#34; Jason Pratt&#34;   使用types.MethodType(...)

示例:

# this class resides inside ReloadCodeDemo.py
class A:
    def bar( self ):
        print "bar1"

    def reloadCode(self, methodName):
        ''' use this function to reload any function of class A'''
        import types
        import ReloadCodeDemo as ReloadMod # import the code as module
        reload (ReloadMod) # force a reload of the module
        myM = getattr(ReloadMod.A,methodName) #get reloaded Method
        myTempFunc = types.FunctionType(# convert the method to a simple function
                                myM.im_func.func_code, #the methods code
                                globals(), # globals to use
                                argdefs=myM.im_func.func_defaults # default values for variables if any
                                ) 
        myNewM = types.MethodType(myTempFunc,self,self.__class__) #convert the function to a method
        setattr(self,methodName,myNewM) # add the method to the function

if __name__ == '__main__':
    a = A()
    a.bar()
    # now change your code and save the file
    a.reloadCode('bar') # reloads the file
    a.bar() # now executes the reloaded code

答案 12 :(得分:3)

如果它可以提供任何帮助,我最近发布了一个名为Gorilla的Python库,使猴子修补过程更加方便。

使用函数needle()修补名为guineapig的模块,如下所示:

import gorilla
import guineapig
@gorilla.patch(guineapig)
def needle():
    print("awesome")

但它也会处理更有趣的用例,如FAQ中的documentation所示。

该代码可在GitHub上找到。

答案 13 :(得分:3)

Jason Pratt发布的内容是正确的。

>>> class Test(object):
...   def a(self):
...     pass
... 
>>> def b(self):
...   pass
... 
>>> Test.b = b
>>> type(b)
<type 'function'>
>>> type(Test.a)
<type 'instancemethod'>
>>> type(Test.b)
<type 'instancemethod'>

正如您所看到的,Python并不认为b()与a()有任何不同。在Python中,所有方法都只是恰好是函数的变量。

答案 14 :(得分:2)

我觉得很奇怪,没有人提到上面列出的所有方法都在添加的方法和实例之间创建了一个循环引用,导致对象持久化直到垃圾回收。有一个老技巧通过扩展对象的类来添加描述符:

malloc

答案 15 :(得分:2)

这个问题在几年前就开始了,但是,嘿,有一个简单的方法来模拟使用装饰器将函数绑定到类实例:

def binder (function, instance):
  copy_of_function = type (function) (function.func_code, {})
  copy_of_function.__bind_to__ = instance
  def bound_function (*args, **kwargs):
    return copy_of_function (copy_of_function.__bind_to__, *args, **kwargs)
  return bound_function


class SupaClass (object):
  def __init__ (self):
    self.supaAttribute = 42


def new_method (self):
  print self.supaAttribute


supaInstance = SupaClass ()
supaInstance.supMethod = binder (new_method, supaInstance)

otherInstance = SupaClass ()
otherInstance.supaAttribute = 72
otherInstance.supMethod = binder (new_method, otherInstance)

otherInstance.supMethod ()
supaInstance.supMethod ()

当你将函数和实例传递给binder装饰器时,它将创建一个新函数,其代码对象与第一个相同。然后,类的给定实例存储在新创建的函数的属性中。装饰器返回一个(第三个)函数,自动调用复制的函数,将实例作为第一个参数。   
  
总之,您将获得一个模拟它与类实例绑定的函数。让原始函数保持不变。

答案 16 :(得分:2)

from types import MethodType

def method(self):
   print 'hi!'


setattr( targetObj, method.__name__, MethodType(method, targetObj, type(method)) )

有了这个,你可以使用自我指针

答案 17 :(得分:0)

除了其他人说的话,我发现__repr____str__方法无法在对象级别上进行猴子修补,因为repr()str()使用类方法,不是局部对象方法:

# Instance monkeypatch
[ins] In [55]: x.__str__ = show.__get__(x)                                                                 

[ins] In [56]: x                                                                                           
Out[56]: <__main__.X at 0x7fc207180c10>

[ins] In [57]: str(x)                                                                                      
Out[57]: '<__main__.X object at 0x7fc207180c10>'

[ins] In [58]: x.__str__()                                                                                 
Nice object!

# Class monkeypatch
[ins] In [62]: X.__str__ = lambda _: "From class"                                                          

[ins] In [63]: str(x)                                                                                      
Out[63]: 'From class'