python log模块_python必掌握模块(四）logging模块用法

一、为什么我们需要引用logging模块？

我们把python代码放入到生产环境中的时候，我们只能看到代码运行的结果，我们不知道的是代码每一步过程的最终运行状态。

如果代码中间过程出现了问题的话，logging库的引用得出的日志记录可以帮助我们排查程序运行错误步骤的。方便我们修复代码，快速排查问题。

logging模块是Python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等；相比print，具备如下优点：可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；

print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出

二、logging模块使用

2.1、logging模块控制台输出

#引入了 logging 模块

import logging

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

#声明了一个 Logger 对象

logger = logging.getLogger(__name__)

logger.info("Start print log")

logger.debug("Do something")

logger.warning("Something maybe fail.")

logger.info("Finish")

logging 的全局配置：

basicConfig配置了 level 信息和 format 信息

level 配置为 INFO 信息，即只输出 INFO 级别的信息，

format=：指定了 format 格式的字符串，包括 asctime运行时间 name模块名称、levelname（日志级别）message （日志内容）输出结果为两条 INFO、一条 WARNING、一条 DEBUG 信息

为什么DEBUG 的信息没有输出？

因为我们在全局配置的时候设置了输出为 INFO 级别，所以 DEBUG 级别的信息就被过滤掉了

logging中可以选择很多消息级别，如debug、info、warning、error以及critical。通过赋予logger或者handler不同的级别，开发者就可以只输出错误信息到特定的记录文件，或者在调试时只记录调试信息。看了这张图你就明白了为什么DEBUG 的信息没有输出

2.2、basicConfig 的参数filename：即日志输出的文件名，如果指定了这个信息之后，实际上会启用 FileHandler，而不再是 StreamHandler，这样日志信息便会输出到文件中了。

filemode：这个是指定日志文件的写入方式，有两种形式，一种是 w，一种是 a，分别代表清除后写入和追加写入。

format：指定日志信息的输出格式（format的参数如下所示）

%(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。

%(processName)s：打印线程名称。

%(module)s：打印模块名称。

%(message)s：打印日志信息。

datefmt：指定时间的输出格式。

style：如果 format 参数指定了，这个参数就可以指定格式化时的占位符风格，如 %、{、$ 等。

level：指定日志输出的类别，程序会输出大于等于此级别的信息。

stream：在没有指定 filename 的时候会默认使用 StreamHandler，这时 stream 可以指定初始化的文件流。指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略；

handlers：可以指定日志处理时所使用的 Handlers，必须是可迭代的。

2.3、Handler的用法

将日志写入到文件，这里我们没有再使用 basicConfig 全局配置，而是，Logger 对象添加对应的 Handler 即可，最后可以发现日志就会被输出到 Alibaba.log 中，内容如下：

import logging

#先声明一个 Logger 对象

logger = logging.getLogger(__name__)

logger.setLevel(level=logging.INFO)

#然后指定其对应的 Handler 为 FileHandler 对象

handler = logging.FileHandler('Alibaba.log')

#然后 Handler 对象单独指定了 Formatter 对象单独配置输出格式

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

handler.setFormatter(formatter)

logger.addHandler(handler)Alibaba.log日志中还没有日志信息

logger.info('welcome to alibaba info')

logger.debug('Debugging')

logger.warning('Warning exists')

logger.info('Finish')Alibaba.log日志内容stream：在没有指定 filename 的时候会默认使用 StreamHandler，这时 stream 可以指定初始化的文件流。指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略；

handlers：可以指定日志处理时所使用的 Handlers，必须是可迭代的。

当然还有其他的Handler 进行日志的输出，logging 模块提供的 Handler 有：StreamHandler：logging.StreamHandler；日志输出到流，可以是 sys.stderr，sys.stdout 或者文件。

FileHandler：logging.FileHandler；日志输出到文件。

BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日志回滚方式。

RotatingHandler：logging.handlers.RotatingHandler；日志回滚方式，支持日志文件最大数量和日志文件回滚。

TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日志回滚方式，在一定时间区域内回滚日志文件。

SocketHandler：logging.handlers.SocketHandler；远程输出日志到TCP/IP sockets。

DatagramHandler：logging.handlers.DatagramHandler；远程输出日志到UDP sockets。

SMTPHandler：logging.handlers.SMTPHandler；远程输出日志到邮件地址。

SysLogHandler：logging.handlers.SysLogHandler；日志输出到syslog。

NTEventLogHandler：logging.handlers.NTEventLogHandler；远程输出日志到Windows NT/2000/XP的事件日志。

MemoryHandler：logging.handlers.MemoryHandler；日志输出到内存中的指定buffer。

HTTPHandler：logging.handlers.HTTPHandler；通过”GET”或者”POST”远程输出到HTTP服务器。

2.4、Formatter的用法

我们当然可以不借助于 basicConfig 来全局配置格式化输出内容， Formatter 可以帮我们完成，每个 Handler 单独配置输出的格式，非常灵活。

import logging

logger = logging.getLogger(__name__)

logger.setLevel(level=logging.WARN)

#指定了一个 Formatter，并传入了 fmt 和 datefmt 参数，这样就指定了日志结果的输出格式和时间格式

formatter = logging.Formatter(fmt='%(asctime)s - %(name)s - %(levelname)s - %(message)s', datefmt='%Y/%m/%d %H:%M:%S')

handler = logging.StreamHandler()

#handler 通过 setFormatter() 方法设置此 Formatter 对象即可

handler.setFormatter(formatter)

logger.addHandler(handler)setFormatter() 方法设置此 Formatter 对象

# Log

logger.debug('Debugging')

logger.critical('Critical Something')

logger.error('Error Occurred')

logger.warning('Warning exists')

logger.info('Finished')输出结果输出结果

三、捕获 Traceback

error() 方法中添加了一个参数，将 exc_info 设置为了 True，这样我们就可以输出执行过程中的信息了，即完整的 Traceback 信息。

import logging

logger = logging.getLogger(__name__)

logger.setLevel(level=logging.DEBUG)

# Formatter

formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

# FileHandler

file_handler = logging.FileHandler('result.log')

file_handler.setFormatter(formatter)

logger.addHandler(file_handler)

# StreamHandler

stream_handler = logging.StreamHandler()

stream_handler.setFormatter(formatter)

logger.addHandler(stream_handler)

# Log

logger.info('Start')

logger.warning('Something maybe fail.')

try:

result = 10 / 0

except Exception:

logger.error('Faild to get result', exc_info=True)

logger.info('Finished')

往期精彩回顾

图片笔者摄于2018年6月30日17:21分，于广东省云门山爬山途中。山青云高天蓝，让人心沉静！