piccolo 1.15.0__tar.gz → 1.16.0__tar.gz

{piccolo-1.15.0 → piccolo-1.16.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.15.0
+Version: 1.16.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.16.0/piccolo/__init__.py

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

piccolo-1.16.0/piccolo/testing/test_case.py

@@ -0,0 +1,120 @@
+from __future__ import annotations
+
+import typing as t
+from unittest import IsolatedAsyncioTestCase, TestCase
+
+from piccolo.engine import Engine, engine_finder
+from piccolo.table import (
+    Table,
+    create_db_tables,
+    create_db_tables_sync,
+    drop_db_tables,
+    drop_db_tables_sync,
+)
+
+
+class TableTest(TestCase):
+    """
+    Identical to :class:`AsyncTableTest <piccolo.testing.test_case.AsyncTableTest>`,
+    except it only work for sync tests. Only use this if you can't make your
+    tests async (perhaps you're on Python 3.7 where ``IsolatedAsyncioTestCase``
+    isn't available).
+
+    For example::
+
+        class TestBand(TableTest):
+            tables = [Band]
+
+            def test_band(self):
+                ...
+
+    """  # noqa: E501
+
+    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 AsyncTableTest(IsolatedAsyncioTestCase):
+    """
+    Used for tests where we need to create Piccolo tables - they will
+    automatically be created and dropped.
+
+    For example::
+
+        class TestBand(AsyncTableTest):
+            tables = [Band]
+
+            async def test_band(self):
+                ...
+
+    """
+
+    tables: t.List[t.Type[Table]]
+
+    async def asyncSetUp(self) -> None:
+        await create_db_tables(*self.tables)
+
+    async def asyncTearDown(self) -> None:
+        await drop_db_tables(*self.tables)
+
+
+class AsyncTransactionTest(IsolatedAsyncioTestCase):
+    """
+    Wraps each test in a transaction, which is automatically rolled back when
+    the test finishes.
+
+    .. warning::
+        Python 3.11 and above only.
+
+    If your test suite just contains ``AsyncTransactionTest`` tests, then you
+    can setup your database tables once before your test suite runs. Any
+    changes made to your tables by the tests will be rolled back automatically.
+
+    Here's an example::
+
+        from piccolo.testing.test_case import AsyncTransactionTest
+
+
+        class TestBandEndpoint(AsyncTransactionTest):
+
+            async def test_band_response(self):
+                \"\"\"
+                Make sure the endpoint returns a 200.
+                \"\"\"
+                band = Band({Band.name: "Pythonistas"})
+                await band.save()
+
+                # Using an API testing client, like httpx:
+                response = await client.get(f"/bands/{band.id}/")
+                self.assertEqual(response.status_code, 200)
+
+    We add a ``Band`` to the database, but any subsequent tests won't see it,
+    as the changes are rolled back automatically.
+
+    """
+
+    # We use `engine_finder` to find the current `Engine`, but you can
+    # explicity set it here if you prefer:
+    #
+    # class MyTest(AsyncTransactionTest):
+    #     db = DB
+    #
+    #     ...
+    #
+    db: t.Optional[Engine] = None
+
+    async def asyncSetUp(self) -> None:
+        db = self.db or engine_finder()
+        assert db is not None
+        self.transaction = db.transaction()
+        # This is only available in Python 3.11 and above:
+        await self.enterAsyncContext(cm=self.transaction)  # type: ignore
+
+    async def asyncTearDown(self):
+        await super().asyncTearDown()
+        await self.transaction.rollback()

{piccolo-1.15.0 → piccolo-1.16.0}/piccolo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.15.0
+Version: 1.16.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.15.0 → piccolo-1.16.0}/piccolo.egg-info/SOURCES.txt

@@ -185,6 +185,7 @@ piccolo/query/methods/update.py
 piccolo/testing/__init__.py
 piccolo/testing/model_builder.py
 piccolo/testing/random_builder.py
+piccolo/testing/test_case.py
 piccolo/utils/__init__.py
 piccolo/utils/dictionary.py
 piccolo/utils/encoding.py
@@ -365,6 +366,7 @@ tests/table/instance/test_to_dict.py
 tests/testing/__init__.py
 tests/testing/test_model_builder.py
 tests/testing/test_random_builder.py
+tests/testing/test_test_case.py
 tests/utils/__init__.py
 tests/utils/test_dictionary.py
 tests/utils/test_encoding.py

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_array.py

@@ -14,7 +14,8 @@ from piccolo.columns.column_types import (
 )
 from piccolo.querystring import QueryString
 from piccolo.table import Table
-from tests.base import TableTest, engines_only, engines_skip, sqlite_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only, engines_skip, sqlite_only
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_bigint.py

@@ -2,7 +2,8 @@ import os
 
 from piccolo.columns.column_types import BigInt
 from piccolo.table import Table
-from tests.base import TableTest, engines_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_boolean.py

@@ -2,7 +2,7 @@ import typing as t
 
 from piccolo.columns.column_types import Boolean
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_bytea.py

@@ -1,6 +1,6 @@
 from piccolo.columns.column_types import Bytea
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_choices.py

@@ -2,7 +2,8 @@ import enum
 
 from piccolo.columns.column_types import Array, Varchar
 from piccolo.table import Table
-from tests.base import TableTest, engines_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only
 from tests.example_apps.music.tables import Shirt
 
 

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_date.py

@@ -3,7 +3,7 @@ import datetime
 from piccolo.columns.column_types import Date
 from piccolo.columns.defaults.date import DateNow
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_double_precision.py

@@ -1,6 +1,6 @@
 from piccolo.columns.column_types import DoublePrecision
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_interval.py

@@ -3,7 +3,7 @@ import datetime
 from piccolo.columns.column_types import Interval
 from piccolo.columns.defaults.interval import IntervalCustom
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_json.py

@@ -1,6 +1,6 @@
 from piccolo.columns.column_types import JSON
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_jsonb.py

@@ -1,6 +1,7 @@
 from piccolo.columns.column_types import JSONB, ForeignKey, Varchar
 from piccolo.table import Table
-from tests.base import TableTest, engines_only, engines_skip
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only, engines_skip
 
 
 class RecordingStudio(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_numeric.py

@@ -2,7 +2,7 @@ from decimal import Decimal
 
 from piccolo.columns.column_types import Numeric
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_primary_key.py

@@ -8,7 +8,7 @@ from piccolo.columns.column_types import (
     Varchar,
 )
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTableDefaultPrimaryKey(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_readable.py

@@ -1,7 +1,7 @@
 from piccolo import columns
 from piccolo.columns.readable import Readable
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_real.py

@@ -1,6 +1,6 @@
 from piccolo.columns.column_types import Real
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_reference.py

@@ -8,7 +8,7 @@ from unittest import TestCase
 from piccolo.columns import ForeignKey, Varchar
 from piccolo.columns.reference import LazyTableReference
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class Band(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_reserved_column_names.py

@@ -1,6 +1,6 @@
 from piccolo.columns.column_types import Integer, Varchar
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class Concert(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_smallint.py

@@ -2,8 +2,8 @@ import os
 
 from piccolo.columns.column_types import SmallInt
 from piccolo.table import Table
-
-from ..base import TableTest, engines_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_time.py

@@ -4,7 +4,8 @@ from functools import partial
 from piccolo.columns.column_types import Time
 from piccolo.columns.defaults.time import TimeNow
 from piccolo.table import Table
-from tests.base import TableTest, engines_skip
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_skip
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_timestamp.py

@@ -3,7 +3,7 @@ import datetime
 from piccolo.columns.column_types import Timestamp
 from piccolo.columns.defaults.timestamp import TimestampNow
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_timestamptz.py

@@ -9,7 +9,7 @@ from piccolo.columns.defaults.timestamptz import (
     TimestamptzOffset,
 )
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_uuid.py

@@ -2,7 +2,7 @@ import uuid
 
 from piccolo.columns.column_types import UUID
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/columns/test_varchar.py

@@ -1,7 +1,7 @@
 from piccolo.columns.column_types import Varchar
 from piccolo.table import Table
-
-from ..base import TableTest, engines_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only
 
 
 class MyTable(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/query/functions/base.py

@@ -1,4 +1,4 @@
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 from tests.example_apps.music.tables import Band, Manager
 
 

{piccolo-1.15.0 → piccolo-1.16.0}/tests/query/functions/test_datetime.py

@@ -12,7 +12,8 @@ from piccolo.query.functions.datetime import (
     Year,
 )
 from piccolo.table import Table
-from tests.base import TableTest, engines_only, sqlite_only
+from piccolo.testing.test_case import TableTest
+from tests.base import engines_only, sqlite_only
 
 
 class Concert(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/query/functions/test_math.py

@@ -3,7 +3,7 @@ import decimal
 from piccolo.columns import Numeric
 from piccolo.query.functions.math import Abs, Ceil, Floor, Round
 from piccolo.table import Table
-from tests.base import TableTest
+from piccolo.testing.test_case import TableTest
 
 
 class Ticket(Table):

{piccolo-1.15.0 → piccolo-1.16.0}/tests/table/test_refresh.py

@@ -1,6 +1,7 @@
 import typing as t
 
-from tests.base import DBTestCase, TableTest
+from piccolo.testing.test_case import TableTest
+from tests.base import DBTestCase
 from tests.example_apps.music.tables import (
     Band,
     Concert,

piccolo-1.16.0/tests/testing/test_test_case.py

@@ -0,0 +1,65 @@
+import sys
+
+import pytest
+
+from piccolo.engine import engine_finder
+from piccolo.testing.test_case import (
+    AsyncTableTest,
+    AsyncTransactionTest,
+    TableTest,
+)
+from tests.example_apps.music.tables import Band, Manager
+
+
+class TestTableTest(TableTest):
+    """
+    Make sure the tables are created automatically.
+    """
+
+    tables = [Band, Manager]
+
+    async def test_tables_created(self):
+        self.assertTrue(Band.table_exists().run_sync())
+        self.assertTrue(Manager.table_exists().run_sync())
+
+
+class TestAsyncTableTest(AsyncTableTest):
+    """
+    Make sure the tables are created automatically in async tests.
+    """
+
+    tables = [Band, Manager]
+
+    async def test_tables_created(self):
+        self.assertTrue(await Band.table_exists())
+        self.assertTrue(await Manager.table_exists())
+
+
+@pytest.mark.skipif(sys.version_info <= (3, 11), reason="Python 3.11 required")
+class TestAsyncTransaction(AsyncTransactionTest):
+    """
+    Make sure that the test exists within a transaction.
+    """
+
+    async def test_transaction_exists(self):
+        db = engine_finder()
+        assert db is not None
+        self.assertTrue(db.transaction_exists())
+
+
+@pytest.mark.skipif(sys.version_info <= (3, 11), reason="Python 3.11 required")
+class TestAsyncTransactionRolledBack(AsyncTransactionTest):
+    """
+    Make sure that the changes get rolled back automatically.
+    """
+
+    async def asyncTearDown(self):
+        await super().asyncTearDown()
+
+        assert Manager.table_exists().run_sync() is False
+
+    async def test_insert_data(self):
+        await Manager.create_table()
+
+        manager = Manager({Manager.name: "Guido"})
+        await manager.save()

piccolo-1.15.0/piccolo/__init__.py

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