openapi-python-generator 1.1.2.dev1734089718__tar.gz → 1.2.1.dev1757310194__tar.gz

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openapi-python-generator
-Version: 1.1.2.dev1734089718
+Version: 1.2.1.dev1757310194
 Summary: Openapi Python Generator
 Home-page: https://github.com/MarcoMuellner/openapi-python-generator
 License: MIT
@@ -18,9 +18,9 @@ Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: Jinja2 (>=3.1.2,<4.0.0)
 Requires-Dist: black (>=21.10b0)
 Requires-Dist: click (>=8.1.3,<9.0.0)
-Requires-Dist: httpx[all] (>=0.23.0,<0.24.0)
+Requires-Dist: httpx[all] (>=0.28.0,<0.29.0)
 Requires-Dist: isort (>=5.10.1)
-Requires-Dist: openapi-pydantic (>=0.5.0,<0.6.0)
+Requires-Dist: openapi-pydantic (>=0.5.1,<0.6.0)
 Requires-Dist: orjson (>=3.9.15,<4.0.0)
 Requires-Dist: pydantic (>=2.10.2,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-python-generator"
-version = "1.1.2.dev.1734089718"
+version = "1.2.1.dev.1757310194"
 description = "Openapi Python Generator"
 authors = ["Marco Müllner <muellnermarco@gmail.com>"]
 license = "MIT"
@@ -18,17 +18,17 @@ Changelog = "https://github.com/MarcoMuellner/openapi-python-generator/releases"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-httpx = {extras = ["all"], version = "^0.23.0"}
+httpx = {extras = ["all"], version = "^0.28.0"}
 pydantic = "^2.10.2"
 orjson = "^3.9.15"
 Jinja2 = "^3.1.2"
 click = "^8.1.3"
 black = ">=21.10b0"
 isort = ">=5.10.1"
-openapi-pydantic = "^0.5.0"
+openapi-pydantic = "^0.5.1"
 pyyaml = "^6.0.2"
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 Pygments = ">=2.10.0"
 coverage = {extras = ["toml"], version = "^6.4.1"}
 darglint = ">=1.8.1"
@@ -51,7 +51,7 @@ myst-parser = {version = ">=0.16.1"}
 pytest-cov = "^3.0.0"
 fastapi = "^0.115.5"
 uvicorn = "^0.18.1"
-respx = "^0.20.1"
+respx = "^0.22.0"
 aiohttp = "^3.8.3"
 
 [tool.poetry.scripts]

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/setup.py

@@ -7,7 +7,8 @@ package_dir = \
 packages = \
 ['openapi_python_generator',
  'openapi_python_generator.language_converters',
- 'openapi_python_generator.language_converters.python']
+ 'openapi_python_generator.language_converters.python',
+ 'openapi_python_generator.parsers']
 
 package_data = \
 {'': ['*'],
@@ -17,9 +18,9 @@ install_requires = \
 ['Jinja2>=3.1.2,<4.0.0',
  'black>=21.10b0',
  'click>=8.1.3,<9.0.0',
- 'httpx[all]>=0.23.0,<0.24.0',
+ 'httpx[all]>=0.28.0,<0.29.0',
  'isort>=5.10.1',
- 'openapi-pydantic>=0.5.0,<0.6.0',
+ 'openapi-pydantic>=0.5.1,<0.6.0',
  'orjson>=3.9.15,<4.0.0',
  'pydantic>=2.10.2,<3.0.0',
  'pyyaml>=6.0.2,<7.0.0']
@@ -30,7 +31,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'openapi-python-generator',
-    'version': '1.1.2.dev1734089718',
+    'version': '1.2.1.dev1757310194',
     'description': 'Openapi Python Generator',
     'long_description': "# Openapi Python Generator\n\n[![PyPI](https://img.shields.io/pypi/v/openapi-python-generator.svg)][pypi_]\n[![Status](https://img.shields.io/pypi/status/openapi-python-generator.svg)][status]\n[![Python Version](https://img.shields.io/pypi/pyversions/openapi-python-generator)][python version]\n[![License](https://img.shields.io/pypi/l/openapi-python-generator)][license]\n\n[![](https://img.shields.io/static/v1?label=documentation&message=enabled&color=<COLOR>)][documentation]\n[![Tests](https://github.com/MarcoMuellner/openapi-python-generator/workflows/Tests/badge.svg)][tests]\n[![Codecov](https://codecov.io/gh/MarcoMuellner/openapi-python-generator/branch/main/graph/badge.svg)][codecov]\n\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]\n[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]\n\n[pypi_]: https://pypi.org/project/openapi-python-generator/\n[status]: https://pypi.org/project/openapi-python-generator/\n[python version]: https://pypi.org/project/openapi-python-generator\n[documentation]: https://marcomuellner.github.io/openapi-python-generator/\n[tests]: https://github.com/MarcoMuellner/openapi-python-generator/actions?workflow=Tests\n[codecov]: https://app.codecov.io/gh/MarcoMuellner/openapi-python-generator\n[pre-commit]: https://github.com/pre-commit/pre-commit\n[black]: https://github.com/psf/black\n\n![](logo.png)\n\n---\n__Documentation:__ [here][documentation]\n\n---\n\n## Features\n\n- __Ease of use__. Provide input, output and the library, and the generator will do the rest.\n- __Type safety and type hinting.__ __OpenAPI python generator__ makes heavy use of pydantic models to provide type-safe data structures.\n- __Support for multiple rest frameworks.__ __OpenAPI python generator__ currently supports the following:\n    - [httpx](https://pypi.org/project/httpx/)\n    - [requests](https://pypi.org/project/requests/)\n    - [aiohttp](https://pypi.org/project/aiohttp/)\n- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.\n- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.\n- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.\n- __Usage as CLI or as library__.\n\n## Requirements\n\n- Python 3.7+\n\n## Installation\n\nYou can install _Openapi Python Generator_ via [pip] from [PyPI]:\n\n```console\n$ pip install openapi-python-generator\n```\n\n## Usage\n\nPlease see the [Quick start page] for details.\n\n## Roadmap\n\n- Support for all commonly used http libraries in the python ecosystem (~~requests~~, urllib, ...)\n- Support for multiple languages\n- Support for multiple authentication schemes\n- Support custom themes\n\n## Contributing\n\nContributions are very welcome.\nTo learn more, see the [Contributor Guide].\n\n## License\n\nDistributed under the terms of the [MIT license][license],\n_Openapi Python Generator_ is free and open source software.\n\n## Issues\n\nIf you encounter any problems,\nplease [file an issue] along with a detailed description.\n\n## Credits\n\nSpecial thanks to the peeps from [openapi-schema-pydantic](https://github.com/kuimono/openapi-schema-pydantic),\nwhich already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.\n\nThis project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.\n\n[@cjolowicz]: https://github.com/cjolowicz\n[pypi]: https://pypi.org/\n[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python\n[file an issue]: https://github.com/MarcoMuellner/openapi-python-generator/issues\n[pip]: https://pip.pypa.io/\n\n<!-- github-only -->\n\n[license]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/LICENSE\n[contributor guide]: https://github.com/MarcoMuellner/openapi-python-generator/blob/main/CONTRIBUTING.md\n[Quick start page]: https://marcomuellner.github.io/openapi-python-generator/quick_start/\n",
     'author': 'Marco Müllner',

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/src/openapi_python_generator/__init__.py

@@ -1,4 +1,5 @@
-"""Python client from an OPENAPI 3.0 specification in seconds."""
+"""Python client from an OPENAPI 3.0+ specification in seconds."""
+
 try:
     from importlib.metadata import PackageNotFoundError  # type: ignore
     from importlib.metadata import version

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/src/openapi_python_generator/__main__.py

@@ -1,12 +1,12 @@
 from typing import Optional
-from enum import Enum
 
 import click
 
 from openapi_python_generator import __version__
-from openapi_python_generator.common import HTTPLibrary, PydanticVersion
+from openapi_python_generator.common import Formatter, HTTPLibrary, PydanticVersion
 from openapi_python_generator.generate_data import generate_data
 
+
 @click.command()
 @click.argument("source")
 @click.argument("output")
@@ -45,6 +45,13 @@ from openapi_python_generator.generate_data import generate_data
     show_default=True,
     help="Pydantic version to use for generated models.",
 )
+@click.option(
+    "--formatter",
+    type=click.Choice(["black", "none"]),
+    default="black",
+    show_default=True,
+    help="Option to choose which auto formatter is applied.",
+)
 @click.version_option(version=__version__)
 def main(
     source: str,
@@ -54,17 +61,25 @@ def main(
     use_orjson: bool = False,
     custom_template_path: Optional[str] = None,
     pydantic_version: PydanticVersion = PydanticVersion.V2,
+    formatter: Formatter = Formatter.BLACK,
 ) -> None:
     """
-    Generate Python code from an OpenAPI 3.0 specification.
+    Generate Python code from an OpenAPI 3.0+ specification.
 
-    Provide a SOURCE (file or URL) containing the OpenAPI 3 specification and
+    Provide a SOURCE (file or URL) containing the OpenAPI 3.0+ specification and
     an OUTPUT path, where the resulting client is created.
     """
     generate_data(
-        source, output, library, env_token_name, use_orjson, custom_template_path,pydantic_version
+        source,
+        output,
+        library,
+        env_token_name,
+        use_orjson,
+        custom_template_path,
+        pydantic_version,
+        formatter,
     )
 
 
 if __name__ == "__main__":  # pragma: no cover
-    main()
+    main()

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/src/openapi_python_generator/common.py

@@ -14,11 +14,26 @@ class HTTPLibrary(str, Enum):
     requests = "requests"
     aiohttp = "aiohttp"
 
+
 class PydanticVersion(str, Enum):
     V1 = "v1"
     V2 = "v2"
 
 
+class Formatter(str, Enum):
+    """
+    Enum for the available code formatters.
+    """
+
+    BLACK = "black"
+    NONE = "none"
+
+
+class FormatOptions:
+    skip_validation: bool = False
+    line_length: int = 120
+
+
 library_config_dict: Dict[Optional[HTTPLibrary], LibraryConfig] = {
     HTTPLibrary.httpx: LibraryConfig(
         name="httpx",

openapi_python_generator-1.2.1.dev1757310194/src/openapi_python_generator/generate_data.py

@@ -0,0 +1,239 @@
+from pathlib import Path
+from typing import List
+from typing import Optional
+from typing import Union
+
+import black
+from black.report import NothingChanged  # type: ignore
+import click
+import httpx
+import isort
+import orjson
+import yaml  # type: ignore
+from httpx import ConnectError
+from httpx import ConnectTimeout
+from pydantic import ValidationError
+
+from .common import FormatOptions, Formatter, HTTPLibrary, PydanticVersion
+from .language_converters.python.jinja_config import SERVICE_TEMPLATE
+from .language_converters.python.jinja_config import create_jinja_env
+from .models import ConversionResult
+from .version_detector import detect_openapi_version
+from .parsers import (
+    parse_openapi_3_0,
+    parse_openapi_3_1,
+    generate_code_3_0,
+    generate_code_3_1,
+)
+
+
+def write_code(path: Path, content: str, formatter: Formatter) -> None:
+    """
+    Write the content to the file at the given path.
+    :param path: The path to the file.
+    :param content: The content to write.
+    :param formatter: The formatter applied to the code written.
+    """
+    if formatter == Formatter.BLACK:
+        formatted_contend = format_using_black(content)
+    elif formatter == Formatter.NONE:
+        formatted_contend = content
+    else:
+        raise NotImplementedError(
+            f"Missing implementation for formatter {formatter!r}."
+        )
+    with open(path, "w") as f:
+        f.write(formatted_contend)
+
+
+def format_using_black(content: str) -> str:
+    try:
+        formatted_contend = black.format_file_contents(
+            content,
+            fast=FormatOptions.skip_validation,
+            mode=black.FileMode(line_length=FormatOptions.line_length),
+        )
+    except NothingChanged:
+        return content
+    return isort.code(formatted_contend, line_length=FormatOptions.line_length)
+
+
+def get_open_api(source: Union[str, Path]):
+    """
+    Tries to fetch the openapi specification file from the web or load from a local file.
+    Supports both JSON and YAML formats. Returns the according OpenAPI object.
+    Automatically supports OpenAPI 3.0 and 3.1 specifications with intelligent version detection.
+
+    Args:
+        source: URL or file path to the OpenAPI specification
+
+    Returns:
+        tuple: (OpenAPI object, version) where version is "3.0" or "3.1"
+
+    Raises:
+        FileNotFoundError: If the specified file cannot be found
+        ConnectError: If the URL cannot be accessed
+        ValidationError: If the specification is invalid
+        JSONDecodeError/YAMLError: If the file cannot be parsed
+    """
+    try:
+        # Handle remote files
+        if not isinstance(source, Path) and (
+            source.startswith("http://") or source.startswith("https://")
+        ):
+            content = httpx.get(source).text
+            # Try JSON first, then YAML for remote files
+            try:
+                data = orjson.loads(content)
+            except orjson.JSONDecodeError:
+                data = yaml.safe_load(content)
+        else:
+            # Handle local files
+            with open(source, "r") as f:
+                file_content = f.read()
+
+                # Try JSON first
+                try:
+                    data = orjson.loads(file_content)
+                except orjson.JSONDecodeError:
+                    # If JSON fails, try YAML
+                    try:
+                        data = yaml.safe_load(file_content)
+                    except yaml.YAMLError as e:
+                        click.echo(
+                            f"File {source} is neither a valid JSON nor YAML file: {str(e)}"
+                        )
+                        raise
+
+        # Detect version and parse with appropriate parser
+        version = detect_openapi_version(data)
+
+        if version == "3.0":
+            openapi_obj = parse_openapi_3_0(data)  # type: ignore[assignment]
+        elif version == "3.1":
+            openapi_obj = parse_openapi_3_1(data)  # type: ignore[assignment]
+        else:
+            # Unsupported version detected (version detection already limited to 3.0 / 3.1)
+            raise ValueError(
+                f"Unsupported OpenAPI version: {version}. Only 3.0.x and 3.1.x are supported."
+            )
+
+        return openapi_obj, version
+
+    except FileNotFoundError:
+        click.echo(
+            f"File {source} not found. Please make sure to pass the path to the OpenAPI specification."
+        )
+        raise
+    except (ConnectError, ConnectTimeout):
+        click.echo(f"Could not connect to {source}.")
+        raise ConnectError(f"Could not connect to {source}.") from None
+    except ValidationError:
+        click.echo(f"File {source} is not a valid OpenAPI 3.0+ specification.")
+        raise
+
+
+def write_data(
+    data: ConversionResult, output: Union[str, Path], formatter: Formatter
+) -> None:
+    """
+    This function will firstly create the folder structure of output, if it doesn't exist. Then it will create the
+    models from data.models into the models sub module of the output folder. After this, the services will be created
+    into the services sub module of the output folder.
+    :param data: The data to write.
+    :param output: The path to the output folder.
+    :param formatter: The formatter applied to the code written.
+    """
+
+    # Create the folder structure of the output folder.
+    Path(output).mkdir(parents=True, exist_ok=True)
+
+    # Create the models module.
+    models_path = Path(output) / "models"
+    models_path.mkdir(parents=True, exist_ok=True)
+
+    # Create the services module.
+    services_path = Path(output) / "services"
+    services_path.mkdir(parents=True, exist_ok=True)
+
+    files: List[str] = []
+
+    # Write the models.
+    for model in data.models:
+        files.append(model.file_name)
+        write_code(models_path / f"{model.file_name}.py", model.content, formatter)
+
+    # Create models.__init__.py file containing imports to all models.
+    write_code(
+        models_path / "__init__.py",
+        "\n".join([f"from .{file} import *" for file in files]),
+        formatter,
+    )
+
+    files = []
+
+    # Write the services.
+    jinja_env = create_jinja_env()
+    for service in data.services:
+        if len(service.operations) == 0:
+            continue
+        files.append(service.file_name)
+        write_code(
+            services_path / f"{service.file_name}.py",
+            jinja_env.get_template(SERVICE_TEMPLATE).render(**service.model_dump()),
+            formatter,
+        )
+
+    # Create services.__init__.py file containing imports to all services.
+    write_code(services_path / "__init__.py", "", formatter)
+
+    # Write the api_config.py file.
+    write_code(Path(output) / "api_config.py", data.api_config.content, formatter)
+
+    # Write the __init__.py file.
+    write_code(
+        Path(output) / "__init__.py",
+        "from .models import *\nfrom .services import *\nfrom .api_config import *",
+        formatter,
+    )
+
+
+def generate_data(
+    source: Union[str, Path],
+    output: Union[str, Path],
+    library: HTTPLibrary = HTTPLibrary.httpx,
+    env_token_name: Optional[str] = None,
+    use_orjson: bool = False,
+    custom_template_path: Optional[str] = None,
+    pydantic_version: PydanticVersion = PydanticVersion.V2,
+    formatter: Formatter = Formatter.BLACK,
+) -> None:
+    """
+    Generate Python code from an OpenAPI 3.0+ specification.
+    """
+    openapi_obj, version = get_open_api(source)
+    click.echo(f"Generating data from {source} (OpenAPI {version})")
+
+    # Use version-specific generator
+    if version == "3.0":
+        result = generate_code_3_0(
+            openapi_obj,  # type: ignore
+            library,
+            env_token_name,
+            use_orjson,
+            custom_template_path,
+            pydantic_version,
+        )
+    elif version == "3.1":
+        result = generate_code_3_1(
+            openapi_obj,  # type: ignore
+            library,
+            env_token_name,
+            use_orjson,
+            custom_template_path,
+            pydantic_version,
+        )
+    else:
+        raise ValueError(f"Unsupported OpenAPI version: {version}")
+
+    write_data(result, output, formatter)

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/src/openapi_python_generator/language_converters/python/api_config_generator.py

@@ -1,10 +1,11 @@
 from typing import Optional
 
-from openapi_pydantic.v3.v3_0 import OpenAPI
+from openapi_pydantic.v3 import OpenAPI
 
 from openapi_python_generator.common import PydanticVersion
 from openapi_python_generator.language_converters.python.jinja_config import (
-    API_CONFIG_TEMPLATE, API_CONFIG_TEMPLATE_PYDANTIC_V2,
+    API_CONFIG_TEMPLATE,
+    API_CONFIG_TEMPLATE_PYDANTIC_V2,
 )
 from openapi_python_generator.language_converters.python.jinja_config import (
     create_jinja_env,
@@ -13,19 +14,24 @@ from openapi_python_generator.models import APIConfig
 
 
 def generate_api_config(
-        data: OpenAPI, env_token_name: Optional[str] = None,
-        pydantic_version: PydanticVersion = PydanticVersion.V2,
+    data: OpenAPI,
+    env_token_name: Optional[str] = None,
+    pydantic_version: PydanticVersion = PydanticVersion.V2,
 ) -> APIConfig:
     """
     Generate the API model.
     """
 
-    template_name = API_CONFIG_TEMPLATE_PYDANTIC_V2 if pydantic_version == PydanticVersion.V2 else API_CONFIG_TEMPLATE
+    template_name = (
+        API_CONFIG_TEMPLATE_PYDANTIC_V2
+        if pydantic_version == PydanticVersion.V2
+        else API_CONFIG_TEMPLATE
+    )
     jinja_env = create_jinja_env()
     return APIConfig(
         file_name="api_config",
         content=jinja_env.get_template(template_name).render(
-            env_token_name=env_token_name, **data.dict()
+            env_token_name=env_token_name, **data.model_dump()
         ),
         base_url=data.servers[0].url if len(data.servers) > 0 else "NO SERVER",
     )

{openapi_python_generator-1.1.2.dev1734089718 → openapi_python_generator-1.2.1.dev1757310194}/src/openapi_python_generator/language_converters/python/generator.py

@@ -1,6 +1,7 @@
-from typing import Optional
+from typing import Optional, Union
 
-from openapi_pydantic.v3.v3_0 import OpenAPI
+from openapi_pydantic.v3.v3_0 import OpenAPI as OpenAPI30
+from openapi_pydantic.v3.v3_1 import OpenAPI as OpenAPI31
 
 from openapi_python_generator.common import PydanticVersion
 from openapi_python_generator.language_converters.python import common
@@ -16,9 +17,12 @@ from openapi_python_generator.language_converters.python.service_generator impor
 from openapi_python_generator.models import ConversionResult
 from openapi_python_generator.models import LibraryConfig
 
+# Type alias for both OpenAPI versions
+OpenAPISpec = Union[OpenAPI30, OpenAPI31]
+
 
 def generator(
-    data: OpenAPI,
+    data: OpenAPISpec,
     library_config: LibraryConfig,
     env_token_name: Optional[str] = None,
     use_orjson: bool = False,
@@ -26,7 +30,7 @@ def generator(
     pydantic_version: PydanticVersion = PydanticVersion.V2,
 ) -> ConversionResult:
     """
-    Generate Python code from an OpenAPI 3.0 specification.
+    Generate Python code from an OpenAPI 3.0+ specification.
     """
 
     common.set_use_orjson(use_orjson)