fix: prevent RecursionError in BaseModel.__eq__ for self-referencing models #12648
+81
−45
Conversation
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
…models (pydantic#10630) Detailed changes: - Import threading in pydantic/main.py. - Introduce _recursion_ignore thread-local storage. - Wrap BaseModel.__eq__ logic with a check against _recursion_ignore.seen. - Add regression test tests/test_issue_10630.py.
CodSpeed Performance ReportMerging #12648 will improve performance by 6.73%Comparing Summary
Benchmarks breakdown
|
This removes the costly try/except AttributeError block in __eq__ and adds proper typing for Mypy.
Contributor
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #10630
Description
This PR prevents
RecursionErrorwhen comparing Pydantic models with self-references (cycles), addressing issue #10630.Implementation
_recursion_ignorethread-local set inpydantic/main.py.BaseModel.__eq__to track pairs of(id(self), id(other))currently being compared.__eq__returnsTrue(assuming equality for the cycle), aligning with Python's standard recursive equality behavior.Verification
tests/test_issue_10630.pywhich reproduces the crash and verifies the fix.pytest tests/test_main.py) to ensure no regressions.