Merge branch 'piccolo-orm:master' into composite_index

Author: sinisaos

CHANGES.rst

@@ -1,6 +1,48 @@
 Changes
 =======
 
+1.31.0
+------
+
+* Added official Postgres 18 support.
+* Removed graphlib backport (no longer needed in supported Python versions).
+* Improved documentation for column kwargs.
+* Updated README to mention other parts of the Piccolo ecosystem (thanks to
+  @sinisaos for this).
+* Table instances can now be compared using the ``==`` operator, and will
+  return ``True`` if they have the same primary key value (thanks to @aarcex3
+  and @Skelmis for this).
+* Fixed missing import for auto migrations when tables use
+  ``LazyTableReference`` (thanks to @sinisaos for this).
+* Improved docs for the auto generated primary key (thanks to @badlydrawnrob
+  for this).
+* Improved ``Table._table_str`` (this is most obvious in the playground, where
+  the table definitions printed out now show more information - thanks to
+  @badlydrawnrob for raising this issue).
+* Fixed a bug with ``ModelBuilder`` when using ``Array`` columns with
+  ``choices`` defined.
+* ``add_m2m`` now returns the id of the joining table row, to match the docs
+  (thanks to @diklios5768 for reporting this).
+* Improved the docs for ``UUID`` columns (what the ``UUID4`` default value
+  does).
+* Moved connection pooling to its own page in the docs.
+* Improved the ``on_conflict`` clause - a ``target`` must be specified if
+  using ``DO UPDATE`` (thanks to @mafuyuuu1 for raising this issue, and
+  @sinisaos for this fix).
+* Changed Esmerald to Ravyn in the ASGI templates (thanks to @sinisaos for
+  this).
+* Fixed a bug with auto migrations when changing a column to a foreign key - an
+  exception was being raised (thanks to @gsavchuk for raising this issue and
+  @sinisaos for this fix).
+* ``Array(Numeric())`` columns now work with SQLite (thanks to @sinisaos for
+  this).
+* UUID columns now use the built-in ``gen_random_uuid()`` function in Postgres
+  to generate a default value, instead of using the ``uuid-ossp`` extension
+  (thanks to @sinisaos for this). See
+  :ref:`this tutorial <UUIDColumnsMigrationTutorial>` for more details.
+
+-------------------------------------------------------------------------------
+
 1.30.0
 ------
 

docs/src/piccolo/engines/sqlite_engine.rst

@@ -30,4 +30,4 @@ Production tips
 ---------------
 
 If you're planning on using SQLite in production with Piccolo, with lots of
-concurrent queries, then here are some :ref:`useful tips <UsingSQLitAndAsyncioEffectively>`.
+concurrent queries, then here are some :ref:`useful tips <UsingSQLiteAndAsyncioEffectively>`.

docs/src/piccolo/tutorials/index.rst

@@ -13,3 +13,4 @@ help you solve common problems:
     ./fastapi
     ./avoiding_circular_imports
     ./moving_table_between_apps
+    ./uuid_columns_in_piccolo_1.31.0

docs/src/piccolo/tutorials/using_sqlite_and_asyncio_effectively.rst

@@ -1,4 +1,4 @@
-.. _UsingSQLitAndAsyncioEffectively:
+.. _UsingSQLiteAndAsyncioEffectively:
 
 Using SQLite and asyncio effectively
 ====================================

docs/src/piccolo/tutorials/uuid_columns_in_piccolo_1.31.0.rst

@@ -0,0 +1,33 @@
+.. _UUIDColumnsMigrationTutorial:
+
+UUID columns in Piccolo >= 1.31.0
+=================================
+
+Prior to ``piccolo==1.31.0``, Postgres
+:class:`UUID<piccolo.columns.column_types.UUID>` columns generated their
+default values using ``uuid_generate_v4()``, which is part of the
+``uuid-ossp`` extension.
+
+In all the versions of Posgres that Piccolo supports, there is now a
+``gen_random_uuid()`` function built in, which Piccolo now uses for all new
+``UUID`` columns for generating default values in the database.
+
+Your existing ``UUID`` columns will be left alone, and will continue to use the
+``uuid-ossp`` extension.
+
+Note that :class:`PostgresEngine<piccolo.engine.postgres.PostgresEngine>` has
+an ``extensions`` argument. These are Postgres extensions which Piccolo will
+try to enable when starting up. This used to include ``uuid-ossp`` by default,
+but this is no longer the case. If you want to maintain the old behaviour,
+simply do this:
+
+.. code-block:: python
+
+    DB = PostgresEngine(extensions=['uuid-ossp'])
+
+If you want to migrate an existing ``UUID`` column over to use
+``gen_random_uuid()`` then run this script:
+
+.. code-block:: sql
+
+    ALTER TABLE my_table ALTER COLUMN my_uuid_column SET DEFAULT gen_random_uuid();

piccolo/__init__.py

@@ -1 +1 @@
-__VERSION__ = "1.30.0"
+__VERSION__ = "1.31.0"

piccolo/engine/sqlite.py

@@ -105,7 +105,8 @@ def serialise(data: list):
             if isinstance(item, list):
                 output.append(serialise(item))
             elif isinstance(
-                item, (datetime.datetime, datetime.time, datetime.date)
+                item,
+                (datetime.datetime, datetime.time, datetime.date, Decimal),
             ):
                 if adapter := ADAPTERS.get(type(item)):
                     output.append(adapter(item))
@@ -317,7 +318,7 @@ def convert_M2M_out(value: str) -> list:
 
 # We have special column types for arrays of timestamps etc, as simply loading
 # the JSON isn't sufficient.
-for column_name in ("TIMESTAMP", "TIMESTAMPTZ", "DATE", "TIME"):
+for column_name in ("TIMESTAMP", "TIMESTAMPTZ", "DATE", "TIME", "NUMERIC"):
     sqlite3.register_converter(
         f"ARRAY_{column_name}",
         partial(

tests/columns/test_array.py

@@ -1,4 +1,5 @@
 import datetime
+from decimal import Decimal
 from unittest import TestCase
 
 import pytest
@@ -8,6 +9,7 @@
     BigInt,
     Date,
     Integer,
+    Numeric,
     Time,
     Timestamp,
     Timestamptz,
@@ -411,21 +413,23 @@ def test_remove_sqlite(self):
 
 
 ###############################################################################
-# Date and time arrays
+# Date, time and decimal arrays
 
 
-class DateTimeArrayTable(Table):
+class DateTimeDecimalArrayTable(Table):
     date = Array(Date())
     time = Array(Time())
     timestamp = Array(Timestamp())
     timestamptz = Array(Timestamptz())
+    decimal = Array(Numeric(digits=(5, 2)))
     date_nullable = Array(Date(), null=True)
     time_nullable = Array(Time(), null=True)
     timestamp_nullable = Array(Timestamp(), null=True)
     timestamptz_nullable = Array(Timestamptz(), null=True)
+    decimal_nullable = Array(Numeric(digits=(5, 2)), null=True)
 
 
-class TestDateTimeArray(TestCase):
+class TestDateTimeDecimalArray(TestCase):
     """
     Make sure that data can be stored and retrieved when using arrays of
     date / time / timestamp.
@@ -436,10 +440,10 @@ class TestDateTimeArray(TestCase):
     """
 
     def setUp(self):
-        DateTimeArrayTable.create_table().run_sync()
+        DateTimeDecimalArrayTable.create_table().run_sync()
 
     def tearDown(self):
-        DateTimeArrayTable.alter().drop_table().run_sync()
+        DateTimeDecimalArrayTable.alter().drop_table().run_sync()
 
     @engines_only("postgres", "sqlite")
     def test_storage(self):
@@ -456,32 +460,37 @@ def test_storage(self):
             minute=0,
             tzinfo=datetime.timezone.utc,
         )
+        test_decimal = Decimal("50.0")
 
-        DateTimeArrayTable(
+        DateTimeDecimalArrayTable(
             {
-                DateTimeArrayTable.date: [test_date],
-                DateTimeArrayTable.time: [test_time],
-                DateTimeArrayTable.timestamp: [test_timestamp],
-                DateTimeArrayTable.timestamptz: [test_timestamptz],
-                DateTimeArrayTable.date_nullable: None,
-                DateTimeArrayTable.time_nullable: None,
-                DateTimeArrayTable.timestamp_nullable: None,
-                DateTimeArrayTable.timestamptz_nullable: None,
+                DateTimeDecimalArrayTable.date: [test_date],
+                DateTimeDecimalArrayTable.time: [test_time],
+                DateTimeDecimalArrayTable.timestamp: [test_timestamp],
+                DateTimeDecimalArrayTable.timestamptz: [test_timestamptz],
+                DateTimeDecimalArrayTable.decimal: [test_decimal],
+                DateTimeDecimalArrayTable.date_nullable: None,
+                DateTimeDecimalArrayTable.time_nullable: None,
+                DateTimeDecimalArrayTable.timestamp_nullable: None,
+                DateTimeDecimalArrayTable.timestamptz_nullable: None,
+                DateTimeDecimalArrayTable.decimal_nullable: None,
             }
         ).save().run_sync()
 
-        row = DateTimeArrayTable.objects().first().run_sync()
+        row = DateTimeDecimalArrayTable.objects().first().run_sync()
         assert row is not None
 
         self.assertListEqual(row.date, [test_date])
         self.assertListEqual(row.time, [test_time])
         self.assertListEqual(row.timestamp, [test_timestamp])
         self.assertListEqual(row.timestamptz, [test_timestamptz])
+        self.assertListEqual(row.decimal, [test_decimal])
 
         self.assertIsNone(row.date_nullable)
         self.assertIsNone(row.time_nullable)
         self.assertIsNone(row.timestamp_nullable)
         self.assertIsNone(row.timestamptz_nullable)
+        self.assertIsNone(row.decimal_nullable)
 
 
 ###############################################################################