Skip to content

gh-161763: Correct SSL docs for unconnected client sockets #161772

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
gpshead merged 2 commits into from
Nov 12, 2026
Merged

gh-161763: Correct SSL docs for unconnected client sockets #161772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a86e02a
gh-161763: Correct SSL docs for unconnected client sockets
notatallshaw Nov 10, 2026
c883649
gh-161763: Qualify SSL socket method references
notatallshaw Nov 10, 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
10 changes: 5 additions & 5 deletions Doc/library/ssl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Client socket example with custom context and IPv4::

with socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) as sock:
with context.wrap_socket(sock, server_hostname=hostname) as ssock:
ssock.connect((hostname, 443))
print(ssock.version())


Expand Down Expand Up @@ -2236,13 +2237,12 @@ to speed up repeated connections from the same clients.
The parameter ``server_side`` is a boolean which identifies whether
server-side or client-side behavior is desired from this socket.

For client-side sockets, the context construction is lazy; if the
underlying socket isn't connected yet, the context construction will be
performed after :meth:`connect` is called on the socket. For
server-side sockets, if the socket has no remote peer, it is assumed
For client-side sockets, if *sock* is not yet connected, the underlying
SSL object is created when :meth:`~socket.socket.connect` is called.
For server-side sockets, if the socket has no remote peer, it is assumed
to be a listening socket, and the server-side SSL wrapping is
automatically performed on client connections accepted via the
:meth:`accept` method. The method may raise :exc:`SSLError`.
:meth:`~socket.socket.accept` method. The method may raise :exc:`SSLError`.

On client connections, the optional parameter *server_hostname* specifies
the hostname of the service which we are connecting to. This allows a
Expand Down
Loading