From 6dac9d2c05a2c6ab7861361b5b8c4d7053a557ea Mon Sep 17 00:00:00 2001 From: samwelkanda Date: Tue, 6 Feb 2024 09:49:15 +0300 Subject: [PATCH 1/3] Fixes enum path and query parameter serialization --- kiota_abstractions/request_information.py | 36 ++++++++++++++++------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/kiota_abstractions/request_information.py b/kiota_abstractions/request_information.py index fb2fa4a3..37e02de9 100644 --- a/kiota_abstractions/request_information.py +++ b/kiota_abstractions/request_information.py @@ -1,5 +1,6 @@ -from dataclasses import dataclass, fields +from dataclasses import fields, is_dataclass from datetime import date, datetime, time, timedelta +from enum import Enum from io import BytesIO from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Set, TypeVar, Union from urllib.parse import unquote @@ -100,8 +101,10 @@ def url(self) -> Url: data: Dict[str, Any] = {} for key, val in self.query_parameters.items(): + val = self._replace_enum_values_with_string_representation(val) data[key] = val for key, val in self.path_parameters.items(): + val = self._replace_enum_values_with_string_representation(val) data[key] = val result = StdUriTemplate.expand(self.url_template, data) @@ -227,15 +230,16 @@ def set_stream_content(self, value: BytesIO, content_type: Optional[str] = None) def set_query_string_parameters_from_raw_object(self, q: Optional[QueryParameters]) -> None: if q: - for field in fields(q): # type: ignore - key = field.name - if hasattr(q, "get_query_parameter"): - serialization_key = q.get_query_parameter(key) # type: ignore - if serialization_key: - key = serialization_key - value = getattr(q, field.name) - if value is not None: - self.query_parameters[key] = value + if is_dataclass(q): + for field in fields(q): + key = field.name + if hasattr(q, "get_query_parameter"): + serialization_key = q.get_query_parameter(key) # type: ignore + if serialization_key: + key = serialization_key + value = getattr(q, field.name) + if value is not None: + self.query_parameters[key] = value def _get_serialization_writer( self, @@ -277,6 +281,18 @@ def _set_content_and_content_type_header( self.headers.try_add(self.CONTENT_TYPE_HEADER, content_type) self.content = writer.get_serialized_content() + def _replace_enum_values_with_string_representation(self, value: Any) -> Any: + """Replaces enum values with their string representation. + + Args: + value (Any): The value to replace. + """ + if isinstance(value, Enum): + return value.value + if isinstance(value, list) and all(isinstance(x, Enum) for x in value): + return ','.join([x.value for x in value]) + return value + def _decode_uri_string(self, uri: Optional[str]) -> str: """Decodes a URI encoded string.""" if uri and "%" in uri: From 4a69bdb3ca5839f8790fd8124f24801fd73d7ca3 Mon Sep 17 00:00:00 2001 From: samwelkanda Date: Tue, 6 Feb 2024 09:49:26 +0300 Subject: [PATCH 2/3] Update tests --- tests/conftest.py | 12 +++++++++- tests/test_request_information.py | 39 ++++++++++++++++++++++++++++++- 2 files changed, 49 insertions(+), 2 deletions(-) diff --git a/tests/conftest.py b/tests/conftest.py index 138d0f80..45051974 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -7,7 +7,8 @@ from __future__ import annotations from dataclasses import dataclass, field -from typing import Any, Callable, Dict, List, Optional, Tuple +from enum import Enum +from typing import Any, Callable, Dict, List, Optional, Tuple, Union import pytest @@ -105,6 +106,15 @@ def serialize(self, writer: SerializationWriter) -> None: writer.write_collection_of_object_values("colleagues", self.colleagues) +class TestEnum(Enum): + VALUE1 = "value1" + VALUE2 = "value2" + VALUE3 = "value3" + +@dataclass +class QueryParams: + dataset: Union[TestEnum, List[TestEnum]] + @pytest.fixture def mock_user(): user = MockEntity() diff --git a/tests/test_request_information.py b/tests/test_request_information.py index e83a88cc..aad52093 100644 --- a/tests/test_request_information.py +++ b/tests/test_request_information.py @@ -5,6 +5,10 @@ from kiota_abstractions.request_information import RequestInformation from kiota_abstractions.headers_collection import HeadersCollection from kiota_abstractions.base_request_configuration import RequestConfiguration +from kiota_abstractions.method import Method + +from .conftest import TestEnum, QueryParams + def test_initialization(): @@ -126,4 +130,37 @@ def get_query_parameter(self,original_name: Optional[str] = None) -> str: assert mock_request_information.headers.get("header1") == {"value1"} assert mock_request_information.headers.get("header2") == {"value2"} assert mock_request_information.query_parameters == {"%24filter": "query1"} - assert not mock_request_information.request_options \ No newline at end of file + assert not mock_request_information.request_options + + +def test_sets_enum_value_in_query_parameters(): + """Tests setting enum values in query parameters + """ + + request_info = RequestInformation(Method.GET, "https://example.com/me{?dataset}") + request_info.set_query_string_parameters_from_raw_object(QueryParams(TestEnum.VALUE1)) + assert request_info.url == "https://example.com/me?dataset=value1" + +def test_sets_enum_values_in_query_parameters(): + """Tests setting enum values in query parameters + """ + + request_info = RequestInformation(Method.GET, "https://example.com/me{?dataset}") + request_info.set_query_string_parameters_from_raw_object(QueryParams([TestEnum.VALUE1, TestEnum.VALUE2])) + assert request_info.url == "https://example.com/me?dataset=value1%2Cvalue2" + +def test_sets_enum_value_in_path_parameters(): + """Tests setting enum values in path parameters + """ + request_info = RequestInformation(Method.GET, "https://example.com/{dataset}") + request_info.path_parameters["dataset"] = TestEnum.VALUE1 + assert request_info.url == "https://example.com/value1" + +def test_sets_enum_values_in_path_parameters(): + """Tests setting enum values in path parameters + """ + request_info = RequestInformation(Method.GET, "https://example.com/{dataset}") + request_info.path_parameters["dataset"] = [TestEnum.VALUE1, TestEnum.VALUE2] + assert request_info.url == "https://example.com/value1%2Cvalue2" + + \ No newline at end of file From a6923d571099224ad99300c884f320a267f4b9c8 Mon Sep 17 00:00:00 2001 From: samwelkanda Date: Tue, 6 Feb 2024 09:53:06 +0300 Subject: [PATCH 3/3] Add CHANGELOG entry --- CHANGELOG.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f60d2ba2..f3b052ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [1.2.0] - 2024-01-31 ### Added -- Added methods in request information to reduce the amount of code being generated. +- Added methods in request information to reduce the amount of code being generated. [microsoft/kiota#3695](https://github.com/microsoft/kiota/issues/3695) + +### Changed +- Fixed an issue where path and query parameters of enum type would not be expanded properly. [microsoft/kiota#3783](https://github.com/microsoft/kiota/issues/3783) ## [1.1.0] - 2024-01-25