Python Logging Facility - Sistema de Log do Python

Porque complicar tanto ?

Em casos mais simples, se quisermos monitorar um passo-a-passo da execução podemos simplesmente usar um monte de prints() dentro do código certo? - certo!

O registro de atividades do sistema - o "log", pode ficar bastante complexo, desde um simples registro para "debugar" a aplicação, até registrar falhas no sistema e métricas de execução quando em produção. É justamente aí que entra o "logging"do Pyhton, para que o programador não tenha que definir previamente como será este controle, e nem ecrever seu próprio código para gerenciar as mensagens, independente do contexto - desenvolvimento e/ou produção.

Utilizando o "logging" do Python, simplesmente usamos o objeto logger para emitir as mensagens, e posso definir depois se serão impressas na tela, em um arquivo, ou mesmo quais mensagens ou de qual tipo envio para um arquivo, terminal ou endereço de rede. E não preciso alterar código. ... se fizer com cuidado, claro!

"O uso de do print() pode inclusive levar a erros de execução - Por exemplo, se a aplicação for instalada em um servidor sem um terminal"

—sim, experiência própria!

Porque o sistema de registro através do Logger?

Porque é simples, bom e barato!

para ter um log funcionando basta ...

# exemplo de código Python para preparar o sistema de "log"
import logging
import sys

logger = logging.getLogger(__name__)  # o parâm. `__name__` pega o nome do módulo Python.

# e pode usar a vontade ... "emitindo" mensagens.
logging.debug('Mensagem de debug')

# o  `Handler`,`Filter` e o `Formatter` não precisam necessariamente serem definidos ou usados!

Pronto, o código acima é tudo que você precisa para não usar print() para analisar seu código, e ganhamos uma série de controles que iremos explorar no restante do texto.

Níveis de mensagens

cada vez que for necessário imprimir um "log", basta utilizar logger.<level>(<msg>) ao invés de um print(). Como abaixo.

logger.warning('This is a warning message to stdout') # no lugar do Print!!

E é possível identificar níveis diferentes de mensagens.

logging.debug('Mensagem de debug')       #logging.DEBUG    = 10
logging.info('Mensagem de info')         #logging.INFO     = 20
logging.warning('Mensagem de warning')   #logging.WARNING  = 30
logging.critical('Mensagem de critical') #logging.CRITICAL = 50
logging.error('Mensagem de error')       #logging.ERROR    = 40

Identificando as mensagens propriamente fica fácil aumentar ou diminuir a sensibilidade do sistema de "log".

Por exemplo, se estou construindo o sistema, preciso de todas as mensagens (<=10), mas se estou enviando o sistema para produção, só preciso registrar os erros, então posso configurar o sistema para emitir mensagens somente a partir de logging.warning ou ">=30".

4 maneiras de se definir um Logger

import logging

# 1º ou
# Cria o logger raiz
logger = logging.getLogger()

# 2º ou
# Cria um "logger" chamado "module_1"
logger_module_1 = logging.getLogger('module_1')  # este está hierarquicamente abaixo de logger automaticamente!

...
# 3º ou
# podemos indicar a relação pai x filho usando a notação de ponto do Python ("dot notation")
logger_module_1.klass_1 = logging.getLogger('module_1.klass_1')

# 4º ou
# ou ainda podemos explicitamente criar um filho
logger_module_2 = logging.getLogger('module_2')
logger_module_2_klass = logger_module_2.getChild('klass')

# tá na dúvida? Use a 2º opção, lembre-se, "feito é melhor que não feito!"

Apesar de podermos utilizar o Logger de maneira simples, sem especificar um nome ou hirarquia, alguns softwares podem demandar tal complexidade, particularmente ao criarmos uma "lib" Python que será incorporada em outros softwares.