From c9e9e97b2434506f67ed051b6b56978e6a5a757c Mon Sep 17 00:00:00 2001 From: Akhil Gupta Date: Thu, 5 Nov 2026 03:17:04 -0800 Subject: [PATCH 1/5] fix(http-client-python): escape wire names in request-builder literals --- .../codegen/serializers/parameter_serializer.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py index 86d8ef2cdea..af6efb072f9 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py @@ -18,6 +18,7 @@ ) from ..models.parameter import _ParameterBase from ..models.parameter_list import BodyParameterType +from ..models.utils import python_string_literal class PopKwargType(Enum): @@ -119,8 +120,8 @@ def serialize_path( retval = ["path_format_arguments = {"] retval.extend( [ - ' "{}": {},'.format( - path_parameter.wire_name, + " {}: {},".format( + python_string_literal(path_parameter.wire_name), ( f'"" if {path_parameter.full_client_name} is None else "/" + {self.serialize_parameter(path_parameter, serializer_name)}' if path_parameter.optional and isinstance(path_parameter, RequestBuilderParameter) @@ -155,17 +156,17 @@ def serialize_query_header( return [ """if_match = prep_if_match(etag, match_condition)""", """if if_match is not None:""", - f""" _headers["{header_name}"] = _SERIALIZER.header("if_match", if_match, "str")""", + f""" _headers[{python_string_literal(header_name)}] = _SERIALIZER.header("if_match", if_match, "str")""", ] return [ """if_none_match = prep_if_none_match(etag, match_condition)""", """if if_none_match is not None:""", - f""" _headers["{header_name}"] = _SERIALIZER.header("if_none_match", if_none_match, "str")""", + f""" _headers[{python_string_literal(header_name)}] = _SERIALIZER.header("if_none_match", if_none_match, "str")""", ] - set_parameter = "_{}['{}'] = {}".format( + set_parameter = "_{}[{}] = {}".format( kwarg_name, - param.wire_name, + python_string_literal(param.wire_name, quote="'"), self.serialize_parameter(param, serializer_name), ) # When the body is optional, the content-type may legitimately be ``None`` (no body @@ -231,7 +232,7 @@ def append_pop_kwarg(key: str, pop_type: PopKwargType) -> None: default_value = kwarg.client_default_value_declaration if check_kwarg_dict and (kwarg.location in [ParameterLocation.HEADER, ParameterLocation.QUERY]): kwarg_dict = "headers" if kwarg.location == ParameterLocation.HEADER else "params" - default_value = f"_{kwarg_dict}.pop('{kwarg.wire_name}', {default_value})" + default_value = f"_{kwarg_dict}.pop({python_string_literal(kwarg.wire_name)}, {default_value})" retval.append( f"{kwarg.client_name}: {type_annotation} = kwargs.pop('{kwarg.client_name}', " + f"{default_value})" From 20147ecc7362ad8722a0f554430a5f86282b29b7 Mon Sep 17 00:00:00 2001 From: Akhil Gupta Date: Thu, 5 Nov 2026 03:17:51 -0800 Subject: [PATCH 2/5] test(http-client-python): add regression tests for wire-name literals --- .../tests/unit/test_string_literals.py | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/packages/http-client-python/tests/unit/test_string_literals.py b/packages/http-client-python/tests/unit/test_string_literals.py index 7d0dc9c3188..28ce07fa8a9 100644 --- a/packages/http-client-python/tests/unit/test_string_literals.py +++ b/packages/http-client-python/tests/unit/test_string_literals.py @@ -31,6 +31,7 @@ from pygen.codegen.serializers.builder_serializer import OperationSerializer, _get_polymorphic_subtype_template from pygen.codegen.serializers.model_serializer import DpgModelSerializer from pygen.codegen.serializers.general_serializer import GeneralSerializer +from pygen.codegen.serializers.parameter_serializer import ParameterSerializer, PopKwargType from pygen.codegen.serializers.types_serializer import TypesSerializer from pygen.codegen.serializers.utils import json_dumps_template @@ -753,3 +754,60 @@ def test_enum_values_are_literals(code_model, env, value): assignments = [node for node in ast.walk(ast.parse(source)) if isinstance(node, ast.Assign)] assignment = next(node for node in assignments if any(getattr(t, "id", "") == "VALUE" for t in node.targets)) assert ast.literal_eval(assignment.value) == value + + +def _request_parameter(code_model, wire_name, location, optional=False, client_default_value=None): + yaml_data = { + "wireName": wire_name, + "clientName": "filter", + "location": location, + "implementation": "Method", + "optional": optional, + "description": "Example parameter.", + } + if client_default_value is not None: + yaml_data["clientDefaultValue"] = client_default_value + return Parameter( + yaml_data, + code_model, + type=StringType({"type": "string"}, code_model), + ) + + +@pytest.mark.parametrize("wire_name", [name for name in VALUES if name]) +@pytest.mark.parametrize("location", ["query", "header"]) +def test_request_builder_wire_names_are_literals(code_model, wire_name, location): + parameter = _request_parameter(code_model, wire_name, location) + kwarg_name = "params" if location == "query" else "headers" + lines = ParameterSerializer("sample").serialize_query_header( + parameter, kwarg_name, "_SERIALIZER", is_legacy=False + ) + module = ast.parse("def build_request():\n " + "\n ".join(lines)) + assignment = module.body[0].body[0] + assert isinstance(assignment, ast.Assign) + assert ast.literal_eval(assignment.targets[0].slice) == wire_name + + +@pytest.mark.parametrize("wire_name", [name for name in VALUES if name]) +def test_path_wire_names_are_literals(code_model, wire_name): + parameter = _request_parameter(code_model, wire_name, "path") + lines = ParameterSerializer("sample").serialize_path([parameter], "_SERIALIZER") + module = ast.parse("\n".join(lines)) + arguments = module.body[0].value + assert isinstance(arguments, ast.Dict) + assert [ast.literal_eval(key) for key in arguments.keys] == [wire_name] + + +@pytest.mark.parametrize("wire_name", [name for name in VALUES if name]) +def test_kwargs_pop_wire_names_are_literals(code_model, wire_name): + parameter = _request_parameter( + code_model, wire_name, "query", optional=True, client_default_value="dflt" + ) + lines = ParameterSerializer("sample").pop_kwargs_from_signature( + [parameter], True, PopKwargType.NO, PopKwargType.SIMPLE + ) + signature = next(line for line in lines if line.startswith("filter:")) + function = ast.parse(f"def build_request({signature}): pass").body[0] + outer_pop = function.args.defaults[0] + inner_pop = outer_pop.args[1] + assert ast.literal_eval(inner_pop.args[0]) == wire_name From d2104895a0eca24ad3d8d8782a35a11e3df0efc9 Mon Sep 17 00:00:00 2001 From: Akhil Gupta Date: Thu, 5 Nov 2026 04:57:19 -0800 Subject: [PATCH 3/5] fix(http-client-python): preserve single quotes for popped header/query kwargs --- .../pygen/codegen/serializers/parameter_serializer.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py b/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py index af6efb072f9..6f4e9d5390c 100644 --- a/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py +++ b/packages/http-client-python/generator/pygen/codegen/serializers/parameter_serializer.py @@ -232,7 +232,8 @@ def append_pop_kwarg(key: str, pop_type: PopKwargType) -> None: default_value = kwarg.client_default_value_declaration if check_kwarg_dict and (kwarg.location in [ParameterLocation.HEADER, ParameterLocation.QUERY]): kwarg_dict = "headers" if kwarg.location == ParameterLocation.HEADER else "params" - default_value = f"_{kwarg_dict}.pop({python_string_literal(kwarg.wire_name)}, {default_value})" + wire_literal = python_string_literal(kwarg.wire_name, quote="'") + default_value = f"_{kwarg_dict}.pop({wire_literal}, {default_value})" retval.append( f"{kwarg.client_name}: {type_annotation} = kwargs.pop('{kwarg.client_name}', " + f"{default_value})" From a6277a31366ee6c9d8d9b69580feeb56411763d8 Mon Sep 17 00:00:00 2001 From: Akhil Gupta Date: Thu, 5 Nov 2026 04:58:29 -0800 Subject: [PATCH 4/5] Add chronus change file for wire-name literal fix --- .chronus/changes/fix-wire-name-literals-2026-11-5.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .chronus/changes/fix-wire-name-literals-2026-11-5.md diff --git a/.chronus/changes/fix-wire-name-literals-2026-11-5.md b/.chronus/changes/fix-wire-name-literals-2026-11-5.md new file mode 100644 index 00000000000..29546540069 --- /dev/null +++ b/.chronus/changes/fix-wire-name-literals-2026-11-5.md @@ -0,0 +1,7 @@ +--- +changeKind: fix +packages: + - "@typespec/http-client-python" +--- + +Fix wire names with quotes in generated request-builder code by escaping them through the shared string-literal helper, preserving the existing single-quoted output for popped header/query kwargs. From bf7108012f9383e8435ad8518463ff77c18229d9 Mon Sep 17 00:00:00 2001 From: Akhil Gupta Date: Thu, 5 Nov 2026 12:10:11 -0800 Subject: [PATCH 5/5] Fix spell check: change dflt to default in test_kwargs_pop_wire_names --- packages/http-client-python/tests/unit/test_string_literals.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/http-client-python/tests/unit/test_string_literals.py b/packages/http-client-python/tests/unit/test_string_literals.py index 28ce07fa8a9..365fc457c94 100644 --- a/packages/http-client-python/tests/unit/test_string_literals.py +++ b/packages/http-client-python/tests/unit/test_string_literals.py @@ -801,7 +801,7 @@ def test_path_wire_names_are_literals(code_model, wire_name): @pytest.mark.parametrize("wire_name", [name for name in VALUES if name]) def test_kwargs_pop_wire_names_are_literals(code_model, wire_name): parameter = _request_parameter( - code_model, wire_name, "query", optional=True, client_default_value="dflt" + code_model, wire_name, "query", optional=True, client_default_value="default" ) lines = ParameterSerializer("sample").pop_kwargs_from_signature( [parameter], True, PopKwargType.NO, PopKwargType.SIMPLE