Work with pydantic 2.10 #87
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
After much confusion around TypeAlias types, this is fixed by adding return_type to the PlainSerialiser annotation. Pydantic 2.10 is stricter about forward references in type annotations. This becomes a problem for NDArray, because the NestedListOfNumbers type it returns isn't present in the scope of the model (which probably only imported NDArray). The solution to this is to specify return_type explicitly, rather than infer it based on the annotation of the serialiser function. Using the `type` keyword might help in the future, but is currently only Python 3.12 and up. As part of this I realised there was some incorrect logic in `type_to_dataschema` which was using TypeAdapter on BaseModel subclasses, which is ineefficient. A test is added that should fail if this issue resurfaces.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pydantic 2.10 is stricter about forward references for types. This caused my
NDArrayannotated type to fail, because the return type of the serialiser function was not in scope when function input/output models were built.This PR fixes the problem by explicitly specifying a
return_typefor the serialiser, and tidies up a few loose ends that appeared while debugging. A test is added to ensure this issue will trigger a failure if it recurs.