Prikaz dokumentacije funkcije v Pythonu

V telesu funkcije lahko napišemo niz, ki opisuje bistvo opravljenega dela. Tak niz običajno štejemo za dokumentacijo funkcije. Je zaprt v enojne narekovaje in se nahaja v prvi vrstici telesa funkcije. Da jo preberemo, moramo uporabiti posebno funkcijo help, v parameter katere se poda ime funkcije.

Recimo, da imamo funkcijo, ki sešteje dve števili. O tem je puščena opomba s ustreznimi informacijami:

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

Pokličimo help in izvedimo, kaj je zakomentirano v getSum:

help(getSum)

Po izvedbi kode se bo v konzoli pojavil niz z imenom funkcije in njeno dokumentacijo:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

S funkcijo help lahko beremo dokumentacijo tudi standardnih funkcij. Izvedimo informacije o funkciji print:

help(print)

Če želimo izpisati samo niz z dokumentacijo funkcije, moramo podati v help za imenom funkcije službeno konstrukcijo .__doc__:

help(print.__doc__)

Ustvarite funkcijo, ki bo sprejela parameter seznam imen mesecev in jih izpisala z začetnico. Opišite bistvo delovanja funkcije v dokumentaciji in jo izpišite v konzolo.

Izpišite vso dokumentacijo o funkciji sum.

Izpišite samo niz z dokumentacijo o funkciji len.