Annotation de type de retour Python void

En python 3.x, il est courant d'utiliser l'annotation de type de retour d'une fonction, telle que:

def foo() -> str:
    return "bar"

Quelle est l'annotation correcte pour le type "void"?

J'envisage 3 options:

1. def foo() -> None:
   • pas logique IMO, car ce Nonen'est pas un type,
2. def foo() -> type(None):
   • en utilisant la meilleure syntaxe que je connaisse pour obtenir NoneType,
3. def foo():
   • omettre les informations de type de retour explicites.

L'option 2. me semble la plus logique, mais j'ai déjà vu quelques exemples de 1.

Ceci est directement issu de la documentation PEP 484 - Type Hints :

Lorsqu'elle est utilisée dans une indication de type, l'expression Noneest considérée comme équivalente à type(None).

Et, comme vous pouvez le voir, la plupart des exemples utilisent Nonecomme type de retour.

TLDR: l'équivalent idiomatique d'une voidannotation de type de retour est -> None.

def foo() -> None:
    ...

Cela correspond à ce qu'une fonction sans returnou juste un simple returnévalue None.

def void_func():  # unannotated void function
    pass

print(void())  # None

Omettre le type de retour ne signifie pas qu'il n'y a pas de valeur de retour. Selon PEP 484 :

Pour une fonction cochée, l'annotation par défaut pour les arguments et pour le type de retour est Any.

Cela signifie que la valeur est considérée comme typée dynamiquement et prend en charge statiquement toute opération . C'est pratiquement le sens opposé de void.

L'indication de type en Python ne nécessite pas strictement de types réels. Par exemple, les annotations peuvent utiliser des chaînes de noms de type: Union[str, int], Union[str, 'int'], 'Union[str, int]'et diverses variantes sont équivalentes.

De même, l'annotation de type Noneest considérée comme signifiant "est de NoneType". Cela peut être utilisé non seulement pour les types de retour, même si vous le verrez le plus souvent là-bas:

bar : None

def foo(baz: None) -> None:
    return None

Cela s'applique également aux types génériques. Par exemple, vous pouvez utiliser Nonein Generator[int, None, None]pour indiquer qu'un générateur ne prend ni ne renvoie de valeurs.

Même si PEP 484 suggère que cela Nonesignifie type(None), vous ne devez pas utiliser ce dernier formulaire explicitement. La spécification de type hinting ne pas inclure toute forme de type(...). Il s'agit techniquement d'une expression d'exécution, et sa prise en charge dépend entièrement du vérificateur de type. Le mypyprojet envisage de retirer le support pour type(None)et le retirer de 484 ainsi.

Ou peut-être devrions-nous mettre à jour PEP 484 pour ne pas suggérer que ce type type(None)est valide et Noneque la seule orthographe est correcte? Il devrait y avoir une - et de préférence une seule - façon évidente de le faire, etc.

--- JukkaL, 18 mai 2018