404-Logging日志模块

1、logging日志的介绍

在现实生活中,记录日志非常重要,比如:银行转账时会有转账记录;飞机飞行过程中,会有个黑盒子(飞行数据记录器)记录着飞机的飞行过程,那在咱们python程序中想要记录程序在运行时所产生的日志信息,怎么做呢?

可以使用 logging 这个包来完成

记录程序日志信息的目的是:

  1. 可以很方便的了解程序的运行情况
  2. 可以分析用户的操作行为、喜好等信息
  3. 方便开发人员检查bug

2、logging日志级别介绍

日志等级可以分为5个,从低到高分别是:

  1. DEBUG
  2. INFO
  3. WARNING
  4. ERROR
  5. CRITICAL

日志等级说明:

3、logging日志的使用

在 logging 包中记录日志的方式有两种:

  1. 输出到控制台(终端)
  2. 保存到日志文件

日志信息输出到控制台的示例代码:

import logging

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

运行结果:

WARNING:root:这是一个warning级别的日志信息
ERROR:root:这是一个error级别的日志信息
CRITICAL:root:这是一个critical级别的日志信息

说明:

logging日志等级和输出格式的设置:

import logging

# 设置日志等级和输出日志格式
logging.basicConfig(level=logging.DEBUG,  # 设置日志等级
                    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s')  # 设置日志格式:时间-文件名-行号-日志级别-日志信息

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

运行结果:

2019-02-13 20:41:33,080 - hello.py[line:6] - DEBUG: 这是一个debug级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:7] - INFO: 这是一个info级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:8] - WARNING: 这是一个warning级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:9] - ERROR: 这是一个error级别的日志信息
2019-02-13 20:41:33,080 - hello.py[line:10] - CRITICAL: 这是一个critical级别的日志信息

代码说明:

日志信息保存到日志文件的示例代码:

import logging

logging.basicConfig(level=logging.DEBUG,  # 设置日志等级为DEBUG
                    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s',  # 设置日志格式:时间-文件名-行号-日志级别-日志信息
                    filename="log.txt",  # 设置日志文件名
                    filemode="w")  # 设置日志文件的写入模式

logging.debug('这是一个debug级别的日志信息')
logging.info('这是一个info级别的日志信息')
logging.warning('这是一个warning级别的日志信息')
logging.error('这是一个error级别的日志信息')
logging.critical('这是一个critical级别的日志信息')

解决中文乱码问题:

import logging

f = open('log.txt', 'a', encoding='utf-8')  # 每次以追加形式写入日志
logging.basicConfig(level=logging.DEBUG,  # 设置日志等级为DEBUG
                    format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s',  # 设置日志格式:时间-文件名-行号-日志级别-日志信息
                    stream=f)  # 设置日志输出到文件

4、logging日志在Web项目中应用

使用logging日志示例:

  1. 程序入口模块设置logging日志的设置

     # 导入FastAPI模块
     from fastapi import FastAPI
     # 导入响应报文Response模块
     from fastapi import Response
     # 导入服务器uvicorn模块
     import uvicorn
     # 导入日志模块
     import logging
    
     # 配置日志
     logging.basicConfig(level=logging.INFO,
                         format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s',
                         filename="log.txt",
                         filemode="a")
    
  2. 访问index.html时进行日志输出,示例代码:

    # 当请求为 /images/0.jpg 时, path ==> 0.jpg
    @app.get("/images/{path}")
    # 注意这里的参数需要设置为 path
    # path : str ==> 指定path为字符串类型的数据
    def get_pic(path: str):
        # 这里open()的路径就是 ==> f"source/images/0.jpg"
        with open(f"source/images/{path}", "rb") as f:
            data = f.read()
        # 打log
        logging.info("访问了" + path)
        # return 返回响应数据
        # Response(content=data, media_type="jpg")
        # 参数1: 响应数据
        # 参数2: 数据格式
        return Response(content=data, media_type="jpg")
    
  3. 访问gdp.html时进行日志输出,示例代码:

    @app.get("/{path}")
    def get_html(path: str):
        with open(f"source/html/{path}") as f:
            data = f.read()
        # 打log
        logging.info("访问了" + path)
        # return 返回响应数据
        # Response(content=data, media_type="text/source"
        # 参数1: 响应数据
        # 参数2: 数据格式
        return Response(content=data, media_type="text/html")
    

logging日志:

![image-20211128182624337](/img/user/czc知识库/计算机/Python/python学习/Python高级课程资料/day10 简单爬虫实践案例/01-笔记/media/image-20211128182624337.png)

通过日志信息我们得知, index.html被访问了2次, gdp.html被访问了2次.

说明:

5、小结