Skip to content

Use TypedProperty for UserAgent #425

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
merged 1 commit into from
Mar 11, 2025
Merged

Use TypedProperty for UserAgent #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 2 deletions packages/smithy-aws-core/src/smithy_aws_core/interceptors/user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import smithy_aws_core
import smithy_core
from smithy_core.interceptors import Interceptor, InterceptorContext
from smithy_http.interceptors.user_agent import USER_AGENT
from smithy_http.user_agent import UserAgentComponent, RawStringUserAgentComponent

_USERAGENT_SDK_NAME = "aws-sdk-python"
Expand Down Expand Up @@ -39,8 +40,8 @@ def __init__(
def read_after_serialization(
self, context: InterceptorContext[Any, Any, Any, Any]
) -> None:
if "user_agent" in context.properties:
user_agent = context.properties["user_agent"]
if USER_AGENT in context.properties:
user_agent = context.properties[USER_AGENT]
user_agent.sdk_metadata = self._build_sdk_metadata()
user_agent.api_metadata.append(
UserAgentComponent("api", self._service_id, self._sdk_version)
Expand Down
7 changes: 5 additions & 2 deletions packages/smithy-http/src/smithy_http/interceptors/user_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@

import smithy_core
from smithy_core.interceptors import Interceptor, InterceptorContext
from smithy_core.types import PropertyKey
from smithy_http import Field
from smithy_http.aio.interfaces import HTTPRequest
from smithy_http.user_agent import UserAgent, UserAgentComponent

USER_AGENT = PropertyKey(key="user_agent", value_type=UserAgent)


class UserAgentInterceptor(Interceptor[Any, None, HTTPRequest, None]):
"""Adds interceptors that initialize UserAgent in the context and add the user-agent
Expand All @@ -17,12 +20,12 @@ class UserAgentInterceptor(Interceptor[Any, None, HTTPRequest, None]):
def read_before_execution(
self, context: InterceptorContext[Any, None, None, None]
) -> None:
context.properties["user_agent"] = _UserAgentBuilder.from_environment().build()
context.properties[USER_AGENT] = _UserAgentBuilder.from_environment().build()

def modify_before_signing(
self, context: InterceptorContext[Any, None, HTTPRequest, None]
) -> HTTPRequest:
user_agent = context.properties["user_agent"]
user_agent = context.properties[USER_AGENT]
request = context.transport_request
request.fields.set_field(Field(name="User-Agent", values=[str(user_agent)]))
return context.transport_request
Expand Down