logging日志模块

Posted 2022-04-29 xp1315458571

一、logging 日志模块

1.logging 日志模块的五个等级10-50             

import logging
logging.basicConfig(filename=‘access.log‘,
                    format=‘%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s‘,
                    datefmt=‘%Y-%m-%d %H:%M:%S %p‘,
                    level=40,
                    )
logging.debug(‘debug日志‘)  # 10      
logging.info(‘info日志‘)  # 20        
logging.warning(‘warning日志‘)  # 30  
logging.error(‘error日志‘)  # 40      
logging.critical(‘critical日志‘)  # 50
#以上程序有以下几个问题：
# 1.乱码  #执行程序会立马生成access文件来记录相应等级的日志信息，打开后发现乱码，怎么办？
# 2.日志格式 #格式怎么任意更改？
# 3.如何既打印到终端又写到文件中  #怎样实现既能保存到文件又能在终端打印？

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

filename：用指定的文件名创建FiledHandler，这样日志会被存储在指定的文件中。
filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。
format：指定handler使用的日志显示格式。
datefmt：指定日期时间格式。
level：设置rootlogger（后边会讲解具体概念）的日志级别
stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件(f=open(‘test.log’,’w’))，默认为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用户输出的消息

配置参数

 

2.日志模块的四个对象                                 

1.logger对象:负责产生日志
2.filter对象:过滤日志(了解)
3.handler对象:控制日志输出的位置(文件/终端)
4.formater对象:规定日志内容的格式

四个对象工作流程：
logger对象传到filter过滤之后绑定上handler对象，handler再从formater中取出一个格式来绑定后传输给文件或者终端

#简单使用（先了解）
import logging
# 1.logger对象:负责产生日志
logger = logging.getLogger(‘转账记录‘)
# 2.filter对象:过滤日志(了解)

# 3.handler对象:控制日志输出的位置(文件/终端)
hd1 = logging.FileHandler(‘a1.log‘,encoding=‘utf-8‘)  # 输出到文件中，解决乱码
hd2 = logging.FileHandler(‘a2.log‘,encoding=‘utf-8‘)  # 输出到文件中，解决乱码
hd3 = logging.StreamHandler()  # 输出到终端，括号内不需要任何格式

# 4.formmater对象:规定日志内容的格式
fm1 = logging.Formatter(
        fmt=‘%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s‘,
        datefmt=‘%Y-%m-%d %H:%M:%S %p‘,) #直接复制过来格式改一改就好了
fm2 = logging.Formatter(
        fmt=‘%(asctime)s - %(name)s:  %(message)s‘,
        datefmt=‘%Y-%m-%d‘,)#可以跟多个格式

# 5.给logger对象绑定handler对象
logger.addHandler(hd1)
logger.addHandler(hd2)
logger.addHandler(hd3)

# 6.给handler绑定formmate对象
hd1.setFormatter(fm1)
hd2.setFormatter(fm2)
hd3.setFormatter(fm1)

# 7.设置日志等级
logger.setLevel(10)

# 8.记录日志
logger.debug(‘写了半天 好累啊 好热啊 好想释放‘)  #对应10，如果上面等级设置>10，这里不会输出

四个对象的简单使用 了解

每次写个格式写这么多累不？痛苦不？如果来一个写好的配置字典，每次我们改个格式直接用多好

3.配置字典                                                        

3.1 定义日志                

import os
import logging.config

# 定义两种日志输出格式 开始
standard_format = ‘[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]‘                   ‘[%(levelname)s][%(message)s]‘ # 格式一 其中name为getlogger指定的名字

simple_format = ‘[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s‘  #格式二
# 定义日志输出格式 结束

"""
下面的两个变量对应的值 需要你手动修改
"""
logfile_dir = os.path.dirname(__file__)  # log文件的目录 这里返回几层看实际情况进行修改
logfile_name = ‘a3.log‘  # log文件名 这个随便起名
# 如果不存在定义的日志目录就创建一个
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)

# log文件的全路径
logfile_path = os.path.join(logfile_dir, logfile_name)

配置开始

3.2 配置字典        　　   

# log配置字典
LOGGING_DIC = 
    ‘version‘: 1,
    ‘disable_existing_loggers‘: False,
    ‘formatters‘: 
        ‘standard‘: 
            ‘format‘: standard_format
        , #格式一
        ‘simple‘: 
            ‘format‘: simple_format
        ,  #格式二
    ,
    ‘filters‘: ,  # 过滤日志
    ‘handlers‘: 
        #打印到终端的日志
        ‘console‘: 
            ‘level‘: ‘DEBUG‘, #也就是10级以上的都输出
            ‘class‘: ‘logging.StreamHandler‘,  # 打印到屏幕
            ‘formatter‘: ‘simple‘ #这个simple不能随便改，要和formates里面的simple对应
        ,
        #打印到文件的日志,收集info及以上的日志
        ‘default‘: 
            ‘level‘: ‘DEBUG‘,
            ‘class‘: ‘logging.handlers.RotatingFileHandler‘,  # 保存到文件
            ‘formatter‘: ‘standard‘,
            ‘filename‘: logfile_path,  # 日志文件
            ‘maxBytes‘: 1024*1024*5,  # 日志大小 5M 一个存满了再建文件夹
            ‘backupCount‘: 5, #最多新建5个文件，满了之后自动清除之前的文件内容
            ‘encoding‘: ‘utf-8‘,  # 日志文件的编码，再也不用担心中文log乱码了
        ,
    ,
    ‘loggers‘: 
        #logging.getLogger(__name__)拿到的logger配置
        ‘‘:   #这里定义的空字符，后面的‘我是空字符串’键不存在时，默认就使用该K-V键值对
            ‘handlers‘: [‘default‘, ‘console‘],  # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕，正式上线后不能要console，他会一直往终端输出
            ‘level‘: ‘DEBUG‘,
            ‘propagate‘: True,  # 向上（更高level的logger）传递
        ,  # 当键不存在的情况下 默认都会使用该k:v配置
    ,

配置字典

3.3 使用日志字典配置    

# 使用日志字典配置
logging.config.dictConfig(LOGGING_DIC)  # 自动加载字典中的配置（一步帮我们干了1-7步，最后8的写日志我们要自己做）
logger1 = logging.getLogger(‘我是空字符串‘)
logger1.debug(‘好好的 不要浮躁 努力就有收获‘)

使用

4. 配置字典   ATM小车应用                        

文件夹级别显示

 

 

4.1 start启动文件 放在根目录下 不要bin文件夹

import os
import sys

BATH_DIR = os.path.dirname(__file__)
sys.path.append(BATH_DIR)

from core import src

if __name__ == ‘__main__‘:  #name没有引号，main要加引号
    src.run()  #这个run函数是核心文件中的程序，自己需要去定义的一个函数，从这里启动它

start.py

4.2 core 核心文件

from conf import setting
from lib import comment
def register():
    logger = comment.get_logger(‘用户注册‘)
    username = input(‘请输入你的账户：‘).strip()
    user_pwd = input(‘请输入你的密码：‘).strip()
    logger.info(‘%s注册了我们的网站‘%username)

func_dict = 
    ‘1‘:register,


def run():
    while True:
        print(
            ‘1 注册‘
        )
        choice = input(‘请输入你的选择：‘).strip()
        if choice not in func_dict.keys() or not choice.isdigit():continue
        # func_dict[choice]() #容易报错
        func_dict.get(choice)()

src.py

4.3  conf 配置文件

import os
import logging.config

# 定义两种日志输出格式 开始
standard_format = ‘[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]‘                   ‘[%(levelname)s][%(message)s]‘ # 格式一 其中name为getlogger指定的名字

simple_format = ‘[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s‘  #格式二
# 定义日志输出格式 结束

"""
下面的两个变量对应的值 需要你手动修改
"""
BASE_DIR = os.path.dirname(os.path.dirname(__file__))  #setting 向上返回两层即 到ATM小车文件夹
logfile_dir = os.path.join(BASE_DIR , ‘log‘)  #用谁来拼 + 拼谁 ATM小车文件夹下拼一个log文件夹，如果有就算了，没有在下面会自动生成
   # logfile_dir = os.path.dirname(__file__)  #模板中的原生格式 返回到log文件所在的目录 这里返回几层看实际情况进行修改
logfile_name = ‘a3.log‘  # log文件中文件名 这个随便起名，到时候生成日志文件就是这个名字
# 如果不存在定义的日志目录log就创建一个
if not os.path.isdir(logfile_dir):
    os.mkdir(logfile_dir)  #生成一个log文件夹出来

# log文件夹下日志文件的全路径
logfile_path = os.path.join(logfile_dir, logfile_name)  #用log文件夹的路经再拼该文件夹下文件a3.log的路经
# log配置字典
LOGGING_DIC = 
    ‘version‘: 1,
    ‘disable_existing_loggers‘: False,
    ‘formatters‘: 
        ‘standard‘: 
            ‘format‘: standard_format
        , #格式一 这里用变量传入，在顶部可以修改格式
        ‘simple‘: 
            ‘format‘: simple_format
        ,  #格式二
    ,
    ‘filters‘: ,  # 过滤日志
    ‘handlers‘: 
        #打印到终端的日志
        ‘console‘: 
            ‘level‘: ‘DEBUG‘, #也就是10级以上的都输出
            ‘class‘: ‘logging.StreamHandler‘,  # 打印到屏幕
            ‘formatter‘: ‘simple‘ #这个simple不能随便改，要和formates里面的simple对应
        ,
        #打印到文件的日志,收集info及以上的日志
        ‘default‘: 
            ‘level‘: ‘DEBUG‘,
            ‘class‘: ‘logging.handlers.RotatingFileHandler‘,  # 保存到文件
            ‘formatter‘: ‘standard‘,
            ‘filename‘: logfile_path,  # 日志文件
            ‘maxBytes‘: 1024*1024*5,  # 日志大小 5M 一个存满了再建文件夹
            ‘backupCount‘: 5, #最多新建5个文件，满了之后自动清除之前的文件内容
            ‘encoding‘: ‘utf-8‘,  # 日志文件的编码，再也不用担心中文log乱码了
        ,
    ,
    ‘loggers‘: 
        #logging.getLogger(__name__)拿到的logger配置
        ‘‘:   #这里定义的空字符，后面的‘我是空字符串’键不存在时，默认就使用该K-V键值对
            ‘handlers‘: [‘default‘, ‘console‘],  # 这里把上面定义的两个handler都加上，即log数据既写入文件又打印到屏幕，
                                                 # 正式上线后不能要console，他会一直往终端输出
            ‘level‘: ‘DEBUG‘,
            ‘propagate‘: True,  # 向上（更高level的logger）传递
        ,
    ,

setting.py

4.4 lib 公共文件

import logging.config  #函数需要什么就给他调
from conf import setting
# from conf.setting import LOGGING_DIC  #不要这样调用，不方便其他变量的调取
def get_logger(name):
    logging.config.dictConfig(setting.LOGGING_DIC)  # 自动加载字典中的配置（一步帮我们干了1-7步，最后8的写日志我们要自己做）
    logger1 = logging.getLogger(name)
    # logger1.debug(‘...‘)  #这里不能这样写，这样就写死了只能输出debug日志，应该让用户选择输入什么信息就输出什么
    return logger1

comment.py