欢迎来到 Flask 的世界¶

欢迎来到 Flask 的文档。你可以从安装入手，然后阅读 Quickstart 来了解基本概念。还有一个包含更多细节的教程介绍如何用 Flask 创建一个很小但是完整的程序。一般的开发模式可以在 Patterns for Flask 章节找到。剩下的文档详细的介绍了 Flask 的每一个组成部件，其中 API 章节包括完整的 API 参考信息。

Flask 依赖 Jinja 模板引擎和 Werkzeug WSGI 工具集。这些库的文档如下：

Jinja 文档
Werkzeug 文档

用户指南¶

这部分的文档大部分是独立章节，以一些关于 Flask 的背景信息开始，然后重点介绍如何使用 Flask 一步步进行 Web 开发。

前言
- “微”的含义
- 配置与惯例
- 与 Flask 共同成长
给资深程序员的序言
- Flask 的线程局部对象
- 谨慎地进行 Web 应用开发
安装
- Python 版本
- 依赖
- 虚拟环境
- 安装 Flask
Quickstart
- A Minimal Application
- What to do if the Server does not Start
- Debug Mode
- HTML Escaping
- Routing
- Static Files
- Rendering Templates
- Accessing Request Data
- Redirects and Errors
- About Responses
- Sessions
- Message Flashing
- Logging
- Hooking in WSGI Middleware
- Using Flask Extensions
- Deploying to a Web Server
教程
- 项目结构
- 应用设置
- 定义并访问数据库
- 蓝图和视图
- 模板
- 静态文件
- 博客蓝图
- 让项目可安装
- 测试覆盖率
- 部署到生产环境
- 继续开发！
Templates
- Jinja Setup
- Standard Context
- Controlling Autoescaping
- Registering Filters
- Context Processors
Testing Flask Applications
- Identifying Tests
- Fixtures
- Sending Requests with the Test Client
- Following Redirects
- Accessing and Modifying the Session
- Running Commands with the CLI Runner
- Tests that depend on an Active Context
Handling Application Errors
- Error Logging Tools
- Error Handlers
- Custom Error Pages
- Blueprint Error Handlers
- Returning API Errors as JSON
- Logging
- Debugging
Debugging Application Errors
- In Production
- The Built-In Debugger
- External Debuggers
日志
- 基本配置
- 将错误信息通过电子邮件发送给管理员
- 注入请求信息
- 其他库
Configuration Handling
- Configuration Basics
- Environment and Debug Features
- Builtin Configuration Values
- Configuring from Python Files
- Configuring from Data Files
- Configuring from Environment Variables
- Configuration Best Practices
- Development / Production
- Instance Folders
Signals
- Subscribing to Signals
- Creating Signals
- Sending Signals
- Signals and Flask’s Request Context
- Decorator Based Signal Subscriptions
- Core Signals
Pluggable Views
- Basic Principle
- Method Hints
- Method Based Dispatching
- Decorating Views
- Method Views for APIs
应用上下文
- 上下文的目的
- 上下文的生命周期
- 手动推入一个上下文
- 存储数据
- 事件与信号
请求上下文
- 上下文的目的
- 上下文的生命周期
- 手动推入上下文
- 上下文的运作原理
- 回调与错误
- 在错误时保留上下文
- 代理对象的注意事项
使用蓝图模块化应用
- 为何要使用蓝图？
- 蓝图的理念
- 第一个蓝图
- 注册蓝图
- 嵌套的蓝图
- 蓝图资源
- 构造 URL
- 蓝图的错误处理器
Extensions
- Finding Extensions
- Using Extensions
- Building Extensions
Command Line Interface
- Application Discovery
- Run the Development Server
- Open a Shell
- Environments
- Debug Mode
- Environment Variables From dotenv
- Environment Variables From virtualenv
- Custom Commands
- Plugins
- Custom Scripts
- PyCharm Integration
Development Server
- Command Line
- In Code
使用 Shell
- 命令行接口
- 创建一个请求上下文
- 触发请求前/后的动作
- 提升 Shell 使用体验
Patterns for Flask
- Large Applications as Packages
- Application Factories
- Application Dispatching
- Using URL Processors
- Deploying with Setuptools
- Deploying with Fabric
- Using SQLite 3 with Flask
- SQLAlchemy in Flask
- Uploading Files
- 缓存
- View Decorators
- Form Validation with WTForms
- Template Inheritance
- Message Flashing
- AJAX with jQuery
- Lazily Loading Views
- MongoDB with MongoEngine
- 添加 Favicon
- Streaming Contents
- Deferred Request Callbacks
- Adding HTTP Method Overrides
- Request Content Checksums
- Celery Background Tasks
- Subclassing Flask
- Single-Page Applications
部署方式
- 托管服务
- 自建服务
大型应用
- 阅读源代码
- 钩子与扩展
- 子类
- 用中间件包装
- 派生
- 专业级的可扩展性
- 与社区沟通
Using async and await
- Performance
- Background tasks
- When to use Quart instead
- Extensions
- Other event loops

API 参考¶

如果你想找关于某个特定函数、类或方法的信息，那么这部分文档就是为你准备的。

附加笔记¶

如果你感兴趣的话，这里有一些设计笔记、法律信息和变更日志（changelog）。

Design Decisions in Flask
HTML/XHTML FAQ
安全注意事项
Flask Extension Development
如何向 Flask 贡献代码
License
- BSD-3-Clause Source License
- Artwork License
Changes