Hey, mensen! In dit artikel zullen we ons richten op een belangrijke verklarende functie in Python – Python help() functie.
Noodzaak van de help() methode
Tijdens het coderen in een bepaalde programmeertaal, is het zeer essentieel voor ons om de basisdocumentatie van de ingelijste taal te kennen. Dit is wanneer de functie help() in beeld komt.
Deze functie voorziet ons van de basisdocumentatie van de Python-taal. Het geeft ons informatie over de methoden en instanties die zijn gekoppeld aan een bepaalde methode of klasse.
De help()-methode werkt met trefwoorden, Klassen, functies en modules om ons te helpen de basisterminologieën, instanties en werking te verkrijgen die respectievelijk daaraan zijn gekoppeld.
Over het algemeen wordt de help() method naast de Python-interpreter gebruikt om toegang te krijgen tot de onderliggende details over Python-objecten die als parameter worden doorgegeven.
Werking van de Python help() methode
Zoals hierboven vermeld, verschaft de help() methode informatie over de Python-objecten die aan de methode worden doorgegeven.
Als de methode help() function wordt genoemd zonder enige parameter, start het de interpreter console waarin we elke module, object, klasse, etc kunnen noemen om de documentatie over hetzelfde te verkrijgen.
Exemplaar:
help()
Uitvoer:
Python help() functie met een Klasse
De helpfunctie kan worden gevoed met aangepaste of vooraf gedefinieerde parameters om mee te werken. We kunnen een aangepaste klasse maken en deze doorgeven aan de functie help() om de documentatie te onderzoeken die door de functie wordt geleverd.
Voorbeeld:
class Info: lang = "Python" name = "JournalDev"obj = Info()help(Info)
We hebben een door de gebruiker gedefinieerde klasse gemaakt en deze aan de functie help() doorgegeven. De functie help() heeft de benodigde documentatie van de klasse ‘Info’ teruggegeven.
Uitvoer:
Help on class Info in module __main__:class Info(builtins.object) | Data descriptors defined here: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | lang = 'Python' | | name = 'JournalDev'
Python help() functie met een functie
De functie help() helpt ons om toegang te krijgen tot de syntaxis, parameterlijst en de beschrijving over een functie die aan de functie wordt doorgegeven met behulp van het onderstaande commando.
Syntax:
help('function-name')
Voorbeeld 1:
help('getattr')
Uitvoer:
Voorbeeld 2:
help('map')
Uitvoer:
De Python help()-functie met een module
We kunnen informatie over de module verkrijgen met behulp van de help()-functie. Wanneer een module wordt doorgegeven aan de functie help(), levert deze de documentatie in termen van de versie, de bestandslocatie, de inhoud van de module en de gegevens die ermee zijn geassocieerd.
Syntax:
help('module-name')
Exemplaar:
help('seaborn')
Uitvoer:
De functie help() met een trefwoord
Als u een Python-sleutelwoord als parameter doorgeeft aan de functie help(), geeft de functie de documentatie terug in termen van de klasse van het trefwoord, de methoden die ermee zijn geassocieerd, enzovoort.
Syntax:
help('keyword-name')
Voorbeeld 1:
help(True)
Uitvoer:
Voorbeeld 2:
help(int)
Uitvoer:
Conclusie
Hiermee zijn we aan het einde van dit onderwerp gekomen. We hebben de noodzaak en de werking van de help() functie begrepen. Ik hoop dat dit concept voor alle lezers duidelijk is.