web-dev-qa-db-ja.com

PyCharm型ヒントのための関数docstringの `Tuple`戻り型のドキュメント化

関数が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.
pythonpycharmdocstring
35
user212218

私はPyCharmサポートに連絡しました、そしてこれは彼らが言ったことです：

タプルの場合、(<type_1>, <type_2>, <type_3>, e t.c.)構文を使用してください。

例えば。：

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

これは PyCharmのドキュメント で確認されています：

タイプ構文

Python docstringsの型構文はどの標準でも定義されていません。したがって、PyCharmは次の表記法を提案しています：

...

  • （フー、バー）＃フーとバーのタプル
46
user212218