Skip to content

Conversation

@barneygale
Copy link
Contributor

@barneygalebarneygale commented Dec 7, 2024

Add pathlib.Path.info attribute, which stores an object implementing the pathlib.types.PathInfo protocol (also new). The object supports querying the file type and internally caching os.stat() results. Path objects generated by Path.iterdir() are initialised with status information from os.DirEntry objects, which is gleaned from scanning the parent directory.

The PathInfo protocol has four methods: exists(), is_dir(), is_file() and is_symlink().

When a path object is generated by `PathBase.iterdir()`, then its `_info` attribute now stores a `os.DirEntry`-like object that can be used to query the file type. This removes any need for a `_scandir()` method. Currently the `_info` attribute is private and only guaranteed to be populated in paths from `iterdir()`. Later on, I'm hoping to rename it to `info` and ensure that it's populated for all kinds of paths (this probably involves adding a `pathlib.FileInfo` class.) In the pathlib ABCs, `info` will replace `stat()` as the lowest-level abstract file status querying mechanism.
@barneygale
Copy link
ContributorAuthor

Steve - hopefully this helps address the issues you raised in #127377, but perhaps I'm only moving the problem around here.

@zooba
Copy link
Member

zooba commented Dec 9, 2024

I think this is just moving stuff around. It might end up being the right places, but let's see the Discourse discussion play out a bit first.

@barneygalebarneygale changed the title GH-125413: pathlib ABCs: replace _scandir() with _infoGH-125413: pathlib ABCs: replace _scandir() with _statusDec 9, 2024
@barneygalebarneygale changed the title GH-125413: pathlib ABCs: replace _scandir() with _statusGH-125413: Add pathlib.Path.status attributeDec 9, 2024
@barneygalebarneygale marked this pull request as draft December 9, 2024 20:58
@barneygale
Copy link
ContributorAuthor

I've revised the PR to be a more complete implementation of what I described on the forum, mostly as a demonstration/proof-of-concept at this stage.

@barneygalebarneygale added the type-feature A feature request or enhancement label Dec 9, 2024
@barneygale
Copy link
ContributorAuthor

Right, I think this is ready for review. Alyssa, sorry if this seems like deja-vu!

@barneygalebarneygale changed the title GH-125413: Add pathlib.Path.status attributeGH-125413: Add pathlib.Path.info attributeDec 21, 2024
Copy link
Member

@encukouencukou left a comment

Choose a reason for hiding this comment

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

This looks great, thank you!
I do have a nitpick:

barneygaleand others added 2 commits January 10, 2025 17:16
@barneygale
Copy link
ContributorAuthor

Thank you Petr :) I'll wait another month until I merge, in case Alyssa or Steve have feedback

@barneygale
Copy link
ContributorAuthor

I'll merge this on Friday if there's no further feedback. Cheers

@barneygalebarneygale merged commit 718ab66 into python:mainFeb 8, 2025
39 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic-pathlibtype-featureA feature request or enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@barneygale@zooba@encukou