openapi-python-client 0.24.0__tar.gz → 0.24.1__tar.gz

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openapi-python-client
-Version: 0.24.0
+Version: 0.24.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>
@@ -23,10 +23,10 @@ Requires-Dist: attrs>=22.2.0
 Requires-Dist: colorama>=0.4.3; sys_platform == 'win32'
 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: pydantic<3.0.0,>=2.10
 Requires-Dist: python-dateutil<3.0.0,>=2.8.1
 Requires-Dist: ruamel-yaml<0.19.0,>=0.18.6
-Requires-Dist: ruff<0.10,>=0.2
+Requires-Dist: ruff<0.12,>=0.2
 Requires-Dist: shellingham<2.0.0,>=1.3.2
 Requires-Dist: typer<0.16,>0.6
 Requires-Dist: typing-extensions<5.0.0,>=4.8.0

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/components.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict
 
@@ -7,7 +7,7 @@ from .example import Example
 from .header import Header
 from .link import Link
 from .parameter import Parameter
-from .reference import Reference
+from .reference import ReferenceOr
 from .request_body import RequestBody
 from .response import Response
 from .schema import Schema
@@ -25,15 +25,15 @@ class Components(BaseModel):
         - https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#componentsObject
     """
 
-    schemas: Optional[dict[str, Union[Schema, Reference]]] = None
-    responses: Optional[dict[str, Union[Response, Reference]]] = None
-    parameters: Optional[dict[str, Union[Parameter, Reference]]] = None
-    examples: Optional[dict[str, Union[Example, Reference]]] = None
-    requestBodies: Optional[dict[str, Union[RequestBody, Reference]]] = None
-    headers: Optional[dict[str, Union[Header, Reference]]] = None
-    securitySchemes: Optional[dict[str, Union[SecurityScheme, Reference]]] = None
-    links: Optional[dict[str, Union[Link, Reference]]] = None
-    callbacks: Optional[dict[str, Union[Callback, Reference]]] = None
+    schemas: Optional[dict[str, ReferenceOr[Schema]]] = None
+    responses: Optional[dict[str, ReferenceOr[Response]]] = None
+    parameters: Optional[dict[str, ReferenceOr[Parameter]]] = None
+    examples: Optional[dict[str, ReferenceOr[Example]]] = None
+    requestBodies: Optional[dict[str, ReferenceOr[RequestBody]]] = None
+    headers: Optional[dict[str, ReferenceOr[Header]]] = None
+    securitySchemes: Optional[dict[str, ReferenceOr[SecurityScheme]]] = None
+    links: Optional[dict[str, ReferenceOr[Link]]] = None
+    callbacks: Optional[dict[str, ReferenceOr[Callback]]] = None
     model_config = ConfigDict(
         # `Callback` contains an unresolvable forward reference, will rebuild in `__init__.py`:
         defer_build=True,

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/encoding.py

@@ -1,8 +1,8 @@
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, Optional
 
 from pydantic import BaseModel, ConfigDict
 
-from .reference import Reference
+from .reference import ReferenceOr
 
 if TYPE_CHECKING:  # pragma: no cover
     from .header import Header
@@ -17,7 +17,7 @@ class Encoding(BaseModel):
     """
 
     contentType: Optional[str] = None
-    headers: Optional[dict[str, Union["Header", Reference]]] = None
+    headers: Optional[dict[str, ReferenceOr["Header"]]] = None
     style: Optional[str] = None
     explode: bool = False
     allowReserved: bool = False

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/media_type.py

@@ -1,10 +1,10 @@
-from typing import Any, Optional, Union
+from typing import Any, Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
 from .encoding import Encoding
 from .example import Example
-from .reference import Reference
+from .reference import ReferenceOr
 from .schema import Schema
 
 
@@ -16,9 +16,9 @@ class MediaType(BaseModel):
         - https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#mediaTypeObject
     """
 
-    media_type_schema: Optional[Union[Reference, Schema]] = Field(default=None, alias="schema")
+    media_type_schema: Optional[ReferenceOr[Schema]] = Field(default=None, alias="schema")
     example: Optional[Any] = None
-    examples: Optional[dict[str, Union[Example, Reference]]] = None
+    examples: Optional[dict[str, ReferenceOr[Example]]] = None
     encoding: Optional[dict[str, Encoding]] = None
     model_config = ConfigDict(
         # `Encoding` is not build yet, will rebuild in `__init__.py`:

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/operation.py

@@ -1,11 +1,11 @@
-from typing import Optional, Union
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
 from .callback import Callback
 from .external_documentation import ExternalDocumentation
 from .parameter import Parameter
-from .reference import Reference
+from .reference import ReferenceOr
 from .request_body import RequestBody
 from .responses import Responses
 from .security_requirement import SecurityRequirement
@@ -25,8 +25,8 @@ class Operation(BaseModel):
     description: Optional[str] = None
     externalDocs: Optional[ExternalDocumentation] = None
     operationId: Optional[str] = None
-    parameters: Optional[list[Union[Parameter, Reference]]] = None
-    request_body: Optional[Union[RequestBody, Reference]] = Field(None, alias="requestBody")
+    parameters: Optional[list[ReferenceOr[Parameter]]] = None
+    request_body: Optional[ReferenceOr[RequestBody]] = Field(None, alias="requestBody")
     responses: Responses
     callbacks: Optional[dict[str, Callback]] = None
 

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/parameter.py

@@ -1,11 +1,11 @@
-from typing import Any, Optional, Union
+from typing import Any, Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
 from ..parameter_location import ParameterLocation
 from .example import Example
 from .media_type import MediaType
-from .reference import Reference
+from .reference import ReferenceOr
 from .schema import Schema
 
 
@@ -30,9 +30,9 @@ class Parameter(BaseModel):
     style: Optional[str] = None
     explode: bool = False
     allowReserved: bool = False
-    param_schema: Optional[Union[Reference, Schema]] = Field(default=None, alias="schema")
+    param_schema: Optional[ReferenceOr[Schema]] = Field(default=None, alias="schema")
     example: Optional[Any] = None
-    examples: Optional[dict[str, Union[Example, Reference]]] = None
+    examples: Optional[dict[str, ReferenceOr[Example]]] = None
     content: Optional[dict[str, MediaType]] = None
     model_config = ConfigDict(
         # `MediaType` is not build yet, will rebuild in `__init__.py`:

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/path_item.py

@@ -1,9 +1,9 @@
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, Optional
 
 from pydantic import BaseModel, ConfigDict, Field
 
 from .parameter import Parameter
-from .reference import Reference
+from .reference import ReferenceOr
 from .server import Server
 
 if TYPE_CHECKING:
@@ -34,7 +34,7 @@ class PathItem(BaseModel):
     patch: Optional["Operation"] = None
     trace: Optional["Operation"] = None
     servers: Optional[list[Server]] = None
-    parameters: Optional[list[Union[Parameter, Reference]]] = None
+    parameters: Optional[list[ReferenceOr[Parameter]]] = None
     model_config = ConfigDict(
         # `Operation` is an unresolvable forward reference, will rebuild in `__init__.py`:
         defer_build=True,

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/reference.py

@@ -1,4 +1,7 @@
-from pydantic import BaseModel, ConfigDict, Field
+from typing import Annotated, Any, Literal, TypeVar, Union
+
+from pydantic import BaseModel, ConfigDict, Discriminator, Field, Tag
+from typing_extensions import TypeAlias
 
 
 class Reference(BaseModel):
@@ -24,3 +27,17 @@ class Reference(BaseModel):
             "examples": [{"$ref": "#/components/schemas/Pet"}, {"$ref": "Pet.json"}, {"$ref": "definitions.json#/Pet"}]
         },
     )
+
+
+T = TypeVar("T")
+
+
+def _reference_discriminator(obj: Any) -> Literal["ref", "other"]:
+    if isinstance(obj, dict):
+        return "ref" if "$ref" in obj else "other"
+    return "ref" if isinstance(obj, Reference) else "other"
+
+
+ReferenceOr: TypeAlias = Annotated[
+    Union[Annotated[Reference, Tag("ref")], Annotated[T, Tag("other")]], Discriminator(_reference_discriminator)
+]

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/response.py

@@ -1,11 +1,11 @@
-from typing import Optional, Union
+from typing import Optional
 
 from pydantic import BaseModel, ConfigDict
 
 from .header import Header
 from .link import Link
 from .media_type import MediaType
-from .reference import Reference
+from .reference import ReferenceOr
 
 
 class Response(BaseModel):
@@ -19,9 +19,9 @@ class Response(BaseModel):
     """
 
     description: str
-    headers: Optional[dict[str, Union[Header, Reference]]] = None
+    headers: Optional[dict[str, ReferenceOr[Header]]] = None
     content: Optional[dict[str, MediaType]] = None
-    links: Optional[dict[str, Union[Link, Reference]]] = None
+    links: Optional[dict[str, ReferenceOr[Link]]] = None
     model_config = ConfigDict(
         # `MediaType` is not build yet, will rebuild in `__init__.py`:
         defer_build=True,

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/responses.py

@@ -1,9 +1,7 @@
-from typing import Union
-
-from .reference import Reference
+from .reference import ReferenceOr
 from .response import Response
 
-Responses = dict[str, Union[Response, Reference]]
+Responses = dict[str, ReferenceOr[Response]]
 """
 A container for the expected responses of an operation.
 The container maps a HTTP response code to the expected response.

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/schema/openapi_schema_pydantic/schema.py

@@ -5,7 +5,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, Stri
 from ..data_type import DataType
 from .discriminator import Discriminator
 from .external_documentation import ExternalDocumentation
-from .reference import Reference
+from .reference import ReferenceOr
 from .xml import XML
 
 
@@ -38,14 +38,14 @@ class Schema(BaseModel):
     enum: Union[None, list[Any]] = Field(default=None, min_length=1)
     const: Union[None, StrictStr, StrictInt, StrictFloat, StrictBool] = None
     type: Union[DataType, list[DataType], None] = Field(default=None)
-    allOf: list[Union[Reference, "Schema"]] = Field(default_factory=list)
-    oneOf: list[Union[Reference, "Schema"]] = Field(default_factory=list)
-    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: list[Union[Reference, "Schema"]] = Field(default_factory=list)
-    properties: Optional[dict[str, Union[Reference, "Schema"]]] = None
-    additionalProperties: Optional[Union[bool, Reference, "Schema"]] = None
+    allOf: list[ReferenceOr["Schema"]] = Field(default_factory=list)
+    oneOf: list[ReferenceOr["Schema"]] = Field(default_factory=list)
+    anyOf: list[ReferenceOr["Schema"]] = Field(default_factory=list)
+    schema_not: Optional[ReferenceOr["Schema"]] = Field(default=None, alias="not")
+    items: Optional[ReferenceOr["Schema"]] = None
+    prefixItems: list[ReferenceOr["Schema"]] = Field(default_factory=list)
+    properties: Optional[dict[str, ReferenceOr["Schema"]]] = None
+    additionalProperties: Optional[Union[bool, ReferenceOr["Schema"]]] = None
     description: Optional[str] = None
     schema_format: Optional[str] = Field(default=None, alias="format")
     default: Optional[Any] = None

openapi_python_client-0.24.1/openapi_python_client/templates/endpoint_init.py.jinja

@@ -0,0 +1 @@
+""" Contains endpoint functions for accessing the API """

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/openapi_python_client/templates/model.py.jinja

@@ -1,3 +1,4 @@
+from collections.abc import Mapping
 from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING
 
 from attrs import define as _attrs_define
@@ -138,12 +139,12 @@ return field_dict
 {% endif %}
 
     @classmethod
-    def from_dict(cls: type[T], src_dict: dict[str, Any]) -> T:
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
     {% for lazy_import in model.lazy_imports %}
         {{ lazy_import }}
     {% endfor %}
 {% if (model.required_properties or model.optional_properties or model.additional_properties) %}
-        d = src_dict.copy()
+        d = dict(src_dict)
 {% for property in model.required_properties + model.optional_properties %}
     {% if property.required %}
         {% set property_source = 'd.pop("' + property.name + '")' %}

{openapi_python_client-0.24.0 → openapi_python_client-0.24.1}/pyproject.toml

@@ -9,16 +9,16 @@ dependencies = [
     "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",
+    "pydantic>=2.10,<3.0.0",
     "attrs>=22.2.0",
     "python-dateutil>=2.8.1,<3.0.0",
     "httpx>=0.20.0,<0.29.0",
     "ruamel.yaml>=0.18.6,<0.19.0",
-    "ruff>=0.2,<0.10",
+    "ruff>=0.2,<0.12",
     "typing-extensions>=4.8.0,<5.0.0",
 ]
 name = "openapi-python-client"
-version = "0.24.0"
+version = "0.24.1"
 description = "Generate modern Python clients from OpenAPI"
 keywords = [
     "OpenAPI",
@@ -66,7 +66,7 @@ ignore = ["E501", "PLR0913", "PLR2004"]
 "tests/*" = ["PLR2004"]
 
 [tool.coverage.run]
-omit = ["openapi_python_client/__main__.py", "openapi_python_client/templates/*"]
+omit = ["openapi_python_client/__main__.py", "openapi_python_client/templates/*", "end_to_end_tests/*", "integration_tests/*", "tests/*"]
 
 [tool.mypy]
 plugins = ["pydantic.mypy"]
@@ -95,7 +95,6 @@ dev = [
     "types-PyYAML<7.0.0,>=6.0.3",
     "types-certifi<2021.10.9,>=2020.0.0",
     "types-python-dateutil<3.0.0,>=2.0.0",
-    "ruamel-yaml-string>=0.1.1",
     "syrupy>=4",
 ]
 
@@ -118,7 +117,7 @@ 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"
+cmd = "pytest tests end_to_end_tests/test_end_to_end.py end_to_end_tests/functional_tests --basetemp=tests/tmp"
 [tool.pdm.scripts.test.env]
 "TEST_RELATIVE" = "true"