pyopenapi-gen 0.20.1__tar.gz → 0.21.0__tar.gz

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/CHANGELOG.md

@@ -1,6 +1,46 @@
 # CHANGELOG
 
 
+## v0.21.0 (2025-10-23)
+
+### Bug Fixes
+
+- **serialization**: Respect BaseSchema field mappings in DataclassSerializer
+  ([`ef5d365`](https://github.com/mindhiveoy/pyopenapi_gen/commit/ef5d3656008417bbae17e6370e33e7b0c12cefd6))
+
+BREAKING CHANGE: DataclassSerializer now correctly maps Python snake_case field names to API
+  camelCase field names when serializing BaseSchema instances.
+
+Problem: DataclassSerializer.serialize() was using Python field names (snake_case) directly as
+  dictionary keys, ignoring the field name mappings defined in
+  BaseSchema.Meta.key_transform_with_load. This caused API requests to send incorrect field names,
+  breaking communication with camelCase APIs.
+
+Solution: Modified DataclassSerializer._serialize_with_tracking() to detect BaseSchema instances and
+  use their to_dict() method, which properly handles field name mapping. Falls back to original
+  behavior for plain dataclasses to maintain backwards compatibility.
+
+Changes: - Updated DataclassSerializer._serialize_with_tracking() in core/utils.py - Added 5
+  comprehensive unit tests for field mapping scenarios - Added 2 end-to-end integration tests with
+  business_swagger.json - All existing tests pass with 88.42% coverage (exceeds 85% requirement)
+
+Example: Before: {"data_source_id": "123"} ❌
+
+After: {"dataSourceId": "123"} ✅
+
+Fixes critical bug affecting all generated clients with camelCase APIs.
+
+### Chores
+
+- **release**: Sync __init__.py version [skip ci]
+  ([`446d496`](https://github.com/mindhiveoy/pyopenapi_gen/commit/446d4963a1e8428da7b6476088104aac599dae8f))
+
+### Breaking Changes
+
+- **serialization**: Dataclassserializer now correctly maps Python snake_case field names to API
+  camelCase field names when serializing BaseSchema instances.
+
+
 ## v0.20.1 (2025-10-21)
 
 ### Bug Fixes

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyopenapi-gen
-Version: 0.20.1
+Version: 0.21.0
 Summary: Modern, async-first Python client generator for OpenAPI specifications with advanced cycle detection and unified type resolution
 Project-URL: Homepage, https://github.com/your-org/pyopenapi-gen
 Project-URL: Documentation, https://github.com/your-org/pyopenapi-gen/blob/main/README.md

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/coverage.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" ?>
-<coverage version="7.10.7" timestamp="1761058806878" lines-valid="6507" lines-covered="5752" line-rate="0.884" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
+<coverage version="7.10.7" timestamp="1761233680435" lines-valid="6518" lines-covered="5763" line-rate="0.8842" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0">
 	<!-- Generated by coverage.py: https://coverage.readthedocs.io/en/7.10.7 -->
 	<!-- Based on https://raw.githubusercontent.com/cobertura/web/master/htdocs/xml/coverage-04.dtd -->
 	<sources>
@@ -652,7 +652,7 @@
 				</class>
 			</classes>
 		</package>
-		<package name="pyopenapi_gen.core" line-rate="0.8327" branch-rate="0" complexity="0">
+		<package name="pyopenapi_gen.core" line-rate="0.836" branch-rate="0" complexity="0">
 			<classes>
 				<class name="__init__.py" filename="pyopenapi_gen/core/__init__.py" complexity="0" line-rate="1" branch-rate="0">
 					<methods/>
@@ -1053,7 +1053,7 @@
 						<line number="69" hits="1"/>
 					</lines>
 				</class>
-				<class name="utils.py" filename="pyopenapi_gen/core/utils.py" complexity="0" line-rate="0.9353" branch-rate="0">
+				<class name="utils.py" filename="pyopenapi_gen/core/utils.py" complexity="0" line-rate="0.9392" branch-rate="0">
 					<methods/>
 					<lines>
 						<line number="6" hits="1"/>
@@ -1173,59 +1173,70 @@
 						<line number="313" hits="1"/>
 						<line number="320" hits="1"/>
 						<line number="321" hits="1"/>
-						<line number="339" hits="1"/>
 						<line number="341" hits="1"/>
-						<line number="342" hits="1"/>
+						<line number="343" hits="1"/>
 						<line number="344" hits="1"/>
-						<line number="347" hits="1"/>
-						<line number="348" hits="1"/>
-						<line number="351" hits="1"/>
-						<line number="352" hits="1"/>
+						<line number="346" hits="1"/>
+						<line number="349" hits="1"/>
+						<line number="350" hits="1"/>
+						<line number="353" hits="1"/>
 						<line number="354" hits="1"/>
-						<line number="355" hits="1"/>
-						<line number="356" hits="0"/>
-						<line number="359" hits="1"/>
-						<line number="360" hits="1"/>
-						<line number="363" hits="1"/>
-						<line number="364" hits="1"/>
-						<line number="367" hits="1"/>
-						<line number="368" hits="1"/>
-						<line number="369" hits="1"/>
+						<line number="356" hits="1"/>
+						<line number="357" hits="1"/>
+						<line number="358" hits="0"/>
+						<line number="361" hits="1"/>
+						<line number="362" hits="1"/>
+						<line number="365" hits="1"/>
+						<line number="366" hits="1"/>
 						<line number="370" hits="1"/>
 						<line number="371" hits="1"/>
 						<line number="372" hits="1"/>
 						<line number="374" hits="1"/>
-						<line number="375" hits="1"/>
 						<line number="376" hits="1"/>
 						<line number="377" hits="1"/>
 						<line number="378" hits="1"/>
+						<line number="379" hits="1"/>
 						<line number="380" hits="1"/>
+						<line number="381" hits="1"/>
 						<line number="383" hits="1"/>
-						<line number="384" hits="1"/>
+						<line number="386" hits="1"/>
 						<line number="387" hits="1"/>
 						<line number="388" hits="1"/>
 						<line number="389" hits="1"/>
 						<line number="390" hits="1"/>
 						<line number="391" hits="1"/>
-						<line number="392" hits="1"/>
 						<line number="393" hits="1"/>
+						<line number="394" hits="1"/>
+						<line number="395" hits="1"/>
 						<line number="396" hits="1"/>
 						<line number="397" hits="1"/>
-						<line number="400" hits="1"/>
+						<line number="399" hits="1"/>
 						<line number="402" hits="1"/>
 						<line number="403" hits="1"/>
-						<line number="404" hits="1"/>
-						<line number="405" hits="1"/>
 						<line number="406" hits="1"/>
 						<line number="407" hits="1"/>
 						<line number="408" hits="1"/>
 						<line number="409" hits="1"/>
 						<line number="410" hits="1"/>
 						<line number="411" hits="1"/>
-						<line number="413" hits="1"/>
-						<line number="416" hits="0"/>
-						<line number="417" hits="0"/>
-						<line number="419" hits="0"/>
+						<line number="412" hits="1"/>
+						<line number="415" hits="1"/>
+						<line number="416" hits="1"/>
+						<line number="419" hits="1"/>
+						<line number="421" hits="1"/>
+						<line number="422" hits="1"/>
+						<line number="423" hits="1"/>
+						<line number="424" hits="1"/>
+						<line number="425" hits="1"/>
+						<line number="426" hits="1"/>
+						<line number="427" hits="1"/>
+						<line number="428" hits="1"/>
+						<line number="429" hits="1"/>
+						<line number="430" hits="1"/>
+						<line number="432" hits="1"/>
+						<line number="435" hits="0"/>
+						<line number="436" hits="0"/>
+						<line number="438" hits="0"/>
 					</lines>
 				</class>
 				<class name="warning_collector.py" filename="pyopenapi_gen/core/warning_collector.py" complexity="0" line-rate="1" branch-rate="0">

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyopenapi-gen"
-version = "0.20.1"
+version = "0.21.0"
 description = "Modern, async-first Python client generator for OpenAPI specifications with advanced cycle detection and unified type resolution"
 authors = [{ name = "Mindhive Oy", email = "contact@mindhive.fi" }]
 maintainers = [{ name = "Ville Venäläinen | Mindhive Oy", email = "ville@mindhive.fi" }]
@@ -140,7 +140,7 @@ pyopenapi-gen = "pyopenapi_gen.cli:app"
 
 [tool.commitizen]
 name = "cz_conventional_commits"
-version = "0.20.1"
+version = "0.21.0"
 version_files = [
     "pyproject.toml:version",
     "src/pyopenapi_gen/__init__.py:__version__"

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/src/pyopenapi_gen/__init__.py

@@ -50,7 +50,7 @@ __all__ = [
 ]
 
 # Semantic version of the generator core – automatically managed by semantic-release.
-__version__: str = "0.20.1"
+__version__: str = "0.21.0"
 
 # ---------------------------------------------------------------------------
 # Lazy-loading and autocompletion support (This part remains)

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/src/pyopenapi_gen/core/utils.py

@@ -328,10 +328,12 @@ class DataclassSerializer:
             The serialized object with dataclasses converted to dictionaries.
 
         Handles:
-        - Dataclass instances: Converted to dictionaries
+        - BaseSchema instances: Uses to_dict() method with field name mapping (e.g., snake_case -> camelCase)
+        - Regular dataclass instances: Converted to dictionaries using field names
         - Lists: Recursively serialize each item
         - Dictionaries: Recursively serialize values
         - datetime: Convert to ISO format string
+        - Enums: Convert to their value
         - Primitives: Return unchanged
         - None values: Excluded from output
         """
@@ -363,7 +365,24 @@ class DataclassSerializer:
         if isinstance(obj, Enum) and not isinstance(obj, type):
             return obj.value
 
-        # Handle dataclass instances
+        # Handle BaseSchema instances (respects field name mappings)
+        # Check for BaseSchema by looking for both to_dict and _get_field_mappings methods
+        if hasattr(obj, "to_dict") and hasattr(obj, "_get_field_mappings") and callable(obj.to_dict):
+            visited.add(obj_id)
+            try:
+                # Use BaseSchema's to_dict() which handles field name mapping
+                result_dict = obj.to_dict(exclude_none=True)
+                # Recursively serialize nested objects in the result
+                serialized_result = {}
+                for key, value in result_dict.items():
+                    serialized_value = DataclassSerializer._serialize_with_tracking(value, visited)
+                    if serialized_value is not None:
+                        serialized_result[key] = serialized_value
+                return serialized_result
+            finally:
+                visited.discard(obj_id)
+
+        # Handle regular dataclass instances (no field mapping)
         if dataclasses.is_dataclass(obj) and not isinstance(obj, type):
             visited.add(obj_id)
             try:

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.0}/tests/core/test_utils.py

@@ -357,3 +357,248 @@ def test_import_collector_sibling_directory_import() -> None:
     assert "from ..models.bar import Baz" in statements
     for stmt in statements:
         assert "/" not in stmt, f"Slash found in import statement: {stmt}"
+
+
+# DataclassSerializer Tests
+
+
+def test_dataclass_serializer__baseschema_with_mappings__uses_api_field_names() -> None:
+    """Test DataclassSerializer respects BaseSchema field name mappings.
+
+    Scenario:
+        - Create a BaseSchema dataclass with field mappings (snake_case -> camelCase)
+        - Serialize the instance using DataclassSerializer.serialize()
+
+    Expected Outcome:
+        - The serialized dictionary should use API field names (camelCase)
+        - Should not use Python field names (snake_case)
+    """
+    # Arrange
+    from dataclasses import dataclass
+
+    from pyopenapi_gen.core.schemas import BaseSchema
+    from pyopenapi_gen.core.utils import DataclassSerializer
+
+    @dataclass
+    class DocumentUpdate(BaseSchema):
+        """Test schema with field mappings."""
+
+        data_source_id: str
+        mime_type: str | None = None
+        last_modified: str | None = None
+
+        class Meta:
+            """Field mappings."""
+
+            key_transform_with_load = {
+                "dataSourceId": "data_source_id",
+                "mimeType": "mime_type",
+                "lastModified": "last_modified",
+            }
+
+    obj = DocumentUpdate(data_source_id="source-123", mime_type="text/html", last_modified="2024-10-23")
+
+    # Act
+    result = DataclassSerializer.serialize(obj)
+
+    # Assert
+    assert isinstance(result, dict)
+    assert "dataSourceId" in result  # camelCase (API name)
+    assert "mimeType" in result
+    assert "lastModified" in result
+    assert "data_source_id" not in result  # snake_case (Python name) should NOT be present
+    assert "mime_type" not in result
+    assert "last_modified" not in result
+    assert result["dataSourceId"] == "source-123"
+    assert result["mimeType"] == "text/html"
+    assert result["lastModified"] == "2024-10-23"
+
+
+def test_dataclass_serializer__nested_baseschema__maps_recursively() -> None:
+    """Test DataclassSerializer handles nested BaseSchema instances with field mappings.
+
+    Scenario:
+        - Create nested BaseSchema dataclasses with field mappings
+        - Serialize the parent instance
+
+    Expected Outcome:
+        - Both parent and nested objects should use API field names
+        - Nested field mappings should be respected recursively
+    """
+    # Arrange
+    from dataclasses import dataclass
+
+    from pyopenapi_gen.core.schemas import BaseSchema
+    from pyopenapi_gen.core.utils import DataclassSerializer
+
+    @dataclass
+    class Address(BaseSchema):
+        """Nested schema with field mappings."""
+
+        street_name: str
+        postal_code: str
+
+        class Meta:
+            """Field mappings."""
+
+            key_transform_with_load = {"streetName": "street_name", "postalCode": "postal_code"}
+
+    @dataclass
+    class User(BaseSchema):
+        """Parent schema with field mappings."""
+
+        user_id: str
+        full_name: str
+        home_address: Address
+
+        class Meta:
+            """Field mappings."""
+
+            key_transform_with_load = {
+                "userId": "user_id",
+                "fullName": "full_name",
+                "homeAddress": "home_address",
+            }
+
+    address = Address(street_name="Main St", postal_code="12345")
+    user = User(user_id="user-123", full_name="John Doe", home_address=address)
+
+    # Act
+    result = DataclassSerializer.serialize(user)
+
+    # Assert
+    assert isinstance(result, dict)
+    assert "userId" in result
+    assert "fullName" in result
+    assert "homeAddress" in result
+    assert isinstance(result["homeAddress"], dict)
+    assert "streetName" in result["homeAddress"]
+    assert "postalCode" in result["homeAddress"]
+    assert result["userId"] == "user-123"
+    assert result["homeAddress"]["streetName"] == "Main St"
+
+
+def test_dataclass_serializer__plain_dataclass__still_works() -> None:
+    """Test DataclassSerializer backwards compatibility with plain dataclasses.
+
+    Scenario:
+        - Create a plain dataclass (not BaseSchema)
+        - Serialize the instance
+
+    Expected Outcome:
+        - Should use field.name directly (no field mapping)
+        - Backwards compatibility maintained
+    """
+    # Arrange
+    from dataclasses import dataclass
+
+    from pyopenapi_gen.core.utils import DataclassSerializer
+
+    @dataclass
+    class PlainModel:
+        """Plain dataclass without BaseSchema."""
+
+        field_one: str
+        field_two: int
+
+    obj = PlainModel(field_one="value", field_two=42)
+
+    # Act
+    result = DataclassSerializer.serialize(obj)
+
+    # Assert
+    assert isinstance(result, dict)
+    assert "field_one" in result
+    assert "field_two" in result
+    assert result["field_one"] == "value"
+    assert result["field_two"] == 42
+
+
+def test_dataclass_serializer__exclude_none_handling() -> None:
+    """Test DataclassSerializer excludes None values when using BaseSchema.
+
+    Scenario:
+        - Create a BaseSchema instance with some None values
+        - Serialize the instance
+
+    Expected Outcome:
+        - None values should be excluded from the result
+        - Non-None values should be present with correct field names
+    """
+    # Arrange
+    from dataclasses import dataclass
+
+    from pyopenapi_gen.core.schemas import BaseSchema
+    from pyopenapi_gen.core.utils import DataclassSerializer
+
+    @dataclass
+    class OptionalFields(BaseSchema):
+        """Schema with optional fields."""
+
+        required_field: str
+        optional_field: str | None = None
+        another_optional: str | None = None
+
+        class Meta:
+            """Field mappings."""
+
+            key_transform_with_load = {
+                "requiredField": "required_field",
+                "optionalField": "optional_field",
+                "anotherOptional": "another_optional",
+            }
+
+    obj = OptionalFields(required_field="present", optional_field=None, another_optional=None)
+
+    # Act
+    result = DataclassSerializer.serialize(obj)
+
+    # Assert
+    assert isinstance(result, dict)
+    assert "requiredField" in result
+    assert "optionalField" not in result  # None values excluded
+    assert "anotherOptional" not in result
+    assert result["requiredField"] == "present"
+
+
+def test_dataclass_serializer__list_of_baseschema__maps_all_items() -> None:
+    """Test DataclassSerializer handles lists of BaseSchema instances.
+
+    Scenario:
+        - Create a list of BaseSchema instances with field mappings
+        - Serialize the list
+
+    Expected Outcome:
+        - Each item in the list should have field names mapped
+        - All items should use API field names
+    """
+    # Arrange
+    from dataclasses import dataclass
+
+    from pyopenapi_gen.core.schemas import BaseSchema
+    from pyopenapi_gen.core.utils import DataclassSerializer
+
+    @dataclass
+    class Item(BaseSchema):
+        """Schema with field mappings."""
+
+        item_id: str
+        item_name: str
+
+        class Meta:
+            """Field mappings."""
+
+            key_transform_with_load = {"itemId": "item_id", "itemName": "item_name"}
+
+    items = [Item(item_id="1", item_name="First"), Item(item_id="2", item_name="Second")]
+
+    # Act
+    result = DataclassSerializer.serialize(items)
+
+    # Assert
+    assert isinstance(result, list)
+    assert len(result) == 2
+    assert all("itemId" in item for item in result)
+    assert all("itemName" in item for item in result)
+    assert result[0]["itemId"] == "1"
+    assert result[1]["itemName"] == "Second"

pyopenapi_gen-0.21.0/tests/integration/test_field_mapping_e2e.py

@@ -0,0 +1,146 @@
+"""Integration test for field name mapping in generated clients.
+
+Tests that the DataclassSerializer correctly maps Python snake_case field names
+to API camelCase field names when serializing request bodies.
+"""
+
+import tempfile
+from pathlib import Path
+
+import pytest
+
+from pyopenapi_gen import generate_client
+
+
+def test_field_mapping__business_swagger_updateDocument__serializes_to_camelCase() -> None:
+    """End-to-end test for field mapping with business_swagger.json.
+
+    Scenario:
+        - Generate client from business_swagger.json
+        - Import DocumentUpdate model from generated client
+        - Create instance with snake_case attributes
+        - Serialize using DataclassSerializer
+        - Verify output uses camelCase API field names
+
+    Expected Outcome:
+        - Generated code should include field mappings in Meta class
+        - DataclassSerializer should use camelCase keys (not snake_case)
+        - Validates the fix for the field mapping bug
+    """
+    # Arrange - Generate client in temporary directory
+    spec_path = "input/business_swagger.json"
+    with tempfile.TemporaryDirectory() as tmpdir:
+        project_root = Path(tmpdir)
+
+        # Act - Generate client
+        generate_client(
+            spec_path=spec_path,
+            project_root=str(project_root),
+            output_package="businessapi",
+            force=True,
+            no_postprocess=True,  # Skip formatting for speed
+        )
+
+        # Import generated model dynamically
+        import sys
+
+        sys.path.insert(0, str(project_root))
+        from businessapi.core.utils import DataclassSerializer
+        from businessapi.models.document_update import DocumentUpdate
+
+        # Create instance with snake_case attributes
+        doc_update = DocumentUpdate(
+            url="https://example.com/doc",
+            data_source_id="source-123",
+            mime_type="text/html",
+            last_modified="2024-10-23T12:00:00Z",
+        )
+
+        # Act - Serialize using DataclassSerializer
+        result = DataclassSerializer.serialize(doc_update)
+
+        # Assert - Should use camelCase API field names
+        assert isinstance(result, dict)
+
+        # Check that camelCase keys are present
+        assert "dataSourceId" in result, "Should use camelCase 'dataSourceId' (API field name)"
+        assert "mimeType" in result, "Should use camelCase 'mimeType' (API field name)"
+        assert "lastModified" in result, "Should use camelCase 'lastModified' (API field name)"
+
+        # Check that snake_case keys are NOT present
+        assert "data_source_id" not in result, "Should NOT use snake_case 'data_source_id' (Python field name)"
+        assert "mime_type" not in result, "Should NOT use snake_case 'mime_type' (Python field name)"
+        assert "last_modified" not in result, "Should NOT use snake_case 'last_modified' (Python field name)"
+
+        # Verify values are correct
+        assert result["dataSourceId"] == "source-123"
+        assert result["mimeType"] == "text/html"
+        assert result["lastModified"] == "2024-10-23T12:00:00Z"
+
+        # Cleanup
+        sys.path.remove(str(project_root))
+
+
+def test_field_mapping__roundtrip__preserves_data() -> None:
+    """Test that field mapping works correctly in both directions.
+
+    Scenario:
+        - Generate client from business_swagger.json
+        - Create DocumentUpdate from dict with camelCase keys (API response)
+        - Serialize back to dict
+        - Verify field names are preserved
+
+    Expected Outcome:
+        - from_dict should accept camelCase and map to snake_case attributes
+        - DataclassSerializer should map snake_case attributes back to camelCase
+        - Data should be preserved through the roundtrip
+    """
+    # Arrange - Generate client in temporary directory
+    spec_path = "input/business_swagger.json"
+    with tempfile.TemporaryDirectory() as tmpdir:
+        project_root = Path(tmpdir)
+
+        # Generate client
+        generate_client(
+            spec_path=spec_path,
+            project_root=str(project_root),
+            output_package="businessapi",
+            force=True,
+            no_postprocess=True,  # Skip formatting for speed
+        )
+
+        # Import generated model dynamically
+        import sys
+
+        sys.path.insert(0, str(project_root))
+        from businessapi.core.utils import DataclassSerializer
+        from businessapi.models.document_update import DocumentUpdate
+
+        # Act - Create from API response (camelCase)
+        api_response = {
+            "url": "https://example.com/doc",
+            "dataSourceId": "source-456",
+            "mimeType": "application/json",
+            "lastModified": "2024-10-23T15:30:00Z",
+        }
+        doc_update = DocumentUpdate.from_dict(api_response)
+
+        # Verify attributes are accessible via snake_case
+        assert doc_update.data_source_id == "source-456"
+        assert doc_update.mime_type == "application/json"
+        assert doc_update.last_modified == "2024-10-23T15:30:00Z"
+
+        # Act - Serialize back (should produce camelCase)
+        result = DataclassSerializer.serialize(doc_update)
+
+        # Assert - Should match original API response format
+        assert result["dataSourceId"] == "source-456"
+        assert result["mimeType"] == "application/json"
+        assert result["lastModified"] == "2024-10-23T15:30:00Z"
+
+        # Cleanup
+        sys.path.remove(str(project_root))
+
+
+if __name__ == "__main__":
+    pytest.main([__file__, "-v"])