muffin-rest 9.4.0__tar.gz → 10.1.0__tar.gz

{muffin_rest-9.4.0 → muffin_rest-10.1.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: muffin-rest
-Version: 9.4.0
+Version: 10.1.0
 Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-Home-page: https://github.com/klen/muffin-rest
 License: MIT
 Keywords: rest,api,muffin,asgi,asyncio,trio
 Author: Kirill Klenov
@@ -33,6 +32,7 @@ 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-9.4.0 → muffin_rest-10.1.0}/muffin_rest/handler.py

@@ -1,4 +1,5 @@
 """Base class for API REST Handlers."""
+
 import abc
 import inspect
 from typing import (
@@ -7,6 +8,7 @@ from typing import (
     Generic,
     Iterable,
     Literal,
+    Mapping,
     Optional,
     Sequence,
     Union,
@@ -97,8 +99,6 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
         self.auth = await self.authorize(request)
 
         meta = self.meta
-        if meta.rate_limit:
-            await self.rate_limit(request)
 
         self.collection = await self.prepare_collection(request)
         resource = await self.prepare_resource(request)
@@ -142,11 +142,6 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
             raise APIError.UNAUTHORIZED()
         return auth
 
-    async def rate_limit(self, request: Request):
-        """Default rate limit method. Proxy rate limit to self.api."""
-        if not await self.meta.rate_limiter.check(f"{self.auth}"):
-            raise APIError.TOO_MANY_REQUESTS()
-
     # Prepare data
     # ------------
     @abc.abstractmethod
@@ -228,24 +223,30 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
         schema_options.setdefault("exclude", query.get("schema_exclude", ()))
         return self.meta.Schema(**schema_options)
 
+    async def load_data(self, request: Request):
+        """Load data from request and create/update a resource."""
+        try:
+            data = await request.data(raise_errors=True)
+        except (ValueError, TypeError) as err:
+            raise APIError.BAD_REQUEST(str(err)) from err
+
+        return data
+
     async def load(
         self, request: Request, resource: Optional[TVResource] = None, **schema_options
     ) -> TVData[TVResource]:
         """Load data from request and create/update a resource."""
         schema = self.get_schema(request, resource=resource, **schema_options)
-        return cast(
-            TVData[TVResource], await load_data(request, 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]
         self, request, data: TVData, *, many: Literal[True]
-    ) -> list[TSchemaRes]:
-        ...
+    ) -> list[TSchemaRes]: ...
 
     @overload
-    async def dump(self, request, data: TVData, *, many: bool = False) -> TSchemaRes:
-        ...
+    async def dump(self, request, data: TVData, *, many: bool = False) -> TSchemaRes: ...
 
     async def dump(
         self,

{muffin_rest-9.4.0 → muffin_rest-10.1.0}/muffin_rest/limits.py

@@ -1,11 +1,12 @@
 import abc
 from time import time
+from typing import Any
 
 
 class RateLimiter(abc.ABC):
     """Rate limiter."""
 
-    def __init__(self, limit: int, period: int, **opts):
+    def __init__(self, limit: int, *, period: int = 60, **opts):
         """Initialize the rate limiter.
 
         Args:
@@ -21,26 +22,29 @@ class RateLimiter(abc.ABC):
         raise NotImplementedError
 
 
-RATE_LIMITS = {}
-
-
 class MemoryRateLimiter(RateLimiter):
     """Memory rate limiter. Do not use in production."""
 
+    def __init__(self, limit: int, **opts):
+        super().__init__(limit, **opts)
+        self.storage: dict[Any, tuple[float, int]] = {}
+
     async def check(self, key: str) -> bool:
         """Check the request."""
         now = time()
-        if key not in RATE_LIMITS:
-            RATE_LIMITS[key] = (now, 1)
+        storage = self.storage
+
+        if key not in storage:
+            storage[key] = (now, 1)
             return True
 
-        last, count = RATE_LIMITS[key]
+        last, count = storage[key]
         if now - last > self.period:
-            RATE_LIMITS[key] = (now, 1)
+            storage[key] = (now, 1)
             return True
 
         if count < self.limit:
-            RATE_LIMITS[key] = (last, count + 1)
+            storage[key] = (last, count + 1)
             return True
 
         return False
@@ -51,7 +55,7 @@ class RedisRateLimiter(RateLimiter):
 
     # TODO: Asyncio lock
 
-    def __init__(self, limit: int, period: int, *, redis, **opts):
+    def __init__(self, limit: int, *, redis, **opts):
         """Initialize the rate limiter.
 
         Args:
@@ -59,7 +63,7 @@ class RedisRateLimiter(RateLimiter):
             period (int): The period of time in seconds.
             redis (aioredis.Redis): The Redis connection.
         """
-        super().__init__(limit, period)
+        super().__init__(limit, **opts)
         self.redis = redis
 
     async def check(self, key: str) -> bool:

muffin_rest-10.1.0/muffin_rest/marshmallow.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Optional, Union
+
+from marshmallow import Schema, ValidationError
+
+from muffin_rest.errors import APIError
+
+if TYPE_CHECKING:
+    from collections.abc import Mapping
+
+
+async def load_data(data: Union[Mapping, list], schema: Optional[Schema] = None, **params):
+    if schema is None:
+        return data
+
+    try:
+        return schema.load(data, many=isinstance(data, list), **params)
+    except ValidationError as err:
+        raise APIError.BAD_REQUEST("Bad request data", errors=err.messages) from err

{muffin_rest-9.4.0 → muffin_rest-10.1.0}/muffin_rest/options.py

@@ -1,11 +1,9 @@
 """REST Options."""
 
-from typing import Any, ClassVar
+from typing import ClassVar
 
 import marshmallow as ma
 
-from muffin_rest.limits import MemoryRateLimiter, RateLimiter
-
 from .filters import Filters
 from .sorting import Sorting
 
@@ -53,14 +51,6 @@ class RESTOptions:
     schema_meta: ClassVar[dict] = {}
     schema_unknown: str = ma.EXCLUDE
 
-    # Rate Limiting
-    # -------------
-
-    rate_limit: int = 0
-    rate_limit_period: int = 60
-    rate_limit_cls: type[RateLimiter] = MemoryRateLimiter
-    rate_limit_cls_opts: ClassVar[dict[str, Any]] = {}
-
     def __init__(self, cls):
         """Inherit meta options."""
         for base in reversed(cls.mro()):
@@ -86,11 +76,6 @@ class RESTOptions:
         if not self.limit_max:
             self.limit_max = self.limit
 
-        if self.rate_limit:
-            self.rate_limiter = self.rate_limit_cls(
-                self.rate_limit, self.rate_limit_period, **self.rate_limit_cls_opts
-            )
-
     def setup_schema_meta(self, _):
         """Generate meta for schemas."""
         return type(

{muffin_rest-9.4.0 → muffin_rest-10.1.0}/muffin_rest/peewee/utils.py

@@ -1,4 +1,5 @@
 """Support filters for Peewee ORM."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Optional
@@ -8,7 +9,7 @@ if TYPE_CHECKING:
     from peewee import Field
 
 
-def get_model_field_by_name(handler, name: str, stacklevel=5) -> Optional[Field]:
+def get_model_field_by_name(handler, name: str, *, stacklevel=5) -> Optional[Field]:
     """Get model field by name."""
     fields = handler.meta.model._meta.fields
     candidate = fields.get(name)

{muffin_rest-9.4.0 → muffin_rest-10.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "muffin-rest"
-version = "9.4.0"
+version = "10.1.0"
 description = "The package provides enhanced support for writing REST APIs with Muffin framework"
 readme = "README.rst"
 homepage = "https://github.com/klen/muffin-rest"
@@ -78,7 +78,7 @@ ignore_missing_imports = true
 [tool.tox]
 legacy_tox_ini = """
 [tox]
-envlist = py39,py310,py311,py312,py313,pypy39
+envlist = py310,py311,py312,py313,pypy39
 
 [testenv]
 deps = -e .[tests]
@@ -88,7 +88,7 @@ commands =
 
 [tool.ruff]
 line-length = 100
-target-version = "py39"
+target-version = "py310"
 exclude = [".venv", "docs", "examples"]
 
 [tool.ruff.lint]
@@ -117,7 +117,7 @@ ignore = [
 
 [tool.black]
 line-length = 100
-target-version = ["py39", "py310", "py311", "py312", "py313"]
+target-version = ["py310", "py311", "py312", "py313"]
 preview = true
 
 [build-system]

muffin_rest-9.4.0/muffin_rest/marshmallow.py

@@ -1,26 +0,0 @@
-from __future__ import annotations
-
-from collections.abc import Mapping
-from typing import TYPE_CHECKING, Optional, Union, cast
-
-from marshmallow import Schema, ValidationError
-
-from muffin_rest.errors import APIError
-
-if TYPE_CHECKING:
-    from asgi_tools import Request
-
-
-async def load_data(request: Request, schema: Optional[Schema] = None, **params):
-    try:
-        data = await request.data(raise_errors=True)
-    except (ValueError, TypeError) as err:
-        raise APIError.BAD_REQUEST(str(err)) from err
-
-    if schema is None:
-        return data
-
-    try:
-        return schema.load(cast(Union[Mapping, list], data), many=isinstance(data, list), **params)
-    except ValidationError as err:
-        raise APIError.BAD_REQUEST("Bad request data", errors=err.messages) from err