feat!: compatibility with pydantic v2 #148
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pydantic v1 is EOL, but some users of this library still use it. Pydantic v2 contains the pydantic v1 in the pydantic.v1 namespace, and pydantic v1.10.17+ also contains this same namespace. So, step one to migrating to Pydantic v2 is to use the pydantic.v1 namespace throughout. Then, in future, the models can be updated to true Pydantic v2 when all consumers are ready for it. I'm marking this as a breaking change since the pydantic library update is not backwards compatible. Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
ddneilson
force-pushed
the
pydantic_v2_compat
branch
from
dbf2a64 to
1bc4470
Compare
|
epmog
approved these changes
Oct 28, 2024
mwiebe
approved these changes
Oct 28, 2024
AWS-Samuel
approved these changes
Oct 28, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #107
What was the problem/requirement? (What/Why)
Pydantic v1 is EOL, but some users of this library still use it. Those users would like to update to pydantic v2, but this library needs to be compatible with it for that to happen.
What was the solution? (How)
Pydantic v2 contains the pydantic v1 in the pydantic.v1 namespace, and pydantic v1.10.17+ also contains this same namespace. So, step one to migrating to Pydantic v2 is to use the pydantic.v1 namespace throughout. Then, in future, the models can be updated to true Pydantic v2 when all consumers are ready for it.
What is the impact of this change?
Consumers of this library can now update to a newer Pydantic without this library blocking them.
How was this change tested?
The unit tests pass. I've run the tests both with pydantic 1.10.18 and pydantic 2.9.2.
Was this change documented?
Is this a breaking change?
I'm marking this as a breaking change since the pydantic library update is not backwards compatible.
Does this change impact security?
No
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.