Changelog for Falcon 3.1.0¶
This release contains several refinements to request validation and error handling, along with some tweaks to response handling for static and downloadable files.
Some important bugs were also fixed to ensure applications properly clean up response streams and do not hang when reading request bodies that are streamed using chunked transfer encoding.
This release also adds support for CPython 3.10 and deprecates CPython 3.6.
Changes to Supported Platforms¶
CPython 3.10 is now fully supported. (#1966)
Support for Python 3.6 is now deprecated and will be removed in Falcon 4.0.
As with the previous release, Python 3.5 support remains deprecated and will no longer be supported in Falcon 4.0.
New & Improved¶
jsonschema.validatedecorator now raises an instance of
MediaValidationErrorinstead of the generic
HTTPBadRequestfor request media validation failures. Although the default behavior is kept unaltered in a backwards-compatible fashion (as the specialized exception subclasses the generic one), but it can now be easily customized by adding an error handler for the new class. (#1320)
Request.rangeproperty now has stricter validation:
When parsing a byte-range-spec with a last-byte-pos, it must be greater than or equal to first-byte-pos.
When parsing a suffix-byte-range-spec, suffix-length must be positive.
When called with deprecated positional arguments, methods and class initializers (such as
falcon.HTTPError) will now emit a user-friendlier warning indicating the fully qualified name of the method in question. (#2010)
Previously, files could be left open when serving via an ASGI static route (depending on the underlying GC implementation). This has been fixed so that a file is closed explicitly after rendering the response. (#1963)
When a request was streamed using the chunked transfer encoding (with no
Content-Lengthknown in advance), iterating over
req.streamcould hang until the client had disconnected. This bug has been fixed, and iteration now stops upon receiving the last body chunk as expected. (#2024)
compile_uri_template()utility method has been deprecated and will be removed in Falcon 4.0. This function was only employed in the early versions of the framework, and is expected to have been fully supplanted by the
CompiledRouter. In the unlikely case it is still in active use, its source code can be simply copied into an affected application. (#1967)
Contributors to this Release¶
Many thanks to all the contributors for this release!