Skip to content

Commit

Permalink
pythonGH-127381: pathlib ABCs: remove PathBase.lstat() (python#127382)
Browse files Browse the repository at this point in the history
Remove the `PathBase.lstat()` method, which is a trivial variation of
`stat()`.

No user-facing changes because the pathlib ABCs are still private.
  • Loading branch information
barneygale authored and picnixz committed Dec 2, 2024
1 parent bf669ed commit 73f0306
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 29 deletions.
12 changes: 2 additions & 10 deletions Lib/pathlib/_abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -438,14 +438,6 @@ def stat(self, *, follow_symlinks=True):
"""
raise UnsupportedOperation(self._unsupported_msg('stat()'))

def lstat(self):
"""
Like stat(), except if the path points to a symlink, the symlink's
status information is returned, rather than its target's.
"""
return self.stat(follow_symlinks=False)


# Convenience functions for querying the stat results

def exists(self, *, follow_symlinks=True):
Expand Down Expand Up @@ -505,7 +497,7 @@ def is_symlink(self):
Whether this path is a symbolic link.
"""
try:
return S_ISLNK(self.lstat().st_mode)
return S_ISLNK(self.stat(follow_symlinks=False).st_mode)
except (OSError, ValueError):
return False

Expand Down Expand Up @@ -789,7 +781,7 @@ def raise_error(*args):
def lstat(path_str):
path = self.with_segments(path_str)
path._resolving = True
return path.lstat()
return path.stat(follow_symlinks=False)

def readlink(path_str):
path = self.with_segments(path_str)
Expand Down
7 changes: 7 additions & 0 deletions Lib/pathlib/_local.py
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,13 @@ def stat(self, *, follow_symlinks=True):
"""
return os.stat(self, follow_symlinks=follow_symlinks)

def lstat(self):
"""
Like stat(), except if the path points to a symlink, the symlink's
status information is returned, rather than its target's.
"""
return os.lstat(self)

def exists(self, *, follow_symlinks=True):
"""
Whether this path exists.
Expand Down
18 changes: 13 additions & 5 deletions Lib/test/test_pathlib/test_pathlib.py
Original file line number Diff line number Diff line change
Expand Up @@ -546,12 +546,9 @@ def tempdir(self):
self.addCleanup(os_helper.rmtree, d)
return d

def test_matches_pathbase_api(self):
our_names = {name for name in dir(self.cls) if name[0] != '_'}
our_names.remove('is_reserved') # only present in PurePath
def test_matches_pathbase_docstrings(self):
path_names = {name for name in dir(pathlib._abc.PathBase) if name[0] != '_'}
self.assertEqual(our_names, path_names)
for attr_name in our_names:
for attr_name in path_names:
if attr_name == 'parser':
# On Windows, Path.parser is ntpath, but PathBase.parser is
# posixpath, and so their docstrings differ.
Expand Down Expand Up @@ -1357,6 +1354,17 @@ def test_symlink_to_unsupported(self):
with self.assertRaises(pathlib.UnsupportedOperation):
q.symlink_to(p)

@needs_symlinks
def test_lstat(self):
p = self.cls(self.base)/ 'linkA'
st = p.stat()
self.assertNotEqual(st, p.lstat())

def test_lstat_nosymlink(self):
p = self.cls(self.base) / 'fileA'
st = p.stat()
self.assertEqual(st, p.lstat())

def test_is_junction(self):
P = self.cls(self.base)

Expand Down
18 changes: 4 additions & 14 deletions Lib/test/test_pathlib/test_pathlib_abc.py
Original file line number Diff line number Diff line change
Expand Up @@ -1351,7 +1351,6 @@ def test_unsupported_operation(self):
p = self.cls('')
e = UnsupportedOperation
self.assertRaises(e, p.stat)
self.assertRaises(e, p.lstat)
self.assertRaises(e, p.exists)
self.assertRaises(e, p.samefile, 'foo')
self.assertRaises(e, p.is_dir)
Expand Down Expand Up @@ -2671,17 +2670,6 @@ def test_stat_no_follow_symlinks_nosymlink(self):
st = p.stat()
self.assertEqual(st, p.stat(follow_symlinks=False))

@needs_symlinks
def test_lstat(self):
p = self.cls(self.base)/ 'linkA'
st = p.stat()
self.assertNotEqual(st, p.lstat())

def test_lstat_nosymlink(self):
p = self.cls(self.base) / 'fileA'
st = p.stat()
self.assertEqual(st, p.lstat())

def test_is_dir(self):
P = self.cls(self.base)
self.assertTrue((P / 'dirA').is_dir())
Expand Down Expand Up @@ -2868,11 +2856,13 @@ def test_delete_dir(self):
base = self.cls(self.base)
base.joinpath('dirA')._delete()
self.assertRaises(FileNotFoundError, base.joinpath('dirA').stat)
self.assertRaises(FileNotFoundError, base.joinpath('dirA', 'linkC').lstat)
self.assertRaises(FileNotFoundError, base.joinpath('dirA', 'linkC').stat,
follow_symlinks=False)
base.joinpath('dirB')._delete()
self.assertRaises(FileNotFoundError, base.joinpath('dirB').stat)
self.assertRaises(FileNotFoundError, base.joinpath('dirB', 'fileB').stat)
self.assertRaises(FileNotFoundError, base.joinpath('dirB', 'linkD').lstat)
self.assertRaises(FileNotFoundError, base.joinpath('dirB', 'linkD').stat,
follow_symlinks=False)
base.joinpath('dirC')._delete()
self.assertRaises(FileNotFoundError, base.joinpath('dirC').stat)
self.assertRaises(FileNotFoundError, base.joinpath('dirC', 'dirD').stat)
Expand Down

0 comments on commit 73f0306

Please sign in to comment.