Jak określić „pustych” typ zwracany z rodzaju aluzje

Question

Załóżmy, że mam funkcję:

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 

Jak określić typ zwracanej przez coś, co można None?

Answer 1

Ponieważ rodzaj powrotu może być albo datetime (jak wrócił z datetime.utcnow()) lub None należy użyć Optional[datetime]:

from typing import Optional 

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

z dokumentacji, Optional jest skrótem dla:

Optional[X] jest równoważna do Union[X, None].

gdzie Union[X, Y] oznacza wartość typu X lub Y.

---

Jeśli chcesz być jednoznaczne ze względu na obawy, że inni mogą natknąć się na Optional i nie zdają sobie sprawy, że to znaczy, zawsze można użyć Union:

from typing import Union 

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

Ale wątpię, że jest to dobry pomysł, Optional to nazwa orientacyjna, która zapisuje kilka naciśnięć klawiszy.

_{Jak zauważył w komentarzach przez @ Michael0x2a Union[T, None] jest przekształcona do Union[T, type(None)] więc nie ma potrzeby korzystania type tutaj.}

Wizualnie mogą się one różnić, ale programowo, w obu przypadkach wynikiem jest dokładnie taki sam; Union[datetime.datetime, NoneType] będzie typ przechowywane w 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]} 

^* Zastosowanie typing.get_type_hints chwycić przedmioty __annotations__ atrybut zamiast dostępu do niego bezpośrednio.