Python Docstring - 函数的两种不同类型的参数

Question

我试图让我的功能描述看起来很漂亮，但是没有用。 问题是我有两种类型的返回：一个列表和一个字符串。 然后你将鼠标悬停在函数上，vscode 会显示函数的返回，如下所示。 我发现您可以使用此示例（-> str）定义一种返回类型：

def function(x, y) -> str:
  string = "test"
  return string

但是假设我的代码中有两个不同的返回：

def function(x, y):
  if x == 1:
    string = "test"
    return string
  else:
    list = [1, 2]
    return list

如何为该函数分配两种不同类型的返回？ 这是另一个例子

Answer 1

from typing import Union, List

def function(x, y) -> Union[str, List[int]]:
  if x == 1:
    return "test"
  return [1, 2]

Answer 2

根据您的 Python 版本，可以通过多种方式对此进行表达：

• 在 3.9 之前：

   from typing import Union, List def foo() -> Union[str, List]: pass

• 从 Python v. 3.9 开始，您还可以编写：

   from typing import Union def foo() -> Union[str, list]: pass

• 从 Python v. 3.10 开始，您还可以编写：

   def foo() -> str | list: pass