NotificationsYou must be signed in to change notification settings
Fork2.2k
Star24.6k

Briefly describe arguments for`model.model_dump()`#11562

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

Jump to bottom

Merged

Viicos merged 4 commits intopydantic:mainfromcmenon12:cmenon12-serialization-docs

Mar 19, 2025

Merged

Briefly describe arguments for`model.model_dump()`#11562

Viicos merged 4 commits intopydantic:mainfromcmenon12:cmenon12-serialization-docs

Mar 19, 2025

Conversation

Copy link

Contributor

cmenon12 commentedMar 15, 2025•
edited by pydantic-hookybot
Loading

Change Summary

Briefly describe the arguments available formodel.model_dump() in theSerialization concept docs, particularly about themode argument.

Also make a couple of small grammar/consistency tweaks.

Related issue number

None - this is just a small change to the docs.

Checklist

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

Selected Reviewer:@sydney-runkle

cmenon12 added2 commits

March 15, 2025 21:51

Briefly describe arguments for model.model_dump()

dbf27e1

Minor fixes

05a54ae

github-actionsbot added the documentation label

Mar 15, 2025

Copy link

Contributor

hyperlint-aibot commentedMar 15, 2025

PR Change Summary

Updated documentation formodel.model_dump() to clarify the available arguments, particularly themode argument, and made minor grammatical adjustments for consistency.

Described themode argument in the context ofmodel.model_dump() for better clarity.
Added a note about JSON serialization in the serialization documentation.
Improved consistency in terminology related to arguments in the documentation.

Modified Files

docs/concepts/serialization.md

How can I customize these reviews?

Check out theHyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add thehyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to addhyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about theHyperlint AI reviewer and the checks that we can run on your documentation.

Copy link

Contributor

github-actionsbot commentedMar 15, 2025•
edited
Loading

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

codspeed-hqbot commentedMar 15, 2025•
edited
Loading

CodSpeed Performance Report

Merging#11562 willdegrade performances by 6.69%

_{Comparingcmenon12:cmenon12-serialization-docs (83a4fca) withmain (a2846da)}

Summary

❌ 1 regressions
✅ 45 untouched benchmarks

⚠️Please fix the performance issues oracknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	`BASE`	`HEAD`	Change
❌	`test_model_validators_serializers`	767.7 µs	822.7 µs	-6.69%

Copy link

ContributorAuthor

cmenon12 commentedMar 15, 2025

please review

pydantic-hookybot added the ready for review label

Mar 15, 2025

Viicos requested changes

Mar 17, 2025

View reviewed changes

Copy link

Member

Viicos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks, a couple changes

docs/concepts/serialization.md Outdated

		@@ -104,7 +108,7 @@ print(Model(x=['{"a": 1}', '[1, 2]']).model_dump(round_trip=True))
		The `.model_dump_json()` method serializes a model directly to a JSON-encoded string
		that is equivalent to the result produced by [`.model_dump()`](#modelmodel_dump).

		See [arguments][pydantic.main.BaseModel.model_dump_json] for more information.
		Seethe available[arguments][pydantic.main.BaseModel.model_dump_json] for more information.

Copy link

Member

ViicosMar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	See the available[arguments][pydantic.main.BaseModel.model_dump_json] for more information.
	See the available[parameters][pydantic.main.BaseModel.model_dump_json] for more information.

docs/concepts/serialization.md Outdated

		@@ -21,6 +21,10 @@ serialized, and exported in a number of ways.

		This is the primary way of converting a model to a dictionary. Sub-models will be recursively converted to dictionaries.

		By default, the output may contain non-JSON-serializable Python objects. The `mode` argument can be specified as `"json"` to ensure that the output only contains JSON serializable types. Other arguments exist to include or exclude fields, [including nested fields](#advanced-include-and-exclude), or to further customize the serialization behaviour.

		See the available [arguments][pydantic.main.BaseModel.model_dump] for more information.

Copy link

Member

ViicosMar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	See the available[arguments][pydantic.main.BaseModel.model_dump] for more information.
	See the available[parameters][pydantic.main.BaseModel.model_dump] for more information.

docs/concepts/serialization.md Outdated

		@@ -839,7 +843,7 @@ print(t.model_dump(include={'id': True, 'value': True})) # (1)!
		1. `value` excluded from the output because it excluded in `Field`.

		That being said, setting `exclude` on the field constructor (`Field(exclude=True)`) does not take priority
		over the `exclude_unset`, `exclude_none`, and `exclude_default`parameters on `model_dump` and `model_dump_json`:
		over the `exclude_unset`, `exclude_none`, and `exclude_default`arguments on `model_dump` and `model_dump_json`:

Copy link

Member

ViicosMar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	over the`exclude_unset`,`exclude_none`, and`exclude_default`arguments on`model_dump` and`model_dump_json`:
	over the`exclude_unset`,`exclude_none`, and`exclude_default`parameters on`model_dump` and`model_dump_json`: