feat: foreignkey to model class

CHANGELOG.rst

@@ -13,6 +13,10 @@ Changelog
 0.26.0 (unreleased)
 -------------------
 
+Changed
+^^^^^
+- feat: foreignkey to model type (#2027)
+
 0.25
 ====
 

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"

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"

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"

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:

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__"]})

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:

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:

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"
     )
 
 

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:

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):

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"
     )
 
 

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",

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)