Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/expose request interface #7186

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Feature/expose request interface #7186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db470e1
expose request param interface
jujumilk3 Jan 28, 2023
661487f
remove param default values
jujumilk3 Jan 28, 2023
403a034
add contribute info
jujumilk3 Jan 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/7185.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Display ClientSession methods' parameters in the help window.
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ Dmitry Shamov
Dmitry Trofimov
Dmytro Bohomiakov
Dmytro Kuznetsov
Donggyu Damon Lee
Dustin J. Mitchell
Eduard Iskandarov
Eli Ribble
Expand Down
284 changes: 266 additions & 18 deletions aiohttp/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import base64
import dataclasses
import hashlib
import inspect
import json
import os
import sys
Expand Down Expand Up @@ -911,60 +912,307 @@ def _prepare_headers(self, headers: Optional[LooseHeaders]) -> "CIMultiDict[str]
return result

def get(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
self,
url: StrOrURL,
*,
allow_redirects: bool = True,
params: Optional[Mapping[str, str]] = None,
data: Any = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP GET request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs)
self._request(hdrs.METH_GET, url, **expected_params)
)

def options(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
self,
url: StrOrURL,
*,
allow_redirects: bool = True,
params: Optional[Mapping[str, str]] = None,
data: Any = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP OPTIONS request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(
hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs
)
self._request(hdrs.METH_OPTIONS, url, **expected_params)
)

def head(
self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any
self,
url: StrOrURL,
*,
allow_redirects: bool = False,
params: Optional[Mapping[str, str]] = None,
data: Any = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP HEAD request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(
hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs
)
self._request(hdrs.METH_HEAD, url, **expected_params)
)

def post(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
self,
url: StrOrURL,
*,
data: Any = None,
params: Optional[Mapping[str, str]] = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP POST request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(hdrs.METH_POST, url, data=data, **kwargs)
self._request(hdrs.METH_POST, url, **expected_params)
)

def put(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
self,
url: StrOrURL,
*,
data: Any = None,
params: Optional[Mapping[str, str]] = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP PUT request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(hdrs.METH_PUT, url, data=data, **kwargs)
self._request(hdrs.METH_PUT, url, **expected_params)
)

def patch(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
self,
url: StrOrURL,
*,
data: Any = None,
params: Optional[Mapping[str, str]] = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP PATCH request."""
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(hdrs.METH_PATCH, url, data=data, **kwargs)
self._request(hdrs.METH_PATCH, url, **expected_params)
)

def delete(self, url: StrOrURL, **kwargs: Any) -> "_RequestContextManager":
def delete(
self,
url: StrOrURL,
params: Optional[Mapping[str, str]] = None,
data: Any = None,
json: Any = None,
cookies: Optional[LooseCookies] = None,
headers: Optional[LooseHeaders] = None,
skip_auto_headers: Optional[Iterable[str]] = None,
auth: Optional[BasicAuth] = None,
max_redirects: Optional[int] = None,
compress: Optional[str] = None,
chunked: Optional[bool] = None,
expect100: Optional[bool] = None,
raise_for_status: Union[
None, bool, Callable[[ClientResponse], Awaitable[None]]
] = None,
read_until_eof: Optional[bool] = None,
proxy: Optional[StrOrURL] = None,
proxy_auth: Optional[BasicAuth] = None,
timeout: Union[ClientTimeout, _SENTINEL, None] = None,
ssl: Optional[Union[SSLContext, bool, Fingerprint]] = None,
proxy_headers: Optional[LooseHeaders] = None,
trace_request_ctx: Optional[SimpleNamespace] = None,
read_bufsize: Optional[int] = None,
auto_decompress: Optional[bool] = None,
**kwargs: Any,
) -> "_RequestContextManager":
"""Perform HTTP DELETE request."""
return _RequestContextManager(self._request(hdrs.METH_DELETE, url, **kwargs))
params = locals()
expected_params = {
k: v
for k, v in params.items()
if k in inspect.signature(self.get).parameters
and v is not None
and k not in ("url", "kwargs")
}
expected_params.update(kwargs)
return _RequestContextManager(
self._request(hdrs.METH_DELETE, url, **expected_params)
)

async def close(self) -> None:
"""Close underlying connector.
Expand Down