Schema-First 0.3.0__tar.gz

schema_first-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 flask-pro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

schema_first-0.3.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: Schema-First
+Version: 0.3.0
+Summary: OpenAPI specification validator and converter to Marshmallow schemas.
+Author-email: Konstantin Fadeev <fadeev@legalact.pro>
+License: MIT License
+        
+        Copyright (c) 2025 flask-pro
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: changelog, https://github.com/flask-pro/schema-first/blob/master/CHANGES.md
+Project-URL: repository, https://github.com/flask-pro/schema-first
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: marshmallow>=4.0.0
+Requires-Dist: PyYAML>=6.0.2
+Provides-Extra: dev
+Requires-Dist: bandit==1.8.6; extra == "dev"
+Requires-Dist: build==1.2.1; extra == "dev"
+Requires-Dist: openapi-spec-validator>=0.5.0; extra == "dev"
+Requires-Dist: pre-commit==4.2.0; extra == "dev"
+Requires-Dist: pytest==8.4.1; extra == "dev"
+Requires-Dist: pytest-cov==6.2.1; extra == "dev"
+Requires-Dist: python-dotenv==1.1.1; extra == "dev"
+Requires-Dist: twine==6.1.0; extra == "dev"
+Dynamic: license-file
+
+# Schema-First
+
+Validate and convert OpenAPI specification via Marshmallow schemas to Marshmallow schemas.
+
+<!--TOC-->
+
+- [Schema-First](#schema-first)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Example](#example)
+  - [Additional documentation](#additional-documentation)
+
+<!--TOC-->
+
+## Features
+
+* OpenAPI specification validate.
+* Convert OpenAPI schemas to Marshmallow schemas.
+
+## Installation
+
+Recommended using the latest version of Python. Schema-First supports Python 3.14 and newer.
+
+Install and update using `pip`:
+
+```shell
+$ pip install -U schema_first
+```
+
+## Example
+
+Create specification - `openapi.yaml`:
+```yaml
+openapi: 3.1.1
+info:
+    title: Example API for testing Flask-First
+    version: 1.0.1
+paths:
+    /endpoint:
+        get:
+            operationId: endpoint
+            responses:
+                '200':
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    message:
+                                        type: string
+                                type: object
+                    description: OK
+
+
+```
+Create script - `main.py`:
+```python
+from pathlib import Path
+from pprint import pprint
+
+from schema_first.specification import Specification
+
+spec_file = Path('openapi.yaml')
+spec = Specification(spec_file)
+spec.load()
+
+pprint(spec.reassembly_spec)
+print(
+    'Marshmallow schema generated from OpenAPI schema',
+    spec.reassembly_spec['paths']['/endpoint']['get']['responses']['200']['content'][
+        'application/json'
+    ]['schema'],
+)
+
+```
+
+More example see to `./example` folder.
+
+## Additional documentation
+
+* [OpenAPI Documentation](https://swagger.io/specification/).
+* [OpenAPI on GitHub](https://github.com/OAI/OpenAPI-Specification).
+* [JSON Schema Documentation](https://json-schema.org/specification.html).

schema_first-0.3.0/README.md

@@ -0,0 +1,82 @@
+# Schema-First
+
+Validate and convert OpenAPI specification via Marshmallow schemas to Marshmallow schemas.
+
+<!--TOC-->
+
+- [Schema-First](#schema-first)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Example](#example)
+  - [Additional documentation](#additional-documentation)
+
+<!--TOC-->
+
+## Features
+
+* OpenAPI specification validate.
+* Convert OpenAPI schemas to Marshmallow schemas.
+
+## Installation
+
+Recommended using the latest version of Python. Schema-First supports Python 3.14 and newer.
+
+Install and update using `pip`:
+
+```shell
+$ pip install -U schema_first
+```
+
+## Example
+
+Create specification - `openapi.yaml`:
+```yaml
+openapi: 3.1.1
+info:
+    title: Example API for testing Flask-First
+    version: 1.0.1
+paths:
+    /endpoint:
+        get:
+            operationId: endpoint
+            responses:
+                '200':
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    message:
+                                        type: string
+                                type: object
+                    description: OK
+
+
+```
+Create script - `main.py`:
+```python
+from pathlib import Path
+from pprint import pprint
+
+from schema_first.specification import Specification
+
+spec_file = Path('openapi.yaml')
+spec = Specification(spec_file)
+spec.load()
+
+pprint(spec.reassembly_spec)
+print(
+    'Marshmallow schema generated from OpenAPI schema',
+    spec.reassembly_spec['paths']['/endpoint']['get']['responses']['200']['content'][
+        'application/json'
+    ]['schema'],
+)
+
+```
+
+More example see to `./example` folder.
+
+## Additional documentation
+
+* [OpenAPI Documentation](https://swagger.io/specification/).
+* [OpenAPI on GitHub](https://github.com/OAI/OpenAPI-Specification).
+* [JSON Schema Documentation](https://json-schema.org/specification.html).

schema_first-0.3.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools>=42", "wheel"]
+
+[project]
+authors = [
+  {name = "Konstantin Fadeev", email = "fadeev@legalact.pro"}
+]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3"
+]
+dependencies = [
+  'marshmallow>=4.0.0',
+  'PyYAML>=6.0.2'
+]
+description = "OpenAPI specification validator and converter to Marshmallow schemas."
+license = {file = "LICENSE"}
+name = "Schema-First"
+readme = "README.md"
+requires-python = ">=3.14"
+version = "0.3.0"
+
+[project.optional-dependencies]
+dev = [
+  "bandit==1.8.6",
+  "build==1.2.1",
+  'openapi-spec-validator>=0.5.0',
+  "pre-commit==4.2.0",
+  "pytest==8.4.1",
+  "pytest-cov==6.2.1",
+  "python-dotenv==1.1.1",
+  "twine==6.1.0"
+]
+
+[project.urls]
+changelog = "https://github.com/flask-pro/schema-first/blob/master/CHANGES.md"
+repository = "https://github.com/flask-pro/schema-first"
+
+[tool.black]
+extend-exclude = '''
+# A regex preceded with ^/ will apply only to files and directories
+# in the root of the project.
+^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
+'''
+include = '\.pyi?$'
+line-length = 100
+skip-string-normalization = true
+target-version = ['py313']
+
+[tool.isort]
+profile = "google"
+src_paths = ["src", "tests"]
+
+[tool.pycln]
+all = true
+silence = true
+
+[tool.setuptools.packages.find]
+include = ["schema_first*"]
+where = ["src"]

schema_first-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

schema_first-0.3.0/src/Schema_First.egg-info/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: Schema-First
+Version: 0.3.0
+Summary: OpenAPI specification validator and converter to Marshmallow schemas.
+Author-email: Konstantin Fadeev <fadeev@legalact.pro>
+License: MIT License
+        
+        Copyright (c) 2025 flask-pro
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: changelog, https://github.com/flask-pro/schema-first/blob/master/CHANGES.md
+Project-URL: repository, https://github.com/flask-pro/schema-first
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: marshmallow>=4.0.0
+Requires-Dist: PyYAML>=6.0.2
+Provides-Extra: dev
+Requires-Dist: bandit==1.8.6; extra == "dev"
+Requires-Dist: build==1.2.1; extra == "dev"
+Requires-Dist: openapi-spec-validator>=0.5.0; extra == "dev"
+Requires-Dist: pre-commit==4.2.0; extra == "dev"
+Requires-Dist: pytest==8.4.1; extra == "dev"
+Requires-Dist: pytest-cov==6.2.1; extra == "dev"
+Requires-Dist: python-dotenv==1.1.1; extra == "dev"
+Requires-Dist: twine==6.1.0; extra == "dev"
+Dynamic: license-file
+
+# Schema-First
+
+Validate and convert OpenAPI specification via Marshmallow schemas to Marshmallow schemas.
+
+<!--TOC-->
+
+- [Schema-First](#schema-first)
+  - [Features](#features)
+  - [Installation](#installation)
+  - [Example](#example)
+  - [Additional documentation](#additional-documentation)
+
+<!--TOC-->
+
+## Features
+
+* OpenAPI specification validate.
+* Convert OpenAPI schemas to Marshmallow schemas.
+
+## Installation
+
+Recommended using the latest version of Python. Schema-First supports Python 3.14 and newer.
+
+Install and update using `pip`:
+
+```shell
+$ pip install -U schema_first
+```
+
+## Example
+
+Create specification - `openapi.yaml`:
+```yaml
+openapi: 3.1.1
+info:
+    title: Example API for testing Flask-First
+    version: 1.0.1
+paths:
+    /endpoint:
+        get:
+            operationId: endpoint
+            responses:
+                '200':
+                    content:
+                        application/json:
+                            schema:
+                                properties:
+                                    message:
+                                        type: string
+                                type: object
+                    description: OK
+
+
+```
+Create script - `main.py`:
+```python
+from pathlib import Path
+from pprint import pprint
+
+from schema_first.specification import Specification
+
+spec_file = Path('openapi.yaml')
+spec = Specification(spec_file)
+spec.load()
+
+pprint(spec.reassembly_spec)
+print(
+    'Marshmallow schema generated from OpenAPI schema',
+    spec.reassembly_spec['paths']['/endpoint']['get']['responses']['200']['content'][
+        'application/json'
+    ]['schema'],
+)
+
+```
+
+More example see to `./example` folder.
+
+## Additional documentation
+
+* [OpenAPI Documentation](https://swagger.io/specification/).
+* [OpenAPI on GitHub](https://github.com/OAI/OpenAPI-Specification).
+* [JSON Schema Documentation](https://json-schema.org/specification.html).

schema_first-0.3.0/src/Schema_First.egg-info/SOURCES.txt

@@ -0,0 +1,36 @@
+LICENSE
+README.md
+pyproject.toml
+src/Schema_First.egg-info/PKG-INFO
+src/Schema_First.egg-info/SOURCES.txt
+src/Schema_First.egg-info/dependency_links.txt
+src/Schema_First.egg-info/requires.txt
+src/Schema_First.egg-info/top_level.txt
+src/schema_first/__init__.py
+src/schema_first/exceptions.py
+src/schema_first/loaders/__init__.py
+src/schema_first/loaders/exc.py
+src/schema_first/loaders/yaml_loader.py
+src/schema_first/openapi/__init__.py
+src/schema_first/openapi/exc.py
+src/schema_first/openapi/schemas/__init__.py
+src/schema_first/openapi/schemas/base.py
+src/schema_first/openapi/schemas/constants.py
+src/schema_first/openapi/schemas/fields.py
+src/schema_first/openapi/schemas/v3_1_1/components_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/contact_schema.py
+src/schema_first/openapi/schemas/v3_1_1/info_schema.py
+src/schema_first/openapi/schemas/v3_1_1/license_schema.py
+src/schema_first/openapi/schemas/v3_1_1/media_type_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/operation_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/path_item_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/reference_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/request_body_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/responses_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/root_schema.py
+src/schema_first/openapi/schemas/v3_1_1/schema_object_schema.py
+src/schema_first/openapi/schemas/v3_1_1/server_schema.py
+src/schema_first/openapi/schemas/v3_1_1/server_variable_object_schema.py
+src/schema_first/specification/__init__.py
+tests/test_specification.py
+tests/test_validator.py

schema_first-0.3.0/src/Schema_First.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

schema_first-0.3.0/src/Schema_First.egg-info/requires.txt

@@ -0,0 +1,12 @@
+marshmallow>=4.0.0
+PyYAML>=6.0.2
+
+[dev]
+bandit==1.8.6
+build==1.2.1
+openapi-spec-validator>=0.5.0
+pre-commit==4.2.0
+pytest==8.4.1
+pytest-cov==6.2.1
+python-dotenv==1.1.1
+twine==6.1.0

schema_first-0.3.0/src/Schema_First.egg-info/top_level.txt

@@ -0,0 +1 @@
+schema_first

schema_first-0.3.0/src/schema_first/__init__.py

@@ -0,0 +1,3 @@
+from .specification import Specification
+
+__all__ = ['Specification']

schema_first-0.3.0/src/schema_first/exceptions.py

@@ -0,0 +1,2 @@
+class SchemaFirstException(Exception):
+    """Common exception."""

schema_first-0.3.0/src/schema_first/loaders/__init__.py

@@ -0,0 +1,3 @@
+from .yaml_loader import load_from_yaml
+
+__all__ = ['load_from_yaml']

schema_first-0.3.0/src/schema_first/loaders/exc.py

@@ -0,0 +1,9 @@
+from ..exceptions import SchemaFirstException
+
+
+class YAMLReaderError(SchemaFirstException):
+    """Exception for yaml file loading error."""
+
+
+class ResolverError(SchemaFirstException):
+    """Exception for specification from yaml file resolver error."""

schema_first-0.3.0/src/schema_first/loaders/yaml_loader.py

@@ -0,0 +1,143 @@
+from collections.abc import Hashable
+from copy import deepcopy
+from functools import reduce
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from .exc import ResolverError
+from .exc import YAMLReaderError
+
+
+class YAMLReader:
+    """
+    Open OpenAPI specification from yaml file. The specification from multiple files is supported.
+    """
+
+    def __init__(self, path: Path):
+        self.path = path
+        self.root_file_name = self.path.name
+        self.store = {}
+
+    @staticmethod
+    def _yaml_to_dict(path: Path) -> dict:
+        with open(path) as f:
+            s = yaml.safe_load(f)
+        return s
+
+    def add_file_to_store(self, file_path: str) -> None:
+        path_to_spec_file = Path(self.path.parent, file_path)
+
+        try:
+            self.store[file_path] = self._yaml_to_dict(path_to_spec_file)
+        except FileNotFoundError:
+            raise YAMLReaderError(f'No such file or directory: <{file_path}>')
+
+        return self.store[file_path]
+
+    def search_file(self, obj: dict or list) -> None:
+        if isinstance(obj, dict):
+            ref = obj.get('$ref')
+            if ref:
+                try:
+                    file_path, _ = ref.split('#/')
+                except (AttributeError, ValueError):
+                    raise YAMLReaderError(f'"$ref" with value <{ref}> is not valid.')
+
+                if file_path and file_path not in self.store:
+                    self.search_file(self.add_file_to_store(file_path))
+            else:
+                for _, v in obj.items():
+                    self.search_file(v)
+
+        elif isinstance(obj, list):
+            for item in obj:
+                self.search_file(item)
+
+        else:
+            return
+
+    def load(self) -> 'YAMLReader':
+        root_file = self._yaml_to_dict(self.path)
+        self.store[self.root_file_name] = root_file
+        self.search_file(root_file)
+        return self
+
+
+class RefResolver:
+    """Resolve links to various parts of the specification."""
+
+    def __init__(self, yaml_reader: YAMLReader):
+        self.yaml_reader = yaml_reader
+        self.resolved_spec = None
+
+    def _get_schema_via_local_ref(self, file_path: str, node_path: str) -> dict:
+        keys = node_path.split('/')
+
+        def get_value_of_key_from_dict(source_dict: dict, key: Hashable) -> Any:
+            return source_dict[key]
+
+        try:
+            return deepcopy(
+                reduce(get_value_of_key_from_dict, keys, self.yaml_reader.store[file_path])
+            )
+        except KeyError:
+            raise ResolverError(f'No such path: "{node_path}"')
+
+    def _get_schema(self, root_file_name: str, file_path: str or None, node_path: str) -> Any:
+        if file_path and node_path:
+            obj = self._get_schema_via_local_ref(file_path, node_path)
+
+        elif node_path and not file_path:
+            obj = self._get_schema_via_local_ref(root_file_name, node_path)
+
+        else:
+            raise NotImplementedError
+
+        return obj
+
+    def _resolving_all_refs(self, file_path: str, obj: Any) -> Any:
+        if isinstance(obj, dict):
+            ref = obj.get('$ref', ...)
+            if ref is not ...:
+                try:
+                    file_path_from_ref, node_path = ref.split('#/')
+                except (AttributeError, ValueError):
+                    raise ResolverError(
+                        f'"$ref" with value <{ref}> is not valid in file <{file_path}>'
+                    )
+
+                if file_path_from_ref:
+                    obj = self._resolving_all_refs(
+                        file_path_from_ref,
+                        self._get_schema(file_path, file_path_from_ref, node_path),
+                    )
+                else:
+                    obj = self._resolving_all_refs(
+                        file_path, self._get_schema(file_path, file_path_from_ref, node_path)
+                    )
+
+            else:
+                for key, value in obj.items():
+                    obj[key] = self._resolving_all_refs(file_path, value)
+
+        if isinstance(obj, list):
+            objs = []
+            for item_obj in obj:
+                objs.append(self._resolving_all_refs(file_path, item_obj))
+            obj = objs
+
+        return obj
+
+    def resolving(self) -> 'RefResolver':
+        root_file_path = self.yaml_reader.root_file_name
+        root_spec = self.yaml_reader.store[root_file_path]
+        self.resolved_spec = self._resolving_all_refs(root_file_path, root_spec)
+        return self
+
+
+def load_from_yaml(path: Path) -> dict:
+    yaml_reader = YAMLReader(path).load()
+    resolved_obj = RefResolver(yaml_reader).resolving()
+    return resolved_obj.resolved_spec

schema_first-0.3.0/src/schema_first/openapi/__init__.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+
+from marshmallow import ValidationError
+
+from ..loaders.yaml_loader import load_from_yaml
+from .exc import OpenAPIValidationError
+from .schemas.v3_1_1.root_schema import RootSchema
+
+
+class OpenAPI:
+    def __init__(self, path: Path or str):
+        self.path = path
+        self.raw_spec = load_from_yaml(self.path)
+
+    def load(self) -> dict:
+        try:
+            return RootSchema().load(self.raw_spec)
+        except ValidationError as e:
+            raise OpenAPIValidationError(e)

schema_first-0.3.0/src/schema_first/openapi/exc.py

@@ -0,0 +1,5 @@
+from ..exceptions import SchemaFirstException
+
+
+class OpenAPIValidationError(SchemaFirstException):
+    """OpenAPI specification validation error."""

schema_first-0.3.0/src/schema_first/openapi/schemas/base.py

@@ -0,0 +1,20 @@
+from marshmallow import RAISE
+from marshmallow import Schema
+from marshmallow import validates_schema
+from marshmallow import ValidationError
+
+
+class BaseSchema(Schema):
+    class Meta:
+        unknown = RAISE
+
+    @validates_schema
+    def validate_ref(self, data, **kwargs) -> None:
+        if 'ref' in data:
+            ALLOWED_FIELDS = {'ref', 'description', 'summary'}
+            ALL_FIELDS = set(data.keys())
+            if ALL_FIELDS.difference(ALLOWED_FIELDS):
+                raise ValidationError(
+                    f"If there is a <'ref'> field, then only <{ALLOWED_FIELDS}>,"
+                    f" but set <{ALL_FIELDS}>"
+                )

schema_first-0.3.0/src/schema_first/openapi/schemas/constants.py

@@ -0,0 +1,5 @@
+OPENAPI_VERSION = '3.1.1'
+TYPES = ('array', 'boolean', 'integer', 'number', 'object', 'string')
+FORMATS = ('uuid', 'date-time', 'date', 'time', 'email', 'ipv4', 'ipv6', 'uri', 'binary')
+RE_VERSION = r'^[0-9]+.[0-9]+.[0-9]+$'
+RE_SERVER_URL = r'^((http|https)://)|(/)*$'

schema_first-0.3.0/src/schema_first/openapi/schemas/fields.py

@@ -0,0 +1,12 @@
+from marshmallow import fields
+from marshmallow import validate
+
+ENDPOINT_FIELD = fields.String(required=True, validate=validate.Regexp(r'^[/][0-9a-z-{}/]*[^/]$'))
+HTTP_CODE_FIELD = fields.String(required=True, validate=validate.Regexp(r'^[1-5]{1}\d{2}|default$'))
+SUMMARY_FIELD = fields.String()
+DESCRIPTION_FIELD = fields.String()
+REQUIRED_DESCRIPTION_FIELD = fields.String(required=True)
+MEDIA_TYPE_FIELD = fields.String(required=True)
+REF_FIELD = fields.String(
+    required=True, data_key='$ref', validate=validate.Regexp(r'^#/[a-zA-Z/]*$')
+)

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/components_object_schema.py

@@ -0,0 +1,14 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from .responses_object_schema import ResponsesObjectSchema
+from .schema_object_schema import SchemaObjectSchema
+
+
+class ComponentsObjectSchema(BaseSchema):
+    responses = fields.Dict(
+        keys=fields.String(), values=fields.Nested(ResponsesObjectSchema, required=True)
+    )
+    schemas = fields.Dict(
+        keys=fields.String(), values=fields.Nested(SchemaObjectSchema, required=True)
+    )

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/contact_schema.py

@@ -0,0 +1,9 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+
+
+class ContactSchema(BaseSchema):
+    name = fields.String()
+    url = fields.URL()
+    email = fields.Email()

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/info_schema.py

@@ -0,0 +1,21 @@
+from marshmallow import fields
+from marshmallow import validate
+
+from ..base import BaseSchema
+from ..constants import RE_VERSION
+from ..fields import DESCRIPTION_FIELD
+from ..fields import SUMMARY_FIELD
+from .contact_schema import ContactSchema
+from .license_schema import LicenseSchema
+
+
+class InfoSchema(BaseSchema):
+    title = fields.String(required=True)
+    version = fields.String(required=True, validate=validate.Regexp(RE_VERSION))
+
+    summary = SUMMARY_FIELD
+    description = DESCRIPTION_FIELD
+    terms_of_service = fields.String(data_key='termsOfService')
+
+    contact = fields.Nested(ContactSchema)
+    license = fields.Nested(LicenseSchema)

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/license_schema.py

@@ -0,0 +1,19 @@
+from marshmallow import fields
+from marshmallow import validates_schema
+from marshmallow import ValidationError
+
+from ..base import BaseSchema
+
+
+class LicenseSchema(BaseSchema):
+    name = fields.String(required=True)
+
+    identifier = fields.String()
+    url = fields.URL()
+
+    @validates_schema
+    def validate_exclusive(self, data, **kwargs) -> None:
+        if 'identifier' in data and 'url' in data:
+            raise ValidationError(
+                'The <identifier> field is mutually exclusive of the <url> field.'
+            )

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/media_type_object_schema.py

@@ -0,0 +1,8 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from .schema_object_schema import SchemaObjectSchema
+
+
+class MediaTypeObjectSchema(BaseSchema):
+    schema = fields.Nested(SchemaObjectSchema)

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/operation_object_schema.py

@@ -0,0 +1,12 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from ..fields import HTTP_CODE_FIELD
+from .request_body_object_schema import RequestBodyObject
+from .responses_object_schema import ResponsesObjectSchema
+
+
+class OperationObjectSchema(BaseSchema):
+    operation_id = fields.String(data_key='operationId')
+    requestBody = fields.Nested(RequestBodyObject)
+    responses = fields.Dict(keys=HTTP_CODE_FIELD, values=fields.Nested(ResponsesObjectSchema))

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/path_item_object_schema.py

@@ -0,0 +1,9 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from .operation_object_schema import OperationObjectSchema
+
+
+class PathItemObjectSchema(BaseSchema):
+    get = fields.Nested(OperationObjectSchema)
+    post = fields.Nested(OperationObjectSchema)

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/reference_object_schema.py

@@ -0,0 +1,8 @@
+from schema_first.openapi.schemas._base import BaseSchema
+from schema_first.openapi.schemas._fields import DESCRIPTION_FIELD
+from schema_first.openapi.schemas._fields import REF_FIELD
+
+
+class ReferenceObjectSchema(BaseSchema):
+    description = DESCRIPTION_FIELD
+    ref = REF_FIELD

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/request_body_object_schema.py

@@ -0,0 +1,11 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from ..fields import DESCRIPTION_FIELD
+from ..fields import MEDIA_TYPE_FIELD
+from .media_type_object_schema import MediaTypeObjectSchema
+
+
+class RequestBodyObject(BaseSchema):
+    description = DESCRIPTION_FIELD
+    content = fields.Dict(keys=MEDIA_TYPE_FIELD, values=fields.Nested(MediaTypeObjectSchema))

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/responses_object_schema.py

@@ -0,0 +1,11 @@
+from marshmallow import fields
+
+from ..base import BaseSchema
+from ..fields import DESCRIPTION_FIELD
+from ..fields import MEDIA_TYPE_FIELD
+from .media_type_object_schema import MediaTypeObjectSchema
+
+
+class ResponsesObjectSchema(BaseSchema):
+    description = DESCRIPTION_FIELD
+    content = fields.Dict(keys=MEDIA_TYPE_FIELD, values=fields.Nested(MediaTypeObjectSchema))

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/root_schema.py

@@ -0,0 +1,25 @@
+from marshmallow import fields
+from marshmallow import validate
+
+from ..base import BaseSchema
+from ..constants import OPENAPI_VERSION
+from ..fields import ENDPOINT_FIELD
+from .components_object_schema import ComponentsObjectSchema
+from .info_schema import InfoSchema
+from .path_item_object_schema import PathItemObjectSchema
+from .server_schema import ServerSchema
+
+
+class RootSchema(BaseSchema):
+    openapi = fields.String(required=True, validate=validate.Equal(OPENAPI_VERSION))
+    info = fields.Nested(InfoSchema, required=True)
+    paths = fields.Dict(
+        required=True,
+        keys=ENDPOINT_FIELD,
+        values=fields.Nested(PathItemObjectSchema, required=True),
+    )
+
+    jsonSchemaDialect = fields.URL()
+
+    servers = fields.Nested(ServerSchema, many=True)
+    components = fields.Nested(ComponentsObjectSchema)

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/schema_object_schema.py

@@ -0,0 +1,17 @@
+from marshmallow import fields
+from marshmallow import validate
+
+from ..base import BaseSchema
+from ..constants import FORMATS
+from ..constants import TYPES
+
+
+class SchemaObjectSchema(BaseSchema):
+    type = fields.String(required=True, validate=validate.OneOf(TYPES))
+
+    format = fields.String(validate=validate.OneOf(FORMATS))
+    pattern = fields.String()
+
+    properties = fields.Dict(
+        keys=fields.String(required=True), values=fields.Nested(lambda: SchemaObjectSchema())
+    )

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/server_schema.py

@@ -0,0 +1,19 @@
+from marshmallow import fields
+from marshmallow import validate
+
+from ..base import BaseSchema
+from ..constants import RE_SERVER_URL
+from ..fields import DESCRIPTION_FIELD
+from .server_variable_object_schema import ServerVariableObjectSchema
+
+
+class ServerSchema(BaseSchema):
+    url = fields.String(
+        required=True, validate=[validate.Regexp(RE_SERVER_URL), validate.Length(min=1)]
+    )
+
+    description = DESCRIPTION_FIELD
+
+    variables = fields.Dict(
+        keys=fields.String(), values=fields.Nested(ServerVariableObjectSchema, required=True)
+    )

schema_first-0.3.0/src/schema_first/openapi/schemas/v3_1_1/server_variable_object_schema.py

@@ -0,0 +1,12 @@
+from marshmallow import fields
+from marshmallow import validate
+
+from ..base import BaseSchema
+from ..fields import DESCRIPTION_FIELD
+
+
+class ServerVariableObjectSchema(BaseSchema):
+    default = fields.String(required=True, validate=[validate.Length(min=1)])
+
+    enum = fields.List(fields.String(validate=[validate.Length(min=1)]))
+    description = DESCRIPTION_FIELD

schema_first-0.3.0/src/schema_first/specification/__init__.py

@@ -0,0 +1,47 @@
+from copy import deepcopy
+from pathlib import Path
+from typing import Any
+
+from marshmallow import fields
+from marshmallow import Schema
+
+from ..openapi import OpenAPI
+
+FIELDS_VIA_TYPES = {
+    'boolean': fields.Boolean,
+    'number': fields.Float,
+    'string': fields.String,
+    'integer': fields.Integer,
+}
+
+
+class Specification:
+    def __init__(self, spec_file: Path | str):
+        self.openapi = OpenAPI(spec_file)
+        self.reassembly_spec = None
+
+    def _convert_from_openapi_to_marshmallow_schema(self, open_api_schema: dict) -> type[Schema]:
+        if open_api_schema['type'] == 'object':
+            marshmallow_schema = {}
+            for field_name, field in open_api_schema['properties'].items():
+                marshmallow_schema[field_name] = FIELDS_VIA_TYPES[field['type']]()
+        else:
+            raise NotImplementedError(open_api_schema)
+
+        return Schema.from_dict(marshmallow_schema)
+
+    def _reassembly_of_schemas(self, obj: Any) -> Any:
+        if isinstance(obj, dict):
+            for k, v in obj.items():
+                if k == 'schema':
+                    obj[k] = self._convert_from_openapi_to_marshmallow_schema(v)
+                else:
+                    self._reassembly_of_schemas(v)
+
+    def load(self) -> 'Specification':
+        self.openapi.load()
+        self.reassembly_spec = deepcopy(self.openapi.raw_spec)
+
+        self._reassembly_of_schemas(self.reassembly_spec)
+
+        return self

schema_first-0.3.0/tests/test_specification.py

@@ -0,0 +1,33 @@
+from marshmallow import fields
+
+from src.schema_first.openapi import OpenAPI
+from src.schema_first.specification import Specification
+from tests.utils import get_schema_from_request
+
+
+def test_specification__minimal(fx_spec_minimal, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_minimal)
+    spec = Specification(spec_file)
+
+    assert isinstance(spec.openapi, OpenAPI)
+    assert spec.reassembly_spec is None
+
+    spec.load()
+
+    request_schema = get_schema_from_request(spec.reassembly_spec, '/endpoint', '200')
+    assert isinstance(request_schema().fields['message'], fields.String)
+    assert request_schema().load({'message': 'Valid string'})
+
+
+def test_specification__full(fx_spec_full, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_full)
+    spec = Specification(spec_file)
+
+    assert isinstance(spec.openapi, OpenAPI)
+    assert spec.reassembly_spec is None
+
+    spec.load()
+
+    request_schema = get_schema_from_request(spec.reassembly_spec, '/endpoint', '200')
+    assert isinstance(request_schema().fields['message'], fields.String)
+    assert request_schema().load({'message': 'Valid string'})

schema_first-0.3.0/tests/test_validator.py

@@ -0,0 +1,41 @@
+import pytest
+
+from src.schema_first.openapi import OpenAPI
+from src.schema_first.openapi import OpenAPIValidationError
+
+
+def test_validator_minimal(fx_spec_minimal, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_minimal)
+    open_api_spec = OpenAPI(spec_file)
+    open_api_spec.load()
+    assert open_api_spec.raw_spec == fx_spec_minimal
+
+
+def test_validator__full(fx_spec_full, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_full)
+    open_api_spec = OpenAPI(spec_file)
+    open_api_spec.load()
+    assert open_api_spec.raw_spec == fx_spec_full
+
+
+def test_validator__minimal__external_validator(fx_spec_minimal, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_minimal, external_validator=True)
+    open_api_spec = OpenAPI(spec_file)
+    open_api_spec.load()
+
+
+def test_validator__full__external_validator(fx_spec_full, fx_spec_as_file):
+    spec_file = fx_spec_as_file(fx_spec_full, external_validator=True)
+    open_api_spec = OpenAPI(spec_file)
+    open_api_spec.load()
+
+
+def test_validator__wrong_field_name(fx_spec_minimal, fx_spec_as_file):
+    fx_spec_minimal['wrong_field_name'] = 'wrong'
+
+    spec_file = fx_spec_as_file(fx_spec_minimal)
+
+    open_api_spec = OpenAPI(spec_file)
+
+    with pytest.raises(OpenAPIValidationError):
+        open_api_spec.load()