欢迎使用 Flask¶
欢迎使用 Flask 文档。使用 安装 开始,然后使用 快速入门 获得概述。还有一个更详细的 教程,展示如何使用 Flask 创建一个小型但完整的应用程序。常见模式在 Flask 模式 部分中进行了描述。文档的其余部分详细描述了 Flask 的每个组件,并在 API 部分中提供了完整参考。
Flask 依赖于 Werkzeug WSGI 工具包、Jinja 模板引擎和 Click CLI 工具包。在查找信息时,请务必查看它们的文档以及 Flask 的文档。
用户指南¶
Flask 提供了配置和约定,以及合理的默认值,以便开始使用。本部分文档解释了 Flask 框架的不同部分,以及如何使用、自定义和扩展它们。除了 Flask 本身之外,还可以寻找社区维护的扩展,以添加更多功能。
安装
Python 版本
依赖项
虚拟环境
安装 Flask
快速入门
最小应用程序
调试模式
HTML 转义
路由
静态文件
渲染模板
访问请求数据
重定向和错误
关于响应
会话
消息闪烁
日志记录
连接到 WSGI 中间件
使用 Flask 扩展
部署到 Web 服务器
教程
项目布局
应用程序设置
定义和访问数据库
蓝图和视图
模板
静态文件
博客蓝图
使项目可安装
测试覆盖率
部署到生产环境
继续开发!
模板
Jinja 设置
标准上下文
控制自动转义
注册过滤器
上下文处理器
流式传输
测试 Flask 应用程序
识别测试
固定装置
使用测试客户端发送请求
跟踪重定向
访问和修改会话
使用 CLI 运行器运行命令
依赖于活动上下文的测试
处理应用程序错误
错误日志记录工具
错误处理程序
自定义错误页面
蓝图错误处理程序
将 API 错误作为 JSON 返回
日志记录
调试
调试应用程序错误
在生产环境中
内置调试器
外部调试器
日志记录
基本配置
将电子邮件错误发送给管理员
注入请求信息
其他库
配置处理
配置基础知识
调试模式
内置配置值
从 Python 文件配置
从数据文件配置
从环境变量配置
配置最佳实践
开发/生产
实例文件夹
信号
核心信号
订阅信号
创建信号
发送信号
信号和 Flask 的请求上下文
基于装饰器的信号订阅
基于类的视图
基本可重复使用视图
URL 变量
视图生命周期和 self
视图装饰器
方法提示
方法分派和 API
应用程序结构和生命周期
应用程序设置
提供应用程序
如何处理请求
应用程序上下文
上下文的用途
上下文的生命周期
手动推送上下文
存储数据
事件和信号
请求上下文
上下文的用途
上下文的生命周期
手动推送上下文
上下文如何工作
回调和错误
代理说明
使用蓝图的模块化应用程序
为什么使用蓝图?
蓝图的概念
我的第一个蓝图
注册蓝图
嵌套蓝图
蓝图资源
构建 URL
蓝图错误处理程序
扩展
查找扩展
使用扩展
构建扩展
命令行界面
应用程序发现
运行开发服务器
打开 Shell
dotenv 中的环境变量
virtualenv 中的环境变量
自定义命令
插件
自定义脚本
PyCharm 集成
开发服务器
命令行
在代码中
使用 Shell
命令行界面
创建请求上下文
在请求之前/之后触发
进一步改善 Shell 体验
Flask 的模式
大型应用程序作为包
应用程序工厂
应用程序调度
使用 URL 处理器
在 Flask 中使用 SQLite 3
在 Flask 中使用 SQLAlchemy
上传文件
缓存
视图装饰器
使用 WTForms 进行表单验证
模板继承
消息闪烁
JavaScript、fetch 和 JSON
延迟加载视图
使用 MongoEngine 的 MongoDB
添加 favicon
流式传输内容
延迟请求回调
添加 HTTP 方法覆盖
请求内容校验和
使用 Celery 的后台任务
Flask 的子类
单页面应用程序
安全注意事项
跨站脚本 (XSS)
跨站请求伪造 (CSRF)
JSON 安全
安全标头
复制/粘贴到终端
部署到生产环境
自托管选项
托管平台
使用 async 和 await
性能
后台任务
何时使用 Quart
扩展
其他事件循环
API 参考¶
如果您正在寻找有关特定函数、类或方法的信息,本部分文档适合您。
API
应用程序对象
蓝图对象
传入请求数据
响应对象
会话
会话接口
测试客户端
测试 CLI 运行器
应用程序全局变量
有用的函数和类
消息闪烁
JSON 支持
模板渲染
配置
流助手
有用的内部函数
信号
基于类的视图
URL 路由注册
视图函数选项
命令行界面
其他说明¶
Flask 中的设计决策
显式应用程序对象
路由系统
一个模板引擎
“micro”是什么意思?
线程局部变量
Async/await 和 ASGI 支持
Flask 是什么,Flask 不是什么
Flask 扩展开发
命名
扩展类和初始化
添加行为
配置技术
请求期间的数据
视图和模型
推荐的扩展指南
如何为 Flask 做出贡献
支持问题
报告问题
提交补丁
BSD-3-Clause 许可证
更改
版本 3.0.2
版本 3.0.1
版本 3.0.0
版本 2.3.3
版本 2.3.2
版本 2.3.1
版本 2.3.0
版本 2.2.5
版本 2.2.4
版本 2.2.3
版本 2.2.2
版本 2.2.1
版本 2.2.0
版本 2.1.3
版本 2.1.2
版本 2.1.1
版本 2.1.0
版本 2.0.3
版本 2.0.2
版本 2.0.1
版本 2.0.0
版本 1.1.4
版本 1.1.3
版本 1.1.2
版本 1.1.1
版本 1.1.0
版本 1.0.4
版本 1.0.3
版本 1.0.2
版本 1.0.1
版本 1.0
版本 0.12.5
版本 0.12.4
版本 0.12.3
版本 0.12.2
版本 0.12.1
版本 0.12
版本 0.11.1
版本 0.11
版本 0.10.1
版本 0.10
版本 0.9
版本 0.8.1
版本 0.8
版本 0.7.2
版本 0.7.1
版本 0.7
版本 0.6.1
版本 0.6
版本 0.5.2
版本 0.5.1
版本 0.5
版本 0.4
版本 0.3.1
版本 0.3
版本 0.2
版本 0.1