smithy-http 0.2.1__tar.gz → 0.3.0__tar.gz

smithy_http-0.3.0/.changes/0.3.0.json

@@ -0,0 +1,16 @@
+{
+  "changes": [
+    {
+      "type": "feature",
+      "description": "Added `MockHTTPClient` for testing SDK clients without making real HTTP requests."
+    },
+    {
+      "type": "enhancement",
+      "description": "Added timeout error detection for HTTP clients"
+    },
+    {
+      "type": "dependency",
+      "description": "Bump `smithy-core` from `~=0.1.0` to `~=0.2.0`."
+    }
+  ]
+}

{smithy_http-0.2.1 → smithy_http-0.3.0}/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.3.0
+
+### Features
+* Added `MockHTTPClient` for testing SDK clients without making real HTTP requests.
+
+### Enhancements
+* Added timeout error detection for HTTP clients
+
+### Dependencies
+* Bump `smithy-core` from `~=0.1.0` to `~=0.2.0`.
+
 ## v0.2.1
 
 ### Bug fixes

smithy_http-0.3.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: smithy-http
+Version: 0.3.0
+Summary: HTTP components for Smithy tooling.
+Project-URL: Changelog, https://github.com/smithy-lang/smithy-python/blob/develop/packages/smithy-http/CHANGELOG.md
+Project-URL: Code, https://github.com/smithy-lang/smithy-python/blob/develop/packages/smithy-http/
+Project-URL: Issue tracker, https://github.com/smithy-lang/smithy-python/issues
+Author: Amazon Web Services
+License: Apache License 2.0
+License-File: NOTICE
+Keywords: http,sdk,smithy
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.12
+Requires-Dist: smithy-core~=0.2.0
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp<4.0,>=3.11.12; extra == 'aiohttp'
+Requires-Dist: yarl; extra == 'aiohttp'
+Provides-Extra: awscrt
+Requires-Dist: awscrt~=0.28.2; extra == 'awscrt'
+Description-Content-Type: text/markdown
+
+# smithy-http
+
+This package provides primitives and interfaces for http functionality in tooling generated by Smithy.
+
+---
+
+## Testing
+
+The `smithy_http.testing` module provides shared utilities for testing HTTP functionality in smithy-python clients.
+
+### MockHTTPClient
+
+The `MockHTTPClient` allows you to test smithy-python clients without making actual network calls. It implements the `HTTPClient` interface and provides configurable responses for functional testing.
+
+#### Basic Usage                                                                                                                                                                                      
+
+```python                                                                                                                                                                                               
+from smithy_http.testing import MockHTTPClient
+
+# Create mock client and configure responses
+mock_client = MockHTTPClient()
+mock_client.add_response(
+   status=200,
+   headers=[("Content-Type", "application/json")],
+   body=b'{"message": "success"}'
+)
+
+# Use with your smithy-python client
+config = Config(transport=mock_client)
+client = TestSmithyServiceClient(config=config)
+
+# Test your client logic
+result = await client.some_operation({"input": "data"})
+
+# Inspect what requests were made
+assert mock_client.call_count == 1
+captured_request = mock_client.captured_requests[0]
+assert result.message == "success"
+```
+
+### Utilities
+
+- `create_test_request()`: Helper for creating test HTTPRequest objects                                                                                                                              
+- `MockHTTPClientError`: Exception raised when no responses are queued                                                                                                                               

smithy_http-0.3.0/README.md

@@ -0,0 +1,44 @@
+# smithy-http
+
+This package provides primitives and interfaces for http functionality in tooling generated by Smithy.
+
+---
+
+## Testing
+
+The `smithy_http.testing` module provides shared utilities for testing HTTP functionality in smithy-python clients.
+
+### MockHTTPClient
+
+The `MockHTTPClient` allows you to test smithy-python clients without making actual network calls. It implements the `HTTPClient` interface and provides configurable responses for functional testing.
+
+#### Basic Usage                                                                                                                                                                                      
+
+```python                                                                                                                                                                                               
+from smithy_http.testing import MockHTTPClient
+
+# Create mock client and configure responses
+mock_client = MockHTTPClient()
+mock_client.add_response(
+   status=200,
+   headers=[("Content-Type", "application/json")],
+   body=b'{"message": "success"}'
+)
+
+# Use with your smithy-python client
+config = Config(transport=mock_client)
+client = TestSmithyServiceClient(config=config)
+
+# Test your client logic
+result = await client.some_operation({"input": "data"})
+
+# Inspect what requests were made
+assert mock_client.call_count == 1
+captured_request = mock_client.captured_requests[0]
+assert result.message == "success"
+```
+
+### Utilities
+
+- `create_test_request()`: Helper for creating test HTTPRequest objects                                                                                                                              
+- `MockHTTPClientError`: Exception raised when no responses are queued                                                                                                                               

{smithy_http-0.2.1 → smithy_http-0.3.0}/pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
   "Topic :: Software Development :: Libraries"
 ]
 dependencies = [
-    "smithy-core~=0.1.0",
+    "smithy-core~=0.2.0",
 ]
 
 [project.urls]

{smithy_http-0.2.1 → smithy_http-0.3.0}/src/smithy_http/__init__.py

@@ -6,7 +6,7 @@ from collections.abc import Iterable, Iterator
 from . import interfaces
 from .interfaces import FieldPosition
 
-__version__ = "0.2.1"
+__version__ = "0.3.0"
 
 
 class Field(interfaces.Field):

{smithy_http-0.2.1 → smithy_http-0.3.0}/src/smithy_http/aio/aiohttp.py

@@ -52,6 +52,8 @@ class AIOHTTPClientConfig(HTTPClientConfiguration):
 class AIOHTTPClient(HTTPClient):
     """Implementation of :py:class:`.interfaces.HTTPClient` using aiohttp."""
 
+    TIMEOUT_EXCEPTIONS = (TimeoutError,)
+
     def __init__(
         self,
         *,

{smithy_http-0.2.1 → smithy_http-0.3.0}/src/smithy_http/aio/crt.py

@@ -8,6 +8,8 @@ from dataclasses import dataclass
 from inspect import iscoroutinefunction
 from typing import TYPE_CHECKING, Any
 
+from awscrt.exceptions import AwsCrtError
+
 if TYPE_CHECKING:
     # pyright doesn't like optional imports. This is reasonable because if we use these
     # in type hints then they'd result in runtime errors.
@@ -129,9 +131,16 @@ class AWSCRTHTTPClientConfig(http_interfaces.HTTPClientConfiguration):
         _assert_crt()
 
 
+class _CRTTimeoutError(Exception):
+    """Internal wrapper for CRT timeout errors."""
+
+
 class AWSCRTHTTPClient(http_aio_interfaces.HTTPClient):
     _HTTP_PORT = 80
     _HTTPS_PORT = 443
+    _TIMEOUT_ERROR_NAMES = frozenset(["AWS_IO_SOCKET_TIMEOUT", "AWS_IO_SOCKET_CLOSED"])
+
+    TIMEOUT_EXCEPTIONS = (_CRTTimeoutError,)
 
     def __init__(
         self,
@@ -163,18 +172,23 @@ class AWSCRTHTTPClient(http_aio_interfaces.HTTPClient):
         :param request: The request including destination URI, fields, payload.
         :param request_config: Configuration specific to this request.
         """
-        crt_request = self._marshal_request(request)
-        connection = await self._get_connection(request.destination)
+        try:
+            crt_request = self._marshal_request(request)
+            connection = await self._get_connection(request.destination)
 
-        # Convert body to async iterator for request_body_generator
-        body_generator = self._create_body_generator(request.body)
+            # Convert body to async iterator for request_body_generator
+            body_generator = self._create_body_generator(request.body)
 
-        crt_stream = connection.request(
-            crt_request,
-            request_body_generator=body_generator,
-        )
+            crt_stream = connection.request(
+                crt_request,
+                request_body_generator=body_generator,
+            )
 
-        return await self._await_response(crt_stream)
+            return await self._await_response(crt_stream)
+        except AwsCrtError as e:
+            if e.name in self._TIMEOUT_ERROR_NAMES:
+                raise _CRTTimeoutError() from e
+            raise
 
     async def _await_response(
         self, stream: "AIOHttpClientStreamUnified"

{smithy_http-0.2.1 → smithy_http-0.3.0}/src/smithy_http/aio/protocols.py

@@ -215,7 +215,6 @@ class HttpBindingClientProtocol(HttpClientProtocol):
             )
             return error_shape.deserialize(deserializer)
 
-        is_throttle = response.status == 429
         message = (
             f"Unknown error for operation {operation.schema.id} "
             f"- status: {response.status}"
@@ -224,11 +223,17 @@ class HttpBindingClientProtocol(HttpClientProtocol):
             message += f" - id: {error_id}"
         if response.reason is not None:
             message += f" - reason: {response.status}"
+
+        is_timeout = response.status == 408
+        is_throttle = response.status == 429
+        fault = "client" if response.status < 500 else "server"
+
         return CallError(
             message=message,
-            fault="client" if response.status < 500 else "server",
+            fault=fault,
             is_throttling_error=is_throttle,
-            is_retry_safe=is_throttle or None,
+            is_timeout_error=is_timeout,
+            is_retry_safe=is_throttle or is_timeout or None,
         )
 
     def _matches_content_type(self, response: HTTPResponse) -> bool:

smithy_http-0.3.0/src/smithy_http/testing/__init__.py

@@ -0,0 +1,13 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Shared utilities for testing smithy-python clients with an HTTP transport."""
+
+from .mockhttp import MockHTTPClient, MockHTTPClientError
+from .utils import create_test_request
+
+__all__ = (
+    "MockHTTPClient",
+    "MockHTTPClientError",
+    "create_test_request",
+)

smithy_http-0.3.0/src/smithy_http/testing/mockhttp.py

@@ -0,0 +1,102 @@
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#  SPDX-License-Identifier: Apache-2.0
+
+from collections import deque
+from copy import copy
+from typing import Any
+
+from smithy_core.aio.utils import async_list
+
+from smithy_http import tuples_to_fields
+from smithy_http.aio import HTTPResponse
+from smithy_http.aio.interfaces import HTTPClient, HTTPRequest
+from smithy_http.interfaces import HTTPClientConfiguration, HTTPRequestConfiguration
+
+
+class MockHTTPClient(HTTPClient):
+    """Implementation of :py:class:`.interfaces.HTTPClient` solely for testing purposes.
+
+    Simulates HTTP request/response behavior. Responses are queued in FIFO order and
+    requests are captured for inspection.
+    """
+
+    TIMEOUT_EXCEPTIONS = (TimeoutError,)
+
+    def __init__(
+        self,
+        *,
+        client_config: HTTPClientConfiguration | None = None,
+    ) -> None:
+        """
+        :param client_config: Configuration that applies to all requests made with this
+        client.
+        """
+        self._client_config = client_config
+        self._response_queue: deque[dict[str, Any]] = deque()
+        self._captured_requests: list[HTTPRequest] = []
+
+    def add_response(
+        self,
+        status: int = 200,
+        headers: list[tuple[str, str]] | None = None,
+        body: bytes = b"",
+    ) -> None:
+        """Queue a response for the next request.
+
+        :param status: HTTP status code.
+        :param headers: HTTP response headers as list of (name, value) tuples.
+        :param body: Response body as bytes.
+        """
+        self._response_queue.append(
+            {
+                "status": status,
+                "headers": headers or [],
+                "body": body,
+            }
+        )
+
+    async def send(
+        self,
+        request: HTTPRequest,
+        *,
+        request_config: HTTPRequestConfiguration | None = None,
+    ) -> HTTPResponse:
+        """Send HTTP request and return configured response.
+
+        :param request: The request including destination URI, fields, payload.
+        :param request_config: Configuration specific to this request.
+        :returns: Pre-configured HTTP response from the queue.
+        :raises MockHTTPClientError: If no responses are queued.
+        """
+        self._captured_requests.append(copy(request))
+
+        # Return next queued response or raise error
+        if self._response_queue:
+            response_data = self._response_queue.popleft()
+            return HTTPResponse(
+                status=response_data["status"],
+                fields=tuples_to_fields(response_data["headers"]),
+                body=async_list([response_data["body"]]),
+                reason=None,
+            )
+        else:
+            raise MockHTTPClientError(
+                "No responses queued in MockHTTPClient. Use add_response() to queue responses."
+            )
+
+    @property
+    def call_count(self) -> int:
+        """The number of requests made to this client."""
+        return len(self._captured_requests)
+
+    @property
+    def captured_requests(self) -> list[HTTPRequest]:
+        """The list of all requests captured by this client."""
+        return self._captured_requests.copy()
+
+    def __deepcopy__(self, memo: Any) -> "MockHTTPClient":
+        return self
+
+
+class MockHTTPClientError(Exception):
+    """Exception raised by MockHTTPClient for test setup issues."""

smithy_http-0.3.0/src/smithy_http/testing/utils.py

@@ -0,0 +1,31 @@
+#  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#  SPDX-License-Identifier: Apache-2.0
+
+from smithy_core import URI
+
+from smithy_http import tuples_to_fields
+from smithy_http.aio import HTTPRequest
+
+
+def create_test_request(
+    method: str = "GET",
+    host: str = "test.aws.dev",
+    path: str | None = None,
+    headers: list[tuple[str, str]] | None = None,
+    body: bytes = b"",
+) -> HTTPRequest:
+    """Create test HTTPRequest with defaults.
+
+    :param method: HTTP method (GET, POST, etc.)
+    :param host: Host name (e.g., "test.aws.dev")
+    :param path: Optional path (e.g., "/users")
+    :param headers: Optional headers as list of (name, value) tuples
+    :param body: Request body as bytes
+    :return: Configured HTTPRequest for testing
+    """
+    return HTTPRequest(
+        destination=URI(host=host, path=path),
+        method=method,
+        fields=tuples_to_fields(headers or []),
+        body=body,
+    )

smithy_http-0.2.1/PKG-INFO

@@ -1,37 +0,0 @@
-Metadata-Version: 2.4
-Name: smithy-http
-Version: 0.2.1
-Summary: HTTP components for Smithy tooling.
-Project-URL: Changelog, https://github.com/smithy-lang/smithy-python/blob/develop/packages/smithy-http/CHANGELOG.md
-Project-URL: Code, https://github.com/smithy-lang/smithy-python/blob/develop/packages/smithy-http/
-Project-URL: Issue tracker, https://github.com/smithy-lang/smithy-python/issues
-Author: Amazon Web Services
-License: Apache License 2.0
-License-File: NOTICE
-Keywords: http,sdk,smithy
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Natural Language :: English
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.12
-Requires-Dist: smithy-core~=0.1.0
-Provides-Extra: aiohttp
-Requires-Dist: aiohttp<4.0,>=3.11.12; extra == 'aiohttp'
-Requires-Dist: yarl; extra == 'aiohttp'
-Provides-Extra: awscrt
-Requires-Dist: awscrt~=0.28.2; extra == 'awscrt'
-Description-Content-Type: text/markdown
-
-# smithy-http
-
-This package provides primitives and interfaces for http functionality in tooling generated by Smithy.

smithy_http-0.2.1/README.md

@@ -1,3 +0,0 @@
-# smithy-http
-
-This package provides primitives and interfaces for http functionality in tooling generated by Smithy.