Добавление метода в существующий экземпляр объекта - PullRequest
552 голосов
/ 04 августа 2008

Я читал, что в Python возможно добавить метод к существующему объекту (т.е. не в определении класса).

Я понимаю, что это не всегда хорошо. Но как можно это сделать?

Ответы [ 17 ]

829 голосов
/ 06 августа 2008

В 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 в модуле типов :

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

Дополнительную информацию можно найти, прочитав о дескрипторах и метакласс программировании .

91 голосов
/ 06 июня 2009

Модуль новый устарел с python 2.6 и удален в 3.0, используйте types

см. http://docs.python.org/library/new.html

В следующем примере я намеренно удалил возвращаемое значение из функции patch_me(). Я думаю, что возвращаемое значение может заставить поверить, что patch возвращает новый объект, который не соответствует действительности - он изменяет входящий. Вероятно, это может способствовать более дисциплинированному использованию обезьяноподготовки.

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'>
67 голосов
/ 21 января 2015

Предисловие - примечание о совместимости: другие ответы могут работать только в Python 2 - этот ответ должен прекрасно работать в Python 2 и 3. Если вы пишете только Python 3, вы можете явно не наследовать от object, но в противном случае код должен остаться прежним.

Добавление метода к существующему экземпляру объекта

Я читал, что в Python можно добавить метод к существующему объекту (например, не в определении класса).

Я понимаю, что это не всегда хорошее решение. Но как можно это сделать?

Да, это возможно - но не рекомендуется

Я не рекомендую это. Это плохая идея. Не делай этого.

Вот несколько причин:

  • Вы будете добавлять связанный объект к каждому экземпляру, с которым вы это делаете. Если вы делаете это много, вы, вероятно, будете тратить много памяти. Связанные методы обычно создаются только на короткое время их вызова, и затем они перестают существовать, когда автоматически собирается мусор. Если вы сделаете это вручную, у вас будет привязка имени, ссылающаяся на связанный метод - что предотвратит его сборку мусора при использовании.
  • Экземпляры объектов данного типа обычно имеют свои методы для всех объектов этого типа. Если вы добавите методы в другом месте, некоторые экземпляры будут иметь эти методы, а другие - нет. Программисты этого не ожидают, и вы рискуете нарушить правило малейшего удивления .
  • Поскольку есть другие действительно веские причины не делать этого, вы также дадите себе плохую репутацию, если сделаете это.

Таким образом, я предлагаю вам не делать этого, если у вас нет действительно веской причины. Гораздо лучше определить правильный метод в определении класса или 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)

Method naught (0) - использовать метод дескриптора, __get__

Пунктирный поиск функций вызывает метод функции __get__ с экземпляром, привязывая объект к методу и создавая, таким образом, «связанный метод».

foo.sample_method = sample_method.__get__(foo)

и сейчас:

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

Метод первый - types.MethodType

Сначала импортируем типы, из которых мы получим конструктор метода:

import types

Теперь мы добавляем метод к экземпляру. Для этого нам требуется конструктор MethodType из модуля types (который мы импортировали выше).

Сигнатура аргумента для 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

Заключение

Теперь вы знаете несколько способов, которыми вы могли бы сделать это, но со всей серьезностью - не делайте этого.

32 голосов
/ 22 января 2012

Я думаю, что вышеупомянутые ответы упустили ключевой момент.

Давайте иметь класс с методом:

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 .__ __.__ 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__ по умолчанию проверяет, является ли атрибут так называемым дескриптором 1028 * или нет, т.е. реализует ли он специальный метод __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'>
16 голосов
/ 04 августа 2008

В Python исправление обезьяны обычно работает путем перезаписи сигнатуры класса или функции вашей собственной. Ниже приведен пример из Zope Wiki :

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

Этот код перезапишет / создаст метод с именем talk в классе. В недавнем сообщении Джеффа Этвуда об исправлении обезьян . Он показывает пример в C # 3.0, который является текущим языком, который я использую для работы.

9 голосов
/ 26 апреля 2013

Существует как минимум два способа присоединить метод к экземпляру без 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>>

Полезные ссылки:
Модель данных - вызов дескрипторов
Руководство по дескриптору - вызов дескрипторов

8 голосов
/ 21 июля 2014

Вы можете использовать лямбду для привязки метода к экземпляру:

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
6 голосов
/ 07 августа 2008

То, что вы ищете, это 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>
6 голосов
/ 09 марта 2012

Поскольку этот вопрос задан для не-Python версий, вот JavaScript:

a.methodname = function () { console.log("Yay, a new method!") }
5 голосов
/ 18 августа 2015

Это на самом деле дополнение к ответу "Джейсон Пратт"

Хотя ответ Jasons работает, он работает, только если кто-то хочет добавить функцию в класс. У меня не получилось, когда я попытался перезагрузить уже существующий метод из файла с исходным кодом .py.

Мне потребовались целую вечность, чтобы найти обходной путь, но трюк кажется простым ... 1.st импортировать код из файла исходного кода 2. и перезарядить 3.rd использовать types.FunctionType (...) для преобразования импортированного и связанного метода в функцию Вы также можете передать текущие глобальные переменные, так как перезагруженный метод будет находиться в другом пространстве имен. 4. Теперь вы можете продолжить, как предложено "Джейсоном Праттом". используя 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
...