使用装饰器进行 Python 日志记录

Question

这是我们面对装饰器时遇到的第一个例子。但我无法意识到我到底想要什么。

一个名为 LOG 的简单装饰器。它应该像这样工作：

@LOG
def f(a, b=2, *c, **d):
    pass

结果应该类似于：

f(1, pippo=4, paperino='luca')
===== Enter f =====
a = 1
b = 2
pippo = 4
paperino = luca
===== Exit f =====

作为参数传递给函数的每个参数都显示其值。

我发现这个问题比我想象的要难，主要是因为可以通过多种不同的方式将参数传递给函数（想想带有 *c 的元组或带有 **d 的字典）。

我尝试了一个解决方案，但我不确定它是否正确。大概是这样的：

def LOG(fn):
    import inspect
    varList, _, _, default = inspect.getargspec(fn)
    d = {}
    if default is not None:
        d = dict((varList[-len(default):][i], v) for i, v in enumerate(default))
    def f(*argt, **argd):
        print ('Enter %s' % fn).center(100, '=')
        d.update(dict((varList[i], v) for i, v in enumerate(argt)))
        d.update(argd)
        for c in d.iteritems():
            print '%s = %s' % c
        ret = fn(*argt, **argd)
        print 'return: %s' % ret
        print ('Exit %s' % fn).center(100, '=')
        return ret
    return f

我觉得这并不像我想象的那么容易，但奇怪的是我没有在谷歌上找到我想要的东西。

你能告诉我我的解决方案是否可以吗？或者你能为我提出的问题提出更好的解决方案吗？

谢谢大家。

Answer 1

我唯一注意到的是，您使用两次的 dict((varList[i], v) for i, v in enumerate(argt)) 构造实际上是 dict(zip(varList, argt))。

除此之外，我只有元批评：以上内容都不属于日志文件。

您无需通过日志查看

• 函数是否使用正确的参数调用，而是使用断言和调试器。
• 看看函数是否返回您编写的单元测试的正确结果。

Answer 2

你的功能一切正常。您似乎迷失了位置与变量和关键字参数。

让我解释一下：在您的情况下，位置参数 a 和 b 是必需的（并且可能有默认值）。其他参数是可选的。如果您想让某个参数成为强制参数或具有默认值，请将其放在 *args 和 **kwargs 之前。但请记住，您不能提供两次参数：

def x(a = 1, b = 2, *args, **kwargs):
    print a, b, args, kwargs

>>> x(3, 4, 5, b=6)
TypeError: x() got multiple values for keyword argument 'b'

还有另一种方法，但不那么可读，可以为参数提供默认值并且没有位置参数：

def x(*args, **kwargs):
    kwargs.updae({'a': 1, 'b': 2})

您分析参数的函数是可以的，尽管我不明白为什么您将 varargs 和 keywords 写入 _ 中。它透明地传递参数：

def x(a = 1, b = 2, *args, **kwargs):
    print a, b, args, kwargs

def y(*args, **kwargs):
    x(*args, **kwargs)

>>> y(3, 4, 5, 6)
3 4 (5, 6) {}

>>> y(3, 4, 5, b=6)
TypeError: x() got multiple values for keyword argument 'b'

Answer 3

我发现如果您考虑到一般函数理论上可以返回可迭代对象，那么您的好解决方案可以稍微改进，在这种情况下会引发错误。

这是一个解决方案：

将 print 'return: %s' % ret 包装到 if 语句中：
if hasattr(ret, "__iter__"):
打印“返回可迭代”
别的：
print '返回：%s' % ret

这样您就不会花费大量时间来打印大型可迭代对象，但当然可以根据需要进行修改。 （而且字符串没有 __iter__ 属性，这很方便）

Answer 4

Polog 库提供了针对此问题的现成解决方案。

安装它：

$ pip install polog

并使用：

from polog import log, config, file_writer

config.add_handlers(file_writer())

@log("my message")
def f(a, b=2, *c, **d):
    pass

f(1, pippo=4, paperino='luca')

控制台中的结果：

[2022-10-30 21:42:32.704898] |    1    | SUCCESS |  AUTO  | "my message" | where: __main__.f() | time of work: 0.00001597 sec. | input variables: 1 (int), pippo = 4 (int), paperino = "luca" (str) | result: None (NoneType)