gh-94199: Remove ssl.wrap_socket() documentation#99023
Merged
vstinner merged 5 commits intopython:mainfrom Nov 3, 2022
vstinner:ssl_doc
Merged
gh-94199: Remove ssl.wrap_socket() documentation#99023vstinner merged 5 commits intopython:mainfrom vstinner:ssl_doc
vstinner merged 5 commits intopython:mainfrom
vstinner:ssl_doc
Conversation
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
added
awaiting core review
docs
Member
Author
|
cc @illia-v |
illia-v
suggested changes
Nov 2, 2022
Contributor
illia-v
left a comment
illia-v
left a comment
There was a problem hiding this comment.
Thanks for updating the doc!
Some arguments of ssl.wrap_socket are no longer present in SSLContext.wrap_socket.
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
|
illia-v
suggested changes
Nov 3, 2022
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 |
Contributor
There was a problem hiding this comment.
SSLContext.wrap_socket has no certfile parameter
illia-v
reviewed
Nov 3, 2022
Co-authored-by: Illia Volochii <[email protected]>
Co-authored-by: Illia Volochii <[email protected]>
illia-v
approved these changes
Nov 3, 2022
Member
Author
|
Thanks @illia-v, it was more complicated than expected. Not just a simple text replace before/after ;-) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
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.