Skip to content

gh-150228: Improve the PEP 829 batch processing APIs#150542

Open
warsaw wants to merge 6 commits into
python:mainfrom
warsaw:gh150228
Open

gh-150228: Improve the PEP 829 batch processing APIs#150542
warsaw wants to merge 6 commits into
python:mainfrom
warsaw:gh150228

Conversation

@warsaw
Copy link
Copy Markdown
Member

@warsaw warsaw commented May 28, 2026

As previously discussed with @ncoghlan and approved for 3.15b2 by @hugovk, this exposes the batch processing APIs for addsitedir() and friends. We remove the defer_processing_start_files flag which required some implicit module global state, and promote StartupState to the public documented API. This removes the need for module global implicit state and allows callers to control when accumulated .start and .pth file state is processed if they want.

This also fixes the interleaving regression identified by @ncoghlan in the same issue. Now, .pth file sys.path extensions are added to sys.path after the sitedir that the .pth file is found in, restoring the legacy behavior.

Along the way, I've made a lot of improvements to function docstrings, site.rst documentation, and comments in the code explaining what's going on.

As previously discussed with @ncoghlan and approved for 3.15b2 by @hugovk,
this exposes the batch processing APIs for addsitedir() and friends.  We
remove the `defer_processing_start_files` flag which required some implicit
module global state, and promote StartupState to the public documented API.
This removes the need for module global implicit state and allows callers to
control when accumulated .start and .pth file state is processed if they want.

This also fixes the interleaving regression identified by @ncoghlan in the
same issue.  Now, .pth file sys.path extensions are added to sys.path after
the sitedir that the .pth file is found in, restoring the legacy behavior.

Along the way, I've made a lot of improvements to function docstrings,
site.rst documentation, and comments in the code explaining what's going on.
@warsaw warsaw self-assigned this May 28, 2026
@warsaw warsaw requested a review from FFY00 as a code owner May 28, 2026 01:35
@warsaw warsaw added the 3.15 pre-release feature fixes, bugs and security fixes label May 28, 2026
@warsaw warsaw requested a review from AA-Turner as a code owner May 28, 2026 01:35
@warsaw warsaw added 3.16 new features, bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels May 28, 2026
@warsaw warsaw requested review from hugovk and ncoghlan May 28, 2026 01:35
@read-the-docs-community
Copy link
Copy Markdown

read-the-docs-community Bot commented May 28, 2026

Documentation build overview

📚 cpython-previews | 🛠️ Build #32880754 | 📁 Comparing e2407d2 against main (9242700)

  🔍 Preview build  

3 files changed
± library/site.html
± whatsnew/3.15.html
± whatsnew/changelog.html

Comment thread Misc/NEWS.d/next/Library/2026-05-27-11-18-36.gh-issue-150228.pNPiO-.rst Outdated
Comment thread Misc/NEWS.d/next/Library/2026-05-27-11-18-36.gh-issue-150228.pNPiO-.rst Outdated
warsaw and others added 2 commits May 27, 2026 22:51
…NPiO-.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
…NPiO-.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@warsaw warsaw requested a review from hugovk May 28, 2026 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.15 pre-release feature fixes, bugs and security fixes 3.16 new features, bugs and security fixes awaiting core review needs backport to 3.15 pre-release feature fixes, bugs and security fixes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants