add new pathlib base classes for 3.13

python · tungol · Oct 31, 2024 · Oct 31, 2024 · Oct 31, 2024 · Oct 31, 2024
commit 694954a393d067dc3449b58d1c97c19453d9e273
diff --git a/stdlib/VERSIONS b/stdlib/VERSIONS
@@ -213,6 +213,7 @@ os: 3.0-
 ossaudiodev: 3.0-3.12
 parser: 3.0-3.9
 pathlib: 3.4-
+pathlib._abc: 3.13-
 pdb: 3.0-
 pickle: 3.0-
 pickletools: 3.0-

diff --git a/stdlib/pathlib.pyi → stdlib/pathlib/__init__.pyi b/stdlib/pathlib.pyi → stdlib/pathlib/__init__.pyi
@@ -18,6 +18,12 @@
 from typing import IO, Any, BinaryIO, ClassVar, Literal, overload
 from typing_extensions import Self, deprecated
 
+if sys.version_info >= (3, 13):
+    from pathlib._abc import PathBase, PurePathBase
+else:
+    PathBase = object
+    PurePathBase = object
+
 if sys.version_info >= (3, 9):
     from types import GenericAlias
 
@@ -26,7 +32,7 @@
 if sys.version_info >= (3, 13):
     __all__ += ["UnsupportedOperation"]
 
-class PurePath(PathLike[str]):
+class PurePath(PathLike[str], PurePathBase):
     if sys.version_info >= (3, 13):
         parser: ClassVar[types.ModuleType]
         def full_match(self, pattern: StrPath, *, case_sensitive: bool | None = None) -> bool: ...
@@ -100,9 +106,9 @@
 class PurePosixPath(PurePath): ...
 class PureWindowsPath(PurePath): ...
 
-class Path(PurePath):
+class Path(PathBase, PurePath):
     if sys.version_info >= (3, 12):
         def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ...  # pyright: ignore[reportInconsistentConstructor]
     else:
        def __new__(cls, *args: StrPath, **kwargs: Unused) -> Self: ...

@@ -291,8 +297,8 @@
    if sys.version_info >= (3, 14):
        def rmtree(self, ignore_errors: bool = False, on_error: Callable[[OSError], object] | None = None) -> None: ...

 class PosixPath(Path, PurePosixPath): ...
 class WindowsPath(Path, PureWindowsPath): ...

 if sys.version_info >= (3, 13):
    class UnsupportedOperation(NotImplementedError): ...
diff --git a/stdlib/pathlib/_abc.pyi b/stdlib/pathlib/_abc.pyi
@@ -0,0 +1,192 @@
+import types
+from _typeshed import (
+    AnyOrLiteralStr,
+    BytesPath,
+    OpenBinaryMode,
+    OpenBinaryModeReading,
+    OpenBinaryModeUpdating,
+    OpenBinaryModeWriting,
+    OpenTextMode,
+    ReadableBuffer,
+    StrOrBytesPath,
+    StrPath,
+)
+from collections.abc import Callable, Generator, Iterator, Sequence
+from io import BufferedRandom, BufferedReader, BufferedWriter, FileIO, TextIOWrapper
+from os import PathLike, stat_result
+from typing import IO, Any, AnyStr, BinaryIO, ClassVar, Literal, overload
+from typing_extensions import LiteralString, Self
+
+__all__ = ["UnsupportedOperation"]
+
+class UnsupportedOperation(NotImplementedError): ...
+
 class ParserBase:
+    @property
+    def sep(self) -> str: ...
+    @overload
+    def join(self, path: LiteralString, *paths: LiteralString) -> LiteralString: ...
+    @overload
+    def join(self, path: StrPath, *paths: StrPath) -> str: ...
+    @overload
+    def join(self, path: BytesPath, *paths: BytesPath) -> bytes: ...
+    @overload
+    def split(self, path: PathLike[AnyStr]) -> tuple[AnyStr, AnyStr]: ...
+    @overload
+    def split(self, path: AnyOrLiteralStr) -> tuple[AnyOrLiteralStr, AnyOrLiteralStr]: ...
+    @overload
+    def splitdrive(self, path: PathLike[AnyStr]) -> tuple[AnyStr, AnyStr]: ...
+    @overload
+    def splitdrive(self, path: AnyOrLiteralStr) -> tuple[AnyOrLiteralStr, AnyOrLiteralStr]: ...
+    @overload
+    def normcase(self, path: PathLike[AnyStr]) -> AnyStr: ...
+    @overload
+    def normcase(self, path: AnyOrLiteralStr) -> AnyOrLiteralStr: ...
+    def isabs(self, path: StrOrBytesPath) -> bool: ...
+
+class PurePathBase:
+    parser: ClassVar[types.ModuleType | ParserBase]
+    def __init__(self, path: StrPath, *paths: StrPath) -> None: ...
+    def with_segments(self, *pathsegments: StrPath) -> Self: ...
+    def as_posix(self) -> str: ...
+    @property
+    def drive(self) -> str: ...
+    @property
+    def root(self) -> str: ...
+    @property
+    def anchor(self) -> str: ...
+    @property
+    def name(self) -> str: ...
+    @property
+    def suffix(self) -> str: ...
+    @property
+    def suffixes(self) -> list[str]: ...
+    @property
+    def stem(self) -> str: ...
+    def with_name(self, name: str) -> Self: ...
+    def with_stem(self, stem: str) -> Self: ...
+    def with_suffix(self, suffix: str) -> Self: ...
+    def relative_to(self, other: StrPath, *, walk_up: bool = False) -> Self: ...
+    def is_relative_to(self, other: StrPath) -> bool: ...
+    @property
+    def parts(self) -> tuple[str, ...]: ...
+    def joinpath(self, *pathsegments: StrPath) -> Self: ...
+    def __truediv__(self, key: StrPath) -> Self: ...
+    def __rtruediv__(self, key: StrPath) -> Self: ...
+    @property
+    def parent(self) -> Self: ...
+    @property
+    def parents(self) -> Sequence[Self]: ...
+    def is_absolute(self) -> bool: ...
+    def match(self, path_pattern: str, *, case_sensitive: bool | None = None) -> bool: ...
+    def full_match(self, pattern: StrPath, *, case_sensitive: bool | None = None) -> bool: ...
+
+class PathBase(PurePathBase):
+    def stat(self, *, follow_symlinks: bool = True) -> stat_result: ...
+    def lstat(self) -> stat_result: ...
+    def exists(self, *, follow_symlinks: bool = True) -> bool: ...
+    def is_dir(self, *, follow_symlinks: bool = True) -> bool: ...
+    def is_file(self, *, follow_symlinks: bool = True) -> bool: ...
+    def is_mount(self) -> bool: ...
+    def is_symlink(self) -> bool: ...
+    def is_junction(self) -> bool: ...
+    def is_block_device(self) -> bool: ...
+    def is_char_device(self) -> bool: ...
+    def is_fifo(self) -> bool: ...
+    def is_socket(self) -> bool: ...
+    def samefile(self, other_path: StrPath) -> bool: ...
+
+    # Adapted from builtins.open
+    # Text mode: always returns a TextIOWrapper
+    # The Traversable .open in stdlib/importlib/abc.pyi should be kept in sync with this.
+    @overload
+    def open(
+        self,
+        mode: OpenTextMode = "r",
+        buffering: int = -1,
+        encoding: str | None = None,
+        errors: str | None = None,
+        newline: str | None = None,
+        ) -> TextIOWrapper: ...
+    # Unbuffered binary mode: returns a FileIO
+    @overload
+    def open(
+        self, mode: OpenBinaryMode, buffering: Literal[0], encoding: None = None, errors: None = None, newline: None = None
+    ) -> FileIO: ...
+    # Buffering is on: return BufferedRandom, BufferedReader, or BufferedWriter
+    @overload
+    def open(
+        self,
+        mode: OpenBinaryModeUpdating,
+        buffering: Literal[-1, 1] = -1,
+        encoding: None = None,
+        errors: None = None,
+        newline: None = None,
+    ) -> BufferedRandom: ...
+    @overload
+    def open(
+        self,
+        mode: OpenBinaryModeWriting,
+        buffering: Literal[-1, 1] = -1,
+        encoding: None = None,
+        errors: None = None,
+        newline: None = None,
+    ) -> BufferedWriter: ...
+    @overload
+    def open(
+        self,
+        mode: OpenBinaryModeReading,
+        buffering: Literal[-1, 1] = -1,
+        encoding: None = None,
+        errors: None = None,
+        newline: None = None,
+    ) -> BufferedReader: ...
+    # Buffering cannot be determined: fall back to BinaryIO
+    @overload
+    def open(
+        self, mode: OpenBinaryMode, buffering: int = -1, encoding: None = None, errors: None = None, newline: None = None
+    ) -> BinaryIO: ...
+    # Fallback if mode is not specified
+    @overload
+    def open(
+        self, mode: str, buffering: int = -1, encoding: str | None = None, errors: str | None = None, newline: str | None = None
+    ) -> IO[Any]: ...
+    def read_bytes(self) -> bytes: ...
+    def read_text(self, encoding: str | None = None, errors: str | None = None, newline: str | None = None) -> str: ...
+    def write_bytes(self, data: ReadableBuffer) -> int: ...
+    def write_text(
+        self, data: str, encoding: str | None = None, errors: str | None = None, newline: str | None = None
+    ) -> int: ...
+    def iterdir(self) -> Generator[Self, None, None]: ...
+    def glob(
+        self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = True
+    ) -> Generator[Self, None, None]: ...
+    def rglob(
+        self, pattern: str, *, case_sensitive: bool | None = None, recurse_symlinks: bool = True
+    ) -> Generator[Self, None, None]: ...
+    def walk(
+        self, top_down: bool = True, on_error: Callable[[OSError], object] | None = None, follow_symlinks: bool = False
+    ) -> Iterator[tuple[Self, list[str], list[str]]]: ...
+    def absolute(self) -> Self: ...
+    @classmethod
+    def cwd(cls) -> Self: ...
+    def expanduser(self) -> Self: ...
+    @classmethod
+    def home(cls) -> Self: ...
+    def readlink(self) -> Self: ...
+    def resolve(self, strict: bool = False) -> Self: ...
+    def symlink_to(self, target: StrOrBytesPath, target_is_directory: bool = False) -> None: ...
+    def hardlink_to(self, target: StrOrBytesPath) -> None: ...
+    def touch(self, mode: int = 0o666, exist_ok: bool = True) -> None: ...
+    def mkdir(self, mode: int = 0o777, parents: bool = False, exist_ok: bool = False) -> None: ...
+    def rename(self, target: StrPath) -> Self: ...
+    def replace(self, target: StrPath) -> Self: ...
+    def chmod(self, mode: int, *, follow_symlinks: bool = True) -> None: ...
+    def lchmod(self, mode: int) -> None: ...
+    def unlink(self, missing_ok: bool = False) -> None: ...
+    def rmdir(self) -> None: ...
+    def owner(self, *, follow_symlinks: bool = True) -> str: ...
+    def group(self, *, follow_symlinks: bool = True) -> str: ...
+    @classmethod
+    def from_uri(cls, uri: str) -> Self: ...
+    def as_uri(self) -> str: ...