Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

LoggerAdapter.info — registo com contexto

LoggerAdapter.info regista uma mensagem INFO com o contexto do adaptador, como um identificador de pedido. Saiba em que difere o comportamento predefinido de extra de merge_extra=True.

Versão: Python 3.14; repository image, production runtime not attested

Sintaxe

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

LoggerAdapter envolve um logger e acrescenta contexto sem ser necessário repeti-lo em cada chamada. LoggerAdapter.info(msg, *args, **kwargs) corresponde a Logger.info: regista uma mensagem de nível INFO, de acordo com a configuração do registo.

O método process() passa o contexto como extra. Os respetivos campos tornam-se atributos de LogRecord que um Formatter pode apresentar, por exemplo com %(request_id)s. Passe os argumentos da mensagem em separado: adapter.info('Processed %s items', 3).

Por predefinição, merge_extra=False ignora o extra fornecido numa chamada individual. Ao definir merge_extra=True, disponível desde Python 3.13, os dois conjuntos são combinados; os valores específicos da chamada têm prioridade. O exemplo demonstra ambos os comportamentos.

As chaves de extra não podem entrar em conflito com atributos de registo reservados. Se faltar um campo exigido pelo formatador de um handler, a formatação falha e esse handler não emite o registo. Outro handler cujo formatador não exija esse campo pode, ainda assim, emitir o mesmo registo. O adaptador não configura handlers nem contorna os limiares dos níveis de registo.

Exemplos

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='')

Resultado

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

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes