Use pydantic for algo option validation (instead of our own validation logict). - #696
Open
janosg wants to merge 6 commits into
Open
Use pydantic for algo option validation (instead of our own validation logict).#696janosg wants to merge 6 commits into
janosg wants to merge 6 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
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.
Current situation
Algorithm options are converted and validated by a hand-written converter table (TYPE_CONVERTERS in type_conversion.py) that Algorithm.post_init looks up per field, keyed by type objects for eight supported types. AlgoInfo and InternalOptimizeResult carry ~50 lines of manual isinstance checks each.
Two problems are hard to solve within this design:
Proposed Implementation
Replace our validation logic with pydantic.
Backwards compatibility
mark.minimizer, so no algorithm definition changes.InvalidAlgoOptionError,InvalidAlgoInfoError,TypeErrorforInternalOptimizeResult), including for unknown constructor kwargs (extra="forbid").Remaining breaking changes:
Alternatives
PR #691 patches the string-annotation symptom by adding a second, string-keyed converter table (TYPE_CONVERTERS_BY_NAME) and branching on the annotation kind in post_init. That fixes the silently-skipped coercion but keeps everything else: optional and union types remain unvalidated, coverage stays limited to eight hand-written converters, and two parallel tables must be kept in sync with typing.py forever. This PR solves the whole class of problems, deletes code instead of adding it, and extends naturally to the other validation boilerplate in the codebase (#694, #695). If this is merged, #691 should be closed and #690 rebased onto main afterwards.