1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
|
from __future__ import annotations
import asyncio
import io
import os
import socket
import ssl
from collections.abc import AsyncIterable, Iterable
from concurrent.futures import CancelledError
from typing import TYPE_CHECKING, Any, cast
import botocore
from botocore.awsrequest import AWSPreparedRequest
from botocore.httpsession import (
MAX_POOL_CONNECTIONS,
ConnectionClosedError,
ConnectTimeoutError,
EndpointConnectionError,
HTTPClientError,
ProxyConnectionError,
ReadTimeoutError,
create_urllib3_context,
ensure_boolean,
get_cert_path,
logger,
)
from multidict import CIMultiDict
import aiobotocore.awsrequest
from aiobotocore._endpoint_helpers import _text
from ._constants import DEFAULT_KEEPALIVE_TIMEOUT
try:
import httpx
except ImportError:
httpx = None
if TYPE_CHECKING:
from ssl import SSLContext
class HttpxSession:
def __init__(
self,
verify: bool = True,
proxies: dict[str, str] | None = None, # {scheme: url}
timeout: float | list[float] | tuple[float, float] | None = None,
max_pool_connections: int = MAX_POOL_CONNECTIONS,
socket_options: list[Any] | None = None,
client_cert: str | tuple[str, str] | None = None,
proxies_config: dict[str, str] | None = None,
connector_args: dict[str, Any] | None = None,
):
if httpx is None: # pragma: no cover
raise RuntimeError(
"Using HttpxSession requires httpx to be installed"
)
if proxies or proxies_config:
raise NotImplementedError(
"Proxy support not implemented with httpx as backend."
)
if connector_args is None:
self._connector_args: dict[str, Any] = {
'keepalive_timeout': DEFAULT_KEEPALIVE_TIMEOUT
}
else:
self._connector_args = connector_args
# TODO: neither this nor AIOHTTPSession handles socket_options
self._session: httpx.AsyncClient | None = None
conn_timeout: float | None
read_timeout: float | None
if isinstance(timeout, (list, tuple)):
conn_timeout, read_timeout = timeout
else:
conn_timeout = read_timeout = timeout
write_timeout = self._connector_args.get('write_timeout', 5)
pool_timeout = self._connector_args.get('pool_timeout', 5)
self._timeout = httpx.Timeout(
connect=conn_timeout,
read=read_timeout,
write=write_timeout,
pool=pool_timeout,
)
self._cert_file = None
self._key_file = None
if isinstance(client_cert, str):
self._cert_file = client_cert
elif isinstance(client_cert, tuple):
self._cert_file, self._key_file = client_cert
elif client_cert is not None:
raise TypeError(f'{client_cert} must be str or tuple[str,str]')
if 'use_dns_cache' in self._connector_args:
raise NotImplementedError(
"DNS caching is not implemented by httpx. https://github.com/encode/httpx/discussions/2211"
)
if 'force_close' in self._connector_args:
raise NotImplementedError("Not supported with httpx as backend.")
if 'resolver' in self._connector_args:
raise NotImplementedError("Not supported with httpx as backend.")
self._max_pool_connections = max_pool_connections
self._socket_options = socket_options
if socket_options is None:
self._socket_options = []
# TODO [httpx]: clean up
ssl_context: SSLContext | None = None
self._verify: bool | str | SSLContext = verify
if not verify:
return
if 'ssl_context' in self._connector_args:
self._verify = cast(
'SSLContext', self._connector_args['ssl_context']
)
return
ssl_context = self._get_ssl_context()
# inline self._setup_ssl_cert
ca_certs = get_cert_path(verify)
if ca_certs:
ssl_context.load_verify_locations(ca_certs, None, None)
if ssl_context is not None:
self._verify = ssl_context
async def __aenter__(self):
assert not self._session
limits = httpx.Limits(
max_connections=self._max_pool_connections,
keepalive_expiry=self._connector_args['keepalive_timeout'],
)
# TODO [httpx]: I put logic here to minimize diff / accidental downstream
# consequences - but can probably put this logic in __init__
if self._cert_file and self._key_file is None:
cert = self._cert_file
elif self._cert_file:
cert = (self._cert_file, self._key_file)
else:
cert = None
self._session = httpx.AsyncClient(
timeout=self._timeout, limits=limits, cert=cert
)
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
if self._session:
await self._session.__aexit__(exc_type, exc_val, exc_tb)
self._session = None
self._connector = None
def _get_ssl_context(self) -> SSLContext:
ssl_context = create_urllib3_context()
if self._cert_file:
ssl_context.load_cert_chain(self._cert_file, self._key_file)
return ssl_context
async def close(self) -> None:
await self.__aexit__(None, None, None)
async def send(
self, request: AWSPreparedRequest
) -> aiobotocore.awsrequest.HttpxAWSResponse:
try:
url = request.url
headers = request.headers
# currently no support for BOTO_EXPERIMENTAL__ADD_PROXY_HOST_HEADER
if ensure_boolean(
os.environ.get('BOTO_EXPERIMENTAL__ADD_PROXY_HOST_HEADER', '')
):
raise NotImplementedError(
'httpx implementation of aiobotocore does not (currently) support proxies'
)
headers_ = CIMultiDict(
(z[0], _text(z[1], encoding='utf-8')) for z in headers.items()
)
# https://github.com/boto/botocore/issues/1255
headers_['Accept-Encoding'] = 'identity'
# content can also be https://github.com/ymyzk/tox-gh-actions
content: AsyncIterable | bytes | bytearray | str | None = None
async def to_async_iterable(stream: Iterable) -> AsyncIterable:
if isinstance(stream, AsyncIterable):
async for item in stream:
yield item
else:
for item in stream:
yield item
await asyncio.sleep(0) # Yield control to event loop
if isinstance(
request.body, (AsyncIterable, io.BytesIO)
) and isinstance(request.body, Iterable):
content = to_async_iterable(request.body)
else:
content = request.body
# The target gets used as the HTTP target instead of the URL path
# it does not get normalized or otherwise processed, which is important
# since arbitrary dots and slashes are valid as key paths.
# See test_basic_s3.test_non_normalized_key_paths
# This way of using it is currently ~undocumented, but recommended in
# https://github.com/encode/httpx/discussions/1805#discussioncomment-8975989
extensions = {"target": bytes(url, encoding='utf-8')}
assert self._session is not None
httpx_request = self._session.build_request(
method=request.method,
url=url,
headers=headers,
content=content,
extensions=extensions,
)
assert isinstance(httpx_request.stream, httpx.AsyncByteStream)
# auth, follow_redirects
response = await self._session.send(httpx_request, stream=True)
response_headers = botocore.compat.HTTPHeaders.from_pairs(
response.headers.items()
)
http_response = aiobotocore.awsrequest.HttpxAWSResponse(
str(response.url),
response.status_code,
response_headers,
response,
)
if not request.stream_output:
# Cause the raw stream to be exhausted immediately. We do it
# this way instead of using preload_content because
# preload_content will never buffer chunked responses
await http_response.content
return http_response
except httpx.ConnectError as e:
raise EndpointConnectionError(endpoint_url=request.url, error=e)
except (socket.gaierror,) as e:
raise EndpointConnectionError(endpoint_url=request.url, error=e)
except asyncio.TimeoutError as e:
raise ReadTimeoutError(endpoint_url=request.url, error=e)
except httpx.ReadTimeout as e:
raise ReadTimeoutError(endpoint_url=request.url, error=e)
except httpx.TimeoutException as e:
raise ConnectTimeoutError(endpoint_url=request.url, error=e)
except httpx.ProxyError as e:
raise ProxyConnectionError(endpoint_url=request.url, error=e)
except httpx.CloseError as e:
raise ConnectionClosedError(endpoint_url=request.url, error=e)
except ssl.SSLError:
raise botocore.exceptions.SSLError
except NotImplementedError:
raise # Avoid turning it into HTTPClientError.
except CancelledError:
raise
except Exception as e:
message = 'Exception received when sending httpx HTTP request'
logger.debug(message, exc_info=True)
raise HTTPClientError(error=e)
|