muffin-rest 4.4.3__py3-none-any.whl → 4.5.1__py3-none-any.whl

muffin_rest/openapi.py

@@ -4,8 +4,7 @@ import re
 from contextlib import suppress
 from functools import partial
 from http import HTTPStatus
-from types import ModuleType
-from typing import Callable, Dict, List, Optional, Tuple, cast
+from typing import Callable, Dict, List, Tuple, cast
 
 from apispec import utils
 from apispec.core import APISpec
@@ -18,11 +17,11 @@ from muffin import Response
 from . import LIMIT_PARAM, OFFSET_PARAM, openapi
 from .options import RESTOptions
 
-yaml_utils: Optional[ModuleType] = None
-
 with suppress(ImportError):
     from apispec import yaml_utils
 
+locals().setdefault("yaml_utils", None)
+
 
 DEFAULT_METHODS = ("get",)
 HTTP_METHODS = [
@@ -45,7 +44,8 @@ def render_openapi(api, request):
     # Setup Specs
     options = dict(api.openapi_options)
     options.setdefault(
-        "servers", [{"url": str(request.url.with_query("").with_path(api.prefix))}],
+        "servers",
+        [{"url": str(request.url.with_query("").with_path(api.prefix))}],
     )
 
     spec = APISpec(
@@ -163,7 +163,6 @@ def return_type_to_response(fn: Callable) -> Dict:
         and issubclass(return_type, Response)
         and return_type.content_type
     ):
-
         responses[return_type.status_code] = {
             "description": HTTPStatus(return_type.status_code).description,
             "content": {return_type.content_type: {}},

muffin_rest/peewee/__init__.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Optional, Tuple, Type, TypeVar, cast, overload
+from typing import TYPE_CHECKING, Optional, Tuple, Type, cast, overload
 
+import marshmallow as ma
 import peewee as pw
 from apispec.ext.marshmallow import MarshmallowPlugin
 from marshmallow_peewee import ForeignKey
@@ -14,16 +15,17 @@ from muffin_rest.handler import RESTBase
 from muffin_rest.peewee.openapi import PeeweeOpenAPIMixin
 
 from .options import PWRESTOptions
+from .schemas import EnumField
+from .types import TVModel
 
 if TYPE_CHECKING:
-    import marshmallow as ma
     from asgi_tools.types import TJSON
     from muffin import Request
 
 # XXX: Patch apispec.MarshmallowPlugin to support ForeignKeyField
 MarshmallowPlugin.Converter.field_mapping[ForeignKey] = ("integer", None)
 
-TVModel = TypeVar("TVModel", bound=pw.Model)
+assert issubclass(EnumField, ma.fields.Field)  # just register EnumField
 
 
 class PWRESTBase(RESTBase[TVModel], PeeweeOpenAPIMixin):

muffin_rest/peewee/schemas.py

@@ -0,0 +1,36 @@
+import marshmallow as ma
+from marshmallow_peewee import DefaultConverter
+from muffin_peewee.fields import IntEnumField, StrEnumField
+
+
+class EnumField(ma.fields.Field):
+    default_error_messages = {
+        "unknown": "Must be one of: {choices}.",
+    }
+
+    def __init__(self, enum, **kwargs):
+        self.enum = enum
+        self.choices_text = ", ".join([str(c.value) for c in enum])
+        super().__init__(**kwargs)
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        if value is None:
+            return None
+
+        return value.value
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        try:
+            return self.enum(value)
+        except ValueError as error:
+            raise self.make_error("unknown", choices=self.choices_text) from error
+
+
+@DefaultConverter.register(StrEnumField)
+@DefaultConverter.register(IntEnumField)
+def build_field(field, opts, **params):
+    params.pop("validate", None)
+    return EnumField(field.enum, **params)
+
+
+# ruff: noqa: ARG001, ARG002

muffin_rest/peewee/types.py

@@ -1,5 +1,6 @@
 from typing import TypeVar
 
-from peewee import Query
+from peewee import Model, Query
 
+TVModel = TypeVar("TVModel", bound=Model)
 TVCollection = TypeVar("TVCollection", bound=Query)

{muffin_rest-4.4.3.dist-info → muffin_rest-4.5.1.dist-info}/METADATA

@@ -1,14 +1,16 @@
 Metadata-Version: 2.1
 Name: muffin-rest
-Version: 4.4.3
+Version: 4.5.1
 Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-Author-email: Kirill Klenov <horneds@gmail.com>
-License: MIT License
-Project-URL: homepage, https://github.com/klen/muffin-rest
-Project-URL: repository, https://github.com/klen/muffin-rest
-Project-URL: changelog, https://raw.githubusercontent.com/klen/muffin-rest/master/CHANGELOG.md
+Home-page: https://github.com/klen/muffin-rest
+License: MIT
 Keywords: rest,api,muffin,asgi,asyncio,trio
+Author: Kirill Klenov
+Author-email: horneds@gmail.com
+Requires-Python: >=3.8,<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
@@ -17,46 +19,26 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-Requires-Dist: apispec (>=4)
-Requires-Dist: marshmallow (>=3.14)
-Requires-Dist: muffin (>=0.92)
-Provides-Extra: dev
-Requires-Dist: pre-commit ; extra == 'dev'
-Requires-Dist: refurb ; extra == 'dev'
-Requires-Dist: bump2version ; extra == 'dev'
-Provides-Extra: example
-Requires-Dist: uvicorn ; extra == 'example'
-Requires-Dist: muffin-peewee-aio ; extra == 'example'
-Requires-Dist: marshmallow-peewee ; extra == 'example'
 Provides-Extra: peewee
-Requires-Dist: muffin-peewee-aio (>=0.2.2) ; extra == 'peewee'
-Requires-Dist: marshmallow-peewee (>=3.2.0) ; extra == 'peewee'
 Provides-Extra: sqlalchemy
-Requires-Dist: muffin-databases (>=0.3.2) ; extra == 'sqlalchemy'
-Requires-Dist: marshmallow-sqlalchemy ; extra == 'sqlalchemy'
-Requires-Dist: sqlalchemy ; extra == 'sqlalchemy'
-Provides-Extra: tests
-Requires-Dist: aiosqlite ; extra == 'tests'
-Requires-Dist: marshmallow-peewee (>=3.2.0) ; extra == 'tests'
-Requires-Dist: marshmallow-sqlalchemy (>=0.27.0) ; extra == 'tests'
-Requires-Dist: muffin-databases (>=0.3.2) ; extra == 'tests'
-Requires-Dist: muffin-mongo (>=0.3.1) ; extra == 'tests'
-Requires-Dist: muffin-peewee-aio ; extra == 'tests'
-Requires-Dist: pytest ; extra == 'tests'
-Requires-Dist: pytest-aio[curio,trio] ; extra == 'tests'
-Requires-Dist: pytest-mypy ; extra == 'tests'
-Requires-Dist: pyyaml ; extra == 'tests'
-Requires-Dist: types-PyYAML ; extra == 'tests'
-Requires-Dist: types-ujson ; extra == 'tests'
-Requires-Dist: ruff ; extra == 'tests'
 Provides-Extra: yaml
-Requires-Dist: pyyaml ; extra == 'yaml'
+Requires-Dist: apispec (>=4,<5)
+Requires-Dist: marshmallow (>=3.14,<4.0)
+Requires-Dist: marshmallow-peewee (>=4,<5) ; extra == "peewee"
+Requires-Dist: marshmallow-sqlalchemy (>=0.27.0,<0.28.0) ; extra == "sqlalchemy"
+Requires-Dist: muffin (>=0.94,<0.95)
+Requires-Dist: muffin-databases (>=0.5.0,<0.6.0) ; extra == "sqlalchemy"
+Requires-Dist: muffin-peewee-aio (>=0.9.6,<0.10.0) ; extra == "peewee"
+Requires-Dist: pyyaml ; extra == "yaml"
+Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
+Project-URL: Repository, https://github.com/klen/muffin-rest
+Description-Content-Type: text/x-rst
 
 Muffin-REST
 ###########
@@ -201,3 +183,4 @@ Licensed under a `MIT license`_.
 .. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
 
 .. _MIT license: http://opensource.org/licenses/MIT
+

{muffin_rest-4.4.3.dist-info → muffin_rest-4.5.1.dist-info}/RECORD

@@ -3,32 +3,32 @@ muffin_rest/api.py,sha256=vGHBQM9JfnAX-9YCyZA7JEAnWiR1iukSS_DRfc5s0fw,3707
 muffin_rest/errors.py,sha256=sFiXZCEjCvgfuE28GM7_B5iOWGSucCKnGM6ta1efBpY,1168
 muffin_rest/filters.py,sha256=-Tea863cPCAuwzGkBu45W2AeTtOw2QNdANb_NN7cpjc,4951
 muffin_rest/handler.py,sha256=Tmp6xRvVl19P3yBf6UR0RPbq8pPIZQjOrjYwjOobWzY,10098
-muffin_rest/openapi.py,sha256=LFzrw8uiiYmA-x9xf3FZdmZUQ6kgEuYcfdyPA87j8dc,8825
-muffin_rest/options.py,sha256=PcrGY1qq3exgOdeJp8tYYC2V83c5vVMQrARgUkxrNTM,1927
-muffin_rest/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-muffin_rest/redoc.html,sha256=GtuHIMvTuSi8Ro6bgI-G8VB94AljMyfjcZseqtBmGCY,559
-muffin_rest/sorting.py,sha256=cAFbeIyIGm9-aojrEVZtsppBktg6mOGmiUzLHzKHQhQ,2438
-muffin_rest/swagger.html,sha256=FGTD5pU9ZUNmlaaVZ1TSajNHvoZ9IiNhJ5yw6Yk_Kz4,4058
-muffin_rest/types.py,sha256=HvPwnmZomUFy4jW5IGHSvzYDZjaLY0kMt_unBfynq2g,388
-muffin_rest/utils.py,sha256=hAxgIvzf7uCGRhOv0pf-oFxdreBYxp0zpLa7DPILQHY,2036
 muffin_rest/mongo/__init__.py,sha256=aXD4yxY1pMmmGOFLyzzGdQc-ONJESU76JGMNu_WFzDg,4792
 muffin_rest/mongo/filters.py,sha256=y2FleM_BqkICKGq3PmM_StOgKlE7RoSxt2NdQfCvnOE,921
 muffin_rest/mongo/schema.py,sha256=y4OEPQnlV_COTIIQ3cKmpqDpD2r18eAWn0rijQldWm0,1205
 muffin_rest/mongo/sorting.py,sha256=iJBnaFwE7g_JMwpGpQkoqSqbQK9XULx1K3skiRRgLgY,870
 muffin_rest/mongo/types.py,sha256=Otqu_FyIVnDAUGcwtzY_B77CKNBYApQPO_LlS2aLAQk,206
 muffin_rest/mongo/utils.py,sha256=RZdAiKaTsgaFz8WbIPI_sjjVDsF_VmPu5Agzp5mpbvY,3946
-muffin_rest/peewee/__init__.py,sha256=l2R_Y9e5X4gC4T9WzPcNJ2Zb8a-LLkWFu_8AF7ZWkBk,5118
+muffin_rest/openapi.py,sha256=b5lq5H1-YMpp6XW6CyttRSApnxEx_QKESSYFhK0Hb4I,8793
+muffin_rest/options.py,sha256=PcrGY1qq3exgOdeJp8tYYC2V83c5vVMQrARgUkxrNTM,1927
+muffin_rest/peewee/__init__.py,sha256=XtKm5fY-6lPWqIhO-WbagtbM7ih7aSzoXY7cwT3ZJOU,5191
 muffin_rest/peewee/filters.py,sha256=p-BGAKhkoreJfXMeJghIwcWNK0rjv3TkUcMbIFouwP8,2923
 muffin_rest/peewee/openapi.py,sha256=ZZuh7nJVuK9cTJqtOJ_XASe9iJgter-xIjj9YJ8xszI,1111
 muffin_rest/peewee/options.py,sha256=RXbuKzlr-MVTx6uyIM1paGdpt1MnDwXm0EkUCs3-zFY,1463
+muffin_rest/peewee/schemas.py,sha256=SijMn7If3keQMwc--omDAqDr7VYASeWuCt7MEZU-waY,1014
 muffin_rest/peewee/sorting.py,sha256=vQHIrzlFTrirlbXwJNNofBUeYu4HanPanasU0NeKyJ4,1562
-muffin_rest/peewee/types.py,sha256=TC7GBvphxqe351NQDy3YmKIJCTxx6JJLdrdak-X0g_8,106
+muffin_rest/peewee/types.py,sha256=cgCXhpGHkImKwudA1lulZHz5oJswHH168AiW5MhZRCM,155
+muffin_rest/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+muffin_rest/redoc.html,sha256=GtuHIMvTuSi8Ro6bgI-G8VB94AljMyfjcZseqtBmGCY,559
+muffin_rest/sorting.py,sha256=cAFbeIyIGm9-aojrEVZtsppBktg6mOGmiUzLHzKHQhQ,2438
 muffin_rest/sqlalchemy/__init__.py,sha256=4ufRdMvuNR8z5lSb7awDdaWurH5zqf6l30D-F78NY_4,6329
 muffin_rest/sqlalchemy/filters.py,sha256=c6Q8aCQZIzV9cRhANF2A6V2bFHQk8WgaDA6tou3P5jM,3038
 muffin_rest/sqlalchemy/sorting.py,sha256=YlFKpIet4TUy7fJ2UBLC8b9lAOwY66QBpPDDApbyh8M,1643
 muffin_rest/sqlalchemy/types.py,sha256=JnIw44XJ2ClWzOv-mTUrvFw1JPxAlvdX_jf7r4zau-s,204
-muffin_rest-4.4.3.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
-muffin_rest-4.4.3.dist-info/METADATA,sha256=W6T25ow2I3KzOv9ikLAyLunsFEUiTyL9SFOLqU0cTig,5242
-muffin_rest-4.4.3.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-muffin_rest-4.4.3.dist-info/top_level.txt,sha256=HbkvTHa4P9UnCl-7SojUzWWDsVaBOvhcan7VQpM465M,12
-muffin_rest-4.4.3.dist-info/RECORD,,
+muffin_rest/swagger.html,sha256=FGTD5pU9ZUNmlaaVZ1TSajNHvoZ9IiNhJ5yw6Yk_Kz4,4058
+muffin_rest/types.py,sha256=HvPwnmZomUFy4jW5IGHSvzYDZjaLY0kMt_unBfynq2g,388
+muffin_rest/utils.py,sha256=hAxgIvzf7uCGRhOv0pf-oFxdreBYxp0zpLa7DPILQHY,2036
+muffin_rest-4.5.1.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
+muffin_rest-4.5.1.dist-info/METADATA,sha256=63Vq5xeNlF0O42_VAIt3b8dkBxZl-PxJwpvbxPEEQbg,4406
+muffin_rest-4.5.1.dist-info/WHEEL,sha256=kLuE8m1WYU0Ig0_YEGrXyTtiJvKPpLpDEiChiNyei5Y,88
+muffin_rest-4.5.1.dist-info/RECORD,,

{muffin_rest-4.4.3.dist-info → muffin_rest-4.5.1.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: poetry-core 1.5.1
 Root-Is-Purelib: true
 Tag: py3-none-any
-

muffin_rest-4.4.3.dist-info/top_level.txt

@@ -1 +0,0 @@
-muffin_rest