Dokumentation `Tupel` return-Typ in eine Funktion docstring für PyCharm Typbestimmung

Wie kann ich dokumentieren, dass eine Funktion einen tuple in der Weise, dass PyCharm wird in der Lage sein, es zu benutzen für die Typbestimmung?

Erfundenes Beispiel:

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.
  • :Rückgabe: name des Kunden: sein name, Kunde, status: den status des Kunden in dog ' s name: in der Regel Fido.
  • Konnte nicht der ganze string nur """Return (name, status, etc)"""? Alles andere scheint ein wenig überflüssig. Es sei denn der PK-Wert etwas zu tun hatte mit dem, was Art der customer_id-die Funktion erwartet.
  • Aktualisiert den Fragetext ein bisschen weniger subjektiv.
InformationsquelleAutor | 2013-08-06
  1. 44

    Kontaktierte ich PyCharm-Unterstützung, und das ist, was Sie sagte:

    Für Tupel verwenden Sie bitte (<type_1>, <type_2>, <type_3>, e t.c.) syntax.

    E. g.:

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

    Bestätigt wird dies in PyCharm Dokumentation:

    Type Syntax

    Type syntax in Python docstrings ist nicht definiert, die von jedem standard. So, PyCharm schlägt folgende notation:

    ...

    • (Foo, Bar) # Tupel von Foo und Bar
    • Ich denke, dies ist nun gebrochen, als von PyCharm 2017.1.5
    InformationsquelleAutor
Schreibe einen Kommentar