如何在numpydoc中键入int的列表

Question

在numpydoc文档字符串中键入list或int的正确方法是什么

例如，这个语法int[]有效吗

def my_function(numbers):
    """
    Parameters
    ----------
    numbers : int[]
        List of numbers
    """

    return numbers

Answer 1

根据numpydoc docstring guide，在部分-4.Parameters下，您可以找到一个关于如何记录list of str的示例，因此只需将其更改为list of int

之所以将它显式地记录为类型list of int，而不仅仅是int []，是因为python中的方括号[]（通常称为“数组索引”）表示可以对对象进行索引、切片和迭代。方括号语法本身并不区分处理的是数组还是列表，除非最初实例化对象。正如python文档所指出的那样，带有list([iterable])构造函数的方括号表示括号内的对象只能是iterable

这一点在并排放置时显而易见：

def my_function_one(numbers):
    """
    Parameters
         
    numbers : int[]
        List of numbers
    """

    return numbers


def my_function_two(numbers):
    """
    Parameters
         
    numbers : list of int
        List of numbers
    """

    return numbers

这样您就可以比较这两个结果：