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

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

picnixz
Copy link
Contributor

@picnixz picnixz commented Dec 22, 2024

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
Member

hugovk commented Dec 22, 2024

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

Doc/whatsnew/3.14.rst Outdated Show resolved Hide resolved
@jakirkham
Copy link

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
Contributor Author

picnixz commented Dec 22, 2024

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?

@gpshead gpshead self-assigned this Dec 24, 2024
Copy link
Member

@gpshead gpshead left a comment

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
Contributor Author

picnixz commented Dec 24, 2024

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'?

@gpshead
Copy link
Member

gpshead commented Dec 25, 2024

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 <[email protected]>
@picnixz
Copy link
Contributor Author

picnixz commented Dec 25, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting core review docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

5 participants