python - how - Documentar el tipo de retorno `tuple` en una función docstring para sugerencias de tipo PyCharm

how to document python code

Question

¿Cómo puedo documentar que una función devuelve una tuple de tal manera que PyCharm podrá usarla para sugerencias de tipo?

Ejemplo elaborado:

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

Me puse en contacto con el soporte de PyCharm, y esto es lo que dijeron:

Para la tupla, use la (<type_1>, <type_2>, <type_3>, e tc) .

P.ej:

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

Esto se confirma en la documentación de PyCharm :

Tipo de sintaxis

La sintaxis de tipo en las cadenas de documentación de Python no está definida por ningún estándar. Por lo tanto, PyCharm sugiere la siguiente notación:

...

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