日志操作手册
************

作者:
   原文作者 Vinay Sajip <vinay_sajip at red-dove dot com>

本页包含了许多日志记录相关的概念，这些概念在过去一直被认为很有用。


在多个模块中记录日志
====================

多次调用 "logging.getLogger('someLogger')" 时会返回对同一个 logger 对
象的引用。 这不仅是在同一个模块中，在其他模块调用也是如此，只要是在同
一个 Python 解释器进程中。 是应该引用同一个对象，此外，应用程序也可以
在一个模块中定义和配置父 logger，而在单独的模块中创建（但不配置）子
logger，对子 logger 的所有调用都将传给父 logger。 这里是主模块:

   import logging
   import auxiliary_module

   # create logger with 'spam_application'
   logger = logging.getLogger('spam_application')
   logger.setLevel(logging.DEBUG)
   # create file handler which logs even debug messages
   fh = logging.FileHandler('spam.log')
   fh.setLevel(logging.DEBUG)
   # create console handler with a higher log level
   ch = logging.StreamHandler()
   ch.setLevel(logging.ERROR)
   # create formatter and add it to the handlers
   formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
   fh.setFormatter(formatter)
   ch.setFormatter(formatter)
   # add the handlers to the logger
   logger.addHandler(fh)
   logger.addHandler(ch)

   logger.info('creating an instance of auxiliary_module.Auxiliary')
   a = auxiliary_module.Auxiliary()
   logger.info('created an instance of auxiliary_module.Auxiliary')
   logger.info('calling auxiliary_module.Auxiliary.do_something')
   a.do_something()
   logger.info('finished auxiliary_module.Auxiliary.do_something')
   logger.info('calling auxiliary_module.some_function()')
   auxiliary_module.some_function()
   logger.info('done with auxiliary_module.some_function()')

这里是辅助模块:

   import logging

   # create logger
   module_logger = logging.getLogger('spam_application.auxiliary')

   class Auxiliary:
       def __init__(self):
           self.logger = logging.getLogger('spam_application.auxiliary.Auxiliary')
           self.logger.info('creating an instance of Auxiliary')

       def do_something(self):
           self.logger.info('doing something')
           a = 1 + 1
           self.logger.info('done doing something')

   def some_function():
       module_logger.info('received a call to "some_function"')

输出结果会像这样:

   2005-03-23 23:47:11,663 - spam_application - INFO -
      creating an instance of auxiliary_module.Auxiliary
   2005-03-23 23:47:11,665 - spam_application.auxiliary.Auxiliary - INFO -
      creating an instance of Auxiliary
   2005-03-23 23:47:11,665 - spam_application - INFO -
      created an instance of auxiliary_module.Auxiliary
   2005-03-23 23:47:11,668 - spam_application - INFO -
      calling auxiliary_module.Auxiliary.do_something
   2005-03-23 23:47:11,668 - spam_application.auxiliary.Auxiliary - INFO -
      doing something
   2005-03-23 23:47:11,669 - spam_application.auxiliary.Auxiliary - INFO -
      done doing something
   2005-03-23 23:47:11,670 - spam_application - INFO -
      finished auxiliary_module.Auxiliary.do_something
   2005-03-23 23:47:11,671 - spam_application - INFO -
      calling auxiliary_module.some_function()
   2005-03-23 23:47:11,672 - spam_application.auxiliary - INFO -
      received a call to 'some_function'
   2005-03-23 23:47:11,673 - spam_application - INFO -
      done with auxiliary_module.some_function()


在多个线程中记录日志
====================

在多个线程中记录日志并不需要特殊的处理，以下示例展示了如何在主（初始）
线程和另一个线程中记录日志:

   import logging
   import threading
   import time

   def worker(arg):
       while not arg['stop']:
           logging.debug('Hi from myfunc')
           time.sleep(0.5)

   def main():
       logging.basicConfig(level=logging.DEBUG, format='%(relativeCreated)6d %(threadName)s %(message)s')
       info = {'stop': False}
       thread = threading.Thread(target=worker, args=(info,))
       thread.start()
       while True:
           try:
               logging.debug('Hello from main')
               time.sleep(0.75)
           except KeyboardInterrupt:
               info['stop'] = True
               break
       thread.join()

   if __name__ == '__main__':
       main()

脚本会运行输出类似下面的内容:

      0 Thread-1 Hi from myfunc
      3 MainThread Hello from main
    505 Thread-1 Hi from myfunc
    755 MainThread Hello from main
   1007 Thread-1 Hi from myfunc
   1507 MainThread Hello from main
   1508 Thread-1 Hi from myfunc
   2010 Thread-1 Hi from myfunc
   2258 MainThread Hello from main
   2512 Thread-1 Hi from myfunc
   3009 MainThread Hello from main
   3013 Thread-1 Hi from myfunc
   3515 Thread-1 Hi from myfunc
   3761 MainThread Hello from main
   4017 Thread-1 Hi from myfunc
   4513 MainThread Hello from main
   4518 Thread-1 Hi from myfunc

这表明不同线程的日志像期望的那样穿插输出，当然更多的线程也会像这样输出
。


多个日志处理器以及多种格式化器
==============================

日志记录器是普通的Python对象。"addHandler()" 方法对可以添加的日志处理
器的数量没有限制。有时候，应用程序需要将所有严重性的所有消息记录到一个
文本文件，而将错误或更高等级的消息输出到控制台。要进行这样的设定，只需
配置适当的日志处理器即可。在应用程序代码中，记录日志的调用将保持不变。
以下是对之前基于模块的简单配置示例的略微修改:

   import logging

   logger = logging.getLogger('simple_example')
   logger.setLevel(logging.DEBUG)
   # create file handler which logs even debug messages
   fh = logging.FileHandler('spam.log')
   fh.setLevel(logging.DEBUG)
   # create console handler with a higher log level
   ch = logging.StreamHandler()
   ch.setLevel(logging.ERROR)
   # create formatter and add it to the handlers
   formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
   ch.setFormatter(formatter)
   fh.setFormatter(formatter)
   # add the handlers to logger
   logger.addHandler(ch)
   logger.addHandler(fh)

   # 'application' code
   logger.debug('debug message')
   logger.info('info message')
   logger.warning('warn message')
   logger.error('error message')
   logger.critical('critical message')

需要注意的是，'应用程序' 代码并不关心是否有多个日志处理器。示例中所做
的改变只是添加和配置了一个新的名为 *fh* 的日志处理器。

在编写和测试应用程序时，能够创建带有更高或更低消息等级的过滤器的日志处
理器是非常有用的。为了避免过多地使用 "print" 语句去调试，请使用
"logger.debug" ：它不像 "print" 语句需要你不得不在调试结束后注释或删除
掉，logger.debug 语句可以在源代码中保持不变，在你再一次需要它之前保持
无效。那时，唯一需要改变的是修改日志记录器和/或日志处理器的消息等级，
以进行调试。


在多个地方记录日志
==================

假设有这样一种情况，你需要将日志按不同的格式和不同的情况存储在控制台和
文件中。比如说想把日志等级为DEBUG或更高的消息记录于文件中，而把那些等
级为INFO或更高的消息输出在控制台。而且记录在文件中的消息格式需要包含时
间戳，打印在控制台的不需要。以下示例展示了如何做到:

   import logging

   # set up logging to file - see previous section for more details
   logging.basicConfig(level=logging.DEBUG,
                       format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
                       datefmt='%m-%d %H:%M',
                       filename='/temp/myapp.log',
                       filemode='w')
   # define a Handler which writes INFO messages or higher to the sys.stderr
   console = logging.StreamHandler()
   console.setLevel(logging.INFO)
   # set a format which is simpler for console use
   formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
   # tell the handler to use this format
   console.setFormatter(formatter)
   # add the handler to the root logger
   logging.getLogger('').addHandler(console)

   # Now, we can log to the root logger, or any other logger. First the root...
   logging.info('Jackdaws love my big sphinx of quartz.')

   # Now, define a couple of other loggers which might represent areas in your
   # application:

   logger1 = logging.getLogger('myapp.area1')
   logger2 = logging.getLogger('myapp.area2')

   logger1.debug('Quick zephyrs blow, vexing daft Jim.')
   logger1.info('How quickly daft jumping zebras vex.')
   logger2.warning('Jail zesty vixen who grabbed pay from quack.')
   logger2.error('The five boxing wizards jump quickly.')

当运行后，你会看到控制台如下所示

   root        : INFO     Jackdaws love my big sphinx of quartz.
   myapp.area1 : INFO     How quickly daft jumping zebras vex.
   myapp.area2 : WARNING  Jail zesty vixen who grabbed pay from quack.
   myapp.area2 : ERROR    The five boxing wizards jump quickly.

而在文件中会看到像这样

   10-22 22:19 root         INFO     Jackdaws love my big sphinx of quartz.
   10-22 22:19 myapp.area1  DEBUG    Quick zephyrs blow, vexing daft Jim.
   10-22 22:19 myapp.area1  INFO     How quickly daft jumping zebras vex.
   10-22 22:19 myapp.area2  WARNING  Jail zesty vixen who grabbed pay from quack.
   10-22 22:19 myapp.area2  ERROR    The five boxing wizards jump quickly.

正如你所看到的，DEBUG级别的消息只展示在文件中，而其他消息两个地方都会
输出。

这个示例只演示了在控制台和文件中去记录日志，但你也可以自由组合任意数量
的日志处理器。


日志服务器配置示例
==================

以下是在一个模块中使用日志服务器配置的示例:

   import logging
   import logging.config
   import time
   import os

   # read initial config file
   logging.config.fileConfig('logging.conf')

   # create and start listener on port 9999
   t = logging.config.listen(9999)
   t.start()

   logger = logging.getLogger('simpleExample')

   try:
       # loop through logging calls to see the difference
       # new configurations make, until Ctrl+C is pressed
       while True:
           logger.debug('debug message')
           logger.info('info message')
           logger.warning('warn message')
           logger.error('error message')
           logger.critical('critical message')
           time.sleep(5)
   except KeyboardInterrupt:
       # cleanup
       logging.config.stopListening()
       t.join()

然后如下的脚本，它接收文件名做为命令行参数，并将该文件以二进制编码的方
式传给服务器，做为新的日志服务器配置:

   #!/usr/bin/env python
   import socket, sys, struct

   with open(sys.argv[1], 'rb') as f:
       data_to_send = f.read()

   HOST = 'localhost'
   PORT = 9999
   s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
   print('connecting...')
   s.connect((HOST, PORT))
   print('sending config...')
   s.send(struct.pack('>L', len(data_to_send)))
   s.send(data_to_send)
   s.close()
   print('complete')


处理日志处理器的阻塞
====================

有时候需要让日志处理程序在不阻塞当前正在记录线程的情况下完成工作。 这
在Web应用程序中很常见，当然也会在其他场景中出现。

一个常见的缓慢行为是 "SMTPHandler": 由于开发者无法控制的多种原因（例如
，性能不佳的邮件或网络基础架构），发送电子邮件可能需要很长时间。 其实
几乎所有基于网络的处理程序都可能造成阻塞：即便是 "SocketHandler" 也可
能在底层进行 DNS 查询，这太慢了（这个查询会深入至套接字代码，位于
Python 层之下，这是不受开发者控制的）。

一种解决方案是分成两部分去处理。第一部分，针对那些对性能有要求的关键线
程的日志记录附加一个 "QueueHandler"。 日志记录器只需简单写入队列，该队
列可以设置一个足够大的容量甚至不设置容量上限。通常写入队列是一个快速的
操作，即使可能需要在代码中去捕获例如 "queue.Full" 等异常。 如果你是一
名处理关键线程的开发者，请务必记录这些信息 (包括建议只为日志处理器附加
"QueueHandlers") 以便于其他开发者使用你的代码。

解决方案的另一部分是 "QueueListener"，它被设计用来作为 "QueueHandler"
的对应。 "QueueListener" 非常简单：向其传入一个队列和一些处理句柄，它
会启动一个内部线程来监听从 "QueueHandlers" (或任何其他可用的
"LogRecords" 源) 发送过来的 LogRecords 队列。 "LogRecords" 会从队列中
被移除，并被传递给句柄进行处理。

使用一个单独的类 "QueueListener" 优点是可以使用同一个实例去服务于多个
``QueueHandlers``。这样会更节省资源，否则每个处理程序都占用一个线程没
有任何益处。

以下是使用了这样两个类的示例(省略了导入语句):

   que = queue.Queue(-1)  # no limit on size
   queue_handler = QueueHandler(que)
   handler = logging.StreamHandler()
   listener = QueueListener(que, handler)
   root = logging.getLogger()
   root.addHandler(queue_handler)
   formatter = logging.Formatter('%(threadName)s: %(message)s')
   handler.setFormatter(formatter)
   listener.start()
   # The log output will display the thread which generated
   # the event (the main thread) rather than the internal
   # thread which monitors the internal queue. This is what
   # you want to happen.
   root.warning('Look out!')
   listener.stop()

在运行后会产生:

   MainThread: Look out!

3.5 版更變: 在 Python 3.5 之前，"QueueListener" 总是把从队列中接收的每
个消息都传给它初始化的日志处理程序。(这是因为它会假设过滤级别总是在队
列的另一侧去设置的。) 从 Python 3.5 开始，可以通过在监听器构造函数中添
加一个参数 "respect_handler_level=True" 改变这种情况。当这样设置时，监
听器会比较每条消息的等级和日志处理器中设置的等级，只把需要传递的消息传
给对应的日志处理器。


通过网络发送和接收日志
======================

如果你想在网络上发送日志，并在接收端处理它们。一个简单的方式是通过附加
一个 "SocketHandler" 的实例在发送端的根日志处理器中:

   import logging, logging.handlers

   rootLogger = logging.getLogger('')
   rootLogger.setLevel(logging.DEBUG)
   socketHandler = logging.handlers.SocketHandler('localhost',
                       logging.handlers.DEFAULT_TCP_LOGGING_PORT)
   # don't bother with a formatter, since a socket handler sends the event as
   # an unformatted pickle
   rootLogger.addHandler(socketHandler)

   # Now, we can log to the root logger, or any other logger. First the root...
   logging.info('Jackdaws love my big sphinx of quartz.')

   # Now, define a couple of other loggers which might represent areas in your
   # application:

   logger1 = logging.getLogger('myapp.area1')
   logger2 = logging.getLogger('myapp.area2')

   logger1.debug('Quick zephyrs blow, vexing daft Jim.')
   logger1.info('How quickly daft jumping zebras vex.')
   logger2.warning('Jail zesty vixen who grabbed pay from quack.')
   logger2.error('The five boxing wizards jump quickly.')

在接收端，你可以使用 "socketserver" 模块设置一个接收器。这里是一个基础
示例:

   import pickle
   import logging
   import logging.handlers
   import socketserver
   import struct


   class LogRecordStreamHandler(socketserver.StreamRequestHandler):
       """Handler for a streaming logging request.

       This basically logs the record using whatever logging policy is
       configured locally.
       """

       def handle(self):
           """
           Handle multiple requests - each expected to be a 4-byte length,
           followed by the LogRecord in pickle format. Logs the record
           according to whatever policy is configured locally.
           """
           while True:
               chunk = self.connection.recv(4)
               if len(chunk) < 4:
                   break
               slen = struct.unpack('>L', chunk)[0]
               chunk = self.connection.recv(slen)
               while len(chunk) < slen:
                   chunk = chunk + self.connection.recv(slen - len(chunk))
               obj = self.unPickle(chunk)
               record = logging.makeLogRecord(obj)
               self.handleLogRecord(record)

       def unPickle(self, data):
           return pickle.loads(data)

       def handleLogRecord(self, record):
           # if a name is specified, we use the named logger rather than the one
           # implied by the record.
           if self.server.logname is not None:
               name = self.server.logname
           else:
               name = record.name
           logger = logging.getLogger(name)
           # N.B. EVERY record gets logged. This is because Logger.handle
           # is normally called AFTER logger-level filtering. If you want
           # to do filtering, do it at the client end to save wasting
           # cycles and network bandwidth!
           logger.handle(record)

   class LogRecordSocketReceiver(socketserver.ThreadingTCPServer):
       """
       Simple TCP socket-based logging receiver suitable for testing.
       """

       allow_reuse_address = True

       def __init__(self, host='localhost',
                    port=logging.handlers.DEFAULT_TCP_LOGGING_PORT,
                    handler=LogRecordStreamHandler):
           socketserver.ThreadingTCPServer.__init__(self, (host, port), handler)
           self.abort = 0
           self.timeout = 1
           self.logname = None

       def serve_until_stopped(self):
           import select
           abort = 0
           while not abort:
               rd, wr, ex = select.select([self.socket.fileno()],
                                          [], [],
                                          self.timeout)
               if rd:
                   self.handle_request()
               abort = self.abort

   def main():
       logging.basicConfig(
           format='%(relativeCreated)5d %(name)-15s %(levelname)-8s %(message)s')
       tcpserver = LogRecordSocketReceiver()
       print('About to start TCP server...')
       tcpserver.serve_until_stopped()

   if __name__ == '__main__':
       main()

首先运行服务端，然后是客户端。在客户端，没有什么内容会打印在控制台中；
在服务端，你应该会看到如下内容：

   About to start TCP server...
      59 root            INFO     Jackdaws love my big sphinx of quartz.
      59 myapp.area1     DEBUG    Quick zephyrs blow, vexing daft Jim.
      69 myapp.area1     INFO     How quickly daft jumping zebras vex.
      69 myapp.area2     WARNING  Jail zesty vixen who grabbed pay from quack.
      69 myapp.area2     ERROR    The five boxing wizards jump quickly.

请注意，在某些情况下序列化会存在一些安全。如果这影响到你，那么你可以通
过覆盖 "makePickle()" 方法，使用自己的实现来解决，并调整上述脚本也使用
覆盖后的序列化方法。


在日志记录中添加上下文信息
==========================

有时，除了传递给日志记录器调用的参数外，我们还希望日志记录中包含上下文
信息。例如，有一个网络应用，可能需要记录一些特殊的客户端信息在日志中（
比如客户端的用户名、IP地址等）。虽然你可以通过设置额外的参数去达到这个
目的，但这种方式不一定方便。或者你可能想到在每个连接的基础上创建一个
"Logger" 的实例，但这些实例是不会被垃圾回收的，这在练习中也许不是问题
，但当 "Logger" 的实例数量取决于你应用程序中想记录的细致程度时，如果
"Logger" 的实例数量不受限制的话，将会变得难以管理。


使用日志适配器传递上下文信息
----------------------------

一个传递上下文信息和日志事件信息的简单办法是使用类 "LoggerAdapter"。
这个类设计的像 "Logger"，所以可以直接调用 "debug()"、"info()"、
"warning()"、 "error()"、"exception()"、 "critical()" 和 "log()"。 这
些方法在对应的 "Logger" 中使用相同的签名，所以可以交替使用两种类型的实
例。

当你创建一个 "LoggerAdapter" 的实例时，你会传入一个 "Logger" 的实例和
一个包含了上下文信息的字典对象。当你调用一个 "LoggerAdapter" 实例的方
法时，它会把调用委托给内部的 "Logger" 的实例，并为其整理相关的上下文信
息。这是 "LoggerAdapter" 的一个代码片段:

   def debug(self, msg, /, *args, **kwargs):
       """
       Delegate a debug call to the underlying logger, after adding
       contextual information from this adapter instance.
       """
       msg, kwargs = self.process(msg, kwargs)
       self.logger.debug(msg, *args, **kwargs)

"LoggerAdapter" 的 "process()" 方法是将上下文信息添加到日志的输出中。
它传入日志消息和日志调用的关键字参数，并传回（隐式的）这些修改后的内容
去调用底层的日志记录器。此方法的默认参数只是一个消息字段，但留有一个
'extra' 的字段作为关键字参数传给构造器。当然，如果你在调用适配器时传入
了一个 'extra' 字段的参数，它会被静默覆盖。

使用 'extra' 的优点是这些键值对会被传入 "LogRecord" 实例的 __dict__ 中
，让你通过 "Formatter" 的实例直接使用定制的字符串，实例能找到这个字典
类对象的键。 如果你需要一个其他的方法，比如说，想要在消息字符串前后增
加上下文信息，你只需要创建一个 "LoggerAdapter" 的子类，并覆盖它的
"process()" 方法来做你想做的事情，以下是一个简单的示例:

   class CustomAdapter(logging.LoggerAdapter):
       """
       This example adapter expects the passed in dict-like object to have a
       'connid' key, whose value in brackets is prepended to the log message.
       """
       def process(self, msg, kwargs):
           return '[%s] %s' % (self.extra['connid'], msg), kwargs

你可以这样使用:

   logger = logging.getLogger(__name__)
   adapter = CustomAdapter(logger, {'connid': some_conn_id})

然后，你记录在适配器中的任何事件消息前将添加``some_conn_id``的值。


使用除字典之外的其它对象传递上下文信息
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

你不需要将一个实际的字典传递给 "LoggerAdapter"-你可以传入一个实现了
``__getitem__`` 和``__iter__``的类的实例，这样它就像是一个字典。这对于
你想动态生成值（而字典中的值往往是常量）将很有帮助。


使用过滤器传递上下文信息
------------------------

你也可以使用一个用户定义的类 "Filter" 在日志输出中添加上下文信息。
"Filter" 的实例是被允许修改传入的 "LogRecords"，包括添加其他的属性，然
后可以使用合适的格式化字符串输出，或者可以使用一个自定义的类
"Formatter"。

例如，在一个web应用程序中，正在处理的请求（或者至少是请求的一部分），
可以存储在一个线程本地 ("threading.local") 变量中，然后从``Filter`` 中
去访问。请求中的信息，如IP地址和用户名将被存储在``LogRecord``中，使用
上例 "LoggerAdapter" 中的 'ip' 和 'user' 属性名。在这种情况下，可以使
用相同的格式化字符串来得到上例中类似的输出结果。这是一段示例代码:

   import logging
   from random import choice

   class ContextFilter(logging.Filter):
       """
       This is a filter which injects contextual information into the log.

       Rather than use actual contextual information, we just use random
       data in this demo.
       """

       USERS = ['jim', 'fred', 'sheila']
       IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1']

       def filter(self, record):

           record.ip = choice(ContextFilter.IPS)
           record.user = choice(ContextFilter.USERS)
           return True

   if __name__ == '__main__':
       levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
       logging.basicConfig(level=logging.DEBUG,
                           format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s')
       a1 = logging.getLogger('a.b.c')
       a2 = logging.getLogger('d.e.f')

       f = ContextFilter()
       a1.addFilter(f)
       a2.addFilter(f)
       a1.debug('A debug message')
       a1.info('An info message with %s', 'some parameters')
       for x in range(10):
           lvl = choice(levels)
           lvlname = logging.getLevelName(lvl)
           a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')

在运行时，产生如下内容:

   2010-09-06 22:38:15,292 a.b.c DEBUG    IP: 123.231.231.123 User: fred     A debug message
   2010-09-06 22:38:15,300 a.b.c INFO     IP: 192.168.0.1     User: sheila   An info message with some parameters
   2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f ERROR    IP: 127.0.0.1       User: jim      A message at ERROR level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 127.0.0.1       User: sheila   A message at DEBUG level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f ERROR    IP: 123.231.231.123 User: fred     A message at ERROR level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 192.168.0.1     User: jim      A message at CRITICAL level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f CRITICAL IP: 127.0.0.1       User: sheila   A message at CRITICAL level with 2 parameters
   2010-09-06 22:38:15,300 d.e.f DEBUG    IP: 192.168.0.1     User: jim      A message at DEBUG level with 2 parameters
   2010-09-06 22:38:15,301 d.e.f ERROR    IP: 127.0.0.1       User: sheila   A message at ERROR level with 2 parameters
   2010-09-06 22:38:15,301 d.e.f DEBUG    IP: 123.231.231.123 User: fred     A message at DEBUG level with 2 parameters
   2010-09-06 22:38:15,301 d.e.f INFO     IP: 123.231.231.123 User: fred     A message at INFO level with 2 parameters


从多个进程记录至单个文件
========================

尽管 logging 是线程安全的，将单个进程中的多个线程日志记录至单个文件也
*是* 受支持的，但将 *多个进程* 中的日志记录至单个文件则 *不是* 受支持
的，因为在 Python 中并没有在多个进程中实现对单个文件访问的序列化的标准
方案。 如果你需要将多个进程中的日志记录至单个文件，有一个方案是让所有
进程都将日志记录至一个 "SocketHandler"，然后用一个实现了套接字服务器的
单独进程一边从套接字中读取一边将日志记录至文件。 （如果愿意的话，你可
以在一个现有进程中专门开一个线程来执行此项功能。） 这一部分 文档对此方
式有更详细的介绍，并包含一个可用的套接字接收器，你自己的应用可以在此基
础上进行适配。

你也可以编写你自己的处理程序，让其使用 "multiprocessing" 模块中的
"Lock" 类来顺序访问你的多个进程中的文件。 现有的 "FileHandler" 及其子
类目前并不使用 "multiprocessing"，尽管它们将来可能会这样做。 请注意在
目前，"multiprocessing" 模块并未在所有平台上都提供可用的锁功能 (参见
https://bugs.python.org/issue3770)。

或者，你也可以使用 "Queue" 和 "QueueHandler" 将所有的日志事件发送至你
的多进程应用的一个进程中。 以下示例脚本演示了如何执行此操作。 在示例中
，一个单独的监听进程负责监听其他进程的日志事件，并根据自己的配置记录。
尽管示例只演示了这种方法（例如你可能希望使用单独的监听线程而非监听进程
—— 它们的实现是类似的），但你也可以在应用程序的监听进程和其他进程使用
不同的配置，它可以作为满足你特定需求的一个基础:

   # You'll need these imports in your own code
   import logging
   import logging.handlers
   import multiprocessing

   # Next two import lines for this demo only
   from random import choice, random
   import time

   #
   # Because you'll want to define the logging configurations for listener and workers, the
   # listener and worker process functions take a configurer parameter which is a callable
   # for configuring logging for that process. These functions are also passed the queue,
   # which they use for communication.
   #
   # In practice, you can configure the listener however you want, but note that in this
   # simple example, the listener does not apply level or filter logic to received records.
   # In practice, you would probably want to do this logic in the worker processes, to avoid
   # sending events which would be filtered out between processes.
   #
   # The size of the rotated files is made small so you can see the results easily.
   def listener_configurer():
       root = logging.getLogger()
       h = logging.handlers.RotatingFileHandler('mptest.log', 'a', 300, 10)
       f = logging.Formatter('%(asctime)s %(processName)-10s %(name)s %(levelname)-8s %(message)s')
       h.setFormatter(f)
       root.addHandler(h)

   # This is the listener process top-level loop: wait for logging events
   # (LogRecords)on the queue and handle them, quit when you get a None for a
   # LogRecord.
   def listener_process(queue, configurer):
       configurer()
       while True:
           try:
               record = queue.get()
               if record is None:  # We send this as a sentinel to tell the listener to quit.
                   break
               logger = logging.getLogger(record.name)
               logger.handle(record)  # No level or filter logic applied - just do it!
           except Exception:
               import sys, traceback
               print('Whoops! Problem:', file=sys.stderr)
               traceback.print_exc(file=sys.stderr)

   # Arrays used for random selections in this demo

   LEVELS = [logging.DEBUG, logging.INFO, logging.WARNING,
             logging.ERROR, logging.CRITICAL]

   LOGGERS = ['a.b.c', 'd.e.f']

   MESSAGES = [
       'Random message #1',
       'Random message #2',
       'Random message #3',
   ]

   # The worker configuration is done at the start of the worker process run.
   # Note that on Windows you can't rely on fork semantics, so each process
   # will run the logging configuration code when it starts.
   def worker_configurer(queue):
       h = logging.handlers.QueueHandler(queue)  # Just the one handler needed
       root = logging.getLogger()
       root.addHandler(h)
       # send all messages, for demo; no other level or filter logic applied.
       root.setLevel(logging.DEBUG)

   # This is the worker process top-level loop, which just logs ten events with
   # random intervening delays before terminating.
   # The print messages are just so you know it's doing something!
   def worker_process(queue, configurer):
       configurer(queue)
       name = multiprocessing.current_process().name
       print('Worker started: %s' % name)
       for i in range(10):
           time.sleep(random())
           logger = logging.getLogger(choice(LOGGERS))
           level = choice(LEVELS)
           message = choice(MESSAGES)
           logger.log(level, message)
       print('Worker finished: %s' % name)

   # Here's where the demo gets orchestrated. Create the queue, create and start
   # the listener, create ten workers and start them, wait for them to finish,
   # then send a None to the queue to tell the listener to finish.
   def main():
       queue = multiprocessing.Queue(-1)
       listener = multiprocessing.Process(target=listener_process,
                                          args=(queue, listener_configurer))
       listener.start()
       workers = []
       for i in range(10):
           worker = multiprocessing.Process(target=worker_process,
                                            args=(queue, worker_configurer))
           workers.append(worker)
           worker.start()
       for w in workers:
           w.join()
       queue.put_nowait(None)
       listener.join()

   if __name__ == '__main__':
       main()

上面脚本的一个变种，仍然在主进程中记录日志，但使用一个单独的线程:

   import logging
   import logging.config
   import logging.handlers
   from multiprocessing import Process, Queue
   import random
   import threading
   import time

   def logger_thread(q):
       while True:
           record = q.get()
           if record is None:
               break
           logger = logging.getLogger(record.name)
           logger.handle(record)


   def worker_process(q):
       qh = logging.handlers.QueueHandler(q)
       root = logging.getLogger()
       root.setLevel(logging.DEBUG)
       root.addHandler(qh)
       levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
                 logging.CRITICAL]
       loggers = ['foo', 'foo.bar', 'foo.bar.baz',
                  'spam', 'spam.ham', 'spam.ham.eggs']
       for i in range(100):
           lvl = random.choice(levels)
           logger = logging.getLogger(random.choice(loggers))
           logger.log(lvl, 'Message no. %d', i)

   if __name__ == '__main__':
       q = Queue()
       d = {
           'version': 1,
           'formatters': {
               'detailed': {
                   'class': 'logging.Formatter',
                   'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
               }
           },
           'handlers': {
               'console': {
                   'class': 'logging.StreamHandler',
                   'level': 'INFO',
               },
               'file': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog.log',
                   'mode': 'w',
                   'formatter': 'detailed',
               },
               'foofile': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog-foo.log',
                   'mode': 'w',
                   'formatter': 'detailed',
               },
               'errors': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog-errors.log',
                   'mode': 'w',
                   'level': 'ERROR',
                   'formatter': 'detailed',
               },
           },
           'loggers': {
               'foo': {
                   'handlers': ['foofile']
               }
           },
           'root': {
               'level': 'DEBUG',
               'handlers': ['console', 'file', 'errors']
           },
       }
       workers = []
       for i in range(5):
           wp = Process(target=worker_process, name='worker %d' % (i + 1), args=(q,))
           workers.append(wp)
           wp.start()
       logging.config.dictConfig(d)
       lp = threading.Thread(target=logger_thread, args=(q,))
       lp.start()
       # At this point, the main process could do some useful work of its own
       # Once it's done that, it can wait for the workers to terminate...
       for wp in workers:
           wp.join()
       # And now tell the logging thread to finish up, too
       q.put(None)
       lp.join()

这段变种的代码展示了如何使用特定的日志记录配置 - 例如``foo``记录器使用
了特殊的处理程序，将 "foo" 子系统中所有的事件记录至一个文件 "mplog-
foo.log"。在主进程（即使是在工作进程中产生的日志事件）的日志记录机制中
将直接使用恰当的配置。


concurrent.futures.ProcessPoolExecutor 的用法
---------------------------------------------

若要利用 "concurrent.futures.ProcessPoolExecutor" 启动工作进程，创建队
列的方式应稍有不同。不能是：

   queue = multiprocessing.Queue(-1)

而应是：

   queue = multiprocessing.Manager().Queue(-1)  # also works with the examples above

然后就可以将以下工作进程的创建过程：

   workers = []
   for i in range(10):
       worker = multiprocessing.Process(target=worker_process,
                                        args=(queue, worker_configurer))
       workers.append(worker)
       worker.start()
   for w in workers:
       w.join()

改为 (记得要先导入 "concurrent.futures"):

   with concurrent.futures.ProcessPoolExecutor(max_workers=10) as executor:
       for i in range(10):
           executor.submit(worker_process, queue, worker_configurer)


轮换日志文件
============

有时，你希望当日志文件不断记录增长至一定大小时，打开一个新的文件接着记
录。 你可能希望只保留一定数量的日志文件，当不断的创建文件到达该数量时
，又覆盖掉最开始的文件形成循环。 对于这种使用场景，日志包提供了
"RotatingFileHandler":

   import glob
   import logging
   import logging.handlers

   LOG_FILENAME = 'logging_rotatingfile_example.out'

   # Set up a specific logger with our desired output level
   my_logger = logging.getLogger('MyLogger')
   my_logger.setLevel(logging.DEBUG)

   # Add the log message handler to the logger
   handler = logging.handlers.RotatingFileHandler(
                 LOG_FILENAME, maxBytes=20, backupCount=5)

   my_logger.addHandler(handler)

   # Log some messages
   for i in range(20):
       my_logger.debug('i = %d' % i)

   # See what files are created
   logfiles = glob.glob('%s*' % LOG_FILENAME)

   for filename in logfiles:
       print(filename)

结果应该是6个单独的文件，每个文件都包含了应用程序的部分历史日志:

   logging_rotatingfile_example.out
   logging_rotatingfile_example.out.1
   logging_rotatingfile_example.out.2
   logging_rotatingfile_example.out.3
   logging_rotatingfile_example.out.4
   logging_rotatingfile_example.out.5

最新的文件始终是:file:*logging_rotatingfile_example.out*，每次到达大小
限制时，都会使用后缀``.1``重命名。每个现有的备份文件都会被重命名并增加
其后缀（例如``.1`` 变为``.2``），而``.6``文件会被删除掉。

显然，这个例子将日志长度设置得太小，这是一个极端的例子。 你可能希望将
*maxBytes* 设置为一个合适的值。


使用其他日志格式化方式
======================

当日志模块被添加至 Python 标准库时，只有一种格式化消息内容的方法即
%-formatting。 在那之后，Python 又增加了两种格式化方法:
"string.Template" (在 Python 2.4 中新增) 和 "str.format()" (在 Python
2.6 中新增)。

日志（从 3.2 开始）为这两种格式化方式提供了更多支持。"Formatter" 类可
以添加一个额外的可选关键字参数 "style"。它的默认值是 "'%'"，其他的值
"'{'" 和 "'$'" 也支持，对应了其他两种格式化样式。其保持了向后兼容（如
您所愿），但通过显示指定样式参数，你可以指定格式化字符串的方式是使用
"str.format()" 或 "string.Template"。 这里是一个控制台会话的示例，展示
了这些方式：

   >>> import logging
   >>> root = logging.getLogger()
   >>> root.setLevel(logging.DEBUG)
   >>> handler = logging.StreamHandler()
   >>> bf = logging.Formatter('{asctime} {name} {levelname:8s} {message}',
   ...                        style='{')
   >>> handler.setFormatter(bf)
   >>> root.addHandler(handler)
   >>> logger = logging.getLogger('foo.bar')
   >>> logger.debug('This is a DEBUG message')
   2010-10-28 15:11:55,341 foo.bar DEBUG    This is a DEBUG message
   >>> logger.critical('This is a CRITICAL message')
   2010-10-28 15:12:11,526 foo.bar CRITICAL This is a CRITICAL message
   >>> df = logging.Formatter('$asctime $name ${levelname} $message',
   ...                        style='$')
   >>> handler.setFormatter(df)
   >>> logger.debug('This is a DEBUG message')
   2010-10-28 15:13:06,924 foo.bar DEBUG This is a DEBUG message
   >>> logger.critical('This is a CRITICAL message')
   2010-10-28 15:13:11,494 foo.bar CRITICAL This is a CRITICAL message
   >>>

请注意最终输出到日志的消息格式完全独立于单条日志消息的构造方式。 它仍
然可以使用 %-formatting，如下所示:

   >>> logger.error('This is an%s %s %s', 'other,', 'ERROR,', 'message')
   2010-10-28 15:19:29,833 foo.bar ERROR This is another, ERROR, message
   >>>

日志调用（"logger.debug()" 、"logger.info()" 等）接受的位置参数只会用
于日志信息本身，而关键字参数仅用于日志调用的可选处理参数（如关键字参数
"exc_info" 表示应记录跟踪信息， "extra" 则标识了需要加入日志的额外上下
文信息）。所以不能直接用 "str.format()" 或 "string.Template" 语法进行
日志调用，因为日志包在内部使用 %-f 格式来合并格式串和参数变量。在保持
向下兼容性时，这一点不会改变，因为已有代码中的所有日志调用都会使用%-f
格式串。

还有一种方法可以构建自己的日志信息，就是利用 {}- 和 $- 格式。回想一下
，任意对象都可用为日志信息的格式串，日志包将会调用该对象的 "str()" 方
法，以获取最终的格式串。不妨看下一下两个类：

   class BraceMessage:
       def __init__(self, fmt, /, *args, **kwargs):
           self.fmt = fmt
           self.args = args
           self.kwargs = kwargs

       def __str__(self):
           return self.fmt.format(*self.args, **self.kwargs)

   class DollarMessage:
       def __init__(self, fmt, /, **kwargs):
           self.fmt = fmt
           self.kwargs = kwargs

       def __str__(self):
           from string import Template
           return Template(self.fmt).substitute(**self.kwargs)

上述两个类均可代替格式串，使得能用 {}- 或 $-formatting 构建最终的“日志
信息”部分，这些信息将出现在格式化后的日志输出中，替换 %(message)s 或
“{message}”或“$message”。每次写入日志时都要使用类名，有点不大实用，但
如果用上 __ 之类的别名就相当合适了（双下划线 --- 不要与 _ 混淆，单下划
线用作 "gettext.gettext()" 或相关函数的同义词/别名 ）。

Python 并没有上述两个类，当然复制粘贴到自己的代码中也很容易。用法可如
下所示（假定在名为 "wherever" 的模块中声明）：

   >>> from wherever import BraceMessage as __
   >>> print(__('Message with {0} {name}', 2, name='placeholders'))
   Message with 2 placeholders
   >>> class Point: pass
   ...
   >>> p = Point()
   >>> p.x = 0.5
   >>> p.y = 0.5
   >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})',
   ...       point=p))
   Message with coordinates: (0.50, 0.50)
   >>> from wherever import DollarMessage as __
   >>> print(__('Message with $num $what', num=2, what='placeholders'))
   Message with 2 placeholders
   >>>

上述示例用了 "print()" 演示格式化输出的过程，实际记录日志时当然会用类
似 "logger.debug()" 的方法来应用。

值得注意的是，上述做法对性能并没什么影响：格式化过程其实不是在日志记录
调用时发生的，而是在日志信息即将由 handler 输出到日志时发生。因此，唯
一可能让人困惑的稍不寻常的地方，就是包裹在格式串和参数外面的括号，而不
是格式串。因为 __ 符号只是对 XXXMessage 类的构造函数调用的语法糖。

只要愿意，上述类似的效果即可用 "LoggerAdapter" 实现，如下例所示：

   import logging

   class Message:
       def __init__(self, fmt, args):
           self.fmt = fmt
           self.args = args

       def __str__(self):
           return self.fmt.format(*self.args)

   class StyleAdapter(logging.LoggerAdapter):
       def __init__(self, logger, extra=None):
           super().__init__(logger, extra or {})

       def log(self, level, msg, /, *args, **kwargs):
           if self.isEnabledFor(level):
               msg, kwargs = self.process(msg, kwargs)
               self.logger._log(level, Message(msg, args), (), **kwargs)

   logger = StyleAdapter(logging.getLogger(__name__))

   def main():
       logger.debug('Hello, {}', 'world!')

   if __name__ == '__main__':
       logging.basicConfig(level=logging.DEBUG)
       main()

在用 Python 3.2 以上版本运行时，上述代码应该会把 "Hello, world!" 写入
日志。


自定义 "LogRecord"
==================

每条日志事件都由一个  "LogRecord" 实例表示。当某事件要记入日志并且没有
被某级别过滤掉时，就会创建一个 "LogRecord" 对象，并将有关事件的信息填
入，传给该日志对象的 handler（及其祖先，直至对象禁止向上传播为止）。在
Python 3.2 之前，只有两个地方会进行事件的创建：

* "Logger.makeRecord()"，在事件正常记入日志的过程中调用。这会直接调用
  "LogRecord" 来创建一个实例。

* "makeLogRecord()"，调用时会带上一个字典参数，其中存放着要加入
  LogRecord 的属性。这通常在通过网络接收到合适的字典时调用（如通过
  "SocketHandler" 以 pickle 形式，或通过 "HTTPHandler" 以 JSON 形式）
  。

于是这意味着若要对 "LogRecord" 进行定制，必须进行下述某种操作。

* 创建 "Logger"  自定义子类，重写 "Logger.makeRecord()"，并在实例化所
  需日志对象之前用 "setLoggerClass()" 进行设置。

* 为日志对象添加 "Filter" 或 handler，当其 "filter()" 方法被调用时，会
  执行必要的定制操作。

比如说在有多个不同库要完成不同操作的场景下，第一种方式会有点笨拙。 每
次都要尝试设置自己的 "Logger" 子类，而起作用的是最后一次尝试。

第二种方式在多数情况下效果都比较良好，但不允许你使用特殊化的
"LogRecord" 子类。 库开发者可以为他们的日志记录器设置合适的过滤器，但
他们应当要记得每次引入新的日志记录器时都需如此（他们只需通过添加新的包
或模块并执行以下操作即可）:

   logger = logging.getLogger(__name__)

或许这样要顾及太多事情。开发人员还可以将过滤器附加到其顶级日志对象的
"NullHandler" 中，但如果应用程序开发人员将 handler 附加到较底层库的日
志对象，则不会调用该过滤器 --- 所以 handler 输出的内容不会符合库开发人
员的预期。

在 Python 3.2 以上版本中，"LogRecord" 的创建是通过工厂对象完成的，工厂
对象可以指定。工厂对象只是一个可调用对象，可以用
"setLogRecordFactory()" 进行设置，并用 "getLogRecordFactory()" 进行查
询。工厂对象的调用参数与 "LogRecord" 的构造函数相同，因为 "LogRecord"
是工厂对象的默认设置。

这种方式可以让自定义工厂对象完全控制 LogRecord 的创建过程。比如可以返
回一个子类，或者在创建的日志对象中加入一些额外的属性，使用方式如下所示
：

   old_factory = logging.getLogRecordFactory()

   def record_factory(*args, **kwargs):
       record = old_factory(*args, **kwargs)
       record.custom_attribute = 0xdecafbad
       return record

   logging.setLogRecordFactory(record_factory)

这种模式允许不同的库将多个工厂对象链在一起，只要不会覆盖彼此的属性或标
准属性，就不会出现意外。但应记住，工厂链中的每个节点都会增加日志操作的
运行开销，本技术仅在采用 "Filter" 无法达到目标时才应使用。


子类化 QueueHandler - ZeroMQ 示例
=================================

你可以使用 "QueueHandler" 子类将消息发送给其他类型的队列 ，比如 ZeroMQ
'publish' 套接字。 在以下示例中，套接字将单独创建并传给处理句柄 (作为
它的 'queue'):

   import zmq   # using pyzmq, the Python binding for ZeroMQ
   import json  # for serializing records portably

   ctx = zmq.Context()
   sock = zmq.Socket(ctx, zmq.PUB)  # or zmq.PUSH, or other suitable value
   sock.bind('tcp://*:5556')        # or wherever

   class ZeroMQSocketHandler(QueueHandler):
       def enqueue(self, record):
           self.queue.send_json(record.__dict__)


   handler = ZeroMQSocketHandler(sock)

当然还有其他方案，比如通过 hander 传入所需数据，以创建 socket：

   class ZeroMQSocketHandler(QueueHandler):
       def __init__(self, uri, socktype=zmq.PUB, ctx=None):
           self.ctx = ctx or zmq.Context()
           socket = zmq.Socket(self.ctx, socktype)
           socket.bind(uri)
           super().__init__(socket)

       def enqueue(self, record):
           self.queue.send_json(record.__dict__)

       def close(self):
           self.queue.close()


子类化 QueueListener —— ZeroMQ 示例
===================================

你还可以子类化 "QueueListener" 来从其他类型的队列中获取消息，比如从
ZeroMQ 'subscribe' 套接字。 下面是一个例子:

   class ZeroMQSocketListener(QueueListener):
       def __init__(self, uri, /, *handlers, **kwargs):
           self.ctx = kwargs.get('ctx') or zmq.Context()
           socket = zmq.Socket(self.ctx, zmq.SUB)
           socket.setsockopt_string(zmq.SUBSCRIBE, '')  # subscribe to everything
           socket.connect(uri)
           super().__init__(socket, *handlers, **kwargs)

       def dequeue(self):
           msg = self.queue.recv_json()
           return logging.makeLogRecord(msg)

也參考:

  模块 "logging"
     日志记录模块的 API 参考。

  "logging.config" 模块
     日志记录模块的配置 API 。

  "logging.handlers" 模块
     日志记录模块附带的有用处理器。

  日志操作基础教程

  日志操作的高级教程


基于字典进行日志配置的示例
==========================

以下是日志配置字典的一个示例——它取自 Django 项目的`文档
<https://docs.djangoproject.com/en/stable/topics/logging/#configuring-
logging>`_。此字典将被传给 "dictConfig()" 以使配置生效:

   LOGGING = {
       'version': 1,
       'disable_existing_loggers': True,
       'formatters': {
           'verbose': {
               'format': '%(levelname)s %(asctime)s %(module)s %(process)d %(thread)d %(message)s'
           },
           'simple': {
               'format': '%(levelname)s %(message)s'
           },
       },
       'filters': {
           'special': {
               '()': 'project.logging.SpecialFilter',
               'foo': 'bar',
           }
       },
       'handlers': {
           'null': {
               'level':'DEBUG',
               'class':'django.utils.log.NullHandler',
           },
           'console':{
               'level':'DEBUG',
               'class':'logging.StreamHandler',
               'formatter': 'simple'
           },
           'mail_admins': {
               'level': 'ERROR',
               'class': 'django.utils.log.AdminEmailHandler',
               'filters': ['special']
           }
       },
       'loggers': {
           'django': {
               'handlers':['null'],
               'propagate': True,
               'level':'INFO',
           },
           'django.request': {
               'handlers': ['mail_admins'],
               'level': 'ERROR',
               'propagate': False,
           },
           'myproject.custom': {
               'handlers': ['console', 'mail_admins'],
               'level': 'INFO',
               'filters': ['special']
           }
       }
   }

有关本配置的更多信息，请参阅 Django 文档的  有关章节 。


利用 rotator 和 namer 自定义日志轮换操作
========================================

以下代码给出了定义 namer 和 rotator 的示例，其中演示了基于 zlib 的日志
文件压缩过程：

   def namer(name):
       return name + ".gz"

   def rotator(source, dest):
       with open(source, "rb") as sf:
           data = sf.read()
           compressed = zlib.compress(data, 9)
           with open(dest, "wb") as df:
               df.write(compressed)
       os.remove(source)

   rh = logging.handlers.RotatingFileHandler(...)
   rh.rotator = rotator
   rh.namer = namer

这些不是“真正的” .gz 文件，因为他们只是纯压缩数据，缺少真正 gzip 文件
中的“容器”。此段代码只是用于演示。


更加详细的多道处理示例
======================

以下可运行的示例显示了如何利用配置文件在多进程中应用日志。这些配置相当
简单，但足以说明如何在真实的多进程场景中实现较为复杂的配置。

上述示例中，主进程产生一个侦听器进程和一些工作进程。每个主进程、侦听器
进程和工作进程都有三种独立的日志配置（工作进程共享同一套配置）。大家可
以看到主进程的日志记录过程、工作线程向 QueueHandler 写入日志的过程，以
及侦听器实现 QueueListener 和较为复杂的日志配置，如何将由队列接收到的
事件分发给配置指定的 handler。请注意，这些配置纯粹用于演示，但应该能调
整代码以适用于自己的场景。

以下是代码——但愿文档字符串和注释能有助于理解其工作原理：

   import logging
   import logging.config
   import logging.handlers
   from multiprocessing import Process, Queue, Event, current_process
   import os
   import random
   import time

   class MyHandler:
       """
       A simple handler for logging events. It runs in the listener process and
       dispatches events to loggers based on the name in the received record,
       which then get dispatched, by the logging system, to the handlers
       configured for those loggers.
       """

       def handle(self, record):
           if record.name == "root":
               logger = logging.getLogger()
           else:
               logger = logging.getLogger(record.name)

           if logger.isEnabledFor(record.levelno):
               # The process name is transformed just to show that it's the listener
               # doing the logging to files and console
               record.processName = '%s (for %s)' % (current_process().name, record.processName)
               logger.handle(record)

   def listener_process(q, stop_event, config):
       """
       This could be done in the main process, but is just done in a separate
       process for illustrative purposes.

       This initialises logging according to the specified configuration,
       starts the listener and waits for the main process to signal completion
       via the event. The listener is then stopped, and the process exits.
       """
       logging.config.dictConfig(config)
       listener = logging.handlers.QueueListener(q, MyHandler())
       listener.start()
       if os.name == 'posix':
           # On POSIX, the setup logger will have been configured in the
           # parent process, but should have been disabled following the
           # dictConfig call.
           # On Windows, since fork isn't used, the setup logger won't
           # exist in the child, so it would be created and the message
           # would appear - hence the "if posix" clause.
           logger = logging.getLogger('setup')
           logger.critical('Should not appear, because of disabled logger ...')
       stop_event.wait()
       listener.stop()

   def worker_process(config):
       """
       A number of these are spawned for the purpose of illustration. In
       practice, they could be a heterogeneous bunch of processes rather than
       ones which are identical to each other.

       This initialises logging according to the specified configuration,
       and logs a hundred messages with random levels to randomly selected
       loggers.

       A small sleep is added to allow other processes a chance to run. This
       is not strictly needed, but it mixes the output from the different
       processes a bit more than if it's left out.
       """
       logging.config.dictConfig(config)
       levels = [logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
                 logging.CRITICAL]
       loggers = ['foo', 'foo.bar', 'foo.bar.baz',
                  'spam', 'spam.ham', 'spam.ham.eggs']
       if os.name == 'posix':
           # On POSIX, the setup logger will have been configured in the
           # parent process, but should have been disabled following the
           # dictConfig call.
           # On Windows, since fork isn't used, the setup logger won't
           # exist in the child, so it would be created and the message
           # would appear - hence the "if posix" clause.
           logger = logging.getLogger('setup')
           logger.critical('Should not appear, because of disabled logger ...')
       for i in range(100):
           lvl = random.choice(levels)
           logger = logging.getLogger(random.choice(loggers))
           logger.log(lvl, 'Message no. %d', i)
           time.sleep(0.01)

   def main():
       q = Queue()
       # The main process gets a simple configuration which prints to the console.
       config_initial = {
           'version': 1,
           'handlers': {
               'console': {
                   'class': 'logging.StreamHandler',
                   'level': 'INFO'
               }
           },
           'root': {
               'handlers': ['console'],
               'level': 'DEBUG'
           }
       }
       # The worker process configuration is just a QueueHandler attached to the
       # root logger, which allows all messages to be sent to the queue.
       # We disable existing loggers to disable the "setup" logger used in the
       # parent process. This is needed on POSIX because the logger will
       # be there in the child following a fork().
       config_worker = {
           'version': 1,
           'disable_existing_loggers': True,
           'handlers': {
               'queue': {
                   'class': 'logging.handlers.QueueHandler',
                   'queue': q
               }
           },
           'root': {
               'handlers': ['queue'],
               'level': 'DEBUG'
           }
       }
       # The listener process configuration shows that the full flexibility of
       # logging configuration is available to dispatch events to handlers however
       # you want.
       # We disable existing loggers to disable the "setup" logger used in the
       # parent process. This is needed on POSIX because the logger will
       # be there in the child following a fork().
       config_listener = {
           'version': 1,
           'disable_existing_loggers': True,
           'formatters': {
               'detailed': {
                   'class': 'logging.Formatter',
                   'format': '%(asctime)s %(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
               },
               'simple': {
                   'class': 'logging.Formatter',
                   'format': '%(name)-15s %(levelname)-8s %(processName)-10s %(message)s'
               }
           },
           'handlers': {
               'console': {
                   'class': 'logging.StreamHandler',
                   'formatter': 'simple',
                   'level': 'INFO'
               },
               'file': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog.log',
                   'mode': 'w',
                   'formatter': 'detailed'
               },
               'foofile': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog-foo.log',
                   'mode': 'w',
                   'formatter': 'detailed'
               },
               'errors': {
                   'class': 'logging.FileHandler',
                   'filename': 'mplog-errors.log',
                   'mode': 'w',
                   'formatter': 'detailed',
                   'level': 'ERROR'
               }
           },
           'loggers': {
               'foo': {
                   'handlers': ['foofile']
               }
           },
           'root': {
               'handlers': ['console', 'file', 'errors'],
               'level': 'DEBUG'
           }
       }
       # Log some initial events, just to show that logging in the parent works
       # normally.
       logging.config.dictConfig(config_initial)
       logger = logging.getLogger('setup')
       logger.info('About to create workers ...')
       workers = []
       for i in range(5):
           wp = Process(target=worker_process, name='worker %d' % (i + 1),
                        args=(config_worker,))
           workers.append(wp)
           wp.start()
           logger.info('Started worker: %s', wp.name)
       logger.info('About to create listener ...')
       stop_event = Event()
       lp = Process(target=listener_process, name='listener',
                    args=(q, stop_event, config_listener))
       lp.start()
       logger.info('Started listener')
       # We now hang around for the workers to finish their work.
       for wp in workers:
           wp.join()
       # Workers all done, listening can now stop.
       # Logging in the parent still works normally.
       logger.info('Telling listener to stop ...')
       stop_event.set()
       lp.join()
       logger.info('All done.')

   if __name__ == '__main__':
       main()


在发送给 SysLogHandler 的信息中插入一个  BOM。
==============================================

**RFC 5424** 要求，Unicode 信息应采用字节流形式发送到系统 syslog 守护
程序，字节流结构如下所示：可选的纯 ASCII部分，后跟 UTF-8 字节序标记（
BOM），然后是采用 UTF-8 编码的 Unicode。（参见 **相关规范** 。）

在 Python 3.1 的 "SysLogHandler" 中，已加入了在日志信息中插入 BOM 的代
码，但不幸的是，代码并不正确，BOM 出现在了日志信息的开头，因此在它之前
就不允许出现纯 ASCII 内容了。

由于无法正常工作， Python 3.2.4 以上版本已删除了出错的插入 BOM 代码。
但已有版本的代码不会被替换，若要生成与 **RFC 5424** 兼容的日志信息，包
括一个 BOM 符，前面有可选的纯 ASCII 字节流，后面为 UTF-8 编码的任意
Unicode，那么 需要执行以下操作：

1. 为 "SysLogHandler" 实例串上一个 "Formatter" 实例，格式串可如下：

      'ASCII section\ufeffUnicode section'

   用 UTF-8 编码时，Unicode 码位 U+FEFF 将会编码为 UTF-8 BOM——字节串
   "b'\xef\xbb\xbf'" 。

2. 用任意占位符替换 ASCII 部分，但要保证替换之后的数据一定是 ASCII 码
   （这样在 UTF-8 编码后就会维持不变）。

3. 用任意占位符替换 Unicode 部分；如果替换后的数据包含超出 ASCII 范围
   的字符，没问题——他们将用 UTF-8 进行编码。

"SysLogHandler" *将* 对格式化后的日志信息进行 UTF-8 编码。如果遵循上述
规则，应能生成符合 **RFC 5424** 的日志信息。否则，日志记录过程可能不会
有什么反馈，但日志信息将不与 RFC 5424 兼容，syslog 守护程序可能会有出
错反应。


结构化日志的实现代码
====================

大多数日志信息是供人阅读的，所以机器解析起来并不容易，但某些时候可能希
望以结构化的格式输出，以 *能够* 被程序解析（无需用到复杂的正则表达式）
。这可以直接用 logging 包实现。实现方式有很多，以下是一种比较简单的方
案，利用 JSON 以机器可解析的方式对事件信息进行序列化：

   import json
   import logging

   class StructuredMessage:
       def __init__(self, message, /, **kwargs):
           self.message = message
           self.kwargs = kwargs

       def __str__(self):
           return '%s >>> %s' % (self.message, json.dumps(self.kwargs))

   _ = StructuredMessage   # optional, to improve readability

   logging.basicConfig(level=logging.INFO, format='%(message)s')
   logging.info(_('message 1', foo='bar', bar='baz', num=123, fnum=123.456))

上述代码运行后的结果是：

   message 1 >>> {"fnum": 123.456, "num": 123, "bar": "baz", "foo": "bar"}

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。

若需进行更为定制化的处理，可以使用自定义 JSON 编码对象，下面给出完整示
例：

   from __future__ import unicode_literals

   import json
   import logging

   # This next bit is to ensure the script runs unchanged on 2.x and 3.x
   try:
       unicode
   except NameError:
       unicode = str

   class Encoder(json.JSONEncoder):
       def default(self, o):
           if isinstance(o, set):
               return tuple(o)
           elif isinstance(o, unicode):
               return o.encode('unicode_escape').decode('ascii')
           return super().default(o)

   class StructuredMessage:
       def __init__(self, message, /, **kwargs):
           self.message = message
           self.kwargs = kwargs

       def __str__(self):
           s = Encoder().encode(self.kwargs)
           return '%s >>> %s' % (self.message, s)

   _ = StructuredMessage   # optional, to improve readability

   def main():
       logging.basicConfig(level=logging.INFO, format='%(message)s')
       logging.info(_('message 1', set_value={1, 2, 3}, snowman='\u2603'))

   if __name__ == '__main__':
       main()

上述代码运行后的结果是：

   message 1 >>> {"snowman": "\u2603", "set_value": [1, 2, 3]}

请注意，根据 Python 版本的不同，各项数据的输出顺序可能会不一样。


利用 "dictConfig()" 自定义 handler
==================================

有时需要以特定方式自定义日志 handler，如果采用 "dictConfig()"，可能无
需生成子类就可以做到。比如要设置日志文件的所有权。在 POSIX 上，可以利
用 "shutil.chown()" 轻松完成，但 stdlib 中的文件 handler 并不提供内置
支持。于是可以用普通函数自定义 handler 的创建，例如：

   def owned_file_handler(filename, mode='a', encoding=None, owner=None):
       if owner:
           if not os.path.exists(filename):
               open(filename, 'a').close()
           shutil.chown(filename, *owner)
       return logging.FileHandler(filename, mode, encoding)

然后，你可以在传给 "dictConfig()" 的日志配置中指定通过调用此函数来创建
日志处理程序:

   LOGGING = {
       'version': 1,
       'disable_existing_loggers': False,
       'formatters': {
           'default': {
               'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
           },
       },
       'handlers': {
           'file':{
               # The values below are popped from this dictionary and
               # used to create the handler, set the handler's level and
               # its formatter.
               '()': owned_file_handler,
               'level':'DEBUG',
               'formatter': 'default',
               # The values below are passed to the handler creator callable
               # as keyword arguments.
               'owner': ['pulse', 'pulse'],
               'filename': 'chowntest.log',
               'mode': 'w',
               'encoding': 'utf-8',
           },
       },
       'root': {
           'handlers': ['file'],
           'level': 'DEBUG',
       },
   }

出于演示目的，以下示例设置用户和用户组为 "pulse"。代码置于一个可运行的
脚本文件 "chowntest.py" 中：

   import logging, logging.config, os, shutil

   def owned_file_handler(filename, mode='a', encoding=None, owner=None):
       if owner:
           if not os.path.exists(filename):
               open(filename, 'a').close()
           shutil.chown(filename, *owner)
       return logging.FileHandler(filename, mode, encoding)

   LOGGING = {
       'version': 1,
       'disable_existing_loggers': False,
       'formatters': {
           'default': {
               'format': '%(asctime)s %(levelname)s %(name)s %(message)s'
           },
       },
       'handlers': {
           'file':{
               # The values below are popped from this dictionary and
               # used to create the handler, set the handler's level and
               # its formatter.
               '()': owned_file_handler,
               'level':'DEBUG',
               'formatter': 'default',
               # The values below are passed to the handler creator callable
               # as keyword arguments.
               'owner': ['pulse', 'pulse'],
               'filename': 'chowntest.log',
               'mode': 'w',
               'encoding': 'utf-8',
           },
       },
       'root': {
           'handlers': ['file'],
           'level': 'DEBUG',
       },
   }

   logging.config.dictConfig(LOGGING)
   logger = logging.getLogger('mylogger')
   logger.debug('A debug message')

可能需要 "root" 权限才能运行：

   $ sudo python3.3 chowntest.py
   $ cat chowntest.log
   2013-11-05 09:34:51,128 DEBUG mylogger A debug message
   $ ls -l chowntest.log
   -rw-r--r-- 1 pulse pulse 55 2013-11-05 09:34 chowntest.log

请注意此示例用的是 Python 3.3，因为 "shutil.chown()" 是从此版本开始出
现的。 此方式应当适用于任何支持 "dictConfig()" 的 Python 版本 —— 例如
Python 2.7, 3.2 或更新的版本。 对于 3.3 之前的版本，你应当使用
"os.chown()" 之类的函数来实现实际的所有权修改。

实际应用中，handler 的创建函数可能位于项目的工具模块中。以下配置：

   '()': owned_file_handler,

应使用：

   '()': 'ext://project.util.owned_file_handler',

这里的 "project.util" 可以换成函数所在包的实际名称。 在上述的可用脚本
中，应该可以使用 "'ext://__main__.owned_file_handler'"。 在这里，实际
的可调用对象是由 "dictConfig()" 从 "ext://" 说明中解析出来的。

上述示例还指明了其他的文件修改类型的实现方案 —— 比如同样利用
"os.chmod()" 设置 POSIX 访问权限位。

当然，以上做法也可以扩展到 "FileHandler" 之外的其他类型的 handler ——比
如某个轮换文件 handler，或类型完全不同的其他 handler。


生效于整个应用程序的格式化样式
==============================

在 Python 3.2 中，"Formatter" 增加了一个 "style" 关键字形参，它默认为
"%" 以便向下兼容，但是允许采用 "{" 或 "{TX-PL-LABEL}#x60;" 来支持
"str.format()" 和 "string.Template" 所支持的格式化方式。 请注意此形参
控制着用用于最终输出到日志的日志消息格式，并且与单独日志消息的构造方式
完全无关。

日志函数（"debug()", "info()" 等）只会读取位置参数获取日志信息本身，而
关键字参数仅用于确定日志函数的工作选项（比如关键字参数 "exc_info" 表示
应将跟踪信息记入日志，关键字参数 "extra" 则给出了需加入日志的额外上下
文信息）。所以不能直接使用 "str.format()" 或 "string.Template" 这种语
法进行日志调用，因为日志包在内部使用 %-f 格式来合并格式串和可变参数。
因为尚需保持向下兼容，这一点不会改变，已有代码中的所有日志调用都将采用
%-f 格式串。

有人建议将格式化样式与特定的日志对象进行关联，但其实也会遇到向下兼容的
问题，因为已有代码可能用到了某日志对象并采用了 %-f 格式串。

为了让第三方库和自编代码都能够交互使用日志功能，需要决定在单次日志记录
调用级别采用什么格式。于是就出现了其他几种格式化样式方案。


LogRecord 工厂的用法
--------------------

在 Python 3.2 中，伴随着 "Formatter" 的上述变化，logging 包增加了允许
用户使用 "setLogRecordFactory()" 函数来。设置自己的 "LogRecord" 子类的
功能。 你可以使用此功能来设置自己的 "LogRecord" 子类，它会通过重载
"getMessage()" 方法来完成适当的操作。 "msg % args" 格式化是在此方法的
基类实现中进行的，你可以在那里用你自己的格式化操作来替换；但是，你应当
注意要支持全部的格式化样式并允许将 %-formatting 作为默认样式，以确保与
其他代码进行配合。 还应当注意调用 "str(self.msg)"，正如基类实现所做的
一样。

更多信息请参阅 "setLogRecordFactory()" 和 "LogRecord" 的参考文档。


自定义信息对象的使用
--------------------

另一种方案可能更为简单，可以利用 {}- 和 $- 格式构建自己的日志消息。大
家或许还记得（来自 使用任意对象作为消息），可以用任意对象作为日志信息
的格式串，日志包将调用该对象上 "str()" 获取实际的格式串。看下以下两个
类：

   class BraceMessage:
       def __init__(self, fmt, /, *args, **kwargs):
           self.fmt = fmt
           self.args = args
           self.kwargs = kwargs

       def __str__(self):
           return self.fmt.format(*self.args, **self.kwargs)

   class DollarMessage:
       def __init__(self, fmt, /, **kwargs):
           self.fmt = fmt
           self.kwargs = kwargs

       def __str__(self):
           from string import Template
           return Template(self.fmt).substitute(**self.kwargs)

以上两个类均都可用于替代格式串，以便用 {}- 或 $-formatting 构建实际的“
日志信息”部分，此部分将出现在格式化后的日志输出中，替换 %(message)s 、
“{message}”或“$message”。每次要写入日志时都使用类名，如果觉得使用不便
，可以采用 "M" 或 "_" 之类的别名（如果将 "_" 用于本地化操作，则可用
"__"）。

下面给出示例。 首先用 "str.format()" 进行格式化：

   >>> __ = BraceMessage
   >>> print(__('Message with {0} {1}', 2, 'placeholders'))
   Message with 2 placeholders
   >>> class Point: pass
   ...
   >>> p = Point()
   >>> p.x = 0.5
   >>> p.y = 0.5
   >>> print(__('Message with coordinates: ({point.x:.2f}, {point.y:.2f})', point=p))
   Message with coordinates: (0.50, 0.50)

然后，用 "string.Template" 格式化：

   >>> __ = DollarMessage
   >>> print(__('Message with $num $what', num=2, what='placeholders'))
   Message with 2 placeholders
   >>>

值得注意的是，上述做法对性能并没什么影响：格式化过程其实不是在日志调用
时发生的，而是在日志信息即将由 handler 输出到日志时发生。因此，唯一可
能让人困惑的稍不寻常的地方，就是包裹在格式串和参数外面的括号，而不是格
式串。因为 __ 符号只是对 "XXXMessage" 类的构造函数调用的语法糖。


利用 "dictConfig()" 定义过滤器
==============================

用 "dictConfig()" *可以* 对日志过滤器进行设置，尽管乍一看做法并不明显
（所以才需要本秘籍）。 由于 "Filter" 是标准库中唯一的日志过滤器类，不
太可能满足众多的要求（它只是作为基类存在），通常需要定义自己的
"Filter" 子类，并重写 "filter()" 方法。为此，请在过滤器的配置字典中设
置 "()" 键，指定要用于创建过滤器的可调用对象（最明显可用的就是给出一个
类，但也可以提供任何一个可调用对象，只要能返回 "Filter" 实例即可）。下
面是一个完整的例子：

   import logging
   import logging.config
   import sys

   class MyFilter(logging.Filter):
       def __init__(self, param=None):
           self.param = param

       def filter(self, record):
           if self.param is None:
               allow = True
           else:
               allow = self.param not in record.msg
           if allow:
               record.msg = 'changed: ' + record.msg
           return allow

   LOGGING = {
       'version': 1,
       'filters': {
           'myfilter': {
               '()': MyFilter,
               'param': 'noshow',
           }
       },
       'handlers': {
           'console': {
               'class': 'logging.StreamHandler',
               'filters': ['myfilter']
           }
       },
       'root': {
           'level': 'DEBUG',
           'handlers': ['console']
       },
   }

   if __name__ == '__main__':
       logging.config.dictConfig(LOGGING)
       logging.debug('hello')
       logging.debug('hello - noshow')

以上示例展示了将配置数据传给构造实例的可调用对象，形式是关键字参数。运
行后将会输出：

   changed: hello

这说明过滤器按照配置的参数生效了。

需要额外注意的地方：

* 如果在配置中无法直接引用可调用对象（比如位于不同的模块中，并且不能在
  配置字典所在的位置直接导入），则可以采用 "ext://..." 的形式，正如 访
  问外部对象 所述。例如，在上述示例中可以使用文本
  "'ext://__main__.MyFilter'" 而不是 "MyFilter" 对象。

* 与过滤器一样，上述技术还可用于配置自定义 handler 和格式化对象。有关
  如何在日志配置中使用用户自定义对象的更多信息，请参阅 用户定义对象，
  以及上述 利用 dictConfig() 自定义 handler 的其他指南。


异常信息的自定义格式化
======================

有时可能需要设置自定义的异常信息格式——考虑到会用到参数，假定要让每条日
志事件只占一行，即便存在异常信息也一样。这可以用自定义格式化类来实现，
如下所示：

   import logging

   class OneLineExceptionFormatter(logging.Formatter):
       def formatException(self, exc_info):
           """
           Format an exception so that it prints on a single line.
           """
           result = super().formatException(exc_info)
           return repr(result)  # or format into one line however you want to

       def format(self, record):
           s = super().format(record)
           if record.exc_text:
               s = s.replace('\n', '') + '|'
           return s

   def configure_logging():
       fh = logging.FileHandler('output.txt', 'w')
       f = OneLineExceptionFormatter('%(asctime)s|%(levelname)s|%(message)s|',
                                     '%d/%m/%Y %H:%M:%S')
       fh.setFormatter(f)
       root = logging.getLogger()
       root.setLevel(logging.DEBUG)
       root.addHandler(fh)

   def main():
       configure_logging()
       logging.info('Sample message')
       try:
           x = 1 / 0
       except ZeroDivisionError as e:
           logging.exception('ZeroDivisionError: %s', e)

   if __name__ == '__main__':
       main()

运行后将会生成只有两行信息的文件：

   28/01/2015 07:21:23|INFO|Sample message|
   28/01/2015 07:21:23|ERROR|ZeroDivisionError: integer division or modulo by zero|'Traceback (most recent call last):\n  File "logtest7.py", line 30, in main\n    x = 1 / 0\nZeroDivisionError: integer division or modulo by zero'|

虽然上述处理方式很简单，但也给出了根据喜好对异常信息进行格式化输出的方
案。或许 "traceback" 模块能满足更专门的需求。


语音播报日志信息
================

有时可能需要以声音的形式呈现日志消息。如果系统自带了文本转语音 （TTS）
功能，即便没与 Python 关联也很容易做到。大多数 TTS 系统都有一个可运行
的命令行程序，在 handler 中可以用 "subprocess" 进行调用。这里假定 TTS
命令行程序不会与用户交互，或需要很长时间才会执行完毕，写入日志的信息也
不会多到影响用户查看，并且可以接受每次播报一条信息，以下示例实现了等一
条信息播完再处理下一条，可能会导致其他 handler 的等待。这个简短示例仅
供演示，假定 "espeak" TTS 包已就绪：

   import logging
   import subprocess
   import sys

   class TTSHandler(logging.Handler):
       def emit(self, record):
           msg = self.format(record)
           # Speak slowly in a female English voice
           cmd = ['espeak', '-s150', '-ven+f3', msg]
           p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                                stderr=subprocess.STDOUT)
           # wait for the program to finish
           p.communicate()

   def configure_logging():
       h = TTSHandler()
       root = logging.getLogger()
       root.addHandler(h)
       # the default formatter just returns the message
       root.setLevel(logging.DEBUG)

   def main():
       logging.info('Hello')
       logging.debug('Goodbye')

   if __name__ == '__main__':
       configure_logging()
       sys.exit(main())

运行后将会以女声播报“Hello”和“Goodbye”。

当然，上述方案也适用于其他 TTS 系统，甚至可以通过利用命令行运行的外部
程序来处理消息。


缓冲日志消息并有条件地输出它们
==============================

在某些情况下，你可能希望在临时区域中记录日志消息，并且只在发生某种特定
的情况下才输出它们。 例如，你可能希望起始在函数中记录调试事件，如果函
数执行完成且没有错误，你不希望输出收集的调试信息以避免造成日志混乱，但
如果出现错误，那么你希望所有调试以及错误消息被输出。

下面是一个示例，展示如何在你的日志记录函数上使用装饰器以实现这一功能。
该示例使用 "logging.handlers.MemoryHandler" ，它允许缓冲已记录的事件直
到某些条件发生，缓冲的事件才会被刷新（"flushed"） - 传递给另一个处理程
序（ "target" handler）进行处理。 默认情况下， "MemoryHandler" 在其缓
冲区被填满时被刷新，或者看到一个级别大于或等于指定阈值的事件。 如果想
要自定义刷新行为，你可以通过更专业的 "MemoryHandler" 子类来使用这个秘
诀。

这个示例脚本有一个简单的函数 "foo" ，它只是在所有的日志级别中循环运行
，写到 "sys.stderr" ，说明它要记录在哪个级别上，然后在这个级别上实际记
录一个消息。你可以给 "foo" 传递一个参数，如果为 true ，它将在ERROR和
CRITICAL级别记录，否则，它只在DEBUG、INFO和WARNING级别记录。

脚本只是使用了一个装饰器来装饰 "foo"，这个装饰器将记录执行所需的条件。
装饰器使用一个记录器作为参数，并在调用被装饰的函数期间附加一个内存处理
程序。装饰器可以使用目标处理程序、记录级别和缓冲区的容量（缓冲记录的数
量）来附加参数。这些参数分别默认为写入``sys.stderr`` 的
"StreamHandler" ， "logging.ERROR" 和 "100"。

以下是脚本：

   import logging
   from logging.handlers import MemoryHandler
   import sys

   logger = logging.getLogger(__name__)
   logger.addHandler(logging.NullHandler())

   def log_if_errors(logger, target_handler=None, flush_level=None, capacity=None):
       if target_handler is None:
           target_handler = logging.StreamHandler()
       if flush_level is None:
           flush_level = logging.ERROR
       if capacity is None:
           capacity = 100
       handler = MemoryHandler(capacity, flushLevel=flush_level, target=target_handler)

       def decorator(fn):
           def wrapper(*args, **kwargs):
               logger.addHandler(handler)
               try:
                   return fn(*args, **kwargs)
               except Exception:
                   logger.exception('call failed')
                   raise
               finally:
                   super(MemoryHandler, handler).flush()
                   logger.removeHandler(handler)
           return wrapper

       return decorator

   def write_line(s):
       sys.stderr.write('%s\n' % s)

   def foo(fail=False):
       write_line('about to log at DEBUG ...')
       logger.debug('Actually logged at DEBUG')
       write_line('about to log at INFO ...')
       logger.info('Actually logged at INFO')
       write_line('about to log at WARNING ...')
       logger.warning('Actually logged at WARNING')
       if fail:
           write_line('about to log at ERROR ...')
           logger.error('Actually logged at ERROR')
           write_line('about to log at CRITICAL ...')
           logger.critical('Actually logged at CRITICAL')
       return fail

   decorated_foo = log_if_errors(logger)(foo)

   if __name__ == '__main__':
       logger.setLevel(logging.DEBUG)
       write_line('Calling undecorated foo with False')
       assert not foo(False)
       write_line('Calling undecorated foo with True')
       assert foo(True)
       write_line('Calling decorated foo with False')
       assert not decorated_foo(False)
       write_line('Calling decorated foo with True')
       assert decorated_foo(True)

运行此脚本时，应看到以下输出：

   Calling undecorated foo with False
   about to log at DEBUG ...
   about to log at INFO ...
   about to log at WARNING ...
   Calling undecorated foo with True
   about to log at DEBUG ...
   about to log at INFO ...
   about to log at WARNING ...
   about to log at ERROR ...
   about to log at CRITICAL ...
   Calling decorated foo with False
   about to log at DEBUG ...
   about to log at INFO ...
   about to log at WARNING ...
   Calling decorated foo with True
   about to log at DEBUG ...
   about to log at INFO ...
   about to log at WARNING ...
   about to log at ERROR ...
   Actually logged at DEBUG
   Actually logged at INFO
   Actually logged at WARNING
   Actually logged at ERROR
   about to log at CRITICAL ...
   Actually logged at CRITICAL

如你所见，实际日志记录输出仅在消息等级为ERROR或更高的事件时发生，但在
这种情况下，任何之前较低消息等级的事件还会被记录。

你当然可以使用传统的装饰方法:

   @log_if_errors(logger)
   def foo(fail=False):
       ...


通过配置使用UTC (GMT) 格式化时间
================================

有时候，你希望使用UTC来格式化时间，这可以通过使用一个类来实现，例如
`UTCFormatter`，如下所示：

   import logging
   import time

   class UTCFormatter(logging.Formatter):
       converter = time.gmtime

然后你可以在你的代码中使用 "UTCFormatter"，而不是 "Formatter"。 如果你
想通过配置来实现这一功能，你可以使用 "dictConfig()" API 来完成，该方法
在以下完整示例中展示:

   import logging
   import logging.config
   import time

   class UTCFormatter(logging.Formatter):
       converter = time.gmtime

   LOGGING = {
       'version': 1,
       'disable_existing_loggers': False,
       'formatters': {
           'utc': {
               '()': UTCFormatter,
               'format': '%(asctime)s %(message)s',
           },
           'local': {
               'format': '%(asctime)s %(message)s',
           }
       },
       'handlers': {
           'console1': {
               'class': 'logging.StreamHandler',
               'formatter': 'utc',
           },
           'console2': {
               'class': 'logging.StreamHandler',
               'formatter': 'local',
           },
       },
       'root': {
           'handlers': ['console1', 'console2'],
      }
   }

   if __name__ == '__main__':
       logging.config.dictConfig(LOGGING)
       logging.warning('The local time is %s', time.asctime())

脚本会运行输出类似下面的内容:

   2015-10-17 12:53:29,501 The local time is Sat Oct 17 13:53:29 2015
   2015-10-17 13:53:29,501 The local time is Sat Oct 17 13:53:29 2015

展示了如何将时间格式化为本地时间和UTC两种形式，其中每种形式对应一个日
志处理器 。


使用上下文管理器的可选的日志记录
================================

有时候，我们需要暂时更改日志配置，并在执行某些操作后将其还原。为此，上
下文管理器是实现保存和恢复日志上下文的最明显的方式。这是一个关于上下文
管理器的简单例子，它允许你在上下文管理器的作用域内更改日志记录等级以及
增加日志处理器：

   import logging
   import sys

   class LoggingContext:
       def __init__(self, logger, level=None, handler=None, close=True):
           self.logger = logger
           self.level = level
           self.handler = handler
           self.close = close

       def __enter__(self):
           if self.level is not None:
               self.old_level = self.logger.level
               self.logger.setLevel(self.level)
           if self.handler:
               self.logger.addHandler(self.handler)

       def __exit__(self, et, ev, tb):
           if self.level is not None:
               self.logger.setLevel(self.old_level)
           if self.handler:
               self.logger.removeHandler(self.handler)
           if self.handler and self.close:
               self.handler.close()
           # implicit return of None => don't swallow exceptions

如果指定上下文管理器的日志记录等级属性，则在上下文管理器的with语句所涵
盖的代码中，日志记录器的记录等级将临时设置为上下文管理器所配置的日志记
录等级。 如果指定上下文管理的日志处理器属性，则该句柄在进入上下文管理
器的上下文时添加到记录器中，并在退出时被删除。 如果你再也不需要该日志
处理器时，你可以让上下文管理器在退出上下文管理器的上下文时关闭它。

为了说明它是如何工作的，我们可以在上面添加以下代码块:

   if __name__ == '__main__':
       logger = logging.getLogger('foo')
       logger.addHandler(logging.StreamHandler())
       logger.setLevel(logging.INFO)
       logger.info('1. This should appear just once on stderr.')
       logger.debug('2. This should not appear.')
       with LoggingContext(logger, level=logging.DEBUG):
           logger.debug('3. This should appear once on stderr.')
       logger.debug('4. This should not appear.')
       h = logging.StreamHandler(sys.stdout)
       with LoggingContext(logger, level=logging.DEBUG, handler=h, close=True):
           logger.debug('5. This should appear twice - once on stderr and once on stdout.')
       logger.info('6. This should appear just once on stderr.')
       logger.debug('7. This should not appear.')

我们最初设置日志记录器的消息等级为 "INFO"，因此消息#1出现，消息#2没有
出现。在接下来的 "with``代码块中我们暂时将消息等级变更为 ``DEBUG"，从
而消息 #3 出现。在这一代码块退出后，日志记录器的消息等级恢复为 "INFO"
，从而消息 #4 没有出现。在下一个 "with" 代码块中，我们再一次将设置消息
等级设置为 "DEBUG"，同时添加一个将消息写入 "sys.stdout" 的日志处理器。
因此，消息#5在控制台出现两次 (分别通过 "stderr" 和 "stdout")。在
"with" 语句完成后，状态与之前一样，因此消息 #6 出现（类似消息 #1），而
消息 #7 没有出现（类似消息 #2）。

如果我们运行生成的脚本，结果如下：

   $ python logctx.py
   1. This should appear just once on stderr.
   3. This should appear once on stderr.
   5. This should appear twice - once on stderr and once on stdout.
   5. This should appear twice - once on stderr and once on stdout.
   6. This should appear just once on stderr.

我们将``stderr``标准错误重定向到``/dev/null``，我再次运行生成的脚步，
唯一被写入``stdout``标准输出的消息，即我们所能看见的消息，如下：

   $ python logctx.py 2>/dev/null
   5. This should appear twice - once on stderr and once on stdout.

再一次，将 "stdout" 标准输出重定向到 "/dev/null"，我获得如下结果：

   $ python logctx.py >/dev/null
   1. This should appear just once on stderr.
   3. This should appear once on stderr.
   5. This should appear twice - once on stderr and once on stdout.
   6. This should appear just once on stderr.

在这种情况下，与预期一致，打印到 "stdout" 标准输出的消息＃5不会出现。

当然，这里描述的方法可以被推广，例如临时附加日志记录过滤器。 请注意，
上面的代码适用于Python 2以及Python 3。


命令行日志应用起步
==================

下面的示例提供了如下功能：

* 根据命令行参数确定日志级别

* 在单独的文件中分发多条子命令，同一级别的子命令均以一致的方式记录。

* 最简单的配置用法

假定有一个命令行应用程序，用于停止、启动或重新启动某些服务。为了便于演
示，不妨将 "app.py" 作为应用程序的主代码文件，并在  "start.py"、
"stop.py``和 ``restart.py" 中实现单独的命令。再假定要通过命令行参数控
制应用程序的日志粒度，默认为 "logging.INFO" 。以下是 "app.py" 的一个示
例：

   import argparse
   import importlib
   import logging
   import os
   import sys

   def main(args=None):
       scriptname = os.path.basename(__file__)
       parser = argparse.ArgumentParser(scriptname)
       levels = ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL')
       parser.add_argument('--log-level', default='INFO', choices=levels)
       subparsers = parser.add_subparsers(dest='command',
                                          help='Available commands:')
       start_cmd = subparsers.add_parser('start', help='Start a service')
       start_cmd.add_argument('name', metavar='NAME',
                              help='Name of service to start')
       stop_cmd = subparsers.add_parser('stop',
                                        help='Stop one or more services')
       stop_cmd.add_argument('names', metavar='NAME', nargs='+',
                             help='Name of service to stop')
       restart_cmd = subparsers.add_parser('restart',
                                           help='Restart one or more services')
       restart_cmd.add_argument('names', metavar='NAME', nargs='+',
                                help='Name of service to restart')
       options = parser.parse_args()
       # the code to dispatch commands could all be in this file. For the purposes
       # of illustration only, we implement each command in a separate module.
       try:
           mod = importlib.import_module(options.command)
           cmd = getattr(mod, 'command')
       except (ImportError, AttributeError):
           print('Unable to find the code for command \'%s\'' % options.command)
           return 1
       # Could get fancy here and load configuration from file or dictionary
       logging.basicConfig(level=options.log_level,
                           format='%(levelname)s %(name)s %(message)s')
       cmd(options)

   if __name__ == '__main__':
       sys.exit(main())

"start"、"stop" 和 "restart" 命令可以在单独的模块中实现，启动命令的代
码可如下：

   # start.py
   import logging

   logger = logging.getLogger(__name__)

   def command(options):
       logger.debug('About to start %s', options.name)
       # actually do the command processing here ...
       logger.info('Started the \'%s\' service.', options.name)

然后是停止命令的代码：

   # stop.py
   import logging

   logger = logging.getLogger(__name__)

   def command(options):
       n = len(options.names)
       if n == 1:
           plural = ''
           services = '\'%s\'' % options.names[0]
       else:
           plural = 's'
           services = ', '.join('\'%s\'' % name for name in options.names)
           i = services.rfind(', ')
           services = services[:i] + ' and ' + services[i + 2:]
       logger.debug('About to stop %s', services)
       # actually do the command processing here ...
       logger.info('Stopped the %s service%s.', services, plural)

重启命令类似：

   # restart.py
   import logging

   logger = logging.getLogger(__name__)

   def command(options):
       n = len(options.names)
       if n == 1:
           plural = ''
           services = '\'%s\'' % options.names[0]
       else:
           plural = 's'
           services = ', '.join('\'%s\'' % name for name in options.names)
           i = services.rfind(', ')
           services = services[:i] + ' and ' + services[i + 2:]
       logger.debug('About to restart %s', services)
       # actually do the command processing here ...
       logger.info('Restarted the %s service%s.', services, plural)

如果以默认日志级别运行该程序，会得到以下结果：

   $ python app.py start foo
   INFO start Started the 'foo' service.

   $ python app.py stop foo bar
   INFO stop Stopped the 'foo' and 'bar' services.

   $ python app.py restart foo bar baz
   INFO restart Restarted the 'foo', 'bar' and 'baz' services.

第一个单词是日志级别，第二个单词是日志事件所在的模块或包的名称。

如果修改了日志级别，发送给日志的信息就能得以改变。如要显示更多信息，则
可：

   $ python app.py --log-level DEBUG start foo
   DEBUG start About to start foo
   INFO start Started the 'foo' service.

   $ python app.py --log-level DEBUG stop foo bar
   DEBUG stop About to stop 'foo' and 'bar'
   INFO stop Stopped the 'foo' and 'bar' services.

   $ python app.py --log-level DEBUG restart foo bar baz
   DEBUG restart About to restart 'foo', 'bar' and 'baz'
   INFO restart Restarted the 'foo', 'bar' and 'baz' services.

若要显示的信息少一些，则：

   $ python app.py --log-level WARNING start foo
   $ python app.py --log-level WARNING stop foo bar
   $ python app.py --log-level WARNING restart foo bar baz

这里的命令不会向控制台输出任何信息，因为没有记录 "WARNING" 以上级别的
日志。


Qt GUI 日志示例
===============

GUI 应用程序如何记录日志，这是个常见的问题。 Qt 框架是一个流行的跨平台
UI 框架，采用的是 PySide2 或 PyQt5 库。

下面的例子演示了将日志写入 Qt GUI 程序的过程。这里引入了一个简单的
"QtHandler" 类，参数是一个可调用对象，其应为嵌入主线程某个“槽位”中运行
的，因为GUI 的更新由主线程完成。这里还创建了一个工作线程，以便演示由
UI（通过人工点击日志按钮）和后台工作线程（此处只是记录级别和时间间隔均
随机生成的日志信息）将日志写入 GUI 的过程。

该工作线程是用 Qt 的 "QThread" 类实现的，而不是 "threading" 模块，因为
某些情况下只能采用 "`QThread"，它与其他 "Qt" 组件的集成性更好一些。

以下代码应能适用于最新版的 "PySide2" 或 "PyQt5"。对于低版本的 Qt 应该
也能适用。更多详情，请参阅代码注释。

   import datetime
   import logging
   import random
   import sys
   import time

   # Deal with minor differences between PySide2 and PyQt5
   try:
       from PySide2 import QtCore, QtGui, QtWidgets
       Signal = QtCore.Signal
       Slot = QtCore.Slot
   except ImportError:
       from PyQt5 import QtCore, QtGui, QtWidgets
       Signal = QtCore.pyqtSignal
       Slot = QtCore.pyqtSlot


   logger = logging.getLogger(__name__)


   #
   # Signals need to be contained in a QObject or subclass in order to be correctly
   # initialized.
   #
   class Signaller(QtCore.QObject):
       signal = Signal(str, logging.LogRecord)

   #
   # Output to a Qt GUI is only supposed to happen on the main thread. So, this
   # handler is designed to take a slot function which is set up to run in the main
   # thread. In this example, the function takes a string argument which is a
   # formatted log message, and the log record which generated it. The formatted
   # string is just a convenience - you could format a string for output any way
   # you like in the slot function itself.
   #
   # You specify the slot function to do whatever GUI updates you want. The handler
   # doesn't know or care about specific UI elements.
   #
   class QtHandler(logging.Handler):
       def __init__(self, slotfunc, *args, **kwargs):
           super().__init__(*args, **kwargs)
           self.signaller = Signaller()
           self.signaller.signal.connect(slotfunc)

       def emit(self, record):
           s = self.format(record)
           self.signaller.signal.emit(s, record)

   #
   # This example uses QThreads, which means that the threads at the Python level
   # are named something like "Dummy-1". The function below gets the Qt name of the
   # current thread.
   #
   def ctname():
       return QtCore.QThread.currentThread().objectName()


   #
   # Used to generate random levels for logging.
   #
   LEVELS = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR,
             logging.CRITICAL)

   #
   # This worker class represents work that is done in a thread separate to the
   # main thread. The way the thread is kicked off to do work is via a button press
   # that connects to a slot in the worker.
   #
   # Because the default threadName value in the LogRecord isn't much use, we add
   # a qThreadName which contains the QThread name as computed above, and pass that
   # value in an "extra" dictionary which is used to update the LogRecord with the
   # QThread name.
   #
   # This example worker just outputs messages sequentially, interspersed with
   # random delays of the order of a few seconds.
   #
   class Worker(QtCore.QObject):
       @Slot()
       def start(self):
           extra = {'qThreadName': ctname() }
           logger.debug('Started work', extra=extra)
           i = 1
           # Let the thread run until interrupted. This allows reasonably clean
           # thread termination.
           while not QtCore.QThread.currentThread().isInterruptionRequested():
               delay = 0.5 + random.random() * 2
               time.sleep(delay)
               level = random.choice(LEVELS)
               logger.log(level, 'Message after delay of %3.1f: %d', delay, i, extra=extra)
               i += 1

   #
   # Implement a simple UI for this cookbook example. This contains:
   #
   # * A read-only text edit window which holds formatted log messages
   # * A button to start work and log stuff in a separate thread
   # * A button to log something from the main thread
   # * A button to clear the log window
   #
   class Window(QtWidgets.QWidget):

       COLORS = {
           logging.DEBUG: 'black',
           logging.INFO: 'blue',
           logging.WARNING: 'orange',
           logging.ERROR: 'red',
           logging.CRITICAL: 'purple',
       }

       def __init__(self, app):
           super().__init__()
           self.app = app
           self.textedit = te = QtWidgets.QPlainTextEdit(self)
           # Set whatever the default monospace font is for the platform
           f = QtGui.QFont('nosuchfont')
           f.setStyleHint(f.Monospace)
           te.setFont(f)
           te.setReadOnly(True)
           PB = QtWidgets.QPushButton
           self.work_button = PB('Start background work', self)
           self.log_button = PB('Log a message at a random level', self)
           self.clear_button = PB('Clear log window', self)
           self.handler = h = QtHandler(self.update_status)
           # Remember to use qThreadName rather than threadName in the format string.
           fs = '%(asctime)s %(qThreadName)-12s %(levelname)-8s %(message)s'
           formatter = logging.Formatter(fs)
           h.setFormatter(formatter)
           logger.addHandler(h)
           # Set up to terminate the QThread when we exit
           app.aboutToQuit.connect(self.force_quit)

           # Lay out all the widgets
           layout = QtWidgets.QVBoxLayout(self)
           layout.addWidget(te)
           layout.addWidget(self.work_button)
           layout.addWidget(self.log_button)
           layout.addWidget(self.clear_button)
           self.setFixedSize(900, 400)

           # Connect the non-worker slots and signals
           self.log_button.clicked.connect(self.manual_update)
           self.clear_button.clicked.connect(self.clear_display)

           # Start a new worker thread and connect the slots for the worker
           self.start_thread()
           self.work_button.clicked.connect(self.worker.start)
           # Once started, the button should be disabled
           self.work_button.clicked.connect(lambda : self.work_button.setEnabled(False))

       def start_thread(self):
           self.worker = Worker()
           self.worker_thread = QtCore.QThread()
           self.worker.setObjectName('Worker')
           self.worker_thread.setObjectName('WorkerThread')  # for qThreadName
           self.worker.moveToThread(self.worker_thread)
           # This will start an event loop in the worker thread
           self.worker_thread.start()

       def kill_thread(self):
           # Just tell the worker to stop, then tell it to quit and wait for that
           # to happen
           self.worker_thread.requestInterruption()
           if self.worker_thread.isRunning():
               self.worker_thread.quit()
               self.worker_thread.wait()
           else:
               print('worker has already exited.')

       def force_quit(self):
           # For use when the window is closed
           if self.worker_thread.isRunning():
               self.kill_thread()

       # The functions below update the UI and run in the main thread because
       # that's where the slots are set up

       @Slot(str, logging.LogRecord)
       def update_status(self, status, record):
           color = self.COLORS.get(record.levelno, 'black')
           s = '<pre><font color="%s">%s</font></pre>' % (color, status)
           self.textedit.appendHtml(s)

       @Slot()
       def manual_update(self):
           # This function uses the formatted message passed in, but also uses
           # information from the record to format the message in an appropriate
           # color according to its severity (level).
           level = random.choice(LEVELS)
           extra = {'qThreadName': ctname() }
           logger.log(level, 'Manually logged!', extra=extra)

       @Slot()
       def clear_display(self):
           self.textedit.clear()


   def main():
       QtCore.QThread.currentThread().setObjectName('MainThread')
       logging.getLogger().setLevel(logging.DEBUG)
       app = QtWidgets.QApplication(sys.argv)
       example = Window(app)
       example.show()
       sys.exit(app.exec_())

   if __name__=='__main__':
       main()
