diff options
| author | Daniel Williams <dann0a@gmail.com> | 2024-05-21 16:23:50 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-21 16:23:50 (GMT) |
| commit | 62a29be5bb01c2d0f72d8f9b1b5539816e65310c (patch) | |
| tree | 8f71e749080238cf5fa067ed434caec15849ba2f | |
| parent | 0398d9339217aa0710c0de45a7e9b587136e7129 (diff) | |
| download | cpython-62a29be5bb01c2d0f72d8f9b1b5539816e65310c.zip cpython-62a29be5bb01c2d0f72d8f9b1b5539816e65310c.tar.gz cpython-62a29be5bb01c2d0f72d8f9b1b5539816e65310c.tar.bz2 | |
gh-110383: Document `socket.makefile()` accepts combined modes (#119150)
The supported mode values are 'r', 'w', and 'b', or a combination of those.
| -rw-r--r-- | Doc/library/socket.rst | 3 | ||||
| -rw-r--r-- | Lib/socket.py | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index 6405f7f..2df0257 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -1589,7 +1589,8 @@ to sockets. Return a :term:`file object` associated with the socket. The exact returned type depends on the arguments given to :meth:`makefile`. These arguments are interpreted the same way as by the built-in :func:`open` function, except - the only supported *mode* values are ``'r'`` (default), ``'w'`` and ``'b'``. + the only supported *mode* values are ``'r'`` (default), ``'w'``, ``'b'``, or + a combination of those. The socket must be in blocking mode; it can have a timeout, but the file object's internal buffer may end up in an inconsistent state if a timeout diff --git a/Lib/socket.py b/Lib/socket.py index 77986fc..524ce13 100644 --- a/Lib/socket.py +++ b/Lib/socket.py @@ -306,7 +306,8 @@ class socket(_socket.socket): """makefile(...) -> an I/O stream connected to the socket The arguments are as for io.open() after the filename, except the only - supported mode values are 'r' (default), 'w' and 'b'. + supported mode values are 'r' (default), 'w', 'b', or a combination of + those. """ # XXX refactor to share code? if not set(mode) <= {"r", "w", "b"}: |