Как бы вы написали @debuggable декоратор на python? - PullRequest
Новая
       16

Как бы вы написали @debuggable декоратор на python?

8 голосов
/ 14 мая 2009

При отладке мне нравится распечатывать все входы и выходы функции (я знаю, что мне нужна лучшая IDE, но, к сожалению, это может быть использовано для отчетов об ошибках) Итак, в идеале я хотел бы иметь: 

@debuggable
def myfunc(argA,argB,argC):
    return argB+1

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

Лучшее, что я могу придумать: 

DEBUG = True

def debuggable(func):
    if DEBUG:
        def decorated(*args):
            print "Entering ",func.func_name
            print "    args ",args
            ret = func(*args)
            print ret
            return ret
        return decorated
    else:
        return func

@debuggable
def myfunc(this,that):
    return this+that

И работает: 

>>> myfunc(1,3)
Entering  myfunc
   args  (1, 3)
4

Как я могу улучшить это?

Ответы [ 4 ]

22 голосов
/ 14 мая 2009

Используйте отладчик. Шутки в сторону. Украшение каждой функции, которую вы хотите отслеживать, - плохая идея.

Python включает отладчик , поэтому вам не нужна хорошая IDE.

Если вы не хотите использовать отладчик, вы можете использовать функцию trace . 

import sys

@sys.settrace
def trace_debug(frame, event, arg):
    if event == 'call':
        print ("calling %r on line %d, vars: %r" % 
                (frame.f_code.co_name, 
                 frame.f_lineno,
                 frame.f_locals))
        return trace_debug
    elif event == "return":
        print "returning", arg

def fun1(a, b):
    return a + b

print fun1(1, 2)

Это печатает: 

calling 'fun1' on line 14, vars: {'a': 1, 'b': 2}
returning 3
3

Еще проще было бы использовать Winpdb :

Это графический отладчик GPL Python, независимый от платформы , с поддержкой удаленной отладки по сети, несколькими потоками, модификацией пространства имен, встроенной отладкой, шифрованной связью и в 20 раз быстрее, чем pdb.

Особенности:

  • Лицензия GPL. Winpdb - свободное программное обеспечение.
  • Совместимо с CPython 2.3 или новее.
  • Совместимо с wxPython 2.6 или новее.
  • Независимо от платформы и протестировано на Ubuntu Gutsy и Windows XP.
  • Пользовательские интерфейсы: rpdb2 основан на консоли, в то время как winpdb требует wxPython 2.6 или новее

Screenshot
(источник: winpdb.org )

10 голосов
/ 14 мая 2009

Я думаю, что вы ищете не декоратор отладки, а декоратор журналирования.

Возможно, имеет смысл использовать Модуль ведения журналов Python , чтобы вы могли иметь более точный контроль над самой регистрацией. Например, вы сможете выводить в файл для последующего анализа вывода.

Тогда декоратор может выглядеть примерно так: 


import logging

logger = logging.getLogger('TraceLog')
# TODO configure logger to write to file/stdout etc, it's level etc


def logthis(level):
    def _decorator(fn):
        def _decorated(*arg,**kwargs):
            logger.log(level, "calling '%s'(%r,%r)", fn.func_name, arg, kwargs)
            ret=fn(*arg,**kwargs)
            logger.log(level, "called '%s'(%r,%r) got return value: %r", fn.func_name, arg, kwargs, ret)
            return ret
        return _decorated
    return _decorator

@logthis(logging.INFO)
def myfunc(this,that):
    return this+that

Тогда, если вы сконфигурируете регистратор для вывода в stderr, вы увидите: 


>>> logger.setLevel(logging.INFO)
>>> handler=logging.StreamHandler()
>>> logger.addHandler(handler)
>>> myfunc(1,2)
calling 'myfunc'((1, 2),{})
called 'myfunc'((1, 2),{}) got return value: 3
7 голосов
/ 14 мая 2009

Я согласен с nosklo, что использовать отладчик гораздо лучше, чем писать свой собственный. Я опубликую улучшение вашего кода. Но я все еще думаю, что вы должны следовать совету Носкло.

Используйте классы декоратора, чтобы сделать ваш отладчик более аккуратным: 

class Debugger(object):
    enabled = False
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        if self.enabled:
            print 'Entering', self.func.func_name 
            print '    args:', args, kwargs
        return self.func(*args, **kwargs)

Debugger.enabled = True

@Debugger
def myfunc(a, b, c, d):
    pass
0 голосов
/ 14 мая 2009

Я второй, что сказал Носкло.

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

b = myfunc(1,3)

В этом случае «b» равно None, потому что декорированная функция ничего не возвращает.

...