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
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
36 changes: 26 additions & 10 deletions kiota_abstractions/request_information.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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:
Expand Down
12 changes: 11 additions & 1 deletion tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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()
Expand Down
39 changes: 38 additions & 1 deletion tests/test_request_information.py
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Expand Down Expand Up @@ -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
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"