Skip to content

Add full request typing signatures for session HTTP methods #8463

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

Merged
merged 10 commits into from
Jul 6, 2024
Merged

Add full request typing signatures for session HTTP methods #8463

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
680d4f5
Add overloads
max-muoto Jun 30, 2024
9212617
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 30, 2024
cb998f9
Merge branch 'master' into feat-improve-request-typing
max-muoto Jun 30, 2024
2df4510
Add changes
max-muoto Jun 30, 2024
c3051af
Merge branch 'feat-improve-request-typing' of https://github.com/max-…
max-muoto Jun 30, 2024
c8368cf
Avoid overloading
max-muoto Jul 5, 2024
ac10ab0
Remove unused import
max-muoto Jul 5, 2024
3d4155f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 5, 2024
e4af6b1
Address feedback
max-muoto Jul 6, 2024
703e89f
Merge branch 'feat-improve-request-typing' of https://github.com/max-…
max-muoto Jul 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/8463.misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added a 3.11-specific overloads to ``ClientSession`` -- by :user:`max-muoto`.
175 changes: 128 additions & 47 deletions aiohttp/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@
Set,
Tuple,
Type,
TypedDict,
TypeVar,
Union,
final,
overload,
)

from multidict import CIMultiDict, MultiDict, MultiDictProxy, istr
Expand Down Expand Up @@ -150,6 +152,34 @@
SSLContext = None


class _RequestOptions(TypedDict, total=False):
params: Union[Mapping[str, str], None]
data: Any
json: Any
cookies: Union[LooseCookies, None]
headers: Union[LooseHeaders, None]
skip_auto_headers: Union[Iterable[str], None]
auth: Union[BasicAuth, None]
allow_redirects: bool
max_redirects: int
compress: Union[str, None]
Copy link

@andersk andersk Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This contradicts the documentation for compress as bool:

aiohttp/docs/client_reference.rst

Lines 431 to 434 in 48a5e07

:param bool compress: Set to ``True`` if request has to be compressed
with deflate encoding. If `compress` can not be combined
with a *Content-Encoding* and *Content-Length* headers.
``None`` by default (optional).

Copy link
Member

@Dreamsorcerer Dreamsorcerer Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's copied from _request(), not something related to this PR specifically. Feel free to open a PR to fix it. Looking at the code, it's the docs that are inaccurate, though we could expand the typing to allow bool:

aiohttp/aiohttp/client_reqrep.py

Lines 434 to 436 in 48a5e07

elif self.compress:
if not isinstance(self.compress, str):
self.compress = "deflate"

Copy link
Member

@Dreamsorcerer Dreamsorcerer Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, basically:
None/False/"" = Disable compression
str = use this compression method
Non-str (e.g. True) = use deflate

Copy link
Member

@Dreamsorcerer Dreamsorcerer Aug 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely clear how the str is used though, I think maybe only deflate and gzip are valid..

chunked: Union[bool, None]
expect100: bool
raise_for_status: Union[None, bool, Callable[[ClientResponse], Awaitable[None]]]
read_until_eof: bool
proxy: Union[StrOrURL, None]
proxy_auth: Union[BasicAuth, None]
timeout: "Union[ClientTimeout, _SENTINEL, None]"
ssl: Union[SSLContext, bool, Fingerprint]
server_hostname: Union[str, None]
proxy_headers: Union[LooseHeaders, None]
trace_request_ctx: Union[SimpleNamespace, None]
read_bufsize: Union[int, None]
auto_decompress: Union[bool, None]
max_line_size: Union[int, None]
max_field_size: Union[int, None]


@dataclasses.dataclass(frozen=True)
class ClientTimeout:
total: Optional[float] = None
Expand Down Expand Up @@ -986,61 +1016,112 @@ def _prepare_headers(self, headers: Optional[LooseHeaders]) -> "CIMultiDict[str]
added_names.add(key)
return result

def get(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP GET request."""
return _RequestContextManager(
self._request(hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs)
)
if sys.version_info >= (3, 11) and TYPE_CHECKING:
import typing

def get(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def options(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def head(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def post(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def put(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def patch(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

def delete(
self,
url: StrOrURL,
**kwargs: typing.Unpack[_RequestOptions],
) -> "_RequestContextManager": ...

Check notice

Code scanning / CodeQL

Statement has no effect

This statement has no effect.

else:

def get(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP GET request."""
return _RequestContextManager(
self._request(
hdrs.METH_GET, url, allow_redirects=allow_redirects, **kwargs
)
)

def options(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP OPTIONS request."""
return _RequestContextManager(
self._request(
hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs
def options(
self, url: StrOrURL, *, allow_redirects: bool = True, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP OPTIONS request."""
return _RequestContextManager(
self._request(
hdrs.METH_OPTIONS, url, allow_redirects=allow_redirects, **kwargs
)
)
)

def head(
self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP HEAD request."""
return _RequestContextManager(
self._request(
hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs
def head(
self, url: StrOrURL, *, allow_redirects: bool = False, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP HEAD request."""
return _RequestContextManager(
self._request(
hdrs.METH_HEAD, url, allow_redirects=allow_redirects, **kwargs
)
)
)

def post(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP POST request."""
return _RequestContextManager(
self._request(hdrs.METH_POST, url, data=data, **kwargs)
)
def post(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP POST request."""
return _RequestContextManager(
self._request(hdrs.METH_POST, url, data=data, **kwargs)
)

def put(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP PUT request."""
return _RequestContextManager(
self._request(hdrs.METH_PUT, url, data=data, **kwargs)
)
def put(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP PUT request."""
return _RequestContextManager(
self._request(hdrs.METH_PUT, url, data=data, **kwargs)
)

def patch(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP PATCH request."""
return _RequestContextManager(
self._request(hdrs.METH_PATCH, url, data=data, **kwargs)
)
def patch(
self, url: StrOrURL, *, data: Any = None, **kwargs: Any
) -> "_RequestContextManager":
"""Perform HTTP PATCH request."""
return _RequestContextManager(
self._request(hdrs.METH_PATCH, url, data=data, **kwargs)
)

def delete(self, url: StrOrURL, **kwargs: Any) -> "_RequestContextManager":
"""Perform HTTP DELETE request."""
return _RequestContextManager(self._request(hdrs.METH_DELETE, url, **kwargs))
def delete(self, url: StrOrURL, **kwargs: Any) -> "_RequestContextManager":
"""Perform HTTP DELETE request."""
return _RequestContextManager(
self._request(hdrs.METH_DELETE, url, **kwargs)
)

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