[14.0] base_rest_pydantic: New addon to use pydantic model into base_rest

base_rest/apispec/rest_method_param_plugin.py

@@ -48,12 +48,14 @@ def _generate_pamareters(self, routing, method, params):
             if method == "get":
                 # get quey params from RequestMethodParam object
                 parameters.extend(
-                    input_param.to_openapi_query_parameters(self._service)
+                    input_param.to_openapi_query_parameters(self._service, self.spec)
                 )
             else:
                 # get requestBody from RequestMethodParam object
                 request_body = params.get("requestBody", {})
-                request_body.update(input_param.to_openapi_requestbody(self._service))
+                request_body.update(
+                    input_param.to_openapi_requestbody(self._service, self.spec)
+                )
                 params["requestBody"] = request_body
             # sort paramters to ease comparison into unittests
             parameters.sort(key=lambda a: a["name"])
@@ -68,5 +70,7 @@ def _generate_responses(self, routing, method, params):
             responses = params.get("responses", {})
             # get response from RequestMethodParam object
             responses.update(self._default_responses.copy())
-            responses.update(output_param.to_openapi_responses(self._service))
+            responses.update(
+                output_param.to_openapi_responses(self._service, self.spec)
+            )
         return responses

base_rest/restapi.py

@@ -131,13 +131,13 @@ def to_response(self, service, result):
         :return: http.Response or JSON dict
         """
 
-    def to_openapi_query_parameters(self, service):
+    def to_openapi_query_parameters(self, service, spec):
         return {}
 
-    def to_openapi_requestbody(self, service):
+    def to_openapi_requestbody(self, service, spec):
         return {}
 
-    def to_openapi_responses(self, service):
+    def to_openapi_responses(self, service, spec):
         return {}
 
 
@@ -161,10 +161,10 @@ def _binary_content_schema(self):
             for mediatype in self._mediatypes
         }
 
-    def to_openapi_requestbody(self, service):
+    def to_openapi_requestbody(self, services, spec):
         return {"content": self._binary_content_schema}
 
-    def to_openapi_responses(self, service):
+    def to_openapi_responses(self, service, spec):
         return {"200": {"content": self._binary_content_schema}}
 
     def to_response(self, service, result):
@@ -209,7 +209,7 @@ def to_response(self, service, result):
             return validator.document
         raise SystemError(_("Invalid Response %s") % validator.errors)
 
-    def to_openapi_query_parameters(self, service):
+    def to_openapi_query_parameters(self, service, spec):
         json_schema = self.to_json_schema(service, "input")
         parameters = []
         for prop, spec in list(json_schema["properties"].items()):
@@ -238,11 +238,11 @@ def to_openapi_query_parameters(self, service):
 
         return parameters
 
-    def to_openapi_requestbody(self, service):
+    def to_openapi_requestbody(self, service, spec):
         json_schema = self.to_json_schema(service, "input")
         return {"content": {"application/json": {"schema": json_schema}}}
 
-    def to_openapi_responses(self, service):
+    def to_openapi_responses(self, service, spec):
         json_schema = self.to_json_schema(service, "output")
         return {"200": {"content": {"application/json": {"schema": json_schema}}}}
 
@@ -293,7 +293,7 @@ def from_params(self, service, params):
     def to_response(self, service, result):
         return self._do_validate(service, data=result, direction="output")
 
-    def to_openapi_query_parameters(self, service):
+    def to_openapi_query_parameters(self, service, spec):
         raise NotImplementedError("List are not (?yet?) supported as query paramters")
 
     def _do_validate(self, service, data, direction):

base_rest/tests/test_cerberus_list_validator.py

@@ -48,7 +48,7 @@ def setUpClass(cls):
         cls.maxDiff = None
 
     def test_to_openapi_responses(self):
-        res = self.simple_schema_list_validator.to_openapi_responses(None)
+        res = self.simple_schema_list_validator.to_openapi_responses(None, None)
         self.assertDictEqual(
             res,
             {
@@ -78,7 +78,7 @@ def test_to_openapi_responses(self):
                 }
             },
         )
-        res = self.nested_schema_list_validator.to_openapi_responses(None)
+        res = self.nested_schema_list_validator.to_openapi_responses(None, None)
         self.assertDictEqual(
             res,
             {
@@ -113,7 +113,7 @@ def test_to_openapi_responses(self):
         )
 
     def test_to_openapi_requestbody(self):
-        res = self.simple_schema_list_validator.to_openapi_requestbody(None)
+        res = self.simple_schema_list_validator.to_openapi_requestbody(None, None)
         self.assertEqual(
             res,
             {
@@ -141,7 +141,7 @@ def test_to_openapi_requestbody(self):
                 }
             },
         )
-        res = self.nested_schema_list_validator.to_openapi_requestbody(None)
+        res = self.nested_schema_list_validator.to_openapi_requestbody(None, None)
         self.assertDictEqual(
             res,
             {
@@ -175,7 +175,7 @@ def test_to_openapi_requestbody(self):
 
     def test_to_openapi_query_parameters(self):
         with self.assertRaises(NotImplementedError):
-            self.simple_schema_list_validator.to_openapi_query_parameters(None)
+            self.simple_schema_list_validator.to_openapi_query_parameters(None, None)
 
     def test_from_params_ignore_unknown(self):
         params = [{"name": "test", "unknown": True}]

base_rest/tests/test_cerberus_validator.py

@@ -51,7 +51,7 @@ def setUpClass(cls):
         )
 
     def test_to_openapi_responses(self):
-        res = self.simple_schema_cerberus_validator.to_openapi_responses(None)
+        res = self.simple_schema_cerberus_validator.to_openapi_responses(None, None)
         self.assertDictEqual(
             res,
             {
@@ -80,7 +80,7 @@ def test_to_openapi_responses(self):
                 }
             },
         )
-        res = self.nested_schema_cerberus_validator.to_openapi_responses(None)
+        res = self.nested_schema_cerberus_validator.to_openapi_responses(None, None)
         self.assertDictEqual(
             res,
             {
@@ -113,7 +113,7 @@ def test_to_openapi_responses(self):
         )
 
     def test_to_openapi_requestbody(self):
-        res = self.simple_schema_cerberus_validator.to_openapi_requestbody(None)
+        res = self.simple_schema_cerberus_validator.to_openapi_requestbody(None, None)
         self.assertEqual(
             res,
             {
@@ -140,7 +140,7 @@ def test_to_openapi_requestbody(self):
                 }
             },
         )
-        res = self.nested_schema_cerberus_validator.to_openapi_requestbody(None)
+        res = self.nested_schema_cerberus_validator.to_openapi_requestbody(None, None)
         self.assertDictEqual(
             res,
             {
@@ -168,7 +168,9 @@ def test_to_openapi_requestbody(self):
         )
 
     def test_to_openapi_query_parameters(self):
-        res = self.simple_schema_cerberus_validator.to_openapi_query_parameters(None)
+        res = self.simple_schema_cerberus_validator.to_openapi_query_parameters(
+            None, None
+        )
         self.assertListEqual(
             res,
             [
@@ -206,7 +208,9 @@ def test_to_openapi_query_parameters(self):
                 },
             ],
         )
-        res = self.nested_schema_cerberus_validator.to_openapi_query_parameters(None)
+        res = self.nested_schema_cerberus_validator.to_openapi_query_parameters(
+            None, None
+        )
         self.assertListEqual(
             res,
             [

base_rest_datamodel/restapi.py

@@ -52,22 +52,22 @@ def to_response(self, service, result):
             raise SystemError(_("Invalid Response %s") % errors)
         return json
 
-    def to_openapi_query_parameters(self, service):
+    def to_openapi_query_parameters(self, service, spec):
         converter = self._get_converter()
         schema = self._get_schema(service)
         return converter.schema2parameters(schema, location="query")
 
     # TODO, we should probably get the spec as parameters. That should
     # allows to add the definition of a schema only once into the specs
     # and use a reference to the schema into the parameters
-    def to_openapi_requestbody(self, service):
+    def to_openapi_requestbody(self, service, spec):
         return {
             "content": {
                 "application/json": {"schema": self.to_json_schema(service, "input")}
             }
         }
 
-    def to_openapi_responses(self, service):
+    def to_openapi_responses(self, service, spec):
         return {
             "200": {
                 "content": {

base_rest_demo/__init__.py

@@ -1,3 +1,4 @@
 from . import controllers
 from . import datamodels
+from . import pydantic_models
 from . import services

base_rest_demo/__manifest__.py

@@ -11,9 +11,17 @@
     "author": "ACSONE SA/NV, " "Odoo Community Association (OCA)",
     "maintainers": ["lmignon"],
     "website": "https://github.com/OCA/rest-framework",
-    "depends": ["base_rest", "base_rest_datamodel", "component"],
+    "depends": [
+        "base_rest",
+        "base_rest_datamodel",
+        "base_rest_pydantic",
+        "component",
+        "extendable",
+    ],
     "data": [],
     "demo": [],
-    "external_dependencies": {"python": ["jsondiff"]},
+    "external_dependencies": {
+        "python": ["jsondiff", "extendable-pydantic", "pydantic"]
+    },
     "installable": True,
 }