-
-
Notifications
You must be signed in to change notification settings - Fork 784
Bug fix for Dictionary and Mapping type hints inside of a Pydantic model #1631
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
claythearc
wants to merge
3
commits into
fastapi:main
Choose a base branch
from
claythearc:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| """Test for Dict relationship recursion bug fix.""" | ||
|
|
||
| from typing import Dict | ||
|
|
||
| from sqlalchemy.orm.collections import attribute_mapped_collection | ||
| from sqlmodel import Field, Relationship, SQLModel | ||
|
|
||
|
|
||
| def test_dict_relationship_pattern(): | ||
| """Test that Dict relationships with attribute_mapped_collection work.""" | ||
|
|
||
| # Create a minimal reproduction of the pattern | ||
| # This should not raise a RecursionError | ||
|
|
||
| class TestChild(SQLModel, table=True): | ||
| __tablename__ = "test_child" | ||
| id: int = Field(primary_key=True) | ||
| key: str = Field(nullable=False) | ||
| parent_id: int = Field(foreign_key="test_parent.id") | ||
| parent: "TestParent" = Relationship(back_populates="children") | ||
|
|
||
| class TestParent(SQLModel, table=True): | ||
| __tablename__ = "test_parent" | ||
| id: int = Field(primary_key=True) | ||
| children: Dict[str, "TestChild"] = Relationship( | ||
| back_populates="parent", | ||
| sa_relationship_kwargs={ | ||
| "collection_class": attribute_mapped_collection("key") | ||
| }, | ||
| ) | ||
|
|
||
| # If we got here without RecursionError, the bug is fixed | ||
| assert TestParent.__tablename__ == "test_parent" | ||
| assert TestChild.__tablename__ == "test_child" | ||
|
|
||
|
|
||
| def test_dict_relationship_with_optional(): | ||
| """Test that Optional[Dict[...]] relationships also work.""" | ||
| from typing import Optional | ||
|
|
||
| class Child(SQLModel, table=True): | ||
| __tablename__ = "child" | ||
| id: int = Field(primary_key=True) | ||
| key: str = Field(nullable=False) | ||
| parent_id: int = Field(foreign_key="parent.id") | ||
| parent: Optional["Parent"] = Relationship(back_populates="children") | ||
|
|
||
| class Parent(SQLModel, table=True): | ||
| __tablename__ = "parent" | ||
| id: int = Field(primary_key=True) | ||
| children: Optional[Dict[str, "Child"]] = Relationship( | ||
| back_populates="parent", | ||
| sa_relationship_kwargs={ | ||
| "collection_class": attribute_mapped_collection("key") | ||
| }, | ||
| ) | ||
|
|
||
| # If we got here without RecursionError, the bug is fixed | ||
| assert Parent.__tablename__ == "parent" | ||
| assert Child.__tablename__ == "child" | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to use
Optionalhere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can make a reasonable argument either way. After going back and forth with Claude some, I decided that it made sense because it lets you distinguish between not loaded and empty, but I dont have exceptionally strong feelings and can change it.