Skip to content

gh-65920: Implement socket.sendfile with TransmitFile on Windows #112337

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

Open
aisk wants to merge 20 commits into
base: main
Choose a base branch
from
Open

gh-65920: Implement socket.sendfile with TransmitFile on Windows #112337

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
490df91
add socket._sendfile_use_transmitfile
aisk Nov 23, 2023
f94935d
add Overlapped.getresultex to implement timeout in sendfile
aisk Nov 23, 2023
87c88fa
using transmitfile for sendfile on windows
aisk Nov 23, 2023
3f7259f
fix tests
aisk Nov 23, 2023
619ef22
skip tests on non windows platforms
aisk Nov 23, 2023
19dde50
fix generated file
aisk Nov 23, 2023
3dd3bc1
Merge branch 'main' into windows-socket-sendfile
aisk Nov 23, 2023
a4ce9df
Merge branch 'main' into windows-socket-sendfile
erlend-aasland Jan 6, 2024
77deb6e
Update Misc/NEWS.d/next/Windows/2023-11-23-22-25-16.gh-issue-65920.6w…
aisk Jan 7, 2024
47eb386
Update Lib/socket.py
aisk Jan 7, 2024
8bd91bb
Merge branch 'main' into windows-socket-sendfile
aisk Apr 24, 2024
b153f22
Merge remote-tracking branch 'origin/main' into windows-socket-sendfile
aisk Dec 2, 2025
048f6a1
Call TransmitFile in chunk
aisk Mar 1, 2026
d6ed576
Merge remote-tracking branch 'upstream/main' into windows-socket-send…
aisk Mar 1, 2026
6edf90f
Fix news entry
aisk Mar 1, 2026
f2de502
Fallback if _overlapped is not usage
aisk Mar 1, 2026
deee263
Update generated files
aisk Mar 1, 2026
1a92bfc
Merge remote-tracking branch 'upstream/main' into windows-socket-send…
aisk Jun 26, 2026
63d384b
Fix file position on error and fallback in socket.sendfile
aisk Jun 27, 2026
76e9bc8
Update sendfile docs and add getresultex docstring
aisk Jun 27, 2026
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
Next Next commit
add socket._sendfile_use_transmitfile
  • Loading branch information
@aisk
aisk committed Nov 23, 2023
commit 490df91637b86087b6017d8d104f3f10791cc429
23 changes: 23 additions & 0 deletions Lib/socket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,13 @@
import os, sys, io, selectors
from enum import IntEnum, IntFlag

try:
import _overlapped
import msvcrt
except ImportError:
_overlapped = None
msvcrt = None

try:
import errno
except ImportError:
Expand Down Expand Up @@ -451,6 +458,22 @@ def _sendfile_use_send(self, file, offset=0, count=None):
if total_sent > 0 and hasattr(file, 'seek'):
file.seek(offset + total_sent)

if _overlapped:
Comment thread
aisk marked this conversation as resolved.
Outdated
def _sendfile_use_transmitfile(self, file, offset=0, count=None):
self._check_sendfile_params(file, offset, count)
if self.gettimeout() == 0:
raise ValueError("non-blocking sockets are not supported")
ov = _overlapped.Overlapped()
offset_low = offset & 0xffff_ffff
offset_high = (offset >> 32) & 0xffff_ffff
count = count or 0
ov.TransmitFile(self.fileno(), msvcrt.get_osfhandle(file.fileno()),
offset_low, offset_high, count, 0, 0)
sent = ov.getresult(True)
if sent > 0 and hasattr(file, 'seek'):
file.seek(offset + sent)
return sent

def _check_sendfile_params(self, file, offset, count):
if 'b' not in getattr(file, 'mode', 'b'):
raise ValueError("file should be opened in binary mode")
Expand Down
8 changes: 8 additions & 0 deletions Lib/test/test_socket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6421,6 +6421,14 @@ def meth_from_sock(self, sock):
return getattr(sock, "_sendfile_use_sendfile")


class SendfileUsingTransmitfileTest(SendfileUsingSendTest):
"""
Test the TransmitFile() implementation of socket.sendfile().
"""
def meth_from_sock(self, sock):
return getattr(sock, "_sendfile_use_transmitfile")


@unittest.skipUnless(HAVE_SOCKET_ALG, 'AF_ALG required')
class LinuxKernelCryptoAPI(unittest.TestCase):
# tests for AF_ALG
Expand Down