diff --git a/.chronus/changes/http-client-python-model-query-expansion.md b/.chronus/changes/http-client-python-model-query-expansion.md new file mode 100644 index 00000000000..08db40862a8 --- /dev/null +++ b/.chronus/changes/http-client-python-model-query-expansion.md @@ -0,0 +1,7 @@ +--- +changeKind: fix +packages: + - "@typespec/http-client-python" +--- + +Serialize named model query parameters using form-style expansion, including exploded properties and query continuation routes. diff --git a/packages/http-client-python/emitter/src/utils.ts b/packages/http-client-python/emitter/src/utils.ts index 526f8eafb84..c37430e0fbd 100644 --- a/packages/http-client-python/emitter/src/utils.ts +++ b/packages/http-client-python/emitter/src/utils.ts @@ -133,6 +133,9 @@ export function isAbstract( export function getDelimiterAndExplode( parameter: SdkQueryParameter | SdkHeaderParameter, ): [string | undefined, boolean] { + if (parameter.kind === "query" && parameter.type.kind === "model") { + return [undefined, parameter.explode]; + } if (parameter.type.kind !== "array") return [undefined, false]; let delimiter: string | undefined = undefined; let explode = parameter.kind === "query" && parameter.explode; 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 6f4e9d5390c..dbf029129d1 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 @@ -15,6 +15,7 @@ ClientParameter, ConfigParameter, ParameterType, + ModelType, ) from ..models.parameter import _ParameterBase from ..models.parameter_list import BodyParameterType @@ -164,11 +165,24 @@ def serialize_query_header( f""" _headers[{python_string_literal(header_name)}] = _SERIALIZER.header("if_none_match", if_none_match, "str")""", ] - set_parameter = "_{}[{}] = {}".format( - kwarg_name, - python_string_literal(param.wire_name, quote="'"), - self.serialize_parameter(param, serializer_name), - ) + if not is_legacy and param.location == ParameterLocation.QUERY and isinstance(param.type, ModelType): + serialized_model = ( + f"{serializer_name}.query_model({python_string_literal(param.full_client_name)}, " + f"{param.full_client_name}, skip_quote={param.skip_url_encoding})" + ) + if param.explode: + set_parameter = f"_{kwarg_name}.update({serialized_model})" + else: + set_parameter = ( + f"_{kwarg_name}[{python_string_literal(param.wire_name)}] = " + f"','.join(component for pair in {serialized_model}.items() for component in pair)" + ) + else: + set_parameter = "_{}[{}] = {}".format( + kwarg_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 # was sent). In that case the header must be omitted instead of serialized, otherwise # ``_SERIALIZER.header`` raises ``ValueError: No value for given attribute``. diff --git a/packages/http-client-python/generator/pygen/codegen/templates/serialization.py.jinja2 b/packages/http-client-python/generator/pygen/codegen/templates/serialization.py.jinja2 index 8194e5c1566..8d5e66bdf19 100644 --- a/packages/http-client-python/generator/pygen/codegen/templates/serialization.py.jinja2 +++ b/packages/http-client-python/generator/pygen/codegen/templates/serialization.py.jinja2 @@ -748,6 +748,26 @@ class Serializer: # pylint: disable=too-many-public-methods raise TypeError("{} must be type {}.".format(name, data_type)) from exc return str(output) + def query_model(self, name, data, **kwargs): + """Serialize a model's wire-name/value pairs for form-style query expansion. + + :param str name: The name of the query parameter. + :param Mapping data: The model or mapping to serialize. + :keyword bool skip_quote: Whether to skip URL encoding. + :return: Individually encoded property names and values. + :rtype: dict[str, str] + :raises ValueError: if data is None. + """ + if data is None: + raise ValueError("No value for given attribute: {}".format(name)) + return { + self.query(name, key, "str", **kwargs): self.query( + name, value, "bool" if isinstance(value, bool) else "str", **kwargs + ) + for key, value in data.items() + if value is not None + } + def header(self, name, data, data_type, **kwargs): """Serialize data intended for a request header. diff --git a/packages/http-client-python/tests/mock_api/shared/asynctests/test_routes_async.py b/packages/http-client-python/tests/mock_api/shared/asynctests/test_routes_async.py index d3e34bc1f93..dc04ce07850 100644 --- a/packages/http-client-python/tests/mock_api/shared/asynctests/test_routes_async.py +++ b/packages/http-client-python/tests/mock_api/shared/asynctests/test_routes_async.py @@ -6,6 +6,7 @@ import pytest import pytest_asyncio from routes.aio import RoutesClient +from routes.models import ExpandParameters @pytest_asyncio.fixture @@ -19,6 +20,14 @@ async def test_fixed(client: RoutesClient): await client.fixed() +@pytest.mark.asyncio +@pytest.mark.parametrize("expansion", ["query_expansion", "query_continuation"]) +@pytest.mark.parametrize("style", ["standard", "explode"]) +async def test_query_parameters_model(client: RoutesClient, expansion: str, style: str): + operation = getattr(getattr(client.query_parameters, expansion), style) + await operation.model(param=ExpandParameters(field="status", value="active")) + + @pytest.mark.asyncio async def test_in_interface_fixed(client: RoutesClient): await client.in_interface.fixed() diff --git a/packages/http-client-python/tests/mock_api/shared/test_routes.py b/packages/http-client-python/tests/mock_api/shared/test_routes.py index e1058d06657..fcc6a9c78e4 100644 --- a/packages/http-client-python/tests/mock_api/shared/test_routes.py +++ b/packages/http-client-python/tests/mock_api/shared/test_routes.py @@ -5,6 +5,7 @@ # -------------------------------------------------------------------------- import pytest from routes import RoutesClient +from routes.models import ExpandParameters @pytest.fixture @@ -213,6 +214,13 @@ def test_query_parameters_annotation_only(client: RoutesClient): ) +@pytest.mark.parametrize("expansion", ["query_expansion", "query_continuation"]) +@pytest.mark.parametrize("style", ["standard", "explode"]) +def test_query_parameters_model(client: RoutesClient, expansion: str, style: str): + operation = getattr(getattr(client.query_parameters, expansion), style) + operation.model(param=ExpandParameters(field="status", value="active")) + + def test_query_parameters_query_expansion_standard_primitive(client: RoutesClient): client.query_parameters.query_expansion.standard.primitive( param="a", diff --git a/packages/http-client-python/tests/unit/test_query_model_serialization.py b/packages/http-client-python/tests/unit/test_query_model_serialization.py new file mode 100644 index 00000000000..084987f0012 --- /dev/null +++ b/packages/http-client-python/tests/unit/test_query_model_serialization.py @@ -0,0 +1,42 @@ +# ------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for +# license information. +# -------------------------------------------------------------------------- +from types import SimpleNamespace + +import pytest +from jinja2 import Environment, PackageLoader + + +@pytest.fixture(scope="session", autouse=True) +def testserver(): + yield + + +@pytest.fixture +def serializer(): + env = Environment(loader=PackageLoader("pygen.codegen", "templates")) + source = env.get_template("serialization.py.jinja2").render( + code_model=SimpleNamespace(license_header="", core_library="corehttp") + ) + namespace = {} + exec(compile(source, "", "exec"), namespace) + return namespace["Serializer"]() + + +def test_query_model_quotes_components_and_preserves_falsy_values(serializer): + result = serializer.query_model( + "filter", + {"wire,name": "a,b & c", "enabled": False, "count": 0, "empty": "", "omitted": None}, + ) + assert result == {"wire%2Cname": "a%2Cb%20%26%20c", "enabled": "false", "count": "0", "empty": ""} + + +def test_query_model_skip_url_encoding(serializer): + assert serializer.query_model("filter", {"wire,name": "a,b"}, skip_quote=True) == {"wire,name": "a,b"} + + +def test_query_model_rejects_missing_required_model(serializer): + with pytest.raises(ValueError, match="filter"): + serializer.query_model("filter", None)