Verwenden Sie print-Anweisungen nur zum Debuggen

Ich habe in letzter Zeit viel in Python programmiert. Und ich habe mit Daten gearbeitet, mit denen ich noch nie gearbeitet habe, mit noch nie dagewesenen Formeln und mit riesigen Dateien. All dies hat mich dazu gebracht, viele Druckanweisungen zu schreiben, um zu überprüfen, ob alles richtig läuft, und um die Fehlerquellen zu identifizieren. Im Allgemeinen ist es jedoch keine gute Praxis, so viele Informationen auszugeben. Wie verwende ich die print-Anweisungen nur, wenn ich debuggen möchte, und lasse sie überspringen, wenn ich nicht möchte, dass sie gedruckt werden?

Das loggingModul bietet alles, was Sie sich wünschen können. Es mag zunächst übertrieben erscheinen, aber verwenden Sie nur die Teile, die Sie benötigen. Ich würde empfehlen , mit logging.basicConfigder Protokollebene auf wechseln stderrund die einfachen Log - Methoden , debug, info, warning, errorund 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))

Eine einfache Möglichkeit, dies zu tun, besteht darin, eine Protokollierungsfunktion aufzurufen:

DEBUG = True

def log(s):
    if DEBUG:
        print s

log("hello world")

Anschließend können Sie den Wert von ändern DEBUGund Ihren Code mit oder ohne Protokollierung ausführen.

Das Standardmodul loggingverfügt hierfür über einen ausgefeilteren Mechanismus.

Verwenden Sie das integrierte Protokollierungsbibliotheksmodul , anstatt zu drucken.

Sie erstellen ein LoggerObjekt (z. B. logger) und geben danach jedes Mal, wenn Sie einen Debug-Druck einfügen, Folgendes ein:

logger.debug("Some string")

Sie können logger.setLevelzu Beginn des Programms den Ausgangspegel einstellen. Wenn Sie DEBUG einstellen, werden alle Debugs gedruckt. Wenn Sie INFO oder höher einstellen, werden alle Debugs sofort ausgeblendet.

Sie können es auch verwenden, um schwerwiegendere Dinge auf verschiedenen Ebenen (INFO, WARNING und ERROR) zu protokollieren.

Zunächst werde ich die Nominierung des Python- Protokollierungsframeworks unterstützen . Seien Sie jedoch ein wenig vorsichtig, wie Sie es verwenden. Insbesondere: Lassen Sie das Protokollierungsframework Ihre Variablen erweitern, und tun Sie es nicht selbst. Zum Beispiel anstelle von:

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

Stellen Sie sicher, dass Sie Folgendes tun:

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

Denn während sie ähnlich aussehen, verursacht die erste Version die repr () - Kosten, selbst wenn sie deaktiviert ist . Die zweite Version vermeidet dies. In ähnlicher Weise würde ich, wenn Sie Ihre eigenen rollen, etwas vorschlagen wie:

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

debug = debug_stdout

angerufen über:

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

Dies vermeidet wiederum den Overhead, wenn Sie ihn deaktivieren, indem Sie Folgendes tun:

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

debug = debug_noop

Der Aufwand für die Berechnung dieser Zeichenfolgen spielt wahrscheinlich keine Rolle, es sei denn, sie sind entweder 1) teuer in der Berechnung oder 2) die Debug-Anweisung befindet sich beispielsweise in der Mitte einer n ^ 3-Schleife oder so. Nicht, dass ich etwas darüber wissen würde.

Ich weiß nichts über andere, aber ich wurde verwendet, um eine "globale Konstante" ( DEBUG) und dann eine globale Funktion ( debug(msg)) zu definieren, die msgnur gedruckt wird , wenn DEBUG == True.

Dann schreibe ich meine Debug-Anweisungen wie folgt:

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

... dann nehme ich Unit-Tests auf und habe das nie wieder gemacht! :) :)