Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/generator reduction #219

Merged
merged 17 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from 3 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
11 changes: 10 additions & 1 deletion kiota_abstractions/base_request_configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@
# ------------------------------------
from dataclasses import dataclass
from typing import Dict, List, Optional
from warnings import warn

from .default_query_parameters import QueryParameters
from .headers_collection import HeadersCollection
from .request_option import RequestOption
baywet marked this conversation as resolved.
Show resolved Hide resolved


@dataclass
class BaseRequestConfiguration:
class RequestConfiguration:
"""
Configuration for the request such as headers, query parameters, and middleware options.
"""
Expand All @@ -23,3 +24,11 @@ class BaseRequestConfiguration:
options: Optional[List[RequestOption]] = None

query_parameters: Optional[QueryParameters] = None


@dataclass
class BaseRequestConfiguration:
samwelkanda marked this conversation as resolved.
Show resolved Hide resolved
warn(
"BaseRequestConfiguration is deprecated. Use RequestConfiguration class instead.",
DeprecationWarning
)
22 changes: 21 additions & 1 deletion kiota_abstractions/default_query_parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
# See License in the project root for license information.
# ------------------------------------
from dataclasses import dataclass
from typing import List, Optional
from warnings import warn


Expand All @@ -12,7 +13,26 @@ class QueryParameters:
"""
Default placeholder class for query parameters.
"""
pass
# Include count of items
count: Optional[bool] = None

# Expand related entities
expand: Optional[List[str]] = None

# Filter items by property values
filter: Optional[str] = None

# Order items by property values
orderby: Optional[List[str]] = None

# Select properties to be returned
select: Optional[List[str]] = None

# Skip the first n items
skip: Optional[int] = None

# Show only the first n items
top: Optional[int] = None
baywet marked this conversation as resolved.
Show resolved Hide resolved


@dataclass
Expand Down
4 changes: 2 additions & 2 deletions kiota_abstractions/request_information.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from stduritemplate import StdUriTemplate

from ._version import VERSION
from .base_request_configuration import BaseRequestConfiguration
from .base_request_configuration import RequestConfiguration
from .default_query_parameters import QueryParameters
from .headers_collection import HeadersCollection
from .method import Method
Expand Down Expand Up @@ -70,7 +70,7 @@ def __init__(
# The Request Body
self.content: Optional[BytesIO] = None

def configure(self, request_configuration: BaseRequestConfiguration) -> None:
def configure(self, request_configuration: RequestConfiguration) -> None:
"""Configures the current request information headers, query parameters, and options
based on the request configuration provided

Expand Down
16 changes: 9 additions & 7 deletions tests/test_request_information.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from kiota_abstractions.request_information import RequestInformation
from kiota_abstractions.headers_collection import HeadersCollection
from kiota_abstractions.base_request_configuration import BaseRequestConfiguration
from kiota_abstractions.base_request_configuration import RequestConfiguration
from kiota_abstractions.default_query_parameters import QueryParameters


Expand Down Expand Up @@ -91,7 +91,7 @@ def test_set_stream_content(mock_request_information):
def test_configure_empty_configuration(mock_request_information):
"""Tests configuring the request information
"""
request_config = BaseRequestConfiguration()
request_config = RequestConfiguration()
mock_request_information.configure(request_config)
assert not mock_request_information.headers.get_all()
assert not mock_request_information.request_options
Expand All @@ -113,20 +113,22 @@ def get_query_parameter(self,original_name: Optional[str] = None) -> str:
"""
if not original_name:
raise TypeError("original_name cannot be null.")
if original_name == "query1":
return "%24query1"
if original_name == "filter":
return "%24filter"

query_params = CustomParams(query1="value1")
query_params = CustomParams(filter="query1")

headers = HeadersCollection()
headers.add("header1", "value1")
headers.add("header2", "value2")

request_config = BaseRequestConfiguration(headers=headers, query_parameters=query_params)
request_config = RequestConfiguration(headers=headers, query_parameters=query_params)


mock_request_information.configure(request_config)
assert mock_request_information.headers.get("header1") == {"value1"}
assert mock_request_information.headers.get("header2") == {"value2"}
assert mock_request_information.query_parameters == {"%24query1": "value1"}
key, value = "%24filter", "query1"
assert (key in mock_request_information.query_parameters
and mock_request_information.query_parameters[key] == value)
assert not mock_request_information.request_options
Loading