Python Language Accéder par programme à docstrings


Exemple

Contrairement aux commentaires réguliers, Docstrings est stocké en tant qu'attribut de la fonction qu'ils documentent, ce qui signifie que vous pouvez y accéder par programmation.

Un exemple de fonction

def func():
    """This is a function that does nothing at all"""
    return

Le docstring est accessible en utilisant l'attribut __doc__ :

print(func.__doc__)

Ceci est une fonction qui ne fait rien du tout

help(func)

Aide sur la fonction func dans le module __main__ :

func()

Ceci est une fonction qui ne fait rien du tout

Un autre exemple de fonction

function.__doc__ n'est que le docstring réel en tant que chaîne, alors que la fonction help fournit des informations générales sur une fonction, y compris la docstring. Voici un exemple plus utile:

def greet(name, greeting="Hello"):
    """Print a greeting to the user `name`

    Optional parameter `greeting` can change what they're greeted with."""
    
    print("{} {}".format(greeting, name))
help(greet)

Aide sur la fonction greet dans le module __main__ :

greet(name, greeting='Hello')

Imprimer un message d'accueil au name de l'utilisateur
Paramètre optionnel greeting d' greeting peut changer ce qu'ils sont accueillis avec.

Avantages de docstrings sur les commentaires réguliers

Le simple fait de ne pas placer de docstring ou un commentaire régulier dans une fonction le rend moins utile.

def greet(name, greeting="Hello"):
    # Print a greeting to the user `name`
    # Optional parameter `greeting` can change what they're greeted with.
    
    print("{} {}".format(greeting, name))
print(greet.__doc__)

Aucun

help(greet)

Aide sur la fonction accueil dans le module principal :

greet(name, greeting='Hello')