OneToOneField

.gitignore

@@ -86,6 +86,7 @@ celerybeat-schedule
 
 # dotenv
 .env
+.env3
 
 # virtualenv
 .venv

CHANGELOG.rst

@@ -7,6 +7,8 @@ Changelog
 - The ``auto_now_add`` argument of ``DatetimeField`` is handled correctly in the SQLite backend.
 - ``unique_together`` now creates named constrains, to prevent the DB from auto-assigning a potentially non-unique constraint name.
 - Filtering by an ``auto_now`` field doesn't replace the filter value with ``now()`` anymore.
+- Implemented ``OneToOneField``, one to one relation between two models.
+- Prefetching is done asynchronously now, sending all prefetch request at the same time instead of in sequence.
 
 0.15.1
 ------

CONTRIBUTORS.rst

@@ -21,6 +21,7 @@ Contributors
 * Adam Wallner ``@wallneradam``
 * Zoltán Szeredi ``@zoliszeredi``
 * Rebecca Klauser ``@svms1``
+* Sina Sohangir ``@sinaso``
 
 Special Thanks
 ==============

docs/fields.rst

@@ -77,6 +77,8 @@ Relational Fields
 .. autoclass:: tortoise.fields.ForeignKeyField
     :exclude-members: to_db_value, to_python_value
 
+.. autoclass:: tortoise.fields.OneToOneField
+
 .. autofunction:: tortoise.fields.ManyToManyField
 
 .. autodata:: tortoise.fields.ForeignKeyRelation

examples/relations.py

@@ -34,6 +34,18 @@ def __str__(self):
         return self.name
 
 
+class Address(Model):
+    city = fields.CharField(max_length=64)
+    street = fields.CharField(max_length=128)
+
+    event: fields.OneToOneRelation[Event] = fields.OneToOneField(
+        "models.Event", on_delete=fields.CASCADE, related_name="address", pk=True
+    )
+
+    def __str__(self):
+        return f"Address({self.city}, {self.street})"
+
+
 class Team(Model):
     id = fields.IntField(pk=True)
     name = fields.TextField()
@@ -53,6 +65,9 @@ async def run():
     await Event(name="Without participants", tournament_id=tournament.id).save()
     event = Event(name="Test", tournament_id=tournament.id)
     await event.save()
+
+    await Address.create(city="Santa Monica", street="Ocean", event=event)
+
     participants = []
     for i in range(2):
         team = Team(name=f"Team {(i + 1)}")
@@ -96,6 +111,14 @@ async def run():
 
     print(await Event.filter(id=event.id).values_list("id", "participants__name"))
 
+    print(await Address.filter(event=event).first())
+
+    event_reload1 = await Event.filter(id=event.id).first()
+    print(await event_reload1.address)
+
+    event_reload2 = await Event.filter(id=event.id).prefetch_related("address").first()
+    print(event_reload2.address)
+
 
 if __name__ == "__main__":
     run_async(run())

tests/model_bad_rel5.py

@@ -0,0 +1,14 @@
+"""
+Testing Models for a bad/wrong relation reference
+Wrong reference. App missing.
+"""
+from tortoise import fields
+from tortoise.models import Model
+
+
+class Tournament(Model):
+    id = fields.IntField(pk=True)
+
+
+class Event(Model):
+    tournament = fields.OneToOneField("Tournament")

tests/models_dup3.py

@@ -0,0 +1,15 @@
+"""
+This is the testing Models — Duplicate 3
+"""
+
+from tortoise import fields
+from tortoise.models import Model
+
+
+class Tournament(Model):
+    id = fields.IntField(pk=True)
+    event = fields.CharField(max_length=32)
+
+
+class Event(Model):
+    tournament = fields.OneToOneField("models.Tournament", related_name="event")

tests/models_o2o_2.py

@@ -0,0 +1,9 @@
+"""
+This is the testing Models — Bad on_delete parameter
+"""
+from tortoise import fields
+from tortoise.models import Model
+
+
+class One(Model):
+    tournament = fields.OneToOneField("models.Two", on_delete="WABOOM")

tests/models_o2o_3.py

@@ -0,0 +1,9 @@
+"""
+This is the testing Models — on_delete SET_NULL without null=True
+"""
+from tortoise import fields
+from tortoise.models import Model
+
+
+class One(Model):
+    tournament = fields.OneToOneField("models.Two", on_delete=fields.SET_NULL)

tests/models_schema_create.py

@@ -47,6 +47,22 @@ class Meta:
         indexes = [("manager", "key"), ["manager_id", "name"]]
 
 
+class TeamAddress(Model):
+    city = fields.CharField(max_length=50, description="City")
+    country = fields.CharField(max_length=50, description="Country")
+    street = fields.CharField(max_length=128, description="Street Address")
+    team = fields.OneToOneField(
+        "models.Team", related_name="address", on_delete=fields.CASCADE, pk=True
+    )
+
+
+class VenueInformation(Model):
+    name = fields.CharField(max_length=128)
+    capacity = fields.IntField()
+    rent = fields.FloatField()
+    team = fields.OneToOneField("models.Team", on_delete=fields.SET_NULL, null=True)
+
+
 class SourceFields(Model):
     id = fields.IntField(pk=True, source_field="sometable_id")
     chars = fields.CharField(max_length=255, source_field="some_chars_table", index=True)

tests/test_bad_relation_reference.py

@@ -98,3 +98,24 @@ async def test_more_than_two_dots_in_reference_init(self):
                     },
                 }
             )
+
+    async def test_no_app_in_o2o_reference_init(self):
+        with self.assertRaisesRegex(
+            ConfigurationError, 'OneToOneField accepts model name in format "app.Model"'
+        ):
+            await Tortoise.init(
+                {
+                    "connections": {
+                        "default": {
+                            "engine": "tortoise.backends.sqlite",
+                            "credentials": {"file_path": ":memory:"},
+                        }
+                    },
+                    "apps": {
+                        "models": {
+                            "models": ["tests.model_bad_rel5"],
+                            "default_connection": "default",
+                        }
+                    },
+                }
+            )