clientele 2.3.0__tar.gz → 2.3.1__tar.gz

{clientele-2.3.0 → clientele-2.3.1}/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 2.3.1
+
+- Models with aliases are now serialized using their alias names instead of the field names, ensuring that the output matches the expected API format.
+- Models are now serialized with `exclude_unset=True`, meaning fields that were not explicitly set will be omitted from the serialized output rather than being included as `null` or their default value.
+
 ## 2.3.0
 
 - Add `clientele.api.Query(alias=...)` for annotating a query parameter with its wire-format name via `typing.Annotated`, so a Python-friendly (snake_case) parameter name can be used without breaking the actual HTTP request. Clients generated from an OpenAPI spec now apply this automatically whenever a query parameter's name isn't already valid snake_case (e.g. `orderBy` → `order_by`).

{clientele-2.3.0 → clientele-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: clientele
-Version: 2.3.0
+Version: 2.3.1
 Summary: Clientele is a different way to build Python API Clients
 Project-URL: Homepage, https://clientele.dev
 Project-URL: Changelog, https://docs.clientele.dev/CHANGELOG/

{clientele-2.3.0 → clientele-2.3.1}/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version       | Supported          |
 | --------------| ------------------ |
-| 2.3.0         | :white_check_mark: |
-| 2.2.2 or less | :x:                |
+| 2.3.1         | :white_check_mark: |
+| 2.3.0 or less | :x:                |
 
 ## Reporting a Vulnerability
 

{clientele-2.3.0 → clientele-2.3.1}/clientele/api/client.py

@@ -175,7 +175,7 @@ class APIClient:
         self, data: dict[str, typing.Any] | pydantic.BaseModel | None
     ) -> dict[str, typing.Any] | None:
         if isinstance(data, pydantic.BaseModel):
-            return data.model_dump(mode="json")
+            return data.model_dump(mode="json", exclude_unset=True)
 
         return data
 
@@ -567,11 +567,11 @@ class APIClient:
             return payload
 
         if isinstance(payload, pydantic.BaseModel):
-            return payload.model_dump(mode="json")
+            return payload.model_dump(mode="json", exclude_unset=True)
 
         if type_utils.is_pydantic_model(annotation):
             model_instance = annotation.model_validate(payload)
-            return model_instance.model_dump(mode="json")
+            return model_instance.model_dump(mode="json", exclude_unset=True)
 
         if type_utils.is_typeddict(annotation):
             if not isinstance(payload, dict):

{clientele-2.3.0 → clientele-2.3.1}/clientele/generators/shared/schemas.py

@@ -119,7 +119,7 @@ class SchemasGenerator:
             lines.append(f"    {sanitized_arg}: {type_string}\n")
 
         if has_aliases:
-            lines.append("\n    model_config = pydantic.ConfigDict(populate_by_name=True)\n")
+            lines.append("\n    model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)\n")
 
         return "".join(lines)
 

{clientele-2.3.0 → clientele-2.3.1}/clientele/settings.py

@@ -1,5 +1,5 @@
 import sys
 
-VERSION = "2.3.0"
+VERSION = "2.3.1"
 
 PY_VERSION = sys.version_info

{clientele-2.3.0 → clientele-2.3.1}/docs/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 2.3.1
+
+- Models with aliases are now serialized using their alias names instead of the field names, ensuring that the output matches the expected API format.
+- Models are now serialized with `exclude_unset=True`, meaning fields that were not explicitly set will be omitted from the serialized output rather than being included as `null` or their default value.
+
 ## 2.3.0
 
 - Add `clientele.api.Query(alias=...)` for annotating a query parameter with its wire-format name via `typing.Annotated`, so a Python-friendly (snake_case) parameter name can be used without breaking the actual HTTP request. Clients generated from an OpenAPI spec now apply this automatically whenever a query parameter's name isn't already valid snake_case (e.g. `orderBy` → `order_by`).

{clientele-2.3.0 → clientele-2.3.1}/docs/install.md

@@ -47,7 +47,7 @@ Once installed, you can run `clientele version` to confirm:
 
 ```sh
 > clientele version
-clientele 2.3.0
+clientele 2.3.1
 ```
 
 ## Next steps

{clientele-2.3.0 → clientele-2.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "clientele"
-version = "2.3.0"
+version = "2.3.1"
 description = "Clientele is a different way to build Python API Clients"
 authors = [{ name = "Paul Hallett", email = "paulandrewhallett@gmail.com" }]
 license = { text = "MIT" }

{clientele-2.3.0 → clientele-2.3.1}/server_examples/django_ninja/client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 1.0.0
 OPENAPI VERSION: 3.1.0
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/server_examples/django_rest_framework/client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 1.0.0
 OPENAPI VERSION: 3.0.3
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/server_examples/fastapi/client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 1.0.0
 OPENAPI VERSION: 3.1.0
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/server_examples/fastapi/client/schemas.py

@@ -28,7 +28,7 @@ class ValidationError(pydantic.BaseModel):
     msg: str
     type_: str = pydantic.Field(alias="type")
 
-    model_config = pydantic.ConfigDict(populate_by_name=True)
+    model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)
 
 
 class ResponseListUsers(ListResponse[UserResponse]):

{clientele-2.3.0 → clientele-2.3.1}/tests/api_clients/async_test_client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 0.1.0
 OPENAPI VERSION: 3.0.2
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/tests/api_clients/async_test_client/schemas.py

@@ -89,7 +89,7 @@ class ValidationError(pydantic.BaseModel):
     msg: str
     type_: str = pydantic.Field(alias="type")
 
-    model_config = pydantic.ConfigDict(populate_by_name=True)
+    model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)
 
 
 class NullableFieldsRequest(pydantic.BaseModel):

{clientele-2.3.0 → clientele-2.3.1}/tests/api_clients/test_basic_client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 
 OPENAPI VERSION: 
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/tests/api_clients/test_client/MANIFEST.md

@@ -16,7 +16,7 @@ uv add clientele
 
 API VERSION: 0.1.0
 OPENAPI VERSION: 3.0.2
-CLIENTELE VERSION: 2.3.0
+CLIENTELE VERSION: 2.3.1
 
 Regenerate using this command:
 

{clientele-2.3.0 → clientele-2.3.1}/tests/api_clients/test_client/schemas.py

@@ -89,7 +89,7 @@ class ValidationError(pydantic.BaseModel):
     msg: str
     type_: str = pydantic.Field(alias="type")
 
-    model_config = pydantic.ConfigDict(populate_by_name=True)
+    model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)
 
 
 class NullableFieldsRequest(pydantic.BaseModel):

{clientele-2.3.0 → clientele-2.3.1}/tests/generators/shared/test_schemas.py

@@ -142,7 +142,7 @@ def test_generate_class_properties_default_with_alias():
         result = generator.generate_class_properties(properties, required=[])
 
         assert 'my_field: int = pydantic.Field(default=42, alias="my-field")' in result
-        assert "model_config = pydantic.ConfigDict(populate_by_name=True)" in result
+        assert "model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)" in result
 
 
 def test_generate_class_properties_no_required_array_with_defaults():
@@ -230,7 +230,7 @@ def test_generate_class_properties_const_with_alias():
         assert (
             "action_type: typing.Literal['delete'] = pydantic.Field(default='delete', alias=\"action-type\")" in result
         )
-        assert "model_config = pydantic.ConfigDict(populate_by_name=True)" in result
+        assert "model_config = pydantic.ConfigDict(populate_by_name=True, serialize_by_alias=True)" in result
 
 
 def test_schemas_generator_no_components():

{clientele-2.3.0 → clientele-2.3.1}/uv.lock

@@ -391,7 +391,7 @@ wheels = [
 
 [[package]]
 name = "clientele"
-version = "2.3.0"
+version = "2.3.1"
 source = { editable = "." }
 dependencies = [
     { name = "httpx2" },