Docstring

Ce terme vous dit peut-être quelque chose 👀

Le mot docstring est un raccourci pour DOCumentation STRINGs.

On les utilise pour donner des indications sur le comportement d'une fonction, d'une méthode, d'une classe ou même d'un module entier.

def print_modulo(): 
    """ Affiche tous les chiffres pairs compris entre 0 et 10 """
    for i in range(10): 
        if i % 2 == 0: 
            print(i) 

print_modulo()

Vous pouvez accéder à cette documentation à n'importe quel moment dans votre code grâce à la méthode __doc__ :

#norun
def print_modulo(): 
    """Affiche tous les chiffres pairs compris entre 0 et 10"""
    for i in range(10): 
        if i % 2 == 0: 
            print(i) 

print(print_modulo.__doc__)  # "Affiche tous les chiffres pairs compris entre 0 et 10"

Vous pouvez aller beaucoup plus dans le détail et donner des informations sur les arguments utilisés, sur ce qui est retourné, les exceptions possibles, etc...

Il y a différents formats que vous pouvez adopter (Google, Numpy, Sphinx, etc..).

Différentes extensions permettent de générer des docstring selon ces différents formats ou nativement comme avec PyCharm.

Si vous êtes sur Visual Studio Code, je vous conseille d'installer l'extension Python Dosctring Generator qui vous permet de générer des docstring automatiquement selon différents formats.