starmallow 0.3.9__tar.gz → 0.5.0__tar.gz

starmallow-0.5.0/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.11
+
+WORKDIR /app
+
+RUN pip install brotli-asgi gunicorn starlette_context
+
+COPY . /app
+RUN pip install --no-cache-dir .[all]
+
+CMD ["gunicorn", "--config", "examples/gunicorn.py", "examples.cache_server:app"]

{starmallow-0.3.9 → starmallow-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: starmallow
-Version: 0.3.9
+Version: 0.5.0
 Summary: StarMallow framework
 Project-URL: Homepage, https://github.com/mvanderlee/starmallow
 Author-email: Michiel Vanderlee <jmt.vanderlee@gmail.com>

starmallow-0.5.0/docker-compose.yml

@@ -0,0 +1,6 @@
+services:
+  debugpy-example:
+    build:
+      context: .
+    ports:
+      - 8000:8000

starmallow-0.5.0/examples/cache_server.py

@@ -0,0 +1,80 @@
+from multiprocessing import Value, Manager
+from typing import Annotated, Optional
+
+import hashlib
+import marshmallow.fields as mf
+from brotli_asgi import BrotliMiddleware
+from marshmallow.validate import Range
+from marshmallow_dataclass import dataclass as ma_dataclass
+from starlette.middleware import Middleware
+from starlette_context import middleware, plugins
+
+from starmallow.applications import StarMallow
+from starmallow.params import Body, Cookie, Header, Query
+
+
+counter = Value('i', 0)
+cache = Manager().dict()
+
+
+app = StarMallow(
+    title="My API",
+    version="1.0.0",
+    middleware=[
+        # Order matters!
+        Middleware(BrotliMiddleware, minimum_size=500),
+        Middleware(
+            middleware.ContextMiddleware,
+            plugins=(
+                plugins.RequestIdPlugin(),
+                plugins.CorrelationIdPlugin(),
+            ),
+        ),
+    ],
+)
+
+@ma_dataclass
+class CreateRequest:
+    my_string: str
+    my_int: int = 5
+
+
+@ma_dataclass
+class CreateResponse:
+    my_string: str
+
+
+@app.post('/test')
+async def test(
+    create_request: CreateRequest,
+    limit: Annotated[int, Query()],
+    offset: int = 0,
+    offset2: int = Query(0, model=mf.Integer(validate=[Range(min=0, max=50)])),
+    my_string: str = Body('foobar'),
+    email: str = Body(..., model=mf.Email()),
+    foobar: str = Header(...),
+    preference: Optional[str] = Cookie(...),
+) -> CreateResponse:
+    with counter.get_lock():
+        counter.value += 1
+
+    print(counter.value)
+
+    cache_key = hashlib.blake2b(f'{create_request}{limit}{offset}{offset2}{my_string}{email}{foobar}')
+    if (cache_key in cache):
+        return cache[cache_key]
+
+    else:
+        print(create_request)
+        print(limit)
+        print(offset)
+        print(offset2)
+        print(foobar)
+        print(my_string)
+        print(email)
+        print(preference)
+
+        cache[cache_key] = create_request
+
+        return create_request
+

starmallow-0.5.0/examples/gunicorn.py

@@ -0,0 +1,10 @@
+import os
+
+if os.environ.get('MODE') == 'dev':
+    reload = True
+
+preload_app = True
+worker_class = "uvicorn.workers.UvicornWorker"
+bind = '0.0.0.0:8000'
+workers = 4
+threads = 4

{starmallow-0.3.9 → starmallow-0.5.0}/starmallow/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.9"
+__version__ = "0.5.0"
 
 from .applications import StarMallow
 from .exceptions import RequestValidationError

{starmallow-0.3.9 → starmallow-0.5.0}/starmallow/applications.py

@@ -251,6 +251,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -275,6 +277,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -296,6 +300,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -319,6 +325,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -356,6 +364,7 @@ class StarMallow(Starlette):
         callbacks: Optional[List[BaseRoute]] = None,
         deprecated: Optional[bool] = None,
         include_in_schema: bool = True,
+        default_request_class: Type[Request] = Default(Request),
         default_response_class: Type[Response] = Default(JSONResponse),
         generate_unique_id_function: Callable[[APIRoute], str] = Default(
             generate_unique_id,
@@ -369,6 +378,7 @@ class StarMallow(Starlette):
             callbacks=callbacks,
             deprecated=deprecated,
             include_in_schema=include_in_schema,
+            default_request_class=default_request_class,
             default_response_class=default_response_class,
             generate_unique_id_function=generate_unique_id_function,
         )
@@ -380,6 +390,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -402,6 +414,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -422,6 +436,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -444,6 +460,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -464,6 +482,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -486,6 +506,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -506,6 +528,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -528,6 +552,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -548,6 +574,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -570,6 +598,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -590,6 +620,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -612,6 +644,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -632,6 +666,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -654,6 +690,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -674,6 +712,8 @@ class StarMallow(Starlette):
         name: str = None,
         include_in_schema: bool = True,
         status_code: Optional[int] = None,
+        middleware: Sequence[Middleware] | None = None,
+        request_class: Type[Request] = Default(Request),
         response_model: Optional[Type[Any]] = None,
         response_class: Type[Response] = JSONResponse,
         # OpenAPI summary
@@ -696,6 +736,8 @@ class StarMallow(Starlette):
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,

{starmallow-0.3.9 → starmallow-0.5.0}/starmallow/decorators.py

@@ -1,7 +1,9 @@
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Type, Union
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Sequence, Type, Union
 
+from starlette.middleware import Middleware
+from starlette.requests import Request
 from starlette.responses import Response
 from starlette.routing import BaseRoute
 
@@ -19,7 +21,9 @@ class EndpointOptions:
     name: str = None
     include_in_schema: bool = True
     status_code: Optional[int] = None
+    middleware: Sequence[Middleware] | None = None
     deprecated: Optional[bool] = None
+    request_class: Type[Request] = Request
     response_model: Optional[Type[Any]] = None
     response_class: Type[Response] = JSONResponse
     # OpenAPI summary
@@ -38,6 +42,7 @@ class EndpointOptions:
     tags: Optional[List[Union[str, Enum]]] = None
     # Will be deeply merged with the automatically generated OpenAPI schema for the path operation.
     openapi_extra: Optional[Dict[str, Any]] = None
+    route_class: Optional[Type["APIRoute"]] = None
 
 
 def route(
@@ -45,7 +50,9 @@ def route(
     name: str = None,
     include_in_schema: bool = True,
     status_code: Optional[int] = None,
+    middleware: Sequence[Middleware] | None = None,
     deprecated: Optional[bool] = None,
+    request_class: Type[Request] = Default(Request),
     response_model: Optional[Type[Any]] = None,
     response_class: Type[Response] = JSONResponse,
     # OpenAPI summary
@@ -62,6 +69,7 @@ def route(
     tags: Optional[List[Union[str, Enum]]] = None,
     # Will be deeply merged with the automatically generated OpenAPI schema for the path operation.
     openapi_extra: Optional[Dict[str, Any]] = None,
+    route_class: Optional[Type["APIRoute"]] = None,
 ) -> Callable[[DecoratedCallable], DecoratedCallable]:
     '''
         Intended to be used with APIHTTPEndpoint to override options on a per method basis
@@ -72,7 +80,9 @@ def route(
             name=name,
             include_in_schema=include_in_schema,
             status_code=status_code,
+            middleware=middleware,
             deprecated=deprecated,
+            request_class=request_class,
             response_model=response_model,
             response_class=response_class,
             summary=summary,
@@ -84,6 +94,7 @@ def route(
             generate_unique_id_function=generate_unique_id_function,
             openapi_extra=openapi_extra,
             tags=tags,
+            route_class=route_class,
         )
         return func
     return decorator

{starmallow-0.3.9 → starmallow-0.5.0}/starmallow/endpoint.py

@@ -245,6 +245,9 @@ class EndpointMixin:
         elif is_marshmallow_schema(model):
             return SchemaModel(model() if inspect.isclass(model) else model, **kwargs)
         elif is_marshmallow_field(model):
+            if inspect.isclass(model):
+                model = model()
+
             if model.load_default is not None and model.load_default != kwargs.get('load_default', ma.missing):
                 logger.warning(
                     f"'{parameter_name}' model and annotation have different 'load_default' values."

starmallow-0.5.0/starmallow/requests.py

@@ -0,0 +1,36 @@
+from typing import Any
+
+from starlette.requests import Request
+
+try:
+    import ujson
+except ImportError:  # pragma: nocover
+    ujson = None  # type: ignore
+
+
+try:
+    import orjson
+except ImportError:  # pragma: nocover
+    orjson = None  # type: ignore
+
+
+class UJSONRequest(Request):
+
+    async def json(self) -> Any:
+        assert ujson is not None, "ujson must be installed to use UJSONRequest"
+
+        if not hasattr(self, "_json"):
+            body = await self.body()
+            self._json = ujson.loads(body)
+        return self._json
+
+
+class ORJSONRequest(Request):
+
+    async def json(self) -> Any:
+        assert orjson is not None, "orjson must be installed to use ORJSONRequest"
+
+        if not hasattr(self, "_json"):
+            body = await self.body()
+            self._json = orjson.loads(body)
+        return self._json