Skip to content

GH-127456: pathlib ABCs: add protocol for path parser #127494

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.

Sign up for GitHub

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

Merged
barneygale merged 12 commits into from
Dec 9, 2024
Merged

GH-127456: pathlib ABCs: add protocol for path parser #127494

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f5e946b
Change the default value of `PurePathBase.parser` from `ParserBase()` to
barneygale Nov 30, 2024
9febad0
Move `pathlib._abc.ParserBase` to `pathlib._types.Parser`, and conver…
barneygale Nov 30, 2024
6e07a3c
Add `pathlib._types.DirEntry`, which is a protocol for directory entr…
barneygale Nov 30, 2024
2ada5d1
Add `pathlib._types.StatResult`, which is a protocol for stat() results.
barneygale Nov 30, 2024
0d0140a
Revise tests
barneygale Nov 30, 2024
4d51683
Docstring tweaks
barneygale Dec 1, 2024
59201c3
Apply suggestions from code review
barneygale Dec 3, 2024
2fa207c
Add DirEntry.is_file()
barneygale Dec 3, 2024
137875c
Another docstring tweak
barneygale Dec 3, 2024
0cc51fa
Merge branch 'main' into gh-127456
barneygale Dec 7, 2024
ee23e0e
Remove DirEntry and StatResult for now.
barneygale Dec 7, 2024
d3fbc5b
Merge branch 'main' into gh-127456
barneygale Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Change the default value of PurePathBase.parser from ParserBase() to 
`posixpath`. As a result, user subclasses of `PurePathBase` and `PathBase`
use POSIX path syntax by default, which is very often desirable.
  • Loading branch information
@barneygale
barneygale committed Nov 30, 2024
commit f5e946bfe827dd5f7b5f69c7563d3b32d4c39672
2 changes: 1 addition & 1 deletion Lib/pathlib/_abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ class PurePathBase:
# work from occurring when `resolve()` calls `stat()` or `readlink()`.
'_resolving',
)
parser = ParserBase()
parser = posixpath
_globber = PathGlobber

def __init__(self, *args):
Expand Down
40 changes: 3 additions & 37 deletions Lib/test/test_pathlib/test_pathlib_abc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,37 +63,6 @@ def test_unsupported_operation(self):
class PurePathBaseTest(unittest.TestCase):
cls = PurePathBase

def test_unsupported_operation_pure(self):
p = self.cls('foo')
e = UnsupportedOperation
with self.assertRaises(e):
p.drive
with self.assertRaises(e):
p.root
with self.assertRaises(e):
p.anchor
with self.assertRaises(e):
p.parts
with self.assertRaises(e):
p.parent
with self.assertRaises(e):
p.parents
with self.assertRaises(e):
p.name
with self.assertRaises(e):
p.stem
with self.assertRaises(e):
p.suffix
with self.assertRaises(e):
p.suffixes
self.assertRaises(e, p.with_name, 'bar')
self.assertRaises(e, p.with_stem, 'bar')
self.assertRaises(e, p.with_suffix, '.txt')
self.assertRaises(e, p.relative_to, '')
self.assertRaises(e, p.is_relative_to, '')
self.assertRaises(e, p.is_absolute)
self.assertRaises(e, p.match, '*')

def test_magic_methods(self):
P = self.cls
self.assertFalse(hasattr(P, '__fspath__'))
Expand All @@ -108,12 +77,11 @@ def test_magic_methods(self):
self.assertIs(P.__ge__, object.__ge__)

def test_parser(self):
self.assertIsInstance(self.cls.parser, ParserBase)
self.assertIs(self.cls.parser, posixpath)


class DummyPurePath(PurePathBase):
__slots__ = ()
parser = posixpath

def __eq__(self, other):
if not isinstance(other, DummyPurePath):
Expand Down Expand Up @@ -1367,10 +1335,9 @@ def test_unsupported_operation(self):
self.assertRaises(e, p.write_bytes, b'foo')
self.assertRaises(e, p.write_text, 'foo')
self.assertRaises(e, p.iterdir)
self.assertRaises(e, p.glob, '*')
self.assertRaises(e, p.rglob, '*')
self.assertRaises(e, lambda: list(p.glob('*')))
self.assertRaises(e, lambda: list(p.rglob('*')))
self.assertRaises(e, lambda: list(p.walk()))
self.assertRaises(e, p.absolute)
self.assertRaises(e, p.expanduser)
self.assertRaises(e, p.readlink)
self.assertRaises(e, p.symlink_to, 'foo')
Expand Down Expand Up @@ -1442,7 +1409,6 @@ class DummyPath(PathBase):
memory.
"""
__slots__ = ()
parser = posixpath

_files = {}
_directories = {}
Expand Down