python - guide - pycharm show docstring



Документирование возвращаемого типа `tuple` в функции docstring для типа PyCharm (1)

Как я могу документировать, что функция возвращает tuple таким образом, что PyCharm сможет использовать его для намека типа?

Продуманный пример:

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.

Я связался с поддержкой PyCharm, и вот что они сказали:

Для кортежа используйте (<type_1>, <type_2>, <type_3>, e tc) синтаксис.

Например:

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

Это подтверждено в документации PyCharm :

Тип Синтаксис

Типичный синтаксис в docstrings Python не определен никаким стандартом. Таким образом, PyCharm предлагает следующие обозначения:

...

  • (Foo, Bar) # Кортеж Foo и Bar




docstring