Sphinx docstring:指定类型而不是对象?

时间:2015-11-17 22:10:18

标签: python python-2.7 python-sphinx

在Sphinx中,假设你有一个带一个参数的函数。您的docstring可能如下所示:

class A(object):
    pass

def funct1(a_object):
    """
    :type a_object: A
    """
    pass

funct1(A())

然而,如果你没有通过A类的对象,而是通过类#34; A"本身?该docstring看起来怎么样?

class B(object):
    pass

def funct2(b_class):
    """
    :type b_class: ?????
    """
    pass

funct2(B)

1 个答案:

答案 0 :(得分:0)

我认为这应该适用于类型提示,即使它在技术上不是100%准确:

class B(object):
    pass

def funct2(b_class):
    """
    :type b_class: () -> B
    """
    pass

funct2(B)