python - 在 PyCharm 类型提示的函数文档字符串中记录 `tuple` 返回类型

Question

我如何记录一个函数以tuplePyCharm 能够使用它进行类型提示的方式返回 a ？

人为的例子：

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

我联系了 PyCharm 支持，他们是这样说的：

对于元组，请使用(<type_1>, <type_2>, <type_3>, e t.c.)语法。

例如：

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

这在PyCharm 的文档中得到了证实：

类型语法

Python 文档字符串中的类型语法没有由任何标准定义。因此，PyCharm 建议使用以下符号：

...

• (Foo, Bar) # Foo 和 Bar 的元组