muffin-rest 12.0.3__py3-none-any.whl → 13.0.1__py3-none-any.whl

muffin_rest/handler.py

@@ -82,7 +82,7 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
 
         else:
             router.bind(cls, f"/{ cls.meta.name }", methods=methods, **params)
-            router.bind(cls, f"/{ cls.meta.name }/{{pk}}", methods=methods, **params)
+            router.bind(cls, f"/{ cls.meta.name }/{{id}}", methods=methods, **params)
 
         for _, method in inspect.getmembers(cls, lambda m: hasattr(m, "__route__")):
             paths, methods = method.__route__
@@ -147,7 +147,7 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
 
     async def prepare_resource(self, request: Request) -> Any:
         """Load a resource."""
-        return request["path_params"].get("pk")
+        return request["path_params"].get("id")
 
     async def filter(self, request: Request, collection: TVCollection) -> tuple[TVCollection, Any]:
         """Filter the collection."""

muffin_rest/mongo/__init__.py

@@ -86,13 +86,13 @@ class MongoRESTHandler(RESTHandler[TVResource]):
 
     async def prepare_resource(self, request: Request) -> TVResource | None:
         """Load a resource."""
-        pk = request["path_params"].get("pk")
-        if not pk:
+        key = request["path_params"].get("id")
+        if not key:
             return None
 
         try:
             return await self.collection.find_one(
-                {self.meta.collection_id: bson.ObjectId(pk)},
+                {self.meta.collection_id: bson.ObjectId(key)},
             )
         except InvalidId as exc:
             raise APIError.NOT_FOUND() from exc

muffin_rest/openapi.py

@@ -199,7 +199,7 @@ class OpenAPIMixin:
         schema_ref = {"$ref": f"#/components/schemas/{ meta.Schema.__name__ }"}
         for method in route_to_methods(route):
             operations[method] = {"tags": [tags[cls]]}
-            is_resource_route = isinstance(route, DynamicRoute) and route.params.get("pk")
+            is_resource_route = isinstance(route, DynamicRoute) and route.params.get("id")
 
             if method == "get" and not is_resource_route:
                 operations[method]["parameters"] = []

muffin_rest/peewee/handler.py

@@ -58,15 +58,15 @@ class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):
 
     async def prepare_resource(self, request: Request) -> TVModel | None:
         """Load a resource."""
-        pk = request["path_params"].get("pk")
-        if not pk:
+        key = request["path_params"].get("id")
+        if not key:
             return None
 
         meta = self.meta
 
         try:
             resource = await meta.manager.fetchone(
-                self.collection.where(meta.model_pk == pk),
+                self.collection.where(meta.model_pk == key),
             )
         except Exception:  # noqa: BLE001
             resource = None

muffin_rest/peewee/openapi.py

@@ -22,7 +22,7 @@ class PeeweeOpenAPIMixin(OpenAPIMixin):
     def openapi(cls, route: Route, spec: APISpec, tags: dict) -> dict:
         """Get openapi specs for the endpoint."""
         operations = super(PeeweeOpenAPIMixin, cls).openapi(route, spec, tags)
-        is_resource_route = getattr(route, "params", {}).get("pk")
+        is_resource_route = getattr(route, "params", {}).get("id")
         if not is_resource_route and "delete" in operations:
             operations["delete"].setdefault("parameters", [])
             operations["delete"]["requestBody"] = {

muffin_rest/sqlalchemy/__init__.py

@@ -143,11 +143,11 @@ class SARESTHandler(RESTHandler[TVResource]):
 
     async def prepare_resource(self, request: Request) -> TVResource | None:
         """Load a resource."""
-        pk = request["path_params"].get("pk")
-        if not pk:
+        key = request["path_params"].get("id")
+        if not key:
             return None
 
-        qs = self.collection.where(self.meta.table_pk == pk)
+        qs = self.collection.where(self.meta.table_pk == key)
         resource = await self.meta.database.fetch_one(qs)
         if resource is None:
             raise APIError.NOT_FOUND("Resource not found")
@@ -176,11 +176,11 @@ class SARESTHandler(RESTHandler[TVResource]):
     async def remove(self, request: Request, resource: TVResource | None = None):
         """Remove the given resource."""
         table_pk = cast("sa.Column", self.meta.table_pk)
-        pks = [resource[table_pk.name]] if resource else await request.data()
-        if not pks:
+        keys = [resource[table_pk.name]] if resource else await request.data()
+        if not keys:
             raise APIError.NOT_FOUND()
 
-        delete = self.meta.table.delete().where(table_pk.in_(cast("list[Any]", pks)))
+        delete = self.meta.table.delete().where(table_pk.in_(cast("list[Any]", keys)))
         await self.meta.database.execute(delete)
 
     delete = remove

{muffin_rest-12.0.3.dist-info → muffin_rest-13.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: muffin-rest
-Version: 12.0.3
+Version: 13.0.1
 Summary: The package provides enhanced support for writing REST APIs with Muffin framework
 License: MIT
 Keywords: rest,api,muffin,asgi,asyncio,trio

{muffin_rest-12.0.3.dist-info → muffin_rest-13.0.1.dist-info}/RECORD

@@ -2,21 +2,21 @@ muffin_rest/__init__.py,sha256=JnwsHQNDmJpOqETeIjjPheG891T5WQ0JBaiEV72Wcmg,1242
 muffin_rest/api.py,sha256=bdbXMPiZi5yXf7_u3XB_gaGDHZKzDPqnnFnrwHoO1Rs,3799
 muffin_rest/errors.py,sha256=Todg7CrCE1ufOsyyARI2Bv-RqNPH4Rl1p-Tkpq7VYrA,1151
 muffin_rest/filters.py,sha256=nWlwDLuId-mmP3tgZjp1joYCVx0k9ekV42fPIMMKphM,5920
-muffin_rest/handler.py,sha256=qpG4ioIagdYqGFOrlT7pBx-0czgS2ZI3AvqKXz9EzcA,10762
+muffin_rest/handler.py,sha256=97nkx5rGB2CE_7oPG4UOLVw7b4UcGbubkSt1m_LrHhk,10762
 muffin_rest/limits.py,sha256=Fnlu4Wj3B-BzpahLK-rDbd1GEd7CEQ3zxyOD0vee7GE,2007
 muffin_rest/marshmallow.py,sha256=-MyMKiaMTfiWw4y-4adpfoQd05HV1vEKqSXJh8eD3xg,548
-muffin_rest/mongo/__init__.py,sha256=xKwIJtDhQFZBmLUWZrZox9ootK3S4UVy0EZ14oF0L20,4662
+muffin_rest/mongo/__init__.py,sha256=dck5zDEv0P3v_2CdlPI7Nbg8xay-EIzy9Y0yksEZkxw,4665
 muffin_rest/mongo/filters.py,sha256=yIxIDVqMn6SoDgVhCqiTxYetw0hoaf_3jIvX2Vnizok,964
 muffin_rest/mongo/schema.py,sha256=y4OEPQnlV_COTIIQ3cKmpqDpD2r18eAWn0rijQldWm0,1205
 muffin_rest/mongo/sorting.py,sha256=iJBnaFwE7g_JMwpGpQkoqSqbQK9XULx1K3skiRRgLgY,870
 muffin_rest/mongo/types.py,sha256=jaODScgwwYbzHis3DY4bPzU1ahiMJMSwquH5_Thi-Gg,200
 muffin_rest/mongo/utils.py,sha256=jirD2Hxk28Wadpq_F08t40dYBygq6W1_0cD3261kCgo,3949
-muffin_rest/openapi.py,sha256=VrkyZr_T0ykAQsvkFQ_yarZ-Zs55AmAGf4aNLsUdjGA,8715
+muffin_rest/openapi.py,sha256=FDHhgzsrCMEjUY63ro4CBlYHpPQHlYJRWRnzF9GyTw4,8715
 muffin_rest/options.py,sha256=Mzv0mq6YylL6cNtad9JhEhkmA4RgmDsu-On2hn5VEiw,2208
 muffin_rest/peewee/__init__.py,sha256=94DSj_ftT6fbPksHlBv40AH2HWaiZommUFOMN2jd9a4,129
 muffin_rest/peewee/filters.py,sha256=8CqleDEn4vVQvBLXEaGOjM2N7sY117EQ4GThPhlDPE8,2494
-muffin_rest/peewee/handler.py,sha256=MhRYQokaEt-NIrMdFiJLcZwp4h0A5LKCwHOb36vm5m0,5402
-muffin_rest/peewee/openapi.py,sha256=ktgsmB9wFNvcTbTaDkMQFLdQxk3osDFW5LkUSFVjcQo,1093
+muffin_rest/peewee/handler.py,sha256=xepN3ydOBbNbZBWkGJf4HqIXq-nXmu23JA2pGyHkHkw,5405
+muffin_rest/peewee/openapi.py,sha256=4E97_muocjBOTw0rL7lc1CRnQEg-vLI9H_Tu_vOuag0,1093
 muffin_rest/peewee/options.py,sha256=TimJtErC9e8B7BRiEkHiBZd71_bZbYr-FE2PIlQvfH0,1455
 muffin_rest/peewee/schemas.py,sha256=hQG2UKR7gEMsz0n75L3tvkVzUX3baXMJ94emgIc1Scw,439
 muffin_rest/peewee/sorting.py,sha256=aBtQkj3iSo6XjBZ8evJuprIkhv1nHFi7wFb0an6Dn34,1963
@@ -26,14 +26,14 @@ muffin_rest/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 muffin_rest/redoc.html,sha256=GtuHIMvTuSi8Ro6bgI-G8VB94AljMyfjcZseqtBmGCY,559
 muffin_rest/schemas.py,sha256=BW3dF82C6Q6STs4tZjej1x8Ii1rI3EZUJZR4mNNKmu4,875
 muffin_rest/sorting.py,sha256=nu4SGW5uxLETJIywE-1UTCCya9QAvYWcq-P8dPWQixI,2822
-muffin_rest/sqlalchemy/__init__.py,sha256=GMtnX3C5H9okEYjkaTHXd6Wna8F1Y6YAr1upT-cFOiM,6335
+muffin_rest/sqlalchemy/__init__.py,sha256=xeOJZ9apF9wc3jezgKW8m2FWpQk8JR1NJXrC7Pp9Duk,6341
 muffin_rest/sqlalchemy/filters.py,sha256=Lf1nPOQjDT7Nv1HAwowfWYTHWCrIMpw-4aWwoaNVlVU,2475
 muffin_rest/sqlalchemy/sorting.py,sha256=qmzP18ongriCGs2Ok_OllEybqWgppU-Kakg0JL1DM_M,1690
 muffin_rest/sqlalchemy/types.py,sha256=Exm-zAQCtPAwXvYcCTtPRqSa-wTEWRcH_v2YSsJkB6s,198
 muffin_rest/swagger.html,sha256=2uGLu_KpkYf925KnDKHBJmV9pm6OHn5C3BWScESsUS8,1736
 muffin_rest/types.py,sha256=5NY9gPTIptv6U2Qab2xMXlS_jZuTuR0bquFFwWRURcA,510
 muffin_rest/utils.py,sha256=c08E4HJ4SLYC-91GKPEbsyKTZ4sZbTN4qDqJbNg_HTE,2076
-muffin_rest-12.0.3.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
-muffin_rest-12.0.3.dist-info/METADATA,sha256=T3T6CJgnSSKsPNuRdmtGt5rOxG1X88KXopVorg7SldQ,4912
-muffin_rest-12.0.3.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-muffin_rest-12.0.3.dist-info/RECORD,,
+muffin_rest-13.0.1.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
+muffin_rest-13.0.1.dist-info/METADATA,sha256=314stUC6_wkJlpM9Ms8IJqiodDBH3eojfuQwq6mvH_8,4912
+muffin_rest-13.0.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+muffin_rest-13.0.1.dist-info/RECORD,,