为什么我无法使用Sphinx Python软件包打印出docstring？

Question

我正在使用狮身人面像记录我的功能。但是，它没有阅读我的Doc字符串，以便使用装饰器读取功能。 sphinx只需用＆lt;魔术替换函数doc字符串。魔术在这里发生＆gt;

我的功能是用装饰器以这种方式编写的。如何使狮身人面像检测功能中的DOC字符串。

文件夹处于此格式

• 项目
  • 功能 - function.py
    • 文档

def wrap(pre, post):
    """ Wrapper """

    def decorate(func):
        """ Decorator """

        def call(*args, **kwargs):
            """ The magic happens here """
            pre(func)
            result = func(*args, **kwargs)
            post(func)
            return result
        return call
    return decorate

def entering(func, *args):
    """ Pre function logging """
    logging.debug("Entered {}".format(func.__name__))
    # logging.info(func.__doc__)
    logging.debug("Function at line {} in {}".format(func.__code__.co_firstlineno, func.__code__.co_filename))
    try:
        logging.debug("The argument {} is {}".format(func.__code__.co_varnames[0], *args))
    except IndexError:
        logging.debug("No arguments")


def exiting(func):
    """ Post function logging """
    logging.debug("Exited {}".format(func.__name__))

@wrap(entering, exiting)
def function(a, b):
    """
    Function to execute
    :param a:
    :param b:
    :return: Sum of a+b
    """
    return a+b

Answer 1

您需要装饰函数才能将docstring从func将其复制到调用之前。否则，Sphinx只能获取呼叫的DocString，而不是原始功能的docstring。

您可以通过直接执行致电。__doc__ = func .__ doc __，也可以使用function> function> wrapss.wrapss.wraps decortor 默认情况下还要复制其他一些属性，并且可以进行很多定制）。

我会尝试：

import functools

def wrap(pre, post):
    """ Wrapper """

    def decorate(func):
        """ Decorator """

        @functools.wraps(func)              # this copies over the docstring and more
        def call(*args, **kwargs):
            """ The magic happens here """
            pre(func)
            result = func(*args, **kwargs)
            post(func)
            return result
        return call
    return decorate