Python的logging模块详解之二基本类

Python的logging模块中的类与Java中的Logging接口几乎如出一辙。具体如下：

1. Logger类

1) 功能

• 暴露接口供直接调用
• 根据日志级别或Filter确定输出的日志消息
• 将符合输出的日志消息交给所有订阅的Handler

2) 实例化

不能直接实例化Logger类。
要实例化Logger，必须通过如下方法：

Logger logger = logging.getLogger(__name__)

实例化时，传入的参数name如果无效（如None,'',False），则默认使用root，即RootLogger(WARNING)

3) 配置方法

• Logger.setLevel()
• Logger.addFilter(),Logger.removeFilter()
• Logger.addHandler(),Logger.removeHandler()

4) 消息方法

• Logger.debug()
• Logger.log()，与Logger.debug()类似，但还可以设置定制日志级别lvl=MYLEVEL
• Logger.info()
• Logger.warning()
• Logger.error()
• Logger.exception()，与Logger.error()类似，但还包含错误栈，往往在处理异常的Handler类中调用。
• Logger.critical()

2. Handler类

用以设置日志记录输出的目的地。Logger类默认没有设置任何输出目的地。但是可以通过logging.basicConfig(...)方法为Logger类设置0..*个Handlers，以输出日志到文件或控制台。

1) logging.basicConfig(...)方法的参数（仅与Handler相关的参数）：

• filename,filemode，创建FileHandler，如磁盘文件
• stream，创建StreamHandler，如文件流对象
• handlers，创建多个Handlers

2) 实例化

不是直接实例化Handler类，而是实例化其子类。具体的Handler子类，可以参考Handler子类。

• fh = logging.FileHandler('spam.log')
• ch = logging.StreamHandler()

3) 配置方法

• Handler.setLevel()
• Handler.addFilter(),Handler.removeFilter()
• Handler.setFormatter()

3. Filter类

设置只输出符合过滤条件的日志记录，供Logger类和Handler类使用。
Logger类默认过滤具有相同前缀的所有日志记录。
Logger只有在处理日志记录时即时检查Filter，所以继承Logger不会检查Filter。
Handler首先注册Filter，然后在处理后续日志记录时检查。

首先定义logging.Filter的扩展类，并在其中实现def filter(self, record)方法。然后创建定制Filter类的实例，并通过addFilter()方法附加到Logger和Handler。

4. Formatter类

设置日志记录的输出格式。

• 默认的日志消息格式'%(message)s'，即severity:logger name:message
• 默认日期时间格式%Y-%m-%d %H:%M:%S

可以通过logging.basicConfig(format='...')设置日志输出格式。
也可以直接实例化Formatter类如下，然后再通过setFormatter()方法附加到Handler。

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

5. LogRecord类

Logger对象每次输出一条日志时创建一个LogRecord对象。

6. LoggerAdapter类

可以方便地将上下文信息输出到日志中。

参考链接：

https://docs.python.org/3.5/library/logging.html

https://docs.python.org/3.5/howto/logging.html

https://github.com/python/cpython/blob/3.5/Lib/logging/__init__.py