如何在 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 下，您找到了一个关于如何记录 a list of str 的示例，因此只需更改list of int。

将其显式记录为类型 list of int 而不仅仅是 int [] 的原因是因为 方括号 [] python（通常称为 "array indexing"）表示可以对对象进行索引、切片和迭代。方括号语法本身不会区分您是在处理数组还是列表，除非最初是在实例化对象时。正如 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

你可以比较两者的结果：

如何在 numpydoc 中键入一个 int 列表

How to type a list of int in numpydoc

python

numpydoc