muffin-rest 11.0.0__tar.gz → 11.0.3__tar.gz

muffin_rest-11.0.3/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.3
+Name: muffin-rest
+Version: 11.0.3
+Summary: The package provides enhanced support for writing REST APIs with Muffin framework
+License: MIT
+Keywords: rest,api,muffin,asgi,asyncio,trio
+Author: Kirill Klenov
+Author-email: horneds@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Provides-Extra: peewee
+Provides-Extra: sqlalchemy
+Provides-Extra: yaml
+Requires-Dist: apispec (>=6,<7)
+Requires-Dist: marshmallow (>=3,<4)
+Requires-Dist: marshmallow-peewee ; extra == "peewee"
+Requires-Dist: marshmallow-sqlalchemy ; extra == "sqlalchemy"
+Requires-Dist: muffin
+Requires-Dist: muffin-databases ; extra == "sqlalchemy"
+Requires-Dist: muffin-peewee-aio ; extra == "peewee"
+Requires-Dist: pyyaml ; extra == "yaml"
+Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
+Project-URL: Homepage, https://github.com/klen/muffin-rest
+Project-URL: Repository, https://github.com/klen/muffin-rest
+Description-Content-Type: text/markdown
+
+# Muffin‑REST
+
+**Muffin‑REST** simplifies building RESTful APIs with [Muffin](https://github.com/klen/muffin) by offering:
+
+- Declarative `API` class with resource registration
+- Built-in filtering, sorting, pagination, and search
+- Support for:
+  - [Peewee ORM](http://docs.peewee-orm.com/en/latest/) via `PeeweeEndpoint`
+  - [SQLAlchemy Core](https://docs.sqlalchemy.org/en/14/core/) via `SAEndpoint`
+  - [MongoDB](https://www.mongodb.com/) via `MongoEndpoint`
+- [Swagger/OpenAPI](https://swagger.io/) autodocumentation
+- Works with asyncio, Trio, and Curio
+
+[![Tests Status](https://github.com/klen/muffin-rest/workflows/tests/badge.svg)](https://github.com/klen/muffin-rest/actions)
+[![PyPI Version](https://img.shields.io/pypi/v/muffin-rest)](https://pypi.org/project/muffin-rest/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/muffin-rest)](https://pypi.org/project/muffin-rest/)
+
+## Requirements
+
+- Python >= 3.10
+- Trio requires Peewee backend
+
+## Installation
+
+Install core package:
+
+```bash
+pip install muffin-rest
+```
+
+Add optional backend support:
+
+- SQLAlchemy Core: `pip install muffin-rest[sqlalchemy]`
+- Peewee ORM: `pip install muffin-rest[peewee]`
+- YAML support for Swagger: `pip install muffin-rest[yaml]`
+
+## Quickstart (Peewee example)
+
+```python
+from muffin import Application
+from muffin_rest import API
+from muffin_rest.peewee import PeeweeEndpoint
+from models import User  # your Peewee model
+
+app = Application("myapp")
+api = API(title="User Service", version="1.0")
+
+@api.route
+class UsersEndpoint(PeeweeEndpoint):
+    class Meta:
+        model = User
+        lookup_field = "id"
+        filters = ["name", "email"]
+        ordering = ["-created_at"]
+
+api.setup(app, prefix="/api", swagger=True)
+```
+
+Endpoints available:
+
+- `GET    /api/users/` — list with pagination, search, filtering
+- `POST   /api/users/` — create
+- `GET    /api/users/{id}/` — retrieve
+- `PUT    /api/users/{id}/` — replace
+- `PATCH  /api/users/{id}/` — update
+- `DELETE /api/users/{id}/` — remove
+- Docs: `/api/docs/`, OpenAPI spec: `/api/openapi.json`
+
+## Usage with SQLAlchemy
+
+```python
+from muffin_rest import API
+from muffin_rest.sqlalchemy import SAEndpoint
+from models import my_table, db_engine
+
+api = API()
+@api.route
+class MySAEndpoint(SAEndpoint):
+    class Meta:
+        table = my_table
+        database = db_engine
+
+api.setup(app)
+```
+
+## Usage with MongoDB
+
+```python
+from muffin_rest import API
+from muffin_rest.mongo import MongoEndpoint
+from models import mongo_collection
+
+api = API()
+@api.route
+class MyMongoEndpoint(MongoEndpoint):
+    class Meta:
+        collection = mongo_collection
+
+api.setup(app)
+```
+
+## Advanced Configuration
+
+Customize Swagger and routes via constructor:
+
+```python
+api = API(
+    title="Service API",
+    version="2.1",
+    swagger_ui=True,
+    openapi_path="/api/openapi.json",
+    docs_path="/api/docs/"
+)
+```
+
+## Contributing & Examples
+
+- See `examples/` for live application demos
+- Tests in `tests/` focus on filtering, pagination, status codes
+- Check `CHANGELOG.md` for latest changes
+
+## Bug Tracker
+
+Report bugs or request features:
+https://github.com/klen/muffin-rest/issues
+
+## Contributing
+
+Repo: https://github.com/klen/muffin-rest
+Pull requests, example additions, docs improvements welcome!
+
+## Contributors
+
+- [klen](https://github.com/klen) (Kirill Klenov)
+
+## License
+
+Licensed under the [MIT license](http://opensource.org/licenses/MIT).
+

muffin_rest-11.0.3/README.md

@@ -0,0 +1,138 @@
+# Muffin‑REST
+
+**Muffin‑REST** simplifies building RESTful APIs with [Muffin](https://github.com/klen/muffin) by offering:
+
+- Declarative `API` class with resource registration
+- Built-in filtering, sorting, pagination, and search
+- Support for:
+  - [Peewee ORM](http://docs.peewee-orm.com/en/latest/) via `PeeweeEndpoint`
+  - [SQLAlchemy Core](https://docs.sqlalchemy.org/en/14/core/) via `SAEndpoint`
+  - [MongoDB](https://www.mongodb.com/) via `MongoEndpoint`
+- [Swagger/OpenAPI](https://swagger.io/) autodocumentation
+- Works with asyncio, Trio, and Curio
+
+[![Tests Status](https://github.com/klen/muffin-rest/workflows/tests/badge.svg)](https://github.com/klen/muffin-rest/actions)
+[![PyPI Version](https://img.shields.io/pypi/v/muffin-rest)](https://pypi.org/project/muffin-rest/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/muffin-rest)](https://pypi.org/project/muffin-rest/)
+
+## Requirements
+
+- Python >= 3.10
+- Trio requires Peewee backend
+
+## Installation
+
+Install core package:
+
+```bash
+pip install muffin-rest
+```
+
+Add optional backend support:
+
+- SQLAlchemy Core: `pip install muffin-rest[sqlalchemy]`
+- Peewee ORM: `pip install muffin-rest[peewee]`
+- YAML support for Swagger: `pip install muffin-rest[yaml]`
+
+## Quickstart (Peewee example)
+
+```python
+from muffin import Application
+from muffin_rest import API
+from muffin_rest.peewee import PeeweeEndpoint
+from models import User  # your Peewee model
+
+app = Application("myapp")
+api = API(title="User Service", version="1.0")
+
+@api.route
+class UsersEndpoint(PeeweeEndpoint):
+    class Meta:
+        model = User
+        lookup_field = "id"
+        filters = ["name", "email"]
+        ordering = ["-created_at"]
+
+api.setup(app, prefix="/api", swagger=True)
+```
+
+Endpoints available:
+
+- `GET    /api/users/` — list with pagination, search, filtering
+- `POST   /api/users/` — create
+- `GET    /api/users/{id}/` — retrieve
+- `PUT    /api/users/{id}/` — replace
+- `PATCH  /api/users/{id}/` — update
+- `DELETE /api/users/{id}/` — remove
+- Docs: `/api/docs/`, OpenAPI spec: `/api/openapi.json`
+
+## Usage with SQLAlchemy
+
+```python
+from muffin_rest import API
+from muffin_rest.sqlalchemy import SAEndpoint
+from models import my_table, db_engine
+
+api = API()
+@api.route
+class MySAEndpoint(SAEndpoint):
+    class Meta:
+        table = my_table
+        database = db_engine
+
+api.setup(app)
+```
+
+## Usage with MongoDB
+
+```python
+from muffin_rest import API
+from muffin_rest.mongo import MongoEndpoint
+from models import mongo_collection
+
+api = API()
+@api.route
+class MyMongoEndpoint(MongoEndpoint):
+    class Meta:
+        collection = mongo_collection
+
+api.setup(app)
+```
+
+## Advanced Configuration
+
+Customize Swagger and routes via constructor:
+
+```python
+api = API(
+    title="Service API",
+    version="2.1",
+    swagger_ui=True,
+    openapi_path="/api/openapi.json",
+    docs_path="/api/docs/"
+)
+```
+
+## Contributing & Examples
+
+- See `examples/` for live application demos
+- Tests in `tests/` focus on filtering, pagination, status codes
+- Check `CHANGELOG.md` for latest changes
+
+## Bug Tracker
+
+Report bugs or request features:
+https://github.com/klen/muffin-rest/issues
+
+## Contributing
+
+Repo: https://github.com/klen/muffin-rest
+Pull requests, example additions, docs improvements welcome!
+
+## Contributors
+
+- [klen](https://github.com/klen) (Kirill Klenov)
+
+## License
+
+Licensed under the [MIT license](http://opensource.org/licenses/MIT).

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/filters.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import operator
-from typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterable, Mapping, Optional  # py39
+from typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterable, Mapping
 
 import marshmallow as ma
 from asgi_tools._compat import json_loads
@@ -59,8 +59,8 @@ class Filter(Mutate):
         name: str,
         *,
         field: Any = None,
-        schema_field: Optional[ma.fields.Field] = None,
-        operator: Optional[str] = None,
+        schema_field: ma.fields.Field | None = None,
+        operator: str | None = None,
         **meta,
     ):
         """Initialize filter.
@@ -75,7 +75,7 @@ class Filter(Mutate):
         self.schema_field = schema_field or self.schema_field
         self.default_operator = operator or self.default_operator
 
-    async def apply(self, collection: Any, data: Optional[Mapping] = None):
+    async def apply(self, collection: Any, data: Mapping | None = None):
         """Filter given collection."""
         if not data:
             return None, collection

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/handler.py

@@ -39,7 +39,7 @@ class RESTHandlerMeta(HandlerMeta):
 
     def __new__(mcs, name, bases, params):
         """Prepare options for the handler."""
-        kls = cast(type["RESTBase"], super().__new__(mcs, name, bases, params))
+        kls = cast("type[RESTBase]", super().__new__(mcs, name, bases, params))
         kls.meta = kls.meta_class(kls)
 
         if getattr(kls.meta, kls.meta_class.base_property, None) is not None:
@@ -237,8 +237,10 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
     ) -> TVData[TVResource]:
         """Load data from request and create/update a resource."""
         schema = self.get_schema(request, resource=resource, **schema_options)
-        data = cast(Union[Mapping, list], await self.load_data(request))
-        return cast(TVData[TVResource], await load_data(data, schema, partial=resource is not None))
+        data = cast("Union[Mapping, list]", await self.load_data(request))
+        return cast(
+            "TVData[TVResource]", await load_data(data, schema, partial=resource is not None)
+        )
 
     @overload
     async def dump(  # type: ignore[misc]
@@ -269,7 +271,7 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
             if resource
             else self.dump(request, data=self.collection, many=True)
         )
-        return ResponseJSON(res)
+        return ResponseJSON(res)  # type: ignore[type-var]
 
     async def post(
         self, request: Request, *, resource: Optional[TVResource] = None
@@ -283,7 +285,7 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
         if many:
             data = await self.save_many(request, data, update=resource is not None)
         else:
-            data = await self.save(request, cast(TVResource, data), update=resource is not None)
+            data = await self.save(request, cast("TVResource", data), update=resource is not None)
 
         res = await self.dump(request, data, many=many)
         return ResponseJSON(res)

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/mongo/__init__.py

@@ -1,4 +1,5 @@
 """Mongo DB support."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Optional, cast
@@ -68,7 +69,7 @@ class MongoRESTHandler(RESTHandler[TVResource]):
             counts = list(self.collection.aggregate(pipeline_num))
             return (
                 self.collection.aggregate(pipeline_all),
-                counts and counts[0]["total"] or 0,  # type: ignore[]
+                (counts and counts[0]["total"]) or 0,  # type: ignore[]
             )
         total = None
         if self.meta.limit_total:
@@ -118,7 +119,9 @@ class MongoRESTHandler(RESTHandler[TVResource]):
     async def delete(self, request: Request, resource: Optional[TVResource] = None):
         """Remove the given resource(s)."""
         meta = self.meta
-        oids = [resource[meta.collection_id]] if resource else cast(list[str], await request.data())
+        oids = (
+            [resource[meta.collection_id]] if resource else cast("list[str]", await request.data())
+        )
         if not oids:
             raise APIError.NOT_FOUND()
 

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/mongo/utils.py

@@ -73,12 +73,12 @@ class MongoChain:
     ) -> Awaitable:
         """Apply filters and return cursor."""
         query = self.__update__(query)
-        query = query and {"$and": query} or {}
+        query = (query and {"$and": query}) or {}
         return self.collection.find_one(query, projection=projection)
 
     def count(self) -> Awaitable[int]:
         """Count documents."""
-        query = self.query and {"$and": self.query} or {}
+        query = (self.query and {"$and": self.query}) or {}
         return self.collection.count_documents(query)
 
     def aggregate(self, pipeline, **kwargs):
@@ -121,7 +121,7 @@ class MongoChain:
 
     def __iter__(self):
         """Iterate by self collection."""
-        query = self.query and {"$and": self.query} or {}
+        query = (self.query and {"$and": self.query}) or {}
         if self.sorting:
             return self.collection.find(query, self.projection).sort(self.sorting)
 
@@ -130,7 +130,7 @@ class MongoChain:
     def __getattr__(self, name):
         """Proxy any attributes except find to self.collection."""
         if name in self.CURSOR_METHODS:
-            query = self.query and {"$and": self.query} or {}
+            query = (self.query and {"$and": self.query}) or {}
             cursor = self.collection.find(query, self.projection)
             if self.sorting:
                 cursor = cursor.sort(self.sorting)

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/openapi.py

@@ -1,4 +1,5 @@
 """Create openapi schema from the given API."""
+
 from __future__ import annotations
 
 import inspect
@@ -88,7 +89,7 @@ def route_to_spec(route: Route, spec: APISpec, tags: dict) -> dict:
         for param in route.params:
             results["parameters"].append({"in": "path", "name": param})
 
-    target = cast(Callable, route.target)
+    target = cast("Callable", route.target)
     if isinstance(target, partial):
         target = target.func
 

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/peewee/filters.py

@@ -15,6 +15,8 @@ from .utils import get_model_field_by_name
 if TYPE_CHECKING:
     from muffin_rest.types import TFilterValue
 
+    from . import PWRESTHandler
+
 
 class PWFilter(Filter):
     """Support Peewee."""
@@ -41,7 +43,9 @@ class PWFilter(Filter):
         """Apply the filters to Peewee QuerySet.."""
         column = self.field
         if isinstance(column, ColumnBase):
-            collection = cast(ModelSelect, collection.where(*[op(column, val) for op, val in ops]))
+            collection = cast(
+                "ModelSelect", collection.where(*[op(column, val) for op, val in ops])
+            )
         return collection
 
 
@@ -52,9 +56,8 @@ class PWFilters(Filters):
 
     def convert(self, obj: Union[str, Field, PWFilter], **meta):
         """Convert params to filters."""
-        from . import PWRESTHandler
 
-        handler = cast(PWRESTHandler, self.handler)
+        handler = cast("PWRESTHandler", self.handler)
         if isinstance(obj, PWFilter):
             return obj
 

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/peewee/handler.py

@@ -5,7 +5,6 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any, Optional, Union, cast, overload
 
 import marshmallow as ma
-import peewee as pw
 from apispec.ext.marshmallow import MarshmallowPlugin
 from marshmallow_peewee import ForeignKey
 from peewee_aio.model import AIOModel, AIOModelSelect
@@ -19,6 +18,7 @@ from .schemas import EnumField
 from .types import TVModel
 
 if TYPE_CHECKING:
+    import peewee as pw
     from muffin import Request
     from peewee_aio.types import TVAIOModel
 
@@ -52,7 +52,7 @@ class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):
     ) -> pw.ModelSelect: ...
 
     # NOTE: there is not a default sorting for peewee (conflict with muffin-admin)
-    async def prepare_collection(self, _: Request):
+    async def prepare_collection(self, _: Request):  # type: ignore[override]
         """Initialize Peeewee QuerySet for a binded to the resource model."""
         return self.meta.model.select()
 
@@ -86,10 +86,10 @@ class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):
         self: PWRESTBase[pw.Model], _: Request, *, limit: int = 0, offset: int = 0
     ) -> tuple[pw.ModelSelect, int | None]: ...
 
-    async def paginate(self, _: Request, *, limit: int = 0, offset: int = 0):
+    async def paginate(self, _: Request, *, limit: int = 0, offset: int = 0):  # type: ignore[override]
         """Paginate the collection."""
         if self.meta.limit_total:
-            cqs = cast(pw.ModelSelect, self.collection.order_by())
+            cqs = cast("pw.ModelSelect", self.collection.order_by())
             if cqs._group_by:  # type: ignore[misc]
                 cqs._returning = cqs._group_by  # type: ignore[misc]
                 cqs._having = None  # type: ignore[misc]
@@ -114,9 +114,9 @@ class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):
         meta = self.meta
         manager = meta.manager
         if issubclass(meta.model, AIOModel):
-            await resource.save()
+            await resource.save(force_insert=not update)
         else:
-            await manager.save(resource)
+            await manager.save(resource, force_insert=not update)
 
         return resource
 
@@ -131,7 +131,7 @@ class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):
             if not data:
                 return
 
-            model_pk = cast(pw.Field, meta.model_pk)
+            model_pk = cast("pw.Field", meta.model_pk)
             resources = await meta.manager.fetchall(self.collection.where(model_pk << data))  # type: ignore[]
 
         if not resources:

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/peewee/schemas.py

@@ -13,5 +13,3 @@ def build_field(field, opts, **params):
 
 
 DefaultConverter.register(URLField, ma.fields.Url)
-
-# ruff: noqa: ARG001, ARG002

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/peewee/sorting.py

@@ -11,6 +11,7 @@ from muffin_rest.sorting import Sort, Sorting
 from .utils import get_model_field_by_name
 
 if TYPE_CHECKING:
+    from . import PWRESTHandler
     from .types import TVCollection
 
 
@@ -36,12 +37,11 @@ class PWSorting(Sorting):
 
     def convert(self, obj: Union[str, Field, PWSort], **meta):
         """Prepare sorters."""
-        from . import PWRESTHandler
 
         if isinstance(obj, PWSort):
             return obj
 
-        handler = cast(PWRESTHandler, self.handler)
+        handler = cast("PWRESTHandler", self.handler)
 
         if isinstance(obj, Field):
             name, field = obj.name, obj

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/sorting.py

@@ -1,15 +1,16 @@
 """Implement sorting."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Generator, Iterable, Mapping, Sequence, cast
 
-from .types import TVCollection
 from .utils import Mutate, Mutator
 
 if TYPE_CHECKING:
     from muffin import Request
 
     from .handler import RESTBase
+    from .types import TVCollection
 
 SORT_PARAM = "sort"
 
@@ -60,14 +61,14 @@ class Sorting(Mutator):
 
     def convert(self, obj, **meta) -> Sort:
         """Prepare sorters."""
-        sort = cast(Sort, super(Sorting, self).convert(obj, **meta))
+        sort = cast("Sort", super(Sorting, self).convert(obj, **meta))
         if sort.meta.get("default"):
             self.default.append(sort)
         return sort
 
     def sort_default(self, collection: TVCollection) -> TVCollection:
         """Sort by default."""
-        return cast(TVCollection, sorted(collection))
+        return cast("TVCollection", sorted(collection))
 
     @property
     def openapi(self):

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/sqlalchemy/__init__.py

@@ -22,7 +22,7 @@ if TYPE_CHECKING:
 
 from .types import TVResource
 
-ModelConverter._get_field_name = lambda _, prop_or_column: str(prop_or_column.key)  # type: ignore[method-assign]
+ModelConverter._get_field_name = lambda _, prop_or_column: str(prop_or_column.key)  # type: ignore[assignment]
 
 
 class SQLAlchemyAutoSchema(BaseSQLAlchemyAutoSchema):
@@ -152,7 +152,7 @@ class SARESTHandler(RESTHandler[TVResource]):
         resource = await self.meta.database.fetch_one(qs)
         if resource is None:
             raise APIError.NOT_FOUND("Resource not found")
-        return cast(TVResource, dict(resource))
+        return cast("TVResource", dict(resource))
 
     def get_schema(
         self, request: Request, *, resource: Optional[TVResource] = None, **schema_options
@@ -164,7 +164,7 @@ class SARESTHandler(RESTHandler[TVResource]):
         """Save the given resource."""
         meta = self.meta
         insert_query = meta.table.insert()
-        table_pk = cast(sa.Column, meta.table_pk)
+        table_pk = cast("sa.Column", meta.table_pk)
         if update:
             update_query = self.meta.table.update().where(table_pk == resource[table_pk.name])  # type: ignore[call-overload]
             await meta.database.execute(update_query, resource)
@@ -176,12 +176,12 @@ class SARESTHandler(RESTHandler[TVResource]):
 
     async def remove(self, request: Request, resource: Optional[TVResource] = None):
         """Remove the given resource."""
-        table_pk = cast(sa.Column, self.meta.table_pk)
+        table_pk = cast("sa.Column", self.meta.table_pk)
         pks = [resource[table_pk.name]] if resource else await request.data()
         if not pks:
             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]", pks)))
         await self.meta.database.execute(delete)
 
     delete = remove

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/sqlalchemy/filters.py

@@ -11,6 +11,7 @@ from muffin_rest.filters import Filter, Filters
 if TYPE_CHECKING:
     from muffin_rest.types import TFilterValue
 
+    from . import SARESTHandler
     from .types import TVCollection
 
 
@@ -51,9 +52,8 @@ class SAFilters(Filters):
 
     def convert(self, obj: Union[str, Column, SAFilter], **meta):
         """Convert params to filters."""
-        from . import SARESTHandler
 
-        handler = cast(SARESTHandler, self.handler)
+        handler = cast("SARESTHandler", self.handler)
 
         if isinstance(obj, SAFilter):
             if obj.field is None:

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/sqlalchemy/sorting.py

@@ -1,4 +1,5 @@
 """Support sorting for SQLAlchemy ORM."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Union, cast
@@ -8,6 +9,7 @@ from sqlalchemy import Column
 from muffin_rest.sorting import Sort, Sorting
 
 if TYPE_CHECKING:
+    from . import SARESTHandler
     from .types import TVCollection
 
 
@@ -15,7 +17,11 @@ class SASort(Sort):
     """Sorter for Peewee."""
 
     async def apply(
-        self, collection: TVCollection, *, desc: bool = False, **_,
+        self,
+        collection: TVCollection,
+        *,
+        desc: bool = False,
+        **_,
     ) -> TVCollection:
         """Sort the collection."""
         field = self.field
@@ -32,19 +38,18 @@ class SASorting(Sorting):
 
     def convert(self, obj: Union[str, Column, SASort], **meta):
         """Prepare sorters."""
-        from . import SARESTHandler
 
         if isinstance(obj, SASort):
             return obj
 
-        handler = cast(SARESTHandler, self.handler)
+        handler = cast("SARESTHandler", self.handler)
 
         if isinstance(obj, Column):
             name, field = obj.name, obj
 
         else:
             name = obj
-            field = meta.get("field", handler.meta.table.c.get(name))
+            field = meta.get("field", handler.meta.table.c.get(name))  # type: ignore[assignment]
 
         if field is not None:
             sort = self.MUTATE_CLASS(name, field=field, **meta)

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/pyproject.toml

@@ -1,8 +1,8 @@
 [tool.poetry]
 name = "muffin-rest"
-version = "11.0.0"
+version = "11.0.3"
 description = "The package provides enhanced support for writing REST APIs with Muffin framework"
-readme = "README.rst"
+readme = "README.md"
 homepage = "https://github.com/klen/muffin-rest"
 repository = "https://github.com/klen/muffin-rest"
 authors = ["Kirill Klenov <horneds@gmail.com>"]
@@ -14,7 +14,6 @@ classifiers = [
   "License :: OSI Approved :: MIT License",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
@@ -25,10 +24,10 @@ classifiers = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 apispec = "^6"
 marshmallow = "^3"
-muffin = "^0"
+muffin = "*"
 
 # Optional dependencies
 pyyaml = { version = "*", optional = true }
@@ -78,7 +77,7 @@ ignore_missing_imports = true
 [tool.tox]
 legacy_tox_ini = """
 [tox]
-envlist = py310,py311,py312,py313,pypy39
+envlist = py310,py311,py312,py313,pypy310
 
 [testenv]
 deps = -e .[tests]
@@ -101,9 +100,10 @@ ignore = [
   "D",
   "DJ",
   "EM",
-  "FIX",
   "FA100",
+  "FIX",
   "N804",
+  "PLC0415",
   "PLR0912",
   "PLR2004",
   "RET",

muffin_rest-11.0.0/PKG-INFO

@@ -1,182 +0,0 @@
-Metadata-Version: 2.3
-Name: muffin-rest
-Version: 11.0.0
-Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-License: MIT
-Keywords: rest,api,muffin,asgi,asyncio,trio
-Author: Kirill Klenov
-Author-email: horneds@gmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Internet :: WWW/HTTP
-Provides-Extra: peewee
-Provides-Extra: sqlalchemy
-Provides-Extra: yaml
-Requires-Dist: apispec (>=6,<7)
-Requires-Dist: marshmallow (>=3,<4)
-Requires-Dist: marshmallow-peewee ; extra == "peewee"
-Requires-Dist: marshmallow-sqlalchemy ; extra == "sqlalchemy"
-Requires-Dist: muffin (>=0,<1)
-Requires-Dist: muffin-databases ; extra == "sqlalchemy"
-Requires-Dist: muffin-peewee-aio ; extra == "peewee"
-Requires-Dist: pyyaml ; extra == "yaml"
-Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
-Project-URL: Homepage, https://github.com/klen/muffin-rest
-Project-URL: Repository, https://github.com/klen/muffin-rest
-Description-Content-Type: text/x-rst
-
-Muffin-REST
-###########
-
-.. _description:
-
-**Muffin-REST** -- provides enhanced support for writing REST APIs with Muffin_.
-
-
-.. _badges:
-
-.. image:: https://github.com/klen/muffin-rest/workflows/tests/badge.svg
-    :target: https://github.com/klen/muffin-rest/actions
-    :alt: Tests Status
-
-.. image:: https://img.shields.io/pypi/v/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: PYPI Version
-
-.. image:: https://img.shields.io/pypi/pyversions/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: Python Versions
-
-----------
-
-.. _features:
-
-Features
---------
-
-- API class to simplify the creation of REST APIs;
-- Automatic filtering and sorting for resources;
-- Support for `Peewee ORM`_, Mongo_, `SQLAlchemy Core`_;
-- Auto documentation with Swagger_;
-
-.. _contents:
-
-.. contents::
-
-.. _requirements:
-
-Requirements
-=============
-
-- python >= 3.9
-
-.. note:: Trio is only supported with Peewee ORM
-
-.. _installation:
-
-Installation
-=============
-
-**Muffin-REST** should be installed using pip: ::
-
-    pip install muffin-rest
-
-With `SQLAlchemy Core`_ support: ::
-
-    pip install muffin-rest[sqlalchemy]
-
-With `Peewee ORM`_ support: ::
-
-    pip install muffin-rest[peewee]
-
-With YAML support for autodocumentation: ::
-
-    pip install muffin-rest[yaml]
-
-.. _usage:
-
-Usage
-=====
-
-Create an API:
-
-.. code-block:: python
-
-   from muffin_rest import API
-
-   api = API()
-
-Create endpoints and connect them to the API (example for sqlalchemy):
-
-.. code-block:: python
-
-   from muffin_rest.sqlalchemy import SAEndpoint
-   from project.api import api
-
-   @api.route
-   class MyEndpoint(SAEndpoint):
-
-        class Meta:
-            table = MyTable
-            database = db
-
-Connect it to your Muffin_ application:
-
-.. code-block:: python
-
-   from project.api import api
-
-   api.setup(app, prefix='/api/v1')
-
-
-.. _bugtracker:
-
-Bug tracker
-===========
-
-If you have any suggestions, bug reports or
-annoyances please report them to the issue tracker
-at https://github.com/klen/muffin-rest/issues
-
-.. _contributing:
-
-Contributing
-============
-
-Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
-
-
-Contributors
-=============
-
-* klen_ (Kirill Klenov)
-
-.. _license:
-
-License
-========
-
-Licensed under a `MIT license`_.
-
-.. _links:
-
-.. _klen: https://github.com/klen
-.. _Muffin: https://github.com/klen/muffin
-.. _Swagger: https://swagger.io/tools/swagger-ui/
-.. _Mongo: https://www.mongodb.com/
-.. _Peewee ORM: http://docs.peewee-orm.com/en/latest/
-.. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
-
-.. _MIT license: http://opensource.org/licenses/MIT
-

muffin_rest-11.0.0/README.rst

@@ -1,143 +0,0 @@
-Muffin-REST
-###########
-
-.. _description:
-
-**Muffin-REST** -- provides enhanced support for writing REST APIs with Muffin_.
-
-
-.. _badges:
-
-.. image:: https://github.com/klen/muffin-rest/workflows/tests/badge.svg
-    :target: https://github.com/klen/muffin-rest/actions
-    :alt: Tests Status
-
-.. image:: https://img.shields.io/pypi/v/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: PYPI Version
-
-.. image:: https://img.shields.io/pypi/pyversions/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: Python Versions
-
-----------
-
-.. _features:
-
-Features
---------
-
-- API class to simplify the creation of REST APIs;
-- Automatic filtering and sorting for resources;
-- Support for `Peewee ORM`_, Mongo_, `SQLAlchemy Core`_;
-- Auto documentation with Swagger_;
-
-.. _contents:
-
-.. contents::
-
-.. _requirements:
-
-Requirements
-=============
-
-- python >= 3.9
-
-.. note:: Trio is only supported with Peewee ORM
-
-.. _installation:
-
-Installation
-=============
-
-**Muffin-REST** should be installed using pip: ::
-
-    pip install muffin-rest
-
-With `SQLAlchemy Core`_ support: ::
-
-    pip install muffin-rest[sqlalchemy]
-
-With `Peewee ORM`_ support: ::
-
-    pip install muffin-rest[peewee]
-
-With YAML support for autodocumentation: ::
-
-    pip install muffin-rest[yaml]
-
-.. _usage:
-
-Usage
-=====
-
-Create an API:
-
-.. code-block:: python
-
-   from muffin_rest import API
-
-   api = API()
-
-Create endpoints and connect them to the API (example for sqlalchemy):
-
-.. code-block:: python
-
-   from muffin_rest.sqlalchemy import SAEndpoint
-   from project.api import api
-
-   @api.route
-   class MyEndpoint(SAEndpoint):
-
-        class Meta:
-            table = MyTable
-            database = db
-
-Connect it to your Muffin_ application:
-
-.. code-block:: python
-
-   from project.api import api
-
-   api.setup(app, prefix='/api/v1')
-
-
-.. _bugtracker:
-
-Bug tracker
-===========
-
-If you have any suggestions, bug reports or
-annoyances please report them to the issue tracker
-at https://github.com/klen/muffin-rest/issues
-
-.. _contributing:
-
-Contributing
-============
-
-Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
-
-
-Contributors
-=============
-
-* klen_ (Kirill Klenov)
-
-.. _license:
-
-License
-========
-
-Licensed under a `MIT license`_.
-
-.. _links:
-
-.. _klen: https://github.com/klen
-.. _Muffin: https://github.com/klen/muffin
-.. _Swagger: https://swagger.io/tools/swagger-ui/
-.. _Mongo: https://www.mongodb.com/
-.. _Peewee ORM: http://docs.peewee-orm.com/en/latest/
-.. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
-
-.. _MIT license: http://opensource.org/licenses/MIT

{muffin_rest-11.0.0 → muffin_rest-11.0.3}/muffin_rest/__init__.py

@@ -17,24 +17,24 @@ Api = API
 
 __all__ = (
     "API",
-    "Api",
-    "RESTHandler",
     "APIError",
-    "PWRESTHandler",
+    "Api",
+    "MongoFilter",
+    "MongoFilters",
+    "MongoRESTHandler",
+    "MongoSort",
+    "MongoSorting",
     "PWFilter",
     "PWFilters",
+    "PWRESTHandler",
     "PWSort",
     "PWSorting",
-    "SARESTHandler",
+    "RESTHandler",
     "SAFilter",
     "SAFilters",
+    "SARESTHandler",
     "SASort",
     "SASorting",
-    "MongoRESTHandler",
-    "MongoFilter",
-    "MongoFilters",
-    "MongoSort",
-    "MongoSorting",
 )
 
 # Support Peewee ORM