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

Make enable_cleanup_closed a NOOP for Python 3.12.7+ and 3.13.1+ #9726

Merged
merged 6 commits into from
Nov 9, 2024
Merged

Make enable_cleanup_closed a NOOP for Python 3.12.7+ and 3.13.1+ #9726

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f517d1c
Make ``enable_cleanup_closed`` a NOOP for Python 3.12.7+ and 3.13.1+
bdraco Nov 9, 2024
6f11f80
changelog
bdraco Nov 9, 2024
fe30909
Update aiohttp/connector.py
bdraco Nov 9, 2024
b25d998
Update docs/client_reference.rst
bdraco Nov 9, 2024
8751ff4
ensure enable_cleanup_closed=True tests still run on all Python versions
bdraco Nov 9, 2024
ec5eb34
add test to ensure warnings
bdraco Nov 9, 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/9726.misc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Passing ``enable_cleanup_closed`` to :py:class:`aiohttp.TCPConnector` is now ignored on Python 3.12.7+ and 3.13.1+ since the underlying bug that caused asyncio to leak SSL connections has been fixed upstream -- by :user:`bdraco`.
19 changes: 19 additions & 0 deletions aiohttp/connector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@
HTTP_AND_EMPTY_SCHEMA_SET = HTTP_SCHEMA_SET | EMPTY_SCHEMA_SET
HIGH_LEVEL_SCHEMA_SET = HTTP_AND_EMPTY_SCHEMA_SET | WS_SCHEMA_SET

NEEDS_CLEANUP_CLOSED = (3, 13, 0) <= sys.version_info < (
3,
13,
1,
) or sys.version_info < (3, 12, 7)
bdraco marked this conversation as resolved.
Show resolved Hide resolved
# Cleanup closed is no longer needed after https://github.com/python/cpython/pull/118960
# which first appeared in Python 3.12.7 and 3.13.1


__all__ = ("BaseConnector", "TCPConnector", "UnixConnector", "NamedPipeConnector")

Expand Down Expand Up @@ -270,6 +278,17 @@ def __init__(

# start cleanup closed transports task
self._cleanup_closed_handle: Optional[asyncio.TimerHandle] = None

if enable_cleanup_closed and not NEEDS_CLEANUP_CLOSED:
warnings.warn(
"enable_cleanup_closed ignored because "
"https://github.com/python/cpython/pull/118960 is fixed in "
"this Python version {sys.version_info}.",
bdraco marked this conversation as resolved.
Show resolved Hide resolved
DeprecationWarning,
stacklevel=2,
)
enable_cleanup_closed = False

self._cleanup_closed_disabled = not enable_cleanup_closed
self._cleanup_closed_transports: List[Optional[asyncio.Transport]] = []

Expand Down
6 changes: 5 additions & 1 deletion docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -963,10 +963,14 @@ is controlled by *force_close* constructor's parameter).
connection releasing (optional).

:param bool enable_cleanup_closed: some SSL servers do not properly complete
SSL shutdown process, in that case asyncio leaks ssl connections.
SSL shutdown process, in that case asyncio leaks SSL connections.
If this parameter is set to True, aiohttp additionally aborts underlining
transport after 2 seconds. It is off by default.

For Python version 3.12.7+, or 3.13.1 and later,
this parameter is ignored because the asyncio SSL connection
leak is fixed in Python.
bdraco marked this conversation as resolved.
Show resolved Hide resolved


:param loop: :ref:`event loop<asyncio-event-loop>`
used for handling connections.
Expand Down
Loading