fastapi_swagger2 0.2.4__tar.gz → 0.2.6__tar.gz

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fastapi_swagger2
-Version: 0.2.4
+Version: 0.2.6
 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,20 +52,20 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Requires-Python: >=3.8
-Requires-Dist: fastapi>=0.100.0
+Requires-Python: >=3.9
+Requires-Dist: fastapi<0.119.0,>=0.100.0
 Provides-Extra: all
-Requires-Dist: httpx>=0.23.0; extra == 'all'
+Requires-Dist: httpx>=0.28.1; extra == 'all'
 Provides-Extra: dev
-Requires-Dist: ruff==0.0.272; extra == 'dev'
+Requires-Dist: ruff==0.14.10; extra == 'dev'
 Provides-Extra: test
-Requires-Dist: black==23.3.0; extra == 'test'
-Requires-Dist: coverage[toml]<8.0,>=6.5.0; extra == 'test'
-Requires-Dist: httpx<0.24.0,>=0.23.0; extra == 'test'
-Requires-Dist: isort<6.0.0,>=5.0.6; extra == 'test'
-Requires-Dist: mypy==1.3.0; extra == 'test'
-Requires-Dist: pytest<8.0.0,>=7.1.3; extra == 'test'
-Requires-Dist: ruff==0.0.272; extra == 'test'
+Requires-Dist: black==25.12.0; extra == 'test'
+Requires-Dist: coverage[toml]<8.0,>=7.13.1; extra == 'test'
+Requires-Dist: httpx>=0.28.1; extra == 'test'
+Requires-Dist: isort>=7.0.0; extra == 'test'
+Requires-Dist: mypy==1.19.1; extra == 'test'
+Requires-Dist: pytest<10.0.0,>=9.0.2; extra == 'test'
+Requires-Dist: ruff==0.14.10; extra == 'test'
 Description-Content-Type: text/markdown
 
 # fastapi_swagger2
@@ -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.4 - FastAPI >= 0.100.0
+* 0.2.6 - FastAPI >= 0.100.0, < 0.199.0 > + Pydantic v1/v2
 
 ## Installation
 

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/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.4 - FastAPI >= 0.100.0
+* 0.2.6 - FastAPI >= 0.100.0, < 0.199.0 > + Pydantic v1/v2
 
 ## Installation
 

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/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,15 +30,16 @@ 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",
 ]
 dependencies = [
-    "fastapi >=0.100.0",
+    "fastapi >=0.100.0,<0.119.0",
 ]
 dynamic = ["version"]
 
@@ -48,19 +49,19 @@ Documentation = "https://github.com/virajkanwade/fastapi_swagger2"
 
 [project.optional-dependencies]
 test = [
-    "pytest >=7.1.3,<8.0.0",
-    "coverage[toml] >= 6.5.0,< 8.0",
-    "mypy ==1.3.0",
-    "ruff ==0.0.272",
-    "black == 23.3.0",
-    "isort >=5.0.6,<6.0.0",
-    "httpx >=0.23.0,<0.24.0",
+    "pytest >=9.0.2,<10.0.0",
+    "coverage[toml] >= 7.13.1,< 8.0",
+    "mypy ==1.19.1",
+    "ruff ==0.14.10",
+    "black == 25.12.0",
+    "isort >=7.0.0",
+    "httpx >=0.28.1",
 ]
 dev = [
-    "ruff ==0.0.272",
+    "ruff ==0.14.10",
 ]
 all = [
-    "httpx >=0.23.0",
+    "httpx >=0.28.1",
 ]
 
 [tool.hatch.version]
@@ -73,7 +74,7 @@ known_third_party = ["fastapi", "pydantic", "starlette"]
 [tool.mypy]
 strict = true
 
-[tool.ruff]
+[tool.ruff.lint]
 select = [
     "E",  # pycodestyle errors
     "W",  # pycodestyle warnings
@@ -87,9 +88,5 @@ ignore = [
     "B008",  # do not perform function calls in argument defaults
     "C901",  # too complex
 ]
-
-[tool.ruff.per-file-ignores]
-"__init__.py" = ["F401"]
-
-[tool.ruff.isort]
-known-third-party = ["fastapi", "pydantic", "starlette"]
+per-file-ignores = { "__init__.py" = ["F401"] }
+isort = { known-third-party = ["fastapi", "pydantic", "starlette"] }

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/scripts/format.sh

@@ -1,6 +1,6 @@
 #!/bin/sh -e
 set -x
 
-ruff src/fastapi_swagger2 tests scripts --fix
+ruff check src/fastapi_swagger2 tests scripts --fix
 black src/fastapi_swagger2 tests scripts
 isort src/fastapi_swagger2 tests scripts

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/scripts/lint.sh

@@ -4,6 +4,6 @@ set -e
 set -x
 
 mypy src/fastapi_swagger2
-ruff src/fastapi_swagger2 tests scripts
+ruff check src/fastapi_swagger2 tests scripts
 black src/fastapi_swagger2 tests --check
 isort src/fastapi_swagger2 tests scripts --check-only

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/src/fastapi_swagger2/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.4"
+__version__ = "0.2.6"
 
 from typing import Any, Dict, List, Optional, TypeVar
 

{fastapi_swagger2-0.2.4 → fastapi_swagger2-0.2.6}/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,65 @@ 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:
+            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",
@@ -188,7 +248,10 @@ def get_swagger2_operation_parameters(
         }
         schema: Dict[str, Any] = param_schema
         if field_info.in_.value == "body":
-            parameter["schema"] = schema
+            if "$ref" in schema:
+                parameter["schema"] = {"$ref", schema["$ref"]}
+            else:
+                parameter["schema"] = schema
         else:
             parameter.update({k: v for (k, v) in schema.items() if k != "title"})
         if field_info.description:
@@ -226,7 +289,14 @@ def get_swagger2_operation_request_body(
     if required:
         request_body_oai["required"] = required
 
-    request_media_content: Dict[str, Any] = {"schema": body_schema}
+    request_media_content: Dict[str, Any] = {}
+    if "$ref" in body_schema:
+        request_media_content["schema"] = {"$ref": body_schema["$ref"]}
+        request_media_content.update(
+            {k: v for (k, v) in body_schema.items() if k != "$ref"}
+        )
+    else:
+        request_media_content["schema"] = body_schema
     if field_info.example != Undefined:
         request_media_content["example"] = jsonable_encoder(field_info.example)
     # request_body_oai["content"] = {request_media_type: request_media_content}
@@ -281,6 +351,7 @@ def get_swagger2_path(
                 model_name_map=model_name_map,
                 field_mapping=field_mapping,
             )
+
             parameters.extend(operation_parameters)
             if parameters:
                 all_parameters = {
@@ -489,6 +560,14 @@ def get_swagger2(
             if result:
                 path, security_schemes, path_definitions = result
 
+                for k, v in path.items():
+                    for param in v["parameters"]:
+                        if "$ref" in param and "in" in param and param["in"] != "body":
+                            definition = definitions[param.pop("$ref").split("/")[2]]
+                            param.update(
+                                {k: v for (k, v) in definition.items() if k != "title"}
+                            )
+
                 if path:
                     paths.setdefault(route.path_format, {}).update(path)
 
@@ -508,16 +587,33 @@ def get_swagger2(
         for k in sorted(definitions):
             properties = definitions[k].get("properties", [])
             for p in properties:
-                if "anyOf" in properties[p].keys():
+                if "anyOf" in properties[p]:
                     any_of = properties[p].pop("anyOf")
-                    if len(any_of) <= 2:
-                        for _any_of in any_of:
-                            if _any_of == {"type": "null"}:
-                                properties[p]["x-nullable"] = True
+
+                    if len(any_of) == 1:
+                        # Single item - just use it directly
+                        properties[p].update(any_of[0])
+                    elif len(any_of) == 2:
+                        # Handle the 2-item case (type + null)
+                        ref_item = None
+                        has_null = False
+
+                        for item in any_of:
+                            if item == {"type": "null"}:
+                                has_null = True
+                            elif "$ref" in item:
+                                ref_item = item
                             else:
-                                properties[p].update(_any_of)
+                                properties[p].update(item)
+
+                        if ref_item and has_null:
+                            properties[p]["allOf"] = [ref_item]
+                            properties[p]["x-nullable"] = True
+                        elif has_null:
+                            properties[p]["x-nullable"] = True
                     else:
-                        properties[p].update({"type": "string"})
+                        # Fallback for complex anyOf cases (len > 2) or empty (len == 0)
+                        properties[p]["type"] = "string"
                         logger.warning(
                             f"fastapi_swagger2: Unable to handle anyOf in definitions {any_of}, defaulting to string type."
                         )