Update UnixSocketMixin to disable socket cleanup on Py >= 3.13#592
Open
cuu508 wants to merge 5 commits into
Open
Update UnixSocketMixin to disable socket cleanup on Py >= 3.13#592cuu508 wants to merge 5 commits into
cuu508 wants to merge 5 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #592 +/- ##
==========================================
+ Coverage 97.75% 97.81% +0.05%
==========================================
Files 23 23
Lines 5709 5712 +3
Branches 351 352 +1
==========================================
+ Hits 5581 5587 +6
+ Misses 79 75 -4
- Partials 49 50 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
cuu508
force-pushed
the
fix_test_unixsocket_on_py313
branch
from
2707444 to
7eda3d4
Compare
Starting from Python 3.13, the unix listener automatically cleans up its socket from the filesystem on shutdown. This can be disabled by passing in cleanup_socket=False. I think it makes sense for aiosmtpd to do that, to keep the shutdown behavior consistent between Python versions. This change fixes the only failing test on Python 3.13: aiosmtpd/tests/test_server.py::TestUnthreaded::test_unixsocket
Passing *kw to `create_unix_server` works at runtime but I'm not sure how to annotate it correctly. Added "type: ignore" to silence mypy warning about unrecognized cleanup_socket argument: python/typeshed#15742
cuu508
force-pushed
the
fix_test_unixsocket_on_py313
branch
from
74918fa to
95b926f
Compare
For some unclear reason, if: * tests are run on python 3.13 * and the system has a proper, non-loopback IPv6 address * and inside tests we mock the socket.recv() function then `asyncio.base_events.Server._wakeup` gets called twice and throws an exception on the second call. As a workaround, in test_controller.py, mock something adjacent to socket.recv – the socket.create_connection function.
cuu508
commented
May 18, 2026
webknjaz
reviewed
May 26, 2026
Member
webknjaz
left a comment
webknjaz
left a comment
There was a problem hiding this comment.
I think the overall approach is fine as a compatibility fix. But long-term, it may make sense to flip the behavior down the line. Or at least provide a way to opt into this behavior and/or have a CM interface for this.
In general, I'd expect servers to clean garbage they've produced, upon completion.
| return self.loop.create_unix_server( | ||
| self._factory_invoker, | ||
| path=self.unix_socket, | ||
| ssl=self.ssl_context, |
Member
There was a problem hiding this comment.
It'd be cleaner to have
Suggested change
| ssl=self.ssl_context, | |
| **_create_unix_server_trailing_kwargs, |
and compute the var conditionally with {} for older versions.
Contributor
Author
There was a problem hiding this comment.
IIRC I initially tried that but couldn't make mypy happy.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What do these changes do?
This change fixes the only failing test on Python 3.13:
This test starts an Unix listener, exercises it, closes it and checks if the socket still exists on the filesystem. The socket does exist on Python 3.12 and below (the test passes), but does not exist on Python 3.13 (the test fails).
This is because Python added automatic socket cleanup: python/cpython#111246
There's a new
cleanup_socket=Falseargument forcreate_unix_serverwhich restores the old behavior (docs). I think it makes sense for aiosmtpd to use it, to keep the shutdown behavior consistent between Python versions.Are there changes in behavior for the user?
Yes:
There's no change when using Python 3.12 and below.
Related issue number
Checklist
NEWS.rstfile