pydantic-openapi-generator 2.2.8__py3-none-any.whl

pydantic_openapi_generator/version_detector.py

@@ -0,0 +1,67 @@
+"""
+OpenAPI version detection utilities.
+"""
+
+from typing import Any, Dict, Literal
+
+OpenAPIVersion = Literal["3.0", "3.1"]
+
+
+def detect_openapi_version(spec_data: Dict[str, Any]) -> OpenAPIVersion:
+    """
+    Detect the OpenAPI version from specification data.
+
+    Performs basic validation to ensure the specification is well-formed enough
+    to route to the appropriate parser. The actual parser will handle detailed
+    validation of the specification content.
+
+    Args:
+        spec_data: Dictionary containing OpenAPI specification
+
+    Returns:
+        OpenAPIVersion: Either "3.0" or "3.1"
+
+    Raises:
+        ValueError: If the specification is malformed or has unsupported version
+    """
+    # Basic validation: must be a dictionary
+    if not isinstance(spec_data, dict):
+        raise ValueError("OpenAPI specification must be a dictionary/object")
+
+    # Basic validation: must have openapi field
+    if "openapi" not in spec_data:
+        raise ValueError("Missing required 'openapi' field in specification")
+
+    openapi_version = spec_data.get("openapi")
+
+    # Basic validation: openapi field must be a string
+    if not isinstance(openapi_version, str):
+        raise ValueError("'openapi' field must be a string")
+
+    # Basic validation: must not be empty
+    if not openapi_version.strip():
+        raise ValueError("'openapi' field cannot be empty")
+
+    # Version detection
+    if openapi_version.startswith("3.0"):
+        return "3.0"
+    elif openapi_version.startswith("3.1"):
+        return "3.1"
+    else:
+        raise ValueError(f"Unsupported OpenAPI version: {openapi_version}. Only OpenAPI 3.0.x and 3.1.x are supported.")
+
+
+def is_openapi_30(spec_data: Dict[str, Any]) -> bool:
+    """Check if the specification is OpenAPI 3.0.x"""
+    try:
+        return detect_openapi_version(spec_data) == "3.0"
+    except ValueError:
+        return False
+
+
+def is_openapi_31(spec_data: Dict[str, Any]) -> bool:
+    """Check if the specification is OpenAPI 3.1.x"""
+    try:
+        return detect_openapi_version(spec_data) == "3.1"
+    except ValueError:
+        return False

pydantic_openapi_generator-2.2.8.dist-info/METADATA

@@ -0,0 +1,141 @@
+Metadata-Version: 2.5
+Name: pydantic-openapi-generator
+Version: 2.2.8
+Summary: Openapi Python Generator
+Project-URL: Homepage, https://github.com/mattcoulter7/pydantic-openapi-generator
+Project-URL: Repository, https://github.com/mattcoulter7/pydantic-openapi-generator
+Project-URL: Documentation, https://github.com/mattcoulter7/pydantic-openapi-generator
+Project-URL: Changelog, https://github.com/mattcoulter7/pydantic-openapi-generator/releases
+Author-email: Marco Müllner <muellnermarco@gmail.com>, Matt Coulter <mattcoul7@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: Generator,OpenAPI,Python,async
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: <4,>=3.12
+Requires-Dist: black>=21.10b0
+Requires-Dist: click<9,>=8.1.3
+Requires-Dist: httpx[all]<0.29,>=0.28.0
+Requires-Dist: importlib-metadata<9,>=8.7.0
+Requires-Dist: isort>=5.10.1
+Requires-Dist: jinja2<4,>=3.1.2
+Requires-Dist: openapi-pydantic<0.6,>=0.5.1
+Requires-Dist: orjson<4,>=3.9.15
+Requires-Dist: pydantic<3,>=2.10.2
+Requires-Dist: pyyaml<7,>=6.0.2
+Description-Content-Type: text/markdown
+
+# Pydantic OpenAPI Generator
+
+[![PyPI](https://img.shields.io/pypi/v/pydantic-openapi-generator.svg)][pypi_]
+[![Status](https://img.shields.io/pypi/status/pydantic-openapi-generator.svg)][status]
+[![Python Version](https://img.shields.io/pypi/pyversions/pydantic-openapi-generator)][python version]
+[![License](https://img.shields.io/pypi/l/pydantic-openapi-generator)][license]
+
+[![](https://img.shields.io/static/v1?label=documentation&message=enabled&color=<COLOR>)][documentation]
+[![Tests](https://github.com/mattcoulter7/pydantic-openapi-generator/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/mattcoulter7/pydantic-openapi-generator/branch/main/graph/badge.svg)][codecov]
+
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]
+
+[pypi_]: https://pypi.org/project/pydantic-openapi-generator/
+[status]: https://pypi.org/project/pydantic-openapi-generator/
+[python version]: https://pypi.org/project/pydantic-openapi-generator
+[documentation]: https://github.com/mattcoulter7/pydantic-openapi-generator
+[tests]: https://github.com/mattcoulter7/pydantic-openapi-generator/actions/workflows/ci.yaml
+[codecov]: https://app.codecov.io/gh/mattcoulter7/pydantic-openapi-generator
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[black]: https://github.com/psf/black
+
+![](logo.png)
+
+---
+__Documentation:__ [here][documentation]
+
+---
+
+## Migration from auth-broker
+
+As of `pydantic-openapi-generator` version `2.2.8`, this package has moved out
+of the `auth-broker` organisation, been renamed, and had its import namespace
+updated.
+
+| Item | Previous | Current |
+| --- | --- | --- |
+| GitHub repository | [`auth-broker/openapi-python-generator`](https://github.com/auth-broker/openapi-python-generator) | [`mattcoulter7/pydantic-openapi-generator`](https://github.com/mattcoulter7/pydantic-openapi-generator) |
+| PyPI package | [`ab-openapi-python-generator`](https://pypi.org/project/ab-openapi-python-generator/) | [`pydantic-openapi-generator`](https://pypi.org/project/pydantic-openapi-generator/) |
+| CLI command | `ab-openapi-python-generator` | `pydantic-openapi-generator` |
+| Import namespace | `ab_openapi_python_generator` | `pydantic_openapi_generator` |
+
+The old PyPI package is retained as an archived historical package. New work
+should use `pydantic-openapi-generator` and `pydantic_openapi_generator`.
+
+## Features
+
+- __Ease of use__. Provide input, output and the library, and the generator will do the rest.
+- __Type safety and type hinting.__ __Pydantic OpenAPI Generator__ makes heavy use of pydantic models to provide type-safe data structures.
+- __Support for multiple rest frameworks.__ __Pydantic OpenAPI Generator__ currently supports the following:
+    - [httpx](https://pypi.org/project/httpx/)
+    - [requests](https://pypi.org/project/requests/)
+    - [aiohttp](https://pypi.org/project/aiohttp/)
+- __Async and sync code generation support__, depending on the framework. It will automatically create both for frameworks that support both.
+- __Easily extendable using Jinja2 templates__. The code is designed to be easily extendable and should support even more languages and frameworks in the future.
+- __Fully tested__. Every generated code is automatically tested against the OpenAPI spec and we have 100% coverage.
+- __Usage as CLI or as library__.
+
+## Requirements
+
+- Python 3.12+
+
+## Installation
+
+You can install _Pydantic OpenAPI Generator_ via [pip] from [PyPI]:
+
+```console
+$ pip install pydantic-openapi-generator
+```
+
+## Usage
+
+Please see the [Quick start page] for details.
+
+## Roadmap
+
+- Support for all commonly used http libraries in the python ecosystem (~~requests~~, urllib, ...)
+- Support for multiple languages
+- Support for multiple authentication schemes
+- Support custom themes
+
+## Contributing
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
+
+## License
+
+Distributed under the terms of the [MIT license][license],
+_Openapi Python Generator_ is free and open source software.
+
+## Issues
+
+If you encounter any problems,
+please [file an issue] along with a detailed description.
+
+## Credits
+
+Special thanks to the peeps from [openapi-schema-pydantic](https://github.com/kuimono/openapi-schema-pydantic),
+which already did a lot of the legwork by providing a pydantic schema for the OpenAPI 3.0.0+ specification.
+
+This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.
+
+[@cjolowicz]: https://github.com/cjolowicz
+[pypi]: https://pypi.org/
+[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+[file an issue]: https://github.com/mattcoulter7/pydantic-openapi-generator/issues
+[pip]: https://pip.pypa.io/
+
+<!-- github-only -->
+
+[license]: https://github.com/mattcoulter7/pydantic-openapi-generator/blob/main/LICENSE
+[contributor guide]: https://github.com/mattcoulter7/pydantic-openapi-generator/blob/main/CONTRIBUTING.md
+[Quick start page]: https://github.com/mattcoulter7/pydantic-openapi-generator#usage

pydantic_openapi_generator-2.2.8.dist-info/RECORD

@@ -0,0 +1,31 @@
+pydantic_openapi_generator/__init__.py,sha256=ph2EznAu4nkHFruaG542m4TQ_xAvDlf36uKxtAkVP1s,460
+pydantic_openapi_generator/__main__.py,sha256=IH3k_bpPr0zDIx3aB_q--5jMqBuvcuVT6scrj-72eP8,2497
+pydantic_openapi_generator/common.py,sha256=ii8KAkTvuUGiWILGUNtLx_S_Ut21Rq6riNvbwDNwIew,1220
+pydantic_openapi_generator/generate_data.py,sha256=s71eWNKqEv5_v0Tfb2jnIME-JOag_Jz9gKxMGT5Veq8,7944
+pydantic_openapi_generator/models.py,sha256=pkuEbp4FrLhgoTzEZKnCVYBBvefX1oMJdbKAoMDTHfA,2031
+pydantic_openapi_generator/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydantic_openapi_generator/version_detector.py,sha256=PUDTpgDMHljUzxhLhMrCzHMdS3mgYQibWDiI4-vLRB4,2104
+pydantic_openapi_generator/language_converters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydantic_openapi_generator/language_converters/python/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydantic_openapi_generator/language_converters/python/client_generator.py,sha256=mMqKRZZVrjbYC2quCKWfyJxoLXu1HfWesg8S2vSF3Ns,19397
+pydantic_openapi_generator/language_converters/python/common.py,sha256=gZHNhVC4OwGBlmr3h9Ffz3iILO1ykva9CrqhBfeYQXU,1616
+pydantic_openapi_generator/language_converters/python/exception_generator.py,sha256=VWpoDhc8kZfFsdJC7hwyPG-zdszYsn75yslu2gKovm4,651
+pydantic_openapi_generator/language_converters/python/generator.py,sha256=uwwh6qLpoQCR__1J5ccA1Z7G7ewu5Ab2D--bgZsWOKE,2103
+pydantic_openapi_generator/language_converters/python/jinja_config.py,sha256=B-qSmxfrplroItvHLS7fp-FC_PkroJLT9fsB5-9J0oI,1267
+pydantic_openapi_generator/language_converters/python/model_generator.py,sha256=iU4JObTxTO1xMUZfenoXBGNOAhLSxlS80f7pNxxGqa8,42546
+pydantic_openapi_generator/language_converters/python/templates/alias_union.jinja2,sha256=tndnrDky4srNRyB_HnUMZFW7HtoJvEfwIFteYIu0ELc,468
+pydantic_openapi_generator/language_converters/python/templates/async_client_httpx_pydantic_2.jinja2,sha256=GOJWwbALdHwTnj3UUB6O5kPBqCHJNiG_WzukJtXpcsI,5017
+pydantic_openapi_generator/language_converters/python/templates/discriminator_enum.jinja2,sha256=GJZ_ih1eURnJRPZq5P_3aKhYB5iJHymj2fpuNSdM90Y,163
+pydantic_openapi_generator/language_converters/python/templates/enum.jinja2,sha256=7dewyMLifUTe9xjCTE62deuncPiNkp7eGkIaY-IWsLo,263
+pydantic_openapi_generator/language_converters/python/templates/http_exception.jinja2,sha256=BHy48PD74aU74NGWC98iciacmGotHuWw9CaOqnCL8Kc,294
+pydantic_openapi_generator/language_converters/python/templates/models.jinja2,sha256=s5PllbxiEENsZ5_fKSh1gKMJWhcLfBdH5744nKnAZsQ,797
+pydantic_openapi_generator/language_converters/python/templates/models_pydantic_2.jinja2,sha256=o6-OlV5upoZOAVx6aQbsaigPMTCi4Uuec-oP1FNDJ60,904
+pydantic_openapi_generator/language_converters/python/templates/sync_client_httpx_pydantic_2.jinja2,sha256=MaFsVuKq5K0rEldlc_HZEU98MdFCXSEKFznxJHKMl3U,4862
+pydantic_openapi_generator/parsers/__init__.py,sha256=UITDIV7rp3HAA1M8kQc_9cNG6e1tS2vDa4mTKua6aMY,300
+pydantic_openapi_generator/parsers/openapi_30.py,sha256=1fQw_kWPJa91MycncQ-3Nk4yRiB2xZjTWutZGnBvVQE,1920
+pydantic_openapi_generator/parsers/openapi_31.py,sha256=rTK-qaYjsF8SMjglcz9lPULwc4AuQykzgytDhORIqhA,1920
+pydantic_openapi_generator-2.2.8.dist-info/METADATA,sha256=2IOAso4QDjYWH3szD4S02eF46oQ1EZ4ZyZJBlTZz4tQ,6223
+pydantic_openapi_generator-2.2.8.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+pydantic_openapi_generator-2.2.8.dist-info/entry_points.txt,sha256=2LNJMXRbxmRkcRNdH7FOaGD0Te_xFojGNGsjQoOdPoQ,88
+pydantic_openapi_generator-2.2.8.dist-info/licenses/LICENSE,sha256=0myanGwJ2vUOZN12aN95o0My6XEysnnVlbKikYw3pHg,1070
+pydantic_openapi_generator-2.2.8.dist-info/RECORD,,

pydantic_openapi_generator-2.2.8.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pydantic_openapi_generator-2.2.8.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pydantic-openapi-generator = pydantic_openapi_generator.__main__:main

pydantic_openapi_generator-2.2.8.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2022 Marco Müllner
+
+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.