Skip to content

Commit

Permalink
pythongh-94172: Update keyfile removal documentation
Browse files Browse the repository at this point in the history
Remove the "deprecated:: 3.6" markup, since the parameters (like
keyfile and certfile) got removed in Python 3.12.
  • Loading branch information
vstinner committed Jun 6, 2023
1 parent b1a91d2 commit ffe6970
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 51 deletions.
8 changes: 1 addition & 7 deletions Doc/library/ftplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,20 +107,14 @@ The module defines the following items:
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
:data:`ssl.HAS_SNI`).

.. deprecated:: 3.6
*keyfile* and *certfile* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
:class:`ValueError` to prevent the creation of a non-blocking socket.
The *encoding* parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow :rfc:`2640`.

.. versionchanged:: 3.12
The deprecated *keyfile* and *certfile* parameters have been removed.
The deprecated *keyfile* and *certfile* parameters have been removed.

Here's a sample session using the :class:`FTP_TLS` class::

Expand Down
14 changes: 2 additions & 12 deletions Doc/library/http.client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,6 @@ The module provides the following classes:
:func:`ssl._create_unverified_context` can be passed to the *context*
parameter.

.. deprecated:: 3.6
*key_file* and *cert_file* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

The *check_hostname* parameter is also deprecated; the
:attr:`ssl.SSLContext.check_hostname` attribute of *context* should
be used instead.

.. versionchanged:: 3.8
This class now enables TLS 1.3
:attr:`ssl.SSLContext.post_handshake_auth` for the default *context* or
Expand All @@ -116,8 +106,8 @@ The module provides the following classes:
ALPN protocols with :meth:`~ssl.SSLContext.set_alpn_protocol`.

.. versionchanged:: 3.12
The deprecated *key_file*, *cert_file* and *check_hostname* parameters
have been removed.
The deprecated *key_file*, *cert_file* and *check_hostname* parameters
have been removed.


.. class:: HTTPResponse(sock, debuglevel=0, method=None, url=None)
Expand Down
9 changes: 1 addition & 8 deletions Doc/library/imaplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,11 @@ There's also a subclass for secure connections:
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
:data:`ssl.HAS_SNI`).

.. deprecated:: 3.6

*keyfile* and *certfile* are deprecated in favor of *ssl_context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

.. versionchanged:: 3.9
The optional *timeout* parameter was added.

.. versionchanged:: 3.12
The deprecated *keyfile* and *certfile* parameters have been removed.
The deprecated *keyfile* and *certfile* parameters have been removed.

The second subclass allows for connections created by a child process:

Expand Down
9 changes: 1 addition & 8 deletions Doc/library/poplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,19 +79,12 @@ The :mod:`poplib` module provides two classes:
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
:data:`ssl.HAS_SNI`).

.. deprecated:: 3.6

*keyfile* and *certfile* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
:class:`ValueError` to prevent the creation of a non-blocking socket.

.. versionchanged:: 3.12
The deprecated *keyfile* and *certfile* parameters have been removed.
The deprecated *keyfile* and *certfile* parameters have been removed.

One exception is defined as an attribute of the :mod:`poplib` module:

Expand Down
18 changes: 2 additions & 16 deletions Doc/library/smtplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,19 +100,12 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
:attr:`ssl.SSLContext.check_hostname` and *Server Name Indication* (see
:data:`ssl.HAS_SNI`).

.. deprecated:: 3.6

*keyfile* and *certfile* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

.. versionchanged:: 3.9
If the *timeout* parameter is set to be zero, it will raise a
:class:`ValueError` to prevent the creation of a non-blocking socket

.. versionchanged:: 3.12
The deprecated *keyfile* and *certfile* parameters have been removed.
The deprecated *keyfile* and *certfile* parameters have been removed.

.. class:: LMTP(host='', port=LMTP_PORT, local_hostname=None, \
source_address=None[, timeout])
Expand Down Expand Up @@ -407,15 +400,8 @@ An :class:`SMTP` instance has the following methods:
If there has been no previous ``EHLO`` or ``HELO`` command this session,
this method tries ESMTP ``EHLO`` first.

.. deprecated:: 3.6

*keyfile* and *certfile* are deprecated in favor of *context*.
Please use :meth:`ssl.SSLContext.load_cert_chain` instead, or let
:func:`ssl.create_default_context` select the system's trusted CA
certificates for you.

.. versionchanged:: 3.12
The deprecated *keyfile* and *certfile* parameters have been removed.
The deprecated *keyfile* and *certfile* parameters have been removed.

:exc:`SMTPHeloError`
The server didn't reply properly to the ``HELO`` greeting.
Expand Down

0 comments on commit ffe6970

Please sign in to comment.