Skip to content

Commit cd59ebd

Browse files
committed
FIXUP: revert proxy_auth back to BasicAuth
1 parent a102977 commit cd59ebd

File tree

4 files changed

+17
-16
lines changed

4 files changed

+17
-16
lines changed

Diff for: aiohttp/client.py

+6-5
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
_SENTINEL,
9797
EMPTY_BODY_METHODS,
9898
AuthBase,
99+
BasicAuth,
99100
TimeoutHandle,
100101
frozen_dataclass_decorator,
101102
get_env_proxy_for_url,
@@ -183,7 +184,7 @@ class _RequestOptions(TypedDict, total=False):
183184
raise_for_status: Union[None, bool, Callable[[ClientResponse], Awaitable[None]]]
184185
read_until_eof: bool
185186
proxy: Union[StrOrURL, None]
186-
proxy_auth: Union[AuthBase, None]
187+
proxy_auth: Union[BasicAuth, None]
187188
timeout: "Union[ClientTimeout, _SENTINEL, None]"
188189
ssl: Union[SSLContext, bool, Fingerprint]
189190
server_hostname: Union[str, None]
@@ -270,7 +271,7 @@ def __init__(
270271
cookies: Optional[LooseCookies] = None,
271272
headers: Optional[LooseHeaders] = None,
272273
proxy: Optional[StrOrURL] = None,
273-
proxy_auth: Optional[AuthBase] = None,
274+
proxy_auth: Optional[BasicAuth] = None,
274275
skip_auto_headers: Optional[Iterable[str]] = None,
275276
auth: Optional[AuthBase] = None,
276277
json_serialize: JSONEncoder = json.dumps,
@@ -440,7 +441,7 @@ async def _request(
440441
] = None,
441442
read_until_eof: bool = True,
442443
proxy: Optional[StrOrURL] = None,
443-
proxy_auth: Optional[AuthBase] = None,
444+
proxy_auth: Optional[BasicAuth] = None,
444445
timeout: Union[ClientTimeout, _SENTINEL, None] = sentinel,
445446
ssl: Union[SSLContext, bool, Fingerprint] = True,
446447
server_hostname: Optional[str] = None,
@@ -836,7 +837,7 @@ def ws_connect(
836837
params: Query = None,
837838
headers: Optional[LooseHeaders] = None,
838839
proxy: Optional[StrOrURL] = None,
839-
proxy_auth: Optional[AuthBase] = None,
840+
proxy_auth: Optional[BasicAuth] = None,
840841
ssl: Union[SSLContext, bool, Fingerprint] = True,
841842
server_hostname: Optional[str] = None,
842843
proxy_headers: Optional[LooseHeaders] = None,
@@ -884,7 +885,7 @@ async def _ws_connect(
884885
params: Query = None,
885886
headers: Optional[LooseHeaders] = None,
886887
proxy: Optional[StrOrURL] = None,
887-
proxy_auth: Optional[AuthBase] = None,
888+
proxy_auth: Optional[BasicAuth] = None,
888889
ssl: Union[SSLContext, bool, Fingerprint] = True,
889890
server_hostname: Optional[str] = None,
890891
proxy_headers: Optional[LooseHeaders] = None,

Diff for: aiohttp/client_reqrep.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ class ConnectionKey(NamedTuple):
188188
is_ssl: bool
189189
ssl: Union[SSLContext, bool, Fingerprint]
190190
proxy: Optional[URL]
191-
proxy_auth: Optional[AuthBase]
191+
proxy_auth: Optional[BasicAuth]
192192
proxy_headers_hash: Optional[int] # hash(CIMultiDict)
193193

194194

@@ -240,7 +240,7 @@ def __init__(
240240
loop: asyncio.AbstractEventLoop,
241241
response_class: Optional[Type["ClientResponse"]] = None,
242242
proxy: Optional[URL] = None,
243-
proxy_auth: Optional[AuthBase] = None,
243+
proxy_auth: Optional[BasicAuth] = None,
244244
timer: Optional[BaseTimerContext] = None,
245245
session: Optional["ClientSession"] = None,
246246
ssl: Union[SSLContext, bool, Fingerprint] = True,
@@ -565,7 +565,7 @@ def update_expect_continue(self, expect: bool = False) -> None:
565565
def update_proxy(
566566
self,
567567
proxy: Optional[URL],
568-
proxy_auth: Optional[AuthBase],
568+
proxy_auth: Optional[BasicAuth],
569569
proxy_headers: Optional[LooseHeaders],
570570
) -> None:
571571
self.proxy = proxy

Diff for: aiohttp/helpers.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ def netrc_from_env() -> Optional[netrc.netrc]:
297297
@frozen_dataclass_decorator
298298
class ProxyInfo:
299299
proxy: URL
300-
proxy_auth: Optional[AuthBase]
300+
proxy_auth: Optional[BasicAuth]
301301

302302

303303
def basicauth_from_netrc(netrc_obj: Optional[netrc.netrc], host: str) -> BasicAuth:
@@ -595,7 +595,7 @@ def proxies_from_env() -> Dict[str, ProxyInfo]:
595595
return ret
596596

597597

598-
def get_env_proxy_for_url(url: URL) -> Tuple[URL, Optional[AuthBase]]:
598+
def get_env_proxy_for_url(url: URL) -> Tuple[URL, Optional[BasicAuth]]:
599599
"""Get a permitted proxy for the given URL from the env."""
600600
if url.host is not None and proxy_bypass(url.host):
601601
raise LookupError(f"Proxying is disallowed for `{url.host!r}`")

Diff for: docs/client_reference.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -475,8 +475,8 @@ The client session supports the context manager protocol for self closing.
475475

476476
:param proxy: Proxy URL, :class:`str` or :class:`~yarl.URL` (optional)
477477

478-
:param aiohttp.AuthBase proxy_auth: an object that represents proxy HTTP
479-
Authorization (optional)
478+
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
479+
Basic Authorization (optional)
480480

481481
:param int timeout: override the session's timeout.
482482

@@ -737,8 +737,8 @@ The client session supports the context manager protocol for self closing.
737737

738738
:param str proxy: Proxy URL, :class:`str` or :class:`~yarl.URL` (optional)
739739

740-
:param aiohttp.AuthBase proxy_auth: an object that represents proxy HTTP
741-
Authorization (optional)
740+
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
741+
Basic Authorization (optional)
742742

743743
:param ssl: SSL validation mode. ``True`` for default SSL check
744744
(:func:`ssl.create_default_context` is used),
@@ -947,8 +947,8 @@ certification chaining.
947947

948948
:param proxy: Proxy URL, :class:`str` or :class:`~yarl.URL` (optional)
949949

950-
:param aiohttp.AuthBase proxy_auth: an object that represents proxy HTTP
951-
Authorization (optional)
950+
:param aiohttp.BasicAuth proxy_auth: an object that represents proxy HTTP
951+
Basic Authorization (optional)
952952

953953
:param timeout: a :class:`ClientTimeout` settings structure, 300 seconds (5min)
954954
total timeout, 30 seconds socket connect timeout by default.

0 commit comments

Comments
 (0)