一篇文章带你搞定 Python 中 Logging 模块-python fitz模块

Hey，大家好呀，我是Go进阶者。

一、基础使用

1. logging使用场景

日志是什么?这个不用多解释。百分之九十的程序都需要提供日志功能。Python内置的logging模块，为我们提供了现成的高效好用的日志解决方案。但是，不是所有的场景都需要使用logging模块，

下面是Python官方推荐的使用方法：(来源百度)

任务场景	最佳工具
普通情况下，在控制台显示输出	`print()`
报告正常程序操作过程中发生的事件	`logging.info()`(或者更详细的`logging.debug()`)
发出有关特定事件的警告	`warnings.warn()`或者`logging.warning`()
报告错误	弹出异常
在不引发异常的情况下报告错误	`logging.error()`, `logging.exception()`或者`logging.critical()`

logging模块定义了下表所示的日志级别，按事件严重程度由低到高排列(注意是全部大写!因为它们是常量。)：

import logging 
logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
logger = logging.getLogger(__name__) 
 
logger.info("Start print log") 
logger.debug("Do something") 
logger.warning("Something maybe fail.") 
logger.info("Finish") 
1.
2.
3.
4.
5.
6.
7.
8.

logging中可以选择很多消息级别，如debug、info、warning、error以及critical。通过赋予logger或者handler不同的级别，开发者就可以只输出错误信息到特定的记录文件，或者在调试时只记录调试信息。

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
1.

例如，我们将logger的级别改为DEBUG，

再观察一下输出结果：

控制台输出，可以发现，输出了debug的信息。

logging.basicConfig函数各参数：
filename：指定日志文件名;
filemode：和file函数意义相同，指定日志文件的打开模式，'w'或者'a';
format：指定输出的格式和内容，format可以输出很多有用的信息。
datefmt：指定时间格式，同time.strftime();
level：设置日志级别，默认为logging.WARNNING;
stream：指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略;

#参数：作用 
%(levelno)s：打印日志级别的数值 
%(levelname)s：打印日志级别的名称 
%(pathname)s：打印当前执行程序的路径，其实就是sys.argv[0] 
%(filename)s：打印当前执行程序名 
%(funcName)s：打印日志的当前函数 
%(lineno)d：打印日志的当前行号 
%(asctime)s：打印日志的时间 
%(thread)d：打印线程ID 
%(threadName)s：打印线程名称 
%(process)d：打印进程ID 
%(message)s：打印日志信息 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

2. 将日志写入到文件

设置logging，创建一个FileHandler，并对输出消息的格式进行设置，将其添加到logger，然后将日志写入到指定的文件。

import logging 
logger = logging.getLogger(__name__) 
logger.setLevel(level = logging.INFO) 
handler = logging.FileHandler("log.txt") 
handler.setLevel(logging.INFO) 
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
handler.setFormatter(formatter) 
logger.addHandler(handler) 
 
logger.info("Start print log") 
logger.debug("Do something") 
logger.warning("Something maybe fail.") 
logger.info("Finish") 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

打开log.txt文件。

2. 将日志同时输出到屏幕和日志文件

logger中添加StreamHandler，可以将日志输出到屏幕上

import logging 
logger = logging.getLogger(__name__) 
logger.setLevel(level = logging.INFO) #添加StreamHandler 
handler = logging.FileHandler("log.txt") 
handler.setLevel(logging.INFO) 
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
handler.setFormatter(formatter) 
 
console = logging.StreamHandler() 
console.setLevel(logging.INFO)  #添加StreamHandler 
 
logger.addHandler(handler) 
logger.addHandler(console) 
 
logger.info("Start print log") 
logger.debug("Do something") 
logger.warning("Something maybe fail.") 
logger.info("Finish") 
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.

控制台信息。

log.text信息。

3. 设置消息的等级

可以设置不同的日志等级，用于控制日志的输出。

#日志等级：使用范围 
FATAL：致命错误 
CRITICAL：特别糟糕的事情，如内存耗尽、磁盘空间为空，一般很少使用 
ERROR：发生错误时，如IO操作失败或者连接问题 
WARNING：发生很重要的事件，但是并不是错误时，如用户登录密码错误 
INFO：处理请求或者状态变化等日常事务 
DEBUG：调试过程中使用DEBUG等级，如算法中每个循环的中间状态 
1.
2.
3.
4.
5.
6.
7.

4. 捕获traceback

Python中的traceback模块被用于跟踪异常返回信息，可以在logging中记录下traceback.

import logging 
logger = logging.getLogger(__name__) 
logger.setLevel(level = logging.INFO) 
handler = logging.FileHandler("log.txt") 
handler.setLevel(logging.INFO) 
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') 
handler.setFormatter(formatter) 
 
console = logging.StreamHandler() 
console.setLevel(logging.INFO) 
 
logger.addHandler(handler) 
logger.addHandler(console) 
 
logger.info("Start print log") 
logger.debug("Do something") 
logger.warning("Something maybe fail.") 
try: 
    open("sklearn.txt","rb") 
except (SystemExit,KeyboardInterrupt): 
    raise 
except Exception: 
    logger.error("Faild to open sklearn.txt from logger.error",exc_info = True) 
 
logger.info("Finish") 
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.

控制台和日志文件log.txt中输出。

可以使用logger.exception(msg,args)，它等价于logger.error(msg,exc_info = True,args)。

将logger.error("Faild to open sklearn.txt from logger.error",exc_info = True)

替换为logger.exception("Failed to open sklearn.txt from logger.exception")

控制台和日志文件log.txt中输出。

二、总结

本文以Pythonl基础为例，主要介绍了logging模块的基础使用方法，以及在现实应用中遇到的问题，进行了详细的解答。

通过一些案例的讲解和运行效果图的截取，使用Python语言，能够帮助读者更好的去理解Python。

我是Go进阶者，如果觉得还不错，记得动手点赞一下哈。感谢你的观看!