Python logging.config模块，logging.config.fileConfig()、logging.config.dictConfig() 使用介绍

分类：Python作者：小青龍

文章目录

在python中进行日志配置时，除了在 Python 代码显式创建日志器、处理器和格式器外，在实际项目中更多的是通过读取配置文件来完成日志配置的。

在python内置的logging.config模块中，有两个常用的方法：fileConfig()、dictConfig()

接下来将总结如何使用这两种方法进行日志配置

一、logging.config.fileConfig()

logging.config.fileConfig(fname,defaults=None,disable_existing_loggers=True,encoding=None)

该方法可以从符合ini格式的文件中读取日志配置（configparser — 配置文件解析器 — 受支持的 INI 文件结构）

fname 参数指定 文件名或文件类对象；

disable_existing_loggers 设置为True时（默认），表示将禁用任何现有的非根日志器，除非它们或它们的祖先在日志配置中被显式命名。设置为False时，表示在调用该方法时，不会禁用已有的日志器。

示例：

log.ini

[loggers]
keys=root,fileLogger,trFileLogger

[handlers]
keys=consoleHandler,fileHandler,trFileHandler

[formatters]
keys=consoleFormatter,fileFormatter

[logger_root]
;level=DEBUG
handlers=consoleHandler

[logger_fileLogger]
level=DEBUG
handlers=consoleHandler,fileHandler
qualname=fileLogger
propagate=0

[logger_trFileLogger]
level=INFO
handlers=consoleHandler,trFileHandler
qualname=trFileLogger
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=consoleFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=fileFormatter
args=('./FH.log','a','utf8',True)

[handler_trFileHandler]
class=logging.handlers.TimedRotatingFileHandler
formatter=fileFormatter
kwargs={"filename":"./trFH.log","when":"S","interval":1,"backupCount":3,"delay":True}

[formatter_consoleFormatter]
format=[%(asctime)s - %(name)s] %(message)s
datefmt=%Y-%m-%d %H:%M:%S

[formatter_fileFormatter]
format=[%(asctime)s - %(name)s - %(filename)s:%(lineno)d] %(message)s

python代码读取日志配置文件，并记录日志：

import logging
import logging.config
# import logging.handlers

logging.config.fileConfig("./log.ini")

logger_r = logging.getLogger()
logger_f = logging.getLogger('fileLogger')
logger_ft = logging.getLogger('fileLogger.test')
logger_trf = logging.getLogger('trFileLogger')

logger_r.warning(logging.getLevelName(logger_r.getEffectiveLevel()))
logger_r.warning(logger_r.parent)

logger_f.info(logging.getLevelName(logger_f.getEffectiveLevel()))
logger_f.info(logger_f.parent)

logger_ft.info(logging.getLevelName(logger_ft.getEffectiveLevel()))
logger_ft.info(logger_ft.parent)

logger_trf.info(logging.getLevelName(logger_trf.getEffectiveLevel()))
logger_trf.info(logger_trf.parent)

运行代码，输出：

# console 输出
[2023-08-18 20:25:46 - root] WARNING
[2023-08-18 20:25:46 - root] None
[2023-08-18 20:25:46 - fileLogger] DEBUG
[2023-08-18 20:25:46 - fileLogger] <RootLogger root (WARNING)>
[2023-08-18 20:25:46 - fileLogger.test] DEBUG
[2023-08-18 20:25:46 - fileLogger.test] <Logger fileLogger (DEBUG)>
[2023-08-18 20:25:46 - trFileLogger] INFO
[2023-08-18 20:25:46 - trFileLogger] <RootLogger root (WARNING)>

# FH.log 文件
[2023-08-18 20:25:46,084 - fileLogger - logger.py:20] DEBUG
[2023-08-18 20:25:46,084 - fileLogger - logger.py:21] <RootLogger root (WARNING)>
[2023-08-18 20:25:46,084 - fileLogger.test - logger.py:23] DEBUG
[2023-08-18 20:25:46,084 - fileLogger.test - logger.py:24] <Logger fileLogger (DEBUG)>

# trFH.log 文件
[2023-08-18 20:25:46,084 - trFileLogger - logger.py:26] INFO
[2023-08-18 20:25:46,084 - trFileLogger - logger.py:27] <RootLogger root (WARNING)>

解释：

  • log.ini文件中包含 [loggers],[handlers] 和 [formatters] 等小节，它们通过名称来标识文件中定义的每种类型的实体。对于每个这样的实体，都有单独的小节来标识实体的配置方式。

    例如： [loggers] 小节中名为 root 的日志器，相应的配置详情保存在 [logger_root] 小节中。 类似地，对于 [handlers] 小节中名为 consoleHandler 的处理程序，其配置将保存在名为 [handler_consoleHandler] 的小节中，而对于 [formatters] 小节中名为 consoleFormatter 的格式化器，其配置将在名为 [formatter_consoleFormatter] 的小节中指定。

  • 根日志器的配置必须在名为 [logger_root] 的小节中指定，并且至少要指定一个处理程序。

    level用来设置当前日志器的日志级别，可选值：DEBUG,INFO,WARNING,ERROR,CRITICAL或 NOTSET，其中NOTSET表示将会记录所有消息。

    handlers用来指定处理程序，如果指定多个处理程序，则各处理器用,隔开。并且指定的处理程序，必须出现在[handlers]小节的配置中。

    程序中调用根日志器是通过logging.getLogger()，不传任何参数。

  • [logger_fileLogger]、[logger_trFileLogger] 小节是非根日志器配置详情。

    level 和 handlers 的解释方式与根日志记录器的一致，不同之处在于如果一个非根日志记录器的级别被指定为 NOTSET，则系统会咨询更高层级的日志记录器来确定该日志记录器的有效级别。

    propagate 条目设为 1 表示消息必须从此日志记录器传播到更高层级的处理程序，设为 0 表示消息不会传播到更高层级的处理程序。如果不设置此项，默认propagate=1

    qualname 是日志器的名称，它是应用程序中logging.getLogger()获取日志器所用的名称。而且，对于非根日志器，该项必须设置（根日志器可以省略，默认为root）

    如果程序中logging.getLogger(<name>)，<name>未在配置文件中定义，则它会按层级关系向上找。例如：logging.getLogger('fileLogger.test') 配置文件中没有qualname=fileLogger.test的日志器配置，它会去找有没有qualname=fileLogger的日志器配置，如果有就使用这个配置。如果没有则继续向上找，这个例子中再向上就是根日志器了。

  • [handler_consoleHandler]、[handler_fileHandler]、[handler_trFileHandler] 小节是处理器配置详情。

    class 用来指明实例化该处理器所使用的类名。

    level 会以与日志记录器相同的方式来解读，但需要注意的是这里设置的级别如果比引用它的日志器里设置的级别还低的化，是没有意义的。

    formatter 条目指明此处理程序的格式化器，如为空白，则会使用默认的格式化器 (logging._defaultFormatter)。 如果指定了名称，则它必须出现于 [formatters] 小节并且在配置文件中有相应的小节。

    args 给class指明的类提供示例化时的参数，如未提供，则默认为()。需要注意提供的参数会按顺序依次赋值给类定义中同样顺序的参数，如果只有提供了一个参数，后面必须有一个, 如：args=(sys.stdout,)

    kwargs 给class指定的类提供示例化时的参数，与args不同的是，它提供的是关键字参数字典，因此不需要按顺序提供参数。如未提供，则默认为{}。

  • [formatter_consoleFormatter]、[formatter_fileFormatter] 小节是格式化程序配置详情。

    format 是整个格式字符串，而 datefmt 则是兼容 strftime() 的日期/时间格式字符串，用来指定format中的asctime（如果有）对应的日期时间格式。如果datefmt为空，则使用默认的'%Y-%m-%d %H:%M:%S,uuu'

    style 用来指定格式字符串使用的类型风格，默认为 %，还支持{、$ 类型

    class 用来指定格式化程序使用的类，默认为logging.Formatter

二、logging.config.dictConfig()

该方法从一个字典获取日志记录配置。这是Python 3.2 中，引入的一种新的配置日志记录的方法，它提供了上述基于配置文件方法的功能的超集，并且是新应用程序和部署的推荐配置方法。

传给 dictConfig() 的字典包含以下的键：

  • version - 应设为代表架构版本的整数值。 目前唯一有效的值是 1

  • formatters - 对应的值将是一个字典，其中每个键是一个格式器 ID 而每个值则是一个描述如何配置相应Formatter 实例的字典。

    Formatter实例字典，可选键有：format、datefmt、style、class

  • filters - 对应的值将是一个字典，其中每个键是一个过滤器 ID 而每个值则是一个描述如何配置相应Filter实例的字典。

    Filter实例字典，可选键有：name

  • handlers - 对应的值将是一个字典，其中每个键是一个处理器 ID 而每个值则是一个描述如何配置相应Handler实例的字典。

    Handler实例字典，必选键：class，可选键：level、formatter、filters，所有其他键将作为关键字传递给class指定的类，如：logging.handlers.RotatingFileHandler类，需要的参数filename、maxBytes、backupCount等。

  • loggers - 对应的值将是一个字典，其中每个键是一个日志记录器名称而每个值则是一个描述如何配置相应Logger实例的字典。

    Logger实例字典，可选键有：level、propagate、filters、handlers

  • root - 根日志记录器对应的配置。 配置的处理方式将与所有日志器一致，除了propagate 设置将不可用之外。

  • incremental - 配置是否要被解读为在现有配置上新增，该值默认为 False。这个不太容易解释，暂时忽略。

  • disable_existing_loggers - 是否要禁用任何现有的非根日志记录器。 该设置对应于 fileConfig() 中的同名形参。 如果省略，则此形参默认为 True。

示例：

你可以使用JSON格式的配置文件，或使用YAML格式的文件来填充配置字典，其中YAML文件作为配置文件，算是目前比较主流的用法，这个示例也以YAML文件作为配置文件。

关于YAML的更多信息请参考：【YAML知识】YAML 简介及语法，绝对干货

log.yaml

version: 1
disable_existing_loggers: false
formatters:
  simpleFormatter:
    format: '[{asctime}.{msecs:03.0f} - {name} - {levelname}] {message}'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '{'
handlers:
  consoleHandler:
    class: logging.StreamHandler
    level: DEBUG
    formatter: simpleFormatter
    stream: ext://sys.stdout
  fileHandler:
    class: logging.handlers.RotatingFileHandler
    level: DEBUG
    formatter: simpleFormatter
    filename: sample.log
    maxBytes: 80
    backupCount: 3
loggers:
  sampleLogger:
    level: DEBUG
    handlers: [fileHandler, consoleHandler]
    propagate: no
root:
  level: INFO
  handlers: [consoleHandler]

python代码读取配置文件，并记录日志：

import logging.config
import yaml

with open('./logconf/log.yaml', 'r') as f:
    config = yaml.safe_load(f.read())
    logging.config.dictConfig(config)

logger_r = logging.getLogger()
logger_s = logging.getLogger('sampleLogger')

logger_r.info(logger_r.getEffectiveLevel())
logger_r.warning(logger_r.parent)

logger_s.info(logger_s.getEffectiveLevel())
logger_s.warning(logger_s.parent)

运行代码，输出结果：

# console 控制台输出
[2023-08-18 23:52:43.016 - root - INFO] 20
[2023-08-18 23:52:43.016 - root - WARNING] None
[2023-08-18 23:52:43.016 - sampleLogger - INFO] 10
[2023-08-18 23:52:43.016 - sampleLogger - WARNING] <RootLogger root (INFO)>

# sample.log 文件
[2023-08-18 23:52:43.016 - sampleLogger - WARNING] <RootLogger root (INFO)>

# sample.log.1 文件
[2023-08-18 23:52:43.016 - sampleLogger - INFO] 10

解释：

  • log.yaml 中root定义了根日志器配置，在应用程序中通过logging.getLogger()获取根日志器（注意不需要传name），根日志器中如果不定义level、handlers等配置，将使用默认的WARNING、sys.stdout

  • 在yaml或json配置文件中需要引用配置以外的对象时，如：sys.stdout，则需要加上ext://前缀， 配置系统会将ext:// 去除，而该值的剩余部分将使用正常导入机制来处理。

  • 另外需要注意的是，由于YAML语法的原因，标量中不能出现一些特殊字符开头，如：%、[、{等，这些字符在YAML语法中都有特殊含义（如下图），因此如果必须出现，在标量开头，请用单引号括起来（单引号括起来的所有字符都是字面字符，双引号括起来的可以接收转义字符）

    yaml语法元素

  • fileHandler处理器的配置使用了RotatingFileHandler类，支持文件按大小进行轮转。从输出结果来看，发生日志轮转时，不会将一条日志切割分到两个日志文件中去。如示例中，设置的maxBytes: 80，而[2023-08-18 23:52:43.016 - sampleLogger - INFO] 10共50个字符，[2023-08-18 23:52:43.016 - sampleLogger - WARNING] <RootLogger root (INFO)>共75个字符，后者并没有被分割为30、45个字符分别放到两个文件中。另外，即使写入1条日志时长度超过设置的maxBytes，该条日志也不会被分割到两个文件中去。

另外，logging.config.dictConfig() 还支持Filters过滤器配置，而logging.config.fileConfig()不能支持过滤器配置。上述示例中未给出Filters配置，有空再单独总结关于logging.config.dictConfig()配置Filters的用法吧。

拜了个拜~

参考资料：logging.config — 日志记录配置

原文地址：https://blog.csdn.net/B11050729/article/details/132373445

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。

相关推荐

Python中的函数（二）
Python中的函数（二） 在上一篇文章中提到了Python中函数的定义和使用，在这篇文章里我们来讨论下关于函数的一些更深的话题。在学习C语言函数的时候，遇到的问题主要有形参实参的区别、参数的传递和改变、变量的作用域。同样在Python中，关于对函数的理解和使用也存在这些问题。下面来逐一讲解。一.函
Python中的字符串
Python中的字符串 可能大多数人在学习C语言的时候，最先接触的数据类型就是字符串，因为大多教程都是以&quot;Hello world&quot;这个程序作为入门程序，这个程序中要打印的&quot;Hello world&quot;就是字符串。如果你做过自然语言处理方面的研究，并且用Python
Python 面向对象编程（一）
Python 面向对象编程（一） 虽然Python是解释性语言，但是它是面向对象的，能够进行对象编程。下面就来了解一下如何在Python中进行对象编程。一.如何定义一个类 在进行python面向对象编程之前，先来了解几个术语：类，类对象，实例对象，属性，函数和方法。 类是对现实世界中一些事物的封装，
Python面向对象编程（二）
Python面向对象编程（二） 在前面一篇文章中谈到了类的基本定义和使用方法，这只体现了面向对象编程的三大特点之一：封装。下面就来了解一下另外两大特征：继承和多态。 在Python中，如果需要的话，可以让一个类去继承一个类，被继承的类称为父类或者超类、也可以称作基类，继承的类称为子类。并且Pytho
Python中的函数（一）
Python中的函数（一） 接触过C语言的朋友对函数这个词肯定非常熟悉，无论在哪门编程语言当中，函数（当然在某些语言里称作方法，意义是相同的）都扮演着至关重要的角色。今天就来了解一下Python中的函数用法。一.函数的定义 在某些编程语言当中，函数声明和函数定义是区分开的（在这些编程语言当中函数声明
在windows下如何快速搭建web.py开发框架
在windows下如何快速搭建web.py开发框架 用Python进行web开发的话有很多框架供选择，比如最出名的Django，tornado等，除了这些框架之外，有一个轻量级的框架使用起来也是非常方便和顺手，就是web.py。它由一名黑客所创建，但是不幸的是这位创建者于2013年自杀了。据说现在由
将Sublime Text 2搭建成一个好用的IDE
将Sublime Text 2搭建成一个好用的IDE 说起编辑器，可能大部分人要推荐的是Vim和Emacs，本人用过Vim，功能确实强大，但是不是很习惯，之前一直有朋友推荐SUblime Text 2这款编辑器，然后这段时间就试了一下，就深深地喜欢上这款编辑器了...
Python中的模块
Python中的模块 有过C语言编程经验的朋友都知道在C语言中如果要引用sqrt这个函数，必须用语句&quot;#include&lt;math.h&gt;&quot;引入math.h这个头文件，否则是无法正常进行调用的。那么在Python中，如果要引用一些内置的函数，该怎么处理呢？在Python中
Python的基础语法
Python的基础语法 在对Python有了基础的认识之后，下面来了解一下Python的基础语法，看看它和C语言、java之间的基础语法差异。一.变量、表达式和语句 Python中的语句也称作命令，比如print &quot;hello python&quot;这就是一条语句。 表达式，顾名思义，是
Eclipse+PyDev+Django+Mysql搭建Python web开发环境
Eclipse+PyDevʽjango+Mysql搭建Python web开发环境 Python的web框架有很多，目前主流的有Django、Tornado、Web.py等，最流行的要属Django了，也是被大家最看好的框架之一。下面就来讲讲如何搭建Django的开发环境。一.准备工作 需要下载的
在windows下安装配置Ulipad
在windows下安装配置Ulipad 今天推荐一款轻便的文本编辑器Ulipad，用来写一些小的Python脚本非常方便。 Ulipad下载地址： https://github.com/limodou/ulipad http://files.cnblogs.com/dolphin0520/u...
Python中的函数（三）
Python中的函数（三） 在前面两篇文章中已经探讨了函数的一些相关用法，下面一起来了解一下函数参数类型的问题。在C语言中，调用函数时必须依照函数定义时的参数个数以及类型来传递参数，否则将会发生错误，这个是严格进行规定的。然而在Python中函数参数定义和传递的方式相比而言就灵活多了。一.函数参数的
在Notepad++中搭配Python开发环境
在Notepad++中搭配Python开发环境 Python在最近几年一度成为最流行的语言之一，不仅仅是因为它简洁明了，更在于它的功能之强大。它不仅能够完成一般脚本语言所能做的事情，还能很方便快捷地进行大规模的项目开发。在学习Python之前我们来看一下Python的历史由来，&quot;Pytho
Python中的条件选择和循环语句
Python中的条件选择和循环语句 同C语言、Java一样，Python中也存在条件选择和循环语句，其风格和C语言、java的很类似，但是在写法和用法上还是有一些区别。今天就让我们一起来了解一下。一.条件选择语句 Python中条件选择语句的关键字为：if 、elif 、else这三个。其基本形式如
关于raw_input()和sys.stdin.readline()的区别
关于raw_input( )和sys.stdin.readline( )的区别 之前一直认为用raw_input( )和sys.stdin.readline( )来获取输入的效果完全相同，但是最近在写程序时有类似这样一段代码：import sysline = sys.stdin.readline()
初识Python
初识Python 跟学习所有的编程语言一样，首先得了解这门语言的编程风格和最基础的语法。下面就让我们一起来了解一下Python的编程风格。1.逻辑行与物理行 在Python中有逻辑行和物理行这个概念，物理行是指在编辑器中实际看到的一行，逻辑行是指一条Python语句。在Python中提倡一个物理行只
retry重试常见场景及实现
当我们的代码是有访问网络相关的操作时,比如http请求或者访问远程数据库，经常可能会发生一些错误，有些错误可能重新去发送请求就会成功，本文分析常见可能需要重试的场景，并最后给出python代码实现。
python迭代器和生成器
1.经典迭代器 2.将Sentence中的__iter__改成生成器函数 改成生成器后用法不变，但更加简洁。 3.惰性实现 当列表比较大，占内存较大时，我们可以采用惰性实现，每次只读取一个元素到内存。 或者使用更简洁的生成器表达式 4.yield from itertools模块含有大量生成器函数可
python-kafka源码解析之socketpair
本文介绍简单介绍socket的常用函数,并以python-kafka中的源码socketpair为例，来讲解python socket的运用
彻底弄懂python编码
python实践中经常出现编码相关的异常，大多网上找资料而没有理解原理，导致一次次重复错误。本文对常用Unicode、UTF-8、GB2312编码的原理进行介绍，接着介绍了python字符类型unicode和str以及常见编解码错误UnicodeEncodeError和UnicodeDEcodeEr
pythonJavaScriptjavaHTMLPHPreactjsC#AndroidCSSNode.jssqlrpython-3.xMysqLjQueryc++pandasFlutterangularIOSdjangolinuxswifttypescript路由器JSON路由器设置无线路由器h3c华三华三路由器设置华三路由器电脑软件教程arraysdocker软件图文教程Cvue.jslaravelspring-boot