fastapi_swagger2 0.2.6__tar.gz → 0.3.0__tar.gz

fastapi_swagger2-0.3.0/.flake8

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi_swagger2
-Version: 0.2.6
+Version: 0.3.0
 Summary: Swagger2 support for FastAPI framework
 Project-URL: Homepage, https://github.com/virajkanwade/fastapi_swagger2
 Project-URL: Documentation, https://github.com/virajkanwade/fastapi_swagger2
@@ -53,7 +53,7 @@ Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
-Requires-Dist: fastapi<0.119.0,>=0.100.0
+Requires-Dist: fastapi<=0.123.8,>=0.119.0
 Provides-Extra: all
 Requires-Dist: httpx>=0.28.1; extra == 'all'
 Provides-Extra: dev
@@ -96,7 +96,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
+* 0.2.7 - FastAPI >= 0.100.0, < 0.119.0 + Pydantic v1/v2
+* 0.3.0 - FastAPI >= 0.119.0, <= 0.123.8 + Pydantic v1/v2
 
 ## Installation
 

fastapi_swagger2-0.3.0/README.md

@@ -0,0 +1,92 @@
+# fastapi_swagger2
+<p align="center">
+Swagger2 support for FastAPI
+</p>
+<p align="center">
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/v/fastapi_swagger2?color=%2334D058&label=pypi%20package" alt="Package version">
+</a>
+<a href="https://pypi.org/project/fastapi_swagger2" target="_blank">
+    <img src="https://img.shields.io/pypi/pyversions/fastapi_swagger2.svg?color=%2334D058" alt="Supported Python versions">
+</a>
+</p>
+
+---
+
+_Reason behind this library:_
+
+Few API GW services like Google Cloud API GW still support only Swagger 2.0 spec. Since FastAPI only supports OAS3, it is a challenge. Converting from OAS3 to Swagger 2.0 requires some manual steps which would hinder CI/CD.
+
+---
+
+## Requirements
+
+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.7 - FastAPI >= 0.100.0, < 0.119.0 + Pydantic v1/v2
+* 0.3.0 - FastAPI >= 0.119.0, <= 0.123.8 + Pydantic v1/v2
+
+## Installation
+
+<div class="termy">
+
+```console
+$ pip install fastapi_swagger2
+```
+
+</div>
+
+## Example
+
+```Python
+from typing import Union
+
+from fastapi import FastAPI
+from fastapi_swagger2 import FastAPISwagger2
+
+app = FastAPI()
+FastAPISwagger2(app)
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int, q: Union[str, None] = None):
+    return {"item_id": item_id, "q": q}
+```
+
+This adds following endpoints:
+* http://localhost:8000/swagger2.json
+* 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
+$ pip install "/path/to/fastapi_swagger2/repo[test,all]"
+```

fastapi_swagger2-0.3.0/fastapi_0.100.0/.git

@@ -0,0 +1 @@
+gitdir: /Users/vkanwade/Work/open_source/fastapi_swagger2/.git/worktrees/fastapi_0.100.0

fastapi_swagger2-0.3.0/fastapi_0.100.0/.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+
+.DS_Store

fastapi_swagger2-0.3.0/fastapi_0.100.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Viraj Kanwade
+
+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.

{fastapi_swagger2-0.2.6 → fastapi_swagger2-0.3.0/fastapi_0.100.0}/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.3.0/fastapi_0.100.0}/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.3.0/fastapi_0.100.0}/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.3.0/fastapi_0.100.0}/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)