python - 向现有对象实例添加方法

Question

我读过可以在 Python 中向现有对象（即不在类定义中）添加方法。

我知道这样做并不总是好的。但是如何做到这一点呢？

score 1073 · Accepted Answer

在 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>

要绑定它，我们可以使用types 模块中的 MethodType 函数：

>>> 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'

通过阅读有关描述符和元类编程可以找到更多信息。

score 135 · Accepted Answer

前言 - 关于兼容性的说明：其他答案可能仅适用于 Python 2 - 此答案在 Python 2 和 3 中应该可以很好地工作。如果只编写 Python 3，您可能会省略显式继承 from object，否则代码应该保持不变.

向现有对象实例添加方法

我读过可以在 Python 中向现有对象（例如不在类定义中）添加方法。

我知道这样做并不总是一个好的决定。但是，怎么可能做到这一点？

是的，有可能 - 但不推荐

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

这里有几个原因：

您将为执行此操作的每个实例添加一个绑定对象。如果你经常这样做，你可能会浪费很多内存。绑定方法通常仅在其调用的短时间内创建，然后在自动垃圾收集时它们不再存在。如果您手动执行此操作，您将拥有一个引用绑定方法的名称绑定 - 这将阻止其在使用时进行垃圾收集。
给定类型的对象实例通常在该类型的所有对象上都有其方法。如果您在其他地方添加方法，则某些实例将具有这些方法，而其他实例则没有。程序员不会预料到这一点，您可能会违反最小意外规则。
由于还有其他非常好的理由不这样做，所以如果你这样做，你也会给自己留下不好的名声。

因此，我建议您不要这样做，除非您有充分的理由。最好在类定义中定义正确的方法，或者直接对类进行猴子补丁，如下所示：

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)

Method naught (0) - 使用描述符方法，`get`

函数的虚线查找__get__使用实例调用函数的方法，将对象绑定到方法，从而创建“绑定方法”。

foo.sample_method = sample_method.__get__(foo)

现在：

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

方法一——types.MethodType

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

import types

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

types.MethodType（在 Python 3 中）的参数签名是(function, instance)：

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

和用法：

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

顺便说一句，在 Python 2 中，签名是(function, instance, class)：

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

方法二：词法绑定

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

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

结论

你现在知道了几种方法可以做到这一点，但说真的——不要这样做。

score 104 · Accepted Answer

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

见http://docs.python.org/library/new.html

在下面的示例中，我故意从patch_me()函数中删除了返回值。我认为给出返回值可能会让人们相信补丁返回一个新对象，这是不正确的——它修改了传入的对象。这可能有助于更规范地使用猴子补丁。

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'>

score 42 · Accepted Answer

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

让我们有一个带有方法的类：

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类字典 - 没有魔法。那为什么Am给了我们一个 unbound 方法呢？这是因为点没有被翻译成简单的字典查找。这实际上是对 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__ 所做的是检查属性是否是所谓的描述符，即它是否实现了特殊的 __get__ 方法。如果它实现了那个方法，那么返回的是调用那个 __get__ 方法的结果。回到我们A类的第一个版本，这就是我们所拥有的：

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

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

好的，那么如何向现有对象添加方法？假设您不介意修补类，它很简单：

B.m = m

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

而且，如果您只想将方法添加到单个对象，则必须自己模拟机器，使用 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'>

score 27 · Accepted Answer

在 Python 中，monkeypatching 通常通过用您自己的覆盖类或函数的签名来工作。下面是来自Zope Wiki的示例：

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

此代码将覆盖/创建speak在类中调用的方法。在 Jeff Atwood最近关于猴子补丁的帖子中，他展示了 C# 3.0 中的一个示例，这是我当前用于工作的语言。

score 18 · Accepted Answer

您可以使用 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

score 11 · Accepted Answer

至少有两种方法可以将方法附加到没有的实例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>>

有用的链接：
数据模型 - 调用描述符
 Descriptor HowTo Guide - 调用描述符

score 10 · Accepted Answer

你要找的是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>

score 7 · Accepted Answer

合并 Jason Pratt 和社区 wiki 的答案，看看不同绑定方法的结果：

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

#!/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>>

score 7 · Accepted Answer

由于这个问题要求非 Python 版本，这里是 JavaScript：

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

score 7 · Accepted Answer

这实际上是对“杰森普拉特”答案的补充

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

我花了很长时间才找到解决方法，但诀窍似乎很简单...... 1.st 从源代码文件中导入代码 2.nd 强制重新加载 3.rd 使用 types.FunctionType(...) 来转换将方法导入和绑定到函数，您还可以传递当前的全局变量，因为重新加载的方法将位于不同的命名空间 4.th 现在您可以按照“Jason Pratt”的建议继续使用 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

score 5 · Accepted Answer

这个问题是几年前提出的，但是，有一种简单的方法可以使用装饰器模拟函数与类实例的绑定：

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 装饰器时，它将创建一个新函数，其代码对象与第一个函数相同。然后，类的给定实例存储在新创建的函数的属性中。装饰器返回一个（第三个）函数，自动调用复制的函数，将实例作为第一个参数。

总之，你得到一个模拟它绑定到类实例的函数。保持原有功能不变。

score 4 · Accepted Answer

如果有帮助的话，我最近发布了一个名为 Gorilla 的 Python 库，以使猴子修补的过程更加方便。

使用函数needle()来修补名为的模块guineapig如下：

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

但它也处理更多有趣的用例，如文档中的常见问题解答中所示。

代码可在GitHub上找到。

score 4 · Accepted Answer

我觉得奇怪的是，没有人提到上面列出的所有方法都会在添加的方法和实例之间创建循环引用，从而导致对象在垃圾回收之前一直存在。有一个老技巧是通过扩展对象的类来添加描述符：

def addmethod(obj, name, func):
    klass = obj.__class__
    subclass = type(klass.__name__, (klass,), {})
    setattr(subclass, name, func)
    obj.__class__ = subclass

score 3 · Accepted Answer

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 中，所有方法都只是恰好是函数的变量。

score 3 · Accepted Answer

from types import MethodType

def method(self):
   print 'hi!'


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

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

score 0 · Accepted Answer

如何从类的实例中恢复类

class UnderWater:
    def __init__(self):
        self.net = 'underwater'

marine = UnderWater() # Instantiate the class

# Recover the class from the instance and add attributes to it.
class SubMarine(marine.__class__):  
    def __init__(self):
        super().__init__()
            self.sound = 'Sonar'
    
print(SubMarine, SubMarine.__name__, SubMarine().net, SubMarine().sound)

# Output
# (__main__.SubMarine,'SubMarine', 'underwater', 'Sonar')

score -1 · Accepted Answer

除了其他人所说的之外，我发现__repr__and__str__方法不能在对象级别进行猴子补丁，因为repr()andstr()使用类方法，而不是本地绑定的对象方法：

# 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'

python - 向现有对象实例添加方法

18 回答 18

向现有对象实例添加方法