piccolo 1.17.0__tar.gz → 1.18.0__tar.gz

{piccolo-1.17.0 → piccolo-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.17.0
+Version: 1.18.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.18.0/piccolo/__init__.py

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

{piccolo-1.17.0 → piccolo-1.18.0}/piccolo/apps/asgi/commands/new.py

@@ -15,7 +15,7 @@ ROUTER_DEPENDENCIES = {
     "fastapi": ["fastapi>=0.112.1"],
     "blacksheep": ["blacksheep"],
     "litestar": ["litestar"],
-    "esmerald": ["esmerald"],
+    "esmerald": ["esmerald==3.3.0"],
     "lilya": ["lilya"],
 }
 ROUTERS = list(ROUTER_DEPENDENCIES.keys())

{piccolo-1.17.0 → piccolo-1.18.0}/piccolo/apps/migrations/auto/diffable_table.py

@@ -40,10 +40,17 @@ def compare_dicts(
 
     for key, value in dict_1.items():
         dict_2_value = dict_2.get(key, ...)
+
         if (
-            dict_2_value is not ...
-            and dict_2_value != value
-            or dict_2_value is ...
+            # If the value is `...` then it means no value was found.
+            (dict_2_value is ...)
+            # We have to compare the types, because if we just use equality
+            # then 1.0 == 1 is True.
+            # See this issue:
+            # https://github.com/piccolo-orm/piccolo/issues/1071
+            or (type(value) is not type(dict_2_value))
+            # Finally compare the actual values.
+            or (dict_2_value != value)
         ):
             output[key] = value
 

{piccolo-1.17.0 → piccolo-1.18.0}/piccolo/query/methods/objects.py

@@ -27,6 +27,7 @@ from piccolo.utils.sync import run_sync
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from piccolo.columns import Column
+    from piccolo.table import Table
 
 
 ###############################################################################
@@ -173,6 +174,61 @@ class Create(t.Generic[TableInstance]):
         return run_sync(self.run(*args, **kwargs))
 
 
+class UpdateSelf:
+
+    def __init__(
+        self,
+        row: Table,
+        values: t.Dict[t.Union[Column, str], t.Any],
+    ):
+        self.row = row
+        self.values = values
+
+    async def run(
+        self,
+        node: t.Optional[str] = None,
+        in_pool: bool = True,
+    ) -> None:
+        if not self.row._exists_in_db:
+            raise ValueError("This row doesn't exist in the database.")
+
+        TableClass = self.row.__class__
+
+        primary_key = TableClass._meta.primary_key
+        primary_key_value = getattr(self.row, primary_key._meta.name)
+
+        if primary_key_value is None:
+            raise ValueError("The primary key is None")
+
+        columns = [
+            TableClass._meta.get_column_by_name(i) if isinstance(i, str) else i
+            for i in self.values.keys()
+        ]
+
+        response = (
+            await TableClass.update(self.values)
+            .where(primary_key == primary_key_value)
+            .returning(*columns)
+            .run(
+                node=node,
+                in_pool=in_pool,
+            )
+        )
+
+        for key, value in response[0].items():
+            setattr(self.row, key, value)
+
+    def __await__(self) -> t.Generator[None, None, None]:
+        """
+        If the user doesn't explicity call .run(), proxy to it as a
+        convenience.
+        """
+        return self.run().__await__()
+
+    def run_sync(self, *args, **kwargs) -> None:
+        return run_sync(self.run(*args, **kwargs))
+
+
 ###############################################################################
 
 

{piccolo-1.17.0 → piccolo-1.18.0}/piccolo/query/methods/raw.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import typing as t
 
+from piccolo.engine.base import BaseBatch
 from piccolo.query.base import Query
 from piccolo.querystring import QueryString
 
@@ -21,6 +22,18 @@ class Raw(Query):
         super().__init__(table, **kwargs)
         self.querystring = querystring
 
+    async def batch(
+        self,
+        batch_size: t.Optional[int] = None,
+        node: t.Optional[str] = None,
+        **kwargs,
+    ) -> BaseBatch:
+        if batch_size:
+            kwargs.update(batch_size=batch_size)
+        if node:
+            kwargs.update(node=node)
+        return await self.table._meta.db.batch(self, **kwargs)
+
     @property
     def default_querystrings(self) -> t.Sequence[QueryString]:
         return [self.querystring]

{piccolo-1.17.0 → piccolo-1.18.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
+from piccolo.query.methods.objects import First, UpdateSelf
 from piccolo.query.methods.refresh import Refresh
 from piccolo.querystring import QueryString
 from piccolo.utils import _camel_to_snake
@@ -525,6 +525,43 @@ class Table(metaclass=TableMetaclass):
             == getattr(self, self._meta.primary_key._meta.name)
         )
 
+    def update_self(
+        self, values: t.Dict[t.Union[Column, str], t.Any]
+    ) -> UpdateSelf:
+        """
+        This allows the user to update a single object - useful when the values
+        are derived from the database in some way.
+
+        For example, if we have the following table::
+
+            class Band(Table):
+                name = Varchar()
+                popularity = Integer()
+
+        And we fetch an object::
+
+            >>> band = await Band.objects().get(name="Pythonistas")
+
+        We could use the typical syntax for updating the object::
+
+            >>> band.popularity += 1
+            >>> await band.save()
+
+        The problem with this, is what if another object has already
+        incremented ``popularity``? It would overide the value.
+
+        Instead we can do this:
+
+            >>> await band.update_self({
+            ...     Band.popularity: Band.popularity + 1
+            ... })
+
+        This updates ``popularity`` in the database, and also sets the new
+        value for ``popularity`` on the object.
+
+        """
+        return UpdateSelf(row=self, values=values)
+
     def remove(self) -> Delete:
         """
         A proxy to a delete query.

{piccolo-1.17.0 → piccolo-1.18.0}/piccolo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.17.0
+Version: 1.18.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.17.0 → piccolo-1.18.0}/piccolo.egg-info/SOURCES.txt

@@ -355,6 +355,7 @@ tests/table/test_select.py
 tests/table/test_str.py
 tests/table/test_table_exists.py
 tests/table/test_update.py
+tests/table/test_update_self.py
 tests/table/instance/__init__.py
 tests/table/instance/test_create.py
 tests/table/instance/test_get_related.py

{piccolo-1.17.0 → piccolo-1.18.0}/tests/apps/migrations/auto/integration/test_migrations.py

@@ -888,6 +888,25 @@ class TestMigrations(MigrationTestCase):
             ]
         )
 
+    def test_column_type_conversion_integer_float(self):
+        """
+        Make sure conversion between ``Integer`` and ``Real`` works - related
+        to this bug:
+
+        https://github.com/piccolo-orm/piccolo/issues/1071
+
+        """
+        self._test_migrations(
+            table_snapshots=[
+                [self.table(column)]
+                for column in [
+                    Real(default=1.0),
+                    Integer(default=1),
+                    Real(default=1.0),
+                ]
+            ]
+        )
+
     def test_column_type_conversion_json(self):
         self._test_migrations(
             table_snapshots=[

{piccolo-1.17.0 → piccolo-1.18.0}/tests/apps/migrations/auto/test_diffable_table.py

@@ -73,6 +73,19 @@ class TestCompareDicts(TestCase):
         response = compare_dicts(dict_1, dict_2)
         self.assertEqual(response, {"a": OnDelete.set_default})
 
+    def test_numeric_values(self):
+        """
+        Make sure that if we have two numbers which are equal, but different
+        types, then they are identified as being different.
+
+        https://github.com/piccolo-orm/piccolo/issues/1071
+
+        """
+        dict_1 = {"a": 1}
+        dict_2 = {"a": 1.0}
+        response = compare_dicts(dict_1, dict_2)
+        self.assertEqual(response, {"a": 1})
+
 
 class TestDiffableTable(TestCase):
     def test_subtract(self):

{piccolo-1.17.0 → piccolo-1.18.0}/tests/table/test_batch.py

@@ -95,6 +95,47 @@ class TestBatchObjects(DBTestCase):
         self.assertEqual(iterations, _iterations)
 
 
+class TestBatchRaw(DBTestCase):
+    def _check_results(self, batch):
+        """
+        Make sure the data is returned in the correct format.
+        """
+        self.assertEqual(type(batch), list)
+        if len(batch) > 0:
+            row = batch[0]
+            self.assertIsInstance(row, Manager)
+
+    async def run_batch(self, batch_size):
+        row_count = 0
+        iterations = 0
+
+        async with await Manager.raw("SELECT * FROM manager").batch(
+            batch_size=batch_size
+        ) as batch:
+            async for _batch in batch:
+                self._check_results(_batch)
+                _row_count = len(_batch)
+                row_count += _row_count
+                iterations += 1
+
+        return row_count, iterations
+
+    async def test_batch(self):
+        row_count = 1000
+        self.insert_many_rows(row_count)
+
+        batch_size = 10
+
+        _row_count, iterations = asyncio.run(
+            self.run_batch(batch_size=batch_size), debug=True
+        )
+
+        _iterations = math.ceil(row_count / batch_size)
+
+        self.assertEqual(_row_count, row_count)
+        self.assertEqual(iterations, _iterations)
+
+
 @engines_only("postgres", "cockroach")
 class TestBatchNodeArg(TestCase):
     def test_batch_extra_node(self):

piccolo-1.18.0/tests/table/test_update_self.py

@@ -0,0 +1,27 @@
+from piccolo.testing.test_case import AsyncTableTest
+from tests.example_apps.music.tables import Band, Manager
+
+
+class TestUpdateSelf(AsyncTableTest):
+
+    tables = [Band, Manager]
+
+    async def test_update_self(self):
+        band = Band({Band.name: "Pythonistas", Band.popularity: 1000})
+
+        # Make sure we get a ValueError if it's not in the database yet.
+        with self.assertRaises(ValueError):
+            await band.update_self({Band.popularity: Band.popularity + 1})
+
+        # Save it, so it's in the database
+        await band.save()
+
+        # Make sure we can successfully update the object
+        await band.update_self({Band.popularity: Band.popularity + 1})
+
+        # Make sure the value was updated on the object
+        assert band.popularity == 1001
+
+        # Make sure the value was updated in the database
+        await band.refresh()
+        assert band.popularity == 1001

piccolo-1.17.0/piccolo/__init__.py

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