Skip to content

gh-84559: improve What's New entry for multiprocessing start method changes - #128173

Merged
picnixz merged 9 commits into
python:mainfrom
picnixz:doc/multiprocessing/clarifications-84559
Feb 23, 2025
Merged

gh-84559: improve What's New entry for multiprocessing start method changes#128173
picnixz merged 9 commits into
python:mainfrom
picnixz:doc/multiprocessing/clarifications-84559

Conversation

@picnixz

@picnixzpicnixz commented Dec 22, 2024

Copy link
Copy Markdown
Member

This is a proposal for an improved changelog. I am tempted to add it at the very top of the file in the "Summary -- release highlights" but I don't know if @hugovk is ok or not with it.


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

@picnixz
picnixz marked this pull request as draft December 22, 2024 11:50
@picnixz
picnixz marked this pull request as ready for review December 22, 2024 11:54
@hugovk

Copy link
Copy Markdown
Member

I am tempted to add it at the very top of the file in the "Summary -- release highlights" but I don't know if @hugovk is ok or not with it.

Yeah, this sounds like a big change we want people to know about, let's add a summary up there and link down to multiprocessing part.

I expect we'll expand the summary closer to the release, compare 3.13:

https://docs.python.org/3/whatsnew/3.13.html#summary-release-highlights

cc @AA-Turner

Comment threadDoc/whatsnew/3.14.rst Outdated
@jakirkham

Copy link
Copy Markdown

Just a note, on macOS the default is spawn (as it has been for a while). However the docs also note that POSIX uses forkserver by default. Though macOS also is a POSIX platform. Should this be disambiguated somehow?

@picnixz

Copy link
Copy Markdown
MemberAuthor

Though macOS also is a POSIX platform. Should this be disambiguated somehow

Ah yes, sorry. it should have been "On POSIX platforms, except macOS, [...]" or "On platforms other than macOS and Windows". Which one would be the clearer?

@gpsheadgpshead self-assigned this Dec 24, 2024

@gpsheadgpshead left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm glad we have a full section in the multiprocessing docs to link to (hooray past us!). But to help people from a What's New standpoint given the issues people are raising about this being confusing, I think we should pick a couple different short example error messages users might see coming out of an application that needs modification to work with the new start method when using multiprocessing or concurrent.futures.

@picnixz

Copy link
Copy Markdown
MemberAuthor

I think we should pick a couple different short example error messages users might see coming out of an application that needs modification to work with the new start method when using multiprocessing or concurrent.futures.

What about improving the section in multiprocessing about the differences between fork and spawn/forkserver by adding some "common issues" examples (and we can add a link to that section in the What's New entries) and/or possible examples of how to upgrade from 'fork' to 'spawn/forkserver'?

Comment threadDoc/whatsnew/3.14.rst Outdated
@gpshead

Copy link
Copy Markdown
Member

I think we should pick a couple different short example error messages users might see coming out of an application that needs modification to work with the new start method when using multiprocessing or concurrent.futures.

What about improving the section in multiprocessing about the differences between fork and spawn/forkserver by adding some "common issues" examples (and we can add a link to that section in the What's New entries) and/or possible examples of how to upgrade from 'fork' to 'spawn/forkserver'?

Even just a sentence in What's New saying something along the lines of "if you are seeing name errors of pickling errors coming out of multiprocessing or concurrent.futures when you upgrade to 3.14, read ...link-to-section..." would help people understand. Expanding further upon that kind of thing in the multiprocessing docs as common issues would be good.

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@picnixz

Copy link
Copy Markdown
MemberAuthor

Even just a sentence in What's New saying something along the lines of "if you are seeing name errors of pickling errors coming out of multiprocessing or concurrent.futures when you upgrade to 3.14, read ...link-to-section..."

I'll have a look at what to link tomorrow and if I have the motivation, I'll do something for the mp docs.

@ngoldbaum

Copy link
Copy Markdown
Contributor

Small ping that I ended up here after a discussion about this behavior and getting this docs improvement merged would help a lot. No rush of course but just don’t want this forgotten.

@picnixz

Copy link
Copy Markdown
MemberAuthor

Oh I forgot... I will try to make it by the end of the weekend. Let's make it as the next task. Thanks for the ping !

Comment threadDoc/whatsnew/3.14.rst Outdated
@picnixz
picnixz merged commit b8c313a into python:mainFeb 23, 2025
@picnixz
picnixz deleted the doc/multiprocessing/clarifications-84559 branch February 23, 2025 09:35
brianschubert pushed a commit to brianschubert/cpython that referenced this pull request Jul 27, 2025
… start method changes (pythonGH-128173)
(cherry picked from commit b8c313a)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app

Copy link
Copy Markdown

GH-137156 is a backport of this pull request to the 3.13 branch.

gpshead added a commit that referenced this pull request Jul 28, 2025
…method changes (GH-128173) (#137156)
[3.13] gh-84559: improve What's New entry for `multiprocessing` start method changes (GH-128173)
(cherry picked from commit b8c313a)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docsDocumentation in the Doc dirskip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants

@picnixz@hugovk@jakirkham@gpshead@ngoldbaum@StanFromIreland