Documentation du type de retour `Tuple` dans une fonction docstring pour l'indication de type PyCharm

Question

Comment puis-je documenter qu'une fonction retourne un Tuple de telle manière que PyCharm pourra l'utiliser pour l'indication de type?

Exemple artificiel:

def fetch_abbrev_customer_info(customer_id):
  """Pulls abbreviated customer data from the database for the Customer
       with the specified PK value.

       :type customer_id:int The ID of the Customer record to fetch.

       :rtype:???
  """
  ... magic happens here ...

  return customer_obj.fullname, customer_obj.status #, etc.

Answer 1

J'ai contacté le support PyCharm, et voici ce qu'ils ont dit:

Pour Tuple, veuillez utiliser (<type_1>, <type_2>, <type_3>, e t.c.) syntaxe.

Par exemple.:

"""
:rtype: (string, int, int)
"""

Ceci est confirmé dans documentation de PyCharm :

Syntaxe de type

Syntaxe de type dans Python docstrings n'est défini par aucune norme. Ainsi, PyCharm suggère la notation suivante:

...

• (Foo, Bar) # Tuple de Foo et Bar