openapi-python-client 0.22.0__tar.gz → 0.23.1__tar.gz

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/PKG-INFO

@@ -1,10 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: openapi-python-client
-Version: 0.22.0
+Version: 0.23.1
 Summary: Generate modern Python clients from OpenAPI
 Project-URL: repository, https://github.com/openapi-generators/openapi-python-client
 Author-email: Dylan Anthony <contact@dylananthony.com>
 License: MIT
+License-File: LICENSE
 Keywords: Client,Generator,OpenAPI
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -18,16 +19,16 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Code Generators
 Classifier: Typing :: Typed
 Requires-Python: <4.0,>=3.9
-Requires-Dist: attrs>=21.3.0
+Requires-Dist: attrs>=22.2.0
 Requires-Dist: colorama>=0.4.3; sys_platform == 'win32'
-Requires-Dist: httpx<0.28.0,>=0.20.0
+Requires-Dist: httpx<0.29.0,>=0.20.0
 Requires-Dist: jinja2<4.0.0,>=3.0.0
 Requires-Dist: pydantic<3.0.0,>=2.1.1
 Requires-Dist: python-dateutil<3.0.0,>=2.8.1
 Requires-Dist: ruamel-yaml<0.19.0,>=0.18.6
-Requires-Dist: ruff<0.9,>=0.2
+Requires-Dist: ruff<0.10,>=0.2
 Requires-Dist: shellingham<2.0.0,>=1.3.2
-Requires-Dist: typer<0.14,>0.6
+Requires-Dist: typer<0.16,>0.6
 Requires-Dist: typing-extensions<5.0.0,>=4.8.0
 Description-Content-Type: text/markdown
 
@@ -141,6 +142,16 @@ literal_enums: true
 
 This is especially useful if enum values, when transformed to their Python names, end up conflicting due to case sensitivity or special symbols.
 
+### generate_all_tags
+
+`openapi-python-client` generates module names within the `api` module based on the OpenAPI `tags` of each endpoint. 
+By default, only the _first_ tag is generated. If you want to generate **duplicate** endpoint functions using _every_ tag 
+listed, you can enable this option:
+
+```yaml
+generate_all_tags: true
+```
+
 ### project_name_override and package_name_override
 
 Used to change the name of generated client library project/package. If the project name is changed but an override for the package name

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/README.md

@@ -108,6 +108,16 @@ literal_enums: true
 
 This is especially useful if enum values, when transformed to their Python names, end up conflicting due to case sensitivity or special symbols.
 
+### generate_all_tags
+
+`openapi-python-client` generates module names within the `api` module based on the OpenAPI `tags` of each endpoint. 
+By default, only the _first_ tag is generated. If you want to generate **duplicate** endpoint functions using _every_ tag 
+listed, you can enable this option:
+
+```yaml
+generate_all_tags: true
+```
+
 ### project_name_override and package_name_override
 
 Used to change the name of generated client library project/package. If the project name is changed but an override for the package name

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/__init__.py

@@ -108,13 +108,11 @@ class Project:
         """Create the project from templates"""
 
         print(f"Generating {self.project_dir}")
-        if self.config.overwrite:
-            shutil.rmtree(self.project_dir, ignore_errors=True)
-
         try:
             self.project_dir.mkdir()
         except FileExistsError:
-            return [GeneratorError(detail="Directory already exists. Delete it or use the --overwrite option.")]
+            if not self.config.overwrite:
+                return [GeneratorError(detail="Directory already exists. Delete it or use the --overwrite option.")]
         self._create_package()
         self._build_metadata()
         self._build_models()
@@ -158,7 +156,7 @@ class Project:
 
     def _create_package(self) -> None:
         if self.package_dir != self.project_dir:
-            self.package_dir.mkdir()
+            self.package_dir.mkdir(exist_ok=True)
         # Package __init__.py
         package_init = self.package_dir / "__init__.py"
 
@@ -214,6 +212,7 @@ class Project:
     def _build_models(self) -> None:
         # Generate models
         models_dir = self.package_dir / "models"
+        shutil.rmtree(models_dir, ignore_errors=True)
         models_dir.mkdir()
         models_init = models_dir / "__init__.py"
         imports = []
@@ -259,6 +258,7 @@ class Project:
 
         # Generate endpoints
         api_dir = self.package_dir / "api"
+        shutil.rmtree(api_dir, ignore_errors=True)
         api_dir.mkdir()
         api_init_path = api_dir / "__init__.py"
         api_init_template = self.env.get_template("api_init.py.jinja")

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/cli.py

@@ -10,7 +10,7 @@ from openapi_python_client import MetaType
 from openapi_python_client.config import Config, ConfigFile
 from openapi_python_client.parser.errors import ErrorLevel, GeneratorError, ParseError
 
-app = typer.Typer()
+app = typer.Typer(name="openapi-python-client")
 
 
 def _version_callback(value: bool) -> None:
@@ -63,7 +63,7 @@ def _process_config(
 # noinspection PyUnusedLocal
 
 
-@app.callback(name="openapi-python-client")
+@app.callback()
 def cli(
     version: bool = typer.Option(False, "--version", callback=_version_callback, help="Print the version and exit"),
 ) -> None:

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/config.py

@@ -42,6 +42,7 @@ class ConfigFile(BaseModel):
     use_path_prefixes_for_title_model_names: bool = True
     post_hooks: Optional[list[str]] = None
     field_prefix: str = "field_"
+    generate_all_tags: bool = False
     http_timeout: int = 5
     literal_enums: bool = False
 
@@ -70,6 +71,7 @@ class Config:
     use_path_prefixes_for_title_model_names: bool
     post_hooks: list[str]
     field_prefix: str
+    generate_all_tags: bool
     http_timeout: int
     literal_enums: bool
     document_source: Union[Path, str]
@@ -110,6 +112,7 @@ class Config:
             use_path_prefixes_for_title_model_names=config_file.use_path_prefixes_for_title_model_names,
             post_hooks=post_hooks,
             field_prefix=config_file.field_prefix,
+            generate_all_tags=config_file.generate_all_tags,
             http_timeout=config_file.http_timeout,
             literal_enums=config_file.literal_enums,
             document_source=document_source,

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/parser/openapi.py

@@ -63,13 +63,18 @@ class EndpointCollection:
                 operation: Optional[oai.Operation] = getattr(path_data, method)
                 if operation is None:
                     continue
-                tag = utils.PythonIdentifier(value=(operation.tags or ["default"])[0], prefix="tag")
-                collection = endpoints_by_tag.setdefault(tag, EndpointCollection(tag=tag))
+
+                tags = [utils.PythonIdentifier(value=tag, prefix="tag") for tag in operation.tags or ["default"]]
+                if not config.generate_all_tags:
+                    tags = tags[:1]
+
+                collections = [endpoints_by_tag.setdefault(tag, EndpointCollection(tag=tag)) for tag in tags]
+
                 endpoint, schemas, parameters = Endpoint.from_data(
                     data=operation,
                     path=path,
                     method=method,
-                    tag=tag,
+                    tags=tags,
                     schemas=schemas,
                     parameters=parameters,
                     request_bodies=request_bodies,
@@ -87,15 +92,16 @@ class EndpointCollection:
                 if not isinstance(endpoint, ParseError):
                     endpoint = Endpoint.sort_parameters(endpoint=endpoint)
                 if isinstance(endpoint, ParseError):
-                    endpoint.header = (
-                        f"WARNING parsing {method.upper()} {path} within {tag}. Endpoint will not be generated."
-                    )
-                    collection.parse_errors.append(endpoint)
+                    endpoint.header = f"WARNING parsing {method.upper()} {path} within {'/'.join(tags)}. Endpoint will not be generated."
+                    for collection in collections:
+                        collection.parse_errors.append(endpoint)
                     continue
                 for error in endpoint.errors:
-                    error.header = f"WARNING parsing {method.upper()} {path} within {tag}."
-                    collection.parse_errors.append(error)
-                collection.endpoints.append(endpoint)
+                    error.header = f"WARNING parsing {method.upper()} {path} within {'/'.join(tags)}."
+                    for collection in collections:
+                        collection.parse_errors.append(error)
+                for collection in collections:
+                    collection.endpoints.append(endpoint)
 
         return endpoints_by_tag, schemas, parameters
 
@@ -132,7 +138,7 @@ class Endpoint:
     description: Optional[str]
     name: str
     requires_security: bool
-    tag: str
+    tags: list[PythonIdentifier]
     summary: Optional[str] = ""
     relative_imports: set[str] = field(default_factory=set)
     query_parameters: list[Property] = field(default_factory=list)
@@ -393,7 +399,7 @@ class Endpoint:
         data: oai.Operation,
         path: str,
         method: str,
-        tag: str,
+        tags: list[PythonIdentifier],
         schemas: Schemas,
         parameters: Parameters,
         request_bodies: dict[str, Union[oai.RequestBody, oai.Reference]],
@@ -413,7 +419,7 @@ class Endpoint:
             description=utils.remove_string_escapes(data.description) if data.description else "",
             name=name,
             requires_security=bool(data.security),
-            tag=tag,
+            tags=tags,
         )
 
         result, schemas, parameters = Endpoint.add_parameters(

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/__init__.py

@@ -70,3 +70,14 @@ from .server import Server
 from .server_variable import ServerVariable
 from .tag import Tag
 from .xml import XML
+
+PathItem.model_rebuild()
+Operation.model_rebuild()
+Components.model_rebuild()
+Encoding.model_rebuild()
+MediaType.model_rebuild()
+OpenAPI.model_rebuild()
+Parameter.model_rebuild()
+Header.model_rebuild()
+RequestBody.model_rebuild()
+Response.model_rebuild()

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/components.py

@@ -35,6 +35,8 @@ class Components(BaseModel):
     links: Optional[dict[str, Union[Link, Reference]]] = None
     callbacks: Optional[dict[str, Union[Callback, Reference]]] = None
     model_config = ConfigDict(
+        # `Callback` contains an unresolvable forward reference, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         json_schema_extra={
             "examples": [

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/encoding.py

@@ -6,8 +6,6 @@ from .reference import Reference
 
 if TYPE_CHECKING:  # pragma: no cover
     from .header import Header
-else:
-    Header = "Header"
 
 
 class Encoding(BaseModel):
@@ -19,11 +17,13 @@ class Encoding(BaseModel):
     """
 
     contentType: Optional[str] = None
-    headers: Optional[dict[str, Union[Header, Reference]]] = None
+    headers: Optional[dict[str, Union["Header", Reference]]] = None
     style: Optional[str] = None
     explode: bool = False
     allowReserved: bool = False
     model_config = ConfigDict(
+        # `Header` is an unresolvable forward reference, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         json_schema_extra={
             "examples": [

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/header.py

@@ -21,6 +21,8 @@ class Header(Parameter):
     name: str = Field(default="")
     param_in: ParameterLocation = Field(default=ParameterLocation.HEADER, alias="in")
     model_config = ConfigDict(
+        # `Parameter` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         populate_by_name=True,
         json_schema_extra={

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/media_type.py

@@ -21,6 +21,8 @@ class MediaType(BaseModel):
     examples: Optional[dict[str, Union[Example, Reference]]] = None
     encoding: Optional[dict[str, Encoding]] = None
     model_config = ConfigDict(
+        # `Encoding` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         populate_by_name=True,
         json_schema_extra={

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/open_api.py

@@ -5,9 +5,6 @@ from pydantic import BaseModel, ConfigDict, field_validator
 from .components import Components
 from .external_documentation import ExternalDocumentation
 from .info import Info
-
-# Required to update forward ref after object creation
-from .path_item import PathItem  # noqa: F401
 from .paths import Paths
 from .security_requirement import SecurityRequirement
 from .server import Server
@@ -32,7 +29,11 @@ class OpenAPI(BaseModel):
     tags: Optional[list[Tag]] = None
     externalDocs: Optional[ExternalDocumentation] = None
     openapi: str
-    model_config = ConfigDict(extra="allow")
+    model_config = ConfigDict(
+        # `Components` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
+        extra="allow",
+    )
 
     @field_validator("openapi")
     @classmethod
@@ -46,6 +47,3 @@ class OpenAPI(BaseModel):
         if int(parts[1]) > 1:
             raise ValueError(f"Only OpenAPI versions 3.1.* are supported, got {value}")
         return value
-
-
-OpenAPI.model_rebuild()

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/operation.py

@@ -4,11 +4,7 @@ from pydantic import BaseModel, ConfigDict, Field
 
 from .callback import Callback
 from .external_documentation import ExternalDocumentation
-from .header import Header  # noqa: F401
 from .parameter import Parameter
-
-# Required to update forward ref after object creation, as this is not imported yet
-from .path_item import PathItem  # noqa: F401
 from .reference import Reference
 from .request_body import RequestBody
 from .responses import Responses
@@ -38,6 +34,8 @@ class Operation(BaseModel):
     security: Optional[list[SecurityRequirement]] = None
     servers: Optional[list[Server]] = None
     model_config = ConfigDict(
+        # `Callback` contains an unresolvable forward reference, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         json_schema_extra={
             "examples": [
@@ -89,7 +87,3 @@ class Operation(BaseModel):
             ]
         },
     )
-
-
-# PathItem in Callback uses Operation, so we need to update forward refs due to circular dependency
-Operation.model_rebuild()

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/parameter.py

@@ -35,6 +35,8 @@ class Parameter(BaseModel):
     examples: Optional[dict[str, Union[Example, Reference]]] = None
     content: Optional[dict[str, MediaType]] = None
     model_config = ConfigDict(
+        # `MediaType` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         populate_by_name=True,
         json_schema_extra={

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/path_item.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import TYPE_CHECKING, Optional, Union
 
 from pydantic import BaseModel, ConfigDict, Field
 
@@ -6,6 +6,9 @@ from .parameter import Parameter
 from .reference import Reference
 from .server import Server
 
+if TYPE_CHECKING:
+    from .operation import Operation  # pragma: no cover
+
 
 class PathItem(BaseModel):
     """
@@ -33,6 +36,8 @@ class PathItem(BaseModel):
     servers: Optional[list[Server]] = None
     parameters: Optional[list[Union[Parameter, Reference]]] = None
     model_config = ConfigDict(
+        # `Operation` is an unresolvable forward reference, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         populate_by_name=True,
         json_schema_extra={
@@ -69,9 +74,3 @@ class PathItem(BaseModel):
             ]
         },
     )
-
-
-# Operation uses PathItem via Callback, so we need late import and to update forward refs due to circular dependency
-from .operation import Operation  # noqa: E402
-
-PathItem.model_rebuild()

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/request_body.py

@@ -17,6 +17,8 @@ class RequestBody(BaseModel):
     content: dict[str, MediaType]
     required: bool = False
     model_config = ConfigDict(
+        # `MediaType` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         json_schema_extra={
             "examples": [

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/response.py

@@ -23,6 +23,8 @@ class Response(BaseModel):
     content: Optional[dict[str, MediaType]] = None
     links: Optional[dict[str, Union[Link, Reference]]] = None
     model_config = ConfigDict(
+        # `MediaType` is not build yet, will rebuild in `__init__.py`:
+        defer_build=True,
         extra="allow",
         json_schema_extra={
             "examples": [

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/schema/openapi_schema_pydantic/schema.py

@@ -43,7 +43,7 @@ class Schema(BaseModel):
     anyOf: list[Union[Reference, "Schema"]] = Field(default_factory=list)
     schema_not: Optional[Union[Reference, "Schema"]] = Field(default=None, alias="not")
     items: Optional[Union[Reference, "Schema"]] = None
-    prefixItems: Optional[list[Union[Reference, "Schema"]]] = Field(default_factory=list)
+    prefixItems: list[Union[Reference, "Schema"]] = Field(default_factory=list)
     properties: Optional[dict[str, Union[Reference, "Schema"]]] = None
     additionalProperties: Optional[Union[bool, Reference, "Schema"]] = None
     description: Optional[str] = None
@@ -206,6 +206,3 @@ class Schema(BaseModel):
             self.oneOf = [Schema(type=DataType.NULL), Schema(allOf=self.allOf)]
             self.allOf = []
         return self
-
-
-Schema.model_rebuild()

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/templates/pyproject.toml.jinja

@@ -19,8 +19,8 @@ include = ["CHANGELOG.md", "{{ package_name }}/py.typed"]
 
 {% if pdm %}
 dependencies = [
-    "httpx>=0.20.0,<0.28.0",
-    "attrs>=21.3.0",
+    "httpx>=0.20.0,<0.29.0",
+    "attrs>=22.2.0",
     "python-dateutil>=2.8.0",
 ]
 
@@ -31,8 +31,8 @@ distribution = true
 
 [tool.poetry.dependencies]
 python = "^3.9"
-httpx = ">=0.20.0,<0.28.0"
-attrs = ">=21.3.0"
+httpx = ">=0.20.0,<0.29.0"
+attrs = ">=22.2.0"
 python-dateutil = "^2.8.0"
 {% endif %}
 

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/openapi_python_client/templates/setup.py.jinja

@@ -13,6 +13,6 @@ setup(
     long_description_content_type="text/markdown",
     packages=find_packages(),
     python_requires=">=3.9, <4",
-    install_requires=["httpx >= 0.20.0, < 0.28.0", "attrs >= 21.3.0", "python-dateutil >= 2.8.0, < 3"],
+    install_requires=["httpx >= 0.20.0, < 0.29.0", "attrs >= 22.2.0", "python-dateutil >= 2.8.0, < 3"],
     package_data={"{{ package_name }}": ["py.typed"]},
 )

{openapi_python_client-0.22.0 → openapi_python_client-0.23.1}/pyproject.toml

@@ -6,19 +6,19 @@ license = { text = "MIT" }
 requires-python = ">=3.9,<4.0"
 dependencies = [
     "jinja2>=3.0.0,<4.0.0",
-    "typer>0.6,<0.14",
+    "typer>0.6,<0.16",
     "colorama>=0.4.3; sys_platform == \"win32\"",
     "shellingham>=1.3.2,<2.0.0",
     "pydantic>=2.1.1,<3.0.0",
-    "attrs>=21.3.0",
+    "attrs>=22.2.0",
     "python-dateutil>=2.8.1,<3.0.0",
-    "httpx>=0.20.0,<0.28.0",
+    "httpx>=0.20.0,<0.29.0",
     "ruamel.yaml>=0.18.6,<0.19.0",
-    "ruff>=0.2,<0.9",
+    "ruff>=0.2,<0.10",
     "typing-extensions>=4.8.0,<5.0.0",
 ]
 name = "openapi-python-client"
-version = "0.22.0"
+version = "0.23.1"
 description = "Generate modern Python clients from OpenAPI"
 keywords = [
     "OpenAPI",
@@ -87,10 +87,9 @@ junit_family = "xunit2"
 
 [tool.pdm.dev-dependencies]
 dev = [
-    "pytest",
-    "pytest-mock",
-    "mypy",
-    "taskipy",
+    "pytest>8",
+    "pytest-mock>3",
+    "mypy>=1.13",
     "pytest-cov",
     "python-multipart",
     "types-PyYAML<7.0.0,>=6.0.3",
@@ -116,6 +115,7 @@ regen = {composite = ["regen_e2e", "regen_integration"]}
 e2e = "pytest openapi_python_client end_to_end_tests/test_end_to_end.py"
 re = {composite = ["regen_e2e", "e2e --snapshot-update"]}
 regen_e2e = "python -m end_to_end_tests.regen_golden_record"
+unit_test = "pytest tests"
 
 [tool.pdm.scripts.test]
 cmd = "pytest tests end_to_end_tests/test_end_to_end.py --basetemp=tests/tmp"
@@ -130,7 +130,7 @@ composite = ["test --cov openapi_python_client tests --cov-report=term-missing"]
 
 [tool.pdm.scripts.regen_integration]
 shell = """
-openapi-python-client generate --overwrite --url https://raw.githubusercontent.com/openapi-generators/openapi-test-server/main/openapi.json --config integration-tests/config.yaml --meta none --output-path integration-tests/integration_tests \
+openapi-python-client generate --overwrite --url https://raw.githubusercontent.com/openapi-generators/openapi-test-server/main/openapi.json --config integration-tests/config.yaml --meta pdm --output-path integration-tests \
 """
 
 [build-system]