Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

LoggerAdapter.info — logowanie z kontekstem

LoggerAdapter.info zapisuje komunikat INFO z kontekstem adaptera, np. identyfikatorem żądania. Poznaj różnicę między domyślnym extra a merge_extra=True.

Wersja: Python 3.14; repository image, production runtime not attested

Składnia

adapter = logging.LoggerAdapter(logger, extra=None, merge_extra=False)
adapter.info(msg, *args, **kwargs)

LoggerAdapter opakowuje logger i dodaje kontekst bez powtarzania go przy każdym wywołaniu. LoggerAdapter.info(msg, *args, **kwargs) odpowiada metodzie Logger.info: zgłasza komunikat poziomu INFO, z uwzględnieniem konfiguracji logowania.

Metoda process() przekazuje kontekst jako extra. Jego pola stają się atrybutami LogRecord, które może wyświetlić Formatter, np. przez %(request_id)s. Argumenty komunikatu przekazuj oddzielnie: adapter.info('Processed %s items', 3).

Domyślne merge_extra=False oznacza ignorowanie extra podanego w pojedynczym wywołaniu. Ustawienie merge_extra=True, dostępne od Python 3.13, łączy oba zestawy; wartości z wywołania mają pierwszeństwo. Przykład pokazuje oba zachowania.

Klucze extra nie mogą kolidować z zarezerwowanymi atrybutami logowania. Jeśli brakuje pola wymaganego przez formatter danego handlera, występuje błąd formatowania i ten handler nie emituje rekordu. Inny handler, którego formatter nie wymaga tego pola, nadal może wyemitować ten sam rekord. Adapter nie konfiguruje handlerów ani nie omija progów poziomu logowania.

Przykłady

import io
import logging

stream = io.StringIO()
handler = logging.StreamHandler(stream)
handler.setFormatter(logging.Formatter(
    '%(levelname)s %(request_id)s %(message)s'
))
logger = logging.Logger('adapter-demo', level=logging.INFO)
logger.addHandler(handler)

adapter = logging.LoggerAdapter(logger, {'request_id': 'R1'})
adapter.info('Processed %s items', 3)
adapter.info('Default context', extra={'request_id': 'R2'})

merged = logging.LoggerAdapter(
    logger, {'request_id': 'R1'}, merge_extra=True
)
merged.info('Merged context', extra={'request_id': 'R2'})

print(stream.getvalue(), end='')

Wynik

INFO R1 Processed 3 items
INFO R1 Default context
INFO R2 Merged context

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła