piccolo 1.19.1__tar.gz → 1.20.0__tar.gz

{piccolo-1.19.1 → piccolo-1.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.19.1
+Version: 1.20.0
 Summary: A fast, user friendly ORM and query builder which supports asyncio.
 Home-page: https://github.com/piccolo-orm/piccolo
 Author: Daniel Townsend

piccolo-1.20.0/piccolo/__init__.py

@@ -0,0 +1 @@
+__VERSION__ = "1.20.0"

{piccolo-1.19.1 → piccolo-1.20.0}/piccolo/query/methods/objects.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import typing as t
 
-from piccolo.columns.column_types import ForeignKey
+from piccolo.columns.column_types import ForeignKey, ReferencedTable
 from piccolo.columns.combination import And, Where
 from piccolo.custom_types import Combinable, TableInstance
 from piccolo.engine.base import BaseBatch
@@ -231,6 +231,63 @@ class UpdateSelf:
         return run_sync(self.run(*args, **kwargs))
 
 
+class GetRelated(t.Generic[ReferencedTable]):
+
+    def __init__(self, row: Table, foreign_key: ForeignKey[ReferencedTable]):
+        self.row = row
+        self.foreign_key = foreign_key
+
+    async def run(
+        self,
+        node: t.Optional[str] = None,
+        in_pool: bool = True,
+    ) -> t.Optional[ReferencedTable]:
+        if not self.row._exists_in_db:
+            raise ValueError("The object doesn't exist in the database.")
+
+        root_table = self.row.__class__
+
+        data = (
+            await root_table.select(
+                *[
+                    i.as_alias(i._meta.name)
+                    for i in self.foreign_key.all_columns()
+                ]
+            )
+            .where(
+                root_table._meta.primary_key
+                == getattr(self.row, root_table._meta.primary_key._meta.name)
+            )
+            .first()
+            .run(node=node, in_pool=in_pool)
+        )
+
+        # Make sure that some values were returned:
+        if data is None or not any(data.values()):
+            return None
+
+        references = t.cast(
+            t.Type[ReferencedTable],
+            self.foreign_key._foreign_key_meta.resolved_references,
+        )
+
+        referenced_object = references(**data)
+        referenced_object._exists_in_db = True
+        return referenced_object
+
+    def __await__(
+        self,
+    ) -> t.Generator[None, None, t.Optional[ReferencedTable]]:
+        """
+        If the user doesn't explicity call .run(), proxy to it as a
+        convenience.
+        """
+        return self.run().__await__()
+
+    def run_sync(self, *args, **kwargs) -> t.Optional[ReferencedTable]:
+        return run_sync(self.run(*args, **kwargs))
+
+
 ###############################################################################
 
 

{piccolo-1.19.1 → piccolo-1.20.0}/piccolo/table.py

@@ -46,7 +46,7 @@ from piccolo.query import (
 )
 from piccolo.query.methods.create_index import CreateIndex
 from piccolo.query.methods.indexes import Indexes
-from piccolo.query.methods.objects import First, UpdateSelf
+from piccolo.query.methods.objects import GetRelated, UpdateSelf
 from piccolo.query.methods.refresh import Refresh
 from piccolo.querystring import QueryString
 from piccolo.utils import _camel_to_snake
@@ -612,14 +612,14 @@ class Table(metaclass=TableMetaclass):
     @t.overload
     def get_related(
         self, foreign_key: ForeignKey[ReferencedTable]
-    ) -> First[ReferencedTable]: ...
+    ) -> GetRelated[ReferencedTable]: ...
 
     @t.overload
-    def get_related(self, foreign_key: str) -> First[Table]: ...
+    def get_related(self, foreign_key: str) -> GetRelated[Table]: ...
 
     def get_related(
         self, foreign_key: t.Union[str, ForeignKey[ReferencedTable]]
-    ) -> t.Union[First[Table], First[ReferencedTable]]:
+    ) -> GetRelated[ReferencedTable]:
         """
         Used to fetch a ``Table`` instance, for the target of a foreign key.
 
@@ -630,8 +630,8 @@ class Table(metaclass=TableMetaclass):
             >>> print(manager.name)
             'Guido'
 
-        It can only follow foreign keys one level currently.
-        i.e. ``Band.manager``, but not ``Band.manager.x.y.z``.
+        It can only follow foreign keys multiple levels deep. For example,
+        ``Concert.band_1.manager``.
 
         """
         if isinstance(foreign_key, str):
@@ -645,18 +645,7 @@ class Table(metaclass=TableMetaclass):
                 "ForeignKey column."
             )
 
-        column_name = foreign_key._meta.name
-
-        references = foreign_key._foreign_key_meta.resolved_references
-
-        return (
-            references.objects()
-            .where(
-                foreign_key._foreign_key_meta.resolved_target_column
-                == getattr(self, column_name)
-            )
-            .first()
-        )
+        return GetRelated(foreign_key=foreign_key, row=self)
 
     def get_m2m(self, m2m: M2M) -> M2MGetRelated:
         """

{piccolo-1.19.1 → piccolo-1.20.0}/piccolo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.19.1
+Version: 1.20.0
 Summary: A fast, user friendly ORM and query builder which supports asyncio.
 Home-page: https://github.com/piccolo-orm/piccolo
 Author: Daniel Townsend

piccolo-1.20.0/tests/table/instance/test_get_related.py

@@ -0,0 +1,98 @@
+import typing as t
+
+from piccolo.testing.test_case import AsyncTableTest
+from tests.example_apps.music.tables import Band, Concert, Manager, Venue
+
+
+class TestGetRelated(AsyncTableTest):
+    tables = [Manager, Band, Concert, Venue]
+
+    async def asyncSetUp(self):
+        await super().asyncSetUp()
+
+        # Setup two pairs of manager/band, so we can make sure the correct
+        # objects are returned.
+
+        self.manager = Manager(name="Guido")
+        await self.manager.save()
+
+        self.band = Band(
+            name="Pythonistas", manager=self.manager.id, popularity=100
+        )
+        await self.band.save()
+
+        self.manager_2 = Manager(name="Graydon")
+        await self.manager_2.save()
+
+        self.band_2 = Band(
+            name="Rustaceans", manager=self.manager_2.id, popularity=100
+        )
+        await self.band_2.save()
+
+    async def test_foreign_key(self) -> None:
+        """
+        Make sure you can get a related object from another object instance.
+        """
+        manager = await self.band.get_related(Band.manager)
+        assert manager is not None
+        self.assertTrue(manager.id == self.manager.id)
+
+        manager_2 = await self.band_2.get_related(Band.manager)
+        assert manager_2 is not None
+        self.assertTrue(manager_2.id == self.manager_2.id)
+
+    async def test_non_foreign_key(self):
+        """
+        Make sure that non-ForeignKey raise an exception.
+        """
+        with self.assertRaises(ValueError):
+            self.band.get_related(Band.name)  # type: ignore
+
+    async def test_string(self):
+        """
+        Make sure it also works using a string representation of a foreign key.
+        """
+        manager = t.cast(Manager, await self.band.get_related("manager"))
+        self.assertTrue(manager.id == self.manager.id)
+
+    async def test_invalid_string(self):
+        """
+        Make sure an exception is raised if the foreign key string is invalid.
+        """
+        with self.assertRaises(ValueError):
+            self.band.get_related("abc123")
+
+    async def test_multiple_levels(self):
+        """
+        Make sure ``get_related`` works multiple levels deep.
+        """
+        concert = Concert(band_1=self.band, band_2=self.band_2)
+        await concert.save()
+
+        manager = await concert.get_related(Concert.band_1._.manager)
+        assert manager is not None
+        self.assertTrue(manager.id == self.manager.id)
+
+        manager_2 = await concert.get_related(Concert.band_2._.manager)
+        assert manager_2 is not None
+        self.assertTrue(manager_2.id == self.manager_2.id)
+
+    async def test_no_match(self):
+        """
+        If not related object exists, make sure ``None`` is returned.
+        """
+        concert = Concert(band_1=self.band, band_2=None)
+        await concert.save()
+
+        manager_2 = await concert.get_related(Concert.band_2._.manager)
+        assert manager_2 is None
+
+    async def test_not_in_db(self):
+        """
+        If the object we're calling ``get_related`` on doesn't exist in the
+        database, then make sure an error is raised.
+        """
+        concert = Concert(band_1=self.band, band_2=self.band_2)
+
+        with self.assertRaises(ValueError):
+            await concert.get_related(Concert.band_1._.manager)

piccolo-1.19.1/piccolo/__init__.py

@@ -1 +0,0 @@
-__VERSION__ = "1.19.1"

piccolo-1.19.1/tests/table/instance/test_get_related.py

@@ -1,42 +0,0 @@
-import typing as t
-from unittest import TestCase
-
-from tests.example_apps.music.tables import Band, Manager
-
-TABLES = [Manager, Band]
-
-
-class TestGetRelated(TestCase):
-    def setUp(self):
-        for table in TABLES:
-            table.create_table().run_sync()
-
-    def tearDown(self):
-        for table in reversed(TABLES):
-            table.alter().drop_table().run_sync()
-
-    def test_get_related(self) -> None:
-        """
-        Make sure you can get a related object from another object instance.
-        """
-        manager = Manager(name="Guido")
-        manager.save().run_sync()
-
-        band = Band(name="Pythonistas", manager=manager.id, popularity=100)
-        band.save().run_sync()
-
-        _manager = band.get_related(Band.manager).run_sync()
-        assert _manager is not None
-        self.assertTrue(_manager.name == "Guido")
-
-        # Test non-ForeignKey
-        with self.assertRaises(ValueError):
-            band.get_related(Band.name)  # type: ignore
-
-        # Make sure it also works using a string
-        _manager_2 = t.cast(Manager, band.get_related("manager").run_sync())
-        self.assertTrue(_manager_2.name == "Guido")
-
-        # Test an invalid string
-        with self.assertRaises(ValueError):
-            band.get_related("abc123")