Afișarea documentației funcției în Python
În corpul unei funcții poți scrie un șir de text,
care descrie esența activității desfășurate. Un astfel de
șir este considerat în mod convențional documentația
funcției. Acesta este cuprins între ghilimele simple
și este plasat pe prima linie a corpului funcției.
Pentru a o citi, trebuie să folosești
o funcție specială help, căreia
îi este transmis numele funcției ca parametru.
Să presupunem că avem o funcție care adună două numere. Despre aceasta a fost lăsat un șir cu informația corespunzătoare:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Să apelăm help și să aflăm ce
a fost comentat în getSum:
help(getSum)
După executarea codului, în consolă va apărea un șir cu numele funcției și documentația acesteia:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
Cu ajutorul funcției help poți citi
documentația și pentru funcțiile standard. Să
aflăm informații despre funcția print:
help(print)
Pentru a afișa doar șirul cu
documentația funcției, trebuie să transmiți
în help după numele funcției construcția
serviciului .__doc__:
help(print.__doc__)
Creați o funcție care va primi ca parametru o listă cu numele lunilor și le va afișa cu literă mare. Descrieți esența activității funcției în documentație și afișați-o în consolă.
Afișați toată documentația despre funcția sum.
Afișați doar șirul cu documentația despre
funcția len.