如何创建可以使用参数或不使用参数的Python装饰器？

Question

我想创建一个Python decorator，它可以与参数一起使用：

@redirect_output("somewhere.log")
def foo():
    ....

或者不使用它们（例如，默认情况下将输出重定向到stderr）：

@redirect_output
def foo():
    ....

那有可能吗？

注意，对于重定向输出的问题，我并没有寻找不同的解决方案，这只是我想要实现的语法的一个例子。

Answer 1

使用具有默认值的关键字参数（如kquinn所建议的）是一个好主意，但需要包含括号：

@redirect_output()
def foo():
    ...

如果您想要一个在装饰器上没有括号的版本，那么您必须在装饰器代码中考虑这两种情况。

如果使用的是Python3.0，则可以使用仅关键字参数：

def redirect_output(fn=None,*,destination=None):
  destination = sys.stderr if destination is None else destination
  def wrapper(*args, **kwargs):
    ... # your code here
  if fn is None:
    def decorator(fn):
      return functools.update_wrapper(wrapper, fn)
    return decorator
  else:
    return functools.update_wrapper(wrapper, fn)

在Python2.x中，这可以用varargs技巧模拟：

def redirected_output(*fn,**options):
  destination = options.pop('destination', sys.stderr)
  if options:
    raise TypeError("unsupported keyword arguments: %s" % 
                    ",".join(options.keys()))
  def wrapper(*args, **kwargs):
    ... # your code here
  if fn:
    return functools.update_wrapper(wrapper, fn[0])
  else:
    def decorator(fn):
      return functools.update_wrapper(wrapper, fn)
    return decorator

这些版本中的任何一个都允许您编写如下代码：

@redirected_output
def foo():
    ...

@redirected_output(destination="somewhere.log")
def bar():
    ...