如何指示嵌套的返回类型(例如,int的列表)

时间:2017-03-30 16:53:25

标签: python python-sphinx docstring autodoc

我有一个嵌套返回类型的python函数,如何正确指示返回类型? (例如,pycharm可能会将返回类型检测为Tuple [listintint],其中每个类型都是单独链接的)

e.g。

def random_list(num):
    """Returns a list of random numbers
    :param num:
        Number of random numbers to generate
    :type num:
        int
    :return:
        A list of random floats
    :rtype:
        ????
    """
    return [random() for x in range(num)]

1 个答案:

答案 0 :(得分:1)

我会调查type hints并使用相同的表达式,例如:

from typing import List

def random_list(num: int) -> List[float]:  # Py 3.5
    """Returns a list of random numbers
    :param num:
        Number of random numbers to generate
    :type num:
        int
    :return:
        A list of random floats
    :rtype:
        List[float]
    """
    return [random() for x in range(num)]