Merge pull request #10 from starlite-api/refactor-remove-303

Removes the `v3_0_3` sub-package.

Author: peterschutt

CHANGELOG.md

@@ -1,17 +1,21 @@
 # Changelog
 
-[v1.0.0]
+[v1.1.0]
 
-- initial release.
+- removes `v3_0_3`.
 
-[v1.0.1]
+[v1.0.3]
 
-- update handling of `email` to allow `str`.
+- update dependencies and docstrings.
 
 [v1.0.2]
 
 - update typing of `email`.
 
-[v1.0.3]
+[v1.0.1]
 
-- update dependencies and docstrings.
+- update handling of `email` to allow `str`.
+
+[v1.0.0]
+
+- initial release.

docs/index.md

@@ -31,6 +31,7 @@ In comparison to the original library this library has:
 4. updated utilities
 5. updated export paths
 6. continuous maintenance
+7. dropped support for v3.0.3
 
 Use is mostly identical to upstream package.
 

poetry.lock

@@ -1,8 +1,7 @@
-from . import v3_0_3, v3_1_0
+from . import v3_1_0
 from .utils import construct_open_api_with_schema_class
 
 __all__ = [
-    "v3_0_3",
     "v3_1_0",
     "construct_open_api_with_schema_class",
 ]

pydantic_openapi_schema/__init__.py

@@ -1,23 +1,16 @@
-from typing import TYPE_CHECKING, Any, List, Optional, Set, Type, TypeVar, Union, cast
+from typing import TYPE_CHECKING, Any, List, Optional, Set, Type, TypeVar, cast
 
 from pydantic import BaseModel
 from pydantic.schema import schema
 
-from pydantic_openapi_schema import v3_0_3, v3_1_0
+from pydantic_openapi_schema import v3_1_0
 
 if TYPE_CHECKING:
     from typing import Dict
 
 REF_PREFIX = "#/components/schemas/"
 
-T = TypeVar("T", bound=Union[v3_0_3.OpenAPI, v3_1_0.OpenAPI])
-
-
-class OpenAPI303PydanticSchema(v3_0_3.Schema):
-    """Special `Schema` class to indicate a reference from pydantic class."""
-
-    schema_class: Type[BaseModel]
-    """the class that is used for generate the schema"""
+T = TypeVar("T", bound=v3_1_0.OpenAPI)
 
 
 class OpenAPI310PydanticSchema(v3_1_0.Schema):
@@ -38,7 +31,7 @@ def construct_open_api_with_schema_class(
 
     Args:
         open_api_schema: the base `OpenAPI` object
-        schema_classes: pydanitic classes that their schema will be used "#/components/schemas" values
+        schema_classes: pydantic classes that their schema will be used as "#/components/schemas" values
         scan_for_pydantic_schema_reference: flag to indicate if scanning for `PydanticSchemaReference`
             class is needed for "#/components/schemas" value updates
         by_alias: construct schema by alias (default is True)
@@ -47,13 +40,11 @@ class is needed for "#/components/schemas" value updates
         new OpenAPI object with "#/components/schemas" values updated. If there is no update in
             "#/components/schemas" values, the original `open_api` will be returned.
     """
-    specs = v3_1_0 if isinstance(open_api_schema, v3_1_0.OpenAPI) else v3_0_3
-
     copied_schema = open_api_schema.copy(deep=True)
 
     if scan_for_pydantic_schema_reference:
         extracted_schema_classes = extract_pydantic_types_to_openapi_components(
-            obj=copied_schema, ref_class=specs.Reference
+            obj=copied_schema, ref_class=v3_1_0.Reference
         )
         schema_classes = list(
             {*schema_classes, *extracted_schema_classes} if schema_classes else extracted_schema_classes
@@ -63,21 +54,19 @@ class is needed for "#/components/schemas" value updates
         return open_api_schema
 
     if not copied_schema.components:
-        copied_schema.components = specs.Components(schemas={})
+        copied_schema.components = v3_1_0.Components(schemas={})
     elif not copied_schema.components.schemas:
         copied_schema.components.schemas = cast("Dict[str, Any]", {})
 
     schema_classes.sort(key=lambda x: x.__name__)
     schema_definitions = schema(schema_classes, by_alias=by_alias, ref_prefix=REF_PREFIX)["definitions"]
     copied_schema.components.schemas.update(  # type: ignore
-        {key: specs.Schema.parse_obj(schema_dict) for key, schema_dict in schema_definitions.items()}
+        {key: v3_1_0.Schema.parse_obj(schema_dict) for key, schema_dict in schema_definitions.items()}
     )
-    return cast("T", copied_schema)
+    return copied_schema
 
 
-def extract_pydantic_types_to_openapi_components(
-    obj: Any, ref_class: Union[Type[v3_0_3.Reference], Type[v3_1_0.Reference]]
-) -> Set[Type[BaseModel]]:
+def extract_pydantic_types_to_openapi_components(obj: Any, ref_class: Type[v3_1_0.Reference]) -> Set[Type[BaseModel]]:
     """Recursively traverses the OpenAPI document, replacing any found Pydantic
     Models with $references to the schema's components section and returning
     the pydantic models themselves.
@@ -94,21 +83,21 @@ def extract_pydantic_types_to_openapi_components(
         fields = obj.__fields_set__
         for field in fields:
             child_obj = getattr(obj, field)
-            if isinstance(child_obj, (OpenAPI303PydanticSchema, OpenAPI310PydanticSchema)):
+            if isinstance(child_obj, OpenAPI310PydanticSchema):
                 setattr(obj, field, ref_class(ref=REF_PREFIX + child_obj.schema_class.__name__))
                 pydantic_schemas.add(child_obj.schema_class)
             else:
                 pydantic_schemas.update(extract_pydantic_types_to_openapi_components(child_obj, ref_class=ref_class))
     elif isinstance(obj, list):
         for index, elem in enumerate(obj):
-            if isinstance(elem, (OpenAPI303PydanticSchema, OpenAPI310PydanticSchema)):
+            if isinstance(elem, OpenAPI310PydanticSchema):
                 obj[index] = ref_class(ref=REF_PREFIX + elem.schema_class.__name__)
                 pydantic_schemas.add(elem.schema_class)
             else:
                 pydantic_schemas.update(extract_pydantic_types_to_openapi_components(elem, ref_class=ref_class))
     elif isinstance(obj, dict):
         for key, value in obj.items():
-            if isinstance(value, (OpenAPI303PydanticSchema, OpenAPI310PydanticSchema)):
+            if isinstance(value, OpenAPI310PydanticSchema):
                 obj[key] = ref_class(ref=REF_PREFIX + value.schema_class.__name__)
                 pydantic_schemas.add(value.schema_class)
             else: