python learning modules - Module (IV)

5.9 logging module

Common parameters
logging.basicConfig () function can change the default behavior logging module specific parameters, parameters are available:

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用户输出的消息

Low version 5.9.1

import logging
#直接写入文件
logging.basicConfig(level=logging.DEBUG,format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename='test.log',
                    filemode='a'
                    )

logging.debug('debug message')
logging.info('info message')
logging.warning('warning message')
logging.error('error message')
logging.critical('critical message')

#输出到屏幕
logging.basicConfig(level=logging.DEBUG,format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    )
logging.debug('debug message')
logging.info('info message')
logging.warning('warning message')
logging.error('error message')
logging.critical('critical message')

5.9.2 Standard Edition

import logging

#定义一个logging对象
logger = logging.getLogger()

#定义一个文件对象
fh = logging.FileHandler('test.log',encoding='utf-8')

#创建一个屏幕对象
sh = logging.StreamHandler()

#配置显示格式
formatter1 = logging.Formatter('%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s')
formatter2 = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
fh.setFormatter(formatter1)
sh.setFormatter(formatter2)

#引入
logger.addHandler(fh)
logger.addHandler(sh)

#设置显示的最低级别
logger.setLevel(10)  #默认是30
fh.setLevel(10)
sh.setLevel(30)  #默认是30

logging.debug('调试模式')
logging.info('正常模式')
logging.warning('警告模式')
logging.error('告警模式')
logging.critical('严重错误模式')

5.9.3 Ultimate

import logging.config
import os

# 定义三种日志输出格式 开始，所有的模板可以自定义，[]也是自加的
# 常规多项目模板，可用于记录文件日志
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'
# 简略模板
id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'

# 定义日志输出格式 结束
logfile_dir = os.path.dirname(os.path.abspath(__file__))
logfile_par_path = os.path.dirname(__file__)


logfile_name = 'login.log'  # log文件名
logfile_path_staff = f"{logfile_par_path}\\log1\\staff.log"
logfile_path_boss = f"{logfile_par_path}\\log2\\boss.log"

#如果不存在定义的日志目录就创建一个
if not os.path.isdir(f"{logfile_par_path}\\log2"):
    os.mkdir(f"{logfile_par_path}\\log2")
if not os.path.isdir(f"{logfile_par_path}\\log1"):
    os.mkdir(f"{logfile_par_path}\\log1")

#log日志的全路径，与上步配合生成log日志的全路径
# logfile_path = os.path.join()

#log配置字典
# LOGGING_DIC第一层的所有的键不能改变
LOGGING_DIC={
    'version':1,
    'disable_existing_loggers':False,
    'formatters':{  #把三个模板搬过来
        'standard':{'format':standard_format},
        'simple':{'format':simple_format},
        'id_simple':{'format':id_simple_format}
    },
    'filters':{},
    'handlers':{
        #打印到终端的日志
        'console':{
            'level':'DEBUG',
            'class':'logging.StreamHandler', #打印到屏幕
            'formatter':'simple'
        },
        #打印到文件1
        'default1':{
            'level':'DEBUG',
            'class':'logging.handlers.RotatingFileHandler', #保存文件
            'formatter':'standard',
            'filename':logfile_path_staff ,  #日志路径
            'maxBytes':1024*3,  #日志大小 3K
            'backupCount':3,  #最对缓存的文件数
            'encoding':'utf-8',
        },
        # 打印到文件2
        'default2': {
            'level': 'DEBUG',
            'class': 'logging.handlers.RotatingFileHandler',  # 保存文件
            'formatter': 'id_simple',
            'filename': logfile_path_boss,  # 日志路径
            'maxBytes': 1024 * 3,  # 日志大小 3K
            'backupCount': 3,  # 最对缓存的文件数
            'encoding': 'utf-8',
        },
    },
    'loggers':{
        #拿到logging.getLogger(__name__)拿到的logger配置
        '':{
            'handlers':['default1','default2','console'],#把上面定义的三个handler都加上，即log数据既写入文件又打印到屏幕
            'level':'DEBUG',
            'propagate':True  # 向上（更高level的logger）传递
        }
    }
}

def md_logger():
    logging.config.dictConfig(LOGGING_DIC) #导入上面定义的logging配置
    logger = logging.getLogger()  #生成一个log实例
    # logger.debug('It Works!')  #记录该文件运行状态
    return logging
dic = {'username':'盖伦'}

def login():  #模拟登录。进行日志测试
    md_logger().info(f"{dic['username']}登陆成功")

login()