python Création de fonctions dont on pourra se souvenir plus tard

Que faites-vous avec cette fonction, même si vous la regardez des semaines plus tard? Quand je ne me souviens plus

Vous pouvez mettre un commentaire au début de la fonction et une description dans l'argument, donc comment l'utiliser et l'afficher

Exemple réalisé: https://github.com/KodairaTomonori/Qiita/blob/master/default_module/syntax/function.py

• M. knoguchi a souligné que nous l'avons corrigé (2015/10/28).

Exemple: programme d'addition simple

comennt.py

def addition(num_a: int, num_b: int, flag:bool=True) -> int:
    '''
Cette fonction est num_a + num_Un programme qui calcule et renvoie b.
Si l'indicateur est défini sur True, le résultat sera imprimé pour une visualisation facile.
    '''
    if flag: print('{} + {} = {}'.format(num_a, num_b, num_a + num_b) )
    return num_a + num_b

if __name__ == '__main__':
    result = addition(1234, 4321)
    print('result:', result) 
    print('Informations sur l'argument: ', addition.__annotations__)
    print('Description de la fonction: ', addition.__doc__)

production

output.txt

1234 + 4321 = 5555
result: 5555
Informations sur l'argument:  {'num_b': <class 'int'>, 'num_a': <class 'int'>, 'return': <class 'int'>, 'flag': <class 'bool'>}
Description de la fonction:  
Cette fonction est num_a + num_Un programme qui calcule et renvoie b.
Si l'indicateur est défini sur True, le résultat sera imprimé pour une visualisation facile.

Commentaire

La fonction ʻadditionelle-même est un programme qui fait un simple ajout, et si vous définissezflag sur False`, il ne retournera que le résultat.

Mettre une description dans la fonction

Si vous souhaitez mettre une description dans l'argument, (num_a: int, num_b: int, flag:bool=True) -> int J'écrirai comme un dictionnaire. Nom de l'argument à gauche, tapez à droite (argument: type), et si vous voulez donner une valeur par défaut, ajoutez simplement quelque chose comme = True à la fin. Enfin, vous pouvez également entrer le type de retour avec -> int.

Vous pouvez voir comment faire référence à cette explication d'argument en définissant ʻaddition .__ annotations__`.

Lorsque vous mettez une description dans une fonction, vous pouvez mettre une chaîne de caractères à l'endroit suivant déclaré par def. Vous pouvez voir comment vous référer à cette explication en définissant ʻaddition .__ doc__`.

Résumé

Il est important de rendre le nom de l'argument facile à comprendre même si vous le regardez plus tard, mais il sera plus facile à comprendre en incluant une description, donc je l'écrirai sans aucun problème à partir de maintenant.