Create common interface for aio response classes

CHANGES.rst

@@ -5,6 +5,7 @@ Changes
 ^^^^^^^^^^^^^^^^^^^
 * patch `ResponseParser`
 * use SPDX license identifier for project metadata
+* refactor `AioResponseParser` to have a consistent async implementation of the `parse` method.
 
 2.21.1 (2025-03-04)
 ^^^^^^^^^^^^^^^^^^^

aiobotocore/endpoint.py

@@ -204,15 +204,9 @@ async def _do_get_response(self, request, operation_model, context):
         )
         parser = self._response_parser_factory.create_parser(protocol)
 
-        if asyncio.iscoroutinefunction(parser.parse):
-            parsed_response = await parser.parse(
-                response_dict, operation_model.output_shape
-            )
-        else:
-            parsed_response = parser.parse(
-                response_dict, operation_model.output_shape
-            )
-
+        parsed_response = await parser.parse(
+            response_dict, operation_model.output_shape
+        )
         parsed_response.update(customized_response_dict)
 
         if http_response.status_code >= 300:
@@ -240,10 +234,7 @@ async def _add_modeled_error_fields(
         if error_shape is None:
             return
 
-        if asyncio.iscoroutinefunction(parser.parse):
-            modeled_parse = await parser.parse(response_dict, error_shape)
-        else:
-            modeled_parse = parser.parse(response_dict, error_shape)
+        modeled_parse = await parser.parse(response_dict, error_shape)
         # TODO: avoid naming conflicts with ResponseMetadata and Error
         parsed_response.update(modeled_parse)
 

aiobotocore/parsers.py

@@ -12,6 +12,7 @@
     lowercase_dict,
 )
 
+from ._helpers import resolve_awaitable
 from .eventstream import AioEventStream
 
 
@@ -31,6 +32,39 @@ def _create_event_stream(self, response, shape):
         name = response['context'].get('operation_name')
         return AioEventStream(response['body'], shape, parser, name)
 
+    async def parse(self, response, shape):
+        LOG.debug('Response headers: %s', response['headers'])
+        LOG.debug('Response body:\n%s', response['body'])
+        if response['status_code'] >= 301:
+            if self._is_generic_error_response(response):
+                parsed = self._do_generic_error_parse(response)
+            elif self._is_modeled_error_shape(shape):
+                parsed = self._do_modeled_error_parse(response, shape)
+                # We don't want to decorate the modeled fields with metadata
+                return parsed
+            else:
+                parsed = self._do_error_parse(response, shape)
+        else:
+            parsed = await resolve_awaitable(self._do_parse(response, shape))
+
+        # We don't want to decorate event stream responses with metadata
+        if shape and shape.serialization.get('eventstream'):
+            return parsed
+
+        # Add ResponseMetadata if it doesn't exist and inject the HTTP
+        # status code and headers from the response.
+        if isinstance(parsed, dict):
+            response_metadata = parsed.get('ResponseMetadata', {})
+            response_metadata['HTTPStatusCode'] = response['status_code']
+            # Ensure that the http header keys are all lower cased. Older
+            # versions of urllib3 (< 1.11) would unintentionally do this for us
+            # (see urllib3#633). We need to do this conversion manually now.
+            headers = response['headers']
+            response_metadata['HTTPHeaders'] = lowercase_dict(headers)
+            parsed['ResponseMetadata'] = response_metadata
+            self._add_checksum_response_metadata(response, response_metadata)
+        return parsed
+
 
 class AioQueryParser(QueryParser, AioResponseParser):
     pass
@@ -66,41 +100,6 @@ async def _handle_event_stream(self, response, shape, event_name):
         parsed[event_name] = event_stream
         return parsed
 
-    # this is actually from ResponseParser however for now JSONParser is the
-    # only class that needs this async
-    async def parse(self, response, shape):
-        LOG.debug('Response headers: %s', response['headers'])
-        LOG.debug('Response body:\n%s', response['body'])
-        if response['status_code'] >= 301:
-            if self._is_generic_error_response(response):
-                parsed = self._do_generic_error_parse(response)
-            elif self._is_modeled_error_shape(shape):
-                parsed = self._do_modeled_error_parse(response, shape)
-                # We don't want to decorate the modeled fields with metadata
-                return parsed
-            else:
-                parsed = self._do_error_parse(response, shape)
-        else:
-            parsed = await self._do_parse(response, shape)
-
-        # We don't want to decorate event stream responses with metadata
-        if shape and shape.serialization.get('eventstream'):
-            return parsed
-
-        # Add ResponseMetadata if it doesn't exist and inject the HTTP
-        # status code and headers from the response.
-        if isinstance(parsed, dict):
-            response_metadata = parsed.get('ResponseMetadata', {})
-            response_metadata['HTTPStatusCode'] = response['status_code']
-            # Ensure that the http header keys are all lower cased. Older
-            # versions of urllib3 (< 1.11) would unintentionally do this for us
-            # (see urllib3#633). We need to do this conversion manually now.
-            headers = response['headers']
-            response_metadata['HTTPHeaders'] = lowercase_dict(headers)
-            parsed['ResponseMetadata'] = response_metadata
-            self._add_checksum_response_metadata(response, response_metadata)
-        return parsed
-
 
 class AioRestJSONParser(RestJSONParser, AioResponseParser):
     pass

aiobotocore/response.py

@@ -150,10 +150,5 @@ async def get_response(operation_model, http_response):
         response_dict['body'] = await http_response.content
 
     parser = parsers.create_parser(protocol)
-    if asyncio.iscoroutinefunction(parser.parse):
-        parsed = await parser.parse(
-            response_dict, operation_model.output_shape
-        )
-    else:
-        parsed = parser.parse(response_dict, operation_model.output_shape)
+    parsed = await parser.parse(response_dict, operation_model.output_shape)
     return http_response, parsed

tests/test_patches.py

@@ -428,6 +428,7 @@
     ResponseParser._create_event_stream: {
         '0564ba55383a71cc1ba3e5be7110549d7e9992f5',
     },
+    ResponseParser.parse: {'c2153eac3789855f4fc6a816a1f30a6afe0cf969'},
     RestXMLParser._create_event_stream: {
         '0564ba55383a71cc1ba3e5be7110549d7e9992f5'
     },
@@ -444,8 +445,6 @@
     JSONParser._handle_event_stream: {
         '3cf7bb1ecff0d72bafd7e7fd6625595b4060abd6'
     },
-    # NOTE: if this hits we need to change our ResponseParser impl in JSONParser
-    JSONParser.parse: {'c2153eac3789855f4fc6a816a1f30a6afe0cf969'},
     RestJSONParser._create_event_stream: {
         '0564ba55383a71cc1ba3e5be7110549d7e9992f5'
     },