Introduzione
A volte capita di lavorare con un modulo Python e non avere una buona documentazione al riguardo (o non averla affatto). In questo breve HOW TO vedremo come ottenere più informazioni possibile da un modulo Python, come l’elenco delle funzioni o degli attributi per esempio.
Ottenere l’elenco delle funzioni e degli attibuti di un modulo Python
Per prima cosa è necessario importare il modulo
import nomemodulo
Poi per avere l’elenco completo degli attributi e delle funzioni di un modulo Python esiste la funzione dir().
dir(nomemodulo)
Restituisce una lista contenente tutte le funzioni e gli attributi del modulo.
Inoltre per avere informazioni specifiche per ciascuna di queste funzioni, puoi utilizzare la funzione help().
help(nomemodulo)
Esempio
import seolib dir(seolib)
Ecco la lista con tutte le funzioni
['__builtins__', '__doc__', '__file__', '__name__', '__package__', '__path__', '__title__', '__version__', 'api', 'decorators', 'errors', 'get_alexa', 'get_facebook_likes', 'get_google_plus', 'get_semrush', 'get_seomoz_data', 'get_tweets', 'helpers']
Infine se vogliamo conoscere informazioni più dettagliate per esempio sulla funzione get_facebook_likes().
help(seolib.get_facebook_likes()) Help on function wrapper in module seolib.decorators: wrapper(url, *args, **kwargs)
Qualche approfondimento
Tra le funzioni e gli attributi presenti nella lista dell’esempio precedente ci sono alcuni attributi degni di nota. Infatti esiste una serie di attributi che vengono generati da Python in modo automatico quando si crea un nuovo modulo e possono essere utili per ottenere delle informazioni.
__builtins__
Questo attributo contiene tutti gli attributi built-in che sono accessibili dal modulo.
__cached__
Questo attributo ti fornisce il nome e la posizione del file cached associato al modulo. Il path che viene visualizzato è relativo alla directory corrente di Python.
__file__
Questo attributo ti fornisce il nome e la posizione del file del modulo. Il path che viene visualizzato è relativo alla directory corrente di Python
__doc__
Questo attributo visualizza le informazioni del modulo, sempre assumendo che lo sviluppatore le abbia mai inserite.
__initializing__
Determina se il modulo si trova nella fase di inizializzazione. Generalmente questo valore è sempre False, comunque è utile in fase di scripting quando si vuole accertare che un modulo sia stato totalmente importato (ed inizializzato) prima di effettuare qualche particolare operazione (importare un modulo che dipende da esso)
__loader__
Questo attributo mostra le informazioni del loader per questo modulo. Il loader si occupa del modulo appena caricato e lo pone in memoria in modo che Python sia in grado di utilizzarlo.
__name__
Contiene il nome del modulo
__package__
Questo attributo viene utilizzato dal sistema per il caricamento e la gestione del modulo.