如何使用类型提示指定“可为空”返回类型

Question

假设我有一个函数：

def get_some_date(some_argument: int=None) -> %datetime_or_None%:
    if some_argument is not None and some_argument == 1:
        return datetime.utcnow()
    else:
        return None

如何指定可以为None的返回类型？

Answer 1

您可以只使用垂直线datetime|无（类似于OR运算符）：

def get_some_date(some_argument: int=None) -> datetime | None:
   # rest of code

Answer 2

您正在寻找可选。

由于您的返回类型可以是 datetime（从 datetime.utcnow（）返回）或 None，因此您应该使用 Optional[datetime]：

from typing import Optional

def get_some_date(some_argument: int=None) -> Optional[datetime]:
    # as defined

在有关键入的文档中，可选是以下内容的缩写：

< code >可选的[X]等效于< code>Union[X，None]。

其中< code>Union[X，Y]表示类型为< code>X或< code>Y的值。

如果您想明确表示，因为担心其他人可能会偶然发现可选并且没有意识到它的含义，您可以始终使用Union：

from typing import Union

def get_some_date(some_argument: int=None) -> Union[datetime, None]:

但我怀疑这是一个好主意，可选是一个指示性名称，它确实节省了几次击键。

< sub >正如@Michael0x2a在评论中指出的那样< code>Union[T，None]被转换为< code>Union[T，type(None)]，因此这里不需要使用< code>type。

视觉上这些可能不同，但在编程上，在这两种情况下，结果完全相同；Union[datetime.datetime， NoneType]将是存储在get_some_date中的类型。__annotations__^*：

>>> from typing import get_type_hints
>>> print(get_type_hints(get_some_date))
{'return': typing.Union[datetime.datetime, NoneType],
 'some_argument': typing.Union[int, NoneType]}

< sup>*使用< code > typing . get _ type _ hints 获取对象的< code>__annotations__属性，而不是直接访问它。