四、日志记录
Python语言具有一个强大灵活的工业级的记录模块,该模块能够在不同的层次把消息记录到任意位置,例如内存、文件、网络和控制台等。要想使用该模块,需要进行必要的配置。 对于那些想要提供日志记录的程序库,可以选择让用户使用程序库的默认配置(这样不会打扰用户),或者选择让用户亲自配置日志记录功能。当然,如果您是一位程序库开发人员的话,最好替用户搭理好一切,而不是去惹他们讨厌。那么,你的程序库配置本身应该做哪些设置呢?
这里有两个常见的选项:将记录写到一个文件中,或者写到控制台。不过这两个选项都会导致混乱。直到Python 3.1,非常好的实践要求程序库开发人员包含一个小型的do-nothing处理程序,并配置它的logger使用这个处理程序。Python 3.1将这种NullHandler作为记录模块本身的一部分。
下面我们举例进行说明。假设您的lib.py模块中含有下面所示的程序库代码。这里有一个接收日志记录处理程序的init()函数,但是默认时接收的却是新的NullHandler。之后,将logger对象设置为使用提供的logger(或者默认的logger)。日志记录处理程序是一个对象,它确定把记录输出到何处。这里的示例函数a_function_that_uses_logging()调用了全局logger对象,并记录一些有趣的消息:
logger = None
def init(handler=logging.NullHandler()):
global logger
logger = logging.getLogger('Super-logger')
logger.setLevel(logging.INFO)
logger.addHandler(handler)
def a_function_that_uses_logging():
logger.info('The capital of France is Paris')
logger.debug('Don\'t forget to fix a few bugs before the release')
logger.error('Oh, oh! something unpalatable occurred')
logger.warning('Mind the gap')
logger.critical('Your code is a mess. You really need to step up.')
下面的应用程序代码配置了一个回旋式文件处理程序,这是一个改进过的处理程序,可用于长期运行的系统,因为这些系统会生成大量的日志信息。此处理程序会限制每个文件中日志记录信息的数量,并且还保持了一个备份文件的预设数量。这些限制能够保证日志文件不会超过规定尺寸,并且总是保留(达到此限制之前的)最新的日志记录信息。
为此,我们的代码将此处理程序配置为每个日志文件只保存250字节内容,并且最多维护5个备份文件。最后,代码调用a_function_that_uses_logging()函数。
import logging.handlers
from lib import a_function_that_uses_logging
log_file = 'log.txt'
handler = logging.handlers.RotatingFileHandler(
log_file, maxBytes=250, backupCount=4)
init(handler)
for i in range(4):
a_function_that_uses_logging()
运行上述代码后,将在当前目录生成下列内容:此处理程序创建了回旋式日志文件(log.txt),以及四个备份文件,因为本例中每个文件只允许存放250字节内容。
article.py log.txt log.txt.1 log.txt.2 log.txt.3 log.txt.4
可以通过下列命令来查看其内容:
Mind the gap
Your code is a mess. You really need to step up.
Your code is a mess. You really need to step up.
The capital of France is Paris
Oh, oh! something unpalatable occurred
Mind the gap
Your code is a mess. You really need to step up.
The capital of France is Paris
Oh, oh! something unpalatable occurred
The capital of France is Paris
Oh, oh! something unpalatable occurred
Mind the gap
Your code is a mess. You really need to step up.
The capital of France is Paris
Oh, oh! something unpalatable occurred
Mind the gap
这种做法很好,因为有时候用户并不关心记录的消息——他们想要的是在调用函数时无需配置logger,并且这些日志不会耗尽他们的硬盘空间,也不会出现满屏的消息。这时,NullHandler正好可以派上用场。下面的代码所做的事情与上面一致,不过它并没有配置日志记录处理程序,所以也就得不到日志记录结果。注意,这里没有导入logging和logging.handlers,并且也没有确定使用哪个处理程序以及如何进行配置。
for i in range(3):
a_function_that_uses_logging()