Skip to content

Commit a55dffd

Browse files
barneygalebarneygale
authored
pythonGH-127381: pathlib ABCs: remove ReadablePath.exists() and is_*() (python#130520)
Remove `ReadablePath` methods duplicated by `ReadablePath.info`. To be specific, we remove `exists()`, `is_dir()`, `is_file()` and `is_symlink()`. The public `Path` class retains these methods.
1 parent 5181ddb commit a55dffd

File tree

3 files changed

+89
-130
lines changed

3 files changed

+89
-130
lines changed

‎Lib/pathlib/_abc.py‎

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -219,38 +219,6 @@ def info(self):
219219
"""
220220
raise NotImplementedError
221221

222-
def exists(self, *, follow_symlinks=True):
223-
"""
224-
Whether this path exists.
225-
226-
This method normally follows symlinks; to check whether a symlink exists,
227-
add the argument follow_symlinks=False.
228-
"""
229-
info = self.joinpath().info
230-
return info.exists(follow_symlinks=follow_symlinks)
231-
232-
def is_dir(self, *, follow_symlinks=True):
233-
"""
234-
Whether this path is a directory.
235-
"""
236-
info = self.joinpath().info
237-
return info.is_dir(follow_symlinks=follow_symlinks)
238-
239-
def is_file(self, *, follow_symlinks=True):
240-
"""
241-
Whether this path is a regular file (also True for symlinks pointing
242-
to regular files).
243-
"""
244-
info = self.joinpath().info
245-
return info.is_file(follow_symlinks=follow_symlinks)
246-
247-
def is_symlink(self):
248-
"""
249-
Whether this path is a symbolic link.
250-
"""
251-
info = self.joinpath().info
252-
return info.is_symlink()
253-
254222
@abstractmethod
255223
def __open_rb__(self, buffering=-1):
256224
"""

‎Lib/test/test_pathlib/test_pathlib.py‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2453,6 +2453,93 @@ def test_lstat_nosymlink(self):
24532453
st = p.stat()
24542454
self.assertEqual(st, p.lstat())
24552455

2456+
def test_exists(self):
2457+
P = self.cls
2458+
p = P(self.base)
2459+
self.assertIs(True, p.exists())
2460+
self.assertIs(True, (p / 'dirA').exists())
2461+
self.assertIs(True, (p / 'fileA').exists())
2462+
self.assertIs(False, (p / 'fileA' / 'bah').exists())
2463+
if self.can_symlink:
2464+
self.assertIs(True, (p / 'linkA').exists())
2465+
self.assertIs(True, (p / 'linkB').exists())
2466+
self.assertIs(True, (p / 'linkB' / 'fileB').exists())
2467+
self.assertIs(False, (p / 'linkA' / 'bah').exists())
2468+
self.assertIs(False, (p / 'brokenLink').exists())
2469+
self.assertIs(True, (p / 'brokenLink').exists(follow_symlinks=False))
2470+
self.assertIs(False, (p / 'foo').exists())
2471+
self.assertIs(False, P('/xyzzy').exists())
2472+
self.assertIs(False, P(self.base + '\udfff').exists())
2473+
self.assertIs(False, P(self.base + '\x00').exists())
2474+
2475+
def test_is_dir(self):
2476+
P = self.cls(self.base)
2477+
self.assertTrue((P / 'dirA').is_dir())
2478+
self.assertFalse((P / 'fileA').is_dir())
2479+
self.assertFalse((P / 'non-existing').is_dir())
2480+
self.assertFalse((P / 'fileA' / 'bah').is_dir())
2481+
if self.can_symlink:
2482+
self.assertFalse((P / 'linkA').is_dir())
2483+
self.assertTrue((P / 'linkB').is_dir())
2484+
self.assertFalse((P/ 'brokenLink').is_dir())
2485+
self.assertFalse((P / 'dirA\udfff').is_dir())
2486+
self.assertFalse((P / 'dirA\x00').is_dir())
2487+
2488+
def test_is_dir_no_follow_symlinks(self):
2489+
P = self.cls(self.base)
2490+
self.assertTrue((P / 'dirA').is_dir(follow_symlinks=False))
2491+
self.assertFalse((P / 'fileA').is_dir(follow_symlinks=False))
2492+
self.assertFalse((P / 'non-existing').is_dir(follow_symlinks=False))
2493+
self.assertFalse((P / 'fileA' / 'bah').is_dir(follow_symlinks=False))
2494+
if self.can_symlink:
2495+
self.assertFalse((P / 'linkA').is_dir(follow_symlinks=False))
2496+
self.assertFalse((P / 'linkB').is_dir(follow_symlinks=False))
2497+
self.assertFalse((P/ 'brokenLink').is_dir(follow_symlinks=False))
2498+
self.assertFalse((P / 'dirA\udfff').is_dir(follow_symlinks=False))
2499+
self.assertFalse((P / 'dirA\x00').is_dir(follow_symlinks=False))
2500+
2501+
def test_is_file(self):
2502+
P = self.cls(self.base)
2503+
self.assertTrue((P / 'fileA').is_file())
2504+
self.assertFalse((P / 'dirA').is_file())
2505+
self.assertFalse((P / 'non-existing').is_file())
2506+
self.assertFalse((P / 'fileA' / 'bah').is_file())
2507+
if self.can_symlink:
2508+
self.assertTrue((P / 'linkA').is_file())
2509+
self.assertFalse((P / 'linkB').is_file())
2510+
self.assertFalse((P/ 'brokenLink').is_file())
2511+
self.assertFalse((P / 'fileA\udfff').is_file())
2512+
self.assertFalse((P / 'fileA\x00').is_file())
2513+
2514+
def test_is_file_no_follow_symlinks(self):
2515+
P = self.cls(self.base)
2516+
self.assertTrue((P / 'fileA').is_file(follow_symlinks=False))
2517+
self.assertFalse((P / 'dirA').is_file(follow_symlinks=False))
2518+
self.assertFalse((P / 'non-existing').is_file(follow_symlinks=False))
2519+
self.assertFalse((P / 'fileA' / 'bah').is_file(follow_symlinks=False))
2520+
if self.can_symlink:
2521+
self.assertFalse((P / 'linkA').is_file(follow_symlinks=False))
2522+
self.assertFalse((P / 'linkB').is_file(follow_symlinks=False))
2523+
self.assertFalse((P/ 'brokenLink').is_file(follow_symlinks=False))
2524+
self.assertFalse((P / 'fileA\udfff').is_file(follow_symlinks=False))
2525+
self.assertFalse((P / 'fileA\x00').is_file(follow_symlinks=False))
2526+
2527+
def test_is_symlink(self):
2528+
P = self.cls(self.base)
2529+
self.assertFalse((P / 'fileA').is_symlink())
2530+
self.assertFalse((P / 'dirA').is_symlink())
2531+
self.assertFalse((P / 'non-existing').is_symlink())
2532+
self.assertFalse((P / 'fileA' / 'bah').is_symlink())
2533+
if self.can_symlink:
2534+
self.assertTrue((P / 'linkA').is_symlink())
2535+
self.assertTrue((P / 'linkB').is_symlink())
2536+
self.assertTrue((P/ 'brokenLink').is_symlink())
2537+
self.assertIs((P / 'fileA\udfff').is_file(), False)
2538+
self.assertIs((P / 'fileA\x00').is_file(), False)
2539+
if self.can_symlink:
2540+
self.assertIs((P / 'linkA\udfff').is_file(), False)
2541+
self.assertIs((P / 'linkA\x00').is_file(), False)
2542+
24562543
def test_is_junction_false(self):
24572544
P = self.cls(self.base)
24582545
self.assertFalse((P / 'fileA').is_junction())

‎Lib/test/test_pathlib/test_pathlib_abc.py‎

Lines changed: 2 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1007,25 +1007,6 @@ def test_is_readable(self):
10071007
p = self.cls(self.base)
10081008
self.assertIsInstance(p, ReadablePath)
10091009

1010-
def test_exists(self):
1011-
P = self.cls
1012-
p = P(self.base)
1013-
self.assertIs(True, p.exists())
1014-
self.assertIs(True, (p / 'dirA').exists())
1015-
self.assertIs(True, (p / 'fileA').exists())
1016-
self.assertIs(False, (p / 'fileA' / 'bah').exists())
1017-
if self.can_symlink:
1018-
self.assertIs(True, (p / 'linkA').exists())
1019-
self.assertIs(True, (p / 'linkB').exists())
1020-
self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1021-
self.assertIs(False, (p / 'linkA' / 'bah').exists())
1022-
self.assertIs(False, (p / 'brokenLink').exists())
1023-
self.assertIs(True, (p / 'brokenLink').exists(follow_symlinks=False))
1024-
self.assertIs(False, (p / 'foo').exists())
1025-
self.assertIs(False, P('/xyzzy').exists())
1026-
self.assertIs(False, P(self.base + '\udfff').exists())
1027-
self.assertIs(False, P(self.base + '\x00').exists())
1028-
10291010
def test_magic_open(self):
10301011
p = self.cls(self.base)
10311012
with magic_open(p / 'fileA', 'r') as f:
@@ -1058,17 +1039,8 @@ def test_iterdir_nodir(self):
10581039
def test_iterdir_info(self):
10591040
p = self.cls(self.base)
10601041
for child in p.iterdir():
1061-
info = child.info
1062-
self.assertIsInstance(info, PathInfo)
1063-
self.assertEqual(info.exists(), child.exists())
1064-
self.assertEqual(info.is_dir(), child.is_dir())
1065-
self.assertEqual(info.is_file(), child.is_file())
1066-
self.assertEqual(info.is_symlink(), child.is_symlink())
1067-
self.assertTrue(info.exists(follow_symlinks=False))
1068-
self.assertEqual(info.is_dir(follow_symlinks=False),
1069-
child.is_dir(follow_symlinks=False))
1070-
self.assertEqual(info.is_file(follow_symlinks=False),
1071-
child.is_file(follow_symlinks=False))
1042+
self.assertIsInstance(child.info, PathInfo)
1043+
self.assertTrue(child.info.exists(follow_symlinks=False))
10721044

10731045
def test_glob_common(self):
10741046
def _check(glob, expected):
@@ -1248,74 +1220,6 @@ def test_info_is_symlink(self):
12481220
self.assertFalse((p / 'fileA\udfff').info.is_symlink())
12491221
self.assertFalse((p / 'fileA\x00').info.is_symlink())
12501222

1251-
def test_is_dir(self):
1252-
P = self.cls(self.base)
1253-
self.assertTrue((P / 'dirA').is_dir())
1254-
self.assertFalse((P / 'fileA').is_dir())
1255-
self.assertFalse((P / 'non-existing').is_dir())
1256-
self.assertFalse((P / 'fileA' / 'bah').is_dir())
1257-
if self.can_symlink:
1258-
self.assertFalse((P / 'linkA').is_dir())
1259-
self.assertTrue((P / 'linkB').is_dir())
1260-
self.assertFalse((P/ 'brokenLink').is_dir())
1261-
self.assertFalse((P / 'dirA\udfff').is_dir())
1262-
self.assertFalse((P / 'dirA\x00').is_dir())
1263-
1264-
def test_is_dir_no_follow_symlinks(self):
1265-
P = self.cls(self.base)
1266-
self.assertTrue((P / 'dirA').is_dir(follow_symlinks=False))
1267-
self.assertFalse((P / 'fileA').is_dir(follow_symlinks=False))
1268-
self.assertFalse((P / 'non-existing').is_dir(follow_symlinks=False))
1269-
self.assertFalse((P / 'fileA' / 'bah').is_dir(follow_symlinks=False))
1270-
if self.can_symlink:
1271-
self.assertFalse((P / 'linkA').is_dir(follow_symlinks=False))
1272-
self.assertFalse((P / 'linkB').is_dir(follow_symlinks=False))
1273-
self.assertFalse((P/ 'brokenLink').is_dir(follow_symlinks=False))
1274-
self.assertFalse((P / 'dirA\udfff').is_dir(follow_symlinks=False))
1275-
self.assertFalse((P / 'dirA\x00').is_dir(follow_symlinks=False))
1276-
1277-
def test_is_file(self):
1278-
P = self.cls(self.base)
1279-
self.assertTrue((P / 'fileA').is_file())
1280-
self.assertFalse((P / 'dirA').is_file())
1281-
self.assertFalse((P / 'non-existing').is_file())
1282-
self.assertFalse((P / 'fileA' / 'bah').is_file())
1283-
if self.can_symlink:
1284-
self.assertTrue((P / 'linkA').is_file())
1285-
self.assertFalse((P / 'linkB').is_file())
1286-
self.assertFalse((P/ 'brokenLink').is_file())
1287-
self.assertFalse((P / 'fileA\udfff').is_file())
1288-
self.assertFalse((P / 'fileA\x00').is_file())
1289-
1290-
def test_is_file_no_follow_symlinks(self):
1291-
P = self.cls(self.base)
1292-
self.assertTrue((P / 'fileA').is_file(follow_symlinks=False))
1293-
self.assertFalse((P / 'dirA').is_file(follow_symlinks=False))
1294-
self.assertFalse((P / 'non-existing').is_file(follow_symlinks=False))
1295-
self.assertFalse((P / 'fileA' / 'bah').is_file(follow_symlinks=False))
1296-
if self.can_symlink:
1297-
self.assertFalse((P / 'linkA').is_file(follow_symlinks=False))
1298-
self.assertFalse((P / 'linkB').is_file(follow_symlinks=False))
1299-
self.assertFalse((P/ 'brokenLink').is_file(follow_symlinks=False))
1300-
self.assertFalse((P / 'fileA\udfff').is_file(follow_symlinks=False))
1301-
self.assertFalse((P / 'fileA\x00').is_file(follow_symlinks=False))
1302-
1303-
def test_is_symlink(self):
1304-
P = self.cls(self.base)
1305-
self.assertFalse((P / 'fileA').is_symlink())
1306-
self.assertFalse((P / 'dirA').is_symlink())
1307-
self.assertFalse((P / 'non-existing').is_symlink())
1308-
self.assertFalse((P / 'fileA' / 'bah').is_symlink())
1309-
if self.can_symlink:
1310-
self.assertTrue((P / 'linkA').is_symlink())
1311-
self.assertTrue((P / 'linkB').is_symlink())
1312-
self.assertTrue((P/ 'brokenLink').is_symlink())
1313-
self.assertIs((P / 'fileA\udfff').is_file(), False)
1314-
self.assertIs((P / 'fileA\x00').is_file(), False)
1315-
if self.can_symlink:
1316-
self.assertIs((P / 'linkA\udfff').is_file(), False)
1317-
self.assertIs((P / 'linkA\x00').is_file(), False)
1318-
13191223

13201224
class WritablePathTest(JoinablePathTest):
13211225
cls = DummyWritablePath

0 commit comments

Comments
 (0)