使用 Python 装饰器强制执行标准方法签名

Question

我有一个包含很多功能的库。我希望与基本方法模式保持一致。我希望所有方法都将上下文作为第一个参数和默认为 0 的关键字 arg。

library_function(context, ..., default=0)

有没有办法可以使用 python 装饰器来转

bobs_function(foo, bar=None)

进入

bobs_library_function(context, foo, bar=None, default=0)

这样做的目的是为声明库函数提供简写。而不是每次都显式添加上下文和默认值。

Answer 1

如果你只允许在你的包装函数中传递关键字参数，你就可以做到这一点：

import functools

def lib(fn):
    @functools.wraps(fn)
    def wrapped(context, default=0, **kwargs):
        print context, default
        return fn(**kwargs)
    return wrapped

@lib
def bobs_function(foo, bar=None):
    print foo
    print bar


bobs_function('context', foo='foo', bar='bar', default='default')

打印：

context default
foo
bar

Answer 2

我对这个问题的观察和思考越多，我就越相信答案是否定的。

我希望能够从内部 bobs 函数访问上下文和默认值。希望我能想出一个方便的速记，以确保我编写的方法签名符合约定。

问题是我必须提前声明bob_function 采用的参数。如果它需要一个位置参数，那么添加一个新的位置参数会搞砸一切。

所以我第一个想到

@library_function
def bobs_function(foo, bar=None):
     ....

神奇地改变方法签名是行不通的。

我的下一个想法是扭转它

@library_function(foo, bar=None)
def bobs_function(*args, **kwargs):
    ...

但这在语法上甚至都不正确。我不得不将我的变量从 args 和 Charges 中剔除，结果令人不快。

所以总结一下我的问题。如果我想使用上下文，我必须将其传入。我无法修改bobs_function 的实际声明参数，所以我可以传入上下文的唯一方法是使用 *args **kwargs，这更令人不快不仅仅是打字

bobs_library_function(context, foo, bar=None, default=0)

开始。