Python Hilfe() Funktion

Die Python-Hilfsfunktion help() wird verwendet, um die Dokumentation für ein bestimmtes Modul, eine Klasse, eine Funktion, Variablen usw. zu erhalten. Diese Methode wird normalerweise mit der Python-Interpreter-Konsole verwendet, um Details über Python-Objekte zu erhalten.

Python-Hilfsfunktion help()

Die Syntax der Python-Hilfsfunktion help() lautet:

help([object])

Wenn kein Argument angegeben wird, wird das interaktive Hilfesystem auf der Interpreter-Konsole gestartet. In der Python-Hilfekonsole können wir Modul, Klasse und Funktionsnamen angeben, um ihre Hilfsdokumentation zu erhalten. Einige davon sind:

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 auch die Hilfsdokumentation direkt von der Python-Konsole abrufen, indem wir einen Parameter an die help() Funktion übergeben.

>>> help('collections')

>>> help(print)

>>> help(globals)

Lassen Sie uns sehen, was die Ausgabe der Hilfe() Funktion 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.

Definieren von help() für benutzerdefinierte Klassen und Funktionen

Wir können die Ausgabe der help() Funktion für unsere benutzerdefinierten Klassen und Funktionen definieren, indem wir einen Docstring (Dokumentationszeichenkette) definieren. Standardmäßig wird der erste Kommentarstring 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 Funktion, Klasse und deren Methoden definiert haben. Sie sollten einem bestimmten Format für die Dokumentation folgen. Ich habe einen Teil von ihnen automatisch mit der PyCharm-IDE generiert. Die NumPy-Docstring-Anleitung ist ein guter Ort, um eine Vorstellung von der richtigen Art der Hilfe-Dokumentation zu bekommen. Schauen wir uns an, wie wir diesen Docstring als Hilfe 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. Dies können wir mit dem Befehl exec() tun.

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

Wir können überprüfen, ob 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 ‚Employee‘ und ‚add‘ im globalen Scope-Dictionary vorhanden sind. Jetzt können wir die Hilfe-Dokumentation mit der Funktion help() 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 Python-Hilfefunktion help() ist sehr hilfreich, um Details über Module, Klassen und Funktionen zu erhalten. Es ist immer bewährte Praxis, für benutzerdefinierte Klassen und Funktionen Docstrings zu definieren, um ihre Verwendung zu erklären.

Sie können vollständige Python-Skripte und weitere Python-Beispiele aus unserem GitHub-Repository überprüfen.

Referenz: Offizielle Dokumentation