pypi fastapi 0.137.0
on Python PyPI

7 hours ago

Breaking Changes

  • ♻️ Refactor internals to preserve APIRouter and APIRoute instances. PR #15745 by @tiangolo.

Unblocks ✨ SO MANY THINGS ✨

Before this, router.include_router(other_router) would take each path operation from other_router and "clone" it, or recreate it from scratch.

This would mean that in the end there was only one top level router, part of the app.

The way it is structured here is that there are a few additional classes to handle intermediate metadata for router and route inclusion. That way the information of "router X includes Y and Y includes Z" is stored somewhere, without affecting (recreating / clonning) the final route.

Non Objectives

Dependencies for 404: previously I intended to support dependencies that would be executed even for 404, but that would conflict with the fact that a router could not find a match, but the next router did find a match. Executing dependencies in the router that did not find a match would not make sense, they could consume the request, body, etc. This original idea was discarded.

Specific Breaking Changes

Now router.routes is no longer a plain list of APIRoute objects, it can contain these intermediate objects that can contain additional routers, forming a tree.

Any logic that depended on iterating on the router.routes directly would be affected, that logic cannot expect to be able to extract data from a plain list of routes, as it's no longer a plain list but a tree.

Additionally, any logic that iterated on router.routes to modify them would now also see these new objects, and would not see all the routes in the app.

router.routes should be considered an internal implementation detail, only passed around to the FastAPI functions that need it.

Features

  • Adding routes (path operations) after a router is included now works, they are reflected as they are not copied.
  • Including subrouter in mainrouter can be done before adding routes (path operations) to subrouter, because now the the entire object is stored instead of copying the routes.
  • As routes are not copied, in some cases that might save some memory.

Alpha Features

This is not documented yet, so it's not officially supported yet and could change in the future.

But, as APIRoute and APIRouter instances are now preserved, they could be customized.

APIRouter has two new methods, .matches() and .handle(), counterpart to the existing ones in APIRoute. With this a router could customize how it matches and handles requests. For example, it could match only requests that include some specific header, for example for handling versions in headers.

Still, for now, consider this very experimental and potentially changing and breaking in the future.

Future Features Enabled

  • Custom APIRoute subclasses (undocumented, but alraedy works as desccribed above)
  • Custom APIRouter subclasses (undocumented, but already works as described above)
  • Dependencies per router
  • Exception handlers per router
  • Middleware per router
  • Other features planned

Docs

  • 📝 Update release notes. PR #15747 by @tiangolo.
  • 📝 Update FastAPI Cloud deployment instructions. PR #15724 by @alejsdev.
  • ✏️ Use Annotated in inline example in docs/en/docs/tutorial/body-multiple-params.md. PR #15591 by @TheArchons.
  • 📝 Remove "NGINX Unit" from the list of ASGI-servers in docs. PR #15475 by @angryfoxx.
  • 📝 Update docs/en/docs/tutorial/security/oauth2-jwt.md. PR #14781 by @zadevhub.

Translations

  • 🌐 Update translations for zh-hant (update-outdated). PR #15671 by @tiangolo.
  • 🌐 Update translations for es (update-outdated). PR #15670 by @tiangolo.
  • 🌐 Update translations for fr (update-outdated). PR #15669 by @tiangolo.
  • 🌐 Update translations for ja (update-outdated). PR #15668 by @tiangolo.
  • 🌐 Update translations for pt (update-outdated). PR #15667 by @tiangolo.
  • 🌐 Update translations for tr (update-outdated). PR #15666 by @tiangolo.
  • 🌐 Update translations for zh (update-outdated). PR #15665 by @tiangolo.
  • 🌐 Update translations for ko (update-outdated). PR #15664 by @tiangolo.
  • 🌐 Update translations for de (update-outdated). PR #15673 by @tiangolo.
  • 🌐 Update translations for uk (update-outdated). PR #15672 by @tiangolo.
  • 🌐 Update translations for ru (update-outdated). PR #15674 by @tiangolo.

Internal

Check out latest releases or
releases around fastapi 0.137.0

Don't miss a new fastapi release

NewReleases is sending notifications on new releases.

Get notifications