浅析Flask如何使用日志功能
作者:麦田里走一夜 时间:2023-06-17 17:18:21
在Flask中配置日志
在Flask应用程序中,可以使用Python的标准logging模块来配置日志记录。以下是一个简单的示例,在其中将日志输出到文件和控制台:
import logging
from logging.handlers import RotatingFileHandler
from flask import Flask
app = Flask(__name__)
# 配置日志记录
handler = RotatingFileHandler('app.log', maxBytes=10000, backupCount=1)
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s %(levelname)s: %(message)s [in %(pathname)s:%(lineno)d]')
handler.setFormatter(formatter)
app.logger.addHandler(handler)
if not app.debug:
# 如果不处于调试模式,将日志输出到 stdout
stream_handler = logging.StreamHandler()
stream_handler.setLevel(logging.INFO)
app.logger.addHandler(stream_handler)
在此示例中,创建了一个名为app.log的旋转文件处理器,并将其绑定到Flask应用程序的记录器上。如果不处于调试模式,则还将创建一个流处理器,并将其绑定到记录器上,以便将日志记录输出到控制台。
要在应用程序中记录日志,可以使用记录器对象,例如:
@app.route('/')
def index():
app.logger.info('Processing request for index page')
return 'Hello, world!'
在此示例中,将使用info()方法记录一条信息级别的日志,指示正在处理针对主页的请求。
需要注意的是,配置日志记录是一个高度可定制的过程,可以根据自己的需求添加或删除处理程序、过滤器等。此示例仅提供了一个简单的起点,以便您开始进行自定义配置。
在Flask应用程序的其它页面中使用logging
在Flask应用程序的其它页面中使用logging,可以通过获取当前应用程序的日志对象来记录信息。可以使用以下代码获取日志对象:
导入日志对象
import logging
logger = logging.getLogger(__name__)
此代码将创建一个名为__name__的Logger对象,该名称将与当前模块的名称相同。然后,您可以使用该Logger对象记录消息,例如:
记录日志
from flask import render_template
from app import logger
@app.route('/about')
def about():
logger.info('Rendering about page')
return render_template('about.html')
在此示例中,当路由处理/about路径时,将记录一条信息级别的日志,并渲染about.html模板。
需要注意的是,与前面提到的Flask应用程序的记录器不同,此处创建的记录器仅用于当前模块或蓝图的日志记录。如果要在整个应用程序中共享日志配置和处理程序,则应使用前面提到的应用程序记录器。
模块中使用app中的日志记录器
若您有一个已经创建并配置好的app对象,并且想在另一个模块中使用相同的日志记录器,则可以通过Flask提供的current_app方法来获得应用程序实例,进而获取该应用程序的记录器对象。以下是一个简单的示例:
app中定义日志记录器
# app.py
import logging
from flask import Flask
app = Flask(__name__)
# 配置日志记录
handler = logging.StreamHandler()
handler.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
app.logger.addHandler(handler)
在此示例中,创建了一个名为app的Flask应用程序,并将输出到标准输出的记录器添加到其logger对象中。
在模块中使用日志记录器
# my_module.py
import logging
from flask import current_app
logger = logging.getLogger(__name__)
def do_something():
# 获取当前应用程序的记录器对象
app_logger = current_app.logger
logger.info('Starting to do something...')
# 进行一些操作
app_logger.info('Doing something now...')
logger.info('Finished doing something.')
在这个例子里,我们创建了另一个模块my_module.py,其中包含一个do_something()函数。该函数会首先通过获取当前应用程序的logger对象来获取应用程序的记录器对象。然后,在进行一些操作之前和之后使用logger对象记录信息,同时在操作期间使用应用程序的logger对象记录信息。
需要注意的是,要使用current_app方法,必须要在Flask应用程序上下文中进行操作。换句话说,您需要确保该方法在请求上下文或应用上下文中被调用。
来源:https://blog.csdn.net/all_night_in/article/details/130778768