muffin-rest 9.3.0__tar.gz → 10.0.0__tar.gz

{muffin_rest-9.3.0 → muffin_rest-10.0.0}/PKG-INFO

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: muffin-rest
-Version: 9.3.0
+Version: 10.0.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.3.0 → muffin_rest-10.0.0}/muffin_rest/filters.py

@@ -1,17 +1,20 @@
 """Support API filters."""
+
 from __future__ import annotations
 
 import operator
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterable, Mapping, Optional  # py39
 
 import marshmallow as ma
-from asgi_tools._compat import json_loads  # type: ignore[]
+from asgi_tools._compat import json_loads
 
 from .utils import Mutate, Mutator
 
 if TYPE_CHECKING:
     from muffin import Request
 
+    from muffin_rest.types import TFilterOps, TFilterValue
+
     from .types import TVCollection
 
 FILTERS_PARAM = "where"
@@ -87,7 +90,7 @@ class Filter(Mutate):
 
         return ops, collection
 
-    async def filter(self, collection, *ops: tuple[Callable, Any], **_) -> Any:
+    async def filter(self, collection, *ops: TFilterValue) -> Any:
         """Apply the filter to collection."""
 
         def validator(obj):
@@ -95,12 +98,22 @@ class Filter(Mutate):
 
         return [item for item in collection if validator(item)]
 
-    def parse(self, data: Mapping):
+    def get_simple_value(self, ops: TFilterOps) -> Any:
+        """Get simple value from filter's data.
+
+        In case of simple filter, return the value.
+        """
+        if not ops:
+            return None
+
+        return ops[0][1]
+
+    def parse(self, data: Mapping) -> TFilterOps:
         """Parse operator and value from filter's data."""
         value = data.get(self.name, ma.missing)
         return tuple(self._parse(value))
 
-    def _parse(self, value):
+    def _parse(self, value) -> Iterable[TFilterValue]:
         deserialize = self.schema_field.deserialize
         if isinstance(value, dict):
             for op, val in value.items():

{muffin_rest-9.3.0 → muffin_rest-10.0.0}/muffin_rest/handler.py

@@ -1,4 +1,5 @@
 """Base class for API REST Handlers."""
+
 import abc
 import inspect
 from typing import (
@@ -97,8 +98,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 +141,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
@@ -240,12 +234,10 @@ class RESTBase(Generic[TVResource], Handler, metaclass=RESTHandlerMeta):
     @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.3.0 → muffin_rest-10.0.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-9.3.0 → muffin_rest-10.0.0}/muffin_rest/mongo/filters.py

@@ -1,8 +1,9 @@
 """Support filters for Mongo."""
 
-from typing import Any, Callable, ClassVar
+from typing import ClassVar
 
 from muffin_rest.filters import Filter, Filters
+from muffin_rest.types import TFilterValue
 
 
 class MongoFilter(Filter):
@@ -21,7 +22,7 @@ class MongoFilter(Filter):
         "$ends": lambda _, v: ("$regex", f"{ v }$"),
     }
 
-    async def filter(self, collection, *ops: tuple[Callable, Any], **_):
+    async def filter(self, collection, *ops: TFilterValue):
         """Apply the filter."""
         return collection.find({self.field: dict(op(self.name, v) for op, v in ops)})
 

{muffin_rest-9.3.0 → muffin_rest-10.0.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.3.0 → muffin_rest-10.0.0}/muffin_rest/peewee/filters.py

@@ -1,9 +1,10 @@
 """Support filters for Peewee ORM."""
+
 from __future__ import annotations
 
 import operator
 from functools import reduce
-from typing import Any, Callable, ClassVar, Union, cast
+from typing import TYPE_CHECKING, ClassVar, Union, cast
 
 from peewee import ColumnBase, Field, ModelSelect
 
@@ -11,6 +12,9 @@ from muffin_rest.filters import Filter, Filters
 
 from .utils import get_model_field_by_name
 
+if TYPE_CHECKING:
+    from muffin_rest.types import TFilterValue
+
 
 class PWFilter(Filter):
     """Support Peewee."""
@@ -33,9 +37,7 @@ class PWFilter(Filter):
 
     list_ops = (*Filter.list_ops, "$between")
 
-    async def filter(
-        self, collection: ModelSelect, *ops: tuple[Callable, Any], **kwargs
-    ) -> ModelSelect:
+    async def filter(self, collection: ModelSelect, *ops: TFilterValue) -> ModelSelect:
         """Apply the filters to Peewee QuerySet.."""
         column = self.field
         if isinstance(column, ColumnBase):

{muffin_rest-9.3.0 → muffin_rest-10.0.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.3.0 → muffin_rest-10.0.0}/muffin_rest/sqlalchemy/filters.py

@@ -2,13 +2,15 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Callable, ClassVar, Union, cast
+from typing import TYPE_CHECKING, Any, ClassVar, Union, cast
 
 from sqlalchemy import Column
 
 from muffin_rest.filters import Filter, Filters
 
 if TYPE_CHECKING:
+    from muffin_rest.types import TFilterValue
+
     from .types import TVCollection
 
 
@@ -29,17 +31,15 @@ class SAFilter(Filter):
 
     list_ops = (*Filter.list_ops, "$between")
 
-    async def filter(
-        self, collection: TVCollection, *ops: tuple[Callable, Any], **kwargs
-    ) -> TVCollection:
+    async def filter(self, collection: TVCollection, *ops: TFilterValue) -> TVCollection:
         """Apply the filters to SQLAlchemy Select."""
         column = self.field
         if ops and column is not None:
-            return self.query(collection, column, *ops, **kwargs)
+            return self.query(collection, column, *ops)
 
         return collection
 
-    def query(self, select: TVCollection, column: Column, *ops, **_) -> TVCollection:
+    def query(self, select: TVCollection, column: Column, *ops: TFilterValue) -> TVCollection:
         """Filter a select."""
         return select.where(*[op(column, val) for op, val in ops])
 

{muffin_rest-9.3.0 → muffin_rest-10.0.0}/muffin_rest/types.py

@@ -19,3 +19,6 @@ TAuth = Callable[[Request], Awaitable]
 TVAuth = TypeVar("TVAuth", bound=TAuth)
 TVHandler = TypeVar("TVHandler", bound=type["RESTBase"])
 TSchemaRes = dict[str, Any]
+
+TFilterValue = tuple[Callable, Any]
+TFilterOps = tuple[TFilterValue, ...]

{muffin_rest-9.3.0 → muffin_rest-10.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "muffin-rest"
-version = "9.3.0"
+version = "10.0.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]