Skip to main content

Apply changes as patches to pydanic models.

Project description

pydantic-apply

Installation

Just use pip install pydantic-apply to install the library.

Note: pydantic-apply is compatible with pydantic versions 1.9, 1.10 and even 2.x (🥳) on Python 3.8, 3.9, 3.10 and 3.11. This is also ensured running all tests on all those versions using tox.

About

With pydantic-apply you can apply changes to your pydantic models by using the ApplyModelMixin it provides:

import pydantic

from pydantic_apply import ApplyModelMixin


class Something(ApplyModelMixin, pydantic.BaseModel):
    name: str
    age: int


obj = Something(name='John Doe', age=42)
obj.model_apply({
    "age": 43,
})
assert obj.age == 43

As the apply data you may pass any dictionary or other pydanic object as you wish. pydantic objects will be converted to dict's when being applied - but will only use fields that where explicitly set on the model instance. Also note that .apply() will ignore all fields not present in the model, like the model constructor would.

Nested models

pydantic-apply will also know how to apply changes to nested models. If those models are by themself subclasses of ApplyModelMixin it will call apply() on those fields as well. Otherwise the whole attribute will be replaced.

Apply changes when using validate_assignment

When your models have validate_assignment enabled it may become tricky to apply changes to the model. This is due to the fact that you only can assign fields once at a time. But with validate_assignment enabled this means each field assignment will trigger its own validation and this validation might fail as the model state is not completely changes and thus in a "broken" intermediate state.

pydantic-apply will take care of this issue and disable the validation for each assignment while applying the changes. It will also ensure the resulting object will still pass the validation, so you don't have to care about this case at all.

Contributing

If you want to contribute to this project, feel free to just fork the project, create a dev branch in your fork and then create a pull request (PR). If you are unsure about whether your changes really suit the project please create an issue first, to talk about this.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydantic_apply-0.5.8.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

pydantic_apply-0.5.8-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_apply-0.5.8.tar.gz.

File metadata

  • Download URL: pydantic_apply-0.5.8.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for pydantic_apply-0.5.8.tar.gz
Algorithm Hash digest
SHA256 456033ecaf93aa826192e8eac84db18e9fa1053cf8ba482dd6700e8be5e5709c
MD5 6986302a7592fbde1389c945b7e7fc77
BLAKE2b-256 3b1134ce55b9fcc275e2b89b21cb0e4f880202b5d26a94391e56a6b8cee060ac

See more details on using hashes here.

File details

Details for the file pydantic_apply-0.5.8-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_apply-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 35493b5fb7043ed42cf60575e22f75ceb5ea966a3787a106bc86e4aa2a50a794
MD5 601df9df52c02ed520e2a4553534105e
BLAKE2b-256 7ee4b9305368280dcf3d6876c4b7667181f39f99baa925dc388da1c37d0bf838

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page