如何使用类型提示指定"可空"返回类型

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

你在找Optional.

由于您的返回类型可以是datetime(从中返回datetime.utcnow()),或者None您应该使用Optional[datetime]:

from typing import Optional

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

从关于打字的文档,Optional是简写:

Optional[X]相当于Union[X, None].

where Union[X, Y]表示类型X或值的值Y.

如果由于担心其他人可能偶然发现Optional并且没有意识到它的含义而想要明确,那么您总是可以使用Union:

from typing import Union

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

但我怀疑这是一个好主意,Optional是一个指示性的名称,它确实节省了几个按键.

_{正如@ Michael0x2a的评论所指出的那样转变Union[T, None]为Union[T, type(None)]所以不需要在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]}

^*使用typing.get_type_hints抢对象的__annotations__属性,而不是直接访问它.

Answer 2

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

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