Falcon v3.1.1-b1 Documentation

语言	格式	评分
英语	.pdf	3
摘要
文档介绍了Falcon框架的3.1.1b1版本，新增了对WSGI和ASGI的支持，改进了错误处理机制，添加了新的中间件功能，并优化了性能。文档还详细说明了与前一版本的兼容性问题及重大变更，包括对Python 3.4的支持终止和对Python 3.8、3.9的支持增强。
AI总结
### Falcon v3.1.1-b1 文档总结 #### 1. 版本概述 - 发布日期: 2022年11月9日 - 主要贡献者: Kurt Griffiths et al. --- #### 2. 核心功能更新 1. 新功能与改进: - WSGI支持: Falcon现支持`wsgi.filewrapper`，允许使用文件对象高效传输数据。 - 表单解析: 自动解析`application/x-www-form-urlencoded`请求内容，表单字段添加到`req.params`。 - 自定义请求与响应: 支持自定义`Request`和`Response`类，可通过继承`falcon.API`指定类型。 - 中间件功能: 新增中间件功能，取代了之前的全局钩子（hooks），建议尽快迁移。 - 上下文共享: 新增`req.context`属性，用于在请求中共享上下文信息。 - 错误处理: 支持XML格式的错误响应，新增`set_error_serializer`方法，允许自定义错误序列化器。 - 测试框架改进: `testing.TestBase`支持Python 3k，`simulate_request`新增`decode`参数以自动解码响应体。 - 查询参数处理: 支持更多字符，改进CSV样式的查询参数解析。 - ASGI支持: Falcon 3.0引入了基于ASGI的异步支持和WebSocket功能。 2. 性能与兼容性: - Python版本支持: - 完全支持Python 3.8和3.9。 - Python 3.6及以上版本支持ASGI，3.5仅限WSGI。 - Python 3.4及更低版本不再支持。 - CPython 2.7和PyPy2.7支持已移除。 - Wsgi/Asgi统一: 修复了Wsgi和Asgi之间的差异，提升了兼容性。 3. Breaking Changes: - 弃用功能: - `OptionalRepresentation`和`NoRepresentation`类被弃用，所有`HTTPError`子类现默认支持媒体类型表示。 - `get_http_status()`方法被弃用，不再接受浮点数。 - 接口变更: - `falcon.testing.create_environ()`函数的参数`protocol` renamed to `http_version`，`app` renamed to `root_path`。 - `BoundedStream`的`writeable`属性 renamed为`writable`。 - 错误处理: - 如果错误处理程序抛出非`HTTPStatus`或`HTTPError`异常，中间件的`process_response`方法将不再执行，异常直接传递给Web服务器。 - 中间件迁移: 建议迁移至新中间件接口，避免性能开销。 4. 其他改进: - 文档优化: FAQ扩展，文档样式更新以匹配官网。 - 测试支持: 新增pytest支持，`TestClient`可配置默认头。 - 工具新增: 新增命令行工具`falcon-print-routes`，用于查看路由信息。 --- #### 3. 已知问题与修复 1. 已修复问题: - 解决了前向头中包含引号和逗号的解析问题。 - 修复了JSON处理中的Unicode警告。 - 解决了`simulate_request`方法中参数传递的问题。 2. 后续计划: - 下一版本（0.3）计划进一步模块化路由机制，并修复`set_stream`与Cookie设置的兼容性问题。 --- #### 4. 重要注意事项 - 迁移建议: - 尽快迁移至新中间件接口，避免性能影响。 - 确保测试覆盖所有可能的Breaking Changes。 - 检查依赖的Python版本和ASGI/WSGI兼容性。 - 社区支持: - 鼓励用户参与文档完善和功能贡献，通过`falconry/user`或GitHub反馈问题。 --- #### 5. 总结 Falcon 3.1.1-b1 是一次重要的版本更新，新增了多项功能和性能优化，同时修复了部分兼容性和稳定性问题。尽管尽量减少了Breaking Changes，但建议用户在升级前仔细阅读变更日志，并进行全面测试。