16.6. 模块 logging — Python 的日志记录工具

源代码: Lib/logging/__init__.py

Important

此页面仅包含API参考信息。有关更多高级主题的教程信息和讨论，请参阅

• 基础教程
• 进阶教程
• Logging Cookbook

---

这个模块为应用与库定义了实现灵活的事件日志系统的函数与类.

使用标准库提提供的 logging API 最主要的好处是，所有的 Python 模块都可能参与日志输出，包括你的日志消息和第三方模块的日志消息。

这个模块提供许多强大而灵活的功能。如果你对 logging 不太熟悉的话， 掌握它最好的方式就是查看它对应的教程（详见右侧的链接）。

该模块定义的基础类和函数都列在下面。

• 记录器暴露了应用程序代码直接使用的接口。
• 处理程序将日志记录（由记录器创建）发送到适当的目标。
• 过滤器提供了更精细的附加功能，用于确定要输出的日志记录。
• 格式化程序指定最终输出中日志记录的样式。

16.6.1. Logger 对象

Loggers have the following attributes and methods. Note that Loggers are never instantiated directly, but always through the module-level function logging.getLogger(name). Multiple calls to getLogger() with the same name will always return a reference to the same Logger object.

name 是潜在的周期分割层级值, 像``foo.bar.baz`` (例如, 抛出的可以只是明文的``foo``)。Loggers是进一步在子层次列表的更高loggers列表。例如，有个名叫``foo``的logger，名叫``foo.bar``，foo.bar.baz, 和 foo.bam 都是 foo``的衍生logger. logger的名字分级类似Python 包的层级, 并且相同的如果你组织你的loggers在每模块级别基本上使用推荐的结构``logging.getLogger(__name__)。这是因为在模块里，在Python包的命名空间的模块名为``__name__``。

class logging.Logger

Logger.propagate

If this evaluates to true, events logged to this logger will be passed to the handlers of higher level (ancestor) loggers, in addition to any handlers attached to this logger. Messages are passed directly to the ancestor loggers』 handlers - neither the level nor filters of the ancestor loggers in question are considered.

如果等于假，记录消息将不会传递给这个原型记录器的管理器。

构造器将这个属性初始化为 True。

備註

如果你关联了一个管理器*并且*到它自己的一个或多个记录器，它可能发出多次相同的记录。总体来说，你不需要关联管理器到一个或多个记录器 - 如果你只是关联它到一个合适的记录器等级中的最高级别记录器，它将会看到子记录器所有记录的事件，他们的传播剩下的设置为``True``。一个通用场景是只关联管理器到根记录器，并且让传播照顾剩下的.

Logger.setLevel(lvl)

Sets the threshold for this logger to lvl. Logging messages which are less severe than lvl will be ignored. When a logger is created, the level is set to NOTSET (which causes all messages to be processed when the logger is the root logger, or delegation to the parent when the logger is a non-root logger). Note that the root logger is created with level WARNING.

委派给父级的意思是如果一个记录器的级别设置为NOTSET，遍历其祖先记录器链，直到找到另一个NOTSET级别的祖先或到达根为止。

如果发现某个父级的级别 不是NOTSET ，那么该父级的级别将被视为发起搜索的记录器的有效级别，并用于确定如何处理日志事件。

如果到达根 logger ，并且其级别为NOTSET，则将处理所有消息。否则，将使用根记录器的级别作为有效级别。

参见 日志级别 级别列表。

3.2 版更變: The lvl parameter now accepts a string representation of the level such as 『INFO』 as an alternative to the integer constants such as INFO. Note, however, that levels are internally stored as integers, and methods such as e.g. getEffectiveLevel() and isEnabledFor() will return/expect to be passed integers.

Logger.isEnabledFor(lvl)

Indicates if a message of severity lvl would be processed by this logger. This method checks first the module-level level set by logging.disable(lvl) and then the logger’s effective level as determined by getEffectiveLevel().

Logger.getEffectiveLevel()

指示此记录器的有效级别。如果通过 setLevel() 设置了除 NOTSET 以外的值，则返回该值。否则，将层次结构遍历到根，直到找到除 NOTSET 以外的其他值，然后返回该值。返回的值是一个整数，通常为 logging.DEBUG、 logging.INFO 等等。

Logger.getChild(suffix)

返回由后缀确定的，是该记录器的后代的记录器。 因此，logging.getLogger('abc').getChild('def.ghi') 与 logging.getLogger('abc.def.ghi') 将返回相同的记录器。 这是一个便捷方法，当使用如 __name__ 而不是字符串字面值命名父记录器时很有用。

3.2 版新加入.

Logger.debug(msg, *args, **kwargs)

Logs a message with level DEBUG on this logger. The msg is the message format string, and the args are the arguments which are merged into msg using the string formatting operator. (Note that this means that you can use keywords in the format string, together with a single dictionary argument.)

There are three keyword arguments in kwargs which are inspected: exc_info, stack_info, and extra.

如果 exc_info 的求值结果不为 false，则它将异常信息添加到日志消息中。如果提供了一个异常元组（按照 sys.exc_info() 返回的格式）或一个异常实例，则将其使用；否则，调用 sys.exc_info() 以获取异常信息。

第二个可选关键字参数是 stack_info，默认为 False。如果为 True，则将堆栈信息添加到日志消息中，包括实际的日志调用。请注意，这与通过指定 exc_info 显示的堆栈信息不同：前者是从堆栈底部到当前线程中的日志记录调用的堆栈帧，而后者是在搜索异常处理程序时，跟踪异常而打开的堆栈帧的信息。

You can specify stack_info independently of exc_info, e.g. to just show how you got to a certain point in your code, even when no exceptions were raised. The stack frames are printed following a header line which says:

Stack (most recent call last):

这模仿了显示异常帧时所使用的 Traceback (most recent call last): 。

The third keyword argument is extra which can be used to pass a dictionary which is used to populate the __dict__ of the LogRecord created for the logging event with user-defined attributes. These custom attributes can then be used as you like. For example, they could be incorporated into logged messages. For example:

FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logger = logging.getLogger('tcpserver')
logger.warning('Protocol problem: %s', 'connection reset', extra=d)

would print something like

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

The keys in the dictionary passed in extra should not clash with the keys used by the logging system. (See the Formatter documentation for more information on which keys are used by the logging system.)

如果你选择在已记录的消息中使用这些属性，则需要格外小心。 例如在上面的示例中，Formatter 已设置了格式字符串，其在 LogRecord 的属性字典中应有 『clientip』 和 『user』。 如果缺少这些属性，消息将不被记录，因为会引发字符串格式化异常，你始终需要传入带有这些键的 extra 字典。

尽管这可能很烦人，但此功能旨在用于特殊情况，例如在多个上下文中执行相同代码的多线程服务器，并且出现的有趣条件取决于此上下文（例如在上面的示例中就是远程客户端IP地址和已验证用户名）。在这种情况下，很可能将专门的 Formatter 与特定的 Handler 一起使用。

3.2 版新加入: 增加了 stack_info 参数。

3.5 版更變: The exc_info parameter can now accept exception instances.

Logger.info(msg, *args, **kwargs)

在此记录器上记录 INFO 级别的消息。参数解释同 debug()。

Logger.warning(msg, *args, **kwargs)

在此记录器上记录 WARNING 级别的消息。参数解释同 debug()。

備註

有一个功能上与 warning 一致的方法 warn。由于 warn 已被弃用，请不要使用它 —— 改为使用 warning。

Logger.error(msg, *args, **kwargs)

在此记录器上记录 ERROR 级别的消息。参数解释同 debug()。

Logger.critical(msg, *args, **kwargs)

在此记录器上记录 CRITICAL 级别的消息。参数解释同 debug()。

Logger.log(lvl, msg, *args, **kwargs)

Logs a message with integer level lvl on this logger. The other arguments are interpreted as for debug().

Logger.exception(msg, *args, **kwargs)

在此记录器上记录 ERROR 级别的消息。参数解释同 debug()。异常信息将添加到日志消息中。仅应从异常处理程序中调用此方法。

Logger.addFilter(filt)

Adds the specified filter filt to this logger.

Logger.removeFilter(filt)

Removes the specified filter filt from this logger.

Logger.filter(record)

Applies this logger’s filters to the record and returns a true value if the record is to be processed. The filters are consulted in turn, until one of them returns a false value. If none of them return a false value, the record will be processed (passed to handlers). If one returns a false value, no further processing of the record occurs.

Logger.addHandler(hdlr)

将指定的处理程序 hdlr 添加到此记录器。

Logger.removeHandler(hdlr)

从此记录器中删除指定的处理器 hdlr。

Logger.findCaller(stack_info=False)

查找调用源的文件名和行号，以 文件名，行号，函数名称和堆栈信息 4元素元组的形式返回。堆栈信息将返回 None``除非 *stack_info* 为 ``True。

Logger.handle(record)

通过将记录传递给与此记录器及其祖先关联的所有处理器来处理（直到某个 propagate 值为 false）。此方法用于从套接字接收的未序列化的以及在本地创建的记录。使用 filter() 进行记录程序级别过滤。

Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)

这是一种工厂方法，可以在子类中对其进行重写以创建专门的 LogRecord 实例。

Logger.hasHandlers()

检查此记录器是否配置了任何处理器。通过在此记录器及其记录器层次结构中的父级中查找处理器完成此操作。如果找到处理器则返回 True，否则返回``False``。只要找到 “propagate” 属性设置为 false的记录器，该方法就会停止搜索层次结构 —— 其将是最后一个检查处理器是否存在的记录器。

3.2 版新加入.

16.6.2. 日志级别

日志记录级别的数值在下表中给出。如果你想要定义自己的级别，并且需要它们具有相对于预定义级别的特定值，那么这些内容可能是你感兴趣的。如果你定义具有相同数值的级别，它将覆盖预定义的值; 预定义的名称丢失。

级别	数值
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
NOTSET	0

16.6.3. 处理器对象

Handler 有以下属性和方法。注意不要直接实例化 Handler ；这个类用来派生其他更有用的子类。但是，子类的 __init__() 方法需要调用 Handler.__init__() 。

Handler.__init__(level=NOTSET)

初始化 Handler 实例时，需要设置它的级别，将过滤列表置为空，并且创建锁（通过 createLock() ）来序列化对 I/O 的访问。

Handler.createLock()

初始化一个线程锁，用来序列化对底层的 I/O 功能的访问，底层的 I/O 功能可能不是线程安全的。

Handler.acquire()

使用 createLock() 获取线程锁。

Handler.release()

使用 acquire() 来释放线程锁。

Handler.setLevel(lvl)

Sets the threshold for this handler to lvl. Logging messages which are less severe than lvl will be ignored. When a handler is created, the level is set to NOTSET (which causes all messages to be processed).

参见 日志级别 级别列表。

3.2 版更變: The lvl parameter now accepts a string representation of the level such as 『INFO』 as an alternative to the integer constants such as INFO.

Handler.setFormatter(form)

Sets the Formatter for this handler to form.

Handler.addFilter(filt)

Adds the specified filter filt to this handler.

Handler.removeFilter(filt)

Removes the specified filter filt from this handler.

Handler.filter(record)

Applies this handler’s filters to the record and returns a true value if the record is to be processed. The filters are consulted in turn, until one of them returns a false value. If none of them return a false value, the record will be emitted. If one returns a false value, the handler will not emit the record.

Handler.flush()

确保所有日志记录从缓存输出。此版本不执行任何操作，并且应由子类实现。

Handler.close()

整理处理器使用的所有资源。此版本不输出，但从内部处理器列表中删除处理器，内部处理器在 shutdown() 被调用时关闭 。子类应确保从重写的 close() 方法中调用此方法。

Handler.handle(record)

经已添加到处理器的过滤器过滤后，有条件地发出指定的日志记录。用获取/释放 I/O 线程锁包装记录的实际发出行为。

Handler.handleError(record)

调用 emit() 期间遇到异常时，应从处理器中调用此方法。如果模块级属性 raiseExceptions 是 False，则异常将被静默忽略。这是大多数情况下日志系统需要的 —— 大多数用户不会关心日志系统中的错误，他们对应用程序错误更感兴趣。但是，你可以根据需要将其替换为自定义处理器。指定的记录是发生异常时正在处理的记录。（raiseExceptions 的默认值是 True，因为这在开发过程中是比较有用的）。

Handler.format(record)

如果设置了格式器则用其对记录进行格式化。否则，使用模块的默认格式器。

Handler.emit(record)

执行实际记录给定日志记录所需的操作。这个版本应由子类实现，因此这里直接引发 NotImplementedError 异常。

有关作为标准随附的处理程序，请参见 logging.handlers。

16.6.4. 格式器对象

Formatter 对象拥有以下的属性和方法。一般情况下，它们负责将 LogRecord 转换为可由人或外部系统解释的字符串。基础的 Formatter 允许指定格式字符串。如果未提供任何值，则使用默认值 '%(message)s' ，它仅将消息包括在日志记录调用中。要在格式化输出中包含其他信息（如时间戳），请阅读下文。

格式器可以使用格式化字符串来初始化，该字符串利用 LogRecord 的属性 —— 例如上述默认值，用户的消息和参数预先格式化为 LogRecord 的 message 属性后被使用。此格式字符串包含标准的 Python %-s 样式映射键。有关字符串格式的更多信息，请参见 printf 风格的字符串格式化。

The useful mapping keys in a LogRecord are given in the section on LogRecord 属性.

class logging.Formatter(fmt=None, datefmt=None, style='%')

Returns a new instance of the Formatter class. The instance is initialized with a format string for the message as a whole, as well as a format string for the date/time portion of a message. If no fmt is specified, '%(message)s' is used. If no datefmt is specified, the ISO8601 date format is used.

style 形参可以是 『%』, 『{『 或 『$』 之一，它决定格式字符串如何与数据进行合并：使用 %-formatting, str.format() 或 string.Template 之一。 请参阅 Using particular formatting styles throughout your application 了解有关在日志消息中使用 {- 和 $-formatting 的更多信息。

3.2 版更變: style 参数已加入.

format(record)

记录的属性字典用作字符串格式化操作的参数。返回结果字符串。在格式化字典之前，需要执行几个准备步骤。 使用 msg % args 计算记录的 message 属性。如果格式化字符串包含 '(asctime)'，则调用 formatTime() 来格式化事件时间。如果有异常信息，则使用 formatException() 将其格式化并附加到消息中。请注意，格式化的异常信息缓存在属性 exc_text 中。这很有用，因为可以对异常信息进行序列化并通过网络发送，但是如果您有不止一个定制了异常信息格式的 Formatter 子类，则应格外小心。在这种情况下，您必须在格式器完成格式化后清除缓存的值，以便下一个处理事件的格式化程序不使用缓存的值，而是重新计算它。

如果栈信息可用，它将被添加在异常信息之后，如有必要请使用 formatStack() 来转换它。

formatTime(record, datefmt=None)

This method should be called from format() by a formatter which wants to make use of a formatted time. This method can be overridden in formatters to provide for any specific requirement, but the basic behavior is as follows: if datefmt (a string) is specified, it is used with time.strftime() to format the creation time of the record. Otherwise, the ISO8601 format is used. The resulting string is returned.

此函数使用一个用户可配置函数将创建时间转换为元组。 默认情况下，使用 time.localtime()；要为特定格式化程序实例更改此项，请将实例的 converter 属性设为具有与 time.localtime() 或 time.gmtime() 相同签名的函数。 要为所有格式化程序更改此项，例如当你希望所有日志时间都显示为 GMT，请在 Formatter 类中设置 converter 属性。

3.3 版更變: Previously, the default ISO 8601 format was hard-coded as in this example: 2010-09-06 22:38:15,292 where the part before the comma is handled by a strptime format string ('%Y-%m-%d %H:%M:%S'), and the part after the comma is a millisecond value. Because strptime does not have a format placeholder for milliseconds, the millisecond value is appended using another format string, '%s,%03d' — and both of these format strings have been hardcoded into this method. With the change, these strings are defined as class-level attributes which can be overridden at the instance level when desired. The names of the attributes are default_time_format (for the strptime format string) and default_msec_format (for appending the millisecond value).

formatException(exc_info)

将指定的异常信息（由 sys.exc_info() 返回的标准异常元组）格式化为字符串。 这个默认实现只使用了 traceback.print_exception()。 结果字符串将被返回。

formatStack(stack_info)

将指定的堆栈信息（由 traceback.print_stack() 返回的字符串，但移除末尾的换行符）格式化为字符串。 这个默认实现只是返回输入值。

16.6.5. Filter 对象

Filters 可被 Handlers 和 Loggers 用来实现比按层级提供更复杂的过滤操作。 基本过滤器类只允许低于日志记录器层级结构中低于特定层级的事件。 例如，一个用 『A.B』 初始化的过滤器将允许 『A.B』, 『A.B.C』, 『A.B.C.D』, 『A.B.D』 等日志记录器所记录的事件。 但 『A.BB』, 『B.A.B』 等则不允许。 如果用空字符串初始化，则所有事件都会被略过。

class logging.Filter(name='')

返回一个 Filter 类的实例。 如果指定了 name，则它将被用来为日志记录器命名，该类及其子类将通过该过滤器允许指定事件通过。 如果 name 为空字符串，则允许所有事件通过。

filter(record)

是否要记录指定的记录？返回零表示否，非零表示是。如果认为合适，则可以通过此方法就地修改记录。

请注意关联到处理程序的过滤器会在事件由处理程序发出之前被查询，而关联到日志记录器的过滤器则会在有事件被记录的的任何时候（使用 debug(), info() 等等）在将事件发送给处理程序之前被查询。 这意味着由后代日志记录器生成的事件将不会被日志记录器的过滤器设置所过滤，除非该过滤器也已被应用于后代日志记录器。

你实际上不需要子类化 Filter: 你可以将传入任何包含 filter 方法的具有相同语义的的实例。

3.2 版更變: 你不需要创建专门的 Filter 类，或使用具有 filter 方法的其他类：你可以使用一个函数（或其他可调用对象）作为过滤器。 过滤逻辑将检查过滤器对象是否文化的 filter 属性：如果有，就会将它当作是 Filter 并调用它的 filter() 方法。 在其他情况下，则会将它当作是可调用对象并附带记录作为单一形参进行调用。 返回值应当与 filter() 的返回值相一致。

Although filters are used primarily to filter records based on more sophisticated criteria than levels, they get to see every record which is processed by the handler or logger they’re attached to: this can be useful if you want to do things like counting how many records were processed by a particular logger or handler, or adding, changing or removing attributes in the LogRecord being processed. Obviously changing the LogRecord needs to be done with some care, but it does allow the injection of contextual information into logs (see 使用过滤器传递上下文信息).

16.6.6. LogRecord 属性

LogRecord 实例是每当有日志被记录时由 Logger 自动创建的，并且可通过 makeLogRecord() 手动创建（例如根据从网络接收的已封存事件创建）。

class logging.LogRecord(name, level, pathname, lineno, msg, args, exc_info, func=None, sinfo=None)

包含与被记录的事件相关的所有信息。

主要信息是在 msg 和 args 中传递的，它们使用 msg % args 组合到一起以创建记录的 message 字段。

參數:

• name – 用于记录由此 LogRecord 所表示 的事件的日志记录器名称。 请注意此名称将始终为该值，即使它可以是由附加到不同（祖先）日志记录器的处理程序所发出的。
• level – 以数字表示的日志记录事件层级（如 DEBUG, INFO 等）。 请注意这会转换为 LogRecord 的 两个 属性: levelno 为数字值而 levelname 为对应的层级名称。
• pathname – 进行日志记录调用的文件的完整路径名。
• lineno – 记录调用所在源文件中的行号。
• msg – 事件描述消息，可能为带有可变数据占位符的格式字符串。
• args – 要合并到 msg 参数以获得事件描述的可变数据。
• exc_info – 包含当前异常信息的异常元组，或者如果没有可用异常信息则为 None。
• func – 发起调用日志记录调用的函数或方法名称。
• sinfo – 一个文本字符串，表示当前线程中从堆栈底部直到日志记录调用的堆栈信息。

getMessage()

在将 LogRecord 实例与任何用户提供的参数合并之后，返回此实例的消息。 如果用户提供给日志记录调用的消息参数不是字符串，则会在其上调用 str() 以将它转换为字符串。 此方法允许将用户定义的类用作消息，类的 __str__ 方法可以返回要使用的实际格式字符串。

3.2 版更變: The creation of a LogRecord has been made more configurable by providing a factory which is used to create the record. The factory can be set using getLogRecordFactory() and setLogRecordFactory() (see this for the factory’s signature).

This functionality can be used to inject your own values into a LogRecord at creation time. You can use the following pattern:

old_factory = logging.getLogRecordFactory()

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

logging.setLogRecordFactory(record_factory)

通过此模式，多个工厂方法可以被链接起来，并且只要它们不重载彼此的属性或是在无意中覆盖了上面列出的标准属性，就不会发生意外。

16.6.7. LogRecord 属性

LogRecord 具有许多属性，它们大多数来自于传递给构造器的形参。 （请注意 LogRecord 构造器形参与 LogRecord 属性的名称并不总是完全彼此对应的。） 这些属性可被用于将来自记录的数据合并到格式字符串中。 下面的表格（按字母顺序）列出了属性名称、它们的含义以及相应的 %-style 格式字符串内占位符。

如果是使用 {}-格式化 (str.format())，你可以将 {attrname} 用作格式字符串内的占位符。 如果是使用 $-格式化 (string.Template)，则会使用 ${attrname} 的形式。 当然在这两种情况下，都应当将 attrname 替换为你想要使用的实际属性名称。

在 {}-格式化的情况下，你可以在属性名称之后放置指定的格式化旗标，并用冒号来分隔两者。 例如，占位符 {msecs:03d} 会将毫秒值 4 格式化为 004。 请参看 str.format() 文档了解你所能使用的选项的完整细节。

属性名称	格式	描述
args	不需要格式化。	合并到 msg 以产生 message 的包含参数的元组，或是其中的值将被用于合并的字典（当只有一个参数且其类型为字典时）。
asctime	%(asctime)s	表示 LogRecord 何时被创建的供人查看时间值。 默认形式为 『2003-07-08 16:49:45,896』 (逗号之后的数字为时间的毫秒部分)。
created	%(created)f	LogRecord 被创建的时间（即 time.time() 的返回值）。
exc_info	不需要格式化。	异常元组 (例如 sys.exc_info) 或者如未发生异常则为 None。
filename	%(filename)s	pathname 的文件名部分。
funcName	%(funcName)s	函数名包括调用日志记录.
levelname	%(levelname)s	消息文本记录级别 ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL').
levelno	%(levelno)s	消息数字记录级别 (DEBUG, INFO, WARNING, ERROR, CRITICAL).
lineno	%(lineno)d	发出日志记录调用所在的源行号（如果可用）。
module 模块	%(module)s	模块 (filename 的名称部分)。
msecs	%(msecs)d	LogRecord 被创建的时间的毫秒部分。
message	%(message)s	记入日志的消息，即 msg % args 的结果。 这是在发起调用 Formatter.format() 时设置的。
msg	不需要格式化。	在原始日志记录调用中传入的格式字符串。 与 args 合并以产生 message，或是一个任意对象 (参见 使用任意对象作为消息)。
名称	%(name)s	用于记录调用的日志记录器名称。
pathname	%(pathname)s	发出日志记录调用的源文件的完整路径名（如果可用）。
process	%(process)d	进程ID（如果可用）
processName	%(processName)s	进程名（如果可用）
relativeCreated	%(relativeCreated)d	以毫秒数表示的 LogRecord 被创建的时间，即相对于 logging 模块被加载时间的差值。
stack_info	不需要格式化。	当前线程中从堆栈底部起向上直到包括日志记录调用并导致创建此记录的堆栈帧的堆栈帧信息（如果可用）。
thread	%(thread)d	线程ID（如果可用）
threadName	%(threadName)s	线程名（如果可用）

3.1 版更變: 添加了 processName

16.6.8. LoggerAdapter 对象

LoggerAdapter 实例会被用来方便地将上下文信息传入日志记录调用。 要获取用法示例，请参阅 添加上下文信息到你的日志记录输出 部分。

class logging.LoggerAdapter(logger, extra)

返回一个 LoggerAdapter 的实例，该实例的初始化带有一个下层的 Logger 实例和一个字典类对象。

process(msg, kwargs)

修改传递给日志记录调用的消息和/或关键字参数以便插入上下文信息。 此实现接受以 extra 形式传给构造器的对象并使用 『extra』 键名将其加入 kwargs。 返回值为一个 (msg, kwargs) 元组，其中传入了（可能经过修改的）参数版本。

在上述方法之外，LoggerAdapter 还支持 Logger 的下列方法: debug(), info(), warning(), error(), exception(), critical(), log(), isEnabledFor(), getEffectiveLevel(), setLevel() 以及 hasHandlers()。 这些方法具有与它们在 Logger 中的对应方法相同的签名，因此你可以互换使用这两种类型的实例。

3.2 版更變: isEnabledFor(), getEffectiveLevel(), setLevel() 和 hasHandlers() 方法已被添加到 LoggerAdapter。 这些方法会委托给下层的日志记录器。

16.6.9. 线程安全

logging 模块的目标是使客户端不必执行任何特殊操作即可确保线程安全。 它通过使用线程锁来达成这个目标；用一个锁来序列化对模块共享数据的访问，并且每个处理程序也会创建一个锁来序列化对其下层 I/O 的访问。

如果你要使用 signal 模块来实现异步信号处理程序，则可能无法在这些处理程序中使用 logging。 这是因为 threading 模块中的锁实现并非总是可重入的，所以无法从此类信号处理程序发起调用。

16.6.10. 模块级别函数

In addition to the classes described above, there are a number of module- level functions.

logging.getLogger(name=None)

返回具有指定 name 的日志记录器，或者当 name 为 None 时返回层级结构中作为根日志记录器的日志记录器。 如果指定了 name，它通常是以点号分隔的带层级结构的名称如 『a』, 『a.b』 或 『a.b.c.d』。 这些名称的选择完全取决于使用 logging 的开发者。

附带给定 name 的所有对此函数的调用都将返回相同的日志记录器实例。 这意味着日志记录器实例不需要在应用的不同部分间传递。

logging.getLoggerClass()

返回标准的 Logger 类，或是最近传给 setLoggerClass() 的类。 此函数可以从一个新的类定义中调用，以确保安装自定义的 Logger 类不会撤销其他代码已经应用的自定义操作。 例如:

class MyLogger(logging.getLoggerClass()):
    # ... override behaviour here

logging.getLogRecordFactory()

返回一个被用来创建 LogRecord 的可调用对象。

3.2 版新加入: 此函数与 setLogRecordFactory() 一起提供，以便允许开发者对如何构造表示日志记录事件的 LogRecord 有更好的控制。

请参阅 setLogRecordFactory() 了解有关如何调用该工厂方法的更多信息。

logging.debug(msg, *args, **kwargs)

在根日志记录器上记录一条 DEBUG 级别的消息。 msg 是消息格式字符串，而 args 是要使用字符串格式化运算符合并到 msg 的参数。 （请注意这意味着你可以在格式字符串中使用关键字以及单个字典参数。）

There are three keyword arguments in kwargs which are inspected: exc_info which, if it does not evaluate as false, causes exception information to be added to the logging message. If an exception tuple (in the format returned by sys.exc_info()) is provided, it is used; otherwise, sys.exc_info() is called to get the exception information.

第二个可选关键字参数是 stack_info，默认为 False。如果为 True，则将堆栈信息添加到日志消息中，包括实际的日志调用。请注意，这与通过指定 exc_info 显示的堆栈信息不同：前者是从堆栈底部到当前线程中的日志记录调用的堆栈帧，而后者是在搜索异常处理程序时，跟踪异常而打开的堆栈帧的信息。

You can specify stack_info independently of exc_info, e.g. to just show how you got to a certain point in your code, even when no exceptions were raised. The stack frames are printed following a header line which says:

Stack (most recent call last):

这模仿了显示异常帧时所使用的 Traceback (most recent call last): 。

第三个可选关键字参数是 extra，它可被用来传递一个字典，该字典会被用来填充为日志记录事件创建并附带用户自定义属性的 LogRecord 的 __dict__。 之后将可按你的需要使用这些自定义属性。 例如，可以将它们合并到已记录的消息中。 举例来说:

FORMAT = '%(asctime)-15s %(clientip)s %(user)-8s %(message)s'
logging.basicConfig(format=FORMAT)
d = {'clientip': '192.168.0.1', 'user': 'fbloggs'}
logging.warning('Protocol problem: %s', 'connection reset', extra=d)

would print something like:

2006-02-08 22:20:02,165 192.168.0.1 fbloggs  Protocol problem: connection reset

The keys in the dictionary passed in extra should not clash with the keys used by the logging system. (See the Formatter documentation for more information on which keys are used by the logging system.)

如果你选择在已记录的消息中使用这些属性，则需要格外小心。 例如在上面的示例中，Formatter 已设置了格式字符串，其在 LogRecord 的属性字典中应有 『clientip』 和 『user』。 如果缺少这些属性，消息将不被记录，因为会引发字符串格式化异常，你始终需要传入带有这些键的 extra 字典。

尽管这可能很烦人，但此功能旨在用于特殊情况，例如在多个上下文中执行相同代码的多线程服务器，并且出现的有趣条件取决于此上下文（例如在上面的示例中就是远程客户端IP地址和已验证用户名）。在这种情况下，很可能将专门的 Formatter 与特定的 Handler 一起使用。

3.2 版新加入: 增加了 stack_info 参数。

logging.info(msg, *args, **kwargs)

在根日志记录器上记录一条 INFO 级别的消息。 参数解释同 debug()。

logging.warning(msg, *args, **kwargs)

在根日志记录器上记录一条 WARNING 级别的消息。 参数解释同 debug()。

備註

有一个已过时方法 warn 其功能与 warning 一致。 由于 warn 已被弃用，请不要使用它 —— 而要改用 warning。

logging.error(msg, *args, **kwargs)

在根日志记录器上记录一条 ERROR 级别的消息。 参数解释同 debug().

logging.critical(msg, *args, **kwargs)

在根日志记录器上记录一条 CRITICAL 级别的消息。 参数解释同 debug()。

logging.exception(msg, *args, **kwargs)

在根日志记录器上记录一条 ERROR 级别的消息。 参数解释同 debug()。 异常信息将被添加到日志消息中。 此函数应当仅从异常处理程序中调用。

logging.log(level, msg, *args, **kwargs)

在根日志记录器上记录一条 level 级别的消息。 其他参数解释同 debug()。

備註

上述模块层级的便捷函数均委托给根日志记录器，它们会调用 basicConfig() 以确保至少有一个处理程序可用。 因此，它们 不应 在线程中使用，在 Python 2.7.1 和 3.2 之前的版本中，除非线程启动 之前 已向根日志记录器添加了至少一个处理程序方可使用。 在较早的 Python 版本中，由于 basicConfig() 中存在线程安全性的不足，这（在少数情况下）可能导致处理程序被多次加入根日志记录器，这会进一步导致同一事件出现多条消息。

logging.disable(lvl)

Provides an overriding level lvl for all loggers which takes precedence over the logger’s own level. When the need arises to temporarily throttle logging output down across the whole application, this function can be useful. Its effect is to disable all logging calls of severity lvl and below, so that if you call it with a value of INFO, then all INFO and DEBUG events would be discarded, whereas those of severity WARNING and above would be processed according to the logger’s effective level. If logging.disable(logging.NOTSET) is called, it effectively removes this overriding level, so that logging output again depends on the effective levels of individual loggers.

logging.addLevelName(lvl, levelName)

Associates level lvl with text levelName in an internal dictionary, which is used to map numeric levels to a textual representation, for example when a Formatter formats a message. This function can also be used to define your own levels. The only constraints are that all levels used must be registered using this function, levels should be positive integers and they should increase in increasing order of severity.

備註

如果你考虑要定义你自己的级别，请参阅 自定义级别 部分。

logging.getLevelName(lvl)

Returns the textual representation of logging level lvl. If the level is one of the predefined levels CRITICAL, ERROR, WARNING, INFO or DEBUG then you get the corresponding string. If you have associated levels with names using addLevelName() then the name you have associated with lvl is returned. If a numeric value corresponding to one of the defined levels is passed in, the corresponding string representation is returned. Otherwise, the string 『Level %s』 % lvl is returned.

備註

级别在内部为整数（它们需要在日志记录逻辑中相互比较）。 此函数被用于在整数级别与通过 %(levelname)s 格式描述符方式格式化的日志输出中显示的级别名称之间进行转换 (参见 LogRecord 属性)。

3.4 版更變: 在早于 3.4 的 Python 版本中，此函数也可传入一个文本级别名称，并将返回对应的级别数字值。 此未记入文档的行为被视为是一个错误，并在 Python 3.4 中被移除，但又在 3.4.2 中被恢复以保持向下兼容性。

logging.makeLogRecord(attrdict)

创建并返回一个新的 LogRecord 实例，实例属性由 attrdict 定义。 此函数适用于接受一个封存的 LogRecord 属性字典，通过套接字传输，并在接收端将其重建为一个 LogRecord 实例。

logging.basicConfig(**kwargs)

通过使用默认的 Formatter 创建一个 StreamHandler 并将其加入根日志记录器来为日志记录系统执行基本配置。 如果没有为根日志记录器定义处理程序则 debug(), info(), warning(), error() 和 critical() 等函数将自动调用 basicConfig()。

This function does nothing if the root logger already has handlers configured for it.

備註

此函数应当在其他线程启动之前从主线程被调用。 在 2.7.1 和 3.2 之前的 Python 版本中，如果此函数从多个线程被调用，一个处理程序（在极少的情况下）有可能被多次加入根日志记录器，导致非预期的结果例如日志中的消息出现重复。

支持以下关键字参数。

格式	描述
filename	使用指定的文件名而不是 StreamHandler 创建 FileHandler。
filemode	Specifies the mode to open the file, if filename is specified (if filemode is unspecified, it defaults to 『a』).
format	处理器使用的指定格式字符串。
datefmt	Use the specified date/time format.
style	If format is specified, use this style for the format string. One of 『%』, 『{『 or 『$』 for %-formatting, str.format() or string.Template respectively, and defaulting to 『%』 if not specified.
level	Set the root logger level to the specified level.
stream	Use the specified stream to initialize the StreamHandler. Note that this argument is incompatible with 『filename』 - if both are present, a ValueError is raised.
handlers	If specified, this should be an iterable of already created handlers to add to the root logger. Any handlers which don’t already have a formatter set will be assigned the default formatter created in this function. Note that this argument is incompatible with 『filename』 or 『stream』 - if both are present, a ValueError is raised.

3.2 版更變: The style argument was added.

3.3 版更變: The handlers argument was added. Additional checks were added to catch situations where incompatible arguments are specified (e.g. handlers together with stream or filename, or stream together with filename).

logging.shutdown()

通过刷新和关闭所有处理程序来通知日志记录系统执行有序停止。 此函数应当在应用退出时被调用并且在此调用之后不应再使用日志记录系统。

logging.setLoggerClass(klass)

Tells the logging system to use the class klass when instantiating a logger. The class should define __init__() such that only a name argument is required, and the __init__() should call Logger.__init__(). This function is typically called before any loggers are instantiated by applications which need to use custom logger behavior.

logging.setLogRecordFactory(factory)

设置一个用来创建 LogRecord 的可调用对象。

參數:factory – 用来实例化日志记录的工厂可调用对象。

3.2 版新加入: 此函数与 getLogRecordFactory() 一起提供，以便允许开发者对如何构造表示日志记录事件的 LogRecord 有更好的控制。

可调用对象 factory 具有如下签名:

factory(name, level, fn, lno, msg, args, exc_info, func=None, sinfo=None, **kwargs)

名称:日志记录器名称 level:日志记录级别（数字）。 fn:进行日志记录调用的文件的完整路径名。 lno:记录调用所在文件中的行号。 msg:日志消息。 args:日志记录消息的参数。 exc_info:异常元组，或 None 。 func:调用日志记录调用的函数或方法的名称。 sinfo:与 traceback.print_stack() 所提供的类似的栈回溯信息，显示调用的层级结构。 kwargs:其他关键字参数。

16.6.11. 模块级属性

logging.lastResort

通过此属性提供的“最后处理者”。 这是一个以 WARNING 级别写入到 sys.stderr 的 StreamHandler，用于在没有任何日志记录配置的情况下处理日志记录事件。 最终结果就是将消息打印到 sys.stderr，这会替代先前形式为 「no handlers could be found for logger XYZ」 的错误消息。 如果出于某种原因你需要先前的行为，可将 lastResort 设为 None。

3.2 版新加入.

16.6.12. 与警告模块集成

captureWarnings() 函数可用来将 logging 和 warnings 模块集成。

logging.captureWarnings(capture)

此函数用于打开和关闭日志系统对警告的捕获。

如果 capture 是 True，则 warnings 模块发出的警告将重定向到日志记录系统。具体来说，将使用 warnings.formatwarning() 格式化警告信息，并将结果字符串使用 WARNING 等级记录到名为 'py.warnings' 的记录器中。

如果 capture 是 False，则将停止将警告重定向到日志记录系统，并且将警告重定向到其原始目标（即在 captureWarnings(True) 调用之前的有效目标）。

也參考

模块 logging.config

日志记录模块的配置 API 。

模块 logging.handlers

日志记录模块附带的有用处理程序。

PEP 282 - Logging 系统

该提案描述了Python标准库中包含的这个特性。

Original Python logging package

这是该 logging 包的原始来源。该站点提供的软件包版本适用于 Python 1.5.2、2.1.x 和 2.2.x，它们不被 logging 包含在标准库中。