Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3c3d3c7

Browse files
committed
Issue #22564: ssl doc: use "class" marker to document the SSLSocket class
1 parent 41f92c2 commit 3c3d3c7

1 file changed

Lines changed: 26 additions & 24 deletions

File tree

Doc/library/ssl.rst

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -755,30 +755,32 @@ Constants
755755
SSL Sockets
756756
-----------
757757

758-
SSL sockets provide the following methods of :ref:`socket-objects`:
759-
760-
- :meth:`~socket.socket.accept()`
761-
- :meth:`~socket.socket.bind()`
762-
- :meth:`~socket.socket.close()`
763-
- :meth:`~socket.socket.connect()`
764-
- :meth:`~socket.socket.detach()`
765-
- :meth:`~socket.socket.fileno()`
766-
- :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()`
767-
- :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()`
768-
- :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`,
769-
:meth:`~socket.socket.setblocking()`
770-
- :meth:`~socket.socket.listen()`
771-
- :meth:`~socket.socket.makefile()`
772-
- :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()`
773-
(but passing a non-zero ``flags`` argument is not allowed)
774-
- :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with
775-
the same limitation)
776-
- :meth:`~socket.socket.shutdown()`
777-
778-
However, since the SSL (and TLS) protocol has its own framing atop
779-
of TCP, the SSL sockets abstraction can, in certain respects, diverge from
780-
the specification of normal, OS-level sockets. See especially the
781-
:ref:`notes on non-blocking sockets <ssl-nonblocking>`.
758+
.. class:: SSLSocket(socket.socket)
759+
760+
SSL sockets provide the following methods of :ref:`socket-objects`:
761+
762+
- :meth:`~socket.socket.accept()`
763+
- :meth:`~socket.socket.bind()`
764+
- :meth:`~socket.socket.close()`
765+
- :meth:`~socket.socket.connect()`
766+
- :meth:`~socket.socket.detach()`
767+
- :meth:`~socket.socket.fileno()`
768+
- :meth:`~socket.socket.getpeername()`, :meth:`~socket.socket.getsockname()`
769+
- :meth:`~socket.socket.getsockopt()`, :meth:`~socket.socket.setsockopt()`
770+
- :meth:`~socket.socket.gettimeout()`, :meth:`~socket.socket.settimeout()`,
771+
:meth:`~socket.socket.setblocking()`
772+
- :meth:`~socket.socket.listen()`
773+
- :meth:`~socket.socket.makefile()`
774+
- :meth:`~socket.socket.recv()`, :meth:`~socket.socket.recv_into()`
775+
(but passing a non-zero ``flags`` argument is not allowed)
776+
- :meth:`~socket.socket.send()`, :meth:`~socket.socket.sendall()` (with
777+
the same limitation)
778+
- :meth:`~socket.socket.shutdown()`
779+
780+
However, since the SSL (and TLS) protocol has its own framing atop
781+
of TCP, the SSL sockets abstraction can, in certain respects, diverge from
782+
the specification of normal, OS-level sockets. See especially the
783+
:ref:`notes on non-blocking sockets <ssl-nonblocking>`.
782784

783785
SSL sockets also have the following additional methods and attributes:
784786

0 commit comments

Comments
 (0)