Notes pr

CONTRIBUTING.md

@@ -32,7 +32,7 @@ To send us a pull request, please:
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
 3. Ensure local tests pass (`make test-py` and `make test-protocols`).
-4. Run `make lint-py` if you've changed any python sources.
+4. Run `make lint-py` and `make check-py` if you've changed any python sources.
 4. Commit to your fork using clear commit messages.
 5. Send us a pull request, answering any default questions in the pull request interface.
 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

codegen/aws/core/src/main/java/software/amazon/smithy/python/aws/codegen/AwsPythonDependency.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package software.amazon.smithy.python.aws.codegen;
+
+import software.amazon.smithy.python.codegen.PythonDependency;
+import software.amazon.smithy.utils.SmithyUnstableApi;
+
+/**
+ * AWS Dependencies used in the smithy python generator.
+ */
+@SmithyUnstableApi
+public class AwsPythonDependency {
+    /**
+     * The core aws smithy runtime python package.
+     *
+     * <p>While in development this will use the develop branch.
+     */
+    public static final PythonDependency SMITHY_AWS_CORE = new PythonDependency(
+            "smithy_aws_core",
+            // You'll need to locally install this before we publish
+            "==0.0.1",
+            PythonDependency.Type.DEPENDENCY,
+            false);
+}

codegen/aws/core/src/main/java/software/amazon/smithy/python/aws/codegen/AwsUserAgentIntegration.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package software.amazon.smithy.python.aws.codegen;
+
+import java.util.Collections;
+import java.util.List;
+import software.amazon.smithy.codegen.core.Symbol;
+import software.amazon.smithy.codegen.core.SymbolReference;
+import software.amazon.smithy.python.codegen.ConfigProperty;
+import software.amazon.smithy.python.codegen.integrations.PythonIntegration;
+import software.amazon.smithy.python.codegen.integrations.RuntimeClientPlugin;
+import software.amazon.smithy.utils.SmithyInternalApi;
+
+/**
+ * Adds a runtime plugin to set user agent.
+ */
+@SmithyInternalApi
+public class AwsUserAgentIntegration implements PythonIntegration {
+    @Override
+    public List<RuntimeClientPlugin> getClientPlugins() {
+        return List.of(
+                RuntimeClientPlugin.builder()
+                        .addConfigProperty(
+                                ConfigProperty.builder()
+                                // TODO: This is the name used in boto, but potentially could be user_agent_prefix.  Depends on backwards compat strategy.
+                                .name("user_agent_extra")
+                                .documentation("Additional suffix to be added to the User-Agent header.")
+                                .type(Symbol.builder().name("str").build()) // TODO: Should common types like this be defined as constants somewhere?
+                                .nullable(true)
+                                .build())
+                        .addConfigProperty(
+                                ConfigProperty.builder()
+                                        .name("sdk_ua_app_id")
+                                        .documentation("A unique and opaque application ID that is appended to the User-Agent header.")
+                                        .type(Symbol.builder().name("str").build())
+                                        .nullable(true)
+                                        .build()
+                        )
+                        .pythonPlugin(
+                                SymbolReference.builder()
+                                        .symbol(Symbol.builder()
+                                                .namespace(AwsPythonDependency.SMITHY_AWS_CORE.packageName() + ".plugins", ".")
+                                                .name("user_agent_plugin")
+                                                .addDependency(AwsPythonDependency.SMITHY_AWS_CORE)
+                                                .build())
+                                        .build()
+                        )
+                        .build()
+        );
+    }
+
+}

codegen/aws/core/src/main/resources/META-INF/services/software.amazon.smithy.python.codegen.integrations.PythonIntegration

@@ -5,3 +5,4 @@
 
 software.amazon.smithy.python.aws.codegen.AwsAuthIntegration
 software.amazon.smithy.python.aws.codegen.AwsProtocolsIntegration
+software.amazon.smithy.python.aws.codegen.AwsUserAgentIntegration

packages/smithy-aws-core/src/smithy_aws_core/interceptors/__init__.py

@@ -0,0 +1,2 @@
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#  SPDX-License-Identifier: Apache-2.0

packages/smithy-aws-core/src/smithy_aws_core/interceptors/user_agent.py

@@ -0,0 +1,41 @@
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#  SPDX-License-Identifier: Apache-2.0
+
+from smithy_aws_core.user_agent import UserAgent
+from smithy_core.interceptors import Interceptor, InterceptorContext, Request
+from smithy_http import Field
+from smithy_http.aio import HTTPRequest
+
+
+class UserAgentInterceptor(Interceptor[Request, None, HTTPRequest, None]):
+    """Adds UserAgent header to the Request before signing."""
+
+    def __init__(
+        self,
+        ua_suffix: str | None = None,
+        ua_app_id: str | None = None,
+        sdk_version: str | None = "0.0.1",
+    ) -> None:
+        """Initialize the UserAgentInterceptor.
+
+        :ua_suffix: Additional suffix to be added to the UserAgent header. :ua_app_id:
+        User defined and opaque application ID to be added to the UserAgent header.
+        """
+        super().__init__()
+        self._ua_suffix = ua_suffix
+        self._ua_app_id = ua_app_id
+        self._sdk_version = sdk_version
+
+    def modify_before_signing(
+        self, context: InterceptorContext[Request, None, HTTPRequest, None]
+    ) -> HTTPRequest:
+        user_agent = UserAgent.from_environment().with_config(
+            ua_suffix=self._ua_suffix,
+            ua_app_id=self._ua_app_id,
+            sdk_version=self._sdk_version,
+        )
+        request = context.transport_request
+        request.fields.set_field(
+            Field(name="User-Agent", values=[user_agent.to_string()])
+        )
+        return context.transport_request

packages/smithy-aws-core/src/smithy_aws_core/plugins/__init__.py

@@ -0,0 +1,16 @@
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#  SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from smithy_aws_core.interceptors.user_agent import UserAgentInterceptor
+
+
+# TODO: Define a Protocol for Config w/ interceptor method?
+def user_agent_plugin(config: Any) -> None:
+    config.interceptors.append(
+        UserAgentInterceptor(
+            ua_suffix=config.user_agent_extra,
+            ua_app_id=config.sdk_ua_app_id,
+        )
+    )