Merge branch 'develop' into no-typing-extensions

waketzheng · web-flow · commit e8cd1788d263 · 2026-01-12T14:04:06.000+08:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -17,6 +17,10 @@ Fixed
 ^^^^^
 - Fix 'Self' in python standard library typing.py, but tortoise/model.py required it in 'typing_extensions' (#2051)
 
+Changed
+^^^^^
+- feat: foreignkey to model type (#2027)
+
 0.25
 ====
 
diff --git a/examples/complex_filtering.py b/examples/complex_filtering.py
@@ -23,7 +23,7 @@ class Event(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        Tournament, related_name="events"
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team", related_name="events", through="event_team"
diff --git a/examples/complex_prefetching.py b/examples/complex_prefetching.py
@@ -17,7 +17,7 @@ class Event(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        Tournament, related_name="events"
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team", related_name="events", through="event_team"
diff --git a/examples/functions.py b/examples/functions.py
@@ -19,7 +19,7 @@ class Event(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        Tournament, related_name="events"
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team", related_name="events", through="event_team"
diff --git a/examples/global_table_name_generator.py b/examples/global_table_name_generator.py
@@ -26,7 +26,7 @@ class BlogPost(Model):
     id = fields.IntField(primary_key=True)
     title = fields.TextField()
     author: fields.ForeignKeyRelation[UserProfile] = fields.ForeignKeyField(
-        "models.UserProfile", related_name="posts"
+        UserProfile, related_name="posts"
     )
 
     class Meta:
diff --git a/examples/group_by.py b/examples/group_by.py
@@ -5,14 +5,16 @@
 class Author(Model):
     name = fields.CharField(max_length=255)
 
+    books: fields.ReverseRelation["Book"]
+
 
 class Book(Model):
     name = fields.CharField(max_length=255)
-    author: fields.ForeignKeyRelation[Author] = fields.ForeignKeyField(
-        "models.Author", related_name="books"
-    )
+    author: fields.ForeignKeyRelation[Author] = fields.ForeignKeyField(Author, related_name="books")
     rating = fields.FloatField()
 
+    author_id: int
+
 
 async def run():
     await Tortoise.init(db_url="sqlite://:memory:", modules={"models": ["__main__"]})
diff --git a/examples/pydantic/basic.py b/examples/pydantic/basic.py
@@ -23,7 +23,7 @@ class Event(Model):
     name = fields.TextField()
     created_at = fields.DatetimeField(auto_now_add=True)
     tournament: fields.ForeignKeyNullableRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", null=True
+        Tournament, related_name="events", null=True
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team", related_name="events", through="event_team"
@@ -40,7 +40,7 @@ class Address(Model):
     created_at = fields.DatetimeField(auto_now_add=True)
 
     event: fields.OneToOneRelation[Event] = fields.OneToOneField(
-        "models.Event", on_delete=fields.OnDelete.CASCADE, related_name="address", primary_key=True
+        Event, on_delete=fields.OnDelete.CASCADE, related_name="address", primary_key=True
     )
 
     class Meta:
diff --git a/examples/pydantic/early_init.py b/examples/pydantic/early_init.py
@@ -23,7 +23,7 @@ class Event(Model):
     name = fields.TextField()
     created_at = fields.DatetimeField(auto_now_add=True)
     tournament: fields.ForeignKeyNullableRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", null=True
+        Tournament, related_name="events", null=True
     )
 
     class Meta:
diff --git a/examples/pydantic/tutorial_3.py b/examples/pydantic/tutorial_3.py
@@ -32,7 +32,7 @@ class Event(Model):
     created_at = fields.DatetimeField(auto_now_add=True)
 
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", description="The Tournament this happens in"
+        Tournament, related_name="events", description="The Tournament this happens in"
     )
 
 
diff --git a/examples/pydantic/tutorial_4.py b/examples/pydantic/tutorial_4.py
@@ -67,7 +67,7 @@ class Event(Model):
     created_at = fields.DatetimeField(auto_now_add=True)
 
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", description="The Tournament this happens in"
+        Tournament, related_name="events", description="The Tournament this happens in"
     )
 
     class Meta:
diff --git a/examples/relations.py b/examples/relations.py
@@ -25,8 +25,9 @@ class Event(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events"
+        Tournament, related_name="events"
     )
+    # class Team does not defined before Event, so we have to use '{app}.{model_class}'
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team", related_name="events", through="event_team"
     )
@@ -40,7 +41,7 @@ class Address(Model):
     street = fields.CharField(max_length=128)
 
     event: fields.OneToOneRelation[Event] = fields.OneToOneField(
-        "models.Event", on_delete=fields.OnDelete.CASCADE, related_name="address", primary_key=True
+        Event, on_delete=fields.OnDelete.CASCADE, related_name="address", primary_key=True
     )
 
     def __str__(self):
diff --git a/examples/relations_with_unique.py b/examples/relations_with_unique.py
@@ -23,15 +23,15 @@ class Student(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     school: fields.ForeignKeyRelation[School] = fields.ForeignKeyField(
-        "models.School", related_name="students", to_field="id"
+        School, related_name="students", to_field="id"
     )
 
 
 class Principal(Model):
     id = fields.IntField(primary_key=True)
     name = fields.TextField()
     school: fields.OneToOneRelation[School] = fields.OneToOneField(
-        "models.School", on_delete=fields.OnDelete.CASCADE, related_name="principal", to_field="id"
+        School, on_delete=fields.OnDelete.CASCADE, related_name="principal", to_field="id"
     )
 
 
diff --git a/examples/schema_create.py b/examples/schema_create.py
@@ -22,7 +22,7 @@ class Event(Model):
     id = fields.IntField(primary_key=True, description="Event ID")
     name = fields.CharField(max_length=255, unique=True)
     tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(
-        "models.Tournament", related_name="events", description="FK to tournament"
+        Tournament, related_name="events", description="FK to tournament"
     )
     participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(
         "models.Team",
diff --git a/tests/test_relations.py b/tests/test_relations.py
@@ -1,3 +1,5 @@
+import subprocess  # nosec
+
 from tests.testmodels import (
     Address,
     Author,
@@ -501,3 +503,12 @@ async def test_reverse_relation_create_fk_errors_for_unsaved_instance(self):
             await tournament.events.create(name="Test Event")
 
         self.assertIn("hasn't been instanced", str(cm.exception))
+
+    @test.requireCapability(dialect="sqlite")
+    async def test_recursive(self) -> None:
+        file = "examples/relations_recursive.py"
+        r = subprocess.run(["python", file], capture_output=True, text=True)  # nosec
+        assert not r.stderr
+        output = r.stdout
+        s = "2.1. Second H2 (to: ) (from: 2.2. Third H2, Loose, 1.1. First H2)"
+        self.assertIn(s, output)
diff --git a/tests/testmodels.py b/tests/testmodels.py
diff --git a/tortoise/__init__.py b/tortoise/__init__.py
diff --git a/tortoise/fields/relational.py b/tortoise/fields/relational.py

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Event(Model):`
`23`	`23`	`id = fields.IntField(primary_key=True)`
`24`	`24`	`name = fields.TextField()`
`25`	`25`	`tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(`
`26`		`- "models.Tournament", related_name="events"`
	`26`	`+ Tournament, related_name="events"`
`27`	`27`	`)`
`28`	`28`	`participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(`
`29`	`29`	`"models.Team", related_name="events", through="event_team"`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ class Event(Model):`
`17`	`17`	`id = fields.IntField(primary_key=True)`
`18`	`18`	`name = fields.TextField()`
`19`	`19`	`tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(`
`20`		`- "models.Tournament", related_name="events"`
	`20`	`+ Tournament, related_name="events"`
`21`	`21`	`)`
`22`	`22`	`participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(`
`23`	`23`	`"models.Team", related_name="events", through="event_team"`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class Event(Model):`
`19`	`19`	`id = fields.IntField(primary_key=True)`
`20`	`20`	`name = fields.TextField()`
`21`	`21`	`tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(`
`22`		`- "models.Tournament", related_name="events"`
	`22`	`+ Tournament, related_name="events"`
`23`	`23`	`)`
`24`	`24`	`participants: fields.ManyToManyRelation["Team"] = fields.ManyToManyField(`
`25`	`25`	`"models.Team", related_name="events", through="event_team"`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class BlogPost(Model):`
`26`	`26`	`id = fields.IntField(primary_key=True)`
`27`	`27`	`title = fields.TextField()`
`28`	`28`	`author: fields.ForeignKeyRelation[UserProfile] = fields.ForeignKeyField(`
`29`		`- "models.UserProfile", related_name="posts"`
	`29`	`+ UserProfile, related_name="posts"`
`30`	`30`	`)`
`31`	`31`
`32`	`32`	`class Meta:`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class Event(Model):`
`32`	`32`	`created_at = fields.DatetimeField(auto_now_add=True)`
`33`	`33`
`34`	`34`	`tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(`
`35`		`- "models.Tournament", related_name="events", description="The Tournament this happens in"`
	`35`	`+ Tournament, related_name="events", description="The Tournament this happens in"`
`36`	`36`	`)`
`37`	`37`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ class Event(Model):`
`67`	`67`	`created_at = fields.DatetimeField(auto_now_add=True)`
`68`	`68`
`69`	`69`	`tournament: fields.ForeignKeyRelation[Tournament] = fields.ForeignKeyField(`
`70`		`- "models.Tournament", related_name="events", description="The Tournament this happens in"`
	`70`	`+ Tournament, related_name="events", description="The Tournament this happens in"`
`71`	`71`	`)`
`72`	`72`
`73`	`73`	`class Meta:`