Fix HashModel list validation blocking vector fields#785
Merged
Conversation
HashModel.__init_subclass__ rejected list fields unconditionally, but vector fields require list[float] type annotation. Now checks for vector_options before raising the error. Also adds automatic serialization of vector list[float] to bytes for Redis Hash storage, and deserialization back to list[float] on retrieval. Fixes #544
4d789b3 to
8ef248e
Compare
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
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.
Summary
Fixes #544 - HashModel incorrectly rejected
list[float]fields even when they were vector fields that require this type annotation.Changes
Modified
HashModel.__init_subclass__to check if a field hasvector_optionsbefore raising the "cannot index list" error. Vector fields are now allowed to uselist[float]type.Added vector serialization in
save()- Vector fields (list[float]) are automatically serialized to packed float32 bytes before storage, since Redis Hash fields can only store scalar values.Added vector deserialization in
get()- Packed bytes are automatically converted back tolist[float]when retrieving vector fields.Example Usage
Testing
test_hashmodel_vector_field_with_listto verify the fix