Skip to content

Fix for construct headers and queries when build request #2681

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.

Sign up for GitHub

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

Merged
iscai-msft merged 7 commits into from
Jul 8, 2024
Merged

Fix for construct headers and queries when build request #2681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
60f74ce
init
msyyc Jul 4, 2024
8d68581
changelog
msyyc Jul 4, 2024
1d00eb8
fix
msyyc Jul 5, 2024
536a1cd
fix
msyyc Jul 5, 2024
6627d1e
fix
msyyc Jul 5, 2024
a20e902
Update HEAD-2024-6-4-17-48-51.md
msyyc Jul 5, 2024
80da759
changelog
msyyc Jul 5, 2024
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
8 changes: 8 additions & 0 deletions .chronus/changes/fix-bug-header-2024-6-5-13-41-56.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
changeKind: fix
packages:
- "@autorest/python"
- "@azure-tools/typespec-python"
---

Fix for construct headers and queries when build request
1 change: 0 additions & 1 deletion ...illa/legacy/Expected/AcceptanceTests/BodyString/bodystring/operations/_enum_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@ def build_put_referenced_constant_request(**kwargs: Any) -> HttpRequest:

content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None))
accept = _headers.pop("Accept", "application/json")
color_constant = "green-color"
Copy link
Copy Markdown
Member Author

@msyyc msyyc Jul 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused variable


# Construct URL
_url = kwargs.pop("template_url", "/string/enum/ReferencedConstant")
Expand Down
13 changes: 9 additions & 4 deletions packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,14 +410,19 @@ def _json_response_template_name(self) -> str:
return "response.json()"

@staticmethod
def declare_non_inputtable_constants(builder: RequestBuilderType) -> List[str]:
def declare_non_inputtable_headers_queries(builder: RequestBuilderType) -> List[str]:
Copy link
Copy Markdown
Member Author

@msyyc msyyc Jul 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is used for "construct headers and queries" so we had better update the function name with its usage scenario:

autorest.python/packages/typespec-python/generator/pygen/codegen/serializers/builder_serializer.py

Lines 469 to 498 in 3b89887

def serialize_headers(self, builder: RequestBuilderType) -> List[str]:
headers = [
h
for h in builder.parameters.headers
if not builder.has_form_data_body or h.wire_name.lower() != "content-type"
]
retval = ["# Construct headers"] if headers else []
for header in headers:
retval.extend(
self.parameter_serializer.serialize_query_header(
header,
"headers",
self.serializer_name,
self.code_model.is_legacy,
)
)
return retval
def serialize_query(self, builder: RequestBuilderType) -> List[str]:
retval = ["# Construct parameters"]
for parameter in builder.parameters.query:
retval.extend(
self.parameter_serializer.serialize_query_header(
parameter,
"params",
self.serializer_name,
self.code_model.is_legacy,
)
)
return retval

def _get_value(param):
declaration = param.get_declaration() if param.constant else None
if param.location in [ParameterLocation.HEADER, ParameterLocation.QUERY]:
kwarg_dict = "headers" if param.location == ParameterLocation.HEADER else "params"
return f"_{kwarg_dict}.pop('{param.wire_name}', {param.get_declaration()})"
return f"{param.get_declaration()}"
return f"_{kwarg_dict}.pop('{param.wire_name}', {declaration})"
return declaration

return [f"{p.client_name} = {_get_value(p)}" for p in builder.parameters.constant if not p.in_method_signature]
return [
f"{p.client_name} = {_get_value(p)}"
for p in (builder.parameters.headers + builder.parameters.query)
if not p.in_method_signature
]

@property
def _function_def(self) -> str:
Expand Down
2 changes: 1 addition & 1 deletion packages/typespec-python/generator/pygen/codegen/serializers/parameter_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def serialize_query_header(
param.wire_name,
ParameterSerializer.serialize_parameter(param, serializer_name),
)
if not param.optional:
if not param.optional and (param.in_method_signature or param.constant):
retval = [set_parameter]
else:
retval = [
Expand Down
4 changes: 2 additions & 2 deletions packages/typespec-python/generator/pygen/codegen/templates/request_builder.py.jinja2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
{% if request_builder_serializer.pop_kwargs_from_signature(request_builder) %}
{{ op_tools.serialize(request_builder_serializer.pop_kwargs_from_signature(request_builder)) | indent }}
{%- endif -%}
{% if request_builder_serializer.declare_non_inputtable_constants(request_builder) %}
{{ op_tools.serialize(request_builder_serializer.declare_non_inputtable_constants(request_builder)) | indent }}
{% if request_builder_serializer.declare_non_inputtable_headers_queries(request_builder) %}
{{ op_tools.serialize(request_builder_serializer.declare_non_inputtable_headers_queries(request_builder)) | indent }}
{% endif %}
# Construct URL
{{ request_builder_serializer.construct_url(request_builder) }}
Expand Down