Funzione help() di Python

La funzione help() di Python viene utilizzata per ottenere la documentazione di un modulo, una classe, una funzione, delle variabili, ecc. Questo metodo è generalmente utilizzato con la console dell’interprete Python per ottenere dettagli sugli oggetti Python.

Funzione help() di Python

La sintassi della funzione help() di Python è:

help([object])

Se nessun argomento viene fornito, il sistema di aiuto interattivo si avvia sulla console dell’interprete. Nella console di aiuto di Python, possiamo specificare i nomi dei moduli, delle classi, delle funzioni per ottenere la loro documentazione di aiuto. Alcuni di essi sono:

help> True

help> collections

help> builtins

help> modules

help> keywords

help> symbols

help> topics

help> LOOPING

Se si desidera uscire dalla console di aiuto, digitare quit. Possiamo anche ottenere la documentazione di aiuto direttamente dalla console di Python passando un parametro alla funzione help().

>>> help('collections')

>>> help(print)

>>> help(globals)

Vediamo qual è l’output della funzione help() per la funzione globals().

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

Definizione di help() per classi e funzioni personalizzate

È possibile definire l’output della funzione help() per le nostre classi e funzioni personalizzate definendo una docstring (stringa di documentazione). Per impostazione predefinita, la prima stringa di commento nel corpo di un metodo viene utilizzata come docstring. È circondata da tre doppie virgolette. Supponiamo di avere un file Python python_help_examples.py con il seguente codice.

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

Nota che abbiamo definito la docstring per la funzione, la classe e i suoi metodi. Dovresti seguire un certo formato per la documentazione, ho generato automaticamente alcune parti di esse usando l’IDE PyCharm. Guida alla docstring di NumPy è un buon punto di riferimento per avere un’idea del modo corretto di documentare l’aiuto. Vediamo come ottenere questa docstring come documentazione di aiuto nella console Python. Prima di tutto, dovremo eseguire questo script nella console per caricare la definizione della nostra funzione e classe. Possiamo farlo usando il comando exec().

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

Possiamo verificare che le definizioni delle funzioni e delle classi siano presenti utilizzando il comando globals().

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

Nota che ‘Employee’ e ‘add’ sono presenti nel dizionario dello scope globale. Ora possiamo ottenere la documentazione di aiuto utilizzando la funzione help(). Vediamo alcuni esempi.

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

Sommario

La funzione help() di Python è molto utile per ottenere dettagli sui moduli, le classi e le funzioni. È sempre una pratica consigliata definire una docstring per le classi e le funzioni personalizzate per spiegare il loro utilizzo.

Puoi controllare lo script completo di Python e altri esempi di Python dal nostro Repository su GitHub.

Riferimento: Documentazione Ufficiale