Documentation `tuple` type de retour d'une fonction docstring pour PyCharm type hinting
Comment puis-je document qu'une fonction renvoie une tuple
de telle manière que PyCharm sera en mesure de l'utiliser pour le type allusion?
Exemple artificiel:
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.
- :retourne: nom du client: son nom, le statut du client: son statut, du client, nom du chien: généralement de Fido.
- Ne pouvais pas l'ensemble de la chaîne juste être
"""Return (name, status, etc)"""
? Tout le reste semble un peu redondant. À moins que la valeur de clé primaire avait quelque chose à faire avec ce genre de customer_id la fonction attend. - Mise à jour le texte de la question d'être un peu moins subjective.
Vous devez vous connecter pour publier un commentaire.
J'ai contacté PyCharm de soutien, et c'est ce qu'ils ont dit:
Ceci est confirmé dans la PyCharm de la documentation: