Repository navigation
Expose os.DirEntry objects from pathlib #125413
Description
Feature or enhancement
I propose we add a new Path.status attribute that stores an os.DirEntry object in paths yielded from Path.iterdir(), or a pathlib-specific type with a similar interface in other paths.
This would:
- Allow users to access to the cached
os.DirEntryafter callingPath.iterdir(), which is useful for efficiently determining files' types and often doesn't involve a system call. - Allow users to switch on the type of any path without repeatedly making system calls, or having to resort to
S_ISREG(st.st_mode)and other holy incantations. - In the pathlib ABCs, allows us to entirely banish
PathBase.stat()and thestat_resultinterface, which is too low-level and local filesystem-specific
See discussion: https://discuss.python.org/t/is-there-a-pathlib-equivalent-of-os-scandir/46626
Linked PRs
- GH-125413: Add
pathlib.Path.dir_entryattribute #125419 - GH-125413:
pathlib.Path.copy(): get common metadata keys only once #125990 - GH-125413: Add
pathlib.Path.scandir()method #126060 - GH-125413: pathlib ABCs: use
scandir()to speed upglob()#126261 - GH-125413: pathlib ABCs: use
scandir()to speed upwalk()#126262 - GH-125413: pathlib: use
scandir()to speed upcopy()#126263 - GH-125413: Revert addition of
pathlib.Path.scandir()method #127377 - GH-125413: Add
pathlib.Path.infoattribute #127730 - GH-125413: Move
pathlib.Path.copy()implementation alongsidePath.info#129856 - GH-125413: Add private metadata methods to
pathlib.Path.info#129897 - GH-125413: Add private
pathlib.Pathmethod to write metadata #130238 - GH-125413: pathlib ABCs: use caching
path.info.exists()when globbing #130422 - GH-125413: Fix stale metadata from
pathlib.Path.copy()andmove()#130424
Activity
pythonGH-125413: Add `pathlib.Path.dir_entry` attribute
pythonGH-125413: Add `pathlib.Path.dir_entry` attribute
ncoghlan commentedon Oct 23, 2024
I put this feedback on the PR, but it's probably better placed here: while I like the general idea, I don't think this specific API is the right way to do it.
dir_entrypotentially beingNonebased on how the instance was created is inconvenientdir_entryexisting onPurePathobjects is awkwardI think we can eliminate both of those bits of awkwardness:
os.DirEntryobjects that allows one to be created from arbitraryos.PathLikeobjectsPurePathprivate rather than public (presumably as_dir_entry)PathBase.dir_entryas a read-only property that returns the cached entry if it is already set, otherwise it uses the new constructor API to create a cachedDirEntryinstance for itselfIf it's impractical to add
os.DirEntry.from_path, then apathlib._DirEntryclass that just emulated theos.DirEntryAPI based on the real underlyingPathobject would also be finepythonGH-125413: `pathlib.Path.copy()`: get common metadata keys only…
[-]Add `pathlib.Path.dir_entry`[/-][+]Expose `os.DirEntry` objects from pathlib[/+]pythonGH-125413: Add `pathlib.Path.scandir()` method
GH-125413: Add `pathlib.Path.scandir()` method (#126060)
pythonGH-125413: pathlib ABCs: use `scandir()` to speed up `glob()`
barneygale commentedon Nov 1, 2024
To tie up the above loose ends, we went with a
Path.scandir()method in the end.pythonGH-125413: pathlib ABCs: use `scandir()` to speed up `walk()`
pythonGH-125413: pathlib: use `scandir()` to speed up `copy()`
pythonGH-125413: pathlib: use `scandir()` to speed up `copy()`
37 remaining items
GH-125413: Add `pathlib.Path.info` attribute (#127730)
pythonGH-125413: Move `pathlib.Path.copy()` implementation alongside …
GH-125413: Move `pathlib.Path.copy()` implementation alongside `Path.…
pythonGH-125413: Add private metadata methods to `pathlib.Path.info`
Merge branch 'main' into pythongh-125413-merge-copyreader
Merge branch 'main' into pythongh-125413-merge-copyreader
Merge branch 'main' into pythongh-125413-merge-copyreader
GH-125413: Add private metadata methods to `pathlib.Path.info` (#129897)
pythonGH-125413: pathlib ABCs: use caching `path.info.exists()` when …
pythonGH-125413: Fix stale metadata from `pathlib.Path.copy()` and `m…
pythonGH-125413: Fix stale metadata from `pathlib.Path.copy()` and `m…
GH-125413: pathlib ABCs: use caching `path.info.exists()` when globbi…
GH-125413: Fix stale metadata from `pathlib.Path.copy()` and `move()` (…
GH-125413: Add private `pathlib.Path` method to write metadata (#130238)