openapi-python-client 0.27.1__tar.gz → 0.28.1__tar.gz

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openapi-python-client
-Version: 0.27.1
+Version: 0.28.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>
@@ -25,10 +25,10 @@ Requires-Dist: httpx<0.29.0,>=0.23.0
 Requires-Dist: jinja2<4.0.0,>=3.0.0
 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: ruamel-yaml<0.20.0,>=0.18.6
 Requires-Dist: ruff>=0.2
 Requires-Dist: shellingham<2.0.0,>=1.3.2
-Requires-Dist: typer<0.21,>0.16
+Requires-Dist: typer<0.22,>0.16
 Description-Content-Type: text/markdown
 
 ![Run Checks](https://github.com/openapi-generators/openapi-python-client/workflows/Run%20Checks/badge.svg)

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/parser/bodies.py

@@ -99,7 +99,7 @@ def body_from_data(
             continue
         prop, schemas = property_from_data(
             name="body",
-            required=True,
+            required=body.required,
             data=media_type_schema,
             schemas=schemas,
             parent_name=f"{endpoint_name}_{body_type}" if prefix_type_names else endpoint_name,

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/parser/properties/model_property.py

@@ -292,6 +292,11 @@ def _process_properties(  # noqa: PLR0912, PLR0911
             unprocessed_props.extend(sub_prop.properties.items() if sub_prop.properties else [])
             required_set.update(sub_prop.required or [])
 
+    # Update properties that are marked as required in the schema
+    for prop_name in required_set:
+        if prop_name in properties and not properties[prop_name].required:
+            properties[prop_name] = evolve(properties[prop_name], required=True)
+
     for key, value in unprocessed_props:
         prop_required = key in required_set
         prop_or_error: Property | (PropertyError | None)

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/parser/properties/union.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from collections.abc import Iterator
 from itertools import chain
 from typing import Any, ClassVar, cast
 
@@ -88,22 +89,26 @@ class UnionProperty(PropertyProtocol):
                 )
             sub_properties.append(sub_prop)
 
-        def flatten_union_properties(sub_properties: list[PropertyProtocol]) -> list[PropertyProtocol]:
-            flattened = []
-            for sub_prop in sub_properties:
-                if isinstance(sub_prop, UnionProperty):
-                    flattened.extend(flatten_union_properties(sub_prop.inner_properties))
+        def flatten_union_properties(possibly_nested: list[PropertyProtocol]) -> Iterator[PropertyProtocol]:
+            for to_flatten in possibly_nested:
+                if isinstance(to_flatten, UnionProperty):
+                    yield from flatten_union_properties(to_flatten.inner_properties)
                 else:
-                    flattened.append(sub_prop)
-            return flattened
+                    yield to_flatten
 
-        sub_properties = flatten_union_properties(sub_properties)
+        seen_types = set()
+        inner_properties: list[PropertyProtocol] = []
+        for flattened in flatten_union_properties(sub_properties):
+            type_string = flattened.get_type_string(no_optional=True)
+            if type_string not in seen_types:
+                seen_types.add(type_string)
+                inner_properties.append(flattened)
 
         prop = UnionProperty(
             name=name,
             required=required,
             default=None,
-            inner_properties=sub_properties,
+            inner_properties=inner_properties,
             python_name=PythonIdentifier(value=name, prefix=config.field_prefix),
             description=data.description,
             example=data.example,

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/endpoint_macros.py.jinja

@@ -60,13 +60,23 @@ params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
 {% macro body_to_kwarg(body) %}
 {% if body.body_type == "data" %}
+  {% if body.prop.required %}
 _kwargs["data"] = body.to_dict()
+  {% else %}
+if not isinstance(body, Unset):
+    _kwargs["data"] = body.to_dict()
+  {% endif %}
 {% elif body.body_type == "files"%}
 {{ multipart_body(body) }}
 {% elif body.body_type == "json" %}
 {{ json_body(body) }}
 {% elif body.body_type == "content" %}
+    {% if body.prop.required %}
 _kwargs["content"] = body.payload
+    {% else %}
+if not isinstance(body, Unset):
+    _kwargs["content"] = body.payload
+    {% endif %}
 {% endif %}
 {% endmacro %}
 
@@ -74,9 +84,12 @@ _kwargs["content"] = body.payload
 {% set property = body.prop %}
 {% import "property_templates/" + property.template as prop_template %}
 {% if prop_template.transform %}
-{{ prop_template.transform(property, property.python_name, "_kwargs[\"json\"]") }}
-{% else %}
+{{ prop_template.transform(property, property.python_name, "_kwargs[\"json\"]", skip_unset=True, declare_type=False) }}
+{% elif property.required %}
 _kwargs["json"] = {{ property.python_name }}
+{% else %}
+if not isinstance({{property.python_name}}, Unset):
+    _kwargs["json"] = {{ property.python_name }}
 {% endif %}
 {% endmacro %}
 
@@ -107,12 +120,12 @@ client: AuthenticatedClient | Client,
 {% endif %}
 {# Any allowed bodies #}
 {% if endpoint.bodies | length == 1 %}
-body: {{ endpoint.bodies[0].prop.get_type_string() }},
+body: {{ endpoint.bodies[0].prop.get_type_string() }}{% if not endpoint.bodies[0].prop.required %} = UNSET{% endif %},
 {% elif endpoint.bodies | length > 1 %}
 body:
-    {%- for body in endpoint.bodies -%}
-    {{ body.prop.get_type_string() }} {% if not loop.last %} | {% endif %}
-    {%- endfor -%}
+    {%- for body in endpoint.bodies -%}{% set body_required = body_required and body.prop.required %}
+    {{ body.prop.get_type_string(no_optional=True) }} {% if not loop.last %} | {% endif %}
+    {%- endfor -%}{% if not body_required %} | Unset = UNSET{% endif %}
 ,
 {% endif %}
 {# query parameters #}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/endpoint_module.py.jinja

@@ -1,5 +1,6 @@
 from http import HTTPStatus
 from typing import Any, cast
+from urllib.parse import quote
 
 import httpx
 
@@ -31,7 +32,7 @@ def _get_kwargs(
         {% if endpoint.path_parameters %}
         "url": "{{ endpoint.path }}".format(
         {%- for parameter in endpoint.path_parameters -%}
-        {{parameter.python_name}}={{parameter.python_name}},
+        {{parameter.python_name}}=quote(str({{parameter.python_name}}), safe=""),
         {%- endfor -%}
         ),
         {% else %}
@@ -47,7 +48,7 @@ def _get_kwargs(
 
 {% if endpoint.bodies | length > 1 %}
 {% for body in endpoint.bodies %}
-    if isinstance(body, {{body.prop.get_type_string() }}):
+    if isinstance(body, {{body.prop.get_type_string(no_optional=True) }}):
         {{ body_to_kwarg(body) | indent(8) }}
         headers["Content-Type"] = "{{ body.content_type }}"
 {% endfor %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/model.py.jinja

@@ -16,7 +16,7 @@ from ..types import UNSET, Unset
 {{ relative }}
 {% endfor %}
 
-{% for lazy_import in model.lazy_imports %}
+{% for lazy_import in model.lazy_imports | sort %}
 {% if loop.first %}
 if TYPE_CHECKING:
 {% endif %}
@@ -151,6 +151,9 @@ return field_dict
 
 {% if model.is_multipart_body %}
     def to_multipart(self) -> types.RequestFiles:
+    {% for lazy_import in model.lazy_imports %}
+        {{ lazy_import }}
+    {% endfor %}
         files: types.RequestFiles = []
 
         {% for property in model.required_properties + model.optional_properties %}
@@ -170,7 +173,7 @@ return field_dict
 
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
-    {% for lazy_import in model.lazy_imports %}
+    {% for lazy_import in model.lazy_imports | sort %}
         {{ lazy_import }}
     {% endfor %}
 {% if (model.required_properties or model.optional_properties or model.additional_properties) %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/date_property.py.jinja

@@ -10,16 +10,18 @@ isoparse({{ source }}).date()
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set transformed = source + ".isoformat()" %}
 {% if property.required %}
 {{ destination }} = {{ transformed }}
 {%- else %}
-{% if declare_type %}
-{% set type_annotation = property.get_type_string(json=True) %}
+{% if not skip_unset %}
+    {% if declare_type %}
+        {% set type_annotation = property.get_type_string(json=True) %}
 {{ destination }}: {{ type_annotation }} = UNSET
-{% else %}
+    {% else %}
 {{ destination }} = UNSET
+    {% endif %}
 {% endif %}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ transformed }}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/datetime_property.py.jinja

@@ -10,17 +10,19 @@ isoparse({{ source }})
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set transformed = source + ".isoformat()" %}
 {% if property.required %}
 {{ destination }} = {{ transformed }}
 {%- else %}
-{% if declare_type %}
-{% set type_annotation = property.get_type_string(json=True) %}
+    {% if not skip_unset %}
+        {% if declare_type %}
+        {% set type_annotation = property.get_type_string(json=True) %}
 {{ destination }}: {{ type_annotation }} = UNSET
-{% else %}
+        {% else %}
 {{ destination }} = UNSET
-{% endif %}
+        {% endif %}
+    {% endif %}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ transformed }}
 {%- endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/enum_property.py.jinja

@@ -10,13 +10,13 @@
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, {{ property.value_type.__name__ }}){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set transformed = source + ".value" %}
 {% set type_string = property.get_type_string(json=True) %}
 {% if property.required %}
 {{ destination }} = {{ transformed }}
 {%- else %}
-{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET
+{% if not skip_unset %}{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET{% endif +%}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ transformed }}
 {% endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/file_property.py.jinja

@@ -12,11 +12,11 @@ File(
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, bytes){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% if property.required %}
 {{ destination }} = {{ source }}.to_tuple()
 {% else %}
-{{ destination }}{% if declare_type %}: {{ property.get_type_string(json=True) }}{% endif %} = UNSET
+{% if not skip_unset %}{{ destination }}{% if declare_type %}: {{ property.get_type_string(json=True) }}{% endif %} = UNSET{% endif +%}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ source }}.to_tuple()
 {% endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/list_property.py.jinja

@@ -39,13 +39,13 @@ for {{ inner_source }} in {{ source }}:
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, list){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set inner_property = property.inner_property %}
 {% set type_string = property.get_type_string(json=True) %}
 {% if property.required %}
 {{ _transform(property, source, destination, "to_dict") }}
 {% else %}
-{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET
+{% if not skip_unset %}{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET{% endif +%}
 if not isinstance({{ source }}, Unset):
     {{ _transform(property, source, destination, "to_dict") | indent(4)}}
 {% endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/literal_enum_property.py.jinja

@@ -10,12 +10,12 @@ check_{{ property.get_class_name_snake_case() }}({{ source }})
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, {{ property.get_instance_type_string() }}){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set type_string = property.get_type_string(json=True) %}
 {% if property.required %}
 {{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = {{ source }}
 {%- else %}
-{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET
+{% if not skip_unset %}{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET{% endif +%}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ source }}
 {% endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/model_property.py.jinja

@@ -10,13 +10,14 @@
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, dict){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set transformed = source + ".to_dict()" %}
 {% set type_string = property.get_type_string(json=True) %}
 {% if property.required %}
 {{ destination }} = {{ transformed }}
 {%- else %}
-{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET
+{% if not skip_unset %}{{ destination }}{% if declare_type %}: {{ type_string }}{% endif %} = UNSET{% endif %}
+
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ transformed }}
 {%- endif %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/union_property.py.jinja

@@ -39,11 +39,11 @@ def _parse_{{ property.python_name }}(data: object) -> {{ property.get_type_stri
 {{ property.python_name }} = _parse_{{ property.python_name }}({{ source }})
 {% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set ns = namespace(contains_properties_without_transform = false, contains_modified_properties = not property.required, has_if = false) %}
 {% if declare_type %}{{ destination }}: {{ property.get_type_string(json=True) }}{% endif %}
 
-{% if not property.required %}
+{% if not property.required and not skip_unset %}
 if isinstance({{ source }}, Unset):
     {{ destination }} = UNSET
     {% set ns.has_if = true %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/openapi_python_client/templates/property_templates/uuid_property.py.jinja

@@ -10,16 +10,18 @@ UUID({{ source }})
 
 {% macro check_type_for_construct(property, source) %}isinstance({{ source }}, str){% endmacro %}
 
-{% macro transform(property, source, destination, declare_type=True) %}
+{% macro transform(property, source, destination, declare_type=True, skip_unset=False) %}
 {% set transformed = "str(" + source + ")" %}
 {% if property.required %}
 {{ destination }} = {{ transformed }}
 {%- else %}
-{% if declare_type %}
-{% set type_annotation = property.get_type_string(json=True) %}
+{% if not skip_unset %}
+    {% if declare_type %}
+    {% set type_annotation = property.get_type_string(json=True) %}
 {{ destination }}: {{ type_annotation }} = UNSET
-{% else %}
+    {% else %}
 {{ destination }} = UNSET
+    {% endif %}
 {% endif %}
 if not isinstance({{ source }}, Unset):
     {{ destination }} = {{ transformed }}
@@ -27,5 +29,5 @@ if not isinstance({{ source }}, Unset):
 {% endmacro %}
 
 {% macro multipart(property, source, name) %}
-files.append(({{ name }}, (None, str({{ source }}), "text/plain"))
+files.append(({{ name }}, (None, str({{ source }}), "text/plain")))
 {% endmacro %}

{openapi_python_client-0.27.1 → openapi_python_client-0.28.1}/pyproject.toml

@@ -6,18 +6,18 @@ license = { text = "MIT" }
 requires-python = ">=3.10,<4.0"
 dependencies = [
     "jinja2>=3.0.0,<4.0.0",
-    "typer>0.16,<0.21",
+    "typer>0.16,<0.22",
     "colorama>=0.4.3; sys_platform == \"win32\"",
     "shellingham>=1.3.2,<2.0.0",
     "pydantic>=2.10,<3.0.0",
     "attrs>=22.2.0",
     "python-dateutil>=2.8.1,<3.0.0",
     "httpx>=0.23.0,<0.29.0",
-    "ruamel.yaml>=0.18.6,<0.19.0",
+    "ruamel.yaml>=0.18.6,<0.20.0",
     "ruff>=0.2",
 ]
 name = "openapi-python-client"
-version = "0.27.1"
+version = "0.28.1"
 description = "Generate modern Python clients from OpenAPI"
 keywords = [
     "OpenAPI",