add serializated arguments and parameters to request object. (#32)

* add serialized arguments and parameters to request object.

Author: flask-pro

CHANGES.md

@@ -1,3 +1,9 @@
+## Version 0.17.0
+
+* Authorization via HTTPBasicAuth and Bearer token supported.
+* Add append serialized path-parameters, arguments, json, cookie and headers to object of request
+  Flask.
+
 ## Version 0.16.1
 
 * Fix the display of the specification described in several files in Swagger UI.

README.md

@@ -6,9 +6,9 @@ Flask extension for using "specification first" and "API-first" principles.
 
 - [Flask-First](#flask-first)
   - [Features](#features)
-    - [Limitations](#limitations)
   - [Installation](#installation)
   - [Settings](#settings)
+  - [Tools](#tools)
   - [Data types](#data-types)
   - [Examples](#examples)
     - [Simple example](#simple-example)
@@ -21,23 +21,16 @@ Flask extension for using "specification first" and "API-first" principles.
 ## Features
 
 * `Application Factory` supported.
-* Validating and serializing headers of request from `request.headers` to `request.first_headers`.
-* Validating and serializing path parameters of request from `request.view_args`
-  to `request.first_view_args`.
-* Validating and serializing arguments of request from `request.args` to `request.first_args`.
-* Validating and serializing cookies of request from `request.cookies` to `request.first_cookies`.
-* Validating and serializing JSON of request from `request.json` to `request.first_json`.
+* Validating and serializing headers of request.
+* Validating and serializing path parameters of request.
+* Validating and serializing arguments of request.
+* Validating and serializing cookies of request.
+* Validating and serializing JSON of request.
 * Validating JSON from response for debugging.
 * Provides a Swagger UI.
 * Support OpenAPI version 3.1.0.
 * Support specification from multiple file.
 
-### Limitations
-
-Will be added in future releases.
-
-* Authorization not supported.
-
 ## Installation
 
 Recommended using the latest version of Python. Flask-First supports Python 3.9 and newer.
@@ -53,6 +46,23 @@ $ pip install -U flask_first
 `FIRST_RESPONSE_VALIDATION` - Default: `False`. Enabling response body validation. Useful when
 developing. Must be disabled in a production environment.
 
+## Tools
+
+Possible to get data from path-parameters, arguments, JSON, cookies and headers in serialized form.
+Use flask-first object attached to the query.
+
+```python
+from flask import request
+
+
+def route_func():
+    path_parameters = request.extensions['first']['views']
+    args = request.extensions['first']['args']
+    json = request.extensions['first']['json']
+    cookies = request.extensions['first']['cookies']
+    headers = request.extensions['first']['headers']
+```
+
 ## Data types
 
 Supported formats for string type field:
@@ -203,18 +213,18 @@ paths:
     options:
       summary: CORS support
       responses:
-      200:
-        headers:
-          Access-Control-Allow-Origin:
-            schema:
-              type: string
-          Access-Control-Allow-Methods:
-            schema:
-              type: string
-          Access-Control-Allow-Headers:
-            schema:
-              type: string
-        content: { }
+        200:
+          headers:
+            Access-Control-Allow-Origin:
+              schema:
+                type: string
+            Access-Control-Allow-Methods:
+              schema:
+                type: string
+            Access-Control-Allow-Headers:
+              schema:
+                type: string
+                content: { }
 ```
 
 ## Additional documentation

pyproject.toml

@@ -13,7 +13,7 @@ classifiers = [
   "Programming Language :: Python :: 3"
 ]
 dependencies = [
-  'Flask>=2.0.2',
+  'Flask>=2.0.3',
   'PyYAML>=6.0.1',
   'openapi-spec-validator>=0.5.0',
   'marshmallow>=3.14.1'
@@ -23,7 +23,7 @@ license = {file = "LICENSE"}
 name = "Flask-First"
 readme = "README.md"
 requires-python = ">=3.9"
-version = "0.16.1"
+version = "0.17.0"
 
 [project.optional-dependencies]
 dev = [

src/flask_first/__init__.py

@@ -1,14 +1,12 @@
 import re
 from pathlib import Path
-from typing import Any
 
 import marshmallow
 from flask import Flask
 from flask import Request
 from flask import request
 from flask import Response
 from marshmallow.exceptions import ValidationError
-from werkzeug.datastructures import Headers
 from werkzeug.datastructures import MultiDict
 
 from .first import RequestSerializer
@@ -77,30 +75,27 @@ def _route_registration_in_flask(self, func: callable) -> None:
 
         self._mapped_routes_from_spec.append(rule)
 
-    def _extract_data_from_request(
-        self, request_obj: Request
-    ) -> tuple[Any, str or None, Headers, dict[str, Any] or None, dict, dict, Any or None]:
-        method = request_obj.method.lower()
+    @staticmethod
+    def _extract_method_from_request(request_obj: Request) -> str:
+        return request_obj.method.lower()
 
+    @staticmethod
+    def _extract_route_from_request(request_obj: Request) -> str:
         if request_obj.url_rule is not None:
             route = request_obj.url_rule.rule
         else:
             route = request_obj.url_rule
 
-        headers = request_obj.headers
-
-        view_args = request_obj.view_args
-
-        args = self._resolved_params(request_obj.args)
-
-        cookies = self._resolved_params(request_obj.cookies)
+        return route
 
+    @staticmethod
+    def _extract_json_from_request(request_obj: Request) -> dict or None:
         if request_obj.is_json:
             json = request_obj.get_json()
         else:
             json = None
 
-        return method, route, headers, view_args, args, cookies, json
+        return json
 
     @staticmethod
     def _resolved_params(payload: MultiDict) -> dict:
@@ -139,31 +134,29 @@ def add_request_validating() -> None:
             if request.method in ('OPTIONS',):
                 return
 
-            (
-                method,
-                route,
-                headers,
-                view_args,
-                args,
-                cookies,
-                json,
-            ) = self._extract_data_from_request(request)
-
+            route = self._extract_route_from_request(request)
             if route not in self._mapped_routes_from_spec:
                 return
 
             route_as_in_spec = self.route_to_openapi_format(route)
 
+            method = self._extract_method_from_request(request)
             params_schemas = self.spec.serialized_spec['paths'][route_as_in_spec][method].get(
                 'parameters'
             )
+            args = self._resolved_params(request.args)
             if params_schemas:
                 args_schema = params_schemas.get('args')
                 if args_schema:
                     schema_fields = args_schema().fields
                     args = self._arg_to_list(args, schema_fields)
 
-            rv = RequestSerializer(
+            headers = request.headers
+            view_args = request.view_args
+            cookies = self._resolved_params(request.cookies)
+            json = self._extract_json_from_request(request)
+
+            request_serializer = RequestSerializer(
                 self.spec,
                 method,
                 route_as_in_spec,
@@ -173,20 +166,22 @@ def add_request_validating() -> None:
                 params=args,
                 json=json,
             )
-            rv.validate()
-
-            request.first_headers = rv.serialized_headers
-            request.first_view_args = rv.serialized_path_params
-            request.first_args = rv.serialized_params
-            request.first_cookies = rv.serialized_cookies
-            request.first_json = rv.serialized_json
+            request_serializer.validate()
+
+            request.extensions = {
+                'first': {
+                    'headers': request_serializer.serialized_headers,
+                    'view_args': request_serializer.serialized_path_params,
+                    'args': request_serializer.serialized_params,
+                    'cookies': request_serializer.serialized_cookies,
+                    'json': request_serializer.serialized_json,
+                }
+            }
 
     def _register_response_validation(self) -> None:
         @self.app.after_request
         def add_response_validating(response: Response) -> Response:
-            method, route, _, _, _, _, json = self._extract_data_from_request(request)
-            json = response.get_json()
-
+            route = self._extract_route_from_request(request)
             if route not in self._mapped_routes_from_spec:
                 return response
 
@@ -199,6 +194,7 @@ def add_response_validating(response: Response) -> Response:
                     f'Route <{e.args[0]}> not defined in specification.'
                 )
 
+            method = self._extract_method_from_request(request)
             try:
                 method_schema: dict = route_schema[method]
             except KeyError as e:
@@ -226,6 +222,7 @@ def add_response_validating(response: Response) -> Response:
                 )
 
             if response_content_type == 'application/json':
+                json = response.get_json()
                 json_schema = content[response.content_type]['schema']
                 try:
                     if isinstance(json, list):

src/flask_first/first/specification.py

@@ -90,10 +90,6 @@ def resolve(self) -> Mapping[Hashable, Any]:
         return self._resolving(schema, self.abs_path)
 
 
-class Serializer:
-    pass
-
-
 class Specification:
     def __init__(self, path: Path or str, experimental_validator: bool = False):
         self.path = path

tests/test_args.py

@@ -26,7 +26,7 @@ def mini_endpoint() -> dict:
 
 def test_specification__required_args(fx_create_app):
     def mini_endpoint(required_path) -> dict:
-        required_arg = request.first_args['required_arg']
+        required_arg = request.extensions['first']['args']['required_arg']
 
         return {'required_path': required_path, 'required_arg': required_arg}
 

tests/test_flask_first.py

@@ -90,9 +90,9 @@ def items_list() -> Response:
 def test_specification__args(fx_app, fx_client):
     def items_args() -> dict:
         return {
-            'page': request.first_args['page'],
-            'per_page': request.first_args['per_page'],
-            'page_list': request.first_args['page_list'],
+            'page': request.extensions['first']['args']['page'],
+            'per_page': request.extensions['first']['args']['per_page'],
+            'page_list': request.extensions['first']['args']['page_list'],
         }
 
     fx_app.extensions['first'].add_view_func(items_args)
@@ -316,7 +316,7 @@ def mini_endpoint(uuid: str) -> dict:
 
 def test_specification__params__format():
     def mini_endpoint(uuid_from_path: str, datetime_from_path: str) -> dict:
-        args = request.first_args
+        args = request.extensions['first']['args']
         uuid_from_query = args['uuid_from_query']
         datetime_from_query = args['datetime_from_query']
 
@@ -360,8 +360,7 @@ def create_app():
 
 def test_specification__param_as_list():
     def mini_endpoint() -> dict:
-        args = request.first_args
-        param_as_list = args['param_as_list']
+        param_as_list = request.extensions['first']['args']['param_as_list']
 
         assert isinstance(param_as_list, list)
         assert isinstance(param_as_list[0], uuid.UUID)