Rewrite serialization documentation#12018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open

Viicos wants to merge6 commits intomain

base:main

Choose a base branch

Open

Viicos wants to merge6 commits intomainfromserialization-rewrite

Conversation

Copy link

Member

This aligns the serialization documentation with the previousvalidators documentation rewrite.

The diff will be unreadable so it is best to check the preview instead.

As header names were changed for the most part, fallback headings were added to avoid creating dead links.

Changes:

Lots of rewording.
Align serializers section with the pattern used in the validation rewrite (tabs for both decorator and annotated pattern, add section about annotated vs decorator).
Add proper section about serialization info, serialization context being a subsection.
Remove lots of repetition in the duck typing section.
Removed some sections that are too specific and mainly adding noise:
- removedhttps://docs.pydantic.dev/latest/concepts/serialization/#overriding-the-serialize_as_any-default-false
- removedhttps://docs.pydantic.dev/latest/concepts/serialization/#overriding-the-return-type-when-dumping-a-model
Simplified include/exclude examples.
Documentedexclude_none and friends.

The pull request title is a good summary of the changes - it will be used in the changelog
Unit tests for the changes exist
Tests pass on CI
Documentation reflects the changes where applicable
My PR is ready to review,please add a comment including the phrase "please review" to assign reviewers

Rewrite serialization documentation

d429ff3

github-actionsbot added the relnotes-fixUsed for bugfixes. label

Bump pydantic-core

cbd847c

Copy link

Latest commit:	`7f86019`
Status:	✅ Deploy successful!
Preview URL:	https://7a42ac80.pydantic-docs.pages.dev
Branch Preview URL:	https://serialization-rewrite.pydantic-docs.pages.dev

Viicos commented

		@@ -695,6 +695,41 @@ Here are some additional notes on the behavior of [`model_construct()`][pydantic
		not stored in `__pydantic_extra__` or `__dict__` on the instance.
		* Unlike when instantiating the model with validation, a call to [`model_construct()`][pydantic.main.BaseModel.model_construct] with [`extra`][pydantic.ConfigDict.extra] set to `'forbid'` doesn't raise an error in the presence of data not corresponding to fields. Rather, said input data is simply ignored.

		## Model copy