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

CKTIS / Python

logging.Handler.setFormatter — definir o formatador de um handler

`logging.Handler.setFormatter` atribui um formatador a um handler ou remove-o quando se passa `None`. Controla a apresentação da saída, não o limiar do nível de registo.

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

Sintaxe

handler.setFormatter(fmt)

logging.Handler.setFormatter(fmt) define o formatador de um handler específico. O método não verifica se fmt é uma instância de logging.Formatter. A implementação padrão de Handler.format(record) também pode usar outro objeto, desde que este seja avaliado como verdadeiro num contexto booleano e disponibilize um método format(record) compatível. Uma simples cadeia de formato não substitui um formatador. Por exemplo, usa handler.setFormatter(logging.Formatter("%(levelname)s | %(message)s")).

A chamada handler.setFormatter(None) remove o formatador atribuído. Quando o handler utiliza Handler.format(record), passa então a ser usado o formatador predefinido do módulo: uma mensagem normal não recebe qualquer prefixo de nível nem de nome do logger. Isto não desativa o registo.

Um formatador controla a apresentação do registo; os limiares de nível e os filtros determinam o seu processamento. A definição aplica-se a este handler, não a todos os handlers do logger. O padrão de saída do formatador é independente da interpolação dos argumentos da mensagem, como em logger.info("Items: %s", 3).

O exemplo captura a saída em io.StringIO, primeiro com um formato personalizado e depois de o remover. Omite as marcas temporais e a configuração do logger raiz para manter o resultado determinístico.

Exemplos

import io
import logging

stream = io.StringIO()
handler = logging.StreamHandler(stream)
logger = logging.getLogger("demo")
logger.setLevel(logging.INFO)
logger.propagate = False
logger.addHandler(handler)

handler.setFormatter(logging.Formatter("%(levelname)s | %(message)s"))
logger.info("Items: %s", 3)

handler.setFormatter(None)
logger.info("Items: %s", 3)

print(stream.getvalue(), end="")
logger.removeHandler(handler)
handler.close()

Resultado

INFO | Items: 3
Items: 3

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