Comment spécifier un type de retour "nullable" avec des indices de type ?

Question

Supposons que j'ai une fonction :

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

Comment puis-je spécifier le type de retour pour quelque chose qui peut être None ?

Answer 1

Vous êtes à la recherche de Optional .

Puisque votre type de retour peut être soit datetime (tel que renvoyé par datetime.utcnow() ) ou None vous devez utiliser Optional[datetime] :

from typing import Optional

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

Extrait de la documentation sur la saisie, Optional est une abréviation de :

Optional[X] est équivalent à Union[X, None] .

où Union[X, Y] signifie une valeur de type X ou Y .

---

Si vous voulez être explicite parce que vous craignez que d'autres personnes ne tombent sur Optional et ne pas réaliser sa signification, vous pouvez toujours utiliser Union :

from typing import Union

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

Mais je doute que ce soit une bonne idée, Optional est un nom indicatif et il permet d'économiser quelques frappes de clavier.

_{Comme indiqué dans les commentaires par @Michael0x2a <code>Union[T, None]</code> est transformé en <code>Union[T, type(None)]</code> il n'est donc pas nécessaire d'utiliser <code>type</code> ici.}

Visuellement, ils peuvent être différents, mais en termes de programmation, dans les deux cas, le résultat est le suivant exactement la même chose ; Union[datetime.datetime, NoneType] sera le type stocké dans 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]}

* Utilisez typing.get_type_hints pour saisir les objets __annotations__ au lieu d'y accéder directement.

Answer 2

Vous pourriez simplement utiliser la ligne verticale datetime | None (similaire à l'opérateur OR) :

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