fix: resolve flaky tenant input validation in Python 3.12#2043
Open
paulxg12 wants to merge 1 commit into
Open
Conversation
Use instead of for runtime issubclass/isinstance checks in the input validator. The typing module's Sequence can produce flaky isinstance() results in Python 3.12+ due to internal changes in the typing module, causing valid Sequence inputs (e.g., a list of Tenant objects) to be incorrectly rejected. Also adds targeted test coverage for the Sequence[Union[...]] validation pattern that reproduces the reported failure scenario.
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
|
To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge. |
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.
What
Replaces
typing.Sequencewithcollections.abc.Sequencefor all runtimeisinstance/issubclasschecks in the input validator. The existing tests pass in Python 3.9-3.14 after this change.Why
Fixes #1355. In Python 3.12+,
typing.Sequencecan produce flaky results when used in runtimeisinstance()checks due to internal changes in thetypingmodule. This causes validSequence[Union[Tenant, TenantUpdate]]inputs (e.g., a plain PythonlistofTenantobjects) to be incorrectly rejected with:How
Sequencefromcollections.abc(aliased asABCSequence) — the canonical ABC for runtime type checkingABCSequenceforissubclass(expected_origin, ABCSequence)instead ofissubclass(expected_origin, Sequence)(whereSequencewas fromtyping)isinstance(value, (ABCSequence, list))as a simpler, more robust checktyping.Sequenceis retained in the import since it's still used in type annotationsTesting
Sequence[Union[str, int]]pattern that reproduces the same code path as the reported failureChecklist