python - 如何在 numpydoc 中键入 int 列表

Question

在numpydoclist文档字符串中键入 a的正确方法是什么。int

int[]例如，这种语法是否有效？

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

    return numbers

Answer 1

根据numpydoc 文档字符串指南，在Sections- 4.Parameters 下，您可以找到有关如何记录 a 的示例list of str，因此只需将其更改为list of int.

将其显式记录为 typelist 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

结果，您可以比较两者：