我如何用Sphinx记录一个以函数为参数的函数？ [英] How can I document a function which takes a function as a parameter with Sphinx?

问题描述

假设我有一个如下所示的类：

class FunctionCaller:
    def __init__(self):
        """A class which can be used to call different functions which take the same
        parameters

        """
        self.f = lambda a,b: (a,b)

    def setF(self, new_f):
        """Set the function to call

        :param new_f: The new function this object should call
        :type new_f: func(:class:`.SomeClass`, :class:`int`)
        """
        self.f = new_f

    def callF(self, a, b):
        """Call the function this object currently contains

        :param a: Some value
        :param b: Some other value
        """
        return self.f(a,b)

class SomeClass:
    """Some class which does nothing
    """
    pass

例如(忽略这可能是糟糕的编码风格)，让我们假设FunctionCaller将要调用的函数期望将SomeClass作为其第一个参数，并将一个int作为其第二个参数。我希望文档显示指向这两件事的链接。我在示例中定义它的方式可以工作，但看起来不是很好。

有什么方法可以使用:type:说明符来指示参数是函数吗？

推荐答案

有什么方法可以使用:type:说明符来指示参数是函数吗？

我想您可以指定types.FunctionType作为类型。但我建议你解释一下它是如何工作的：

def setF(self, new_f):
     """Set the function to call

     :param new_f: The new function this object should call.

     The new function takes two positional parameters: the first of
     type :class:`.SomeClass` and the second of type :class:`int`.
     """
     self.f = new_f

这篇关于我如何用Sphinx记录一个以函数为参数的函数？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！