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

gh-110383: Document socket.makefile() accepts combined modes #119150

Merged
merged 4 commits into from
May 21, 2024
Merged

gh-110383: Document socket.makefile() accepts combined modes #119150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc72329
Document `socket.makefile()` accepts combined modes
squeakyboots May 18, 2024
2e8d690
Merge branch 'python:main' into socket.makefile-doc-modes
squeakyboots May 20, 2024
81f461e
Merge branch 'python:main' into socket.makefile-doc-modes
squeakyboots May 20, 2024
20ded2e
Document `socket.makefile()` accepts combined modes in `Lib/socket.py`
squeakyboots May 20, 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
3 changes: 2 additions & 1 deletion Doc/library/socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion Lib/socket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,8 @@ def makefile(self, mode="r", buffering=None, *,
"""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"}:
Expand Down
Loading