Início / coding / Perguntas / 78992244
Accepted
OmniZ
Asked: 2024-09-17 09:08:05 +0800 CST

Como posso subclassificar logging.Logger sem quebrar %(filename) na sintaxe de interpolação do logging.Formatter

  • 772

Estou tentando escrever uma logging.Loggersubclasse personalizada que está funcionando, mas tenho problemas ao tentar usar uma logging.Formatterque inclui o valor interpolado %(filename)no formato personalizado. Ela imprime o nome do arquivo onde está minha subclasse personalizada, em vez do nome do arquivo do código que chamou a função de registro.

Encontrei vários tutoriais para subclassificar Logger, mas nenhum deles aborda os efeitos que isso tem na interpolação de nome de arquivo. Existe uma solução direta para isso sem ter que sobrescrever grandes seções de logging.Logger?

Código de exemplo definindo meu registrador personalizado:

#-------------------------------------
# custom_logger.py
#-------------------------------------
import logging
import io
class CustomLogger(logging.Logger):
    
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setLevel(logging.DEBUG)
        
        # create the record format
        formatter = logging.Formatter(fmt = "%(filename)s - %(message)s")
        
        # create the handler
        self.stream = io.StringIO()
        handler = logging.StreamHandler(self.stream)
        handler.setFormatter(formatter)
        self.addHandler(handler)
    
    def debug(self, msg, *args, **kwargs):
        super().debug(msg, *args, **kwargs)
        
        # do some other stuff
        ...        

#-------------------------------------
# test.py
#-------------------------------------
from custom_logger import CustomLogger
import logging

logging.setLoggerClass(CustomLogger)
myLog = logging.getLogger("myLog")
myLog.debug("hello world")
print(myLog.stream.getvalue())

Saída esperada: >>> test.py - hello world

Produção real: >>> custom_logger.py - hello world

python

1 respostas

  1. Best Answer

    Isso já foi respondido em https://stackoverflow.com/a/59492341/2138700

    A solução é usar o argumento de palavra-chave stacklevel ao chamar o super().debugno seu código custom_logger. Aqui está a seção relevante da documentação

    O terceiro argumento de palavra-chave opcional é stacklevel, cujo padrão é 1. Se for maior que 1, o número correspondente de quadros de pilha será ignorado ao calcular o número da linha e o nome da função definidos no LogRecord criado para o evento de registro. Isso pode ser usado em auxiliares de registro para que o nome da função, o nome do arquivo e o número da linha registrados não sejam as informações para a função/método auxiliar, mas sim para seu chamador.

    Então o código modificado deve ser

    import logging
import io
class CustomLogger(logging.Logger):
    
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setLevel(logging.DEBUG)
        
        # create the record format
        formatter = logging.Formatter(fmt = "%(filename)s - %(message)s")
        
        # create the handler
        self.stream = io.StringIO()
        handler = logging.StreamHandler(self.stream)
        handler.setFormatter(formatter)
        self.addHandler(handler)
    
    def debug(self, msg, *args, **kwargs):
        super().debug(msg, *args, stacklevel=2, **kwargs)

    Agora a saída serátest.py - hello world

    • 1

relate perguntas