PyLint-Nachricht: Protokollierungsformat-Interpolation

Für den folgenden Code:

logger.debug('message: {}'.format('test'))

pylint erzeugt die folgende Warnung:

Protokollierungsformat-Interpolation (W1202):

Verwenden Sie die% -Formatierung in Protokollierungsfunktionen und übergeben Sie die% -Parameter als Argumente. Wird verwendet, wenn eine Protokollierungsanweisung die Aufrufform "Protokollierung. (Format_string.format (format_args ...))" hat. Solche Aufrufe sollten stattdessen die% -Formatierung verwenden, aber die Interpolation der Protokollierungsfunktion überlassen, indem die Parameter als Argumente übergeben werden.

Ich weiß, dass ich diese Warnung ausschalten kann, aber ich würde sie gerne verstehen. Ich nahm an, dass die Verwendung format()der bevorzugten Methode zum Ausdrucken von Anweisungen in Python 3 ist. Warum gilt dies nicht für Logger-Anweisungen?

Dies gilt nicht für die Logger-Anweisung, da sie sich auf das frühere "%" -Format wie eine Zeichenfolge stützt, um eine verzögerte Interpolation dieser Zeichenfolge mithilfe zusätzlicher Argumente für den Logger-Aufruf zu ermöglichen. Zum Beispiel anstatt zu tun:

logger.error('oops caused by %s' % exc)

du solltest tun

logger.error('oops caused by %s', exc)

Daher wird die Zeichenfolge nur interpoliert, wenn die Nachricht tatsächlich ausgegeben wird.

Sie können diese Funktionalität bei der Verwendung nicht nutzen .format().

Gemäß dem Abschnitt " Optimierung " der loggingDokumente:

Die Formatierung von Nachrichtenargumenten wird verschoben, bis sie nicht mehr vermieden werden kann. Das Berechnen der an die Protokollierungsmethode übergebenen Argumente kann jedoch auch teuer sein, und Sie möchten dies möglicherweise vermeiden, wenn der Protokollierer Ihr Ereignis einfach wegwirft.

Vielleicht können Ihnen diesmal Zeitunterschiede helfen.

Die folgende Beschreibung ist nicht die Antwort auf Ihre Frage, kann aber Menschen helfen.

Für Pylint 2.4: Es gibt drei Optionen für Stil in der Logging - .pylintrcDatei: old, new,fstr

fstrOption in 2.4 hinzugefügt und in 2.5 entfernt

Beschreibung aus .pylintrcDatei (v2.4):

[LOGGING]

# Format style used to check logging format string. `old` means using %
# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings.
logging-format-style=old

für alt ( logging-format-style=old):

foo = "bar"
self.logger.info("foo: %s", foo)

für new ( logging-format-style=new):

foo = "bar"
self.logger.info("foo: {}", foo)
# OR
self.logger.info("foo: {foo}", foo=foo)

Hinweis : Sie können nicht verwenden, .format()auch wenn Sie auswählennew Option .

pylint gibt immer noch die gleiche Warnung für diesen Code aus:

self.logger.info("foo: {}".format(foo))  # W1202
# OR
self.logger.info("foo: {foo}".format(foo=foo))  # W1202

für fstr ( logging-format-style=fstr):

foo = "bar"
self.logger.info(f"foo: {foo}")

Persönlich bevorzuge ich die Option fstr wegen PEP-0498 .

Nach meiner Erfahrung ist ein überzeugenderer Grund als die Optimierung (für die meisten Anwendungsfälle) für die verzögerte Interpolation, dass sie gut mit Protokollaggregatoren wie Sentry funktioniert.

Betrachten Sie eine Protokollmeldung "Benutzer angemeldet". Wenn Sie den Benutzer in die Formatzeichenfolge interpolieren, haben Sie so viele unterschiedliche Protokollnachrichten, wie Benutzer vorhanden sind. Wenn Sie eine verzögerte Interpolation wie diese verwenden, kann der Protokollaggregator dies vernünftigerweise als dieselbe Protokollnachricht mit einer Reihe verschiedener Instanzen interpretieren.