Ce face help()
help(obiect) afișează semnătura și documentația (docstring-ul) obiectului. În consola interactivă, help() fără argument pornește un mod de ajutor în care poți căuta subiecte; ieși cu q sau quit.
Documentația propriilor funcții vine din textul pus între ghilimele triple pe primul rând al funcției.
Parametri
| Parametru | Descriere |
|---|---|
obiect |
Opțional. Funcția, clasa, modulul sau un text cu numele lor. |
Ce returnează
None; documentația este afișată.
Exemple
Exemplul 1: Ajutor pentru o funcție proprie
def pret_cu_tva(pret, tva=0.21):
"""Returnează prețul cu TVA, rotunjit la 2 zecimale."""
return round(pret * (1 + tva), 2)
help(pret_cu_tva)
Rezultat
Help on function pret_cu_tva in module __main__:
pret_cu_tva(pret, tva=0.21)
Returnează prețul cu TVA, rotunjit la 2 zecimale.
Greșeli frecvente
- Scrii
help(len())cu paranteze și primești o eroare sau ajutorul pentru rezultat. Dă funcția fără să o apelezi:help(len).