Skip to content

gh-142972: Document arbitrary ordering in Path.glob #143025

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.

Sign up for GitHub

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

Jump to bottom
Merged
ZeroIntensity merged 7 commits into from
Jan 11, 2026
Merged

gh-142972: Document arbitrary ordering in Path.glob #143025

ZeroIntensity merged 7 commits into from
Jan 11, 2026
+8 −0

Conversation

@johnslavik
Copy link
Member

@johnslavik johnslavik commented Dec 20, 2025 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Dec 20, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Dec 20, 2025
@bedevere-app bedevere-app bot mentioned this pull request Dec 20, 2025
Closed
AA-Turner
AA-Turner requested changes Dec 20, 2025
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I would say 'unordered' or 'no ordering guarantees'. Please also add the note to rglob().

A

@bedevere-app
Copy link

bedevere-app bot commented Dec 20, 2025

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@johnslavik
Copy link
Member Author

johnslavik commented Dec 20, 2025 •
edited
Loading

I would say 'unordered' or 'no ordering guarantees'. Please also add the note to rglob().

Thanks. Would you also like me to correct the glob module documention to use the same wording?
This is what's in glob docs rn (GH-140184):

cpython/Doc/library/glob.rst

Lines 28 to 31 in ec269e1

.. note::
The pathnames are returned in no particular order. If you need a specific
order, sort the results.

@johnslavik
Copy link
Member Author

johnslavik commented Dec 20, 2025

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Dec 20, 2025

Thanks for making the requested changes!

@AA-Turner: please review the changes made to this pull request.

@bedevere-app bedevere-app bot requested a review from AA-Turner December 20, 2025 19:48
@AA-Turner
Copy link
Member

AA-Turner commented Dec 20, 2025

Oh, fine: in that case just reuse the exact wording (ie drop 'akin' etc)

A

@johnslavik
Copy link
Member Author

johnslavik commented Dec 20, 2025

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Dec 20, 2025

Thanks for making the requested changes!

@AA-Turner: please review the changes made to this pull request.

AA-Turner
AA-Turner reviewed Dec 20, 2025
View reviewed changes
@johnslavik johnslavik requested a review from AA-Turner December 20, 2025 21:28
AA-Turner
AA-Turner approved these changes Dec 20, 2025
View reviewed changes
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks! Unless @barneygale has any comments, will merge in a few days.

A

@johnslavik
Copy link
Member Author

johnslavik commented Jan 1, 2026 •
edited
Loading

@AA-Turner I think we can merge? :)

@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 11, 2026
@ZeroIntensity ZeroIntensity merged commit 9d13ca9 into python:main Jan 11, 2026
35 of 36 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jan 11, 2026
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 11, 2026

Thanks @johnslavik for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 11, 2026
@johnslavik @miss-islington
pythongh-142972: Document arbitrary ordering in Path.glob and `Path…
99abe5f 
….rglob` (pythonGH-143025)

(cherry picked from commit 9d13ca97c1a83ed649a16fb0512b5f1c5f9ad108)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 11, 2026
@johnslavik @miss-islington
pythongh-142972: Document arbitrary ordering in Path.glob and `Path…
be7e629 
….rglob` (pythonGH-143025)

(cherry picked from commit 9d13ca97c1a83ed649a16fb0512b5f1c5f9ad108)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 11, 2026

GH-143709 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jan 11, 2026
@bedevere-app
Copy link

bedevere-app bot commented Jan 11, 2026

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 11, 2026
ZeroIntensity pushed a commit that referenced this pull request Jan 11, 2026
@miss-islington @johnslavik
[3.14] gh-142972: Document arbitrary ordering in Path.glob and `Pat…
bfc57f7 
…h.rglob` (GH-143025) (GH-143709)

gh-142972: Document arbitrary ordering in `Path.glob` and `Path.rglob` (GH-143025)
(cherry picked from commit 9d13ca9)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
ZeroIntensity pushed a commit that referenced this pull request Jan 11, 2026
@miss-islington @johnslavik
[3.13] gh-142972: Document arbitrary ordering in Path.glob and `Pat…
18eeec4 
…h.rglob` (GH-143025) (GH-143710)

gh-142972: Document arbitrary ordering in `Path.glob` and `Path.rglob` (GH-143025)
(cherry picked from commit 9d13ca9)

Co-authored-by: Bartosz Sławecki <bartosz@ilikepython.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AA-Turner AA-Turner AA-Turner approved these changes

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

@barneygale barneygale Awaiting requested review from barneygale barneygale is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@johnslavik @AA-Turner @ZeroIntensity