GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-94172: Update docs for params removed in 3.12 by hugovk · Pull Request #100431 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Dec 22, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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

  • https://deploy-preview-100431--python-cpython-preview.netlify.app/library/ftplib.html
  • https://deploy-preview-100431--python-cpython-preview.netlify.app/library/imaplib.html
  • https://deploy-preview-100431--python-cpython-preview.netlify.app/library/poplib.html
  • https://deploy-preview-100431--python-cpython-preview.netlify.app/library/smtplib.html
  • https://deploy-preview-100431--python-cpython-preview.netlify.app/library/http.client.html
  • Issue: Remove deprecated keyfile, certfile and check_hostname parameters, in favor of context #94172

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@hugovk
Fix parameter names for each module
70453c6
@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
Remove deprecated keyfile, certfile and check_hostname parameters, in favor of context #94172
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
gh-94172: Remove keyfile, certfile and check_hostname parameters #94173
Merged
@hugovk
Update docs for params removed in 3.12
770bc01
@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

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting changes and removed awaiting core review labels Dec 22, 2022
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
hugovk added 2 commits December 23, 2022 14:38
@hugovk
Update docs for params removed in 3.12
d288832
@hugovk
Update some formatting
879e651
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added awaiting change review and removed awaiting changes labels Dec 23, 2022
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot
bedevere-bot requested a review from hauntsaninja December 23, 2022 13:00
hauntsaninja
hauntsaninja reviewed Dec 23, 2022
View reviewed changes

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/ftplib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/http.client.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/http.client.rst Outdated

.. class:: HTTPSConnection(host, port=None, key_file=None, \
cert_file=None[, timeout], \
.. class:: HTTPSConnection(host, port=None[, timeout], \

@hauntsaninja hauntsaninja Dec 23, 2022

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Can't leave a suggestion, but this one needs to be made keyword-only

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@hugovk hugovk Dec 27, 2022

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Updated in 25421ff

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@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.
AlexWaygood reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
slateny
slateny reviewed Dec 25, 2022
View reviewed changes
Comment thread Misc/NEWS.d/3.12.0a2.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Doc/library/smtplib.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
hugovk and others added 2 commits December 27, 2022 15:03
@hugovk @hauntsaninja @slateny
Apply suggestions from code review
6938e1f 
Co-authored-by: Shantanu <[email protected]>
Co-authored-by: Stanley <[email protected]>
@hugovk @hauntsaninja
Update keyword-only
25421ff 
Co-authored-by: Shantanu <[email protected]>
@hugovk

hugovk commented Dec 27, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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):
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
hauntsaninja
hauntsaninja approved these changes Dec 28, 2022
View reviewed changes

@hauntsaninja hauntsaninja left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thank you!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting change review labels Dec 28, 2022
@hauntsaninja
hauntsaninja merged commit 9eca723 into python:main Dec 28, 2022
@bedevere-bot bedevere-bot removed the awaiting merge label 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 slateny left review comments
@hauntsaninja hauntsaninja hauntsaninja approved these changes

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@hugovk @bedevere-bot @hauntsaninja @slateny
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.