gh-100228: Document the os.fork threads DeprecationWarning. by gpshead · Pull Request #109767 · python/cpython

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

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

(thanks AA-Turner!)

hugovk

Looks good, couple of suggestions.

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

+ 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 only 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-appBot mentioned this pull request Sep 12, 2023
raise a Warning when os.fork() is called and the process has multiple threads #100228
Closed

bedevere-appBot 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

Comment threadDoc/whatsnew/3.12.rst Outdated

AA-Turner reviewed Sep 23, 2023
View reviewed changes

Comment threadDoc/library/concurrent.futures.rst Outdated
Comment threadDoc/library/concurrent.futures.rst Outdated
Comment threadDoc/library/multiprocessing.rst Outdated
Comment threadDoc/library/os.rst Outdated
Comment threadDoc/library/os.rst

gpsheadand 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

Comment threadDoc/library/concurrent.futures.rst Outdated
Comment threadDoc/library/os.rst Outdated

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

gpsheadand 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:mainSep 23, 2023

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

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

bedevere-appBot removed the needs backport to 3.12 only 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
Closed
Deprecation warning for os.fork on Python 3.12 benoitc/gunicorn#3289
Closed

Navigation Menu

Uh oh!

Uh oh!

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

gh-100228: Document the os.fork threads DeprecationWarning.#109767
gpshead merged 9 commits into
python:mainfrom
gpshead:docs/fork_threads_warning

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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Uh oh!

Uh oh!

Uh oh!

AA-Turner left a comment

Uh oh!

miss-islington commented Sep 23, 2023

Uh oh!

bedevere-appBot commented Sep 23, 2023

Uh oh!

malemburg left a comment

Uh oh!

malemburgSep 23, 2023

Uh oh!

gpsheadSep 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Uh oh!

Conversation

gpshead commented Sep 23, 2023• edited by bedevere-app BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Sep 23, 2023

Uh oh!

bedevere-appBot commented Sep 23, 2023

Uh oh!

malemburg left a comment

Choose a reason for hiding this comment

Uh oh!

malemburgSep 23, 2023

Choose a reason for hiding this comment

Uh oh!

gpsheadSep 23, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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