Fastapi

Fixes

* 🐛 Ignore Response classes on return annotation. PR [5855](https://github.com/tiangolo/fastapi/pull/5855) by [Kludex](https://github.com/Kludex). See the new docs in the PR below.

Docs

* 📝 Update docs and examples for Response Model with Return Type Annotations, and update runtime error. PR [5873](https://github.com/tiangolo/fastapi/pull/5873) by [tiangolo](https://github.com/tiangolo). New docs at [Response Model - Return Type: Other Return Type Annotations](https://fastapi.tiangolo.com/tutorial/response-model/#other-return-type-annotations).
* 📝 Add External Link: FastAPI lambda container: serverless simplified. PR [5784](https://github.com/tiangolo/fastapi/pull/5784) by [rafrasenberg](https://github.com/rafrasenberg).

Translations

* 🌐 Add Turkish translation for `docs/tr/docs/tutorial/first_steps.md`. PR [5691](https://github.com/tiangolo/fastapi/pull/5691) by [Kadermiyanyedi](https://github.com/Kadermiyanyedi).

Features

* ✨ Add support for function return type annotations to declare the `response_model`. Initial PR [1436](https://github.com/tiangolo/fastapi/pull/1436) by [uriyyo](https://github.com/uriyyo).

Now you can declare the return type / `response_model` in the function return type annotation:

python
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
name: str
price: float


app.get("/items/")
async def read_items() -> list[Item]:
return [
Item(name="Portal Gun", price=42.0),
Item(name="Plumbus", price=32.0),
]


FastAPI will use the return type annotation to perform:

* Data validation
* Automatic documentation
* It could power automatic client generators
* **Data filtering**

Before this version it was only supported via the `response_model` parameter.

Read more about it in the new docs: [Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/).

Docs

* 📝 Add External Link: Authorization on FastAPI with Casbin. PR [5712](https://github.com/tiangolo/fastapi/pull/5712) by [Xhy-5000](https://github.com/Xhy-5000).
* ✏ Fix typo in `docs/en/docs/async.md`. PR [5785](https://github.com/tiangolo/fastapi/pull/5785) by [Kingdageek](https://github.com/Kingdageek).
* ✏ Fix typo in `docs/en/docs/deployment/concepts.md`. PR [5824](https://github.com/tiangolo/fastapi/pull/5824) by [kelbyfaessler](https://github.com/kelbyfaessler).

Translations

* 🌐 Add Russian translation for `docs/ru/docs/fastapi-people.md`. PR [5577](https://github.com/tiangolo/fastapi/pull/5577) by [Xewus](https://github.com/Xewus).
* 🌐 Fix typo in Chinese translation for `docs/zh/docs/benchmarks.md`. PR [4269](https://github.com/tiangolo/fastapi/pull/4269) by [15027668g](https://github.com/15027668g).
* 🌐 Add Korean translation for `docs/tutorial/cors.md`. PR [3764](https://github.com/tiangolo/fastapi/pull/3764) by [NinaHwang](https://github.com/NinaHwang).

Internal

* ⬆ Update coverage[toml] requirement from <7.0,>=6.5.0 to >=6.5.0,<8.0. PR [5801](https://github.com/tiangolo/fastapi/pull/5801) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update uvicorn[standard] requirement from <0.19.0,>=0.12.0 to >=0.12.0,<0.21.0 for development. PR [5795](https://github.com/tiangolo/fastapi/pull/5795) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump dawidd6/action-download-artifact from 2.24.2 to 2.24.3. PR [5842](https://github.com/tiangolo/fastapi/pull/5842) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👥 Update FastAPI People. PR [5825](https://github.com/tiangolo/fastapi/pull/5825) by [github-actions[bot]](https://github.com/apps/github-actions).
* ⬆ Bump types-ujson from 5.5.0 to 5.6.0.0. PR [5735](https://github.com/tiangolo/fastapi/pull/5735) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump pypa/gh-action-pypi-publish from 1.5.2 to 1.6.4. PR [5750](https://github.com/tiangolo/fastapi/pull/5750) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👷 Add GitHub Action gate/check. PR [5492](https://github.com/tiangolo/fastapi/pull/5492) by [webknjaz](https://github.com/webknjaz).
* 🔧 Update sponsors, add Svix. PR [5848](https://github.com/tiangolo/fastapi/pull/5848) by [tiangolo](https://github.com/tiangolo).
* 🔧 Remove Doist sponsor. PR [5847](https://github.com/tiangolo/fastapi/pull/5847) by [tiangolo](https://github.com/tiangolo).
* ⬆ Update sqlalchemy requirement from <=1.4.41,>=1.3.18 to >=1.3.18,<1.4.43. PR [5540](https://github.com/tiangolo/fastapi/pull/5540) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump nwtgck/actions-netlify from 1.2.4 to 2.0.0. PR [5757](https://github.com/tiangolo/fastapi/pull/5757) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👷 Refactor CI artifact upload/download for docs previews. PR [5793](https://github.com/tiangolo/fastapi/pull/5793) by [tiangolo](https://github.com/tiangolo).
* ⬆ Bump pypa/gh-action-pypi-publish from 1.5.1 to 1.5.2. PR [5714](https://github.com/tiangolo/fastapi/pull/5714) by [dependabot[bot]](https://github.com/apps/dependabot).
* 👥 Update FastAPI People. PR [5722](https://github.com/tiangolo/fastapi/pull/5722) by [github-actions[bot]](https://github.com/apps/github-actions).
* 🔧 Update sponsors, disable course bundle. PR [5713](https://github.com/tiangolo/fastapi/pull/5713) by [tiangolo](https://github.com/tiangolo).
* ⬆ Update typer[all] requirement from <0.7.0,>=0.6.1 to >=0.6.1,<0.8.0. PR [5639](https://github.com/tiangolo/fastapi/pull/5639) by [dependabot[bot]](https://github.com/apps/dependabot).

Upgrades

* ⬆ Bump Starlette to version `0.22.0` to fix bad encoding for query parameters in new `TestClient`. PR [5659](https://github.com/tiangolo/fastapi/pull/5659) by [azogue](https://github.com/azogue).

Docs

* ✏️ Fix typo in docs for `docs/en/docs/advanced/middleware.md`. PR [5376](https://github.com/tiangolo/fastapi/pull/5376) by [rifatrakib](https://github.com/rifatrakib).

Translations

* 🌐 Add Portuguese translation for `docs/pt/docs/deployment/docker.md`. PR [5663](https://github.com/tiangolo/fastapi/pull/5663) by [ayr-ton](https://github.com/ayr-ton).

Internal

* 👷 Tweak build-docs to improve CI performance. PR [5699](https://github.com/tiangolo/fastapi/pull/5699) by [tiangolo](https://github.com/tiangolo).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [5566](https://github.com/tiangolo/fastapi/pull/5566) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* ⬆️ Upgrade Ruff. PR [5698](https://github.com/tiangolo/fastapi/pull/5698) by [tiangolo](https://github.com/tiangolo).
* 👷 Remove pip cache for Smokeshow as it depends on a requirements.txt. PR [5700](https://github.com/tiangolo/fastapi/pull/5700) by [tiangolo](https://github.com/tiangolo).
* 💚 Fix pip cache for Smokeshow. PR [5697](https://github.com/tiangolo/fastapi/pull/5697) by [tiangolo](https://github.com/tiangolo).
* 👷 Fix and tweak CI cache handling. PR [5696](https://github.com/tiangolo/fastapi/pull/5696) by [tiangolo](https://github.com/tiangolo).
* 👷 Update `setup-python` action in tests to use new caching feature. PR [5680](https://github.com/tiangolo/fastapi/pull/5680) by [madkinsz](https://github.com/madkinsz).
* ⬆ Bump black from 22.8.0 to 22.10.0. PR [5569](https://github.com/tiangolo/fastapi/pull/5569) by [dependabot[bot]](https://github.com/apps/dependabot).

Highlights of this release:

* [Upgraded Starlette](https://github.com/encode/starlette/releases/tag/0.21.0)
* Now the `TestClient` is based on HTTPX instead of Requests. 🚀
* There are some possible **breaking changes** in the `TestClient` usage, but [Kludex](https://github.com/Kludex) built [bump-testclient](https://github.com/Kludex/bump-testclient) to help you automatize migrating your tests. Make sure you are using Git and that you can undo any unnecessary changes (false positive changes, etc) before using `bump-testclient`.
* New [WebSocketException (and docs)](https://fastapi.tiangolo.com/advanced/websockets/#using-depends-and-others), re-exported from Starlette.
* Upgraded and relaxed dependencies for package extras `all` (including new Uvicorn version), when you install `"fastapi[all]"`.
* New docs about how to [**Help Maintain FastAPI**](https://fastapi.tiangolo.com/help-fastapi/#help-maintain-fastapi).

Features

* ⬆️ Upgrade and relax dependencies for extras "all". PR [5634](https://github.com/tiangolo/fastapi/pull/5634) by [tiangolo](https://github.com/tiangolo).
* ✨ Re-export Starlette's `WebSocketException` and add it to docs. PR [5629](https://github.com/tiangolo/fastapi/pull/5629) by [tiangolo](https://github.com/tiangolo).
* 📝 Update references to Requests for tests to HTTPX, and add HTTPX to extras. PR [5628](https://github.com/tiangolo/fastapi/pull/5628) by [tiangolo](https://github.com/tiangolo).
* ⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0). PR [#5471](https://github.com/tiangolo/fastapi/pull/5471) by [pawelrubin](https://github.com/pawelrubin).

Docs

* ✏️ Tweak Help FastAPI from PR review after merging. PR [5633](https://github.com/tiangolo/fastapi/pull/5633) by [tiangolo](https://github.com/tiangolo).
* ✏️ Clarify docs on CORS. PR [5627](https://github.com/tiangolo/fastapi/pull/5627) by [paxcodes](https://github.com/paxcodes).
* 📝 Update Help FastAPI: Help Maintain FastAPI. PR [5632](https://github.com/tiangolo/fastapi/pull/5632) by [tiangolo](https://github.com/tiangolo).

Translations

* 🌐 Fix highlight lines for Japanese translation for `docs/tutorial/query-params.md`. PR [2969](https://github.com/tiangolo/fastapi/pull/2969) by [ftnext](https://github.com/ftnext).
* 🌐 Add French translation for `docs/fr/docs/advanced/additional-status-code.md`. PR [5477](https://github.com/tiangolo/fastapi/pull/5477) by [axel584](https://github.com/axel584).
* 🌐 Add Portuguese translation for `docs/pt/docs/tutorial/request-forms-and-files.md`. PR [5579](https://github.com/tiangolo/fastapi/pull/5579) by [batlopes](https://github.com/batlopes).
* 🌐 Add Japanese translation for `docs/ja/docs/advanced/websockets.md`. PR [4983](https://github.com/tiangolo/fastapi/pull/4983) by [xryuseix](https://github.com/xryuseix).

Internal

* ✨ Use Ruff for linting. PR [5630](https://github.com/tiangolo/fastapi/pull/5630) by [tiangolo](https://github.com/tiangolo).
* 🛠 Add Arabic issue number to Notify Translations GitHub Action. PR [5610](https://github.com/tiangolo/fastapi/pull/5610) by [tiangolo](https://github.com/tiangolo).
* ⬆ Bump dawidd6/action-download-artifact from 2.24.1 to 2.24.2. PR [5609](https://github.com/tiangolo/fastapi/pull/5609) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump dawidd6/action-download-artifact from 2.24.0 to 2.24.1. PR [5603](https://github.com/tiangolo/fastapi/pull/5603) by [dependabot[bot]](https://github.com/apps/dependabot).
* 📝 Update coverage badge to use Samuel Colvin's Smokeshow. PR [5585](https://github.com/tiangolo/fastapi/pull/5585) by [tiangolo](https://github.com/tiangolo).

Features

* ⬆ Add Python 3.11 to the officially supported versions. PR [5587](https://github.com/tiangolo/fastapi/pull/5587) by [tiangolo](https://github.com/tiangolo).
* ✅ Enable tests for Python 3.11. PR [4881](https://github.com/tiangolo/fastapi/pull/4881) by [tiangolo](https://github.com/tiangolo).

Fixes

* 🐛 Close FormData (uploaded files) after the request is done. PR [5465](https://github.com/tiangolo/fastapi/pull/5465) by [adriangb](https://github.com/adriangb).

Docs

* ✏ Fix typo in `docs/en/docs/tutorial/security/oauth2-jwt.md`. PR [5584](https://github.com/tiangolo/fastapi/pull/5584) by [vivekashok1221](https://github.com/vivekashok1221).

Translations

* 🌐 Update wording in Chinese translation for `docs/zh/docs/python-types.md`. PR [5416](https://github.com/tiangolo/fastapi/pull/5416) by [supercaizehua](https://github.com/supercaizehua).
* 🌐 Add Russian translation for `docs/ru/docs/deployment/index.md`. PR [5336](https://github.com/tiangolo/fastapi/pull/5336) by [Xewus](https://github.com/Xewus).
* 🌐 Update Chinese translation for `docs/tutorial/security/oauth2-jwt.md`. PR [3846](https://github.com/tiangolo/fastapi/pull/3846) by [jaystone776](https://github.com/jaystone776).

Internal

* 👷 Update FastAPI People to exclude bots: pre-commit-ci, dependabot. PR [5586](https://github.com/tiangolo/fastapi/pull/5586) by [tiangolo](https://github.com/tiangolo).
* 🎨 Format OpenAPI JSON in `test_starlette_exception.py`. PR [5379](https://github.com/tiangolo/fastapi/pull/5379) by [iudeen](https://github.com/iudeen).
* 👷 Switch from Codecov to Smokeshow plus pytest-cov to pure coverage for internal tests. PR [5583](https://github.com/tiangolo/fastapi/pull/5583) by [tiangolo](https://github.com/tiangolo).
* 👥 Update FastAPI People. PR [5571](https://github.com/tiangolo/fastapi/pull/5571) by [github-actions[bot]](https://github.com/apps/github-actions).

**Note**: this release doesn't affect final users, it's mainly internal. It unlocks Pydanitc work with the integration that runs FastAPI's tests in Pydantic's CI.

Docs

* ✏ Fix grammar and add helpful links to dependencies in `docs/en/docs/async.md`. PR [5432](https://github.com/tiangolo/fastapi/pull/5432) by [pamelafox](https://github.com/pamelafox).
* ✏ Fix broken link in `alternatives.md`. PR [5455](https://github.com/tiangolo/fastapi/pull/5455) by [su-shubham](https://github.com/su-shubham).
* ✏ Fix typo in docs about contributing, for compatibility with `pip` in Zsh. PR [5523](https://github.com/tiangolo/fastapi/pull/5523) by [zhangbo2012](https://github.com/zhangbo2012).
* 📝 Fix typo in docs with examples for Python 3.10 instead of 3.9. PR [5545](https://github.com/tiangolo/fastapi/pull/5545) by [feliciss](https://github.com/feliciss).

Translations

* 🌐 Add Portuguese translation for `docs/pt/docs/tutorial/request-forms.md`. PR [4934](https://github.com/tiangolo/fastapi/pull/4934) by [batlopes](https://github.com/batlopes).
* 🌐 Add Chinese translation for `docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md`. PR [4971](https://github.com/tiangolo/fastapi/pull/4971) by [Zssaer](https://github.com/Zssaer).
* 🌐 Add French translation for `deployment/deta.md`. PR [3692](https://github.com/tiangolo/fastapi/pull/3692) by [rjNemo](https://github.com/rjNemo).
* 🌐 Update Chinese translation for `docs/zh/docs/tutorial/query-params-str-validations.md`. PR [5255](https://github.com/tiangolo/fastapi/pull/5255) by [hjlarry](https://github.com/hjlarry).
* 🌐 Add Chinese translation for `docs/zh/docs/tutorial/sql-databases.md`. PR [4999](https://github.com/tiangolo/fastapi/pull/4999) by [Zssaer](https://github.com/Zssaer).
* 🌐 Add Chinese translation for `docs/zh/docs/advanced/wsgi.md`. PR [4505](https://github.com/tiangolo/fastapi/pull/4505) by [ASpathfinder](https://github.com/ASpathfinder).
* 🌐 Add Portuguese translation for `docs/pt/docs/tutorial/body-multiple-params.md`. PR [4111](https://github.com/tiangolo/fastapi/pull/4111) by [lbmendes](https://github.com/lbmendes).
* 🌐 Add Portuguese translation for `docs/pt/docs/tutorial/path-params-numeric-validations.md`. PR [4099](https://github.com/tiangolo/fastapi/pull/4099) by [lbmendes](https://github.com/lbmendes).
* 🌐 Add French translation for `deployment/versions.md`. PR [3690](https://github.com/tiangolo/fastapi/pull/3690) by [rjNemo](https://github.com/rjNemo).
* 🌐 Add French translation for `docs/fr/docs/help-fastapi.md`. PR [2233](https://github.com/tiangolo/fastapi/pull/2233) by [JulianMaurin](https://github.com/JulianMaurin).
* 🌐 Fix typo in Chinese translation for `docs/zh/docs/tutorial/security/first-steps.md`. PR [5530](https://github.com/tiangolo/fastapi/pull/5530) by [yuki1sntSnow](https://github.com/yuki1sntSnow).
* 🌐 Add Portuguese translation for `docs/pt/docs/tutorial/response-status-code.md`. PR [4922](https://github.com/tiangolo/fastapi/pull/4922) by [batlopes](https://github.com/batlopes).
* 🔧 Add config for Tamil translations. PR [5563](https://github.com/tiangolo/fastapi/pull/5563) by [tiangolo](https://github.com/tiangolo).

Internal

* ⬆ Bump internal dependency mypy from 0.971 to 0.982. PR [5541](https://github.com/tiangolo/fastapi/pull/5541) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump nwtgck/actions-netlify from 1.2.3 to 1.2.4. PR [5507](https://github.com/tiangolo/fastapi/pull/5507) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump internal dependency types-ujson from 5.4.0 to 5.5.0. PR [5537](https://github.com/tiangolo/fastapi/pull/5537) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Bump dawidd6/action-download-artifact from 2.23.0 to 2.24.0. PR [5508](https://github.com/tiangolo/fastapi/pull/5508) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ Update internal dependency pytest-cov requirement from <4.0.0,>=2.12.0 to >=2.12.0,<5.0.0. PR [5539](https://github.com/tiangolo/fastapi/pull/5539) by [dependabot[bot]](https://github.com/apps/dependabot).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [5536](https://github.com/tiangolo/fastapi/pull/5536) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* 🐛 Fix internal Trio test warnings. PR [5547](https://github.com/tiangolo/fastapi/pull/5547) by [samuelcolvin](https://github.com/samuelcolvin).
* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [5408](https://github.com/tiangolo/fastapi/pull/5408) by [pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
* ⬆️ Upgrade Typer to include Rich in scripts for docs. PR [5502](https://github.com/tiangolo/fastapi/pull/5502) by [tiangolo](https://github.com/tiangolo).
* 🐛 Fix calling `mkdocs` for languages as a subprocess to fix/enable MkDocs Material search plugin. PR [5501](https://github.com/tiangolo/fastapi/pull/5501) by [tiangolo](https://github.com/tiangolo).