◐ Shell
reader mode source ↗
Skip to content

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

Merged
hauntsaninja merged 6 commits into
python:mainfrom
hugovk:94172-fix-docs-key_file-cert_file-deprecation
Dec 28, 2022
Merged

gh-94172: Update docs for params removed in 3.12#100431
hauntsaninja merged 6 commits into
python:mainfrom
hugovk:94172-fix-docs-key_file-cert_file-deprecation

Conversation

@hugovk

@hugovk hugovk commented Dec 22, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

In the following modules, these parameters were removed (in #94173) after being deprecated in Python 3.6:

ftplib imaplib poplib smptblib http.client
keyfile keyfile keyfile keyfile key_file
certfile certfile certfile certfile cert_file
        check_hostname

This PR updates the documentation to remove the parameters and note their removal in 3.12.

Preview

@hugovk hugovk requested a review from a team as a code owner December 22, 2022 12:46
@bedevere-bot bedevere-bot mentioned this pull request Dec 22, 2022
Closed
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Dec 22, 2022
@hugovk hugovk mentioned this pull request Dec 22, 2022
Merged
@hugovk hugovk force-pushed the 94172-fix-docs-key_file-cert_file-deprecation branch from 6f55419 to 770bc01 Compare December 22, 2022 15:51
hauntsaninja
hauntsaninja requested changes Dec 22, 2022
View reviewed changes

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thanks for updating these! It looks like the remaining arguments were also made keyword-only.

@bedevere-bot

bedevere-bot commented Dec 22, 2022

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

@hugovk

hugovk commented Dec 23, 2022

Copy link
Copy Markdown
Member Author

I have made the requested changes; please review again.

Thanks, updated, and I'd also missed SMTP.starttls so done that one too.

I also fixed a bit of formatting whilst these files are being updated.

@bedevere-bot

bedevere-bot commented Dec 23, 2022

Copy link
Copy Markdown

Thanks for making the requested changes!

@hauntsaninja: please review the changes made to this pull request.

hauntsaninja
hauntsaninja reviewed Dec 23, 2022
View reviewed changes

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Left some comments! Good catch on SMTP.starttls (I didn't check for any other errors of omission)

@hauntsaninja

hauntsaninja commented Dec 23, 2022

Copy link
Copy Markdown
Contributor

Btw, subject for a separate discussion, but I've never really liked the [param] syntax for optional parameters, since it's not close to any valid Python syntax. In some complicated signatures it may be necessary, but for the cases in this PR I feel like timeout=... or timeout=<default> or timeout=<unspecified> would be clearer.

hugovk and others added 2 commits December 27, 2022 15:03
@hugovk @hauntsaninja @slateny
Apply suggestions from code review …
6938e1f 
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@hugovk @hauntsaninja
Update keyword-only …
25421ff 
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@hugovk

hugovk commented Dec 27, 2022 •
edited
Loading

Copy link
Copy Markdown
Member Author

Thanks both for the reviews!

Btw, subject for a separate discussion, but I've never really liked the [param] syntax for optional parameters, since it's not close to any valid Python syntax. In some complicated signatures it may be necessary, but for the cases in this PR I feel like timeout=... or timeout=<default> or timeout=<unspecified> would be clearer.

Yeah, I guess [param] is following the Unix manual page format, and we don't have an unambiguous default compared to the others:

    def __init__(self, host, port=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
                 source_address=None, blocksize=8192):

hauntsaninja
hauntsaninja approved these changes Dec 28, 2022
View reviewed changes

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hide comment

Thank you!

@hauntsaninja hauntsaninja merged commit 9eca723 into python:main Dec 28, 2022
@hugovk hugovk deleted the 94172-fix-docs-key_file-cert_file-deprecation branch December 28, 2022 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slateny slateny

@hauntsaninja hauntsaninja hauntsaninja approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@hugovk @bedevere-bot @hauntsaninja @slateny