Utilizzo di istruzioni print solo per eseguire il debug

Negli ultimi tempi ho scritto molto in Python. E ho lavorato con dati su cui non avevo mai lavorato prima, utilizzando formule mai viste prima e gestendo file enormi. Tutto ciò mi ha fatto scrivere molte dichiarazioni di stampa per verificare se tutto va bene e identificare i punti di errore. Ma, in generale, fornire così tante informazioni non è una buona pratica. Come posso utilizzare le istruzioni print solo quando voglio eseguire il debug e lasciarle ignorare quando non voglio che vengano stampate?

Il loggingmodulo ha tutto ciò che potresti desiderare. All'inizio può sembrare eccessivo, ma usa solo le parti di cui hai bisogno. Mi consiglia di utilizzare logging.basicConfigper attivare o disattivare il livello di registrazione stderrei metodi di registro semplice , debug, info, warning, errore critical.

import logging, sys
logging.basicConfig(stream=sys.stderr, level=logging.DEBUG)
logging.debug('A debug message!')
logging.info('We processed %d records', len(processed_records))

Un modo semplice per farlo è chiamare una funzione di registrazione:

DEBUG = True

def log(s):
    if DEBUG:
        print s

log("hello world")

Quindi puoi modificare il valore di DEBUGed eseguire il codice con o senza registrazione.

Il loggingmodulo standard ha un meccanismo più elaborato per questo.

Utilizzare la registrazione modulo incorporato libreria al posto della stampa.

Crei un Loggeroggetto (diciamo logger) e poi, ogni volta che inserisci una stampa di debug, metti semplicemente:

logger.debug("Some string")

È possibile utilizzare logger.setLevelall'inizio del programma per impostare il livello di uscita. Se lo imposti su DEBUG, stamperà tutti i debug. Impostalo su INFO o superiore e immediatamente tutti i debug scompariranno.

Puoi anche usarlo per registrare cose più serie, a diversi livelli (INFO, ATTENZIONE ed ERRORE).

Prima di tutto, seguirò la nomina del framework di registrazione di Python . Tuttavia, fai un po 'attenzione a come lo usi. Nello specifico: lascia che il framework di registrazione espanda le tue variabili, non farlo da solo. Ad esempio, invece di:

logging.debug("datastructure: %r" % complex_dict_structure)

assicurati di fare:

logging.debug("datastructure: %r", complex_dict_structure)

perché mentre sembrano simili, la prima versione sostiene il costo di repr () anche se è disabilitata . La seconda versione lo evita. Allo stesso modo, se fai il tuo, suggerirei qualcosa del tipo:

def debug_stdout(sfunc):
    print(sfunc())

debug = debug_stdout

chiamato tramite:

debug(lambda: "datastructure: %r" % complex_dict_structure)

che, ancora una volta, eviterà l'overhead se lo disabiliti facendo:

def debug_noop(*args, **kwargs):
    pass

debug = debug_noop

Il sovraccarico del calcolo di quelle stringhe probabilmente non ha importanza a meno che non siano 1) costosi da calcolare o 2) l'istruzione di debug sia nel mezzo, diciamo, di un ciclo n ^ 3 o qualcosa del genere. Non che ne sapessi nulla.

Non conosco altri, ma ero abituato a definire una "costante globale" ( DEBUG) e quindi una funzione globale ( debug(msg)) che sarebbe stampata msgsolo se DEBUG == True.

Quindi scrivo le mie dichiarazioni di debug come:

debug('My value: %d' % value)

... poi riprendo i test unitari e non l'ho più fatto! :)