it-swarm.dev

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

假设我有一个功能:

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指定某些内容的返回类型?

98
exfizik

你正在寻找 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]

其中Union[X, Y]表示XY类型的值。


如果由于担心其他人可能会在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__属性,而不是直接访问它。

152
Jim Fasarakis Hilliard