Falcon v3.0.1 Documentation

• 语言: 英语
• 格式: .pdf
• 来源: falcon.readthedocs.io

摘要

Falcon 3.0.1是一个针对Falcon框架的修复版本，主要修复了与ASGI和WSGI兼容性相关的bug，并改进了错误处理和中间件功能。该版本还引入了对WebSocket的支持、更高效的请求处理机制以及对多种Python版本的兼容性优化。文档详细介绍了新功能、变更内容以及如何迁移现有应用以充分利用新版本的功能。

AI总结

《Falcon v3.0.1 Documentation》是Falcon框架的官方文档，主要介绍了Falcon 3.0.1版本的更新内容、功能特性以及使用指南。以下是文档的核心总结：

---

### **Falcon 框架概述**
- **简介**
Falcon 是一个高性能的 Python Web 框架，专注于构建大规模应用后端和微服务。它支持 ASGI、WSGI 和 WebSocket，鼓励 REST 风格，并注重高效性和扩展性。

- **核心特性**
- 支持异步（ASGI 和 asyncio）
- 支持 WSGI 和 WebSocket
- 稳定且向后兼容的接口
- 高效的路由和请求处理
- 支持自定义请求和响应类
- 支持中间件和钩子（hooks）
- 严格的 HTTP RFC 遵从性
- 支持 XML 和 JSON 错误响应
- 支持测试框架（WSGI/ASGI）

- **支持的平台**
- Python 3.8 和 3.9 全面支持
- Python 3.6+ 支持 ASGI（WSGI 仍支持 Python 3.5+）
- Python 3.5 支持已弃用
- 不再支持 Python 2 和 PyPy 2.7

---

### **Falcon 3.0.1 更新内容**
- **版本说明**
Falcon 3.0.1 是一个 minor 版本更新，修复了 3.0.0 中未被发现的两个问题。

- **修复内容**
1. **api_helpers 模块**
该模块被重命名为 app_helpers，但在未宣布重大变更的情况下被移除，现重新加入但已标记为弃用，将在未来版本中移除。
2. **ASGI HTTP 头编码问题**
修复了 ASGI HTTP 头的编码问题，现在使用 ISO-8859-1 而不是 UTF-8，以兼容 WSGI 应用。

- **贡献者**
感谢 CaselIT 和 vytas7 对此版本的贡献。

---

### **Falcon 3.0.0 更新内容**
- **版本说明**
Falcon 3.0 是一个 major 版本，引入了 ASGI 支持、改进的错误处理、新的中间件功能，以及对社区和文档的重大改进。

- **新增功能**
1. **ASGI 支持**
- 增加了对 ASGI 的支持，支持 asyncio 和 WebSocket。
2. **错误处理**
- 支持 XML 错误响应。
- 新增 `set_error_serializer` 方法以自定义错误序列化。
3. **中间件与钩子**
- 弃用全局钩子，新增中间件功能。
4. **请求处理**
- 支持自定义请求和响应类。
- 新增 `req.context` 属性用于共享上下文信息。
- 新增 `append_header` 方法支持设置多个头。
5. **测试框架**
- 支持 pytest 和 unittest 风格测试。
- 新增 `falcon-print-routes` CLI 工具。
6. **其他改进**
- 支持更广泛的查询参数字符。
- 改进文档和测试覆盖率。

- **Breaking Changes**
- 弃用了 `OptionalRepresentation` 和 `NoRepresentation` 类。
- 修改了 `falcon.testing.create_environ()` 的默认值和参数名称。
- 不再支持 Python 2 和 PyPy 2.7。

---

### **Falcon 的优势**
- **性能**
Falcon 是同类框架中速度最快的之一，支持 PyPy 和 Cython 加速。
- **可靠性**
严格遵循语义化版本控制（SemVer），尽量减少-breaking changes。
- **调试性**
避免魔法全局状态，便于调试和跟踪。
- **灵活性**
允许开发者自定义路由、中间件和错误处理。

---

### **文档结构**
文档内容分为以下几个部分：
1. **用户指南**
- 入门、安装、快速上手、教程（WSGI 和 ASGI）、技巧、FAQ。
2. **部署指南**
- 部署到 Linux 的分步指南（使用 NGINX 和 uWSGI）。
3. **社区指南**
- 获取帮助、贡献代码、参与社区。
4. **框架参考**
- 核心类（App、Request、Response）、WebSocket（仅 ASGI）、中间件、CORS、路由等。
5. **变更日志**
- 详细记录每个版本的新增功能、修复和-breaking changes。

---

### **总结**
Falcon 3.0.1 是一个修复版本，重点解决了 3.0.0 中的遗留问题。而 Falcon 3.0 则是一个重大版本，引入了 ASGI 支持、改进了错误处理，并增强了框架的灵活性和性能。Falcon 以其高性能、可靠性和灵活性，成为构建大规模应用后端和微服务的理想选择。