fastapi_swagger2 0.2.3__tar.gz → 0.2.5__tar.gz

{fastapi_swagger2-0.2.3 → fastapi_swagger2-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: fastapi_swagger2
-Version: 0.2.3
+Version: 0.2.5
 Summary: Swagger2 support for FastAPI framework
 Project-URL: Homepage, https://github.com/virajkanwade/fastapi_swagger2
 Project-URL: Documentation, https://github.com/virajkanwade/fastapi_swagger2
@@ -40,10 +40,11 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Internet
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
@@ -51,7 +52,7 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: fastapi>=0.100.0
 Provides-Extra: all
 Requires-Dist: httpx>=0.23.0; extra == 'all'
@@ -90,11 +91,12 @@ Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec
 
 ## Requirements
 
-Python 3.8+
+Python 3.9+
 
 * 0.0.3 - FastAPI >= 0.79.0, <= 0.98.0
 * 0.1.1 - FastAPI >= 0.99.0, <= 0.99.1
-* 0.2.1 - FastAPI >= 0.100.0
+* 0.2.4 - FastAPI >= 0.100.0
+* 0.2.5 - FastAPI >= 0.100.0 + Pydantic v1/v2
 
 ## Installation
 
@@ -133,6 +135,25 @@ This adds following endpoints:
 * http://localhost:8000/swagger2/docs
 * http://localhost:8000/swagger2/redoc
 
+## Generate spec for CI/CD
+
+```Python
+import os
+
+import yaml
+
+from app.main import app
+
+URL = os.environ["CLOUD_RUN_URL"]
+
+app.servers.append(URL)
+
+spec = app.swagger2()
+spec['x-google-backend'] = {'address': URL}
+
+print(yaml.dump(spec))
+```
+
 ## Development
 
 ```console

{fastapi_swagger2-0.2.3 → fastapi_swagger2-0.2.5}/README.md

@@ -21,11 +21,12 @@ Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec
 
 ## Requirements
 
-Python 3.8+
+Python 3.9+
 
 * 0.0.3 - FastAPI >= 0.79.0, <= 0.98.0
 * 0.1.1 - FastAPI >= 0.99.0, <= 0.99.1
-* 0.2.1 - FastAPI >= 0.100.0
+* 0.2.4 - FastAPI >= 0.100.0
+* 0.2.5 - FastAPI >= 0.100.0 + Pydantic v1/v2
 
 ## Installation
 
@@ -64,6 +65,25 @@ This adds following endpoints:
 * http://localhost:8000/swagger2/docs
 * http://localhost:8000/swagger2/redoc
 
+## Generate spec for CI/CD
+
+```Python
+import os
+
+import yaml
+
+from app.main import app
+
+URL = os.environ["CLOUD_RUN_URL"]
+
+app.servers.append(URL)
+
+spec = app.swagger2()
+spec['x-google-backend'] = {'address': URL}
+
+print(yaml.dump(spec))
+```
+
 ## Development
 
 ```console

{fastapi_swagger2-0.2.3 → fastapi_swagger2-0.2.5}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 name = "fastapi_swagger2"
 description = "Swagger2 support for FastAPI framework"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 license = { file="LICENSE" }
 authors = [
     { name = "Viraj Kanwade", email = "virajk.oib@gmail.com" },
@@ -30,10 +30,11 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
     "Topic :: Internet :: WWW/HTTP",
 ]

fastapi_swagger2-0.2.5/setup.cfg

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length=88
+

{fastapi_swagger2-0.2.3 → fastapi_swagger2-0.2.5}/src/fastapi_swagger2/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.3"
+__version__ = "0.2.5"
 
 from typing import Any, Dict, List, Optional, TypeVar
 
@@ -139,7 +139,7 @@ class FastAPISwagger2:
                 contact=self.app.contact,
                 license_info=self.app.license_info,
                 routes=self.app.routes,
-                tags=self.app.swagger2_tags,
+                tags=self.app.openapi_tags,
             )
 
         return self.app.swagger2_schema

{fastapi_swagger2-0.2.3 → fastapi_swagger2-0.2.5}/src/fastapi_swagger2/utils.py

@@ -1,17 +1,17 @@
 import http.client
 import inspect
+from enum import Enum
 from typing import Any, Dict, List, Optional, Sequence, Set, Tuple, Type, Union, cast
 from urllib.parse import ParseResult, urlparse
 
 from fastapi import routing
 from fastapi._compat import (
+    PYDANTIC_V2,
     GenerateJsonSchema,
     JsonSchemaValue,
     ModelField,
     Undefined,
     get_compat_model_name_map,
-    get_definitions,
-    get_schema_from_model_field,
     lenient_issubclass,
 )
 from fastapi.datastructures import DefaultPlaceholder
@@ -29,6 +29,7 @@ from fastapi.params import Body, Param
 from fastapi.responses import Response
 from fastapi.types import ModelNameMap
 from fastapi.utils import deep_dict_update, is_body_allowed_for_status_code
+from pydantic import BaseModel
 from starlette.responses import JSONResponse
 from starlette.routing import BaseRoute
 from starlette.status import HTTP_422_UNPROCESSABLE_ENTITY
@@ -37,6 +38,66 @@ from typing_extensions import Literal
 from fastapi_swagger2.constants import REF_PREFIX, REF_TEMPLATE
 from fastapi_swagger2.models import Swagger2
 
+if PYDANTIC_V2:
+    from fastapi._compat import get_definitions, get_schema_from_model_field
+else:
+    from pydantic.schema import (
+        field_schema,
+        get_flat_models_from_fields,
+        model_process_schema,
+    )
+
+    def get_model_definitions(
+        *,
+        flat_models: Set[Union[Type[BaseModel], Type[Enum]]],
+        model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],
+    ) -> Dict[str, Any]:
+        definitions: Dict[str, Dict[str, Any]] = {}
+        for model in flat_models:
+            print(REF_PREFIX)
+            m_schema, m_definitions, m_nested_models = model_process_schema(
+                model, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+            )
+            definitions.update(m_definitions)
+            model_name = model_name_map[model]
+            if "description" in m_schema:
+                m_schema["description"] = m_schema["description"].split("\f")[0]
+            definitions[model_name] = m_schema
+        return definitions
+
+    def get_definitions(
+        *,
+        fields: List[ModelField],
+        schema_generator: GenerateJsonSchema,
+        model_name_map: ModelNameMap,
+        separate_input_output_schemas: bool = True,
+    ) -> Tuple[
+        Dict[
+            Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+        ],
+        Dict[str, Dict[str, Any]],
+    ]:
+        models = get_flat_models_from_fields(fields, known_models=set())
+        return {}, get_model_definitions(
+            flat_models=models, model_name_map=model_name_map
+        )
+
+    def get_schema_from_model_field(
+        *,
+        field: ModelField,
+        schema_generator: GenerateJsonSchema,
+        model_name_map: ModelNameMap,
+        field_mapping: Dict[
+            Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+        ],
+        separate_input_output_schemas: bool = True,
+    ) -> Dict[str, Any]:
+        # This expects that GenerateJsonSchema was already used to generate the definitions
+        return field_schema(  # type: ignore[no-any-return]
+            field, model_name_map=model_name_map, ref_prefix=REF_PREFIX
+        )[0]
+
+
 validation_error_definition = {
     "title": "ValidationError",
     "type": "object",
@@ -64,15 +125,17 @@ validation_error_response_definition = {
     },
 }
 
+FieldMapping = Dict[
+    Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+]
+
 
 # def get_schema_from_model_field(
 #        *,
 #        field: ModelField,
 #        schema_generator: GenerateJsonSchema,
 #        model_name_map: ModelNameMap,
-#        field_mapping: Dict[
-#            Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-#        ],
+#        field_mapping: FieldMapping,
 #    ) -> Dict[str, Any]:
 #        # This expects that GenerateJsonSchema was already used to generate the definitions
 #        json_schema = field_mapping[(field, field.mode)]
@@ -110,6 +173,7 @@ def get_swagger2_security_definitions(
     security_definitions = {}
     operation_security = []
     for security_requirement in flat_dependant.security_requirements:
+        skip: bool = False
         # fastapi.security.* which gets model from fastapi.openapi.models
         security_definition = jsonable_encoder(
             security_requirement.security_scheme.model,
@@ -120,13 +184,13 @@ def get_swagger2_security_definitions(
             if security_definition.get("scheme", "basic") == "basic":
                 security_definition = {"type": "basic"}
             else:
+                skip = True
                 logger.warning(
                     f"fastapi_swagger2: Unable to handle security_definition: {security_definition}"
                 )
         elif security_definition["type"] == "apiKey":
             pass
         elif security_definition["type"] == "oauth2":
-            _security_definition = security_definition
             flows = security_definition["flows"]
             flows_keys = list(flows.keys())
             if len(flows_keys) >= 1:
@@ -148,12 +212,14 @@ def get_swagger2_security_definitions(
                         {_security_name: security_requirement.scopes}
                     )
         else:
+            skip = True
             logger.warning(
                 f"fastapi_swagger2: Unable to handle security_definition: {security_definition}"
             )
-        security_name = security_requirement.security_scheme.scheme_name
-        security_definitions[security_name] = security_definition
-        operation_security.append({security_name: security_requirement.scopes})
+        if not skip:
+            security_name = security_requirement.security_scheme.scheme_name
+            security_definitions[security_name] = security_definition
+            operation_security.append({security_name: security_requirement.scopes})
     return security_definitions, operation_security
 
 
@@ -162,9 +228,7 @@ def get_swagger2_operation_parameters(
     all_route_params: Sequence[ModelField],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> List[Dict[str, Any]]:
     parameters = []
     for param in all_route_params:
@@ -203,9 +267,7 @@ def get_swagger2_operation_request_body(
     body_field: Optional[ModelField],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> Optional[Dict[str, Any]]:
     if not body_field:
         return None
@@ -239,9 +301,7 @@ def get_swagger2_path(
     operation_ids: Set[str],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:
     path: Dict[str, Any] = {}
     security_schemes: Dict[str, Any] = {}