This release replaces the underlying HTTP client used on the TestClient (requests➡️httpx), and as those clients differ a bit on their API, your test suite will likely break. To make the migration smoother, you can use the bump-testclient tool.
Fix inference of Route.name when created from methods #1553.
Avoid TypeError on websocket.disconnect when code is None#1574.
Deprecated
Deprecate WS_1004_NO_STATUS_RCVD and WS_1005_ABNORMAL_CLOSURE in favor of WS_1005_NO_STATUS_RCVD and WS_1006_ABNORMAL_CLOSURE, as the previous constants didn't match the WebSockets specs#1580.
Don't omit Content-Length header for Content-Length: 0 cases #1395.
Don't set headers for responses with 1xx, 204 and 304 status code #1397.
SessionMiddleware.max_age now accepts None, so cookie can last as long as the browser session #1387.
Fixed
Tweak hashlib.md5() function on FileResponses ETag generation. The parameter usedforsecurity flag is set to False, if the flag is available on the system. This fixes an error raised on systems with FIPS enabled #1366 and #1410.
Fix path_params type on url_path_for() method i.e. turn str into Any#1341.
starlette.websockets.WebSocket instances are now hashable and compare by identity #1039
A number of fixes related to running task groups in lifespan #1213, #1227
Deprecated/removed
The method starlette.templates.Jinja2Templates.get_env was removed #1218
The ClassVar starlette.testclient.TestClient.async_backend was removed,
the backend is now configured using constructor kwargs #1211
Passing an Async Generator Function or a Generator Function to starlette.router.Router(lifespan_context=) is deprecated. You should wrap your lifespan in @contextlib.asynccontextmanager. #1227 #1110
This release includes major changes to the low-level asynchronous parts of Starlette. As a result, Starlette now depends on AnyIO and some minor API changes have occurred. Another significant change with this release is the deprecation of built-in GraphQL support.
Added
Starlette now supports Trio as an async runtime via AnyIO - #1157.
TestClient.websocket_connect() now must be used as a context manager.
Improved exception messages in the case of duplicated path parameter names - #1177.
RedirectResponse now uses quote instead of quote_plus encoding for the Location header to better match the behaviour in other frameworks such as Django - #1164.
Exception causes are now preserved in more cases - #1158.
Session cookies now use the ASGI root path in the case of mounted applications - #1147.
Fixed a cache invalidation bug when static files were deleted in certain circumstances - #1023.
Improved memory usage of BaseHTTPMiddleware when handling large responses - #1012 fixed via #1157
Deprecated/removed
Built-in GraphQL support via the GraphQLApp class has been deprecated and will be removed in a future release. Please see #619. GraphQL is not supported on Python 3.10.
The executor parameter to GraphQLApp was removed. Use executor_class instead.
The workers parameter to WSGIMiddleware was removed. This hasn't had any effect since Starlette v0.6.3.
Configuration
📅Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕Ignore: Close this PR and you won't be reminded about this update again.
If you want to rebase/retry this PR, check this box
This PR contains the following updates:
| Package | Update | Change |
|---|---|---|
| [starlette](https://github.com/encode/starlette) ([changelog](https://www.starlette.io/release-notes/)) | minor | `==0.14.2` -> `==0.37.1` |
---
### Release Notes
<details>
<summary>encode/starlette (starlette)</summary>
### [`v0.37.1`](https://github.com/encode/starlette/releases/tag/0.37.1): Version 0.37.1
[Compare Source](https://github.com/encode/starlette/compare/0.37.0...0.37.1)
#### Fixed
- Warn instead of raise for missing env file on `Config` [#​2485](https://github.com/encode/starlette/pull/2485).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.37.0...0.37.1
### [`v0.37.0`](https://github.com/encode/starlette/releases/tag/0.37.0): Version 0.37.0
[Compare Source](https://github.com/encode/starlette/compare/0.36.3...0.37.0)
#### Added
- Support the WebSocket Denial Response ASGI extension [#​2041](https://github.com/encode/starlette/pull/2041).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.36.3...0.37.0
### [`v0.36.3`](https://github.com/encode/starlette/releases/tag/0.36.3): Version 0.36.3
[Compare Source](https://github.com/encode/starlette/compare/0.36.2...0.36.3)
#### Fixed
- Create `anyio.Event` on async context [#​2459](https://github.com/encode/starlette/pull/2459).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.36.2...0.36.3
### [`v0.36.2`](https://github.com/encode/starlette/releases/tag/0.36.2): Version 0.36.2
[Compare Source](https://github.com/encode/starlette/compare/0.36.1...0.36.2)
#### Fixed
- Upgrade `python-multipart` to `0.0.7` [13e5c26](13e5c26a27f4903924624736abd6131b2da80cc5).
- Avoid duplicate charset on `Content-Type` [#​2443](https://github.com/encode/starlette/2443).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.36.1...0.36.2
### [`v0.36.1`](https://github.com/encode/starlette/releases/tag/0.36.1): Version 0.36.1
[Compare Source](https://github.com/encode/starlette/compare/0.36.0...0.36.1)
#### Fixed
- Check if "extensions" in scope before checking the extension [#​2438](http://github.com/encode/starlette/pull/2438).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.36.0...0.36.1
### [`v0.36.0`](https://github.com/encode/starlette/releases/tag/0.36.0): Version 0.36.0
[Compare Source](https://github.com/encode/starlette/compare/0.35.1...0.36.0)
#### Added
- Add support for ASGI `pathsend` extension [#​2435](http://github.com/encode/starlette/pull/2435).
- Cancel `WebSocketTestSession` on close [#​2427](http://github.com/encode/starlette/pull/2427).
- Raise `WebSocketDisconnect` when `WebSocket.send()` excepts `IOError` [#​2425](http://github.com/encode/starlette/pull/2425).
- Raise `FileNotFoundError` when the `env_file` parameter on `Config` is not valid [#​2422](http://github.com/encode/starlette/pull/2422).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.35.1...0.36.0
### [`v0.35.1`](https://github.com/encode/starlette/releases/tag/0.35.1): Version 0.35.1
[Compare Source](https://github.com/encode/starlette/compare/0.35.0...0.35.1)
#### Fixed
- Stop using the deprecated "method" parameter in `FileResponse` inside of `StaticFiles` [#​2406](https://github.com/encode/starlette/pull/2406).
- Make `typing-extensions` optional again [#​2409](https://github.com/encode/starlette/pull/2409).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.35.0...0.35.1
### [`v0.35.0`](https://github.com/encode/starlette/releases/tag/0.35.0): Version 0.35.0
[Compare Source](https://github.com/encode/starlette/compare/0.34.0...0.35.0)
#### Added
- Add `*args` to `Middleware` and improve its type hints [#​2381](https://github.com/encode/starlette/pull/2381).
#### Fixed
- Use `Iterable` instead `Iterator` on `iterate_in_threadpool` [#​2362](https://github.com/encode/starlette/pull/2362).
#### Changes
- Handle `root_path` to keep compatibility with mounted ASGI applications and WSGI [#​2400](https://github.com/encode/starlette/pull/2400).
- Turn `scope["client"]` to `None` on `TestClient` [#​2377](https://github.com/encode/starlette/pull/2377).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.34.0...0.35.0
### [`v0.34.0`](https://github.com/encode/starlette/releases/tag/0.34.0): Version 0.34.0
[Compare Source](https://github.com/encode/starlette/compare/0.33.0...0.34.0)
#### Added
- Use `ParamSpec` for `run_in_threadpool` [#​2375](https://github.com/encode/starlette/pull/2375).
- Add `UploadFile.__repr__` [#​2360](https://github.com/encode/starlette/pull/2360).
#### Fixed
- Merge URLs properly on `TestClient` [#​2376](https://github.com/encode/starlette/pull/2376).
- Take weak ETags in consideration on `StaticFiles` [#​2334](https://github.com/encode/starlette/pull/2334).
#### Deprecated
- Deprecate `FileResponse(method=...)` parameter [#​2366](https://github.com/encode/starlette/pull/2366).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.33.0...0.34.0
### [`v0.33.0`](https://github.com/encode/starlette/releases/tag/0.33.0): Version 0.33.0
[Compare Source](https://github.com/encode/starlette/compare/0.32.0.post1...0.33.0)
#### Added
- Add `middleware` per `Route`/`WebSocketRoute` [#​2349](https://github.com/encode/starlette/pull/2349).
- Add `middleware` per `Router` [#​2351](https://github.com/encode/starlette/pull/2351).
#### Fixed
- Do not overwrite `"path"` and `"root_path"` scope keys [#​2352](https://github.com/encode/starlette/pull/2352).
- Set `ensure_ascii=False` on `json.dumps()` for `WebSocket.send_json()` [#​2341](https://github.com/encode/starlette/pull/2341).
### [`v0.32.0.post1`](https://github.com/encode/starlette/releases/tag/0.32.0.post1): Version 0.32.0.post1
[Compare Source](https://github.com/encode/starlette/compare/0.32.0...0.32.0.post1)
##### Fixed
- Revert mkdocs-material from 9.1.17 to 9.4.7 [#​2326](https://github.com/encode/starlette/pull/2326).
### [`v0.32.0`](https://github.com/encode/starlette/releases/tag/0.32.0): Version 0.32.0
[Compare Source](https://github.com/encode/starlette/compare/0.31.1...0.32.0)
#### Added
- Send `reason` on `WebSocketDisconnect` [#​2309](https:://github.com/encode/starlette/pull/2309).
- Add `domain` parameter to `SessionMiddleware` [#​2280](https:://github.com/encode/starlette/pull/2280).
#### Changed
- Inherit from `HTMLResponse` instead of `Response` on `_TemplateResponse` [#​2274](https://github.com/encode/starlette/pull/2274).
- Restore the `Response.render` type annotation to its pre-0.31.0 state [#​2264](https://github.com/encode/starlette/pull/2264).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.31.1...0.32.0
### [`v0.31.1`](https://github.com/encode/starlette/releases/tag/0.31.1): Version 0.31.1
[Compare Source](https://github.com/encode/starlette/compare/0.31.0...0.31.1)
##### Fixed
- Fix import error when `exceptiongroup` isn't available [#​2231](https://github.com/encode/starlette/pull/2231).
- Set `url_for` global for custom Jinja environments [#​2230](https://github.com/encode/starlette/pull/2230).
**Full Changelog**: https://github.com/encode/starlette/compare/0.31.0...0.31.1
### [`v0.31.0`](https://github.com/encode/starlette/releases/tag/0.31.0): Version 0.31.0
[Compare Source](https://github.com/encode/starlette/compare/0.30.0...0.31.0)
#### Added
- Officially support Python 3.12 [#​2214](https://github.com/encode/starlette/pull/2214).
- Support AnyIO 4.0 [#​2211](https://github.com/encode/starlette/pull/2211).
- Strictly type annotate Starlette (strict mode on mypy) [#​2180](https://github.com/encode/starlette/pull/2180).
#### Fixed
- Don't group duplicated headers on a single string when using the `TestClient` [#​2219](https://github.com/encode/starlette/pull/2219).
***
**Full Changelog**: https://github.com/encode/starlette/compare/0.30.0...0.31.0
### [`v0.30.0`](https://github.com/encode/starlette/releases/tag/0.30.0): Version 0.30.0
[Compare Source](https://github.com/encode/starlette/compare/0.29.0...0.30.0)
##### Removed
- Drop Python 3.7 support [#​2178](https://github.com/encode/starlette/pull/2178).
### [`v0.29.0`](https://github.com/encode/starlette/releases/tag/0.29.0): Version 0.29.0
[Compare Source](https://github.com/encode/starlette/compare/0.28.0...0.29.0)
#### Added
- Add `follow_redirects` parameter to `TestClient` [#​2207](https://github.com/encode/starlette/pull/2207).
- Add `__str__` to `HTTPException` and `WebSocketException` [#​2181](https://github.com/encode/starlette/pull/2181).
- Warn users when using `lifespan` together with `on_startup`/`on_shutdown` [#​2193](https://github.com/encode/starlette/pull/2193).
- Collect routes from `Host` to generate the OpenAPI schema [#​2183](https://github.com/encode/starlette/pull/2183).
- Add `request` argument to `TemplateResponse` [#​2191](https://github.com/encode/starlette/pull/2191).
#### Fixed
- Stop `body_stream` in case `more_body=False` on `BaseHTTPMiddleware` [#​2194](https://github.com/encode/starlette/pull/2194).
**Full Changelog**: https://github.com/encode/starlette/compare/0.28.0...0.29.0
### [`v0.28.0`](https://github.com/encode/starlette/releases/tag/0.28.0): Version 0.28.0
[Compare Source](https://github.com/encode/starlette/compare/0.27.0...0.28.0)
##### Changed
- Reuse `Request`'s body buffer for call_next in `BaseHTTPMiddleware` [#​1692](https://github.com/encode/starlette/pull/1692).
- Move exception handling logic to `Route` [#​2026](https://github.com/encode/starlette/pull/2026).
##### Added
- Add `env` parameter to `Jinja2Templates`, and deprecate `**env_options` [#​2159](https://github.com/encode/starlette/pull/2159).
- Add clear error message when `httpx` is not installed [#​2177](https://github.com/encode/starlette/pull/2177).
##### Fixed
- Allow "name" argument on `templates url_for()` [#​2127](https://github.com/encode/starlette/pull/2127).
**Full Changelog**: https://github.com/encode/starlette/compare/0.27.0...0.28.0
### [`v0.27.0`](https://github.com/encode/starlette/releases/tag/0.27.0): Version 0.27.0
[Compare Source](https://github.com/encode/starlette/compare/0.26.1...0.27.0)
This release fixes a path traversal vulnerability in `StaticFiles`. You can view the full security advisory:
https://github.com/encode/starlette/security/advisories/GHSA-v5gw-mw7f-84px
##### Added
- Minify JSON websocket data via `send_json` https://github.com/encode/starlette/pull/2128
##### Fixed
- Replace `commonprefix` by `commonpath` on `StaticFiles` [1797de4](https://github.com/encode/starlette/commit/1797de464124b090f10cf570441e8292936d63e3).
- Convert ImportErrors into ModuleNotFoundError [#​2135](https://github.com/encode/starlette/pull/2135).
- Correct the RuntimeError message content in websockets [#​2141](https://github.com/encode/starlette/pull/2141).
**Full Changelog**: https://github.com/encode/starlette/compare/0.26.1...0.27.0
### [`v0.26.1`](https://github.com/encode/starlette/releases/tag/0.26.1): Version 0.26.1
[Compare Source](https://github.com/encode/starlette/compare/0.26.0.post1...0.26.1)
##### Fixed
- Fix typing of Lifespan to allow subclasses of Starlette [#​2077](https://github.com/encode/starlette/pull/2077).
### [`v0.26.0.post1`](https://github.com/encode/starlette/releases/tag/0.26.0.post1): Version 0.26.0.post1
[Compare Source](https://github.com/encode/starlette/compare/0.26.0...0.26.0.post1)
##### Fixed
- Replace reference from Events to Lifespan on the mkdocs.yml [#​2072](https://github.com/encode/starlette/pull/2072).
### [`v0.26.0`](https://github.com/encode/starlette/releases/tag/0.26.0): Version 0.26.0
[Compare Source](https://github.com/encode/starlette/compare/0.25.0...0.26.0)
##### Added
- Support [lifespan state](https://www.starlette.io/lifespan/) [#​2060](https://github.com/encode/starlette/pull/2060), [#​2065](https://github.com/encode/starlette/pull/2065) and [#​2064](https://github.com/encode/starlette/pull/2064).
##### Changed
- Change `url_for` signature to return a `URL` instance [#​1385](https://github.com/encode/starlette/pull/1385).
##### Fixed
- Allow "name" argument on `url_for()` and `url_path_for()` [#​2050](https://github.com/encode/starlette/pull/2050).
##### Deprecated
- Deprecate `on_startup` and `on_shutdown` events [#​2070](https://github.com/encode/starlette/pull/2070).
**Full Changelog**: https://github.com/encode/starlette/compare/0.25.0...0.26.0
### [`v0.25.0`](https://github.com/encode/starlette/releases/tag/0.25.0): Version 0.25.0
[Compare Source](https://github.com/encode/starlette/compare/0.24.0...0.25.0)
##### Fixed
- Limit the number of fields and files when parsing `multipart/form-data` on the `MultipartParser` [8c74c2c](https://github.com/encode/starlette/commit/8c74c2c8dba7030154f8af18e016136bea1938fa) and [#​2036](https://github.com/encode/starlette/pull/2036).
### [`v0.24.0`](https://github.com/encode/starlette/releases/tag/0.24.0): Version 0.24.0
[Compare Source](https://github.com/encode/starlette/compare/0.23.1...0.24.0)
##### Added
- Allow `StaticFiles` to follow symlinks [#​1683](https://github.com/encode/starlette/pull/1683).
- Allow `Request.form()` as a context manager [#​1903](https://github.com/encode/starlette/pull/1903).
- Add `size` attribute to `UploadFile` [#​1405](https://github.com/encode/starlette/pull/1405).
- Add `env_prefix` argument to `Config` [#​1990](https://github.com/encode/starlette/pull/1990).
- Add template context processors [#​1904](https://github.com/encode/starlette/pull/1904).
- Support `str` and `datetime` on `expires` parameter on the `Response.set_cookie` method [#​1908](https://github.com/encode/starlette/pull/1908).
##### Changed
- Lazily build the middleware stack [#​2017](https://github.com/encode/starlette/pull/2017).
- Make the `file` argument required on `UploadFile` [#​1413](https://github.com/encode/starlette/pull/1413).
- Use debug extension instead of custom response template extension [#​1991](https://github.com/encode/starlette/pull/1991).
##### Fixed
- Fix url parsing of ipv6 urls on `URL.replace` [#​1965](https://github.com/encode/starlette/pull/1965).
### [`v0.23.1`](https://github.com/encode/starlette/releases/tag/0.23.1): Version 0.23.1
[Compare Source](https://github.com/encode/starlette/compare/0.23.0...0.23.1)
##### Fixed
- Only stop receiving stream on `body_stream` if body is empty on the `BaseHTTPMiddleware` [#​1940](https://github.com/encode/starlette/pull/1940).
### [`v0.23.0`](https://github.com/encode/starlette/releases/tag/0.23.0): Version 0.23.0
[Compare Source](https://github.com/encode/starlette/compare/0.22.0...0.23.0)
##### Added
- Add `headers` parameter to the `TestClient` [#​1966](https://github.com/encode/starlette/pull/1966).
##### Deprecated
- Deprecate `Starlette` and `Router` decorators [#​1897](https://github.com/encode/starlette/pull/1897).
##### Fixed
- Fix bug on `FloatConvertor` regex [#​1973](https://github.com/encode/starlette/pull/1973).
### [`v0.22.0`](https://github.com/encode/starlette/releases/tag/0.22.0): Version 0.22.0
[Compare Source](https://github.com/encode/starlette/compare/0.21.0...0.22.0)
##### Changed
- Bypass `GZipMiddleware` when response includes `Content-Encoding` [#​1901](https://github.com/encode/starlette/pull/1901).
##### Fixed
- Remove unneeded `unquote()` from query parameters on the `TestClient` [#​1953](https://github.com/encode/starlette/pull/1953).
- Make sure `MutableHeaders._list` is actually a `list` [#​1917](https://github.com/encode/starlette/pull/1917).
- Import compatibility with the next version of `AnyIO` [#​1936](https://github.com/encode/starlette/pull/1936).
### [`v0.21.0`](https://github.com/encode/starlette/releases/tag/0.21.0): Version 0.21.0
[Compare Source](https://github.com/encode/starlette/compare/0.20.4...0.21.0)
This release replaces the underlying HTTP client used on the `TestClient` (`requests` :arrow_right: `httpx`), and as those clients [differ *a bit* on their API](https://www.python-httpx.org/compatibility/), your test suite will likely break. To make the migration smoother, you can use the [`bump-testclient`](https://github.com/Kludex/bump-testclient) tool.
##### Changed
- Replace `requests` with `httpx` in `TestClient` [#​1376](https://github.com/encode/starlette/pull/1376).
##### Added
- Add `WebSocketException` and support for WebSocket exception handlers [#​1263](https://github.com/encode/starlette/pull/1263).
- Add `middleware` parameter to `Mount` class [#​1649](https://github.com/encode/starlette/pull/1649).
- Officially support Python 3.11 [#​1863](https://github.com/encode/starlette/pull/1863).
- Implement `__repr__` for route classes [#​1864](https://github.com/encode/starlette/pull/1864).
##### Fixed
- Fix bug on which `BackgroundTasks` were cancelled when using `BaseHTTPMiddleware` and client disconnected [#​1715](https://github.com/encode/starlette/pull/1715).
### [`v0.20.4`](https://github.com/encode/starlette/releases/tag/0.20.4): Version 0.20.4
[Compare Source](https://github.com/encode/starlette/compare/0.20.3...0.20.4)
##### Fixed
- Remove converter from path when generating OpenAPI schema [#​1648](https://github.com/encode/starlette/pull/1648).
### [`v0.20.3`](https://github.com/encode/starlette/releases/tag/0.20.3): Version 0.20.3
[Compare Source](https://github.com/encode/starlette/compare/0.20.2...0.20.3)
##### Fixed
- Revert "Allow `StaticFiles` to follow symlinks" [#​1681](https://github.com/encode/starlette/pull/1681).
### [`v0.20.2`](https://github.com/encode/starlette/releases/tag/0.20.2): Version 0.20.2
[Compare Source](https://github.com/encode/starlette/compare/0.20.1...0.20.2)
##### Fixed
- Fix regression on route paths with colons [#​1675](https://github.com/encode/starlette/pull/1675).
- Allow `StaticFiles` to follow symlinks [#​1337](https://github.com/encode/starlette/pull/1377).
### [`v0.20.1`](https://github.com/encode/starlette/releases/tag/0.20.1): Version 0.20.1
[Compare Source](https://github.com/encode/starlette/compare/0.20.0...0.20.1)
##### Fixed
- Improve detection of async callables [#​1444](https://github.com/encode/starlette/pull/1444).
- Send 400 (Bad Request) when `boundary` is missing [#​1617](https://github.com/encode/starlette/pull/1617).
- Send 400 (Bad Request) when missing "name" field on `Content-Disposition` header [#​1643](https://github.com/encode/starlette/pull/1643).
- Do not send empty data to `StreamingResponse` on `BaseHTTPMiddleware` [#​1609](https://github.com/encode/starlette/pull/1609).
- Add `__bool__` dunder for `Secret` [#​1625](https://github.com/encode/starlette/pull/1625).
### [`v0.20.0`](https://github.com/encode/starlette/releases/tag/0.20.0): Version 0.20.0
[Compare Source](https://github.com/encode/starlette/compare/0.19.1...0.20.0)
##### Removed
- Drop Python 3.6 support [#​1357](https://github.com/encode/starlette/pull/1357) and [#​1616](https://github.com/encode/starlette/pull/1616).
### [`v0.19.1`](https://github.com/encode/starlette/releases/tag/0.19.1): Version 0.19.1
[Compare Source](https://github.com/encode/starlette/compare/0.19.0...0.19.1)
##### Fixed
- Fix inference of `Route.name` when created from methods [#​1553](https://github.com/encode/starlette/pull/1553).
- Avoid `TypeError` on `websocket.disconnect` when code is `None` [#​1574](https://github.com/encode/starlette/pull/1574).
##### Deprecated
- Deprecate `WS_1004_NO_STATUS_RCVD` and `WS_1005_ABNORMAL_CLOSURE` in favor of `WS_1005_NO_STATUS_RCVD` and `WS_1006_ABNORMAL_CLOSURE`, as the previous constants didn't match the [WebSockets specs](https://www.iana.org/assignments/websocket/websocket.xhtml) [#​1580](https://github.com/encode/starlette/pull/1580).
### [`v0.19.0`](https://github.com/encode/starlette/releases/tag/0.19.0): Version 0.19.0
[Compare Source](https://github.com/encode/starlette/compare/0.18.0...0.19.0)
##### Added
- Error handler will always run, even if the error happens on a background task [#​761](https://github.com/encode/starlette/pull/761).
- Add `headers` parameter to `HTTPException` [#​1435](https://github.com/encode/starlette/pull/1435).
- Internal responses with `405` status code insert an `Allow` header, as described by [RFC 7231](https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.5) [#​1436](https://github.com/encode/starlette/pull/1436).
- The `content` argument in `JSONResponse` is now required [#​1431](https://github.com/encode/starlette/pull/1431).
- Add custom URL convertor register [#​1437](https://github.com/encode/starlette/pull/1437).
- Add content disposition type parameter to `FileResponse` [#​1266](https://github.com/encode/starlette/pull/1266).
- Add next query param with original request URL in requires decorator [#​920](https://github.com/encode/starlette/pull/920).
- Add `raw_path` to `TestClient` scope [#​1445](https://github.com/encode/starlette/pull/1445).
- Add union operators to `MutableHeaders` [#​1240](https://github.com/encode/starlette/pull/1240).
- Display missing route details on debug page [#​1363](https://github.com/encode/starlette/pull/1363).
- Change `anyio` required version range to `>=3.4.0,<5.0` [#​1421](https://github.com/encode/starlette/pull/1421) and [#​1460](https://github.com/encode/starlette/pull/1460).
- Add `typing-extensions>=3.10` requirement - used only on lower versions than Python 3.10 [#​1475](https://github.com/encode/starlette/pull/1475).
##### Fixed
- Prevent `BaseHTTPMiddleware` from hiding errors of `StreamingResponse` and mounted applications [#​1459](https://github.com/encode/starlette/pull/1459).
- `SessionMiddleware` uses an explicit `path=...`, instead of defaulting to the ASGI 'root_path' [#​1512](https://github.com/encode/starlette/pull/1512).
- `Request.client` is now compliant with the ASGI specifications [#​1462](https://github.com/encode/starlette/pull/1462).
- Raise `KeyError` at early stage for missing boundary [#​1349](https://github.com/encode/starlette/pull/1349).
##### Deprecated
- Deprecate WSGIMiddleware in favor of a2wsgi [#​1504](https://github.com/encode/starlette/pull/1504).
- Deprecate `run_until_first_complete` [#​1443](https://github.com/encode/starlette/pull/1443).
### [`v0.18.0`](https://github.com/encode/starlette/releases/tag/0.18.0): Version 0.18.0
[Compare Source](https://github.com/encode/starlette/compare/0.17.1...0.18.0)
##### Added
- Change default chunk size from 4Kb to 64Kb on `FileResponse` [#​1345](https://github.com/encode/starlette/pull/1345).
- Add support for `functools.partial` in `WebSocketRoute` [#​1356](https://github.com/encode/starlette/pull/1356).
- Add `StaticFiles` packages with directory [#​1350](https://github.com/encode/starlette/pull/1350).
- Allow environment options in `Jinja2Templates` [#​1401](https://github.com/encode/starlette/pull/1401).
- Allow HEAD method on `HttpEndpoint` [#​1346](https://github.com/encode/starlette/pull/1346).
- Accept additional headers on `websocket.accept` message [#​1361](https://github.com/encode/starlette/pull/1361) and [#​1422](https://github.com/encode/starlette/pull/1422).
- Add `reason` to `WebSocket` close ASGI event [#​1417](https://github.com/encode/starlette/pull/1417).
- Add headers attribute to `UploadFile` [#​1382](https://github.com/encode/starlette/pull/1382).
- Don't omit `Content-Length` header for `Content-Length: 0` cases [#​1395](https://github.com/encode/starlette/pull/1395).
- Don't set headers for responses with 1xx, 204 and 304 status code [#​1397](https://github.com/encode/starlette/pull/1397).
- `SessionMiddleware.max_age` now accepts `None`, so cookie can last as long as the browser session [#​1387](https://github.com/encode/starlette/pull/1387).
##### Fixed
- Tweak `hashlib.md5()` function on `FileResponse`s ETag generation. The parameter [`usedforsecurity`](https://bugs.python.org/issue9216) flag is set to `False`, if the flag is available on the system. This fixes an error raised on systems with [FIPS](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/FIPS_Mode\_-\_an_explanation) enabled [#​1366](https://github.com/encode/starlette/pull/1366) and [#​1410](https://github.com/encode/starlette/pull/1410).
- Fix `path_params` type on `url_path_for()` method i.e. turn `str` into `Any` [#​1341](https://github.com/encode/starlette/pull/1341).
- `Host` now ignores `port` on routing [#​1322](https://github.com/encode/starlette/pull/1322).
### [`v0.17.1`](https://github.com/encode/starlette/releases/tag/0.17.1): Version 0.17.1
[Compare Source](https://github.com/encode/starlette/compare/0.17.0...0.17.1)
##### Fixed
- Fix `IndexError` in authentication `requires` when wrapped function arguments are distributed between `*args` and `**kwargs` [#​1335](https://github.com/encode/starlette/pull/1335).
### [`v0.17.0`](https://github.com/encode/starlette/releases/tag/0.17.0): Version 0.17.0
[Compare Source](https://github.com/encode/starlette/compare/0.16.0...0.17.0)
##### Added
- `Response.delete_cookie` now accepts the same parameters as `Response.set_cookie` [#​1228](https://github.com/encode/starlette/pull/1228).
- Update the `Jinja2Templates` constructor to allow `PathLike` [#​1292](https://github.com/encode/starlette/pull/1292).
##### Fixed
- Fix BadSignature exception handling in SessionMiddleware [#​1264](https://github.com/encode/starlette/pull/1264).
- Change `HTTPConnection.__getitem__` return type from `str` to `typing.Any` [#​1118](https://github.com/encode/starlette/pull/1118).
- Change `ImmutableMultiDict.getlist` return type from `typing.List[str]` to `typing.List[typing.Any]` [#​1235](https://github.com/encode/starlette/pull/1235).
- Handle `OSError` exceptions on `StaticFiles` [#​1220](https://github.com/encode/starlette/pull/1220).
- Fix `StaticFiles` 404.html in HTML mode [#​1314](https://github.com/encode/starlette/pull/1314).
- Prevent anyio.ExceptionGroup in error views under a BaseHTTPMiddleware [#​1262](https://github.com/encode/starlette/pull/1262).
##### Removed
- Remove GraphQL support [#​1198](https://github.com/encode/starlette/pull/1198).
### [`v0.16.0`](https://github.com/encode/starlette/releases/tag/0.16.0): Version 0.16.0
[Compare Source](https://github.com/encode/starlette/compare/0.15.0...0.16.0)
##### Added
- Added [Encode](https://github.com/sponsors/encode) funding option
[#​1219](https://github.com/encode/starlette/pull/1219)
##### Fixed
- `starlette.websockets.WebSocket` instances are now hashable and compare by identity
[#​1039](https://github.com/encode/starlette/pull/1039)
- A number of fixes related to running task groups in lifespan
[#​1213](https://github.com/encode/starlette/pull/1213),
[#​1227](https://github.com/encode/starlette/pull/1227)
##### Deprecated/removed
- The method `starlette.templates.Jinja2Templates.get_env` was removed
[#​1218](https://github.com/encode/starlette/pull/1218)
- The ClassVar `starlette.testclient.TestClient.async_backend` was removed,
the backend is now configured using constructor kwargs
[#​1211](https://github.com/encode/starlette/pull/1211)
- Passing an Async Generator Function or a Generator Function to `starlette.router.Router(lifespan_context=)` is deprecated. You should wrap your lifespan in `@contextlib.asynccontextmanager`.
[#​1227](https://github.com/encode/starlette/pull/1227)
[#​1110](https://github.com/encode/starlette/pull/1110)
### [`v0.15.0`](https://github.com/encode/starlette/releases/tag/0.15.0): Version 0.15.0
[Compare Source](https://github.com/encode/starlette/compare/0.14.2...0.15.0)
#### 0.15.0
This release includes major changes to the low-level asynchronous parts of Starlette. As a result, **Starlette now depends on [AnyIO](https://anyio.readthedocs.io/en/stable/)** and some minor API changes have occurred. Another significant change with this release is the **deprecation of built-in GraphQL support**.
##### Added
- Starlette now supports [Trio](https://trio.readthedocs.io/en/stable/) as an async runtime via AnyIO - [#​1157](https://github.com/encode/starlette/pull/1157).
- `TestClient.websocket_connect()` now must be used as a context manager.
- Initial support for Python 3.10 - [#​1201](https://github.com/encode/starlette/pull/1201).
- The compression level used in `GZipMiddleware` is now adjustable - [#​1128](https://github.com/encode/starlette/pull/1128).
##### Fixed
- Several fixes to `CORSMiddleware`. See [#​1111](https://github.com/encode/starlette/pull/1111), [#​1112](https://github.com/encode/starlette/pull/1112), [#​1113](https://github.com/encode/starlette/pull/1113), [#​1199](https://github.com/encode/starlette/pull/1199).
- Improved exception messages in the case of duplicated path parameter names - [#​1177](https://github.com/encode/starlette/pull/1177).
- `RedirectResponse` now uses `quote` instead of `quote_plus` encoding for the `Location` header to better match the behaviour in other frameworks such as Django - [#​1164](https://github.com/encode/starlette/pull/1164).
- Exception causes are now preserved in more cases - [#​1158](https://github.com/encode/starlette/pull/1158).
- Session cookies now use the ASGI root path in the case of mounted applications - [#​1147](https://github.com/encode/starlette/pull/1147).
- Fixed a cache invalidation bug when static files were deleted in certain circumstances - [#​1023](https://github.com/encode/starlette/pull/1023).
- Improved memory usage of `BaseHTTPMiddleware` when handling large responses - [#​1012](https://github.com/encode/starlette/issues/1012) fixed via [#​1157](https://github.com/encode/starlette/issues/1157)
##### Deprecated/removed
- Built-in GraphQL support via the `GraphQLApp` class has been deprecated and will be removed in a future release. Please see [#​619](https://github.com/encode/starlette/issues/619). GraphQL is not supported on Python 3.10.
- The `executor` parameter to `GraphQLApp` was removed. Use `executor_class` instead.
- The `workers` parameter to `WSGIMiddleware` was removed. This hasn't had any effect since Starlette v0.6.3.
</details>
---
### Configuration
📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box
---
This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xODIuMyIsInVwZGF0ZWRJblZlciI6IjM3LjE4Mi4zIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->
Because you closed this PR without merging, Renovate will ignore this update (==0.37.1). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the ignoreDeps array of your Renovate config.
If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.
### Renovate Ignore Notification
Because you closed this PR without merging, Renovate will ignore this update (`==0.37.1`). You will get a PR once a newer version is released. To ignore this dependency forever, add it to the `ignoreDeps` array of your Renovate config.
If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
This PR contains the following updates:
==0.14.2->==0.37.1Release Notes
encode/starlette (starlette)
v0.37.1: Version 0.37.1Compare Source
Fixed
Config#2485.Full Changelog: https://github.com/encode/starlette/compare/0.37.0...0.37.1
v0.37.0: Version 0.37.0Compare Source
Added
Full Changelog: https://github.com/encode/starlette/compare/0.36.3...0.37.0
v0.36.3: Version 0.36.3Compare Source
Fixed
anyio.Eventon async context #2459.Full Changelog: https://github.com/encode/starlette/compare/0.36.2...0.36.3
v0.36.2: Version 0.36.2Compare Source
Fixed
python-multipartto0.0.713e5c26.Content-Type#2443.Full Changelog: https://github.com/encode/starlette/compare/0.36.1...0.36.2
v0.36.1: Version 0.36.1Compare Source
Fixed
Full Changelog: https://github.com/encode/starlette/compare/0.36.0...0.36.1
v0.36.0: Version 0.36.0Compare Source
Added
pathsendextension #2435.WebSocketTestSessionon close #2427.WebSocketDisconnectwhenWebSocket.send()exceptsIOError#2425.FileNotFoundErrorwhen theenv_fileparameter onConfigis not valid #2422.Full Changelog: https://github.com/encode/starlette/compare/0.35.1...0.36.0
v0.35.1: Version 0.35.1Compare Source
Fixed
FileResponseinside ofStaticFiles#2406.typing-extensionsoptional again #2409.Full Changelog: https://github.com/encode/starlette/compare/0.35.0...0.35.1
v0.35.0: Version 0.35.0Compare Source
Added
*argstoMiddlewareand improve its type hints #2381.Fixed
IterableinsteadIteratoroniterate_in_threadpool#2362.Changes
root_pathto keep compatibility with mounted ASGI applications and WSGI #2400.scope["client"]toNoneonTestClient#2377.Full Changelog: https://github.com/encode/starlette/compare/0.34.0...0.35.0
v0.34.0: Version 0.34.0Compare Source
Added
ParamSpecforrun_in_threadpool#2375.UploadFile.__repr__#2360.Fixed
TestClient#2376.StaticFiles#2334.Deprecated
FileResponse(method=...)parameter #2366.Full Changelog: https://github.com/encode/starlette/compare/0.33.0...0.34.0
v0.33.0: Version 0.33.0Compare Source
Added
middlewareperRoute/WebSocketRoute#2349.middlewareperRouter#2351.Fixed
"path"and"root_path"scope keys #2352.ensure_ascii=Falseonjson.dumps()forWebSocket.send_json()#2341.v0.32.0.post1: Version 0.32.0.post1Compare Source
Fixed
v0.32.0: Version 0.32.0Compare Source
Added
reasononWebSocketDisconnect#2309.domainparameter toSessionMiddleware#2280.Changed
HTMLResponseinstead ofResponseon_TemplateResponse#2274.Response.rendertype annotation to its pre-0.31.0 state #2264.Full Changelog: https://github.com/encode/starlette/compare/0.31.1...0.32.0
v0.31.1: Version 0.31.1Compare Source
Fixed
exceptiongroupisn't available #2231.url_forglobal for custom Jinja environments #2230.Full Changelog: https://github.com/encode/starlette/compare/0.31.0...0.31.1
v0.31.0: Version 0.31.0Compare Source
Added
Fixed
TestClient#2219.Full Changelog: https://github.com/encode/starlette/compare/0.30.0...0.31.0
v0.30.0: Version 0.30.0Compare Source
Removed
v0.29.0: Version 0.29.0Compare Source
Added
follow_redirectsparameter toTestClient#2207.__str__toHTTPExceptionandWebSocketException#2181.lifespantogether withon_startup/on_shutdown#2193.Hostto generate the OpenAPI schema #2183.requestargument toTemplateResponse#2191.Fixed
body_streamin casemore_body=FalseonBaseHTTPMiddleware#2194.Full Changelog: https://github.com/encode/starlette/compare/0.28.0...0.29.0
v0.28.0: Version 0.28.0Compare Source
Changed
Request's body buffer for call_next inBaseHTTPMiddleware#1692.Route#2026.Added
envparameter toJinja2Templates, and deprecate**env_options#2159.httpxis not installed #2177.Fixed
templates url_for()#2127.Full Changelog: https://github.com/encode/starlette/compare/0.27.0...0.28.0
v0.27.0: Version 0.27.0Compare Source
This release fixes a path traversal vulnerability in
StaticFiles. You can view the full security advisory:https://github.com/encode/starlette/security/advisories/GHSA-v5gw-mw7f-84px
Added
send_jsonhttps://github.com/encode/starlette/pull/2128Fixed
commonprefixbycommonpathonStaticFiles1797de4.Full Changelog: https://github.com/encode/starlette/compare/0.26.1...0.27.0
v0.26.1: Version 0.26.1Compare Source
Fixed
v0.26.0.post1: Version 0.26.0.post1Compare Source
Fixed
v0.26.0: Version 0.26.0Compare Source
Added
Changed
url_forsignature to return aURLinstance #1385.Fixed
url_for()andurl_path_for()#2050.Deprecated
on_startupandon_shutdownevents #2070.Full Changelog: https://github.com/encode/starlette/compare/0.25.0...0.26.0
v0.25.0: Version 0.25.0Compare Source
Fixed
multipart/form-dataon theMultipartParser8c74c2c and #2036.v0.24.0: Version 0.24.0Compare Source
Added
StaticFilesto follow symlinks #1683.Request.form()as a context manager #1903.sizeattribute toUploadFile#1405.env_prefixargument toConfig#1990.stranddatetimeonexpiresparameter on theResponse.set_cookiemethod #1908.Changed
fileargument required onUploadFile#1413.Fixed
URL.replace#1965.v0.23.1: Version 0.23.1Compare Source
Fixed
body_streamif body is empty on theBaseHTTPMiddleware#1940.v0.23.0: Version 0.23.0Compare Source
Added
headersparameter to theTestClient#1966.Deprecated
StarletteandRouterdecorators #1897.Fixed
FloatConvertorregex #1973.v0.22.0: Version 0.22.0Compare Source
Changed
GZipMiddlewarewhen response includesContent-Encoding#1901.Fixed
unquote()from query parameters on theTestClient#1953.MutableHeaders._listis actually alist#1917.AnyIO#1936.v0.21.0: Version 0.21.0Compare Source
This release replaces the underlying HTTP client used on the
TestClient(requests➡️httpx), and as those clients differ a bit on their API, your test suite will likely break. To make the migration smoother, you can use thebump-testclienttool.Changed
requestswithhttpxinTestClient#1376.Added
WebSocketExceptionand support for WebSocket exception handlers #1263.middlewareparameter toMountclass #1649.__repr__for route classes #1864.Fixed
BackgroundTaskswere cancelled when usingBaseHTTPMiddlewareand client disconnected #1715.v0.20.4: Version 0.20.4Compare Source
Fixed
v0.20.3: Version 0.20.3Compare Source
Fixed
StaticFilesto follow symlinks" #1681.v0.20.2: Version 0.20.2Compare Source
Fixed
StaticFilesto follow symlinks #1337.v0.20.1: Version 0.20.1Compare Source
Fixed
boundaryis missing #1617.Content-Dispositionheader #1643.StreamingResponseonBaseHTTPMiddleware#1609.__bool__dunder forSecret#1625.v0.20.0: Version 0.20.0Compare Source
Removed
v0.19.1: Version 0.19.1Compare Source
Fixed
Route.namewhen created from methods #1553.TypeErroronwebsocket.disconnectwhen code isNone#1574.Deprecated
WS_1004_NO_STATUS_RCVDandWS_1005_ABNORMAL_CLOSUREin favor ofWS_1005_NO_STATUS_RCVDandWS_1006_ABNORMAL_CLOSURE, as the previous constants didn't match the WebSockets specs #1580.v0.19.0: Version 0.19.0Compare Source
Added
headersparameter toHTTPException#1435.405status code insert anAllowheader, as described by RFC 7231 #1436.contentargument inJSONResponseis now required #1431.FileResponse#1266.raw_pathtoTestClientscope #1445.MutableHeaders#1240.anyiorequired version range to>=3.4.0,<5.0#1421 and #1460.typing-extensions>=3.10requirement - used only on lower versions than Python 3.10 #1475.Fixed
BaseHTTPMiddlewarefrom hiding errors ofStreamingResponseand mounted applications #1459.SessionMiddlewareuses an explicitpath=..., instead of defaulting to the ASGI 'root_path' #1512.Request.clientis now compliant with the ASGI specifications #1462.KeyErrorat early stage for missing boundary #1349.Deprecated
run_until_first_complete#1443.v0.18.0: Version 0.18.0Compare Source
Added
FileResponse#1345.functools.partialinWebSocketRoute#1356.StaticFilespackages with directory #1350.Jinja2Templates#1401.HttpEndpoint#1346.websocket.acceptmessage #1361 and #1422.reasontoWebSocketclose ASGI event #1417.UploadFile#1382.Content-Lengthheader forContent-Length: 0cases #1395.SessionMiddleware.max_agenow acceptsNone, so cookie can last as long as the browser session #1387.Fixed
hashlib.md5()function onFileResponses ETag generation. The parameterusedforsecurityflag is set toFalse, if the flag is available on the system. This fixes an error raised on systems with FIPS enabled #1366 and #1410.path_paramstype onurl_path_for()method i.e. turnstrintoAny#1341.Hostnow ignoresporton routing #1322.v0.17.1: Version 0.17.1Compare Source
Fixed
IndexErrorin authenticationrequireswhen wrapped function arguments are distributed between*argsand**kwargs#1335.v0.17.0: Version 0.17.0Compare Source
Added
Response.delete_cookienow accepts the same parameters asResponse.set_cookie#1228.Jinja2Templatesconstructor to allowPathLike#1292.Fixed
HTTPConnection.__getitem__return type fromstrtotyping.Any#1118.ImmutableMultiDict.getlistreturn type fromtyping.List[str]totyping.List[typing.Any]#1235.OSErrorexceptions onStaticFiles#1220.StaticFiles404.html in HTML mode #1314.Removed
v0.16.0: Version 0.16.0Compare Source
Added
#1219
Fixed
starlette.websockets.WebSocketinstances are now hashable and compare by identity#1039
#1213,
#1227
Deprecated/removed
starlette.templates.Jinja2Templates.get_envwas removed#1218
starlette.testclient.TestClient.async_backendwas removed,the backend is now configured using constructor kwargs
#1211
starlette.router.Router(lifespan_context=)is deprecated. You should wrap your lifespan in@contextlib.asynccontextmanager.#1227
#1110
v0.15.0: Version 0.15.0Compare Source
0.15.0
This release includes major changes to the low-level asynchronous parts of Starlette. As a result, Starlette now depends on AnyIO and some minor API changes have occurred. Another significant change with this release is the deprecation of built-in GraphQL support.
Added
TestClient.websocket_connect()now must be used as a context manager.GZipMiddlewareis now adjustable - #1128.Fixed
CORSMiddleware. See #1111, #1112, #1113, #1199.RedirectResponsenow usesquoteinstead ofquote_plusencoding for theLocationheader to better match the behaviour in other frameworks such as Django - #1164.BaseHTTPMiddlewarewhen handling large responses - #1012 fixed via #1157Deprecated/removed
GraphQLAppclass has been deprecated and will be removed in a future release. Please see #619. GraphQL is not supported on Python 3.10.executorparameter toGraphQLAppwas removed. Useexecutor_classinstead.workersparameter toWSGIMiddlewarewas removed. This hasn't had any effect since Starlette v0.6.3.Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.
Renovate Ignore Notification
Because you closed this PR without merging, Renovate will ignore this update (
==0.37.1). You will get a PR once a newer version is released. To ignore this dependency forever, add it to theignoreDepsarray of your Renovate config.If you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.