fastapi_swagger2 0.2.6__tar.gz → 0.2.7__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_swagger2
-Version: 0.2.6
+Version: 0.2.7
 Summary: Swagger2 support for FastAPI framework
 Project-URL: Homepage, https://github.com/virajkanwade/fastapi_swagger2
 Project-URL: Documentation, https://github.com/virajkanwade/fastapi_swagger2
@@ -96,7 +96,7 @@ 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
+* 0.2.7 - FastAPI >= 0.100.0, < 0.119.0 > + Pydantic v1/v2
 
 ## Installation
 

{fastapi_swagger2-0.2.6 → fastapi_swagger2-0.2.7}/README.md

@@ -26,7 +26,7 @@ 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
+* 0.2.7 - FastAPI >= 0.100.0, < 0.119.0 > + Pydantic v1/v2
 
 ## Installation
 

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

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

{fastapi_swagger2-0.2.6 → fastapi_swagger2-0.2.7}/src/fastapi_swagger2/models.py

@@ -1,9 +1,12 @@
 from enum import Enum
 from typing import Any, Callable, Dict, Iterable, List, Optional, Union
 
-from fastapi._compat import _model_rebuild
+from fastapi._compat import PYDANTIC_V2, _model_rebuild
 from fastapi.logger import logger
-from pydantic import AnyUrl, BaseModel, Field
+from pydantic import AnyUrl, BaseModel, Extra, Field
+
+if PYDANTIC_V2:
+    from pydantic import ConfigDict
 
 try:
     import email_validator  # type: ignore
@@ -31,14 +34,24 @@ class Contact(BaseModel):
     url: Optional[AnyUrl] = None
     email: Optional[EmailStr] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class License(BaseModel):
     name: str
     url: Optional[AnyUrl] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Info(BaseModel):
@@ -49,7 +62,12 @@ class Info(BaseModel):
     license: Optional[License] = None
     version: str
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 # class URLHost(Field)
@@ -76,7 +94,12 @@ class ExternalDocumentation(BaseModel):
     description: Optional[str] = None
     url: AnyUrl
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Reference(BaseModel):
@@ -90,7 +113,12 @@ class XML(BaseModel):
     attribute: Optional[bool] = None
     wrapped: Optional[bool] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Schema(BaseModel):
@@ -128,8 +156,12 @@ class Schema(BaseModel):
     externalDocs: Optional[ExternalDocumentation] = None
     example: Optional[Any] = None
 
-    class Config:
-        extra: str = "allow"
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class _Schema2(BaseModel):
@@ -151,15 +183,23 @@ class _Schema2(BaseModel):
     enum: Optional[List[Any]] = None
     multipleOf: Optional[float] = None
 
-    class Config:
-        extra: str = "allow"
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class ParameterSchema(_Schema2):
     allowEmptyValue: bool = False
 
-    class Config:
-        extra: str = "allow"
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class ParameterInType(Enum):
@@ -176,7 +216,12 @@ class ParameterBase(BaseModel):
     description: Optional[str] = None
     required: Optional[bool] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class ParameterBody(ParameterBase):
@@ -188,7 +233,12 @@ class ParameterBody(ParameterBase):
 class ParameterNotBody(ParameterBase, ParameterSchema):
     pass
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Header(_Schema2):
@@ -201,7 +251,12 @@ class Response(BaseModel):
     headers: Optional[Dict[str, Union[Header, Reference]]] = None
     examples: Optional[Any] = None  # XXX
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Operation(BaseModel):
@@ -219,7 +274,12 @@ class Operation(BaseModel):
     deprecated: Optional[bool] = None
     security: Optional[List[Dict[str, List[str]]]] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class PathItem(BaseModel):
@@ -233,7 +293,12 @@ class PathItem(BaseModel):
     patch: Optional[Operation] = None
     parameters: Optional[List[Union[ParameterBody, ParameterNotBody]]] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class SecuritySchemeType(Enum):
@@ -246,7 +311,12 @@ class SecurityBase(BaseModel):
     type_: SecuritySchemeType = Field(alias="type")
     description: Optional[str] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class BasicAuth(SecurityBase):
@@ -275,7 +345,12 @@ class OAuth2FlowBase(SecurityBase):
     flow: OAuth2FlowIn
     scopes: Dict[str, str] = {}
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class OAuth2Implicit(OAuth2FlowBase):
@@ -310,7 +385,12 @@ class Tag(BaseModel):
     description: Optional[str] = None
     externalDocs: Optional[ExternalDocumentation] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 class Swagger2(BaseModel):
@@ -332,7 +412,12 @@ class Swagger2(BaseModel):
     tags: Optional[List[Tag]] = None
     externalDocs: Optional[ExternalDocumentation] = None
 
-    model_config = {"extra": "allow"}
+    if PYDANTIC_V2:
+        model_config = ConfigDict(extra=Extra.allow)
+    else:
+
+        class Config:
+            extra = "allow"
 
 
 _model_rebuild(Schema)

{fastapi_swagger2-0.2.6 → fastapi_swagger2-0.2.7}/src/fastapi_swagger2/utils.py

@@ -9,7 +9,6 @@ from fastapi._compat import (
     PYDANTIC_V2,
     GenerateJsonSchema,
     JsonSchemaValue,
-    ModelField,
     Undefined,
     get_compat_model_name_map,
     lenient_issubclass,
@@ -39,8 +38,11 @@ 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
+    from fastapi._compat import ModelField, get_definitions, get_schema_from_model_field
 else:
+    from pydantic.fields import (  # type: ignore[attr-defined,no-redef,assignment,unused-ignore]
+        ModelField,
+    )
     from pydantic.schema import (
         field_schema,
         get_flat_models_from_fields,
@@ -76,7 +78,7 @@ else:
         ],
         Dict[str, Dict[str, Any]],
     ]:
-        models = get_flat_models_from_fields(fields, known_models=set())
+        models = get_flat_models_from_fields(fields, known_models=set())  # type: ignore[arg-type,unused-ignore]
         return {}, get_model_definitions(
             flat_models=models, model_name_map=model_name_map
         )
@@ -92,8 +94,8 @@ else:
         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
+        return field_schema(  # type: ignore[no-any-return,unused-ignore]
+            field, model_name_map=model_name_map, ref_prefix=REF_PREFIX  # type: ignore[arg-type,unused-ignore]
         )[0]
 
 
@@ -562,11 +564,56 @@ def get_swagger2(
 
                 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 PYDANTIC_V2:
+                            if "$ref" in param and param.get("in") != "body":
+                                definition = definitions[
+                                    param.pop("$ref").split("/")[2]
+                                ]
+                                param.update(
+                                    {
+                                        k: v
+                                        for (k, v) in definition.items()
+                                        if k != "title"
+                                    }
+                                )
+                        else:
+                            if "allOf" in param:
+                                all_of = param.pop("allOf")
+                                if len(all_of) > 1:
+                                    logger.warning(
+                                        f"fastapi_swagger2: Unable to handle allOf in path params {all_of}, using the first one."
+                                    )
+
+                                if len(all_of) > 0:
+                                    definition = definitions[
+                                        all_of[0]["$ref"].split("/")[2]
+                                    ]
+                                    param.update(
+                                        {
+                                            k: v
+                                            for (k, v) in definition.items()
+                                            if k != "title"
+                                        }
+                                    )
+                            if param.get("in") == "body" and "allOf" in param.get(
+                                "schema", {}
+                            ):
+                                schema = param.pop("schema")
+                                all_of = schema.pop("allOf")
+                                if len(all_of) > 1:
+                                    logger.warning(
+                                        f"fastapi_swagger2: Unable to handle allOf in path params {all_of}, using the first one."
+                                    )
+
+                                if len(all_of) > 0:
+                                    param["schema"] = {"$ref": all_of[0]["$ref"]}
+                                    param.update(
+                                        {
+                                            k: v
+                                            for (k, v) in schema.items()
+                                            if k != "title"
+                                        }
+                                    )
 
                 if path:
                     paths.setdefault(route.path_format, {}).update(path)