使用Python自定义创建的Log日志模块

2023-07-07 09:14:35 作者：信橙则灵

这篇文章主要介绍了使用Python自定义创建的Log日志模块,日志文件是用于记录系统操作事件的文件集合，可分为事件日志和消息日志。具有处理历史数据、诊断问题的追踪以及理解系统的活动等重要作用,需要的朋友可以参考下

日志的作用

作为一名开发人员，日志是我们排查问题的好帮手，在程序中设计一份好的日志，能够让我们快速定位到问题的原因。比如我们的产品在用户手中出了问题，我们只需要查看该用户日志，然后就能发现问题原因。毫无疑问。这会极大的节省我们排查问题的时间，提升了我们工作的效率。

日志分类

根据Python中logging提供的日志函数，它们分别是: debug()、 info()、 warning()、 error() 和 critical(),logging根据错误对程序运行的影响情况，可以大致分为四类(影响递增)：

debug：所有详细信息，用于调试。
info:一些关键跳转，证明软件正常运行的日志。
warning:表明发生了一些意外，软件无法处理，但是依然能正常运行。
error：由于一些严重问题，软件不能正常执行一些功能，但是依然能运行。
critical/fatal：非常严重的错误，软件已经不能继续运行了。

每个级别对应的数字值为
CRITICAL：50，ERROR：40，WARNING：30，INFO：20，DEBUG：10，NOTSET：0。
Python 中日志的默认等级是 WARNING，DEBUG 和 INFO 级别的日志将不会得到显示，在 logging 中更改设置。

日志输出

日志输出的方式主要有两种，一种使用 logging 在控制台打印日志，另一种是将日志打印到文件中，方便日后的观察

输出到控制台

使用 logging 在控制台打印日志

import logging
logging.debug('运行正常')
logging.warning('博主颜值要爆表了')
logging.info('博主张的真帅，可惜你看不到')
logging.error('程序运行遇到错误')
logging.critical('严重错误，无法运行')

在这里插入图片描述

根据控制台的打印情况，可以看出，日志设置在 WARNING 级别(那些数字低于这个级别的将不会展示)

那怎么去改变日志的级别呢？

很简单，一句代码就可以实现

import logging
logging.basicConfig(level=logging.DEBUG)   # 此处的级别要大写
logging.debug('运行正常')
logging.warning('博主颜值要爆表了')
logging.info('博主张的真帅，可惜你看不到')
logging.error('程序运行遇到错误')
logging.critical('严重错误，无法运行')

当设置为最小的级别时，那所有的日志信息就都展示出来了

将日志信息打印到文件中

将信息打印到文件中同样需要调用 basicConfig ，现在我们修改上面的代码，查看一下运行情况。

import logging
logging.basicConfig(level=logging.DEBUG, filename='Zhang.log', filemode='a')   # 此处的级别要大写
logging.debug('运行正常')
logging.warning('博主颜值要爆表了')
logging.info('博主张的真帅，可惜你看不到')
logging.error('程序运行遇到错误')
logging.critical('严重错误，无法运行')

在这里插入图片描述

在 basicConfig 中添加配置信息： filename(文件名称)、filemode(写入文件方式）,OK ,查看一下文件中的内容：

在这里插入图片描述

在运行文件的同级目录生成了 Zhang.log 日志文件现在这个方法虽然将日志打印到文件中了，但是在控制台中却没有了输出信息，那怎么才能既在控制台中显示，又能写入到日志中呢

强大的 logging

logging所提供的模块级别的日志记录函数是对logging日志系统相关类的封装

logging 模块提供了两种记录日志的方式：

使用logging提供的模块级别的函数
使用Logging日志系统的四大组件

这里提到的级别函数就是上面所用的 DEBGE、ERROR 等级别，而四大组件则是指 loggers、handlers、filters 和 formatters 这几个组件，下图简单明了的阐述了它们各自的作用：

在这里插入图片描述

日志器（logger）是入口，真正工作的是处理器（handler），处理器（handler）还可以通过过滤器（filter）和格式器（formatter）对要输出的日志内容做过滤和格式化等处理操作。

四大组件

下面介绍下与logging四大组件相关的类：Logger, Handler, Filter, Formatter。

在这里插入图片描述

Logger类

Logger 对象有3个工作要做：

1）向应用程序代码暴露几个方法，使应用程序可以在运行时记录日志消息；
2）基于日志严重等级（默认的过滤设施）或filter对象来决定要对哪些日志进行后续处理；
3）将日志消息传送给所有感兴趣的日志handlers。

Logger对象最常用的方法分为两类：配置方法和消息发送方法最常用的配置方法如下：

在这里插入图片描述

关于Logger.setLevel()方法的说明：

内建等级中，级别最低的是DEBUG，级别最高的是CRITICAL。例如setLevel(logging.INFO)，此时函数参数为INFO，那么该logger将只会处理INFO、WARNING、ERROR和CRITICAL级别的日志，而DEBUG级别的消息将会被忽略/丢弃。

logger对象配置完成后，可以使用下面的方法来创建日志记录：

在这里插入图片描述

那么，怎样得到一个Logger对象呢？一种方式是通过Logger类的实例化方法创建一个Logger类的实例，但是我们通常都是用第二种方式–logging.getLogger()方法。

logging.getLogger()方法有一个可选参数name，该参数表示将要返回的日志器的名称标识，如果不提供该参数，则其值为’root’。若以相同的name参数值多次调用getLogger()方法，将会返回指向同一个logger对象的引用。

关于logger的层级结构与有效等级的说明：
logger的名称是一个以'.'分割的层级结构，每个'.'后面的logger都是'.'前面的logger的children，例如，有一个名称为 foo 的logger，其它名称分别为 foo.bar, foo.bar.baz 和 foo.bam都是 foo 的后代。
logger有一个"有效等级（effective level）"的概念。如果一个logger上没有被明确设置一个level，那么该logger就是使用它parent的level;如果它的parent也没有明确设置level则继续向上查找parent的parent的有效level，依次类推，直到找到个一个明确设置了level的祖先为止。需要说明的是，root logger总是会有一个明确的level设置（默认为 WARNING）。当决定是否去处理一个已发生的事件时，logger的有效等级将会被用来决定是否将该事件传递给该logger的handlers进行处理。
child loggers在完成对日志消息的处理后，默认会将日志消息传递给与它们的祖先loggers相关的handlers。因此，我们不必为一个应用程序中所使用的所有loggers定义和配置handlers，只需要为一个顶层的logger配置handlers，然后按照需要创建child loggers就可足够了。我们也可以通过将一个logger的propagate属性设置为False来关闭这种传递机制。

Handler

Handler对象的作用是（基于日志消息的level）将消息分发到handler指定的位置（文件、网络、邮件等）。Logger对象可以通过addHandler()方法为自己添加0个或者更多个handler对象。比如，一个应用程序可能想要实现以下几个日志需求：

1）把所有日志都发送到一个日志文件中；
2）把所有严重级别大于等于error的日志发送到stdout（标准输出）；
3）把所有严重级别为critical的日志发送到一个email邮件地址。
这种场景就需要3个不同的handlers，每个handler复杂发送一个特定严重级别的日志到一个特定的位置。

一个handler中只有非常少数的方法是需要应用开发人员去关心的。对于使用内建handler对象的应用开发人员来说，似乎唯一相关的handler方法就是下面这几个配置方法：

在这里插入图片描述

需要说明的是，应用程序代码不应该直接实例化和使用Handler实例。因为Handler是一个基类，它只定义了素有handlers都应该有的接口，同时提供了一些子类可以直接使用或覆盖的默认行为。下面是一些常用的Handler：

在这里插入图片描述

Formater

Formater对象用于配置日志信息的最终顺序、结构和内容。与logging.Handler基类不同的是，应用代码可以直接实例化Formatter类。另外，如果你的应用程序需要一些特殊的处理行为，也可以实现一个Formatter的子类来完成。

Formatter类的构造方法定义如下：

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

该构造方法接收3个可选参数：

fmt：指定消息格式化字符串，如果不指定该参数则默认使用message的原始值
datefmt：指定日期格式字符串，如果不指定该参数则默认使用"%Y-%m-%d %H:%M:%S"
style：Python 3.2新增的参数，可取值为 ‘%’, ‘{‘和 ‘$’，如果不指定该参数则默认使用’%’

Filter

Filter可以被Handler和Logger用来做比level更细粒度的、更复杂的过滤功能。Filter是一个过滤器基类，它只允许某个logger层级下的日志事件通过过滤。该类定义如下：

class logging.Filter(name='')
    filter(record)

比如，一个filter实例化时传递的name参数值为’A.B’，那么该filter实例将只允许名称为类似如下规则的loggers产生的日志记录通过过滤：‘A.B’，‘A.B,C’，‘A.B.C.D’，‘A.B.D’，而名称为’A.BB’, 'B.A.B’的loggers产生的日志则会被过滤掉。如果name的值为空字符串，则允许所有的日志事件通过过滤。

filter方法用于具体控制传递的record记录是否能通过过滤，如果该方法返回值为0表示不能通过过滤，返回值为非0表示可以通过过滤。

说明:
如果有需要，也可以在filter(record)方法内部改变该record，比如添加、删除或修改一些属性。
我们还可以通过filter做一些统计工作，比如可以计算下被一个特殊的logger或handler所处理的record数量等。

实战演练

上面文绉绉的说了(复制/粘贴)那么多，现在应该动手实践了。

现在我需要既将日志输出到控制台、又能将日志保存到文件，我应该怎么办？

利用刚才所学的知识，我们可以构思一下：

在这里插入图片描述

看起来好像也不难，挺简单的样子，但是实际如此吗？

在实际的工作或应用中，我们或许还需要指定文件存放路径、用随机数作为日志文件名、显示具体的信息输出代码行数、日志信息输出日期和日志写入方式等内容。再构思一下：

在这里插入图片描述

具体代码如下：

import os
import logging
import uuid
from logging import Handler, FileHandler, StreamHandler
class PathFileHandler(FileHandler):
    def __init__(self, path, filename, mode='a', encoding=None, delay=False):
        filename = os.fspath(filename)
        if not os.path.exists(path):
            os.mkdir(path)
        self.baseFilename = os.path.join(path, filename)
        self.mode = mode
        self.encoding = encoding
        self.delay = delay
        if delay:
            Handler.__init__(self)
            self.stream = None
        else:
            StreamHandler.__init__(self, self._open())
class Loggers(object):
    # 日志级别关系映射
    level_relations = {
        'debug': logging.DEBUG, 'info': logging.INFO, 'warning': logging.WARNING,
        'error': logging.ERROR, 'critical': logging.CRITICAL
    }
    def __init__(self, filename='{uid}.log'.format(uid=uuid.uuid4()), level='info', log_dir='log',
                 fmt='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s'):
        self.logger = logging.getLogger(filename)
        abspath = os.path.dirname(os.path.abspath(__file__))
        self.directory = os.path.join(abspath, log_dir)
        format_str = logging.Formatter(fmt)  # 设置日志格式
        self.logger.setLevel(self.level_relations.get(level))  # 设置日志级别
        stream_handler = logging.StreamHandler()  # 往屏幕上输出
        stream_handler.setFormatter(format_str)
        file_handler = PathFileHandler(path=self.directory, filename=filename, mode='a')
        file_handler.setFormatter(format_str)
        self.logger.addHandler(stream_handler)
        self.logger.addHandler(file_handler)
if __name__ == "__main__":
    txt = "关注公众号【进击的 Coder】，回复『日志代码』可以领取文章中完整的代码以及流程图"
    log = Loggers(level='debug')
    log.logger.info(4)
    log.logger.info(5)
    log.logger.info(txt)

本人在使用代码后，将日志模块放入到程序中打包完成，但运行后，在exe的同级目录并没有产生 log 文件夹，而自己在测的时候是可以的，另外，代码中的 os.fspath 方法是在 Python 3.6 之后才有的最后，根据本人程序的需要，我对原作者的代码进行了修改

import os
import logging
import time
from logging import Handler, FileHandler, StreamHandler
class PathFileHandler(FileHandler):
    def __init__(self, path, filename, mode='a', encoding=None, delay=False):
        if not os.path.exists(path):
            os.mkdir(path)
        self.baseFilename = os.path.join(path, filename)
        self.mode = mode
        self.encoding = encoding
        self.delay = delay
        if delay:
            Handler.__init__(self)
            self.stream = None
        else:
            StreamHandler.__init__(self, self._open())
class Loggers(object):
    # 日志级别关系映射
    level_relations = {
        'debug': logging.DEBUG, 'info': logging.INFO, 'warning': logging.WARNING,
        'error': logging.ERROR, 'critical': logging.CRITICAL
    }
    def __init__(self, filename='{date}.log'.format(date = time.strftime("%Y-%m-%d_%H%M%S", time.localtime())), level='info', log_dir='log',
                 fmt='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s'):
        self.logger = logging.getLogger(filename)
        self.directory = os.path.join(os.getcwd(), log_dir)
        format_str = logging.Formatter(fmt)  # 设置日志格式
        self.logger.setLevel(self.level_relations.get(level))  # 设置日志级别
        stream_handler = logging.StreamHandler()  # 往屏幕上输出
        stream_handler.setFormatter(format_str)
        file_handler = PathFileHandler(path=self.directory, filename=filename, mode='a')
        file_handler.setFormatter(format_str)
        self.logger.addHandler(stream_handler)
        self.logger.addHandler(file_handler)
if __name__ == "__main__":
    txt = "将信息打印到日志文件中......"
    log = Loggers(level='debug')
    log.logger.info(4)
    log.logger.info(5)
    log.logger.info(txt)

文件保存后运行，运行结果如下图所示：

在这里插入图片描述

目录内生成指定的文件和文件夹，文件打开后可以看到里面的内容：

在这里插入图片描述

这样，以后在需要日志的时候，直接导入该日志模块。而且，可以根据自己的需要对模块进行修改。最关键的是，原作者对该模块设计时的思路。如果该文章有什么问题，或者侵权，请告知，我会进行修改。

到此这篇关于使用Python自定义创建的Log日志模块的文章就介绍到这了,更多相关Python自定义Log内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

使用Python自定义创建的Log日志模块

日志的作用

日志分类

日志输出

输出到控制台

那怎么去改变日志的级别呢？

将日志信息打印到文件中

强大的 logging

四大组件

Logger类

Handler

Formater

Filter

实战演练

您可能感兴趣的文章: