fix: resolve IndexSchema fields type annotation inconsistency (#361)#381
Merged
Conversation
rbs333
approved these changes
Sep 24, 2025
abrookins
approved these changes
Sep 24, 2025
abrookins
left a comment
abrookins
left a comment
Collaborator
There was a problem hiding this comment.
Some non-blocking comments and ideas for your consideration. 👍
Fix conflicting type expectations in IndexSchema constructor and validation.
The type annotation declared `fields: Dict[str, BaseField]` but the validator
raised an error when fields was actually provided as a dict.
Changes:
- Update model validator to accept both list and dict formats for fields
- Support dict with field definitions: {"field_name": {"name": "field_name", "type": "text"}}
- Support dict with BaseField instances: {"field_name": BaseFieldInstance}
- Maintain backward compatibility with existing list format
- Use Field(default_factory=dict) instead of mutable default {}
- Change fields type annotation from Dict to Mapping for better type safety
- Use collections.abc.Mapping for isinstance checks
- Use Sequence check with str/bytes exclusion for list detection
- Add field name validation when BaseField is provided directly in dict format
Co-authored-by: Andrew Brookins <andrew@klaviyo.com>
bsbodden
force-pushed
the
bsb/issue-361
branch
from
57b37a7 to
09d0d44
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
3 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.
Fix conflicting type expectations in IndexSchema constructor and validation.
The type annotation declared
fields: Dict[str, BaseField]but the validatorraised an error when fields was actually provided as a dict.
Changes: