feat chaotic: use pydantic in jsonschema

commit_hash:aef03af9688103b900014af98aa4c9e47b9ec34d

Author: segoon

.mapping.json

@@ -191,6 +191,7 @@
   "chaotic/chaotic/cpp_names.py":"taxi/uservices/userver/chaotic/chaotic/cpp_names.py",
   "chaotic/chaotic/error.py":"taxi/uservices/userver/chaotic/chaotic/error.py",
   "chaotic/chaotic/front/__init__.py":"taxi/uservices/userver/chaotic/chaotic/front/__init__.py",
+  "chaotic/chaotic/front/base_model.py":"taxi/uservices/userver/chaotic/chaotic/front/base_model.py",
   "chaotic/chaotic/front/parser.py":"taxi/uservices/userver/chaotic/chaotic/front/parser.py",
   "chaotic/chaotic/front/ref.py":"taxi/uservices/userver/chaotic/chaotic/front/ref.py",
   "chaotic/chaotic/front/ref_resolver.py":"taxi/uservices/userver/chaotic/chaotic/front/ref_resolver.py",

chaotic-openapi/chaotic_openapi/front/base_model.py

@@ -1,29 +1,8 @@
-from typing import Any
-
 import pydantic
 
+from chaotic.front import base_model
 
-class BaseModel(pydantic.BaseModel):
-    model_config = pydantic.ConfigDict(extra='allow')
-    _model_userver_tags: list[str] = []
-
-    def model_post_init(self, context: Any) -> None:
-        super().model_post_init(context)
-
-        if not self.__pydantic_extra__:
-            return
-        for field in self.__pydantic_extra__:
-            if field.startswith('x-taxi-py3'):
-                continue
-            if field.startswith('x-taxi-go-'):
-                continue
-            if field.startswith('x-taxi-') or field.startswith('x-usrv-'):
-                assert field in self._model_userver_tags, f'Field {field} is not allowed in this context'
-                continue
-
-            if field.startswith('x-'):
-                continue
-            raise Exception(f'Unknown field "{field}"')
+BaseModel = base_model.BaseModel
 
 
 class XMiddlewares(pydantic.BaseModel):

chaotic-openapi/chaotic_openapi/front/errors.py

@@ -1,39 +1,10 @@
-import pydantic
+from chaotic.front import parser
 
-import chaotic.error
-
-ERROR_MESSAGES = {
-    'extra_forbidden': 'Extra fields are forbidden ({input})',
-    'missing': 'Required field "{field}" is missing',
-    'string_type': 'String type is expected, {input} is found',
-    'bool_type': 'Boolean type is expected, {input} is found',
-    'int_type': 'Integer type is expected, {input} is found',
-}
+ERROR_MESSAGES = parser.ERROR_MESSAGES
 
 
 def missing_field_msg(field: str) -> str:
     return ERROR_MESSAGES['missing'].format(field=field)
 
 
-def convert_error(full_filepath: str, schema_type: str, err: pydantic.ValidationError) -> chaotic.error.BaseError:
-    assert len(err.errors()) >= 1
-
-    # show only the first error
-    error = err.errors()[0]
-
-    if len(error['loc']) > 0:
-        # the last location is the missing field name
-        field = error['loc'][-1]
-    else:
-        field = ''
-
-    if error['type'] in ERROR_MESSAGES:
-        msg = ERROR_MESSAGES[error['type']].format(**error, field=field)
-    else:
-        msg = error['msg']
-    return chaotic.error.BaseError(
-        full_filepath=full_filepath,
-        infile_path='.'.join(map(str, error['loc'])),
-        schema_type=schema_type,
-        msg=msg,
-    )
+convert_error = parser.convert_error

chaotic-openapi/chaotic_openapi/front/model.py

@@ -1,6 +1,7 @@
 import dataclasses
 import enum
 from typing import Any
+from typing import Callable
 from typing import Optional
 from typing import Union
 
@@ -156,3 +157,45 @@ class Service:
     headers: dict[str, Parameter] = dataclasses.field(default_factory=dict)
     requestBodies: dict[str, list[RequestBody]] = dataclasses.field(default_factory=dict)
     security: dict[str, Security] = dataclasses.field(default_factory=dict)
+
+    # For tests only
+    def visit_all_schemas(
+        self,
+        callback: Callable[[types.Schema], None],
+    ) -> None:
+        def callback2(child: types.Schema, _: types.Schema) -> None:
+            callback(child)
+
+        def clear_response(response):
+            for body2 in response.content.values():
+                callback(body2.schema)
+                body2.schema.visit_children(callback2)
+            for header in response.headers.values():
+                callback(header.schema)
+                header.schema.visit_children(callback2)
+
+        for schema in self.schemas.values():
+            callback(schema)
+            schema.visit_children(callback2)
+        for body in self.requestBodies.values():
+            for b in body:
+                callback(b.schema)
+                b.schema.visit_children(callback2)
+        for response in self.responses.values():
+            clear_response(response)
+        for parameter in self.parameters.values():
+            callback(parameter.schema)
+            parameter.schema.visit_children(callback2)
+
+        for operation in self.operations:
+            if not isinstance(operation.requestBody, Ref):
+                for body3 in operation.requestBody:
+                    callback(body3.schema)
+                    body3.schema.visit_children(callback2)
+            for response2 in operation.responses.values():
+                if isinstance(response2, Ref):
+                    continue
+                clear_response(response2)
+            for parameter in operation.parameters:
+                callback(parameter.schema)
+                parameter.schema.visit_children(callback2)

chaotic-openapi/chaotic_openapi/front/openapi.py

@@ -47,7 +47,7 @@ class Header(base_model.BaseModel):
     deprecated: bool = False
     allowEmptyValue: bool = False
 
-    style: Optional[Style] = None
+    style: Optional[Style] = pydantic.Field(default=None, strict=False)
     explode: Optional[bool] = None
     allowReserved: bool = False
     schema_: Schema = pydantic.Field(alias='schema')
@@ -62,10 +62,10 @@ class MediaType(base_model.BaseModel):
     examples: dict[str, Any] = pydantic.Field(default_factory=dict)
     # encoding: dict[str, Encoding] = {}
 
-    _model_userver_tags: list[str] = [
-        'x-taxi-non-std-type-reason',
-        'x-usrv-non-std-type-reason',
-    ]
+    x_non_std_type_reason: Optional[str] = pydantic.Field(
+        default=None,
+        validation_alias=pydantic.AliasChoices('x-taxi-non-std-type-reason', 'x-usrv-non-std-type-reason'),
+    )
 
 
 # https://spec.openapis.org/oas/v3.0.0.html#reference-object
@@ -101,13 +101,13 @@ class QueryLogMode(str, enum.Enum):
 # https://spec.openapis.org/oas/v3.0.0.html#parameter-object
 class Parameter(base_model.BaseModel):
     name: str
-    in_: In = pydantic.Field(alias='in')
+    in_: In = pydantic.Field(alias='in', strict=False)
     description: Optional[str] = None
     required: bool = False
     deprecated: bool = False
     allowEmptyValue: bool = False
 
-    style: Optional[Style] = None
+    style: Optional[Style] = pydantic.Field(default=None, strict=False)
     explode: Optional[bool] = None
     allowReserved: bool = False
     schema_: Schema = pydantic.Field(alias='schema')
@@ -127,6 +127,7 @@ class Parameter(base_model.BaseModel):
     x_query_log_mode: QueryLogMode = pydantic.Field(
         default=QueryLogMode.show,
         validation_alias=pydantic.AliasChoices('x-taxi-query-log-mode', 'x-usrv-query-log-mode'),
+        strict=False,
     )
     x_explode_true_reason: str = pydantic.Field(
         default='',
@@ -201,10 +202,10 @@ class OAuthFlows(base_model.BaseModel):
 
 # https://spec.openapis.org/oas/v3.0.0.html#security-scheme-object
 class SecurityScheme(base_model.BaseModel):
-    type: SecurityType
+    type: SecurityType = pydantic.Field(strict=False)
     description: Optional[str] = None
     name: Optional[str] = None
-    in_: Optional[SecurityIn] = pydantic.Field(alias='in', default=None)
+    in_: Optional[SecurityIn] = pydantic.Field(alias='in', default=None, strict=False)
     scheme_: Optional[str] = pydantic.Field(alias='scheme', default=None)
     bearerFormat: Optional[str] = None
     flows: Optional[OAuthFlows] = None
@@ -273,6 +274,7 @@ class Operation(base_model.BaseModel):
     x_query_log_mode: QueryLogMode = pydantic.Field(
         default=QueryLogMode.show,
         validation_alias=pydantic.AliasChoices('x-taxi-query-log-mode', 'x-usrv-query-log-mode'),
+        strict=False,
     )
     x_client_codegen: bool = pydantic.Field(
         default=True,

chaotic-openapi/chaotic_openapi/front/parser.py

@@ -43,7 +43,7 @@ def parse_schema(self, schema: dict, full_filepath: str, full_vfilepath: str) ->
         try:
             parsed = parser(**schema)
         except pydantic.ValidationError as exc:
-            raise errors.convert_error(full_filepath, parser.schema_type(), exc) from None
+            raise errors.convert_error(self._state.full_filepath, '', parser.schema_type(), exc) from None
 
         self._append_schema(parsed)
 
@@ -636,11 +636,11 @@ def _parse_schema(self, schema: Any, infile_path: str, allow_file=False) -> Unio
 
         if isinstance(schema_ref, types.Ref):
             ref_ = types.Ref(
-                chaotic_parser.SchemaParser._normalize_ref(schema_ref.ref),
+                ref=chaotic_parser.SchemaParser._normalize_ref(schema_ref.ref),
                 indirect=schema_ref.indirect,
                 self_ref=schema_ref.self_ref,
             )
-            ref_._source_location = schema_ref._source_location  # type: ignore
+            ref_.source_location_ = schema_ref.source_location_
             return ref_
         else:
             return schema_ref

chaotic-openapi/chaotic_openapi/front/swagger.py

@@ -31,7 +31,7 @@ class In(str, enum.Enum):
 # https://spec.openapis.org/oas/v2.0.html#parameter-object
 class Parameter(base_model.BaseModel):
     name: str
-    in_: In = pydantic.Field(alias='in')
+    in_: In = pydantic.Field(alias='in', strict=False)
     description: str = ''
     required: bool = False
 
@@ -118,11 +118,11 @@ class OAuthFlow(str, enum.Enum):
 
 # https://spec.openapis.org/oas/v2.0.html#security-definitions-object
 class SecurityDef(base_model.BaseModel):
-    type: SecurityType
+    type: SecurityType = pydantic.Field(strict=False)
     description: Optional[str] = None
     name: Optional[str] = None
-    in_: Optional[SecurityIn] = pydantic.Field(alias='in', default=None)
-    flow: Optional[OAuthFlow] = None
+    in_: Optional[SecurityIn] = pydantic.Field(alias='in', default=None, strict=False)
+    flow: Optional[OAuthFlow] = pydantic.Field(default=None, strict=False)
     authorizationUrl: Optional[str] = None
     tokenUrl: Optional[str] = None
     scopes: dict[str, str] = pydantic.Field(default_factory=dict)

chaotic-openapi/tests/back/conftest.py

@@ -5,6 +5,9 @@
 
 @pytest.fixture
 def translate_single_schema():
+    def clear_source_location(schema):
+        schema.source_location_ = None
+
     def func(schema):
         parser = front_parser.Parser('test')
         parser.parse_schema(schema, '<inline>', '<inline>')
@@ -17,6 +20,7 @@ def func(schema):
             include_dirs=[],
             middleware_plugins=[],
         )
+        service.visit_all_schemas(clear_source_location)
         return tr.spec()
 
     return func

chaotic-openapi/tests/back/test_parameters.py

@@ -182,7 +182,7 @@ def test_parameters_schemas_ref(translate_single_schema):
                                 ref='<inline>#/components/schemas/Parameter',
                                 indirect=False,
                                 self_ref=False,
-                                schema=chaotic_types.Integer(
+                                schema_=chaotic_types.Integer(
                                     type='integer',
                                 ),
                             ),
@@ -217,7 +217,7 @@ def test_parameters_schemas_ref(translate_single_schema):
                     ref='<inline>#/components/schemas/Parameter',
                     indirect=False,
                     self_ref=False,
-                    schema=chaotic_types.Integer(
+                    schema_=chaotic_types.Integer(
                         type='integer',
                         default=None,
                         nullable=False,

chaotic-openapi/tests/front/conftest.py

@@ -4,9 +4,13 @@
 
 @pytest.fixture
 def simple_parser():
+    def clear_source_location(schema):
+        schema.source_location_ = None
+
     def _simple_parser(schema):
         parser = front_parser.Parser('test')
         parser.parse_schema(schema, '<inline>', '<inline>')
+        parser.service().visit_all_schemas(clear_source_location)
         return parser.service()
 
     return _simple_parser