Update dependency fastapi to v0.101.0

Review changes
Download
Patches
Plain diff

Merged Update dependency fastapi to v0.101.0

Overview 0
Commits 1
Pipelines 0
Changes 2

Merged renovate-bot requested to merge renovate/fastapi-0.x into master 2 years ago

Overview 0
Commits 1
Pipelines 0
Changes 2

This MR contains the following updates:

Package	Type	Update	Change
fastapi	dependencies	minor	`0.95.1` -> `0.101.0`

Release Notes

tiangolo/fastapi

`v0.101.0`

Compare Source

Features

Enable Pydantic's serialization mode for responses, add support for Pydantic's computed_field, better OpenAPI for response models, proper required attributes, better generated clients. MR #10011 by @tiangolo.

Refactors

Fix tests for compatibility with pydantic 2.1.1. MR #9943 by @dmontagu.
Fix test error in Windows for jsonable_encoder. MR #9840 by @iudeen.

Upgrades

Do not allow Pydantic 2.1.0 that breaks (require 2.1.1). MR #10012 by @tiangolo.

Translations

Add Russian translation for docs/ru/docs/tutorial/security/index.md. MR #9963 by @eVery1337.
Remove Vietnamese note about missing translation. MR #9957 by @tiangolo.

Internal

Add GitHub Actions step dump context to debug external failures. MR #10008 by @tiangolo.
Restore MkDocs Material pin after the fix. MR #10001 by @tiangolo.
Update the Question template to ask for the Pydantic version. MR #10000 by @tiangolo.
Update MkDocs Material dependencies. MR #9986 by @tiangolo.
Update FastAPI People. MR #9999 by @tiangolo.
Update Dockerfile with compatibility versions, to upgrade later. MR #9998 by @tiangolo.
Add pydantic-settings to FastAPI People dependencies. MR #9988 by @tiangolo.
️ Update FastAPI People logic with new Pydantic. MR #9985 by @tiangolo.
Update sponsors, Fern badge. MR #9982 by @tiangolo.
Deploy docs to Cloudflare Pages. MR #9978 by @tiangolo.
Update sponsor Fern. MR #9979 by @tiangolo.
Update CI debug mode with Tmate. MR #9977 by @tiangolo.

`v0.100.1`

Compare Source

Fixes

Replace MultHostUrl to AnyUrl for compatibility with older versions of Pydantic v1. MR #9852 by @Kludex.

Docs

Update links for self-hosted Swagger UI, point to v5, for OpenAPI 31.0. MR #9834 by @tiangolo.

Translations

Add Ukrainian translation for docs/uk/docs/tutorial/body.md. MR #4574 by @ss-o-furda.
Add Vietnamese translation for docs/vi/docs/features.md and docs/vi/docs/index.md. MR #3006 by @magiskboy.
Add Korean translation for docs/ko/docs/async.md. MR #4179 by @NinaHwang.
Add Chinese translation for docs/zh/docs/tutorial/background-tasks.md. MR #9812 by @wdh99.
Add French translation for docs/fr/docs/tutorial/query-params-str-validations.md. MR #4075 by @Smlep.
Add French translation for docs/fr/docs/tutorial/index.md. MR #2234 by @JulianMaurin.
Add French translation for docs/fr/docs/contributing.md. MR #2132 by @JulianMaurin.
Add French translation for docs/fr/docs/benchmarks.md. MR #2155 by @clemsau.
Update Chinese translations with new source files. MR #9738 by @mahone3297.
Add Russian translation for docs/ru/docs/tutorial/request-forms.md. MR #9841 by @dedkot01.
Update Chinese translation for docs/zh/docs/tutorial/handling-errors.md. MR #9485 by @Creat55.

Internal

Update sponsors, add Fern. MR #9956 by @tiangolo.
Update FastAPI People token. MR #9844 by @tiangolo.
Update FastAPI People. MR #9775 by @tiangolo.
Update MkDocs Material token. MR #9843 by @tiangolo.
Update token for latest changes. MR #9842 by @tiangolo.

`v0.100.0`

Compare Source

Support for Pydantic v2

Pydantic version 2 has the core re-written in Rust and includes a lot of improvements and features, for example:

Improved correctness in corner cases.
Safer types.
Better performance and less energy consumption.
Better extensibility.
etc.

...all this while keeping the same Python API. In most of the cases, for simple models, you can simply upgrade the Pydantic version and get all the benefits.

In some cases, for pure data validation and processing, you can get performance improvements of 20x or more. This means 2,000% or more. 🤯

When you use FastAPI, there's a lot more going on, processing the request and response, handling dependencies, executing your own code, and particularly, waiting for the network. But you will probably still get some nice performance improvements just from the upgrade.

The focus of this release is compatibility with Pydantic v1 and v2, to make sure your current apps keep working. Later there will be more focus on refactors, correctness, code improvements, and then performance improvements. Some third-party early beta testers that ran benchmarks on the beta releases of FastAPI reported improvements of 2x - 3x. Which is not bad for just doing pip install --upgrade fastapi pydantic. This was not an official benchmark and I didn't check it myself, but it's a good sign.

Migration

Check out the Pydantic migration guide.

For the things that need changes in your Pydantic models, the Pydantic team built bump-pydantic.

A command line tool that will process your code and update most of the things automatically for you. Make sure you have your code in git first, and review each of the changes to make sure everything is correct before committing the changes.

Pydantic v1

This version of FastAPI still supports Pydantic v1. And although Pydantic v1 will be deprecated at some point, ti will still be supported for a while.

This means that you can install the new Pydantic v2, and if something fails, you can install Pydantic v1 while you fix any problems you might have, but having the latest FastAPI.

There are tests for both Pydantic v1 and v2, and test coverage is kept at 100%.

Changes

There are new parameter fields supported by Pydantic Field() for:
- Path()
- Query()
- Header()
- Cookie()
- Body()
- Form()
- File()
The new parameter fields are:
- default_factory
- alias_priority
- validation_alias
- serialization_alias
- discriminator
- strict
- multiple_of
- allow_inf_nan
- max_digits
- decimal_places
- json_schema_extra

...you can read about them in the Pydantic docs.

The parameter regex has been deprecated and replaced by pattern.
- You can read more about it in the docs for Query Parameters and String Validations: Add regular expressions.
New Pydantic models use an improved and simplified attribute model_config that takes a simple dict instead of an internal class Config for their configuration.
- You can read more about it in the docs for Declare Request Example Data.
The attribute schema_extra for the internal class Config has been replaced by the key json_schema_extra in the new model_config dict.
- You can read more about it in the docs for Declare Request Example Data.
When you install "fastapi[all]" it now also includes:
- pydantic-settings - for settings management.
- pydantic-extra-types - for extra types to be used with Pydantic.
Now Pydantic Settings is an additional optional package (included in "fastapi[all]"). To use settings you should now import from pydantic_settings import BaseSettings instead of importing from pydantic directly.
- You can read more about it in the docs for Settings and Environment Variables.
MR #9816 by @tiangolo, included all the work done (in multiple MRs) on the beta branch (main-pv2).

`v0.99.1`

Compare Source

Fixes

Fix JSON Schema accepting bools as valid JSON Schemas, e.g. additionalProperties: false. MR #9781 by @tiangolo.

Docs

Update source examples to use new JSON Schema examples field. MR #9776 by @tiangolo.

`v0.99.0`

Compare Source

Note: this is the last release before supporting Pydantic v2. You can try out the beta with support for Pydantic v2 now, a new beta supporting Pydantic v2 with these same changes from this release will be available in the next hours/days. And the final version (0.100.0) with support for Pydantic v2 will be released in the next days (next week).

Now, back to this release (this one doesn't include the beta support for Pydantic v2).

This release has OpenAPI 3.1.0