logging模块使用简介

python黑科技

python3日志模块，logging使用简介

日志打印

python3使用logging进行日志打印，很简单，直接引logging包即可：

1
2
3
4
5
6
7
8
9
import logging

logging.warning("This is warning message")
logging.critical("This is critical message")
logging.error("This is error message")
# 打印结果
WARNING:root:This is warning message
CRITICAL:root:This is critical message
ERROR:root:This is error message

默认情况下只显示了大于等于WARNING级别的日志。
日志级别：

1
critical(50) > error(40) > warning(30) > info(20) > debug(10)

简单应用

通过logging.basicConfig函数对日志的输出格式及方式做相关配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import logging

logging.basicConfig(
    filename='test.log',
    format='%(asctime)s - %(name)s - %(levelname)s - %(module)s: %(message)s',
    datefmt='%Y-%m-%d %H-%M-%S',
    level=logging.DEBUG,
    #level=10
)

logging.critical("This ia critical message")
logging.error("This is error message")
logging.warning("This is warning message")
logging.info("This is info message")
logging.debug("This is debug message")

logging.basicConfig函数各参数

1.filename：指定日志文件名
2.filemode：和file函数意义相同，指定日志文件的打开模式，’w’或’a’；默认为’a’表示“append”。
3.format：指定输出的格式和内容，format可以输出很多有用信息：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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用户输出的消息

4.datefmt：指定时间格式，同time.strftime()
5.level：设置日志级别，默认为logging.WARNING
6.stream：指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略

模块介绍

若要对logging进行更多灵活的控制，必须了解Logger，Handler，Formatter，Filter的概念：
logger提供了应用程序可以直接使用的接口；
handle将（logger创建的）日志记录发送到合适的目的输出；
filter提供了细度设备来决定输出哪条日志记录；
formatter决定日志记录的最终输出格式；

Logger

每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：
LOG=logging.getLogger(”chat.gui”)
而核心模块可以这样：
LOG=logging.getLogger(”chat.kernel”)

Logger.setLevel(lel):指定最低的日志级别，低于lel的级别将被忽略。debug是最低的内置级别，critical为最高
Logger.addFilter(filt)、Logger.removeFilter(filt):添加或删除指定的filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)：增加或删除指定的handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()：可以设置的日志级别

Handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Logger可以把信息输出到文件，还有些Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler
Handler.setLevel(lel):指定被处理的信息级别，低于lel级别的信息将被忽略
Handler.setFormatter()：给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：

1) logging.StreamHandler

使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是:StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr

2) logging.FileHandler

和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a’，即添加到文件末尾。

3) logging.handlers.RotatingFileHandler

这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。它的构造函数是：
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])
其中filename和mode两个参数和FileHandler一样。
maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4) logging.handlers.TimedRotatingFileHandler

这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是：
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
interval是时间间隔。
when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：
S 秒
M 分
H 小时
D 天
W 每星期（interval==0时代表星期一）
midnight 每天凌晨

实例

日志的一般操作顺序为：
1.创建一个流类型handler用于输出日志到控制台(控制器)
2.定义输出日志级别
3.定义handler的输出格式formatter
4.将handler添加到logging对象

同时输出日志到控制台和文件

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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import logging

logging.basicConfig(
    filename='test.log',
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H-%M-%S',
    level=10
)

# 定义一个StreamHandler(日志流处理器)，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象
console = logging.StreamHandler()
console.setLevel(logging.INFO)
# 格式化，设置控制台的日志输出格式
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
# 定义控制器的日志输出格式
console.setFormatter(formatter)
# 将控制器添加到logging对象
logging.getLogger('').addHandler(console)

logging.critical("This is critical message")
logging.error("This is error message")
logging.warning("This is warning message")
logging.info("This is info message")
logging.debug("This is debug message")

配置文件

用法类似于java中的log4j的logging.config，我们也可以自己配置logger.conf文件：

Logger.conf

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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
###############################################
[loggers]
keys=root,example01,example02

[logger_root]
level=DEBUG

handlers=hand01,hand02

[logger_example01]
handlers=hand01,hand02
qualname=example01
propagate=0

[logger_example02]
handlers=hand01,hand03
qualname=example02
propagate=0
###############################################
[handlers]
keys=hand01,hand02,hand03

[handler_hand01]
class=StreamHandler
level=INFO
formatter=form02
args=(sys.stderr,)

[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form01
args=('D:/bug_things/selenium/logs/AutoTest.log', 'a', 'utf-8')

[handler_hand03]
class=handlers.RotatingFileHandler
level=INFO
formatter=form02
args=('D:/bug_things/selenium/logs/AutoTest.log', 'a', 10*1024*1024, 5, 'utf-8')
###############################################
[formatters]
keys=form01,form02

[formatter_form01]
format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s
datefmt=%a, %d %b %Y %H:%M:%S

[formatter_form02]
format=%(name)-12s: %(levelname)-8s %(message)s
datefmt=%Y %m %d %H %M %S

封装方法

将配置文件中定义的日志打印的配置进行封装，生成debug，info，message方法：
Log.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import logging.config

logging.config.fileConfig("Logger.conf")


def debug(message):
    # 打印debug级别的日志方法
    logging.debug(message)


def warning(message):
    # 打印warning级别的日志方法
    logging.warning(message)


def info(message):
    # 打印info级别的日志方法
    logging.info(message)

应用

以百度搜索为例:
BaiDu.py

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
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
from selenium import webdriver
from Log import *
import time


class TestBaiDuSearch():
    def __init__(self):
        # 启动浏览器
        self.browser = webdriver.Chrome()

    def test_baidu_search(self):
        info(u"===================搜索====================")
        url = "https://www.baidu.com"
        self.browser.get(url)
        info(u"访问百度首页")
        self.browser.find_element_by_id('kw').send_keys(u"自动化测试")
        info(u"在输入框中搜索关键字“自动化测试”")
        self.browser.find_element_by_id('su').click()
        info(u"单击搜索按键")
        info(u"=================测试执行结束================")

        time.sleep(3)
        self.browser.quit()

if __name__ == '__main__':
    testbaidu = TestBaiDuSearch()
    testbaidu.test_baidu_search()

执行BaiDu.py文件，在D:/bug_things/selenium/logs目录下会生成AutoTest.log日志文件，文件内容：

1
2
3
4
5
Fri, 02 Feb 2018 17:10:52 Log.py[line:20] INFO ===================搜索====================
Fri, 02 Feb 2018 17:10:53 Log.py[line:20] INFO 访问百度首页
Fri, 02 Feb 2018 17:10:53 Log.py[line:20] INFO 在输入框中搜索关键字“自动化测试”
Fri, 02 Feb 2018 17:10:53 Log.py[line:20] INFO 单击搜索按键
Fri, 02 Feb 2018 17:10:53 Log.py[line:20] INFO =================测试执行结束================

同时控制台打印信息：

1
2
3
4
5
root        : INFO     ===================搜索====================
root        : INFO     访问百度首页
root        : INFO     在输入框中搜索关键字“自动化测试”
root        : INFO     单击搜索按键
root        : INFO     =================测试执行结束================

参考文章

本文标题:logging模块使用简介

文章作者:Kyle

发布时间:2018-02-02, 09:17:58

最后更新:2020-12-21, 14:39:13

原始链接:https://spindriftks.github.io/2018/02/02/logging%E6%A8%A1%E5%9D%97%E4%BD%BF%E7%94%A8%E7%AE%80%E4%BB%8B/

许可协议: "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。

文章目录
  1. 日志打印
  2. 简单应用
  3. 模块介绍
    1. Logger
    2. Handler
      1. 1) logging.StreamHandler
      2. 2) logging.FileHandler
      3. 3) logging.handlers.RotatingFileHandler
      4. 4) logging.handlers.TimedRotatingFileHandler
  4. 实例
    1. 同时输出日志到控制台和文件
  5. 配置文件
    1. Logger.conf
    2. 封装方法
    3. 应用
|