Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/fix-wire-name-literals-2026-11-5.md
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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="'"),
Comment thread
akhil9tiet marked this conversation as resolved.
Resolved
self.serialize_parameter(param, serializer_name),
)
# When the body is optional, the content-type may legitimately be ``None`` (no body
Expand Down Expand Up @@ -231,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('{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})"
Expand Down
58 changes: 58 additions & 0 deletions packages/http-client-python/tests/unit/test_string_literals.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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="default"
)
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
Loading