Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add method send_io, recv_io to the socket module. #72910

Closed
tokibito mannequin opened this issue Nov 17, 2016 · 13 comments
Closed

Add method send_io, recv_io to the socket module. #72910

tokibito mannequin opened this issue Nov 17, 2016 · 13 comments
Labels
3.9 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement

Comments

@tokibito
Copy link
Mannequin

tokibito mannequin commented Nov 17, 2016

BPO 28724
Nosy @vstinner, @tiran, @methane, @JulienPalard, @tokibito, @miss-islington, @nanjekyejoannah, @gousaiyang, @hauntsaninja
PRs
  • bpo-28724: Add methods send_fds, recv_fds to the socket module #12889
  • bpo-28724: Move socket.send_fds and socket.recv_fds documentation to the "Other functions" section #22608
  • [3.9] bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608) #25517
    		•
    Files
  • socket_send_io_recv_io.patch
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2021-04-22.04:35:33.652>
created_at = <Date 2016-11-17.15:05:33.604>
labels = ['type-feature', 'library', '3.9']
title = 'Add method send_io, recv_io to the socket module.'
updated_at = <Date 2021-04-22.04:35:33.651>
user = 'https://github.com/tokibito'

    bugs.python.org fields:

    activity = <Date 2021-04-22.04:35:33.651>
actor = 'methane'
assignee = 'none'
closed = True
closed_date = <Date 2021-04-22.04:35:33.652>
closer = 'methane'
components = ['Library (Lib)']
creation = <Date 2016-11-17.15:05:33.604>
creator = 'tokibito'
dependencies = []
files = ['45519']
hgrepos = []
issue_num = 28724
keywords = ['patch']
message_count = 13.0
messages = ['281041', '281065', '281089', '282348', '282415', '282488', '282508', '346379', '351986', '351988', '376132', '391573', '391575']
nosy_count = 9.0
nosy_names = ['vstinner', 'christian.heimes', 'methane', 'mdk', 'tokibito', 'miss-islington', 'nanjekyejoannah', 'gousaiyang', 'hauntsaninja']
pr_nums = ['12889', '22608', '25517']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue28724'
versions = ['Python 3.9']
    @tokibito
    Copy link
    Mannequin Author

    tokibito mannequin commented Nov 17, 2016

    This patch makes it easy to pass file descriptor in using AF_UNIX.

    Ruby language libraries have such methods.

    see slso:

    @tokibito tokibito mannequin added 3.7 (EOL) end of life stdlib Python modules in the Lib dir type-feature A feature request or enhancement labels Nov 17, 2016
    @JulienPalard
    Copy link
    Member

    Hi, thanks for your contribution!

    Documentation give examples implementation of your methods:

    and from here, some remarks:

    • Why allowing people to mix fds and file objects? I'm not a fan of this: I prefer the clarity of allowing only file descriptors. Have you seen such methods (allowing both fd and file obj) in the stdlib?
    • The documented implementation for recv_io checks for integer truncation, there may be a good reason, should'n you do the same?
    • The documented implementation allows to pass a message, shouldn't you at least allow for an optional message to be passed?

    Adding those methods may make sense if people are copying send_fds/recv_fds in their code, but I found only two copy/paste in github, so I think the best is to put your code as a module on pypi and see, from here, if it gets popular?

    You should also write a few tests, and comply to the PEP-8 (your two methods should probably be separated by a newline).

    Bests

    @methane
    Copy link
    Member

    methane commented Nov 18, 2016

    FYI, multiprocessing.reduction module has send_fds and recv_fds.

    @JulienPalard
    Copy link
    Member

    Unless somebody don't think so, I think this should go as a pypi module before going to the socket module, so this issue should probably be closed.

    @tiran
    Copy link
    Member

    tiran commented Dec 5, 2016

    Good idea! Initially I planned to add the functions and some other helpers around AF_UNIX to Python 3.6. You can directly copy the example functions from the documentation.

    https://docs.python.org/3/library/socket.html#socket.socket.sendmsg
    https://docs.python.org/3/library/socket.html#socket.socket.recvmsg

    Please keep the names send_fds() and recv_fds(), and pass the message like in the examples. Some protocols use the payload to signal the count of fds. Your patch is also lacking unit tests and documentation update.

    @tokibito
    Copy link
    Mannequin Author

    tokibito mannequin commented Dec 6, 2016

    Thanks for reviews and comments. I will work on the weekend.

    @tiran
    Copy link
    Member

    tiran commented Dec 6, 2016

    Take your time, feature freeze for 3.7 is in about 18 months from now.

    @vstinner
    Copy link
    Member

    See also bpo-37385: "test_multiprocessing fails on AMD64 FreeBSD CURRENT Shared 2.7".

    @vstinner
    Copy link
    Member

    New changeset 8d120f7 by Victor Stinner (Joannah Nanjekye) in branch 'master':
    bpo-28724: Add methods send_fds and recv_fds to the socket module (GH-12889)
    8d120f7

    @vstinner
    Copy link
    Member

    Thanks Shinya Okano for the original patch.

    Well done Joannah! Thanks for your tenacity :-) This PR has 100 comments and 27 commits which shows the complexity of the feature.

    Honestly, I'm not 100% happy with current documentation, but I chose to merge the PR anyway. Please leave this issue open until the documentation is completed to mention corner cases like partial send (similar to sock.send vs sock.sendall).

    @hauntsaninja
    Copy link
    Contributor

    I was looking at adding stubs for these to typeshed. Is it intentional that we ignore the flags and address arguments in the implementation?

    @methane
    Copy link
    Member

    methane commented Apr 22, 2021

    New changeset 660592f by Saiyang Gou in branch 'master':
    bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)
    660592f

    @miss-islington
    Copy link
    Contributor

    New changeset 87a392d by Miss Islington (bot) in branch '3.9':
    bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)
    87a392d

    @methane methane added 3.9 only security fixes and removed 3.7 (EOL) end of life labels Apr 22, 2021
    @methane methane closed this as completed Apr 22, 2021
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.9 only security fixes stdlib Python modules in the Lib dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    6 participants
    @vstinner @methane @JulienPalard @tiran @hauntsaninja @miss-islington