Sphinx 文档没有列出修饰函数的参数

Question

当我从 cachetools 应用我自己的装饰器（细节并不重要，但见下文）或其他装饰器（例如 cached）时，我的 Sphinx 生成的文档不会在其签名中显示参数名称。

例如，文档

@cached()
def some_func(argA, argB=None):
    ...

@require_unicode('third')
def another_func(first, second=None, third=None):
...

一般会读

some_func(*args, **kwargs)

another_func(*args, **kwargs)

而不是，信息丰富的，作为

some_func(argA, argB=None)

another_func(first, second=None, third=None)

我该如何解决这个问题，以便我的参数名称出现在我的 Sphinx 文档中？我知道这是一个已知问题，而且，因为我知道我使用的装饰器的名称，所以我想在我的conf.py 中将它们变成无操作，但不知道该怎么做.

例如，this 之类的东西看起来很有希望，但我不知道如何让它发挥作用。我可以把它放在我上面的定义之前，但看不到如何让它为cached 工作。

---

我的装修师，供参考。请注意，至少这会生成文档（如果我不使用 wraps，它不会生成文档）：

from functools import wraps

def require_unicode(*given_arg_names):
    def check_types(_func_):
        @wraps(_func_)
        def modified(*args, **kwargs):
            arg_names = list(_func_.func_code.co_varnames[:_func_.func_code.co_argcount])
            if len(given_arg_names) == 0:
                raise TypeError('No arguments provided to require_unicode decorator.')
                #unicode_arg_names = arg_names
            else:
                unicode_arg_names = given_arg_names
            for unicode_arg_name in unicode_arg_names:
                try:
                    arg_index = arg_names.index(unicode_arg_name)
                    if len(args) > arg_index:
                        arg = args[arg_index]
                    elif unicode_arg_name in kwargs:
                        arg = kwargs[unicode_arg_name]
                    else:
                    if not isinstance(arg, unicode):
                        raise TypeError("Parameter '{}' should be Unicode".format(unicode_arg_name))
                except ValueError:
                    raise NameError(unicode_arg_name)
            return _func_(*args, **kwargs)
        return modified
    return check_types

Answer 1

查看source code for cached，它没有使用functools.wraps，因此您当前的猴子补丁不会在那里成功。它使用functools.update_wrapper 或它自己的版本，别名为_update_wrapper，因此您需要修补它。如果您使用任何其他具有自己实现包装方式的库，则需要相应地调查每个库。