kiba-core 0.5.3.dev90__tar.gz → 0.5.3.dev91__tar.gz

{kiba_core-0.5.3.dev90 → kiba_core-0.5.3.dev91}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev90
+Version: 0.5.3.dev91
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev90 → kiba_core-0.5.3.dev91}/core/store/entity_repository.py

@@ -9,6 +9,7 @@ from sqlalchemy.dialects import sqlite as sqlalchemy_sqlite
 from sqlalchemy.engine import Result
 from sqlalchemy.engine import RowMapping
 from sqlalchemy.sql import Select
+from sqlalchemy.sql.base import ReadOnlyColumnCollection
 
 from core.exceptions import KibaException
 from core.exceptions import NotFoundException
@@ -25,6 +26,7 @@ from core.store.retriever import uuid_from_value
 from core.util import date_util
 
 EntityType = typing.TypeVar('EntityType', bound=BaseModel)
+UpsertUpdateWhere = typing.Callable[[ReadOnlyColumnCollection[str, typing.Any]], sqlalchemy.ColumnElement[bool]]  # type: ignore[explicit-any]
 
 
 class EntityRepository(typing.Generic[EntityType]):  # noqa: UP046
@@ -135,7 +137,8 @@ class EntityRepository(typing.Generic[EntityType]):  # noqa: UP046
         result = await database.execute(query=self.table.update().where(self.idColumn == idValue).values(updateValues).returning(*self.list_select_columns()), connection=connection)
         return self.force_from_result(result=result)
 
-    async def upsert(self, database: Database, constraintColumnNames: list[str], connection: DatabaseConnection | None = None, **kwargs) -> EntityType:  # type: ignore[no-untyped-def]  # noqa: ANN003
+    # NOTE(krishan711): updateWhere gets the conflicting row's new values (`excluded`) and only updates when it is true; when it is false nothing is written and the stored row is returned
+    async def upsert(self, database: Database, constraintColumnNames: list[str], connection: DatabaseConnection | None = None, updateWhere: UpsertUpdateWhere | None = None, **kwargs) -> EntityType:  # type: ignore[no-untyped-def]  # noqa: ANN003
         updateValues = self._create_values(kwargs=kwargs, shouldAddUpdatedDate=True, shouldAddCreatedDate=False)
         insertValues = self._create_values(kwargs=kwargs, shouldAddUpdatedDate=True, shouldAddCreatedDate=True)
         self._add_generated_id(values=insertValues)
@@ -144,9 +147,16 @@ class EntityRepository(typing.Generic[EntityType]):  # noqa: UP046
         doUpdateStatement = insertStatement.on_conflict_do_update(
             index_elements=constraintColumns,
             set_=updateValues,
+            where=updateWhere(insertStatement.excluded) if updateWhere is not None else None,
         )
         result = await database.execute(query=doUpdateStatement.returning(*self.list_select_columns()), connection=connection)
-        return self.force_from_result(result=result)
+        row = result.mappings().first()
+        if row is None and updateWhere is not None:
+            storedQuery = self.build_select().where(*[column == insertValues[column] for column in constraintColumns])
+            row = (await database.execute(query=storedQuery, connection=connection)).mappings().first()
+        if row is None:
+            raise NotFoundException
+        return self.from_row(row=row)
 
     async def upsert_many(self, database: Database, constraintColumnNames: list[str], rowDicts: list[dict[str, typing.Any]], connection: DatabaseConnection | None = None) -> list[EntityType]:  # type: ignore[explicit-any]
         if not rowDicts:

{kiba_core-0.5.3.dev90 → kiba_core-0.5.3.dev91}/kiba_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiba-core
-Version: 0.5.3.dev90
+Version: 0.5.3.dev91
 Summary: Kiba Labs' python utilities
 Project-URL: repository, https://github.com/kibalabs/core-py
 Requires-Python: <4,>=3.12

{kiba_core-0.5.3.dev90 → kiba_core-0.5.3.dev91}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "kiba-core"
-version = "0.5.3.dev90"
+version = "0.5.3.dev91"
 description = "Kiba Labs' python utilities"
 readme = "README.md"
 requires-python = ">=3.12, <4"

{kiba_core-0.5.3.dev90 → kiba_core-0.5.3.dev91}/tests/test_entity_repository.py

@@ -172,6 +172,49 @@ async def test_upsert_inserts_then_updates(database: Database):
     assert upsertedItem.count == 2
 
 
+async def test_upsert_with_false_update_where_keeps_and_returns_the_stored_row(database: Database):
+    item = await _create_item(database=database, name='a', count=1)
+    async with database.create_transaction() as connection:
+        upsertedItem = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=lambda excluded: excluded.count > ItemsTable.c.count, name='a', count=0, amount=5)
+        storedItem = await ItemsRepository.get(database=database, connection=connection, idValue=item.itemId)
+    assert upsertedItem == item
+    assert storedItem == item
+
+
+async def test_upsert_with_false_update_where_finds_the_stored_row_by_converted_constraint_values(database: Database):
+    repository = UpperNameEntityRepository(table=ItemsTable, modelClass=Item)
+    async with database.create_transaction() as connection:
+        item = await repository.create(database=database, connection=connection, name='a', count=1, amount=1)
+        upsertedItem = await repository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=lambda _excluded: sqlalchemy.false(), name='a', count=2, amount=1)
+    assert upsertedItem == item
+
+
+async def test_upsert_with_true_update_where_updates_the_row(database: Database):
+    item = await _create_item(database=database, name='a', count=1)
+    async with database.create_transaction() as connection:
+        upsertedItem = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=lambda excluded: excluded.count > ItemsTable.c.count, name='a', count=2, amount=5)
+    assert (upsertedItem.itemId, upsertedItem.createdDate, upsertedItem.count, upsertedItem.amount) == (item.itemId, item.createdDate, 2, 5)
+
+
+async def test_upsert_with_update_where_still_inserts_new_rows(database: Database):
+    async with database.create_transaction() as connection:
+        upsertedItem = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=lambda _excluded: sqlalchemy.false(), name='a', count=1, amount=1)
+        storedItems = await ItemsRepository.list_many(database=database, connection=connection, fieldFilters=[])
+    assert storedItems == [upsertedItem]
+
+
+async def test_upsert_only_when_values_changed(database: Database):
+    def changed(excluded: typing.Any) -> sqlalchemy.ColumnElement[bool]:  # type: ignore[explicit-any]
+        return sqlalchemy.or_(ItemsTable.c.count.is_distinct_from(excluded.count), ItemsTable.c.expiryDate.is_distinct_from(excluded.expiryDate))
+
+    async with database.create_transaction() as connection:
+        item = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=changed, name='a', count=1, amount=1, expiryDate=None)
+        unchangedItem = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=changed, name='a', count=1, amount=1, expiryDate=None)
+        changedItem = await ItemsRepository.upsert(database=database, connection=connection, constraintColumnNames=['name'], updateWhere=changed, name='a', count=1, amount=1, expiryDate=datetime.datetime(2030, 1, 1, tzinfo=datetime.UTC))
+    assert unchangedItem == item
+    assert (changedItem.itemId, changedItem.expiryDate) == (item.itemId, datetime.datetime(2030, 1, 1, tzinfo=datetime.UTC))
+
+
 async def test_upsert_many_inserts_and_updates(database: Database):
     item = await _create_item(database=database, name='a')
     async with database.create_transaction() as connection: