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.

Sign up for GitHub

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

GH-88968: Add notes about socket ownership transfers #97936

Merged
merged 2 commits into from
Oct 5, 2022
Merged

GH-88968: Add notes about socket ownership transfers #97936

merged 2 commits into from
Oct 5, 2022

Conversation

gvanrossum
Copy link
Member

@gvanrossum gvanrossum commented Oct 5, 2022 •
edited
Loading

There are four event loop methods (create_connection, create_datagram_endpoint, create_server, and connect_accepted_socket) that take an optional sock argument to specify an already-configured socket. To each, add a note that ownership of the socket (in particular, the responsibility to close it) thereby transfers to the transport or server object returned.

I also added similar notes to four stream-related top-level functions, open_connection, start_server, open_unix_connection, and start_unix_server.

@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir skip news labels Oct 5, 2022
@gvanrossum gvanrossum requested a review from CAM-Gerlach October 5, 2022 22:29
CAM-Gerlach
CAM-Gerlach approved these changes Oct 5, 2022
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

I would say "to the created transport", etc., as opposed to "to the transport created" as I think it reads more clearly and idiomatically, but maybe that's just me. Otherwise, LGTM.

@gvanrossum gvanrossum added needs backport to 3.10 only security fixes needs backport to 3.11 only security fixes labels Oct 5, 2022
@gvanrossum gvanrossum merged commit 74ea204 into python:main Oct 5, 2022
@miss-islington
Copy link
Contributor

Thanks @gvanrossum for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@gvanrossum gvanrossum deleted the socket-notes branch October 5, 2022 23:42
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 5, 2022
@bedevere-bot
Copy link

GH-97945 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 5, 2022
@bedevere-bot
Copy link

GH-97946 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
@gvanrossum @miss-islington
pythonGH-88968: Add notes about socket ownership transfers (pythonGH-…
8b28374 
…97936)

(cherry picked from commit 74ea204)

Co-authored-by: Guido van Rossum <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 5, 2022
@gvanrossum @miss-islington
pythonGH-88968: Add notes about socket ownership transfers (pythonGH-…
34ecc9a 
…97936)

(cherry picked from commit 74ea204)

Co-authored-by: Guido van Rossum <[email protected]>
miss-islington added a commit that referenced this pull request Oct 5, 2022
@miss-islington @gvanrossum
GH-88968: Add notes about socket ownership transfers (GH-97936)
0c387bf 
(cherry picked from commit 74ea204)

Co-authored-by: Guido van Rossum <[email protected]>
miss-islington added a commit that referenced this pull request Oct 5, 2022
@miss-islington @gvanrossum
GH-88968: Add notes about socket ownership transfers (GH-97936)
c80c282 
(cherry picked from commit 74ea204)

Co-authored-by: Guido van Rossum <[email protected]>
@ntc2 ntc2 mentioned this pull request Oct 6, 2022
Closed
carljm added a commit to carljm/cpython that referenced this pull request Oct 6, 2022
@carljm
Merge branch 'main' into dictwatch
7938d6f 
* main:
  pythonGH-88050: fix race in closing subprocess pipe in asyncio  (python#97951)
  pythongh-93738: Disallow pre-v3 syntax in the C domain (python#97962)
  pythongh-95986: Fix the example using match keyword (python#95989)
  pythongh-97897: Prevent os.mkfifo and os.mknod segfaults with macOS 13 SDK (pythonGH-97944)
  pythongh-94808: Cover `PyUnicode_Count` in CAPI (python#96929)
  pythongh-94808: Cover `PyObject_PyBytes` case with custom `__bytes__` method (python#96610)
  pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
  pythonGH-88968: Add notes about socket ownership transfers (python#97936)
  pythongh-96865: [Enum] fix Flag to use CONFORM boundary (pythonGH-97528)
carljm added a commit to carljm/cpython that referenced this pull request Oct 8, 2022
@carljm
Merge branch 'main' into typewatch
1af2a98 
* main: (53 commits)
  pythongh-94808: Coverage: Test that maximum indentation level is handled (python#95926)
  pythonGH-88050: fix race in closing subprocess pipe in asyncio  (python#97951)
  pythongh-93738: Disallow pre-v3 syntax in the C domain (python#97962)
  pythongh-95986: Fix the example using match keyword (python#95989)
  pythongh-97897: Prevent os.mkfifo and os.mknod segfaults with macOS 13 SDK (pythonGH-97944)
  pythongh-94808: Cover `PyUnicode_Count` in CAPI (python#96929)
  pythongh-94808: Cover `PyObject_PyBytes` case with custom `__bytes__` method (python#96610)
  pythongh-95691: Doc BufferedWriter and BufferedReader (python#95703)
  pythonGH-88968: Add notes about socket ownership transfers (python#97936)
  pythongh-96865: [Enum] fix Flag to use CONFORM boundary (pythonGH-97528)
  pythongh-65961: Raise `DeprecationWarning` when `__package__` differs from `__spec__.parent` (python#97879)
  docs(typing): add "see PEP 675" to LiteralString (python#97926)
  pythongh-97850: Remove all known instances of module_repr() (python#97876)
  I changed my surname early this year (python#96671)
  pythongh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (python#97768)
  pythongh-91539: improve performance of get_proxies_environment  (python#91566)
  build(deps): bump actions/stale from 5 to 6 (python#97701)
  pythonGH-95172 Make the same version `versionadded` oneline (python#95172)
  pythongh-88050: Fix asyncio subprocess to kill process cleanly when process is blocked (python#32073)
  pythongh-93738: Documentation C syntax (Function glob patterns -> literal markup) (python#97774)
  ...
mpage pushed a commit to mpage/cpython that referenced this pull request Oct 11, 2022
@gvanrossum @mpage
pythonGH-88968: Add notes about socket ownership transfers (python#97936
3335bbe 
)
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @gvanrossum @pablogsal
GH-88968: Add notes about socket ownership transfers (GH-97936)
bf50f10 
(cherry picked from commit 74ea204)

Co-authored-by: Guido van Rossum <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

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.
4 participants
@gvanrossum @miss-islington @bedevere-bot @CAM-Gerlach