piccolo 1.18.0__tar.gz → 1.19.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.18.0
+Version: 1.19.1
 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.19.1/piccolo/__init__.py

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

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

@@ -12,10 +12,10 @@ TEMPLATE_DIR = os.path.join(os.path.dirname(__file__), "templates/app/")
 SERVERS = ["uvicorn", "Hypercorn", "granian"]
 ROUTER_DEPENDENCIES = {
     "starlette": ["starlette"],
-    "fastapi": ["fastapi>=0.112.1"],
+    "fastapi": ["fastapi"],
     "blacksheep": ["blacksheep"],
     "litestar": ["litestar"],
-    "esmerald": ["esmerald==3.3.0"],
+    "esmerald": ["esmerald"],
     "lilya": ["lilya"],
 }
 ROUTERS = list(ROUTER_DEPENDENCIES.keys())

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/apps/asgi/commands/templates/app/_blacksheep_app.py.jinja

@@ -1,20 +1,18 @@
 import typing as t
 
-from piccolo_admin.endpoints import create_admin
-from piccolo_api.crud.serializers import create_pydantic_model
-from piccolo.engine import engine_finder
-
 from blacksheep.server import Application
 from blacksheep.server.bindings import FromJSON
-from blacksheep.server.responses import json
 from blacksheep.server.openapi.v3 import OpenAPIHandler
+from blacksheep.server.responses import json
 from openapidocs.v3 import Info
+from piccolo.engine import engine_finder
+from piccolo_admin.endpoints import create_admin
+from piccolo_api.crud.serializers import create_pydantic_model
 
 from home.endpoints import home
 from home.piccolo_app import APP_CONFIG
 from home.tables import Task
 
-
 app = Application()
 
 app.mount(
@@ -47,7 +45,7 @@ TaskModelPartial: t.Any = create_pydantic_model(
 
 @app.router.get("/tasks/")
 async def tasks() -> t.List[TaskModelOut]:
-    return await Task.select().order_by(Task.id)
+    return await Task.select().order_by(Task._meta.primary_key, ascending=False)
 
 
 @app.router.post("/tasks/")
@@ -58,10 +56,8 @@ async def create_task(task_model: FromJSON[TaskModelIn]) -> TaskModelOut:
 
 
 @app.router.put("/tasks/{task_id}/")
-async def put_task(
-    task_id: int, task_model: FromJSON[TaskModelIn]
-) -> TaskModelOut:
-    task = await Task.objects().get(Task.id == task_id)
+async def put_task(task_id: int, task_model: FromJSON[TaskModelIn]) -> TaskModelOut:
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
     if not task:
         return json({}, status=404)
 
@@ -77,7 +73,7 @@ async def put_task(
 async def patch_task(
     task_id: int, task_model: FromJSON[TaskModelPartial]
 ) -> TaskModelOut:
-    task = await Task.objects().get(Task.id == task_id)
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
     if not task:
         return json({}, status=404)
 
@@ -92,7 +88,7 @@ async def patch_task(
 
 @app.router.delete("/tasks/{task_id}/")
 async def delete_task(task_id: int):
-    task = await Task.objects().get(Task.id == task_id)
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
     if not task:
         return json({}, status=404)
 

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/apps/asgi/commands/templates/app/_esmerald_app.py.jinja

@@ -1,23 +1,21 @@
 import typing as t
-
 from pathlib import Path
 
-from piccolo.utils.pydantic import create_pydantic_model
-from piccolo.engine import engine_finder
-from piccolo_admin.endpoints import create_admin
-
 from esmerald import (
+    APIView,
     Esmerald,
-    Include,
     Gateway,
+    Include,
     JSONResponse,
-    APIView,
+    delete,
     get,
     post,
     put,
-    delete
 )
 from esmerald.config import StaticFilesConfig
+from piccolo.engine import engine_finder
+from piccolo.utils.pydantic import create_pydantic_model
+from piccolo_admin.endpoints import create_admin
 
 from home.endpoints import home
 from home.piccolo_app import APP_CONFIG
@@ -40,14 +38,9 @@ async def close_database_connection_pool():
         print("Unable to connect to the database")
 
 
-TaskModelIn: t.Any = create_pydantic_model(
-    table=Task,
-    model_name='TaskModelIn'
-)
+TaskModelIn: t.Any = create_pydantic_model(table=Task, model_name="TaskModelIn")
 TaskModelOut: t.Any = create_pydantic_model(
-    table=Task,
-    include_default_columns=True,
-    model_name='TaskModelOut'
+    table=Task, include_default_columns=True, model_name="TaskModelOut"
 )
 
 
@@ -57,19 +50,17 @@ class TaskAPIView(APIView):
 
     @get("/")
     async def tasks(self) -> t.List[TaskModelOut]:
-        return await Task.select().order_by(Task.id)
-
+        return await Task.select().order_by(Task._meta.primary_key, ascending=False)
 
-    @post('/')
+    @post("/")
     async def create_task(self, payload: TaskModelIn) -> TaskModelOut:
         task = Task(**payload.dict())
         await task.save()
         return task.to_dict()
 
-
-    @put('/{task_id}')
+    @put("/{task_id}")
     async def update_task(self, payload: TaskModelIn, task_id: int) -> TaskModelOut:
-        task = await Task.objects().get(Task.id == task_id)
+        task = await Task.objects().get(Task._meta.primary_key == task_id)
         if not task:
             return JSONResponse({}, status_code=404)
 
@@ -80,10 +71,9 @@ class TaskAPIView(APIView):
 
         return task.to_dict()
 
-
-    @delete('/{task_id}')
+    @delete("/{task_id}")
     async def delete_task(self, task_id: int) -> None:
-        task = await Task.objects().get(Task.id == task_id)
+        task = await Task.objects().get(Task._meta.primary_key == task_id)
         if not task:
             return JSONResponse({}, status_code=404)
 

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/apps/asgi/commands/templates/app/_lilya_app.py.jinja

@@ -1,15 +1,14 @@
-from piccolo_admin.endpoints import create_admin
-from piccolo_api.crud.endpoints import PiccoloCRUD
-from piccolo.engine import engine_finder
-from lilya.routing import Path, Include
 from lilya.apps import Lilya
+from lilya.routing import Include, Path
 from lilya.staticfiles import StaticFiles
+from piccolo.engine import engine_finder
+from piccolo_admin.endpoints import create_admin
+from piccolo_api.crud.endpoints import PiccoloCRUD
 
 from home.endpoints import HomeController
 from home.piccolo_app import APP_CONFIG
 from home.tables import Task
 
-
 app = Lilya(
     routes=[
         Path("/", HomeController),
@@ -19,10 +18,10 @@ app = Lilya(
                 tables=APP_CONFIG.table_classes,
                 # Required when running under HTTPS:
                 # allowed_hosts=['my_site.com']
-            )
+            ),
         ),
         Include("/static/", StaticFiles(directory="static")),
-        Include("/tasks/", PiccoloCRUD(table=Task))
+        Include("/tasks/", PiccoloCRUD(table=Task)),
     ],
 )
 

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/apps/asgi/commands/templates/app/_litestar_app.py.jinja

@@ -1,8 +1,5 @@
 import typing as t
 
-from home.endpoints import home
-from home.piccolo_app import APP_CONFIG
-from home.tables import Task
 from litestar import Litestar, asgi, delete, get, patch, post
 from litestar.contrib.jinja import JinjaTemplateEngine
 from litestar.exceptions import NotFoundException
@@ -10,8 +7,19 @@ from litestar.static_files import StaticFilesConfig
 from litestar.template import TemplateConfig
 from litestar.types import Receive, Scope, Send
 from piccolo.engine import engine_finder
-from piccolo.utils.pydantic import create_pydantic_model
 from piccolo_admin.endpoints import create_admin
+from pydantic import BaseModel
+
+from home.endpoints import home
+from home.piccolo_app import APP_CONFIG
+from home.tables import Task
+
+"""
+NOTE: `create_pydantic_model` is not compatible with Litestar
+version higher than 2.11.0. If you are using Litestar<=2.11.0, 
+you can use `create_pydantic_model` as in other asgi templates
+
+from piccolo.utils.pydantic import create_pydantic_model
 
 TaskModelIn: t.Any = create_pydantic_model(
     table=Task,
@@ -22,6 +30,18 @@ TaskModelOut: t.Any = create_pydantic_model(
     include_default_columns=True,
     model_name="TaskModelOut",
 )
+"""
+
+
+class TaskModelIn(BaseModel):
+    name: str
+    completed: bool = False
+
+
+class TaskModelOut(BaseModel):
+    id: int
+    name: str
+    completed: bool = False
 
 
 # mounting Piccolo Admin
@@ -32,31 +52,32 @@ async def admin(scope: "Scope", receive: "Receive", send: "Send") -> None:
 
 @get("/tasks", tags=["Task"])
 async def tasks() -> t.List[TaskModelOut]:
-    return await Task.select().order_by(Task.id, ascending=False)
+    tasks = await Task.select().order_by(Task._meta.primary_key, ascending=False)
+    return [TaskModelOut(**task) for task in tasks]
 
 
 @post("/tasks", tags=["Task"])
 async def create_task(data: TaskModelIn) -> TaskModelOut:
-    task = Task(**data.dict())
+    task = Task(**data.model_dump())
     await task.save()
-    return task.to_dict()
+    return TaskModelOut(**task.to_dict())
 
 
 @patch("/tasks/{task_id:int}", tags=["Task"])
 async def update_task(task_id: int, data: TaskModelIn) -> TaskModelOut:
-    task = await Task.objects().get(Task.id == task_id)
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
     if not task:
         raise NotFoundException("Task does not exist")
-    for key, value in data.dict().items():
+    for key, value in data.model_dump().items():
         setattr(task, key, value)
 
     await task.save()
-    return task.to_dict()
+    return TaskModelOut(**task.to_dict())
 
 
 @delete("/tasks/{task_id:int}", tags=["Task"])
 async def delete_task(task_id: int) -> None:
-    task = await Task.objects().get(Task.id == task_id)
+    task = await Task.objects().get(Task._meta.primary_key == task_id)
     if not task:
         raise NotFoundException("Task does not exist")
     await task.remove()

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/columns/m2m.py

@@ -384,8 +384,12 @@ class M2MGetRelated:
             .output(as_list=True)
         )
 
-        results = await secondary_table.objects().where(
-            secondary_table._meta.primary_key.is_in(ids)
+        results = (
+            await secondary_table.objects().where(
+                secondary_table._meta.primary_key.is_in(ids)
+            )
+            if len(ids) > 0
+            else []
         )
 
         return results

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

@@ -13,6 +13,8 @@ from piccolo.query.mixins import (
     CallbackDelegate,
     CallbackType,
     LimitDelegate,
+    LockRowsDelegate,
+    LockStrength,
     OffsetDelegate,
     OrderByDelegate,
     OrderByRaw,
@@ -250,6 +252,7 @@ class Objects(
         "callback_delegate",
         "prefetch_delegate",
         "where_delegate",
+        "lock_rows_delegate",
     )
 
     def __init__(
@@ -269,6 +272,7 @@ class Objects(
         self.prefetch_delegate = PrefetchDelegate()
         self.prefetch(*prefetch)
         self.where_delegate = WhereDelegate()
+        self.lock_rows_delegate = LockRowsDelegate()
 
     def output(self: Self, load_json: bool = False) -> Self:
         self.output_delegate.output(
@@ -328,6 +332,26 @@ class Objects(
         self.limit_delegate.limit(1)
         return First[TableInstance](query=self)
 
+    def lock_rows(
+        self: Self,
+        lock_strength: t.Union[
+            LockStrength,
+            t.Literal[
+                "UPDATE",
+                "NO KEY UPDATE",
+                "KEY SHARE",
+                "SHARE",
+            ],
+        ] = LockStrength.update,
+        nowait: bool = False,
+        skip_locked: bool = False,
+        of: t.Tuple[type[Table], ...] = (),
+    ) -> Self:
+        self.lock_rows_delegate.lock_rows(
+            lock_strength, nowait, skip_locked, of
+        )
+        return self
+
     def get(self, where: Combinable) -> Get[TableInstance]:
         self.where_delegate.where(where)
         self.limit_delegate.limit(1)
@@ -378,6 +402,7 @@ class Objects(
             "offset_delegate",
             "output_delegate",
             "order_by_delegate",
+            "lock_rows_delegate",
         ):
             setattr(select, attr, getattr(self, attr))
 

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/query/methods/select.py

@@ -19,6 +19,8 @@ from piccolo.query.mixins import (
     DistinctDelegate,
     GroupByDelegate,
     LimitDelegate,
+    LockRowsDelegate,
+    LockStrength,
     OffsetDelegate,
     OrderByDelegate,
     OrderByRaw,
@@ -150,6 +152,7 @@ class Select(Query[TableInstance, t.List[t.Dict[str, t.Any]]]):
         "output_delegate",
         "callback_delegate",
         "where_delegate",
+        "lock_rows_delegate",
     )
 
     def __init__(
@@ -174,6 +177,7 @@ class Select(Query[TableInstance, t.List[t.Dict[str, t.Any]]]):
         self.output_delegate = OutputDelegate()
         self.callback_delegate = CallbackDelegate()
         self.where_delegate = WhereDelegate()
+        self.lock_rows_delegate = LockRowsDelegate()
 
         self.columns(*columns_list)
 
@@ -219,6 +223,26 @@ class Select(Query[TableInstance, t.List[t.Dict[str, t.Any]]]):
         self.offset_delegate.offset(number)
         return self
 
+    def lock_rows(
+        self: Self,
+        lock_strength: t.Union[
+            LockStrength,
+            t.Literal[
+                "UPDATE",
+                "NO KEY UPDATE",
+                "KEY SHARE",
+                "SHARE",
+            ],
+        ] = LockStrength.update,
+        nowait: bool = False,
+        skip_locked: bool = False,
+        of: t.Tuple[type[Table], ...] = (),
+    ) -> Self:
+        self.lock_rows_delegate.lock_rows(
+            lock_strength, nowait, skip_locked, of
+        )
+        return self
+
     async def _splice_m2m_rows(
         self,
         response: t.List[t.Dict[str, t.Any]],
@@ -618,6 +642,16 @@ class Select(Query[TableInstance, t.List[t.Dict[str, t.Any]]]):
             query += "{}"
             args.append(self.offset_delegate._offset.querystring)
 
+        if self.lock_rows_delegate._lock_rows:
+            if engine_type == "sqlite":
+                raise NotImplementedError(
+                    "SQLite doesn't support row locking e.g. SELECT ... FOR "
+                    "UPDATE"
+                )
+
+            query += "{}"
+            args.append(self.lock_rows_delegate._lock_rows.querystring)
+
         querystring = QueryString(query, *args)
 
         return [querystring]

{piccolo-1.18.0 → piccolo-1.19.1}/piccolo/query/mixins.py

@@ -784,3 +784,91 @@ class OnConflictDelegate:
                 target=target, action=action_, values=values, where=where
             )
         )
+
+
+class LockStrength(str, Enum):
+    """
+    Specify lock strength
+
+    https://www.postgresql.org/docs/current/sql-select.html#SQL-FOR-UPDATE-SHARE
+    """
+
+    update = "UPDATE"
+    no_key_update = "NO KEY UPDATE"
+    share = "SHARE"
+    key_share = "KEY SHARE"
+
+
+@dataclass
+class LockRows:
+    __slots__ = ("lock_strength", "nowait", "skip_locked", "of")
+
+    lock_strength: LockStrength
+    nowait: bool
+    skip_locked: bool
+    of: t.Tuple[t.Type[Table], ...]
+
+    def __post_init__(self):
+        if not isinstance(self.lock_strength, LockStrength):
+            raise TypeError("lock_strength must be a LockStrength")
+        if not isinstance(self.nowait, bool):
+            raise TypeError("nowait must be a bool")
+        if not isinstance(self.skip_locked, bool):
+            raise TypeError("skip_locked must be a bool")
+        if not isinstance(self.of, tuple) or not all(
+            hasattr(x, "_meta") for x in self.of
+        ):
+            raise TypeError("of must be a tuple of Table")
+        if self.nowait and self.skip_locked:
+            raise TypeError(
+                "The nowait option cannot be used with skip_locked"
+            )
+
+    @property
+    def querystring(self) -> QueryString:
+        sql = f" FOR {self.lock_strength.value}"
+        if self.of:
+            tables = ", ".join(
+                i._meta.get_formatted_tablename() for i in self.of
+            )
+            sql += " OF " + tables
+        if self.nowait:
+            sql += " NOWAIT"
+        if self.skip_locked:
+            sql += " SKIP LOCKED"
+
+        return QueryString(sql)
+
+    def __str__(self) -> str:
+        return self.querystring.__str__()
+
+
+@dataclass
+class LockRowsDelegate:
+
+    _lock_rows: t.Optional[LockRows] = None
+
+    def lock_rows(
+        self,
+        lock_strength: t.Union[
+            LockStrength,
+            t.Literal[
+                "UPDATE",
+                "NO KEY UPDATE",
+                "KEY SHARE",
+                "SHARE",
+            ],
+        ] = LockStrength.update,
+        nowait=False,
+        skip_locked=False,
+        of: t.Tuple[type[Table], ...] = (),
+    ):
+        lock_strength_: LockStrength
+        if isinstance(lock_strength, LockStrength):
+            lock_strength_ = lock_strength
+        elif isinstance(lock_strength, str):
+            lock_strength_ = LockStrength(lock_strength.upper())
+        else:
+            raise ValueError("Unrecognised `lock_strength` value.")
+
+        self._lock_rows = LockRows(lock_strength_, nowait, skip_locked, of)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: piccolo
-Version: 1.18.0
+Version: 1.19.1
 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-1.19.1}/tests/columns/m2m/base.py

@@ -434,6 +434,22 @@ class M2MBase:
 
         self.assertEqual([i.name for i in genres], ["Rock", "Folk"])
 
+    def test_get_m2m_no_rows(self):
+        """
+        If there are no matching objects, then an empty list should be
+        returned.
+
+        https://github.com/piccolo-orm/piccolo/issues/1090
+
+        """
+        band = Band.objects().get(Band.name == "Pythonistas").run_sync()
+        assert band is not None
+
+        Genre.delete(force=True).run_sync()
+
+        genres = band.get_m2m(Band.genres).run_sync()
+        self.assertEqual(genres, [])
+
     def test_remove_m2m(self):
         """
         Make sure we can remove related items via the joining table.

{piccolo-1.18.0 → piccolo-1.19.1}/tests/table/test_select.py

@@ -1028,6 +1028,40 @@ class TestSelect(DBTestCase):
             response, [{"name": "Pythonistas", "popularity_log": 3.0}]
         )
 
+    @pytest.mark.skipif(
+        is_running_sqlite(),
+        reason="SQLite doesn't support SELECT ... FOR UPDATE.",
+    )
+    def test_lock_rows(self):
+        """
+        Make sure the for_update clause works.
+        """
+        self.insert_rows()
+
+        query = Band.select()
+        self.assertNotIn("FOR UPDATE", query.__str__())
+
+        query = query.lock_rows()
+        self.assertTrue(query.__str__().endswith("FOR UPDATE"))
+
+        query = query.lock_rows(lock_strength="KEY SHARE")
+        self.assertTrue(query.__str__().endswith("FOR KEY SHARE"))
+
+        query = query.lock_rows(skip_locked=True)
+        self.assertTrue(query.__str__().endswith("FOR UPDATE SKIP LOCKED"))
+
+        query = query.lock_rows(nowait=True)
+        self.assertTrue(query.__str__().endswith("FOR UPDATE NOWAIT"))
+
+        query = query.lock_rows(of=(Band,))
+        self.assertTrue(query.__str__().endswith('FOR UPDATE OF "band"'))
+
+        with self.assertRaises(TypeError):
+            query = query.lock_rows(skip_locked=True, nowait=True)
+
+        response = query.run_sync()
+        assert response is not None
+
 
 class TestSelectSecret(TestCase):
     def setUp(self):

piccolo-1.18.0/piccolo/__init__.py

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