]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
docs: Update intersphinx references for python 3.12
authorBen Darnell <ben@bendarnell.com>
Sat, 14 Oct 2023 01:27:20 +0000 (21:27 -0400)
committerBen Darnell <ben@bendarnell.com>
Sat, 14 Oct 2023 01:27:20 +0000 (21:27 -0400)
Intersphinx links are currently an unpinned dependency, so when
a new version of python is released it's possible (although relatively
rare) for it to break our links. 3.12 removed a few members of
the ssl module.

docs/releases/v3.0.1.rst
docs/releases/v5.0.0.rst
tornado/httpserver.py
tornado/iostream.py
tornado/netutil.py
tornado/tcpserver.py

index 4511838c85eccddcc4c781ab90503b3b6ed2e6fb..4d289f5004e5118c094cb01b9407b3701435df2b 100644 (file)
@@ -11,7 +11,7 @@ Apr 8, 2013
 * The `tornado.testing.gen_test` decorator will no longer be recognized
   as a (broken) test by ``nose``.
 * Work around a bug in Ubuntu 13.04 betas involving an incomplete backport
-  of the `ssl.match_hostname` function.
+  of the ``ssl.match_hostname`` function.
 * `tornado.websocket.websocket_connect` now fails cleanly when it attempts
   to connect to a non-websocket url.
 * ``tornado.testing.LogTrapTestCase`` once again works with byte strings
index dd0bd02439bab52406859473ffa617f11038f772..950b2e17391c6c6943c6a69dea4bbbe572499557 100644 (file)
@@ -27,7 +27,7 @@ Backwards-compatibility notes
   longer supported. (The `ssl` module was updated in version 2.7.9,
   although in some distributions the updates are present in builds
   with a lower version number. Tornado requires `ssl.SSLContext`,
-  `ssl.create_default_context`, and `ssl.match_hostname`)
+  `ssl.create_default_context`, and ``ssl.match_hostname``)
 - Versions of Python 3.5 prior to 3.5.2 are no longer supported due to
   a change in the async iterator protocol in that version.
 - The ``trollius`` project (`asyncio` backported to Python 2) is no
index 77dc541e9de7c58afe426acf71705e7958620d14..757f711b24debba00383949da371f20101e90daf 100644 (file)
@@ -74,7 +74,7 @@ class HTTPServer(TCPServer, Configurable, httputil.HTTPServerConnectionDelegate)
     To make this server serve SSL traffic, send the ``ssl_options`` keyword
     argument with an `ssl.SSLContext` object. For compatibility with older
     versions of Python ``ssl_options`` may also be a dictionary of keyword
-    arguments for the `ssl.wrap_socket` method.::
+    arguments for the `ssl.SSLContext.wrap_socket` method.::
 
        ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
        ssl_ctx.load_cert_chain(os.path.join(data_dir, "mydomain.crt"),
index a408be59cd8b59f0ca00832316a1cc651a914fe0..0305370a8a08e25a77eacd22bef7561c36d7b56d 100644 (file)
@@ -1217,7 +1217,7 @@ class IOStream(BaseIOStream):
 
         The ``ssl_options`` argument may be either an `ssl.SSLContext`
         object or a dictionary of keyword arguments for the
-        `ssl.wrap_socket` function.  The ``server_hostname`` argument
+        `ssl.SSLContext.wrap_socket` function.  The ``server_hostname`` argument
         will be used for certificate validation unless disabled
         in the ``ssl_options``.
 
@@ -1322,7 +1322,7 @@ class SSLIOStream(IOStream):
     If the socket passed to the constructor is already connected,
     it should be wrapped with::
 
-        ssl.wrap_socket(sock, do_handshake_on_connect=False, **kwargs)
+        ssl.SSLContext(...).wrap_socket(sock, do_handshake_on_connect=False, **kwargs)
 
     before constructing the `SSLIOStream`.  Unconnected sockets will be
     wrapped when `IOStream.connect` is finished.
@@ -1333,7 +1333,7 @@ class SSLIOStream(IOStream):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         """The ``ssl_options`` keyword argument may either be an
         `ssl.SSLContext` object or a dictionary of keywords arguments
-        for `ssl.wrap_socket`
+        for `ssl.SSLContext.wrap_socket`
         """
         self._ssl_options = kwargs.pop("ssl_options", _client_ssl_defaults)
         super().__init__(*args, **kwargs)
index 04db085abf4c2f553e1c899da9dc475c4cdfcef5..be7b55373a7015961cd95dd6004be177e5bf8518 100644 (file)
@@ -594,7 +594,7 @@ def ssl_options_to_context(
     `~ssl.SSLContext` object.
 
     The ``ssl_options`` dictionary contains keywords to be passed to
-    `ssl.wrap_socket`.  In Python 2.7.9+, `ssl.SSLContext` objects can
+    ``ssl.SSLContext.wrap_socket``.  In Python 2.7.9+, `ssl.SSLContext` objects can
     be used instead.  This function converts the dict form to its
     `~ssl.SSLContext` equivalent, and may be used when a component which
     accepts both forms needs to upgrade to the `~ssl.SSLContext` version
@@ -652,9 +652,7 @@ def ssl_wrap_socket(
 
     ``ssl_options`` may be either an `ssl.SSLContext` object or a
     dictionary (as accepted by `ssl_options_to_context`).  Additional
-    keyword arguments are passed to ``wrap_socket`` (either the
-    `~ssl.SSLContext` method or the `ssl` module function as
-    appropriate).
+    keyword arguments are passed to `ssl.SSLContext.wrap_socket`.
 
     .. versionchanged:: 6.2
 
index deab8f2ad99cba048939760ad1c82be1730d000b..02c0ca0ccab9186c7e900a3a80610ef851f55380 100644 (file)
@@ -61,7 +61,7 @@ class TCPServer(object):
     To make this server serve SSL traffic, send the ``ssl_options`` keyword
     argument with an `ssl.SSLContext` object. For compatibility with older
     versions of Python ``ssl_options`` may also be a dictionary of keyword
-    arguments for the `ssl.wrap_socket` method.::
+    arguments for the `ssl.SSLContext.wrap_socket` method.::
 
        ssl_ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
        ssl_ctx.load_cert_chain(os.path.join(data_dir, "mydomain.crt"),