gh-100228: Document the os.fork threads DeprecationWarning. #109767

gpshead · 2023-09-23T00:18:38Z

Better document the os.fork warning to explain questions such as those raised in https://discuss.python.org/t/concerns-regarding-deprecation-of-fork-with-alive-threads/33555.

📚 Documentation preview 📚: https://cpython-previews--109767.org.readthedocs.build/

Issue: raise a Warning when os.fork() is called and the process has multiple threads #100228

Doc/whatsnew/3.12.rst

Doc/library/concurrent.futures.rst

Doc/library/multiprocessing.rst

Doc/library/os.rst

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

(thanks AA-Turner!)

hugovk

Looks good, couple of suggestions.

Doc/library/concurrent.futures.rst

Doc/library/os.rst

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

AA-Turner

Thanks!

A

miss-islington · 2023-09-23T05:04:24Z

Thanks @gpshead for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

…thonGH-109767) Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs. Many reviews and doc cleanup edits by Adam & Hugo. 🥳 (cherry picked from commit 5e7ea95) Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

bedevere-app · 2023-09-23T05:04:37Z

GH-109773 is a backport of this pull request to the 3.12 branch.

malemburg

Thanks for adding these clarifications and warnings.

Apart from the change in the "What's new" I think this is good to go.

malemburg · 2023-09-23T08:38:02Z

Doc/whatsnew/3.12.rst

+  We added the warning to to raise awareness as issues encounted by code doing
+  this are becoming more frequent. See the :func:`os.fork` documentation for
+  more details.
+


I would copy the paragraph from the os.fork() docs here as well, to make it easier for people to find the reasoning behind this:

See `this discussion on fork being incompatible with threads <https://discuss.python.org/t/33555>`_ for technical details of why we're surfacing this longstanding platform compatibility problem to developers.

Thanks, I included that (edited) over in the 3.12 backport #109773. I'll make the same edit in main after that is merged.

Include the link to the discussion in the what's new text per @malemberg's comment on. python#109767 (i'll follow up with a PR to main to include this edit there as well)

…H-109767) (#109773) * gh-100228: Document the os.fork threads DeprecationWarning. (GH-109767) Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs. Many reviews and doc cleanup edits by Adam & Hugo. 🥳 (cherry picked from commit 5e7ea95) Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * link to the discussion thread from whatsnew Include the link to the discussion in the what's new text per @malemberg's comment on. #109767 (i'll follow up with a PR to main to include this edit there as well) --------- Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

A post main merge edit to the text was added in the 3.12 backport PR. e38d710 This includes that in main. It's a minor edit over #109767 to resolve the comment there.

…H-109767) (#109773) * gh-100228: Document the os.fork threads DeprecationWarning. (GH-109767) Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs. Many reviews and doc cleanup edits by Adam & Hugo. 🥳 (cherry picked from commit 5e7ea95d9d5c3b80a67ffbeebd76ce4fc327dd8e) Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * link to the discussion thread from whatsnew Include the link to the discussion in the what's new text per @malemberg's comment on. python/cpython#109767 (i'll follow up with a PR to main to include this edit there as well) --------- Co-authored-by: Gregory P. Smith <greg@krypto.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> CPython-sync-commit: 62df559448362f9a4291661d64aee30474dec025

…thon#109767) Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs. Many reviews and doc cleanup edits by Adam & Hugo. 🥳 Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

…09807) A post main merge edit to the text was added in the 3.12 backport PR. python@e38d710 This includes that in main. It's a minor edit over python#109767 to resolve the comment there.

…thon#109767) Document the `os.fork` posix threads detected `DeprecationWarning` in 3.12 What's New, os, multiprocessing, and concurrent.futures docs. Many reviews and doc cleanup edits by Adam & Hugo. 🥳 Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

…09807) A post main merge edit to the text was added in the 3.12 backport PR. python@e38d710 This includes that in main. It's a minor edit over python#109767 to resolve the comment there.

Document the os.fork threads DeprecationWarning.

c2c36c0

gpshead added docs Documentation in the Doc dir skip news needs backport to 3.12 bug and security fixes labels Sep 23, 2023

gpshead changed the title ~~Document the os.fork threads DeprecationWarning.~~ gh-100228: Document the os.fork threads DeprecationWarning. Sep 23, 2023

gpshead marked this pull request as ready for review September 23, 2023 00:20

bedevere-app bot mentioned this pull request Sep 12, 2023

raise a Warning when os.fork() is called and the process has multiple threads #100228

Closed

bedevere-app bot added the awaiting review label Sep 23, 2023

gpshead requested a review from hugovk September 23, 2023 00:20

AA-Turner reviewed Sep 23, 2023

View reviewed changes

Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved

AA-Turner reviewed Sep 23, 2023

View reviewed changes

gpshead and others added 6 commits September 22, 2023 21:09

Update Doc/library/concurrent.futures.rst

d38b056

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/library/concurrent.futures.rst

d594072

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/library/multiprocessing.rst

c8f7a73

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/library/os.rst

227c883

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/library/os.rst

49fa636

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Move to the proper Deprecated section.

126ed5e

(thanks AA-Turner!)

hugovk approved these changes Sep 23, 2023

View reviewed changes

Doc/library/concurrent.futures.rst Outdated Show resolved Hide resolved

Doc/library/os.rst Outdated Show resolved Hide resolved

bedevere-app bot added awaiting core review and removed awaiting review labels Sep 23, 2023

gpshead and others added 2 commits September 22, 2023 21:53

Update Doc/library/concurrent.futures.rst

f47b99c

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

Update Doc/library/os.rst

5960e72

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

AA-Turner approved these changes Sep 23, 2023

View reviewed changes

gpshead enabled auto-merge (squash) September 23, 2023 05:03

gpshead merged commit 5e7ea95 into python:main Sep 23, 2023
21 checks passed

bedevere-app bot removed the awaiting core review label Sep 23, 2023

gpshead deleted the docs/fork_threads_warning branch September 23, 2023 05:04

bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 23, 2023

malemburg reviewed Sep 23, 2023

View reviewed changes

gpshead mentioned this pull request Sep 24, 2023

Sync whatsnew with the edit I made in the 3.12 backport PR. #109807

Merged

This was referenced Aug 29, 2024

Deprecation warning for os.fork on Python 3.12 gevent/gevent#2052

Open

Deprecation warning for os.fork on Python 3.12 benoitc/gunicorn#3289

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-100228: Document the os.fork threads DeprecationWarning. #109767

gh-100228: Document the os.fork threads DeprecationWarning. #109767

gpshead commented Sep 23, 2023 •

edited by bedevere-app bot

Loading

hugovk left a comment

AA-Turner left a comment

miss-islington commented Sep 23, 2023

bedevere-app bot commented Sep 23, 2023

malemburg left a comment

malemburg Sep 23, 2023

gpshead Sep 23, 2023

gh-100228: Document the os.fork threads DeprecationWarning. #109767

gh-100228: Document the os.fork threads DeprecationWarning. #109767

Conversation

gpshead commented Sep 23, 2023 • edited by bedevere-app bot Loading

hugovk left a comment

Choose a reason for hiding this comment

AA-Turner left a comment

Choose a reason for hiding this comment

miss-islington commented Sep 23, 2023

bedevere-app bot commented Sep 23, 2023

malemburg left a comment

Choose a reason for hiding this comment

malemburg Sep 23, 2023

Choose a reason for hiding this comment

gpshead Sep 23, 2023

Choose a reason for hiding this comment

gpshead commented Sep 23, 2023 •

edited by bedevere-app bot

Loading