Fix RecursionError in BaseModel equality with circular references #12624
+79
−8
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
Fix
RecursionErrorwhen comparingBaseModelinstances that contain circular self-references.Changes
try-except RecursionErrorhandlers inBaseModel.__eq__to gracefully handle circular referencesRecursionErroris caught during comparison, we returnTrue(assuming equal structure)Why This Approach
This implementation has zero performance overhead for normal (non-circular) comparisons:
RecursionErroractually occursThis addresses the performance concerns raised in PR #11581 which proposed using
ContextVartracking for every equality comparison.Behavior
TrueFalse(detected before recursion)False(detected before recursion)a == a)TrueExample
Testing
test_self_referential_equalityfor direct self-reference scenariostest_mutual_reference_equalityfor mutual circular referencesFixes #10630
🤖 Generated with Claude Code