Python help() functie

De Python help() functie wordt gebruikt om de documentatie van een gespecificeerde module, klasse, functie, variabelen, enz. te verkrijgen. Deze methode wordt meestal gebruikt met de Python-interpreterconsole om details over Python-objecten te krijgen.

Python help() functie

De syntax van de Python help() functie is:

help([object])

Als er geen argument wordt gegeven, start het interactieve help-systeem op de interpreterconsole. In de Python help-console kunnen we de namen van module, klasse, functie opgeven om hun help-documentatie te krijgen. Enkele voorbeelden zijn:

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Als je de help-console wilt verlaten, typ dan quit. We kunnen ook de help-documentatie rechtstreeks vanuit de Python-console krijgen door een parameter aan de help() functie door te geven.

>>> help('collections')

>>> help(print)

>>> help(globals)

Laten we eens kijken wat de uitvoer is van de help() functie voor de globals() functie.

>>> help('builtins.globals')

Help on built-in function globals in builtins:

builtins.globals = globals()
    Return the dictionary containing the current scope's global variables.
    
    NOTE: Updates to this dictionary *will* affect name lookups in the current global scope and vice-versa.

Het definiëren van help() voor aangepaste klasse en functies

We kunnen de uitvoer van de help() functie definiëren voor onze aangepaste klassen en functies door een docstring (documentatiestring) te definiëren. Standaard wordt de eerste opmerkingreeks in de body van een methode gebruikt als de docstring. Het is omgeven door drie dubbele aanhalingstekens. Laten we zeggen dat we een Python-bestand hebben met de naam python_help_examples.py met de volgende code.

def add(x, y):
    """
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
    """
    return x + y


class Employee:
    """
    Employee class, mapped to "employee" table in Database
    """
    id = 0
    name = ''

    def __init__(self, i, n):
        """
        Employee object constructor
        :param i: integer, must be positive
        :param n: string
        """
        self.id = i
        self.name = n

Merk op dat we een docstring hebben gedefinieerd voor de functie, klasse en de methoden ervan. U moet een bepaald formaat volgen voor documentatie; ik heb automatisch een deel ervan gegenereerd met behulp van de PyCharm IDE. NumPy docstring-gids is een goede plek om wat ideeën op te doen over de juiste manier van documenteren. Laten we nu kijken hoe we deze docstring als help-documentatie kunnen verkrijgen in de Python-console. Allereerst moeten we dit script uitvoeren in de console om onze functie- en klassedefinitie te laden. Dit kunnen we doen met het exec()-commando.

>>> exec(open("python_help_examples.py").read())

We kunnen verifiëren dat de functies en klassedefinities aanwezig zijn met behulp van het globals() commando.

>>> globals()
{'__name__': '__main__', '__doc__': None, '__package__': None, '__loader__': <class '_frozen_importlib.BuiltinImporter'>, '__spec__': None, '__annotations__': {}, '__builtins__': <module 'builtins' (built-in)>, '__warningregistry__': {'version': 0}, 'add': <function add at 0x100dda1e0>, 'Employee': <class '__main__.Employee'>}

Merk op dat ‘Employee’ en ‘add’ aanwezig zijn in het globale scopewoordenboek. Nu kunnen we de help-documentatie verkrijgen met behulp van de help() functie. Laten we eens kijken naar enkele voorbeelden.

>>> help('python_help_examples')

>>> help('python_help_examples.add')

Help on function add in python_help_examples:

python_help_examples.add = add(x, y)
    This function adds the given integer arguments
    :param x: integer
    :param y: integer
    :return: integer
(END)

>>> help('python_help_examples.Employee')

>>> help('python_help_examples.Employee.__init__')


Help on function __init__ in python_help_examples.Employee:

python_help_examples.Employee.__init__ = __init__(self, i, n)
    Employee object constructor
    :param i: integer, must be positive
    :param n: string
(END)

Samenvatting

De Python help() functie is erg handig om details over modules, klassen en functies te krijgen. Het is altijd een goede praktijk om docstrings te definiëren voor aangepaste klassen en functies om hun gebruik uit te leggen.

Je kunt complete Python-scripts en meer Python-voorbeelden bekijken op onze GitHub Repository.

Referentie: Officiële documentatie