docs/changes/4.3.0.rst
This is the first beta release of Falcon 4.3.
As Falcon 4.3 is now feature-complete, we would really be thankful if you could
take this beta release for a spin with your apps, and
:ref:let us know if you run into any issues <chat>!
As always, you can grab this pre-release
from PyPI <https://pypi.org/project/falcon/4.3.0b1/>__::
pip install falcon==4.3.0b1
Thank You!
.. Changes to Supported Platforms .. ------------------------------
.. NOTE(vytas): No changes to the supported platforms (yet).
The test client (:func:~falcon.testing.simulate_request and friends) now
accepts a msgpack keyword argument, analogous to the existing json
one. When provided, the value is serialized as a MessagePack document and
used as the request body, and the Content-Type header is set to
:attr:~falcon.MEDIA_MSGPACK. (#1026 <https://github.com/falconry/falcon/issues/1026>__)
A new router option,
:attr:~falcon.routing.CompiledRouterOptions.default_to_on_request, was
added to allow resources to provide a default responder via on_request()
(disabled by default). When enabled,
on_request() is used as the default responder for every unimplemented HTTP
verb except on_options() (and the special on_websocket handler).
When the option is disabled, or the on_request() method is not implemented,
the default responder for
:class:"405 Method Not Allowed" <falcon.HTTPMethodNotAllowed> is used. (#2071 <https://github.com/falconry/falcon/issues/2071>__)
On Windows, :func:falcon.secure_filename now escapes reserved device names
(CON, NUL, COM1, etc.) by prefixing the sanitized value with an
underscore. (#2422 <https://github.com/falconry/falcon/issues/2422>__)
Internal type annotations were improved, allowing the project to pass
mypy --strict falcon/. We have added a few # type: ignore comments for
known limitations, and are actively working to reduce their necessity. (#2504 <https://github.com/falconry/falcon/issues/2504>__)
The :meth:req.get_param_as_list <falcon.Request.get_param_as_list> method now
supports a new argument, delimiter, for splitting values.
In line with the OpenAPI v3 parameter specification, the supported delimiters
currently include the 'pipeDelimited' and 'spaceDelimited' symbolic
constants, as well as the literal ',', '|', and ' ' characters. (#2538 <https://github.com/falconry/falcon/issues/2538>__)
A new :meth:~falcon.Request.get_param_as_dict method was added to
:class:~falcon.Request that retrieves a query parameter as a dict.
Two input formats are supported: an alternating key/value list
(e.g. param=k1,v1,k2,v2) and, when deep_object is set, the OpenAPI v3
deepObject style (e.g. param[k1]=v1¶m[k2]=v2). (#2542 <https://github.com/falconry/falcon/issues/2542>__)
A new :meth:~falcon.Request.get_query_string_as_media method was added to
:class:~falcon.Request. The method URL-decodes the entire query string and
deserializes it using the configured media handlers. This is useful for
implementing the OpenAPI 3.2 querystring parameter location <https://spec.openapis.org/oas/v3.2.0.html#parameter-locations>, where
the entire query string is treated as a single serialized value. (#2546 <https://github.com/falconry/falcon/issues/2546>)
A new :meth:~falcon.Request.get_param_as_media method was added to
:class:~falcon.Request. It deserializes a single query-string parameter
using the configured media handlers, and accepts an optional media_type
that falls back to the app's
:attr:~falcon.RequestOptions.default_media_type when unspecified. (#2549 <https://github.com/falconry/falcon/issues/2549>__)
A new request property, :attr:req.last_event_id <falcon.Request.last_event_id>,
was added to provide convenient access to the Last-Event-ID header.
This header is commonly sent by clients when reconnecting to a
:attr:Server-Sent Events <falcon.asgi.Response.sse> stream. (#2580 <https://github.com/falconry/falcon/issues/2580>__)
:ref:Generic App types <generic_app_types> are now automatically parametrized
by the default request/response types (unless specified otherwise), courtesy of
:class:~typing.TypeVar's default value support on CPython 3.13+. (#2586 <https://github.com/falconry/falcon/issues/2586>__)
Due to differences in interpretation of the ASGI specification, Uvicorn
could set client in the HTTP connection scope in a way that broke
:attr:req.access_route <falcon.asgi.Request.access_route> and
:attr:req.remote_addr <falcon.asgi.Request.remote_addr> when the app server
was bound to a Unix domain socket.
This discrepancy was addressed, and Falcon should now fall back to the same
default value ('127.0.0.1') in this case as if client was missing
altogether. (#2583 <https://github.com/falconry/falcon/issues/2583>__)
name and value arguments
of :meth:falcon.Response.set_cookie. The implementation has always rejected
non-ASCII inputs (raising KeyError for name and ValueError for
value), but the parameter and Raises entries did not call this out;
the docstring now matches the runtime behaviour. (#1445 <https://github.com/falconry/falcon/issues/1445>__)falcon.testing.redirected context manager has been deprecated in
favor of the standard library's :func:contextlib.redirect_stdout and
:func:contextlib.redirect_stderr. It is scheduled for removal in Falcon 5.0. (#2569 <https://github.com/falconry/falcon/issues/2569>__)logging.NullHandler to the
falcon logger, so ASGI application tracebacks may now reach
sys.stderr via the :any:logging.lastResort handler in the absence of
configuration (see also: :ref:debugging_asgi_applications). (#2594 <https://github.com/falconry/falcon/issues/2594>__)falcon.sys (an internal re-export of the standard library's
:mod:sys module that was added inadvertently long ago) is
scheduled for removal in Falcon 5.0. Import the standard library's
:mod:sys module directly instead. (#2630 <https://github.com/falconry/falcon/issues/2630>__)zizmor <https://zizmor.sh/>, a static analysis tool that catches common
security pitfalls in CI/CD pipelines. The audit runs both as a dedicated
workflow and as part of our tox checks, and the existing workflows were
hardened to address the issues it surfaced. (#2651 <https://github.com/falconry/falcon/issues/2651>)Many thanks to all of our talented and stylish contributors for this release!
0x1618 <https://github.com/0x1618>__0xMattB <https://github.com/0xMattB>__arthurprioli <https://github.com/arthurprioli>__CaselIT <https://github.com/CaselIT>__CuriousHet <https://github.com/CuriousHet>__gespyrop <https://github.com/gespyrop>__granuels <https://github.com/granuels>__jap <https://github.com/jap>__MannXo <https://github.com/MannXo>__mvanhorn <https://github.com/mvanhorn>__ReinerBRO <https://github.com/ReinerBRO>__rushevich <https://github.com/rushevich>__StepanUFL <https://github.com/StepanUFL>__tang-vu <https://github.com/tang-vu>__thisisrick25 <https://github.com/thisisrick25>__toroleapinc <https://github.com/toroleapinc>__tuanaiseo <https://github.com/tuanaiseo>__TudorGR <https://github.com/TudorGR>__vytas7 <https://github.com/vytas7>__