pathlib ABCs: prune PathBase interface #127381

barneygale · 2024-11-29T01:54:37Z

It's time to make some difficult decisions about which methods deserve to stay in the pathlib._abc.PathBase interface, and which ought to be made pathlib.Path-only. Guidelines:

Compare to zipfile.Path and os.DirEntry; don't evict shared methods.
Include abstract methods only for the most basic functionality common to all virtual filesystems
Include concrete methods only when they combine abstract methods to produce widely useful functionality

Linked PRs

The text was updated successfully, but these errors were encountered:

Remove the `PathBase.lstat()` method, which is a trivial variation of `stat()`. No user-facing changes because the pathlib ABCs are still private.

These classmethods presume that the user has retained the original `__init__()` signature, which may not be the case. Also, many virtual filesystems don't provide current or home directories.

Remove the `PathBase.lstat()` method, which is a trivial variation of `stat()`. No user-facing changes because the pathlib ABCs are still private.

…ython#127427) These classmethods presume that the user has retained the original `__init__()` signature, which may not be the case. Also, many virtual filesystems don't provide current or home directories.

…e()` These methods are obviated by `PathBase.move()`, which can move directories and supports any `PathBase` object as a target.

…127658) These methods are obviated by `PathBase.move()`, which can move directories and supports any `PathBase` object as a target.

…ute()` Remove our implementation of POSIX path resolution in `PathBase.resolve()`. This functionality is rather fragile and isn't necessary in most cases. It depends on `PathBase.stat()`, which we're looking to remove. Also remove `PathBase.absolute()`. Many legitimate virtual filesystems lack the notion of a 'current directory', so it's wrong to include in the basic interface.

… `is_*()` Remove `PathBase.samefile()`, which is fairly specific to the local FS, and relies on `stat()`, which we're aiming to remove from `PathBase`. Also remove `PathBase.is_mount()`, `is_junction()`, `is_block_device()`, `is_char_device()`, `is_fifo()` and `is_socket()`. These rely on POSIX file type numbers that we're aiming to remove from the `PathBase` API.

…#127707) Remove our implementation of POSIX path resolution in `PathBase.resolve()`. This functionality is rather fragile and isn't necessary in most cases. It depends on `PathBase.stat()`, which we're looking to remove. Also remove `PathBase.absolute()`. Many legitimate virtual filesystems lack the notion of a 'current directory', so it's wrong to include in the basic interface.

…ethods Remove the following methods from `pathlib._abc.PathBase`: - `expanduser()` - `hardlink_to()` - `touch()` - `chmod()` - `lchmod()` - `owner()` - `group()` - `from_uri()` - `as_uri()` These operations aren't regularly supported in virtual filesystems, so they don't win a place in the `PathBase` interface. (Some of them probably don't deserve a place in `Path` :P.) They're quasi-abstract (except `lchmod()`), and they're not called by other `PathBase` methods.

Virtual filesystems don't always make a distinction between deleting files and empty directories, and sometimes support deleting non-empty directories in a single operation. Here we remove `PathBase.unlink()` and `rmdir()`, leaving `_delete()` as the sole deletion method, now made abstract. I hope to drop the underscore prefix later on.

…27736) Virtual filesystems don't always make a distinction between deleting files and empty directories, and sometimes support deleting non-empty directories in a single operation. Here we remove `PathBase.unlink()` and `rmdir()`, leaving `_delete()` as the sole deletion method, now made abstract. I hope to drop the underscore prefix later on.

Remove the `PathBase.stat()` method. Its use of the `os.stat_result` API, with its 10 mandatory fields and low-level types, makes it a poor fit for virtual filesystems. We'll look to add a `PathBase.info` attribute later - see pythonGH-125413.

Remove the `PathBase.stat()` method. Its use of the `os.stat_result` API, with its 10 mandatory fields and low-level types, makes it an awkward fit for virtual filesystems. We'll look to add a `PathBase.info` attribute later - see GH-125413.

) Remove `PurePathBase.relative_to()` and `is_relative_to()` because they don't account for *other* being an entirely different kind of path, and they can't use `__eq__()` because it's not on the `PurePathBase` interface. Remove `PurePathBase.drive`, `root`, `is_absolute()` and `as_posix()`. These are all too specific to local filesystems.

…o()` These methods combine `_delete()` and `copy()`, but `_delete()` isn't part of the public interface, and it's unlikely to be added until the pathlib ABCs are made official, or perhaps even later.

…128337) These methods combine `_delete()` and `copy()`, but `_delete()` isn't part of the public interface, and it's unlikely to be added until the pathlib ABCs are made official, or perhaps even later.

barneygale · 2025-01-04T12:58:00Z

Pruning is done! There are a few more changes planned:

Rename PurePathBase to JoinablePath
Split PathBase into ReadablePath and WritablePath
Add PathBase.status (see Expose os.DirEntry objects from pathlib #125413)
Subclass abc.ABC
Make JoinablePath.parser abstract
Figure out what to do with open()

…o()` (python#128337) These methods combine `_delete()` and `copy()`, but `_delete()` isn't part of the public interface, and it's unlikely to be added until the pathlib ABCs are made official, or perhaps even later.

Remove the `PathBase.lstat()` method, which is a trivial variation of `stat()`. No user-facing changes because the pathlib ABCs are still private.

…ython#127427) These classmethods presume that the user has retained the original `__init__()` signature, which may not be the case. Also, many virtual filesystems don't provide current or home directories.

…e()` (python#127658) These methods are obviated by `PathBase.move()`, which can move directories and supports any `PathBase` object as a target.

…ute()` (python#127707) Remove our implementation of POSIX path resolution in `PathBase.resolve()`. This functionality is rather fragile and isn't necessary in most cases. It depends on `PathBase.stat()`, which we're looking to remove. Also remove `PathBase.absolute()`. Many legitimate virtual filesystems lack the notion of a 'current directory', so it's wrong to include in the basic interface.

…)` (python#127736) Virtual filesystems don't always make a distinction between deleting files and empty directories, and sometimes support deleting non-empty directories in a single operation. Here we remove `PathBase.unlink()` and `rmdir()`, leaving `_delete()` as the sole deletion method, now made abstract. I hope to drop the underscore prefix later on.

… `is_*()` (python#127709) Remove `PathBase.samefile()`, which is fairly specific to the local FS, and relies on `stat()`, which we're aiming to remove from `PathBase`. Also remove `PathBase.is_mount()`, `is_junction()`, `is_block_device()`, `is_char_device()`, `is_fifo()` and `is_socket()`. These rely on POSIX file type numbers that we're aiming to remove from the `PathBase` API.

…ethods (python#127714) Remove the following methods from `pathlib._abc.PathBase`: - `expanduser()` - `hardlink_to()` - `touch()` - `chmod()` - `lchmod()` - `owner()` - `group()` - `from_uri()` - `as_uri()` These operations aren't regularly supported in virtual filesystems, so they don't win a place in the `PathBase` interface. (Some of them probably don't deserve a place in `Path` :P.) They're quasi-abstract (except `lchmod()`), and they're not called by other `PathBase` methods.

Remove the `PathBase.stat()` method. Its use of the `os.stat_result` API, with its 10 mandatory fields and low-level types, makes it an awkward fit for virtual filesystems. We'll look to add a `PathBase.info` attribute later - see pythonGH-125413.

…python#127853) Remove `PurePathBase.relative_to()` and `is_relative_to()` because they don't account for *other* being an entirely different kind of path, and they can't use `__eq__()` because it's not on the `PurePathBase` interface. Remove `PurePathBase.drive`, `root`, `is_absolute()` and `as_posix()`. These are all too specific to local filesystems.

…o()` (python#128337) These methods combine `_delete()` and `copy()`, but `_delete()` isn't part of the public interface, and it's unlikely to be added until the pathlib ABCs are made official, or perhaps even later.

Remove the `PathBase.lstat()` method, which is a trivial variation of `stat()`. No user-facing changes because the pathlib ABCs are still private.

…ython#127427) These classmethods presume that the user has retained the original `__init__()` signature, which may not be the case. Also, many virtual filesystems don't provide current or home directories.

Unlike `ReadablePath.[r]glob()` and `JoinablePath.full_match()`, the `JoinablePath.match()` method doesn't support the recursive wildcard `**`, and matches from the right when a fully relative pattern is given. These quirks means its probably unsuitable for inclusion in the pathlib ABCs, especially given `full_match()` handles the same use case.

barneygale · 2025-01-21T19:38:46Z

Re-opening to remove JoinablePath.match()

barneygale added topic-pathlib type-feature A feature request or enhancement stdlib Python modules in the Lib dir and removed type-feature A feature request or enhancement labels Nov 29, 2024

bedevere-app bot mentioned this issue Nov 29, 2024

GH-127381: pathlib ABCs: remove PathBase.lstat() #127382

Merged

barneygale added a commit to barneygale/cpython that referenced this issue Nov 29, 2024

Merge branch 'main' into pythongh-127381-lstat

06356c0

barneygale added a commit that referenced this issue Nov 29, 2024

GH-127381: pathlib ABCs: remove PathBase.lstat() (#127382)

38264a0

Remove the `PathBase.lstat()` method, which is a trivial variation of `stat()`. No user-facing changes because the pathlib ABCs are still private.

bedevere-app bot mentioned this issue Nov 29, 2024

GH-127381: pathlib ABCs: remove PathBase.cwd() and home() #127427

Merged

github-actions bot mentioned this issue Dec 1, 2024

Monthly issue metrics report hugovk/test#88

Closed

bedevere-app bot mentioned this issue Dec 5, 2024

GH-127381: pathlib ABCs: remove PathBase.rename() and replace() #127658

Merged

barneygale added a commit that referenced this issue Dec 6, 2024

GH-127381: pathlib ABCs: remove PathBase.rename() and replace() (#…

5b6635f

…127658) These methods are obviated by `PathBase.move()`, which can move directories and supports any `PathBase` object as a target.

bedevere-app bot mentioned this issue Dec 6, 2024

GH-127381: pathlib ABCs: remove PathBase.resolve() and absolute() #127707

Merged

bedevere-app bot mentioned this issue Dec 6, 2024

GH-127381: pathlib ABCs: remove PathBase.samefile() and rarer is_*() #127709

Merged

barneygale added a commit to barneygale/cpython that referenced this issue Dec 6, 2024

Merge branch 'main' into pythongh-127381-samefile

6266d5c

bedevere-app bot mentioned this issue Dec 7, 2024

GH-127381: pathlib ABCs: remove remaining uncommon PathBase methods #127714

Merged

bedevere-app bot mentioned this issue Dec 8, 2024

GH-127381: pathlib ABCs: remove PathBase.unlink() and rmdir() #127736

Merged

barneygale added a commit to barneygale/cpython that referenced this issue Dec 8, 2024

Merge branch 'main' into pythongh-127381-samefile

12aaf67

barneygale added a commit to barneygale/cpython that referenced this issue Dec 8, 2024

Merge branch 'main' into pythongh-127381-dregs

4b71917

barneygale added a commit to barneygale/cpython that referenced this issue Dec 22, 2024

Merge branch 'main' into pythongh-127381-purepathbase

43f51a4

bedevere-app bot mentioned this issue Dec 29, 2024

GH-127381: pathlib ABCs: remove PathBase.stat() #128334

Merged

barneygale added a commit to barneygale/cpython that referenced this issue Dec 29, 2024

Merge branch 'main' into pythongh-127381-purepathbase

5986db7

bedevere-app bot mentioned this issue Dec 29, 2024

GH-127381: pathlib ABCs: remove PathBase.move() and move_into() #128337

Merged

barneygale closed this as completed Jan 4, 2025

bedevere-app bot mentioned this issue Jan 21, 2025

GH-127381: pathlib ABCs: remove JoinablePath.match() #129147

Open

barneygale reopened this Jan 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pathlib ABCs: prune PathBase interface #127381

pathlib ABCs: prune PathBase interface #127381

barneygale commented Nov 29, 2024 •

edited by bedevere-app bot

Loading

barneygale commented Jan 4, 2025

barneygale commented Jan 21, 2025 •

edited

Loading

pathlib ABCs: prune PathBase interface #127381

pathlib ABCs: prune PathBase interface #127381

Comments

barneygale commented Nov 29, 2024 • edited by bedevere-app bot Loading

Linked PRs

barneygale commented Jan 4, 2025

barneygale commented Jan 21, 2025 • edited Loading

barneygale commented Nov 29, 2024 •

edited by bedevere-app bot

Loading

barneygale commented Jan 21, 2025 •

edited

Loading