pallets-eco

flask-debugtoolbar

flask-debugtoolbar 是 Flask 调试工具栏扩展,在调试模式下向渲染页面注入侧边栏面板,展示请求、SQL 与模板等调试信息。

0.16.0
发布于
2024年9月28日
978
星标
39
下载
同步于
8 天前

作者已不再通过 GitHub Release 发版,但仓库仍在更新(最近提交 23 天前)。最新版本请到官网获取: 项目官网

最新版本

0.16.02024年9月28日 22:56
下载慢?可在上方随时切换镜像源

项目说明

项目概述

Flask-DebugToolbar 是一个 Flask 扩展,在调试模式下向渲染的 HTML 页面注入调试信息侧边栏,面板内容可配置。它是 django-debug-toolbar 的 Flask 移植版,属于 Pallets 社区生态项目,配置后随 flask run --debug 自动生效。

项目 内容
框架 Flask
语言 Python
类型 开发调试工具栏
许可 BSD-3-Clause

Flask 页面里直接看请求细节,调试少开一堆 print。

主要功能

  • 侧边栏注入:调试模式下自动注入到 Jinja 渲染页面
  • 可配置面板:按需启用信息面板
  • SQL 查看:配合 flask-sqlalchemy 观察查询
  • 模板信息:检查模板渲染上下文
  • 请求详情:查看当前请求的变量与会话
  • 开箱即用:初始化扩展即可,无需模板改动

适用人群

  • Flask 开发者
  • 后端工程师
  • 排查数据库查询问题的团队
  • Flask 项目维护者
  • 教学 Flask 的讲师

快速上手

  1. 安装 flask-debugtoolbar
pip install flask-debugtoolbar
  1. 初始化扩展
from flask import Flask
from flask_debugtoolbar import DebugToolbarExtension

app = Flask(__name__)
app.config['SECRET_KEY'] = '<replace with a secret key>'

toolbar = DebugToolbarExtension(app)
  1. 以调试模式启动应用
flask -A my_app run --debug
  1. 打开页面即可在侧边栏查看各面板信息

核心优势

  • 零模板改动:自动注入,无需修改业务模板
  • 生态归属:Pallets 官方社区生态项目,与 Flask 兼容性有保障
  • 配置简单:初始化一行即可使用

系统要求

项目 要求
框架版本 Flask
语言环境 Python
使用场景 仅建议开发环境启用

注意事项

  • 需要 SECRET_KEY:扩展依赖应用配置的 SECRET_KEY
  • 仅限调试模式:只在 debug 模式注入,生产环境不受影响
  • 面板来源:功能面板移植自 django-debug-toolbar,能力与之对应

历史版本

排序