openapi-python-generator 1.0.1.dev1732810009__tar.gz → 1.0.1.dev1732810474__tar.gz

{openapi_python_generator-1.0.1.dev1732810009 → openapi_python_generator-1.0.1.dev1732810474}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openapi-python-generator
-Version: 1.0.1.dev1732810009
+Version: 1.0.1.dev1732810474
 Summary: Openapi Python Generator
 Home-page: https://github.com/MarcoMuellner/openapi-python-generator
 License: MIT

{openapi_python_generator-1.0.1.dev1732810009 → openapi_python_generator-1.0.1.dev1732810474}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-python-generator"
-version = "1.0.1.dev.1732810009"
+version = "1.0.1.dev.1732810474"
 description = "Openapi Python Generator"
 authors = ["Marco Müllner <muellnermarco@gmail.com>"]
 license = "MIT"

{openapi_python_generator-1.0.1.dev1732810009 → openapi_python_generator-1.0.1.dev1732810474}/setup.py

@@ -29,7 +29,7 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'openapi-python-generator',
-    'version': '1.0.1.dev1732810009',
+    'version': '1.0.1.dev1732810474',
     '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.0.1.dev1732810009 → openapi_python_generator-1.0.1.dev1732810474}/src/openapi_python_generator/generate_data.py

@@ -7,6 +7,7 @@ import click
 import httpx
 import isort
 import orjson
+import yaml
 from black import NothingChanged
 from httpx import ConnectError
 from httpx import ConnectTimeout
@@ -45,30 +46,61 @@ def write_code(path: Path, content) -> None:
 
 def get_open_api(source: Union[str, Path]) -> OpenAPI:
     """
-    Tries to fetch the openapi.json file from the web or load from a local file. Returns the according OpenAPI object.
-    :param source:
-    :return:
+    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.
+
+    Args:
+        source: URL or file path to the OpenAPI specification
+
+    Returns:
+        OpenAPI: Parsed OpenAPI specification object
+
+    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://")
+                source.startswith("http://") or source.startswith("https://")
         ):
-            return OpenAPI(**orjson.loads(httpx.get(source).text))
+            content = httpx.get(source).text
+            # Try JSON first, then YAML for remote files
+            try:
+                return OpenAPI(**orjson.loads(content))
+            except orjson.JSONDecodeError:
+                return OpenAPI(**yaml.safe_load(content))
 
+        # Handle local files
         with open(source, "r") as f:
             file_content = f.read()
-            return OpenAPI(**orjson.loads(file_content))
+
+            # Try JSON first
+            try:
+                return OpenAPI(**orjson.loads(file_content))
+            except orjson.JSONDecodeError:
+                # If JSON fails, try YAML
+                try:
+                    return OpenAPI(**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
+
     except FileNotFoundError:
         click.echo(
-            f"File {source} not found. Please make sure to pass the path to the OpenAPI 3.0 specification."
+            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, orjson.JSONDecodeError):
+    except ValidationError:
         click.echo(
-            f"File {source} is not a valid OpenAPI 3.0 specification, or there may be a problem with your JSON."
+            f"File {source} is not a valid OpenAPI 3.0 specification."
         )
         raise