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

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

@@ -1,6 +1,88 @@
 # CHANGELOG
 
 
+## v0.21.1 (2025-10-24)
+
+### Bug Fixes
+
+- **codegen**: Fix enum parameter serialization in query, header, and path parameters
+  ([`be5391f`](https://github.com/mindhiveoy/pyopenapi_gen/commit/be5391ff9fde14a1826aa217c077b06a0f832f8c))
+
+Implement consistent parameter serialization using DataclassSerializer.serialize() for query,
+  header, and path parameters to handle enum-to-string conversion correctly.
+
+Technical changes: - _write_query_params() now wraps all parameter values in
+  DataclassSerializer.serialize() - _write_header_params() now wraps all parameter values in
+  DataclassSerializer.serialize() - generate_url_and_args() serializes path params before f-string
+  interpolation - Added context.add_import() calls to ensure DataclassSerializer is imported in
+  generated code
+
+Implementation approach: Query/header parameters use DataclassSerializer.serialize() in dict
+  construction: Required: "{param}": DataclassSerializer.serialize(param_var)
+
+Optional: **{{"{param}": DataclassSerializer.serialize(param_var)} if param_var is not None else {}}
+
+Path parameters are serialized before URL construction to prevent enum objects in f-strings (would
+  produce "EnumType.VALUE" instead of "value"): param_var = DataclassSerializer.serialize(param_var)
+
+Breaking changes: None API changes: None (generated code behavior corrected to match intended
+  design)
+
+Test coverage: - 5 new TDD tests validate enum serialization for all parameter types - All 1360
+  tests passing with 88.43% coverage - Integration tests confirm correct mypy validation and runtime
+  behavior
+
+Fixes issue where enum parameters (e.g., DocumentStatus.INDEXED) were passed directly to httpx
+  instead of being converted to their string values ("indexed"), causing incorrect API calls.
+
+Related: business_swagger.json list_documents endpoint with status parameter
+
+### Chores
+
+- **release**: Sync __init__.py version [skip ci]
+  ([`823dc4e`](https://github.com/mindhiveoy/pyopenapi_gen/commit/823dc4e7083f17df7323aeebd9a400fd9d7aca5d))
+
+
+## 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.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyopenapi-gen
-Version: 0.20.1
+Version: 0.21.1
 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.1}/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="1761323025794" lines-valid="6528" lines-covered="5773" line-rate="0.8843" 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">
@@ -6008,7 +6019,7 @@
 				</class>
 			</classes>
 		</package>
-		<package name="pyopenapi_gen.visit.endpoint.generators" line-rate="0.8884" branch-rate="0" complexity="0">
+		<package name="pyopenapi_gen.visit.endpoint.generators" line-rate="0.89" branch-rate="0" complexity="0">
 			<classes>
 				<class name="__init__.py" filename="pyopenapi_gen/visit/endpoint/generators/__init__.py" complexity="0" line-rate="1" branch-rate="0">
 					<methods/>
@@ -6658,7 +6669,7 @@
 						<line number="83" hits="1"/>
 					</lines>
 				</class>
-				<class name="url_args_generator.py" filename="pyopenapi_gen/visit/endpoint/generators/url_args_generator.py" complexity="0" line-rate="0.9882" branch-rate="0">
+				<class name="url_args_generator.py" filename="pyopenapi_gen/visit/endpoint/generators/url_args_generator.py" complexity="0" line-rate="0.9895" branch-rate="0">
 					<methods/>
 					<lines>
 						<line number="5" hits="1"/>
@@ -6678,74 +6689,84 @@
 						<line number="41" hits="1"/>
 						<line number="42" hits="1"/>
 						<line number="44" hits="0"/>
-						<line number="46" hits="1"/>
 						<line number="47" hits="1"/>
-						<line number="48" hits="1"/>
 						<line number="49" hits="1"/>
+						<line number="50" hits="1"/>
 						<line number="51" hits="1"/>
 						<line number="52" hits="1"/>
+						<line number="54" hits="1"/>
 						<line number="55" hits="1"/>
 						<line number="60" hits="1"/>
-						<line number="67" hits="1"/>
-						<line number="69" hits="1"/>
-						<line number="70" hits="1"/>
-						<line number="73" hits="1"/>
-						<line number="74" hits="1"/>
+						<line number="65" hits="1"/>
+						<line number="72" hits="1"/>
+						<line number="75" hits="1"/>
 						<line number="76" hits="1"/>
-						<line number="77" hits="1"/>
+						<line number="78" hits="1"/>
+						<line number="79" hits="1"/>
 						<line number="82" hits="1"/>
-						<line number="87" hits="1"/>
+						<line number="83" hits="1"/>
+						<line number="85" hits="1"/>
+						<line number="86" hits="1"/>
+						<line number="93" hits="1"/>
 						<line number="98" hits="1"/>
-						<line number="99" hits="1"/>
-						<line number="100" hits="1"/>
-						<line number="104" hits="1"/>
-						<line number="105" hits="1"/>
-						<line number="106" hits="1"/>
-						<line number="107" hits="1"/>
-						<line number="108" hits="1"/>
-						<line number="110" hits="1"/>
-						<line number="112" hits="1"/>
 						<line number="113" hits="1"/>
+						<line number="114" hits="1"/>
 						<line number="116" hits="1"/>
 						<line number="117" hits="1"/>
 						<line number="118" hits="1"/>
 						<line number="119" hits="1"/>
 						<line number="120" hits="1"/>
 						<line number="122" hits="1"/>
+						<line number="123" hits="1"/>
 						<line number="124" hits="1"/>
-						<line number="125" hits="1"/>
+						<line number="128" hits="1"/>
 						<line number="129" hits="1"/>
+						<line number="130" hits="1"/>
 						<line number="131" hits="1"/>
-						<line number="133" hits="1"/>
+						<line number="132" hits="1"/>
 						<line number="134" hits="1"/>
-						<line number="135" hits="1"/>
 						<line number="136" hits="1"/>
 						<line number="137" hits="1"/>
-						<line number="138" hits="1"/>
+						<line number="140" hits="1"/>
+						<line number="141" hits="1"/>
 						<line number="142" hits="1"/>
+						<line number="143" hits="1"/>
+						<line number="144" hits="1"/>
 						<line number="146" hits="1"/>
-						<line number="147" hits="1"/>
 						<line number="148" hits="1"/>
 						<line number="149" hits="1"/>
-						<line number="150" hits="1"/>
-						<line number="151" hits="1"/>
-						<line number="152" hits="1"/>
 						<line number="153" hits="1"/>
 						<line number="155" hits="1"/>
+						<line number="157" hits="1"/>
+						<line number="158" hits="1"/>
 						<line number="159" hits="1"/>
 						<line number="160" hits="1"/>
 						<line number="161" hits="1"/>
 						<line number="162" hits="1"/>
-						<line number="165" hits="1"/>
-						<line number="168" hits="1"/>
-						<line number="169" hits="1"/>
+						<line number="166" hits="1"/>
+						<line number="170" hits="1"/>
+						<line number="171" hits="1"/>
+						<line number="172" hits="1"/>
 						<line number="173" hits="1"/>
 						<line number="174" hits="1"/>
 						<line number="175" hits="1"/>
-						<line number="178" hits="1"/>
-						<line number="180" hits="1"/>
-						<line number="181" hits="1"/>
+						<line number="176" hits="1"/>
+						<line number="177" hits="1"/>
+						<line number="179" hits="1"/>
 						<line number="183" hits="1"/>
+						<line number="184" hits="1"/>
+						<line number="185" hits="1"/>
+						<line number="186" hits="1"/>
+						<line number="189" hits="1"/>
+						<line number="192" hits="1"/>
+						<line number="193" hits="1"/>
+						<line number="197" hits="1"/>
+						<line number="198" hits="1"/>
+						<line number="199" hits="1"/>
+						<line number="202" hits="1"/>
+						<line number="204" hits="1"/>
+						<line number="205" hits="1"/>
+						<line number="207" hits="1"/>
 					</lines>
 				</class>
 			</classes>

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyopenapi-gen"
-version = "0.20.1"
+version = "0.21.1"
 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.1"
 version_files = [
     "pyproject.toml:version",
     "src/pyopenapi_gen/__init__.py:__version__"

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.1}/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.1"
 
 # ---------------------------------------------------------------------------
 # Lazy-loading and autocompletion support (This part remains)

{pyopenapi_gen-0.20.1 → pyopenapi_gen-0.21.1}/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.1}/src/pyopenapi_gen/visit/endpoint/generators/url_args_generator.py

@@ -43,17 +43,22 @@ class EndpointUrlArgsGenerator:
             # writer.write_line("# No query parameters to write") # Optional: for clarity during debugging
             return
 
+        # Import DataclassSerializer since we use it for parameter serialization
+        context.add_import(f"{context.core_package_name}.utils", "DataclassSerializer")
+
         for i, p in enumerate(query_params_to_write):
             param_var_name = NameSanitizer.sanitize_method_name(p["name"])  # Ensure name is sanitized
             original_param_name = p["original_name"]
             line_end = ","  # Always add comma, let formatter handle final one if needed
 
             if p.get("required", False):
-                writer.write_line(f'    "{original_param_name}": {param_var_name}{line_end}')
+                writer.write_line(
+                    f'    "{original_param_name}": DataclassSerializer.serialize({param_var_name}){line_end}'
+                )
             else:
                 # Using dict unpacking for conditional parameters
                 writer.write_line(
-                    f'    **({{"{original_param_name}": {param_var_name}}} '
+                    f'    **({{"{original_param_name}": DataclassSerializer.serialize({param_var_name})}} '
                     f"if {param_var_name} is not None else {{}}){line_end}"
                 )
 
@@ -66,6 +71,10 @@ class EndpointUrlArgsGenerator:
         # if ordered_params is the sole source of truth for method params.
         header_params_to_write = [p for p in ordered_params if p.get("param_in") == "header"]
 
+        # Import DataclassSerializer since we use it for parameter serialization
+        if header_params_to_write:
+            context.add_import(f"{context.core_package_name}.utils", "DataclassSerializer")
+
         for p_info in header_params_to_write:
             param_var_name = NameSanitizer.sanitize_method_name(
                 p_info["name"]
@@ -74,13 +83,15 @@ class EndpointUrlArgsGenerator:
             line_end = ","
 
             if p_info.get("required", False):
-                writer.write_line(f'    "{original_header_name}": {param_var_name}{line_end}')
+                writer.write_line(
+                    f'    "{original_header_name}": DataclassSerializer.serialize({param_var_name}){line_end}'
+                )
             else:
                 # Conditional inclusion for optional headers
                 # This assumes that if an optional header parameter is None, it should not be sent.
                 # If specific behavior (e.g. empty string) is needed for None, logic would adjust.
                 writer.write_line(
-                    f'    **({{"{original_header_name}": {param_var_name}}} '
+                    f'    **({{"{original_header_name}": DataclassSerializer.serialize({param_var_name})}} '
                     f"if {param_var_name} is not None else {{}}){line_end}"
                 )
 
@@ -95,6 +106,19 @@ class EndpointUrlArgsGenerator:
     ) -> bool:
         """Writes URL, query, and header parameters. Returns True if header params were written."""
         # Main logic from EndpointMethodGenerator._write_url_and_args
+
+        # Serialize path parameters before URL construction
+        # This ensures enums, dates, and other complex types are converted to strings
+        # before f-string interpolation in the URL
+        path_params = [p for p in ordered_params if p.get("param_in") == "path"]
+        if path_params:
+            # Import DataclassSerializer since we use it for parameter serialization
+            context.add_import(f"{context.core_package_name}.utils", "DataclassSerializer")
+            for p in path_params:
+                param_var_name = NameSanitizer.sanitize_method_name(p["name"])
+                writer.write_line(f"{param_var_name} = DataclassSerializer.serialize({param_var_name})")
+            writer.write_line("")  # Blank line after path param serialization
+
         url_expr = self._build_url_with_path_vars(op.path)
         writer.write_line(f"url = {url_expr}")
         writer.write_line("")  # Add a blank line for readability