bpo-31965: fix doc for multiprocessing.connection.Client and Listener#4304
Merged
Conversation
The authenticate argument does not exist on either Client or Listener: - https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.py#L483 (master) - https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.py#L478 (3.6) - https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.py#L478 (3.5) - https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.py#L487 (3.4) The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior. Also made some small changes to vary sentence structure.
JelleZijlstra
changed the title
Member
Author
|
I think this doesn't need a NEWS entry, but happy to add one if needed. |
JelleZijlstra
added a commit
to python/typeshed
that referenced
this pull request
Nov 7, 2017
Adds additional public members based on https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.py#L10 and https://docs.python.org/3/library/multiprocessing.html#multiprocessing-listeners-clients. I found some discrepancies in the docs while adding these stubs and filed python/cpython#4304 to address them.
pitrou
reviewed
Nov 7, 2017
| If authentication fails then | ||
| :exc:`~multiprocessing.AuthenticationError` is raised. See | ||
| :ref:`multiprocessing-auth-keys`. | ||
| If *authkey* is a byte string, digest authentication is used. |
Member
There was a problem hiding this comment.
I'd like to suggest an improvement: If *authkey* is given and not None, it should be a byte string and will be used as the secret key for an authentication challenge.
Also how about improving the multiprocessing-auth-keys section to mention the challenge is HMAC-based?
Member
Author
There was a problem hiding this comment.
I reworded both sections (for Client and Listener) to use that sentence.
Also, multiprocessing-auth-keys already mentions HMAC; I added it to the Client and Listener docs.
pitrou
approved these changes
Nov 7, 2017
Member
|
Thank you @JelleZijlstra ! |
Member
Author
|
Thanks for the quick review! |
Contributor
|
Thanks @JelleZijlstra for the PR, and @pitrou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Nov 7, 2017
…pythonGH-4304) * fix doc for multiprocessing.connection.Client The authenticate argument does not exist on either Client or Listener: - https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.pyGH-L483 (master) - https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.pyGH-L478 (3.6) - https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.pyGH-L478 (3.5) - https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.pyGH-L487 (3.4) The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior. Also made some small changes to vary sentence structure. (cherry picked from commit 1e5d54c)
|
GH-4321 is a backport of this pull request to the 3.6 branch. |
pitrou
pushed a commit
that referenced
this pull request
Nov 7, 2017
…GH-4304) (#4321) * fix doc for multiprocessing.connection.Client The authenticate argument does not exist on either Client or Listener: - https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.pyGH-L483 (master) - https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.pyGH-L478 (3.6) - https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.pyGH-L478 (3.5) - https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.pyGH-L487 (3.4) The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior. Also made some small changes to vary sentence structure. (cherry picked from commit 1e5d54c)
embray
pushed a commit
to embray/cpython
that referenced
this pull request
Nov 9, 2017
…python#4304) * fix doc for multiprocessing.connection.Client The authenticate argument does not exist on either Client or Listener: - https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.py#L483 (master) - https://github.com/python/cpython/blob/3.6/Lib/multiprocessing/connection.py#L478 (3.6) - https://github.com/python/cpython/blob/3.5/Lib/multiprocessing/connection.py#L478 (3.5) - https://github.com/python/cpython/blob/3.4/Lib/multiprocessing/connection.py#L487 (3.4) The documentation also claimed that these functions will call `current_process().auth_key`, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior. Also made some small changes to vary sentence structure.
matthiaskramm
pushed a commit
to python/typeshed
that referenced
this pull request
Nov 9, 2017
Adds additional public members based on https://github.com/python/cpython/blob/master/Lib/multiprocessing/connection.py#L10 and https://docs.python.org/3/library/multiprocessing.html#multiprocessing-listeners-clients. I found some discrepancies in the docs while adding these stubs and filed python/cpython#4304 to address them.
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
5 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 authenticate argument does not exist on either Client or Listener:
The documentation also claimed that these functions will call
current_process().auth_key, for which I could find no evidence in the code. I rewrote the documentation to reflect the actual behavior.Also made some small changes to vary sentence structure.
https://bugs.python.org/issue31965