Fix pyright errors

Author: alextwoods

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

@@ -17,7 +17,7 @@
 from smithy_http.aio import HTTPRequest
 
 
-class UserAgentInterceptor(Interceptor):
+class UserAgentInterceptor(Interceptor[Request, None, HTTPRequest, None]):
     """Adds UserAgent header to the Request before signing."""
 
     def __init__(

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

@@ -14,7 +14,7 @@
 import os
 import platform
 from string import ascii_letters, digits
-from typing import NamedTuple, Optional, Self
+from typing import NamedTuple, Optional, Self, Union, List
 
 from smithy_http.aio.crt import HAS_CRT
 
@@ -33,16 +33,58 @@
 _USERAGENT_SDK_NAME = "aws-sdk-python"
 
 
+class UserAgentComponent(NamedTuple):
+    """Component of a User-Agent header string in the standard format.
+
+    Each component consists of a prefix, a name, and a value. In the string
+    representation these are combined in the format ``prefix/name#value``.
+
+    This class is considered private and is subject to abrupt breaking changes.
+    """
+
+    prefix: str
+    name: str
+    value: Optional[str] = None
+
+    def to_string(self):
+        """Create string like 'prefix/name#value' from a UserAgentComponent."""
+        clean_prefix = sanitize_user_agent_string_component(
+            self.prefix, allow_hash=True
+        )
+        clean_name = sanitize_user_agent_string_component(self.name, allow_hash=False)
+        if self.value is None or self.value == "":
+            return f"{clean_prefix}/{clean_name}"
+        clean_value = sanitize_user_agent_string_component(self.value, allow_hash=True)
+        return f"{clean_prefix}/{clean_name}#{clean_value}"
+
+
+class RawStringUserAgentComponent:
+    """UserAgentComponent interface wrapper around ``str``.
+
+    Use for User-Agent header components that are not constructed from prefix+name+value
+    but instead are provided as strings. No sanitization is performed.
+    """
+
+    def __init__(self, value: str):
+        self._value = value
+
+    def to_string(self) -> str:
+        return self._value
+
+
+_UAComponent = Union[UserAgentComponent, RawStringUserAgentComponent]
+
+
 class UserAgent:
     def __init__(
         self,
-        platform_name,
-        platform_version,
-        platform_machine,
-        python_version,
-        python_implementation,
-        execution_env,
-        crt_version=None,
+        platform_name: str | None,
+        platform_version: str | None,
+        platform_machine: str | None,
+        python_version: str | None,
+        python_implementation: str | None,
+        execution_env: str | None,
+        crt_version: str | None,
     ) -> None:
         self._platform_name = platform_name
         self._platform_version = platform_version
@@ -74,16 +116,16 @@ def from_environment(cls) -> Self:
 
     def with_config(
         self,
-        ua_suffix: str | None = None,
-        ua_app_id: str | None = None,
-        sdk_version: str | None = None,
+        ua_suffix: str | None,
+        ua_app_id: str | None,
+        sdk_version: str | None,
     ) -> Self:
         self._user_agent_suffix = ua_suffix
         self._user_agent_app_id = ua_app_id
         self._sdk_version = sdk_version
         return self
 
-    def to_string(self):
+    def to_string(self) -> str:
         """Build User-Agent header string from the object's properties."""
         components = [
             *self._build_sdk_metadata(),
@@ -99,20 +141,22 @@ def to_string(self):
 
         return " ".join([comp.to_string() for comp in components])
 
-    def _build_sdk_metadata(self):
+    def _build_sdk_metadata(self) -> List[UserAgentComponent]:
         """Build the SDK name and version component of the User-Agent header.
 
         Includes CRT version if available.
         """
-        sdk_md = []
-        sdk_md.append(UserAgentComponent(_USERAGENT_SDK_NAME, self._sdk_version))
+        sdk_version = self._sdk_version if self._sdk_version else "Unknown"
+        sdk_md: List[UserAgentComponent] = [
+            UserAgentComponent(_USERAGENT_SDK_NAME, sdk_version)
+        ]
 
         if self._crt_version is not None:
             sdk_md.append(UserAgentComponent("md", "awscrt", self._crt_version))
 
         return sdk_md
 
-    def _build_os_metadata(self):
+    def _build_os_metadata(self) -> List[UserAgentComponent]:
         """Build the OS/platform components of the User-Agent header string.
 
         For recognized platform names that match or map to an entry in the list
@@ -145,7 +189,7 @@ def _build_os_metadata(self):
                 UserAgentComponent("md", self._platform_name, self._platform_version),
             ]
 
-    def _build_architecture_metadata(self):
+    def _build_architecture_metadata(self) -> List[UserAgentComponent]:
         """Build architecture component of the User-Agent header string.
 
         Returns the machine type with prefix "md" and name "arch", if one is available.
@@ -155,7 +199,7 @@ def _build_architecture_metadata(self):
             return [UserAgentComponent("md", "arch", self._platform_machine.lower())]
         return []
 
-    def _build_language_metadata(self):
+    def _build_language_metadata(self) -> List[UserAgentComponent]:
         """Build the language components of the User-Agent header string.
 
         Returns the Python version in a component with prefix "lang" and name
@@ -174,7 +218,7 @@ def _build_language_metadata(self):
             )
         return lang_md
 
-    def _build_execution_env_metadata(self):
+    def _build_execution_env_metadata(self) -> List[UserAgentComponent]:
         """Build the execution environment component of the User-Agent header.
 
         Returns a single component prefixed with "exec-env", usually sourced from the
@@ -185,28 +229,28 @@ def _build_execution_env_metadata(self):
         else:
             return []
 
-    def _build_feature_metadata(self):
+    def _build_feature_metadata(self) -> List[UserAgentComponent]:
         """Build the features components of the User-Agent header string.
 
         TODO: These should be sourced from property bag set on context.
         """
         return []
 
-    def _build_app_id(self):
+    def _build_app_id(self) -> List[UserAgentComponent]:
         """Build app component of the User-Agent header string."""
         if self._user_agent_app_id:
             return [UserAgentComponent("app", self._user_agent_app_id)]
         else:
             return []
 
-    def _build_suffix(self):
+    def _build_suffix(self) -> List[_UAComponent]:
         if self._user_agent_suffix:
             return [RawStringUserAgentComponent(self._user_agent_suffix)]
         else:
             return []
 
 
-def sanitize_user_agent_string_component(raw_str, allow_hash):
+def sanitize_user_agent_string_component(raw_str: str, allow_hash: bool = False) -> str:
     """Replaces all not allowed characters in the string with a dash ("-").
 
     Allowed characters are ASCII alphanumerics and ``!$%&'*+-.^_`|~``. If
@@ -224,46 +268,7 @@ def sanitize_user_agent_string_component(raw_str, allow_hash):
     )
 
 
-class UserAgentComponent(NamedTuple):
-    """Component of a User-Agent header string in the standard format.
-
-    Each component consists of a prefix, a name, and a value. In the string
-    representation these are combined in the format ``prefix/name#value``.
-
-    This class is considered private and is subject to abrupt breaking changes.
-    """
-
-    prefix: str
-    name: str
-    value: Optional[str] = None
-
-    def to_string(self):
-        """Create string like 'prefix/name#value' from a UserAgentComponent."""
-        clean_prefix = sanitize_user_agent_string_component(
-            self.prefix, allow_hash=True
-        )
-        clean_name = sanitize_user_agent_string_component(self.name, allow_hash=False)
-        if self.value is None or self.value == "":
-            return f"{clean_prefix}/{clean_name}"
-        clean_value = sanitize_user_agent_string_component(self.value, allow_hash=True)
-        return f"{clean_prefix}/{clean_name}#{clean_value}"
-
-
-class RawStringUserAgentComponent:
-    """UserAgentComponent interface wrapper around ``str``.
-
-    Use for User-Agent header components that are not constructed from prefix+name+value
-    but instead are provided as strings. No sanitization is performed.
-    """
-
-    def __init__(self, value):
-        self._value = value
-
-    def to_string(self):
-        return self._value
-
-
-def _get_crt_version():
+def _get_crt_version() -> str | None:
     """This function is considered private and is subject to abrupt breaking changes."""
     try:
         import awscrt

pyproject.toml

@@ -33,6 +33,7 @@ aws_event_stream = { workspace = true }
 
 [tool.pyright]
 typeCheckingMode = "strict"
+reportMissingTypeStubs = false # TODO: Remove once awscrt supplies stubs/types
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto" # makes pytest run async tests without having to be marked with the @pytest.mark.asyncio decorator