fix(deps): update dependency fastapi to ^0.100.0

[bcgov-devops]

This PR contains the following updates:

Package	Type	Update	Change
fastapi	dependencies	minor	^0.98.0 -> ^0.100.0

---

Release Notes

tiangolo/fastapi

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.

• PR #​9816 by @​tiangolo, included all the work done (in multiple PRs) 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. PR #​9781 by @​tiangolo.

Docs

• 📝 Update source examples to use new JSON Schema examples field. PR #​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 ✨ 🎉

Features

• ✨ Add support for OpenAPI 3.1.0. PR #​9770 by @​tiangolo.

  • New support for documenting webhooks, read the new docs here: Advanced User Guide: OpenAPI Webhooks.
  • Upgrade OpenAPI 3.1.0, this uses JSON Schema 2020-12.
  • Upgrade Swagger UI to version 5.x.x, that supports OpenAPI 3.1.0.
  • Updated examples field in Query(), Cookie(), Body(), etc. based on the latest JSON Schema and OpenAPI. Now it takes a list of examples and they are included directly in the JSON Schema, not outside. Read more about it (including the historical technical details) in the updated docs: Tutorial: Declare Request Example Data.

• ✨ Add support for deque objects and children in jsonable_encoder. PR #​9433 by @​cranium.

Docs

• 📝 Fix form for the FastAPI and friends newsletter. PR #​9749 by @​tiangolo.

Translations

• 🌐 Add Persian translation for docs/fa/docs/advanced/sub-applications.md. PR #​9692 by @​mojtabapaso.
• 🌐 Add Russian translation for docs/ru/docs/tutorial/response-model.md. PR #​9675 by @​glsglsgls.

Internal

• 🔨 Enable linenums in MkDocs Material during local live development to simplify highlighting code. PR #​9769 by @​tiangolo.
• ⬆ Update httpx requirement from <0.24.0,>=0.23.0 to >=0.23.0,<0.25.0. PR #​9724 by @​dependabot[bot].
• ⬆ Bump mkdocs-material from 9.1.16 to 9.1.17. PR #​9746 by @​dependabot[bot].
• 🔥 Remove missing translation dummy pages, no longer necessary. PR #​9751 by @​tiangolo.
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #​9259 by @​pre-commit-ci[bot].
• ✨ Add Material for MkDocs Insiders features and cards. PR #​9748 by @​tiangolo.
• 🔥 Remove languages without translations. PR #​9743 by @​tiangolo.
• ✨ Refactor docs for building scripts, use MkDocs hooks, simplify (remove) configs for languages. PR #​9742 by @​tiangolo.
• 🔨 Add MkDocs hook that renames sections based on the first index file. PR #​9737 by @​tiangolo.
• 👷 Make cron jobs run only on main repo, not on forks, to avoid error notifications from missing tokens. PR #​9735 by @​tiangolo.
• 🔧 Update MkDocs for other languages. PR #​9734 by @​tiangolo.
• 👷 Refactor Docs CI, run in multiple workers with a dynamic matrix to optimize speed. PR #​9732 by @​tiangolo.
• 🔥 Remove old internal GitHub Action watch-previews that is no longer needed. PR #​9730 by @​tiangolo.
• ⬆️ Upgrade MkDocs and MkDocs Material. PR #​9729 by @​tiangolo.
• 👷 Build and deploy docs only on docs changes. PR #​9728 by @​tiangolo.

---

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 is behind base branch, 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 has been generated by Renovate Bot.