-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
add new pathlib base classes for 3.13 #12937
Open
tungol
wants to merge
6
commits into
python:main
Choose a base branch
from
tungol:pathlib
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
694954a
add new pathlib base classes for 3.13
tungol 87d5bd4
tweaks for stubtest
tungol 598fee1
note
tungol 9ad0b43
UnsupportedOperation
tungol d8cec88
simplify PathBase.open
tungol 0fb2a5d
add default to final overload of pathlib.Path.open
tungol File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: ... | ||
tungol marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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: ... |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if we should require all implementations of this ABC to duplicate this stack of overloads. Not sure what the alternative would be, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hadn't considered that aspect when copying it over. I think the alternative is to define only the most generic form of open on the base class, and implementations can have more specific overloads as needed. I'll update the MR for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
stubtest didn't like that... I thought it would work based on a simplified test I did locally, but possibly I misunderstood something. I'll need to look at it later, so I'll put this in draft for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also the same concern possibly applies to the overloads on ParserBase. I copied the definitions in the MR right now for that class from the versions that exist in posixpath.pyi.