2022年 11月 9日

[102]python写日志

文章目录

      • 日志级别
      • basicConfig关键字参数
      • 有用的format格式
      • 简单日志打印:
      • 只输出到文件不在ternimal打印
      • 既输出到文件,又打印到terminal
      • 日常使用

日志级别

级别 何时使用
DEBUG 详细信息,典型地调试问题时会感兴趣。
INFO 证明事情按预期工作。
WARNING 表明发生了一些意外,或者不久的将来会发生问题(如‘磁盘满了’)。软件还是在正常工作。
ERROR 由于更严重的问题,软件已不能执行一些功能了。
CRITICAL 严重错误,表明软件已不能继续运行了。

简单配置使用

# -*- coding:utf-8 -*-
import logging

# 通过下面的方式进行简单配置输出方式与日志级别
logging.basicConfig(filename='logger.log', level=logging.INFO)

logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

输出:
标准输出(屏幕)未显示任何信息,发现当前工作目录下生成了logger.log,内容如下:

INFO:root:info message
WARNING:root:warn message
ERROR:root:error message
CRITICAL:root:critical message

因为通过level=logging.INFO设置日志级别为INFO,所以INFO级别及以上的日志信息均输出出来了。

默认情况下,logging模块将日志打印到屏幕上(stdout),日志级别为WARNING(即只有日志级别高于WARNING的日志信息才会输出),日志格式如下图所示:
image.png

basicConfig关键字参数

关键字 描述
filename 创建一个FileHandler,使用指定的文件名,而不是使用StreamHandler。
filemode 如果指明了文件名,指明打开文件的模式(如果没有指明filemode,默认为’a’)。
format handler使用指明的格式化字符串。
datefmt 使用指明的日期/时间格式。
level 指明根logger的级别。
stream 使用指明的流来初始化StreamHandler。该参数与’filename’不兼容,如果两个都有,’stream’被忽略。

有用的format格式

格式 描述
%(levelno)s 打印日志级别的数值
%(levelname)s 打印日志级别名称
%(pathname)s 打印当前执行程序的路径
%(filename)s 打印当前执行程序名称
%(funcName)s 打印日志的当前函数
%(lineno)d 打印日志的当前行号
%(asctime)s 打印日志的时间
%(thread)d 打印线程id
%(threadName)s 打印线程名称
%(process)d 打印进程ID
%(message)s 打印日志信息

简单日志打印:

filename = time.strftime('%Y-%m-%d', time.localtime(time.time()))

logging.basicConfig(level=logging.DEBUG,
                        format='%(asctime)s \tFile \"%(filename)s\"[line:%(lineno)d] %(levelname)s %(message)s',
                        # datefmt='%a, %d %b %Y %H:%M:%S',
                        filename="./log/" + filename + ".log",
                        filemode='a')

logging.debug('debug message')
logging.info('info message')
logging.warn('warn message')
logging.error('error message')
logging.critical('critical message')
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为,可用参数有

  • filename:用指定的文件名创建FiledHandler(后边会具体讲解handler的概念),这样日志会被存储在指定的文件中。
  • filemode:文件打开方式,在指定了filename时使用这个参数,默认值为“a”还可指定为“w”。
  • format:指定handler使用的日志显示格式。
  • datefmt:指定日期时间格式。
  • level:设置rootlogger; 默认的日志级别设置为WARNING(日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET)
  • stream:用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件,默认为sys.stderr。若同时列出了filename和stream两个参数,则stream参数会被忽略。

format参数中可能用到的格式化串:

%(name)s Logger的名字
%(levelno)s 数字形式的日志级别
%(levelname)s 文本形式的日志级别
%(pathname)s 调用日志输出函数的模块的完整路径名,可能没有
%(filename)s 调用日志输出函数的模块的文件名
%(module)s 调用日志输出函数的模块名
%(funcName)s 调用日志输出函数的函数名
%(lineno)d 调用日志输出函数的语句所在的代码行
%(created)f 当前时间,用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d 输出日志信息时的,自Logger创建以 来的毫秒数
%(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d 线程ID。可能没有
%(threadName)s 线程名。可能没有
%(process)d 进程ID。可能没有
%(message)s用户输出的消息

logging库提供了两个可以用于日志滚动的class(可以参考https://docs.python.org/2/library/logging.handlers.html,一个是RotatingFileHandler,它主要是根据日志文件的大小进行滚动,另一个是TimeRotatingFileHandler,它主要是根据时间进行滚动。在实际应用中,我们通常根据时间进行滚动,因此,本文中主要介绍TimeRotaingFileHandler的使用方法(RotatingFileHandler一样)。

只输出到文件不在ternimal打印

import logging,re
from logging.handlers import TimedRotatingFileHandler
from logging.handlers import RotatingFileHandler

filename = time.strftime('%Y-%m-%d', time.localtime(time.time()))

def log_init(message):
    log_fmt = '%(asctime)s\tFile \"%(filename)s\",line %(lineno)s\t%(levelname)s: %(message)s'
    formatter = logging.Formatter(log_fmt)

    log_file_handler = TimedRotatingFileHandler(filename="./log/" + filename + ".log", when="D", interval=1, backupCount=30)
    log_file_handler.suffix = "%Y-%m-%d.log"
    log_file_handler.extMatch = re.compile(r"^\d{4}-\d{2}-\d{2}.log$")

    log_file_handler.setFormatter(formatter)
    log_file_handler.setLevel(logging.DEBUG)
    log = logging.getLogger()
    log.addHandler(log_file_handler)
    '''
    程序运行
    '''
    log.info(message)
    #removeHandler 要放在程序运用打印日志的后面
    log.removeHandler(log_file_handler)
    #  用pop方法把logger.handlers列表中的handler移除,注意如果你add了多个handler,这里需多次pop,或者可以直接为handlers列表赋空值
    # log.handlers.pop()
    # log.handler = []

log_init('1234')
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29

结果是每天生成一个日志文件,保留最近30天的日志文件。

when:是一个字符串,用于描述滚动周期的基本单位,字符串的值及意义如下:

  • “S”: Seconds
  • “M”: Minutes
  • “H”: Hours
  • “D”: Days
  • “W”: Week day (0=Monday)
  • “midnight”: Roll over at midnight
  • interval: 滚动周期,单位有when指定,比如:when=’D’,interval=1,表示每天产生一个日志文件;
  • backupCount: 表示日志文件的保留个数;

删除日志文件设置:

log_file_handler.suffix = “%Y-%m-%d_%H-%M.log” 
log_file_handler.extMatch = re.compile(r”^\d{4}-\d{2}-\d{2}_\d{2}-\d{2}.log$”) 
  • 1
  • 2

suffix和extMatch的格式要相对应,Year-4位,m-2位 以此类推

既输出到文件,又打印到terminal

import logging

filename = time.strftime('%Y-%m-%d', time.localtime(time.time()))

def initLogging(message):
    logging.basicConfig(
                    level    = logging.DEBUG,
                    format   = '%(asctime)s\tFile \"%(filename)s\",line %(lineno)s\t%(levelname)s: %(message)s',
                    # datefmt  = '%a, %d %b %Y %H:%M:%S',
                    filename = "./log/" + filename + ".log",
                    filemode = 'w')
    #添加StreamHandler在控制台也打印出来
    console = logging.StreamHandler()
    console.setLevel(logging.INFO)
    formatter = logging.Formatter('LINE %(lineno)-4d : %(levelname)-8s %(message)s')
    console.setFormatter(formatter)

    logging.getLogger('').addHandler(console)
    logging.info(message)

initLogging('123')
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

通过logging.StreamHandler()函数来打印到terminal

新建一个文件:myLog.py

# encoding:utf-8  
import sys  
import logging  
import time  
   
def writeLog(message):
    logger = logging.getLogger()
    # streamhandler = logging.StreamHandler()
    filename = time.strftime('%Y-%m-%d', time.localtime(time.time()))

    handler = logging.FileHandler("./log/" + filename + ".log")
    logger.addHandler(handler)
    logger.setLevel(logging.INFO )
    logger.info(datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')+':'+message)

    #  添加下面一句,在记录日志之后移除句柄
    logger.removeHandler(handler)
   
if __name__ == '__main__':  
    writeLog("hello")  
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20

然后直接在其他文件引用import myLog ,对于要写入的消息 用 myLog.writeLog(‘insert bad ‘) 写入 insert bad 的消息

日常使用

# -*- coding:utf-8 -*-
import os,sys, time
import json,requests
import logging,logging.handlers

def get_logger(log_name='',date_str=None):
    local_path="./logs/"
    if not os.path.exists(local_path):
        # os.mkdir(local_path)# 只能创建一级目录
        os.makedirs(local_path)  # 可以创建多级目录
    if date_str==None:
        date_str = time.strftime('%Y-%m-%d', time.localtime(time.time()))

    logfile = local_path + date_str + log_name + ".log"
    # hander = logging.handlers.RotatingFileHandler(logfile,encoding='utf-8')
    # 日志文件切割
    hander = logging.handlers.TimedRotatingFileHandler(filename=logfile, when="D", interval=1, backupCount=60)
    hander.suffix = hander.suffix + ".log"
    # print(hander.suffix)
    formatter = logging.Formatter('%(asctime)s [%(filename)s:%(lineno)s][%(levelname)s] %(message)s')
    hander.setFormatter(formatter)
    logger = logging.getLogger(logfile)
    ## 每次被调用后,清空已经存在handler,不然日志会打印多遍
    logger.handlers.clear()
    logger.addHandler(hander)
    logger.setLevel(logging.INFO)

    return logger

logger=get_logger(log_name='_test',date_str=None)
logger.info('test')
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31

参考:https://www.jianshu.com/p/feb86c06c4f4
https://wenku.baidu.com/view/0601b8d2b90d4a7302768e9951e79b8969026845.html