FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-94199: Remove ssl.wrap_socket() documentation by vstinner · Pull Request #99023 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-94199: Remove ssl.wrap_socket() documentation - #99023

Merged
vstinner merged 5 commits into
python:mainfrom
vstinner:ssl_doc
Nov 3, 2022
ConversationCommits (5)ChecksFiles changed
Merged

gh-94199: Remove ssl.wrap_socket() documentation#99023
vstinner merged 5 commits into
python:mainfrom
vstinner:ssl_doc

Conversation

vstinner commented Nov 2, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

The function has been removed. In the ssl documentation, replace references to the ssl.wrap_socket() function with references to the ssl.SSLContext.wrap_socket() method.

gh-94199: Remove ssl.wrap_socket() documentation
5e11f40 
The function has been removed. In the ssl documentation, replace
references to the ssl.wrap_socket() function with references to the
ssl.SSLContext.wrap_socket() method.
bedevere-bot mentioned this pull request Nov 2, 2022
Closed
bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Nov 2, 2022

vstinner commented Nov 2, 2022

Copy link
Copy Markdown
Member Author

cc @illia-v

illia-v suggested changes Nov 2, 2022
View reviewed changes

illia-v 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for updating the doc!

Some arguments of ssl.wrap_socket are no longer present in SSLContext.wrap_socket.

Comment thread Doc/library/ssl.rst Outdated
Comment thread Doc/library/ssl.rst Outdated

vstinner commented Nov 2, 2022

Copy link
Copy Markdown
Member Author

@illia-v: I updated my PR, would you mind to review it? I removed references to non-existing parameters.

I made it clear the wrap_socket() is now the only way to create SSL socket objects, as already stated in the SSLSocket documentation: https://docs.python.org/dev/library/ssl.html#ssl.SSLSocket

Instances of SSLSocket must be created using the SSLContext.wrap_socket() method.

illia-v suggested changes Nov 3, 2022
View reviewed changes
Comment thread Doc/library/ssl.rst Outdated
Comment thread Doc/library/ssl.rst Outdated
Comment on lines +2053 to +2054
case, only the ``certfile`` parameter to :meth:`SSLContext.load_cert_chain`
and :func:`wrap_socket` needs to be passed. If the private key is stored
and :meth:`SSLContext.wrap_socket` needs to be passed. If the private key is stored

illia-v Nov 3, 2022

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

SSLContext.wrap_socket has no certfile parameter

illia-v reviewed Nov 3, 2022
View reviewed changes
Comment thread Doc/library/ssl.rst Outdated
Comment thread Doc/library/ssl.rst Outdated
vstinner and others added 2 commits November 3, 2022 12:33
Update Doc/library/ssl.rst
e0b7e86 
Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
Update Doc/library/ssl.rst
ce7a34a 
Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
vstinner merged commit cff1c20 into python:main Nov 3, 2022
vstinner deleted the ssl_doc branch November 3, 2022 12:33

vstinner commented Nov 3, 2022

Copy link
Copy Markdown
Member Author

Thanks @illia-v, it was more complicated than expected. Not just a simple text replace before/after ;-)

jiridanek mentioned this pull request Jan 2, 2024
Closed
AA-Turner mentioned this pull request Jan 12, 2024
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
illia-v illia-v approved these changes
Reviewers whose approvals may not affect merge requirements

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.

3 participants

Back | FazBrowse Home | New Git URL