Skip to content

gh-94172: Update docs for params removed in 3.12 #100431

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
hauntsaninja merged 6 commits into from
Dec 28, 2022
Merged

gh-94172: Update docs for params removed in 3.12 #100431

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
70453c6
Fix parameter names for each module
hugovk Dec 22, 2022
770bc01
Update docs for params removed in 3.12
hugovk Dec 22, 2022
d288832
Update docs for params removed in 3.12
hugovk Dec 23, 2022
879e651
Update some formatting
hugovk Dec 23, 2022
6938e1f
Apply suggestions from code review
hugovk Dec 27, 2022
25421ff
Update keyword-only
hugovk Dec 27, 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
Prev Previous commit
Next Next commit
Update docs for params removed in 3.12
  • Loading branch information
@hugovk
hugovk committed Dec 23, 2022
commit d2888326d7300c6067be5e7fba87b925303930c5
3 changes: 2 additions & 1 deletion Doc/library/ftplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ The module defines the following items:
The *encoding* parameter was added, and the default was changed from
Latin-1 to UTF-8 to follow :rfc:`2640`.

.. class:: FTP_TLS(host='', user='', passwd='', acct='', context=None, timeout=None, source_address=None, *, encoding='utf-8')
.. class:: FTP_TLS(host='', user='', passwd='', acct='', *, context=None,
timeout=None, source_address=None, *, encoding='utf-8')
Comment thread
hugovk marked this conversation as resolved.
Outdated

A :class:`FTP` subclass which adds TLS support to FTP as described in
:rfc:`4217`.
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/http.client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ HTTPS protocols. It is normally not used directly --- the module

.. seealso::

The `Requests package <https://requests.readthedocs.io/en/master/>`_
The `Requests package <https://requests.readthedocs.io/en/latest/>`_
is recommended for a higher-level HTTP client interface.

.. note::
Expand All @@ -33,7 +33,7 @@ HTTPS protocols. It is normally not used directly --- the module
The module provides the following classes:


.. class:: HTTPConnection(host, port=None[, timeout], source_address=None, \
.. class:: HTTPConnection(host, port=None, *[, timeout], source_address=None, \
Comment thread
hugovk marked this conversation as resolved.
Outdated
blocksize=8192)

An :class:`HTTPConnection` instance represents one transaction with an HTTP
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/imaplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Three exceptions are defined as attributes of the :class:`IMAP4` class:
There's also a subclass for secure connections:


.. class:: IMAP4_SSL(host='', port=IMAP4_SSL_PORT, ssl_context=None, \
.. class:: IMAP4_SSL(host='', port=IMAP4_SSL_PORT, *, ssl_context=None, \
timeout=None)

This is a subclass derived from :class:`IMAP4` that connects over an SSL
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/poplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The :mod:`poplib` module provides two classes:
If the *timeout* parameter is set to be zero, it will raise a
:class:`ValueError` to prevent the creation of a non-blocking socket.

.. class:: POP3_SSL(host, port=POP3_SSL_PORT, timeout=None, context=None)
.. class:: POP3_SSL(host, port=POP3_SSL_PORT, *, timeout=None, context=None)

This is a subclass of :class:`POP3` that connects to the server over an SSL
encrypted socket. If *port* is not specified, 995, the standard POP3-over-SSL
Expand Down
7 changes: 5 additions & 2 deletions Doc/library/smtplib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
If the *timeout* parameter is set to be zero, it will raise a
:class:`ValueError` to prevent the creation of a non-blocking socket

.. class:: SMTP_SSL(host='', port=0, local_hostname=None [, timeout], \
.. class:: SMTP_SSL(host='', port=0, local_hostname=None, * [, timeout], \
context=None, source_address=None)

An :class:`SMTP_SSL` instance behaves exactly the same as instances of
Expand Down Expand Up @@ -391,7 +391,7 @@ An :class:`SMTP` instance has the following methods:
.. versionadded:: 3.5


.. method:: SMTP.starttls(keyfile=None, certfile=None, context=None)
.. method:: SMTP.starttls(*, context=None)

Put the SMTP connection in TLS (Transport Layer Security) mode. All SMTP
commands that follow will be encrypted. You should then call :meth:`ehlo`
Expand All @@ -414,6 +414,9 @@ An :class:`SMTP` instance has the following methods:
: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.

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

Expand Down