Affichage de la documentation de fonction en Python

Dans le corps d'une fonction, on peut écrire une chaîne de caractères, décrivant l'essence du travail effectué. Une telle chaîne est considérée comme la documentation de la fonction. Elle est placée entre guillemets simples et se trouve sur la première ligne du corps de la fonction. Pour la lire, il faut utiliser la fonction spéciale help, en passant le nom de la fonction en paramètre.

Supposons que nous ayons une fonction qui additionne deux nombres. Une chaîne contenant les informations correspondantes a été laissée à cet effet :

def getSum(num1, num2):
	'this function sums two numbers'
	return num1 + num2

Appelons help et découvrons ce qui a été commenté dans getSum :

help(getSum)

Après l'exécution du code, une ligne avec le nom de la fonction et sa documentation apparaîtra dans la console :

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Avec la fonction help, on peut aussi lire la documentation des fonctions standard. Découvrons les informations sur la fonction print :

help(print)

Pour afficher uniquement la chaîne de documentation de la fonction, il faut passer à help, après le nom de la fonction, la construction spéciale .__doc__ :

help(print.__doc__)

Créez une fonction qui prendra en paramètre une liste de noms de mois et les affichera avec une majuscule. Décrivez l'essence du travail de la fonction dans la documentation et affichez-la dans la console.

Affichez toute la documentation sur la fonction sum.

Affichez uniquement la chaîne de documentation de la fonction len.