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

CKTIS / Python

Registar avisos com contexto de equipa através de `LoggerAdapter`

Encapsula um logger existente em `logging.LoggerAdapter` com um campo `team` para que as chamadas a `info`, `warning` e `error` partilhem o mesmo contexto de equipa.

Versão: Python 3.12

Sintaxe

adapter = logging.LoggerAdapter(logger, {"team": "Platform"})
adapter.info(msg, *args, **kwargs)
adapter.warning(msg, *args, **kwargs)
adapter.error(msg, *args, **kwargs)

Em Python 3.12, logging.LoggerAdapter(logger, {"team": "Platform"}) encapsula um logger existente e encaminha-lhe as chamadas com o contexto da equipa. Usa adapter.warning(...) para registar um WARNING quando acontece algo inesperado ou se prevê um possível problema. adapter.info(...) indica o progresso normal (INFO) e adapter.error(...) indica que uma operação falhou (ERROR). Já as funções do módulo logging.info, logging.warning e logging.error usam o logger raiz e não recebem automaticamente o contexto do adaptador.

Em Python 3.12, a implementação predefinida de process() mantém a mensagem inalterada e passa o mapeamento do construtor como extra. Se passares extra numa chamada ao adaptador, esse valor é substituído, não combinado com o do construtor. team torna-se um atributo de LogRecord, pelo que um Formatter o pode apresentar com %(team)s. As chaves de extra não podem coincidir com atributos reservados do registo.

Todos os registos processados por esse formatador têm de conter team; caso contrário, a formatação falha. A configuração do logger e do handler continua a determinar se a mensagem é emitida. No exemplo, o limiar INFO deixa passar os três níveis.

Exemplos

import logging
import sys

logger = logging.getLogger("ck tis.deployment".replace(" ", ""))
logger.setLevel(logging.INFO)
logger.propagate = False

handler = logging.StreamHandler(sys.stdout)
handler.setFormatter(logging.Formatter("%(levelname)s [%(team)s] %(message)s"))
logger.addHandler(handler)

adapter = logging.LoggerAdapter(logger, {"team": "Platform"})
adapter.info("Deployment started")
adapter.warning("Retrying health check")
adapter.error("Deployment failed")

Resultado

INFO [Platform] Deployment started
WARNING [Platform] Retrying health check
ERROR [Platform] Deployment failed

Executa o código como um script autónomo em Python 3.12. O handler escreve na saída padrão e a propagação desativada impede que os registos cheguem aos loggers superiores. São esperadas três linhas, cada uma com `[Platform]`.

Lições relacionadas

  • Python · Lição 27 · Avançado · Versão: 5

Fontes