python - 在文档字符串中写入 "a or b"类型提示的_正确_方式是什么？

Question

我有一个参数是“E”或“H”。

def my_func(name):
    """
    Parameters
    ----------
    name : str
    """

要指定它是 'E' 或 'H' 我见过有人写:

    name : {'E', 'H'}

    name : ['E', 'H']

    name : ['E' | 'H']

    name : Union['E', 'H']

    name : 'E' or 'H'

或者，将它们放在第二行:

    name : str
        {'E', 'H'}

    name : str
        ['E', 'H']

    name : str
        ['E' | 'H']

    name : str
        Union['E', 'H']

    name : str
        'E' or 'H'

以上哪一项是正确 ?
如果是 int或 float ，以下哪一项是正确的？

  param : int or float

  param : Union[int, float]

  param : [int | float]

  param : {int, float}

Answer 1

恕我直言，没有任何正确的方法，但正如我所见pandas使用了很多这些方式。
对于 pd.DataFrame.apply ， 有:

axis : {0 or ‘index’, 1 or ‘columns’}, default 0

result_type : {‘expand’, ‘reduce’, ‘broadcast’, None}, default None

而对于 pd.DataFrame.aggregate :

func : function, str, list or dict

而对于 numpy数组， np.array 已:

order : {‘K’, ‘A’, ‘C’, ‘F’}, optional

而对于 np.zeros 你得到了:

shape : int or tuple of ints

和 typing.Union肯定也经常使用。
所有这些都相当正确，这些pandas和 numpy用途被认为更常见。