如何在numpydoc中键入int列表

Question

在list文档字符串中键入农比多 of int的正确方法是什么。

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

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

    return numbers

Answer 1

根据numpydoc文档字符串指南的说法，在章节-4下，您可以找到一个关于如何记录list of str的示例，所以只需将其更改为list of int即可。

​

​

之所以显式地将其记录为list of int类型而不仅仅是int []，是因为python中的方括号 [] (通常称为“数组索引”)表明可以对对象进行索引、切片和迭代。方括号语法本身并不区分是处理数组还是处理列表，除非最初实例化对象。正如python所指出的，带有list([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

结果，您可以比较这两种情况：

​

​