Skip to content

Docs: improve accuracy of socketserver reference #24767

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

Merged
erlend-aasland merged 9 commits into from
Nov 29, 2022
Merged

Docs: improve accuracy of socketserver reference #24767

Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
38d27aa
Update socketserver.rst
geryogam Mar 5, 2021
dcea65b
Fix the class diagram
geryogam Mar 5, 2021
126273b
Remove a no longer valid restriction for wfile
geryogam Mar 8, 2021
62d3aa6
Apply Erlend’s change suggestion
geryogam Nov 28, 2022
a033dc8
Revert arrow direction in class diagram
geryogam Nov 28, 2022
512d06c
Apply Erlend’s suggested change
geryogam Nov 28, 2022
f6cd652
Update socketserver.rst
geryogam Nov 29, 2022
57604b9
Apply Erlend’s suggestion
geryogam Nov 29, 2022
a55c279
Update Doc/library/socketserver.rst
geryogam Nov 29, 2022
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
13 changes: 5 additions & 8 deletions Doc/library/socketserver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ synchronous servers of four types::
+-----------+ +--------------------+

Note that :class:`UnixDatagramServer` derives from :class:`UDPServer`, not from
:class:`UnixStreamServer` --- the only difference between an IP and a Unix
stream server is the address family, which is simply repeated in both Unix
server classes.
:class:`UnixStreamServer` --- the only difference between a TCP or UDP server
and a Unix stream or datagram server is the address family, which is simply repeated in both Unix
stream and datagram server classes.


.. class:: ForkingMixIn
Expand Down Expand Up @@ -430,11 +430,8 @@ Request Handler Objects
The :attr:`self.rfile` and :attr:`self.wfile` attributes can be
read or written, respectively, to get the request data or return data
to the client.

The :attr:`rfile` attributes of both classes support the
:class:`io.BufferedIOBase` readable interface, and
:attr:`DatagramRequestHandler.wfile` supports the
:class:`io.BufferedIOBase` writable interface.
The :attr:`!rfile` attributes support the :class:`io.BufferedIOBase` readable interface,
and :attr:`!wfile` attributes support the :class:`!io.BufferedIOBase` writable interface.

.. versionchanged:: 3.6
:attr:`StreamRequestHandler.wfile` also supports the
Expand Down