Komunikat PyLint: interpolacja formatu logowania

Dla następującego kodu:

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

pylint generuje następujące ostrzeżenie:

interpolacja formatu logowania (W1202):

Użyj formatowania% w funkcjach rejestrowania i przekaż parametry% jako argumenty Używane, gdy instrukcja logowania ma postać wywołania „logging. (Format_string.format (format_args ...))”. Takie wywołania powinny zamiast tego używać formatowania%, ale pozostawić interpolację funkcji rejestrowania, przekazując parametry jako argumenty.

Wiem, że mogę wyłączyć to ostrzeżenie, ale chciałbym je zrozumieć. Założyłem, że używanie format()jest preferowanym sposobem drukowania instrukcji w Pythonie 3. Dlaczego nie jest to prawdą w przypadku instrukcji rejestrujących?

Nie jest to prawdą w przypadku instrukcji rejestrującej, ponieważ opiera się ona na poprzednim formacie „%”, takim jak łańcuch, w celu zapewnienia leniwej interpolacji tego ciągu przy użyciu dodatkowych argumentów przekazanych do wywołania rejestratora. Na przykład zamiast robić:

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

powinieneś zrobić

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

więc łańcuch będzie interpolowany tylko wtedy, gdy wiadomość zostanie faktycznie wyemitowana.

Nie możesz korzystać z tej funkcji podczas korzystania z .format().

Zgodnie z sekcją Optymalizacja w loggingdokumentacji:

Formatowanie argumentów wiadomości jest odroczone, dopóki nie będzie można tego uniknąć. Jednak obliczanie argumentów przekazanych do metody rejestrowania może być również kosztowne i możesz chcieć tego uniknąć, jeśli rejestrator po prostu wyrzuci twoje zdarzenie.

Może tym razem różnice pomogą Ci .

Poniższy opis nie jest odpowiedzią na Twoje pytanie, ale może pomóc ludziom.

Dla pylint 2.4: Istnieją 3 opcje zalogowaniu styl w .pylintrcpliku: old, new,fstr

fstropcja dodana w 2.4 i usunięta w 2.5

Opis z .pylintrcpliku (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

dla starego ( logging-format-style=old):

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

dla nowego ( logging-format-style=new):

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

Uwaga : można nie używać .format()nawet po wybraniunew opcji.

pylint nadal daje to samo ostrzeżenie dla tego kodu:

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

dla fstr ( logging-format-style=fstr):

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

Osobiście wolę opcję fstr ze względu na PEP-0498 .

Z mojego doświadczenia wynika, że ​​bardziej przekonującym powodem niż optymalizacja (w większości przypadków użycia) leniwej interpolacji jest to, że działa ona dobrze z agregatorami dzienników, takimi jak Sentry.

Rozważ komunikat dziennika „użytkownik zalogował się”. Jeśli interpolujesz użytkownika do ciągu formatu, masz tyle różnych komunikatów dziennika, ile jest użytkowników. Jeśli używasz tak leniwej interpolacji, agregator dziennika może rozsądniej zinterpretować to jako ten sam komunikat dziennika z wieloma różnymi wystąpieniami.