Python--Logging的详细用法

python的logging模块用于记录和管理日志信息。他是python标准库的一部分，用于帮助开发者实施高效的日志记录，以便在开发、测试和生产环境中更好地理解和排查问题。杠杆接触logging模块的人可能比较困惑它的使用方法，我这里根据我的理解，向初学者介绍一下logging的使用方法，希望能够帮助到大家

1. 最简单的使用方式——logging.basicConfig方法

如何快速使用logging记录和管理日志信息呢？只需要三步，先给出代码：

import logging

# 第一步：使用basicConfig()方法配置日志格式
logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s: %(message)s', filename='test.log', filemode='a')

# 第二步：创建日志记录器
console_logger = logging.getLogger('func')

# 第三步：打印日志
console_logger.info('Func is normal!')

这里分别解释一下：

1.1  basicConfig方法

logging.basicConfig()方法用于配置Python的日志系统。它允许你定义全局的日志行为，包括日志级别、输出格式、输出位置等。一般用于程序的初始化部分调用。

import logging

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s: %(message)s', filename='test.log', filemode='a')

level	设置日志几倍，只有达到或超过该级别的日志才会被记录。如，设置为logging.DEBUG将记录所有级别的日志。
format	定义日志的输出格式。在这个实例中, %(asctime)s 表示时间戳，%(levelname)s表示日志级别，%(message)s表示消息内容。可以根据需要自定义格式
filename	指定日志输出到文件的文件名。如果不指定文件名，则日志将输出到控制台
filemode	指定日志文件的打开模式，可选择的值为‘a’(追加），‘w’覆盖

注意事项：

• 该方法通常在应用程序的入口处，以确保一次性配置整个日志系统；
• 在多线程或者多进程应用程序中，要谨慎使用该方法，以避免竞态条件；
• 在生产环境中，一般不建议将日志级别设置为DEBUG，来减少日志量

 1.2 getLogger()方法

logging.getLogger()方法是Python用于获取日志记录器的函数。每个日志记录器都有一个名称，通常使用模块名或其他标识符命名。基本语法如下：

import logging

my_logger = logging.getLogger(name)

name: 指定要获取的日志记录器的名称，通常使用模块名作为名称，这有助于组织和识别不同模块的日志。

重要事项：

• 获取相同名称的日志记录器对象会返回相同的实例；
• 可以在不同的模块中多次调用getLogger()来获取相同名称的日志记录器，这不会创建多个实例，而是返回相同的实例。

1.3 logging的级别

logging支持不同的日志级别，包括debug、info、warning、error和critical，开发者可以更具需要选择适当的级别来记录信息。

2. 进阶使用

如果我们想要创建不同的日志处理程序，比如我既想把日志传到控制器上，又想把日志传到文件中。或者说，我想把不同的模块的日志记录到不同的文件中，那么使用basicConfig()方法就无法做到这些了。要实现以上的功能，先了解logging模块中其他的方法和类。

2.1 Formatter类

logging.Formatter()用于定义日志消息的输出格式。它允许你以自定义的方式格式化日志消息，以满足应用程序的需求。一般的使用方式如下：

import logging

#创建Formatter对象
formatter = logging.Formatter(fmt='%(asctime)s %(levelname)s:%(message)s', datefmt='%Y-%m-%d %H:%M:%S', style='%')

在上面的示例中，创建了一个简单的Formatter对象，fmt参数定义了日志消息包括时间戳、日志级别和消息内容。其他可用于格式化的选项如下：

%(asctime)s	时间戳
%(name)s	记录器名称
%(levelname)s	日志级别名称
%(funcName)s	包含当前日志记录的函数名
%(thread)d	线程ID
%(threadName)s	线程名
%(filename)s	包含当前日志记录文件的源文件名

2.2 Handle类

在logging模块中，有多个类可以用来创建不同类型的处理程序（Handler objects），用于将日志消息发送到不同的目标。以下是常用的能够创建处理程序对象的类。

2.2.1 logging.StreamHandler

这是常用的一个处理程序，它的作用就是将日志消息发送到标准输出流（通常是控制台，console）。这对于在控制台上查看应用程序的日志非常有用

import logging

# 创建处理对象，将日志消息发送到标准输出流
console_handler = logging.StreamHandler()

2.2.2 logging.FileHandle

该方法创建一个处理程序，将日志消息写到文件中。可以指定文件名和可选的文件方式。这同样也是常用的一种处理方法。

import logging

# 创建处理对象，将日志消息发送到文件
file_handler = logging.FileHandler(filename='func.log', mode='a', encoding='utf-8')

这里面有三个参数，filename指定发送日志信息的文件夹，mode指定文件的写入方式，encoding指定编码方式

2.2.3 logging.handlers.RotatingFileHandle

创建一个处理程序，用于将日志消息写入到滚动日志文件中，允许在达到一定大小时备份文件并创建新文件。

from logging.handlers import RotatingFileHandler

rotating_handler = RotatingFileHandler('func.log', maxBytes=1024, backupCount=3)

2.2.4 logging.handlers.TimedRotatingFileHandler

该方法创建一个处理程序，用于将日志消息写入到基于时间的滚动日志文件中，允许按照一定的时间间隔备份文件。

from logging.handlers import TimedRotatingFileHandler

timed_rotating_handle = TimedRotatingFileHandler('func.log', when='midnight', interval=1, backupCount=7)

2.3 输入日志到不同的处理程序

下面的代码实现将日志输出到不同的处理程序（文件、监控台）

import logging

# 实例化日志记录器
logger = logging.getLogger('func')

# 设置日志记录器的打印等级
logger.setLevel(logging.INFO)

# 创建Formatter对象
formatter = logging.Formatter(fmt='%(asctime)s %(levelname)s:%(message)s', datefmt='%Y-%m-%d %H:%M:%S', style='%')

# 创建处理对象
# 文件处理对象
file_handle = logging.FileHandler(filename='func.log', mode='a', encoding='utf-8')
# 控制器处理对象
console_handle = logging.StreamHandler()

# 给不同的处理对象添加log输出格式
file_handle.setFormatter(formatter)
console_handle.setFormatter(formatter)


# 给日志记录器添加处理对象
logger.addHandler(file_handle)
logger.addHandler(console_handle)

def func():
    logger.info('This is a func!')

if __name__ == '__main__':
    func()