Falcon v3.1.0 Documentation

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

摘要

文档介绍了Falcon框架的3.1.0版本更新，包括新功能、改进和修复。主要更新包括对ASGI和WebSocket的支持增强，错误处理和测试框架的改进，性能优化，以及兼容性提升。Falcon是一个高性能的Python Web框架，支持REST风格，适用于大规模应用后端和微服务。

AI总结

### Falcon 3.1.0 文档总结

#### 版本信息
- **版本**: Falcon 3.1.0
- **发布日期**: 2022年3月25日
- **主要贡献者**: Kurt Griffiths 等

---

#### 核心功能与改进
1. **新功能**:
- **ASGI 和 WebSocket 支持**: 增强了对 ASGI 和 WebSocket 的支持，提升了现代 Web 应用的开发能力。
- **新的 CLI 工具**: 新增 `falcon-print-routes` 工具，用于查看和分析应用的路由信息。
- **自定义请求和响应类**: 支持通过自定义 `Request` 和 `Response` 类来扩展功能。
- **JSON 和 XML 错误响应**: 支持通过 `set_error_serializer` 方法自定义错误响应的序列化格式。
- **`get_param_as_dict()`**: 新增方法，支持直接将查询参数解析为字典。
- **`uri_template` 属性**: 新增 `Request.uri_template` 属性，用于获取请求路径的 URI 模板。
- **`accept_ranges` 属性**: 新增 `Response.accept_ranges` 属性，便于设置 `Accept-Ranges` 头。
- **`falcon.testing.Cookie` 类**: 新增测试框架中的 Cookie 支持，便于模拟请求时处理 Cookie。

2. **性能与兼容性**:
- **WSGI 文件流支持**: 支持 `wsgi.filewrapper`，提升文件数据的传输效率。
- **Python 3.6 兼容性**: 解决了 Python 3.6 中字符串警告的问题。
- **Jython 支持**: 增加了对 Jython 2.7 的支持。

3. **错误修复**:
- **查询参数解析**: 修复了逗号分隔查询参数的解析问题，例如 `foo=1,,3` 现在返回 `[1, 3]`。
- **向前兼容性**: 解决了部分中间件与新版本不兼容的问题，通过 shim 保证旧版本的兼容性。
- **文档修复**: 修正了文档中代码示例的语法错误。

4. **测试与开发**:
- **Pytest 支持**: 测试框架新增对 Pytest 的支持，允许用户选择 `unittest` 或 `pytest` 进行测试。
- **`simulate_request()` 改进**: 新增 `json` 参数，支持直接从 JSON 序列化对象生成请求体。
- **`TestClient` 配置**: 支持设置默认请求头，提升了测试框架的灵活性。

5. **其他改进**:
- **中间件功能**: 新增中间件功能，取代了旧版的全局钩子（hooks）。
- **`append_header` 方法**: 支持通过 `falcon.API` 的 `append_header` 方法设置多个相同头值。
- **`req.host` 和 `req.subdomain`**: 新增属性，便于获取请求的主机名和子域名信息。
- **文档扩展**: 重新组织了 FAQ 并增加了更多内容，提升了文档的易用性。

---

#### 兼容性与限制
- **兼容性**: 保持了对 Python 3.5+ 和 PyPy 3.5+ 的支持。
- **许可**: 采用 Apache 2.0 许可证，允许用户在商业项目中使用。

---

#### 贡献者
感谢众多贡献者为 Falcon 3.1.0 的开发和改进提供了支持，包括 GriffGeorge、hynek、kgriffs 等。

---

#### 总结
Falcon 3.1.0 是一个功能丰富且稳定的版本，新增了对 ASGI 和 WebSocket 的支持，优化了性能和兼容性，并修复了多项用户反馈的问题。对于开发者而言，这是一个高效、灵活且易于扩展的 Web 框架。