Comment annoter une fonction qui prend un tuple de longueur variable ? (annotation du type de tuple variadique)

Question

J'ai une fonction qui prend un tuple de différentes longueurs comme argument :

from typing import Tuple

def process_tuple(t: Tuple[str]):
    # Do nasty tuple stuff

process_tuple(("a",))
process_tuple(("a", "b"))
process_tuple(("a", "b", "c"))

Lorsque j'annote la fonction comme indiqué ci-dessus, j'obtiens les messages d'erreur suivants

fool.py:9: error: Argument 1 to "process_tuple" has incompatible type "Tuple[str, str]"; expected "Tuple[str]"
fool.py:10: error: Argument 1 to "process_tuple" has incompatible type "Tuple[str, str, str]"; expected "Tuple[str]"

process_tuple fonctionne vraiment avec des tuples et je les utilise comme des listes immuables de longueur variable. Je n'ai pas trouvé de consensus sur ce sujet sur Internet, et je me demande donc comment je dois annoter ce type d'entrée.

Answer 1

Nous pouvons annoter des tuples homogènes de longueur variable en utilisant la fonction ... littéral (alias Ellipsis ) comme ceci :

def process_tuple(t: Tuple[str, ...]):
    ...

Après cela, les erreurs devraient disparaître.

De la docs :

Pour spécifier un tuple de longueur variable de type homogène, utilisez le littéral ellipses, par exemple Tuple[int, ...] . Une plaine Tuple est équivalent à Tuple[Any, ...] et, à son tour, à tuple .

Answer 2

En plus de la réponse Ellipsis telle que postée par Azat, vous pourriez la rendre plus explicite en utilisant @typing.overload o typing.Union

from typing import Tuple

@overload
def process_tuple(t: Tuple[str]):
    # Do nasty tuple stuff

@overload
def process_tuple(t: Tuple[str, str]):
    ...

Ou avec l'Union :

from typing import Tuple, Union

def process_tuple(t: Union[Tuple[str], Tuple[str, str], Tuple[str, str, str]]):
    # Do nasty tuple stuff