gh-78318: Add pathlib.Path.lexists and related by nphilipp · Pull Request #21157 · python/cpython · GitHub
Skip to content

gh-78318: Add pathlib.Path.lexists and related #21157

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

Closed
nphilipp wants to merge 2 commits into from
Closed

gh-78318: Add pathlib.Path.lexists and related #21157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d48d796
bpo-34137: Add pathlib.Path.lexists and related
nphilipp Feb 12, 2021
0336439
Merge branch 'main' into master--pathlib-path-lexists
AlexWaygood Jan 8, 2023
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
17 changes: 15 additions & 2 deletions Doc/library/pathlib.rst
View file
Open in desktop
18 changes: 16 additions & 2 deletions Lib/pathlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1061,12 +1061,18 @@ def hardlink_to(self, target):

# Convenience functions for querying the stat results

def exists(self):
def exists(self, *, follow_symlinks=True):
"""
Whether this path exists.

Returns False for broken symbolic links unless follow_symlinks is set
to False.
"""
try:
self.stat()
if follow_symlinks:
self.stat()
else:
self.lstat()
except OSError as e:
if not _ignore_error(e):
raise
Expand Down Expand Up @@ -1200,6 +1206,14 @@ def is_socket(self):
# Non-encodable path
return False

def lexists(self):
"""
Whether this path exists, but don't follow symbolic links.

Returns True for broken symbolic links.
"""
return self.exists(follow_symlinks=False)

def expanduser(self):
""" Return a new path with expanded ~ and ~user constructs
(as returned by os.path.expanduser)
Expand Down
20 changes: 20 additions & 0 deletions Lib/test/test_pathlib.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1646,11 +1646,31 @@ def test_exists(self):
self.assertIs(True, (p / 'linkB').exists())
self.assertIs(True, (p / 'linkB' / 'fileB').exists())
self.assertIs(False, (p / 'linkA' / 'bah').exists())
self.assertIs(False, (p / 'brokenLink').exists())
self.assertIs(False, (p / 'brokenLinkLoop').exists())
self.assertIs(True, (p / 'brokenLink').exists(
follow_symlinks=False))
self.assertIs(True, (p / 'brokenLinkLoop').exists(
follow_symlinks=False))
self.assertIs(False, (p / 'foo').exists())
self.assertIs(False, P('/xyzzy').exists())
self.assertIs(False, P(BASE + '\udfff').exists())
self.assertIs(False, P(BASE + '\x00').exists())

@os_helper.skip_unless_symlink
def test_exists_follow_symlinks(self):
P = self.cls
p = P(BASE)
self.assertIs(True, (p / 'brokenLink').exists(follow_symlinks=False))
self.assertIs(True, (p / 'brokenLinkLoop').exists(follow_symlinks=False))

@os_helper.skip_unless_symlink
def test_lexists(self):
P = self.cls
p = P(BASE)
self.assertIs(True, (p / 'brokenLink').lexists())
self.assertIs(True, (p / 'brokenLinkLoop').lexists())

def test_open_common(self):
p = self.cls(BASE)
with (p / 'fileA').open('r') as f:
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2020-06-25-16-34-59.bpo-34137.JomN6i.rst
View file
Open in desktop