Python hilfe() Funktion

Die Hilfe()-Funktion in Python wird verwendet, um die Dokumentation des angegebenen Moduls, der Klasse, der Funktion, der Variablen usw. zu erhalten. Diese Methode wird normalerweise mit der Python-Interpreter-Konsole verwendet, um Details über Python-Objekte zu erhalten.

Python hilfe() Funktion

Die Syntax der Python help() Funktion ist:

help([object])

Wenn kein Argument angegeben wird, startet das interaktive Hilfesystem an der Interpreter-Konsole.

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Wenn Sie die Hilfekonsole verlassen möchten, geben Sie quit ein. Wir können die Hilfedokumentation auch direkt aus der Python-Konsole abrufen, indem wir einen Parameter an die help()-Funktion übergeben.

>>> help('collections')

>>> help(print)

>>> help(globals)

Lass uns sehen, was die Ausgabe der Funktion help() für die Funktion globals() ist.

>>> 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.

Die Funktion help() für benutzerdefinierte Klassen und Funktionen definieren

Wir können die Ausgabe der Funktion help() für unsere benutzerdefinierten Klassen und Funktionen definieren, indem wir einen Docstring (Dokumentationsstring) definieren. Standardmäßig wird der erste Kommentarsatz im Rumpf einer Methode als ihr Docstring verwendet. Er ist von drei doppelten Anführungszeichen umgeben. Angenommen, wir haben eine Python-Datei python_help_examples.py mit folgendem 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

Beachten Sie, dass wir Docstrings für Funktionen, Klassen und deren Methoden definiert haben. Sie sollten ein gewisses Format für die Dokumentation einhalten. Ich habe einige Teile davon automatisch mit der PyCharm IDE generiert. Der NumPy-Dokstring-Leitfaden ist ein guter Ort, um sich einen Eindruck über die richtige Art der Hilfedokumentation zu verschaffen. Lassen Sie uns sehen, wie wir diesen Docstring als Hilfedokumentation in der Python-Konsole erhalten können. Zunächst müssen wir dieses Skript in der Konsole ausführen, um unsere Funktions- und Klassendefinition zu laden. Das können wir mit dem exec() Befehl tun.

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

Wir können bestätigen, dass die Funktionen und Klassendefinitionen mit dem Befehl globals() vorhanden sind.

>>> 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'>}

Beachten Sie, dass 'Mitarbeiter' und 'hinzufügen' im globalen Bereichs-Wörterbuch vorhanden sind. Nun können wir die Hilfedokumentation mithilfe der help()-Funktion abrufen. Schauen wir uns einige Beispiele an.

>>> 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)

Zusammenfassung

Die help()-Funktion in Python ist sehr hilfreich, um Details zu Modulen, Klassen und Funktionen zu erhalten. Es ist immer eine bewährte Praxis, docstrings für benutzerdefinierte Klassen und Funktionen zu definieren, um deren Verwendung zu erklären.

Sie können das vollständige Python-Skript und weitere Python-Beispiele aus unserem GitHub-Repository abrufen.

Referenz: Offizielle Dokumentation