Как получить себя в метод Python, не принимая его явно - PullRequest
8 голосов
/ 11 августа 2010

Я разрабатываю среду тестирования документации - в основном модульные тесты для PDF-файлов.Тесты - это (оформленные) методы экземпляров классов, определенных платформой, которые находятся и создаются во время выполнения, а методы вызываются для выполнения тестов.

Моя цель - сократить количество необычныхСинтаксис Python, о котором должны заботиться люди, которые будут писать тесты, так как эти люди могут быть, а могут и не быть программистами Python или даже очень многими программистами.Поэтому я хотел бы, чтобы они могли писать «def foo ():» вместо «def foo (self):» для методов, но при этом иметь возможность использовать «self» для доступа к членам.

Inобычная программа, я бы посчитал это ужасной идеей, но в подобной программе, ориентированной на предметную область, похоже, стоит попробовать.

Я успешно исключил себя из сигнатуры метода, используядекоратор (на самом деле, поскольку я уже использую декоратор для тестовых случаев, я бы просто включил его в это), но «self» не ссылается ни на что в методе тестового примера.

У меня естьЯ подумал об использовании global для себя, и даже придумаю реализацию, которая более или менее работает, но я бы предпочел загрязнить наименьшее возможное пространство имен, поэтому я бы предпочел внедрить переменную непосредственно в локальное пространство имен метода тестового примера.Есть мысли?

Ответы [ 5 ]

5 голосов
/ 11 августа 2010

небольшое обновление для решения aaronasterling (у меня недостаточно репутации, чтобы комментировать):

def wrap(f):
    @functools.wraps(f)
    def wrapper(self,*arg,**kw):
        f.func_globals['self'] = self        
        return f(*arg,**kw)
    return wrapper

но оба эти решения будут работать непредсказуемо, если функция f будет вызываться рекурсивно для другого экземпляра, поэтому вы должны клонировать ее следующим образом:

import types
class wrap(object):
    def __init__(self,func):
        self.func = func
    def __get__(self,obj,type):
        new_globals = self.func.func_globals.copy()
        new_globals['self'] = obj
        return types.FunctionType(self.func.func_code,new_globals)
class C(object):
    def __init__(self,word):
        self.greeting = word
    @wrap
    def greet(name):
        print(self.greeting+' , ' + name+ '!')
C('Hello').greet('kindall')
5 голосов
/ 11 августа 2010

Мой принятый ответ на этот вопрос был довольно глуп, но я только начинал.Вот намного лучший способ.Это только немного проверено, но это хорошо для демонстрации правильного способа сделать это, а это неправильно.Работает на 2.6.5 точно.Я не тестировал никаких других версий, но в нем жестко не закодированы коды операций, поэтому он должен быть таким же переносимым, как и большинство других кодов 2.x.

add_self может быть применен в качестве декоратора, но это может нанести ущерб цели (почему бы просто не набрать «self»?) Было бы легко адаптировать метакласс из моего другого ответа, чтобы вместо этого применить эту функцию.1004 *

import opcode
import types



def instructions(code):
    """Iterates over a code string yielding integer [op, arg] pairs

    If the opcode does not take an argument, just put None in the second part
    """
    code = map(ord, code)
    i, L = 0, len(code)
    extended_arg = 0
    while i < L:
        op = code[i]
        i+= 1
        if op < opcode.HAVE_ARGUMENT:
            yield [op, None]
            continue
        oparg = code[i] + (code[i+1] << 8) + extended_arg
        extended_arg = 0
        i += 2
        if op == opcode.EXTENDED_ARG:
            extended_arg = oparg << 16
            continue
        yield [op, oparg]


def write_instruction(inst):
    """Takes an integer [op, arg] pair and returns a list of character bytecodes"""
    op, oparg = inst
    if oparg is None:
        return [chr(op)]
    elif oparg <= 65536L:
        return [chr(op), chr(oparg & 255), chr((oparg >> 8) & 255)]
    elif oparg <= 4294967296L:
        # The argument is large enough to need 4 bytes and the EXTENDED_ARG opcode
        return [chr(opcode.EXTENDED_ARG),
                chr((oparg >> 16) & 255),
                chr((oparg >> 24) & 255),
                chr(op),
                chr(oparg & 255),
                chr((oparg >> 8) & 255)]
    else:
        raise ValueError("Invalid oparg: {0} is too large".format(oparg))


def add_self(f):
    """Add self to a method

    Creates a new function by prepending the name 'self' to co_varnames, and      
    incrementing co_argcount and co_nlocals. Increase the index of all other locals
    by 1 to compensate. Also removes 'self' from co_names and decrease the index of 
    all names that occur after it by 1. Finally, replace all occurrences of 
    `LOAD_GLOBAL i,j` that make reference to the old 'self' with 'LOAD_FAST 0,0'.   

    Essentially, just create a code object that is exactly the same but has one more
    argument. 
    """
    code_obj = f.func_code
    try:
        self_index = code_obj.co_names.index('self')
    except ValueError:
        raise NotImplementedError("self is not a global")

    # The arguments are just the first co_argcount co_varnames
    varnames = ('self', ) + code_obj.co_varnames   
    names = tuple(name for name in code_obj.co_names if name != 'self')

    code = []

    for inst in instructions(code_obj.co_code):
        op = inst[0]
        if op in opcode.haslocal:
            # The index is now one greater because we added 'self' at the head of
            # the tuple
            inst[1] += 1
        elif op in opcode.hasname:
            arg = inst[1]
            if arg == self_index:
                # This refers to the old global 'self'
                if op == opcode.opmap['LOAD_GLOBAL']:
                    inst[0] = opcode.opmap['LOAD_FAST']
                    inst[1] = 0
                else:
                    # If `self` is used as an attribute, real global, module
                    # name, module attribute, or gets looked at funny, bail out.
                    raise NotImplementedError("Abnormal use of self")
            elif arg > self_index:
                # This rewrites the index to account for the old global 'self'
                # having been removed.
                inst[1] -= 1

        code += write_instruction(inst)

    code = ''.join(code)

    # type help(types.CodeType) at the interpreter prompt for this one   
    new_code_obj = types.CodeType(code_obj.co_argcount + 1,
                                  code_obj.co_nlocals + 1,
                                  code_obj.co_stacksize,
                                  code_obj.co_flags, 
                                  code,
                                  code_obj.co_consts,
                                  names, 
                                  varnames, 
                                  '<OpcodeCity>',
                                  code_obj.co_name,  
                                  code_obj.co_firstlineno,
                                  code_obj.co_lnotab, 
                                  code_obj.co_freevars,
                                  code_obj.co_cellvars)


    # help(types.FunctionType)
    return types.FunctionType(new_code_obj, f.func_globals)



class Test(object):

    msg = 'Foo'

    @add_self
    def show(msg):
        print self.msg + msg


t = Test()
t.show('Bar')
4 голосов
/ 11 ноября 2010

Вот однострочный метод-декоратор, который, кажется, выполняет работу без изменения каких-либо специальных атрибутов типов Callable *, помеченных только для чтения :

# method decorator -- makes undeclared 'self' argument available to method
injectself = lambda f: lambda self: eval(f.func_code, dict(self=self))

class TestClass:
    def __init__(self, thing):
        self.attr = thing

    @injectself
    def method():
        print 'in TestClass::method(): self.attr = %r' % self.attr
        return 42

test = TestClass("attribute's value")
ret = test.method()
print 'return value:', ret

# output:
# in TestClass::method(): self.attr = "attribute's value"
# return value: 42

Обратите внимание, что, если вы не примете меры предосторожности, чтобы предотвратить это, побочным эффектом функции eval() может быть добавление нескольких записей, например ссылки на модуль __builtin__ под ключ __builtins__ - автоматически передается dict.

@ kendall: На ваш комментарий о том, как вы используете это с методами, находящимися в классах-контейнерах (но в данный момент игнорируете добавление дополнительных переменных) - это что-то вроде того, что вы делаете? Мне трудно понять, как вещи делятся между фреймворком и тем, что пишут пользователи. Для меня это звучит как интересный шаблон дизайна.

# method decorator -- makes undeclared 'self' argument available to method
injectself = lambda f: lambda self: eval(f.func_code, dict(self=self))

class methodclass:
    def __call__():
        print 'in methodclass::__call__(): self.attr = %r' % self.attr
        return 42

class TestClass:
    def __init__(self, thing):
        self.attr = thing

    method = injectself(methodclass.__call__)

test = TestClass("attribute's value")
ret = test.method()
print 'return value:', ret

# output
# in methodclass::__call__(): self.attr = "attribute's value"
# return value: 42
3 голосов
/ 11 августа 2010

Хитрость в том, чтобы добавить «я» к f.func_globals. Это работает в python2.6. Мне действительно нужно найти другие версии, чтобы протестировать подобные вещи. Извините за стену кода, но я рассмотрел два случая: сделать это с метаклассом и сделать с декоратором. Для вашего случая использования, я думаю, что метакласс лучше, так как весь смысл этого упражнения состоит в том, чтобы защитить пользователей от синтаксиса.

import new, functools

class TestMeta(type):
    def __new__(meta, classname, bases, classdict):
        for item in classdict:
            if hasattr(classdict[item], '__call__'):
                classdict[item] = wrap(classdict[item])
        return type.__new__(meta, classname, bases, classdict)

def wrap(f):
    @functools.wraps(f)
    def wrapper(self):
        f.func_globals['self'] = self        
        return f()
    return wrapper

def testdec(f):
    @functools.wraps(f)
    def wrapper():
        return f()
    return wrapper

class Test(object):
    __metaclass__ = TestMeta
    message = 'You can do anything in python'
    def test():
        print self.message

    @testdec
    def test2():
        print self.message + ' but the wrapper funcion can\'t take a self argument either or you get a TypeError'

class Test2(object):
    message = 'It also works as a decorator but (to me at least) feels better as a metaclass'
    @wrap
    def test():
        print self.message


t = Test()
t2 = Test2()
t.test()
t.test2()
t2.test()
2 голосов
/ 11 августа 2010

Это может быть вариант использования для декораторов - вы даете им небольшой набор лего-кирпичей для построения функций, а сложный фреймворк передается через @testcase или что-то подобное.

Редактировать: Вы не опубликовали никакого кода, поэтому это будет отрывочно, но им не нужно писать методы. Они могут писать обычные функции без «self», и вы можете использовать декораторы, как в этом примере из статьи, на которую я ссылаюсь:

class myDecorator(object):

    def __init__(self, f):
        print "inside myDecorator.__init__()"
        f() # Prove that function definition has completed

    def __call__(self):
        print "inside myDecorator.__call__()"

@myDecorator
def aFunction():
    print "inside aFunction()"
...