Python Python Logging（函数名、文件名、行号）使用单个文件

在本文中，我们将介绍如何使用Python的日志记录模块(logging)来记录函数名、文件名和行号，并将所有日志信息写入一个单独的文件中。日志记录是开发过程中非常重要的一个环节，它可以帮助我们追踪和调试代码，查找错误和异常，并对系统的运行状态进行监控和分析。

阅读更多：Python 教程

1. 设置日志记录

首先，我们需要导入Python的logging模块，并进行一些基本的配置。我们可以使用basicConfig()函数来配置日志输出的格式、级别和目标文件。

import logging

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

在上面的例子中，我们指定了日志输出的文件名为’log.txt’，并将文件模式设置为’w’，表示每次运行程序时都会重新写入日志文件。我们还指定了日志格式，使用了%(asctime)s表示日志记录的时间，%(levelname)s表示日志的级别(INFO, WARNING, ERROR等)，%(message)s表示日志的具体内容。最后，我们将日志的级别设置为INFO，表示只记录INFO及以上级别的日志。

2. 添加自定义函数

为了能够记录函数名、文件名和行号，我们需要添加一个自定义的日志记录函数。下面是一个示例：

def log_function():
    frame_records = inspect.stack()[1]
    frame = frame_records[0]
    info = inspect.getframeinfo(frame)
    logging.info(f"Function: {info.function}, File: {os.path.basename(info.filename)}, Line: {info.lineno}")

def foo():
    log_function()
    logging.info("This is function foo")

foo()

在上面的例子中，我们定义了一个名为log_function()的函数，用于记录函数名、文件名和行号。我们使用inspect模块的stack()函数获取当前运行的堆栈信息，然后通过getframeinfo()函数获取调用该函数的信息。最后，我们使用logging.info()函数记录日志。

在示例中，我们定义了一个名为foo()的函数，并在函数内部调用了log_function()函数，并记录了一条日志。当我们运行这段代码后，会生成一个名为’log.txt’的日志文件，并包含以下内容：

2021-08-01 15:00:00,000 - INFO - Function: foo, File: example.py, Line: 17
2021-08-01 15:00:00,001 - INFO - This is function foo

3. 日志级别

Python的logging模块提供了多个日志级别，我们可以根据具体的需求选择适合的级别。常用的日志级别包括：

DEBUG：详细的调试信息
INFO：一般的信息记录
WARNING：警告信息
ERROR：错误信息
CRITICAL：严重错误信息

我们可以通过设置不同的日志级别来控制日志记录的详细程度。例如，如果我们将日志级别设置为WARNING，那么只有警告信息和以上级别的日志会被记录。

logging.basicConfig(level=logging.WARNING)

4. 使用日志记录调试代码

日志记录在调试代码和查找错误方面非常有用。我们可以在代码中添加日志记录语句，以帮助我们追踪代码的执行过程和变量的取值。例如：

def divide(a, b):
    logging.debug(f"Dividing {a} by {b}")
    result = a / b
    logging.debug(f"Result: {result}")
    return result

在上面的例子中，我们在divide()函数内部添加了两条日志记录语句。这样，当我们调用该函数时，日志文件中会记录我们执行该函数时的参数和结果。

5. 日志的格式化输出

我们可以通过配置logging模块来改变日志的输出格式。Python的logging模块默认使用的是包含时间、级别和日志内容的简单格式。但如果我们想要自定义日志的输出格式，可以使用Formatter类来完成。

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
handler = logging.StreamHandler()
handler.setFormatter(formatter)
logging.getLogger().addHandler(handler)

在上面的例子中，我们使用Formatter类创建了一个自定义的日志格式，包含时间、级别和日志内容。然后，我们创建了一个StreamHandler对象，并将其设置为日志记录的处理器。最后，我们使用getLogger()函数获取根日志记录器，并添加了刚刚创建的处理器。

6. 使用单个文件记录多个模块的日志

在实际项目中，通常会有多个模块需要记录日志。为了方便管理，我们可以将所有的日志信息记录在一个统一的文件中。

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

在上面的例子中，我们使用了相同的日志文件名，并将文件模式设置为’w’，表示每次运行程序都会重新写入日志文件。

7. 日志的分级输出

除了将所有日志信息写入一个文件，我们还可以将日志信息按照不同的级别分别输出到不同的文件中。这样可以方便我们根据日志级别查找和分析特定类型的日志信息。

info_handler = logging.FileHandler('info.log')
info_handler.setLevel(logging.INFO)
info_handler.setFormatter(formatter)

在上面的例子中，我们创建了一个FileHandler对象，并将其设置为INFO级别的处理器。然后，我们将格式化输出器(formatter)设置到处理器中，并将处理器添加到根日志记录器中。

总结

在本文中，我们介绍了如何使用Python的logging模块来记录函数名、文件名和行号，并将所有日志信息写入一个单独的文件中。我们学习了如何配置日志记录，添加自定义函数，设置日志级别，使用日志记录调试代码，自定义日志的输出格式，以及将日志信息记录在单个文件和分级输出到不同文件的方法。通过合理利用日志记录，我们可以更好地调试和分析代码，提高开发效率。希望本文对你理解和使用Python的日志记录模块有所帮助。

详细代码请见：Python Logging 使用单个文件记录函数名、文件名和行号