PythonFunkcje wbudowane
help()
Wyświetla wbudowaną dokumentację obiektu, funkcji lub modułu.
- Zwraca
None(dokumentacja jest wyświetlana).
Przykład
#Python
def award(name, exp=10):
"""Przyznaje punkty doświadczenia uczniowi."""
return f"{name}: +{exp} EXP"
help(award)Wynik
Kliknij Uruchom, żeby zobaczyć wynik.
Wynik zawiera sygnaturę award(name, exp=10) i opis z docstringa. Dokładny wygląd zależy od wersji Pythona.
Definicja i zastosowanie
#Funkcja help() wyświetla dokumentację podanego obiektu: opis działania, parametry i dostępne metody. Działa z funkcjami wbudowanymi, modułami, klasami i Twoim własnym kodem.
Dokumentację własnych funkcji tworzą napisy dokumentacyjne (docstringi) umieszczone na początku funkcji lub klasy. help() pokaże je razem z sygnaturą.
W trybie interaktywnym wywołanie help() bez argumentu uruchamia przeglądarkę pomocy, z której wychodzi się, wpisując q albo quit.
Składnia
#Składnia
help(obiekt)Parametry
#obiekt
opcjonalny
Funkcja, moduł, klasa albo napis z nazwą tematu.
Więcej przykładów
#Python
def award(name, exp=10):
"""Przyznaje punkty doświadczenia uczniowi."""
print(award.__doc__)Wynikzapisany wynik, możesz go sprawdzić
Przyznaje punkty doświadczenia uczniowi.
Dobre praktyki
#- Pisz docstringi do swoich funkcji.
help()i edytory kodu pokażą je innym programistom. - Do szybkiego sprawdzenia listy metod obiektu użyj
dir().
Powiązane hasła
#Widzisz błąd albo brakuje przykładu? Napisz do nas.