piccolo 1.8.0__tar.gz → 1.9.0__tar.gz

{piccolo-1.8.0 → piccolo-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.8.0
+Version: 1.9.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.9.0/piccolo/__init__.py

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

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo/columns/base.py

@@ -830,7 +830,11 @@ class Column(Selectable):
             engine_type=engine_type, with_alias=False
         )
 
-    def get_sql_value(self, value: t.Any) -> t.Any:
+    def get_sql_value(
+        self,
+        value: t.Any,
+        delimiter: str = "'",
+    ) -> str:
         """
         When using DDL statements, we can't parameterise the values. An example
         is when setting the default for a column. So we have to convert from
@@ -839,11 +843,18 @@ class Column(Selectable):
 
         :param value:
             The Python value to convert to a string usable in a DDL statement
-            e.g. 1.
+            e.g. ``1``.
+        :param delimiter:
+            The string returned by this function is wrapped in delimiters,
+            ready to be added to a DDL statement. For example:
+            ``'hello world'``.
         :returns:
-            The string usable in the DDL statement e.g. '1'.
+            The string usable in the DDL statement e.g. ``'1'``.
 
         """
+        from piccolo.engine.sqlite import ADAPTERS as sqlite_adapters
+
+        # Common across all DB engines
         if isinstance(value, Default):
             return getattr(value, self._meta.engine_type)
         elif value is None:
@@ -851,37 +862,52 @@ class Column(Selectable):
         elif isinstance(value, (float, decimal.Decimal)):
             return str(value)
         elif isinstance(value, str):
-            return f"'{value}'"
+            return f"{delimiter}{value}{delimiter}"
         elif isinstance(value, bool):
             return str(value).lower()
-        elif isinstance(value, datetime.datetime):
-            return f"'{value.isoformat().replace('T', ' ')}'"
-        elif isinstance(value, datetime.date):
-            return f"'{value.isoformat()}'"
-        elif isinstance(value, datetime.time):
-            return f"'{value.isoformat()}'"
-        elif isinstance(value, datetime.timedelta):
-            interval = IntervalCustom.from_timedelta(value)
-            return getattr(interval, self._meta.engine_type)
         elif isinstance(value, bytes):
-            return f"'{value.hex()}'"
-        elif isinstance(value, uuid.UUID):
-            return f"'{value}'"
-        elif isinstance(value, list):
-            # Convert to the array syntax.
-            return (
-                "'{"
-                + ", ".join(
-                    (
-                        f'"{i}"'
-                        if isinstance(i, str)
-                        else str(self.get_sql_value(i))
+            return f"{delimiter}{value.hex()}{delimiter}"
+
+        # SQLite specific
+        if self._meta.engine_type == "sqlite":
+            if adapter := sqlite_adapters.get(type(value)):
+                sqlite_value = adapter(value)
+                return (
+                    f"{delimiter}{sqlite_value}{delimiter}"
+                    if isinstance(sqlite_value, str)
+                    else sqlite_value
+                )
+
+        # Postgres and Cockroach
+        if self._meta.engine_type in ["postgres", "cockroach"]:
+            if isinstance(value, datetime.datetime):
+                return f"{delimiter}{value.isoformat().replace('T', ' ')}{delimiter}"  # noqa: E501
+            elif isinstance(value, datetime.date):
+                return f"{delimiter}{value.isoformat()}{delimiter}"
+            elif isinstance(value, datetime.time):
+                return f"{delimiter}{value.isoformat()}{delimiter}"
+            elif isinstance(value, datetime.timedelta):
+                interval = IntervalCustom.from_timedelta(value)
+                return getattr(interval, self._meta.engine_type)
+            elif isinstance(value, uuid.UUID):
+                return f"{delimiter}{value}{delimiter}"
+            elif isinstance(value, list):
+                # Convert to the array syntax.
+                return (
+                    delimiter
+                    + "{"
+                    + ",".join(
+                        self.get_sql_value(
+                            i,
+                            delimiter="" if isinstance(i, list) else '"',
+                        )
+                        for i in value
                     )
-                    for i in value
+                    + "}"
+                    + delimiter
                 )
-            ) + "}'"
-        else:
-            return value
+
+        return str(value)
 
     @property
     def column_type(self):

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo/columns/defaults/base.py

@@ -1,17 +1,19 @@
 from __future__ import annotations
 
 import typing as t
-from abc import ABC, abstractmethod, abstractproperty
+from abc import ABC, abstractmethod
 
 from piccolo.utils.repr import repr_class_instance
 
 
 class Default(ABC):
-    @abstractproperty
+    @property
+    @abstractmethod
     def postgres(self) -> str:
         pass
 
-    @abstractproperty
+    @property
+    @abstractmethod
     def sqlite(self) -> str:
         pass
 

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo/query/functions/__init__.py

@@ -1,17 +1,22 @@
 from .aggregate import Avg, Count, Max, Min, Sum
+from .math import Abs, Ceil, Floor, Round
 from .string import Length, Lower, Ltrim, Reverse, Rtrim, Upper
 from .type_conversion import Cast
 
 __all__ = (
+    "Abs",
     "Avg",
     "Cast",
+    "Ceil",
     "Count",
+    "Floor",
     "Length",
     "Lower",
     "Ltrim",
     "Max",
     "Min",
     "Reverse",
+    "Round",
     "Rtrim",
     "Sum",
     "Upper",

piccolo-1.9.0/piccolo/query/functions/math.py

@@ -0,0 +1,48 @@
+"""
+These functions mirror their counterparts in the Postgresql docs:
+
+https://www.postgresql.org/docs/current/functions-math.html
+
+"""
+
+from .base import Function
+
+
+class Abs(Function):
+    """
+    Absolute value.
+    """
+
+    function_name = "ABS"
+
+
+class Ceil(Function):
+    """
+    Nearest integer greater than or equal to argument.
+    """
+
+    function_name = "CEIL"
+
+
+class Floor(Function):
+    """
+    Nearest integer less than or equal to argument.
+    """
+
+    function_name = "FLOOR"
+
+
+class Round(Function):
+    """
+    Rounds to nearest integer.
+    """
+
+    function_name = "ROUND"
+
+
+__all__ = (
+    "Abs",
+    "Ceil",
+    "Floor",
+    "Round",
+)

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo/querystring.py

@@ -282,12 +282,30 @@ class QueryString(Selectable):
     def __le__(self, value) -> QueryString:
         return QueryString("{} <= {}", self, value)
 
+    def __truediv__(self, value) -> QueryString:
+        return QueryString("{} / {}", self, value)
+
+    def __mul__(self, value) -> QueryString:
+        return QueryString("{} * {}", self, value)
+
+    def __pow__(self, value) -> QueryString:
+        return QueryString("{} ^ {}", self, value)
+
+    def __mod__(self, value) -> QueryString:
+        return QueryString("{} % {}", self, value)
+
     def is_in(self, value) -> QueryString:
         return QueryString("{} IN {}", self, value)
 
     def not_in(self, value) -> QueryString:
         return QueryString("{} NOT IN {}", self, value)
 
+    def like(self, value: str) -> QueryString:
+        return QueryString("{} LIKE {}", self, value)
+
+    def ilike(self, value: str) -> QueryString:
+        return QueryString("{} ILIKE {}", self, value)
+
 
 class Unquoted(QueryString):
     """

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo/schema.py

@@ -13,7 +13,8 @@ class SchemaDDLBase(abc.ABC):
 
     db: Engine
 
-    @abc.abstractproperty
+    @property
+    @abc.abstractmethod
     def ddl(self) -> str:
         pass
 

{piccolo-1.8.0 → piccolo-1.9.0}/piccolo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.8.0
+Version: 1.9.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.8.0 → piccolo-1.9.0}/piccolo.egg-info/SOURCES.txt

@@ -162,6 +162,7 @@ piccolo/query/proxy.py
 piccolo/query/functions/__init__.py
 piccolo/query/functions/aggregate.py
 piccolo/query/functions/base.py
+piccolo/query/functions/math.py
 piccolo/query/functions/string.py
 piccolo/query/functions/type_conversion.py
 piccolo/query/methods/__init__.py
@@ -265,6 +266,7 @@ tests/columns/test_date.py
 tests/columns/test_db_column_name.py
 tests/columns/test_defaults.py
 tests/columns/test_double_precision.py
+tests/columns/test_get_sql_value.py
 tests/columns/test_interval.py
 tests/columns/test_json.py
 tests/columns/test_jsonb.py
@@ -308,10 +310,15 @@ tests/query/__init__.py
 tests/query/test_await.py
 tests/query/test_camelcase.py
 tests/query/test_freeze.py
-tests/query/test_functions.py
 tests/query/test_gather.py
 tests/query/test_querystring.py
 tests/query/test_slots.py
+tests/query/functions/__init__.py
+tests/query/functions/base.py
+tests/query/functions/test_functions.py
+tests/query/functions/test_math.py
+tests/query/functions/test_string.py
+tests/query/functions/test_type_conversion.py
 tests/query/mixins/__init__.py
 tests/query/mixins/test_columns_delegate.py
 tests/query/mixins/test_order_by_delegate.py

{piccolo-1.8.0 → piccolo-1.9.0}/pyproject.toml

@@ -24,7 +24,8 @@ ignore_missing_imports = true
 [tool.pytest.ini_options]
 markers = [
     "integration",
-    "speed"
+    "speed",
+    "cockroach_array_slow"
 ]
 
 [tool.coverage.run]

{piccolo-1.8.0 → piccolo-1.9.0}/tests/columns/test_array.py

@@ -1,6 +1,8 @@
 import datetime
 from unittest import TestCase
 
+import pytest
+
 from piccolo.columns.column_types import (
     Array,
     BigInt,
@@ -10,8 +12,9 @@ from piccolo.columns.column_types import (
     Timestamp,
     Timestamptz,
 )
+from piccolo.querystring import QueryString
 from piccolo.table import Table
-from tests.base import engines_only, sqlite_only
+from tests.base import engines_only, engines_skip, sqlite_only
 
 
 class MyTable(Table):
@@ -40,12 +43,18 @@ class TestArray(TestCase):
     def tearDown(self):
         MyTable.alter().drop_table().run_sync()
 
-    @engines_only("postgres", "sqlite")
+    @pytest.mark.cockroach_array_slow
     def test_storage(self):
         """
         Make sure data can be stored and retrieved.
 
-        🐛 Cockroach bug: https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+        In CockroachDB <= v22.2.0 we had this error:
+
+        * https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+
+        In newer CockroachDB versions, it runs but is very slow:
+
+        * https://github.com/piccolo-orm/piccolo/issues/1005
 
         """  # noqa: E501
         MyTable(value=[1, 2, 3]).save().run_sync()
@@ -54,12 +63,19 @@ class TestArray(TestCase):
         assert row is not None
         self.assertEqual(row.value, [1, 2, 3])
 
-    @engines_only("postgres")
+    @engines_skip("sqlite")
+    @pytest.mark.cockroach_array_slow
     def test_index(self):
         """
         Indexes should allow individual array elements to be queried.
 
-        🐛 Cockroach bug: https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+        In CockroachDB <= v22.2.0 we had this error:
+
+        * https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+
+        In newer CockroachDB versions, it runs but is very slow:
+
+        * https://github.com/piccolo-orm/piccolo/issues/1005
 
         """  # noqa: E501
         MyTable(value=[1, 2, 3]).save().run_sync()
@@ -68,66 +84,92 @@ class TestArray(TestCase):
             MyTable.select(MyTable.value[0]).first().run_sync(), {"value": 1}
         )
 
-    @engines_only("postgres")
+    @engines_skip("sqlite")
+    @pytest.mark.cockroach_array_slow
     def test_all(self):
         """
         Make sure rows can be retrieved where all items in an array match a
         given value.
 
-        🐛 Cockroach bug: https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+        In CockroachDB <= v22.2.0 we had this error:
+
+        * https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+
+        In newer CockroachDB versions, it runs but is very slow:
+
+        * https://github.com/piccolo-orm/piccolo/issues/1005
 
         """  # noqa: E501
         MyTable(value=[1, 1, 1]).save().run_sync()
 
+        # We have to explicitly specify the type, so CockroachDB works.
         self.assertEqual(
             MyTable.select(MyTable.value)
-            .where(MyTable.value.all(1))
+            .where(MyTable.value.all(QueryString("{}::INTEGER", 1)))
             .first()
             .run_sync(),
             {"value": [1, 1, 1]},
         )
 
+        # We have to explicitly specify the type, so CockroachDB works.
         self.assertEqual(
             MyTable.select(MyTable.value)
-            .where(MyTable.value.all(0))
+            .where(MyTable.value.all(QueryString("{}::INTEGER", 0)))
             .first()
             .run_sync(),
             None,
         )
 
-    @engines_only("postgres")
+    @engines_skip("sqlite")
+    @pytest.mark.cockroach_array_slow
     def test_any(self):
         """
         Make sure rows can be retrieved where any items in an array match a
         given value.
 
-        🐛 Cockroach bug: https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+        In CockroachDB <= v22.2.0 we had this error:
+
+        * https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+
+        In newer CockroachDB versions, it runs but is very slow:
+
+        * https://github.com/piccolo-orm/piccolo/issues/1005
 
         """  # noqa: E501
+
         MyTable(value=[1, 2, 3]).save().run_sync()
 
+        # We have to explicitly specify the type, so CockroachDB works.
         self.assertEqual(
             MyTable.select(MyTable.value)
-            .where(MyTable.value.any(1))
+            .where(MyTable.value.any(QueryString("{}::INTEGER", 1)))
             .first()
             .run_sync(),
             {"value": [1, 2, 3]},
         )
 
+        # We have to explicitly specify the type, so CockroachDB works.
         self.assertEqual(
             MyTable.select(MyTable.value)
-            .where(MyTable.value.any(0))
+            .where(MyTable.value.any(QueryString("{}::INTEGER", 0)))
             .first()
             .run_sync(),
             None,
         )
 
-    @engines_only("postgres")
+    @engines_skip("sqlite")
+    @pytest.mark.cockroach_array_slow
     def test_cat(self):
         """
         Make sure values can be appended to an array.
 
-        🐛 Cockroach bug: https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+        In CockroachDB <= v22.2.0 we had this error:
+
+        * https://github.com/cockroachdb/cockroach/issues/71908 "could not decorrelate subquery" error under asyncpg
+
+        In newer CockroachDB versions, it runs but is very slow:
+
+        * https://github.com/piccolo-orm/piccolo/issues/1005
 
         """  # noqa: E501
         MyTable(value=[1, 1, 1]).save().run_sync()
@@ -137,7 +179,8 @@ class TestArray(TestCase):
         ).run_sync()
 
         self.assertEqual(
-            MyTable.select().run_sync(), [{"id": 1, "value": [1, 1, 1, 2]}]
+            MyTable.select(MyTable.value).run_sync(),
+            [{"value": [1, 1, 1, 2]}],
         )
 
         # Try plus symbol
@@ -147,7 +190,8 @@ class TestArray(TestCase):
         ).run_sync()
 
         self.assertEqual(
-            MyTable.select().run_sync(), [{"id": 1, "value": [1, 1, 1, 2, 3]}]
+            MyTable.select(MyTable.value).run_sync(),
+            [{"value": [1, 1, 1, 2, 3]}],
         )
 
         # Make sure non-list values work
@@ -157,8 +201,8 @@ class TestArray(TestCase):
         ).run_sync()
 
         self.assertEqual(
-            MyTable.select().run_sync(),
-            [{"id": 1, "value": [1, 1, 1, 2, 3, 4]}],
+            MyTable.select(MyTable.value).run_sync(),
+            [{"value": [1, 1, 1, 2, 3, 4]}],
         )
 
     @sqlite_only

piccolo-1.9.0/tests/columns/test_get_sql_value.py

@@ -0,0 +1,66 @@
+import datetime
+from unittest import TestCase
+
+from tests.base import engines_only
+from tests.example_apps.music.tables import Band
+
+
+@engines_only("postgres", "cockroach")
+class TestArrayPostgres(TestCase):
+
+    def test_string(self):
+        self.assertEqual(
+            Band.name.get_sql_value(["a", "b", "c"]),
+            '\'{"a","b","c"}\'',
+        )
+
+    def test_int(self):
+        self.assertEqual(
+            Band.name.get_sql_value([1, 2, 3]),
+            "'{1,2,3}'",
+        )
+
+    def test_nested(self):
+        self.assertEqual(
+            Band.name.get_sql_value([1, 2, 3, [4, 5, 6]]),
+            "'{1,2,3,{4,5,6}}'",
+        )
+
+    def test_time(self):
+        self.assertEqual(
+            Band.name.get_sql_value([datetime.time(hour=8, minute=0)]),
+            "'{\"08:00:00\"}'",
+        )
+
+
+@engines_only("sqlite")
+class TestArraySQLite(TestCase):
+    """
+    Note, we use ``.replace(" ", "")`` because we serialise arrays using
+    Python's json library, and there is inconsistency between Python versions
+    (some output ``["a", "b", "c"]``, and others ``["a","b","c"]``).
+    """
+
+    def test_string(self):
+        self.assertEqual(
+            Band.name.get_sql_value(["a", "b", "c"]).replace(" ", ""),
+            '\'["a","b","c"]\'',
+        )
+
+    def test_int(self):
+        self.assertEqual(
+            Band.name.get_sql_value([1, 2, 3]).replace(" ", ""),
+            "'[1,2,3]'",
+        )
+
+    def test_nested(self):
+        self.assertEqual(
+            Band.name.get_sql_value([1, 2, 3, [4, 5, 6]]).replace(" ", ""),
+            "'[1,2,3,[4,5,6]]'",
+        )
+
+    def test_time(self):
+        self.assertEqual(
+            Band.name.get_sql_value([datetime.time(hour=8, minute=0)]),
+            "'[\"08:00:00\"]'",
+        )

piccolo-1.9.0/tests/query/functions/base.py

@@ -0,0 +1,34 @@
+import typing as t
+from unittest import TestCase
+
+from piccolo.table import Table, create_db_tables_sync, drop_db_tables_sync
+from tests.example_apps.music.tables import Band, Manager
+
+
+class FunctionTest(TestCase):
+    tables: t.List[t.Type[Table]]
+
+    def setUp(self) -> None:
+        create_db_tables_sync(*self.tables)
+
+    def tearDown(self) -> None:
+        drop_db_tables_sync(*self.tables)
+
+
+class BandTest(FunctionTest):
+    tables = [Band, Manager]
+
+    def setUp(self) -> None:
+        super().setUp()
+
+        manager = Manager({Manager.name: "Guido"})
+        manager.save().run_sync()
+
+        band = Band(
+            {
+                Band.name: "Pythonistas",
+                Band.manager: manager,
+                Band.popularity: 1000,
+            }
+        )
+        band.save().run_sync()

piccolo-1.9.0/tests/query/functions/test_functions.py

@@ -0,0 +1,64 @@
+from piccolo.query.functions import Reverse, Upper
+from piccolo.querystring import QueryString
+from tests.base import engines_skip
+from tests.example_apps.music.tables import Band
+
+from .base import BandTest
+
+
+@engines_skip("sqlite")
+class TestNested(BandTest):
+    """
+    Skip the the test for SQLite, as it doesn't support ``Reverse``.
+    """
+
+    def test_nested(self):
+        """
+        Make sure we can nest functions.
+        """
+        response = Band.select(Upper(Reverse(Band.name))).run_sync()
+        self.assertListEqual(response, [{"upper": "SATSINOHTYP"}])
+
+    def test_nested_with_joined_column(self):
+        """
+        Make sure nested functions can be used on a column from a joined table.
+        """
+        response = Band.select(Upper(Reverse(Band.manager._.name))).run_sync()
+        self.assertListEqual(response, [{"upper": "ODIUG"}])
+
+    def test_nested_within_querystring(self):
+        """
+        If we wrap a function in a custom QueryString - make sure the columns
+        are still accessible, so joins are successful.
+        """
+        response = Band.select(
+            QueryString("CONCAT({}, '!')", Upper(Band.manager._.name)),
+        ).run_sync()
+
+        self.assertListEqual(response, [{"concat": "GUIDO!"}])
+
+
+class TestWhereClause(BandTest):
+
+    def test_where(self):
+        """
+        Make sure where clauses work with functions.
+        """
+        response = (
+            Band.select(Band.name)
+            .where(Upper(Band.name) == "PYTHONISTAS")
+            .run_sync()
+        )
+        self.assertListEqual(response, [{"name": "Pythonistas"}])
+
+    def test_where_with_joined_column(self):
+        """
+        Make sure where clauses work with functions, when a joined column is
+        used.
+        """
+        response = (
+            Band.select(Band.name)
+            .where(Upper(Band.manager._.name) == "GUIDO")
+            .run_sync()
+        )
+        self.assertListEqual(response, [{"name": "Pythonistas"}])