blob: 2f2ba3cbfc7c352fcd35d193e89b1f8635380829 [file] [log] [blame]
Antoine Pitrou31119e42013-11-22 17:38:12 +01001import collections
2import io
3import os
4import errno
5import pathlib
6import pickle
Antoine Pitrou31119e42013-11-22 17:38:12 +01007import socket
8import stat
Antoine Pitrou31119e42013-11-22 17:38:12 +01009import tempfile
10import unittest
Antoine Pitrou31119e42013-11-22 17:38:12 +010011
12from test import support
13TESTFN = support.TESTFN
14
15try:
16 import grp, pwd
17except ImportError:
18 grp = pwd = None
19
20
21class _BaseFlavourTest(object):
22
23 def _check_parse_parts(self, arg, expected):
24 f = self.flavour.parse_parts
25 sep = self.flavour.sep
26 altsep = self.flavour.altsep
27 actual = f([x.replace('/', sep) for x in arg])
28 self.assertEqual(actual, expected)
29 if altsep:
30 actual = f([x.replace('/', altsep) for x in arg])
31 self.assertEqual(actual, expected)
32
33 def test_parse_parts_common(self):
34 check = self._check_parse_parts
35 sep = self.flavour.sep
36 # Unanchored parts
37 check([], ('', '', []))
38 check(['a'], ('', '', ['a']))
39 check(['a/'], ('', '', ['a']))
40 check(['a', 'b'], ('', '', ['a', 'b']))
41 # Expansion
42 check(['a/b'], ('', '', ['a', 'b']))
43 check(['a/b/'], ('', '', ['a', 'b']))
44 check(['a', 'b/c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
45 # Collapsing and stripping excess slashes
46 check(['a', 'b//c', 'd'], ('', '', ['a', 'b', 'c', 'd']))
47 check(['a', 'b/c/', 'd'], ('', '', ['a', 'b', 'c', 'd']))
48 # Eliminating standalone dots
49 check(['.'], ('', '', []))
50 check(['.', '.', 'b'], ('', '', ['b']))
51 check(['a', '.', 'b'], ('', '', ['a', 'b']))
52 check(['a', '.', '.'], ('', '', ['a']))
53 # The first part is anchored
54 check(['/a/b'], ('', sep, [sep, 'a', 'b']))
55 check(['/a', 'b'], ('', sep, [sep, 'a', 'b']))
56 check(['/a/', 'b'], ('', sep, [sep, 'a', 'b']))
57 # Ignoring parts before an anchored part
58 check(['a', '/b', 'c'], ('', sep, [sep, 'b', 'c']))
59 check(['a', '/b', '/c'], ('', sep, [sep, 'c']))
60
61
62class PosixFlavourTest(_BaseFlavourTest, unittest.TestCase):
63 flavour = pathlib._posix_flavour
64
65 def test_parse_parts(self):
66 check = self._check_parse_parts
67 # Collapsing of excess leading slashes, except for the double-slash
68 # special case.
69 check(['//a', 'b'], ('', '//', ['//', 'a', 'b']))
70 check(['///a', 'b'], ('', '/', ['/', 'a', 'b']))
71 check(['////a', 'b'], ('', '/', ['/', 'a', 'b']))
72 # Paths which look like NT paths aren't treated specially
73 check(['c:a'], ('', '', ['c:a']))
74 check(['c:\\a'], ('', '', ['c:\\a']))
75 check(['\\a'], ('', '', ['\\a']))
76
77 def test_splitroot(self):
78 f = self.flavour.splitroot
79 self.assertEqual(f(''), ('', '', ''))
80 self.assertEqual(f('a'), ('', '', 'a'))
81 self.assertEqual(f('a/b'), ('', '', 'a/b'))
82 self.assertEqual(f('a/b/'), ('', '', 'a/b/'))
83 self.assertEqual(f('/a'), ('', '/', 'a'))
84 self.assertEqual(f('/a/b'), ('', '/', 'a/b'))
85 self.assertEqual(f('/a/b/'), ('', '/', 'a/b/'))
86 # The root is collapsed when there are redundant slashes
87 # except when there are exactly two leading slashes, which
88 # is a special case in POSIX.
89 self.assertEqual(f('//a'), ('', '//', 'a'))
90 self.assertEqual(f('///a'), ('', '/', 'a'))
91 self.assertEqual(f('///a/b'), ('', '/', 'a/b'))
92 # Paths which look like NT paths aren't treated specially
93 self.assertEqual(f('c:/a/b'), ('', '', 'c:/a/b'))
94 self.assertEqual(f('\\/a/b'), ('', '', '\\/a/b'))
95 self.assertEqual(f('\\a\\b'), ('', '', '\\a\\b'))
96
97
98class NTFlavourTest(_BaseFlavourTest, unittest.TestCase):
99 flavour = pathlib._windows_flavour
100
101 def test_parse_parts(self):
102 check = self._check_parse_parts
103 # First part is anchored
104 check(['c:'], ('c:', '', ['c:']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100105 check(['c:/'], ('c:', '\\', ['c:\\']))
106 check(['/'], ('', '\\', ['\\']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100107 check(['c:a'], ('c:', '', ['c:', 'a']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100108 check(['c:/a'], ('c:', '\\', ['c:\\', 'a']))
109 check(['/a'], ('', '\\', ['\\', 'a']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100110 # UNC paths
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100111 check(['//a/b'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
112 check(['//a/b/'], ('\\\\a\\b', '\\', ['\\\\a\\b\\']))
113 check(['//a/b/c'], ('\\\\a\\b', '\\', ['\\\\a\\b\\', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100114 # Second part is anchored, so that the first part is ignored
115 check(['a', 'Z:b', 'c'], ('Z:', '', ['Z:', 'b', 'c']))
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100116 check(['a', 'Z:/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100117 # UNC paths
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100118 check(['a', '//b/c', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100119 # Collapsing and stripping excess slashes
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100120 check(['a', 'Z://b//c/', 'd/'], ('Z:', '\\', ['Z:\\', 'b', 'c', 'd']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100121 # UNC paths
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100122 check(['a', '//b/c//', 'd'], ('\\\\b\\c', '\\', ['\\\\b\\c\\', 'd']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100123 # Extended paths
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100124 check(['//?/c:/'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\']))
125 check(['//?/c:/a'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'a']))
126 check(['//?/c:/a', '/b'], ('\\\\?\\c:', '\\', ['\\\\?\\c:\\', 'b']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100127 # Extended UNC paths (format is "\\?\UNC\server\share")
Antoine Pitrou57fffd62015-02-15 18:03:59 +0100128 check(['//?/UNC/b/c'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\']))
129 check(['//?/UNC/b/c/d'], ('\\\\?\\UNC\\b\\c', '\\', ['\\\\?\\UNC\\b\\c\\', 'd']))
130 # Second part has a root but not drive
131 check(['a', '/b', 'c'], ('', '\\', ['\\', 'b', 'c']))
132 check(['Z:/a', '/b', 'c'], ('Z:', '\\', ['Z:\\', 'b', 'c']))
133 check(['//?/Z:/a', '/b', 'c'], ('\\\\?\\Z:', '\\', ['\\\\?\\Z:\\', 'b', 'c']))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100134
135 def test_splitroot(self):
136 f = self.flavour.splitroot
137 self.assertEqual(f(''), ('', '', ''))
138 self.assertEqual(f('a'), ('', '', 'a'))
139 self.assertEqual(f('a\\b'), ('', '', 'a\\b'))
140 self.assertEqual(f('\\a'), ('', '\\', 'a'))
141 self.assertEqual(f('\\a\\b'), ('', '\\', 'a\\b'))
142 self.assertEqual(f('c:a\\b'), ('c:', '', 'a\\b'))
143 self.assertEqual(f('c:\\a\\b'), ('c:', '\\', 'a\\b'))
144 # Redundant slashes in the root are collapsed
145 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
146 self.assertEqual(f('\\\\\\a/b'), ('', '\\', 'a/b'))
147 self.assertEqual(f('c:\\\\a'), ('c:', '\\', 'a'))
148 self.assertEqual(f('c:\\\\\\a/b'), ('c:', '\\', 'a/b'))
149 # Valid UNC paths
150 self.assertEqual(f('\\\\a\\b'), ('\\\\a\\b', '\\', ''))
151 self.assertEqual(f('\\\\a\\b\\'), ('\\\\a\\b', '\\', ''))
152 self.assertEqual(f('\\\\a\\b\\c\\d'), ('\\\\a\\b', '\\', 'c\\d'))
153 # These are non-UNC paths (according to ntpath.py and test_ntpath)
154 # However, command.com says such paths are invalid, so it's
155 # difficult to know what the right semantics are
156 self.assertEqual(f('\\\\\\a\\b'), ('', '\\', 'a\\b'))
157 self.assertEqual(f('\\\\a'), ('', '\\', 'a'))
158
159
160#
161# Tests for the pure classes
162#
163
164class _BasePurePathTest(object):
165
166 # keys are canonical paths, values are list of tuples of arguments
167 # supposed to produce equal paths
168 equivalences = {
169 'a/b': [
170 ('a', 'b'), ('a/', 'b'), ('a', 'b/'), ('a/', 'b/'),
171 ('a/b/',), ('a//b',), ('a//b//',),
172 # empty components get removed
173 ('', 'a', 'b'), ('a', '', 'b'), ('a', 'b', ''),
174 ],
175 '/b/c/d': [
176 ('a', '/b/c', 'd'), ('a', '///b//c', 'd/'),
177 ('/a', '/b/c', 'd'),
178 # empty components get removed
179 ('/', 'b', '', 'c/d'), ('/', '', 'b/c/d'), ('', '/b/c/d'),
180 ],
181 }
182
183 def setUp(self):
184 p = self.cls('a')
185 self.flavour = p._flavour
186 self.sep = self.flavour.sep
187 self.altsep = self.flavour.altsep
188
189 def test_constructor_common(self):
190 P = self.cls
191 p = P('a')
192 self.assertIsInstance(p, P)
Brett Cannon568be632016-06-10 12:20:49 -0700193 class PathLike:
194 def __fspath__(self):
195 return "a/b/c"
Antoine Pitrou31119e42013-11-22 17:38:12 +0100196 P('a', 'b', 'c')
197 P('/a', 'b', 'c')
198 P('a/b/c')
199 P('/a/b/c')
Brett Cannon568be632016-06-10 12:20:49 -0700200 P(PathLike())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100201 self.assertEqual(P(P('a')), P('a'))
202 self.assertEqual(P(P('a'), 'b'), P('a/b'))
203 self.assertEqual(P(P('a'), P('b')), P('a/b'))
Brett Cannon568be632016-06-10 12:20:49 -0700204 self.assertEqual(P(P('a'), P('b'), P('c')), P(PathLike()))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100205
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200206 def _check_str_subclass(self, *args):
207 # Issue #21127: it should be possible to construct a PurePath object
Serhiy Storchaka6a7b3a72016-04-17 08:32:47 +0300208 # from a str subclass instance, and it then gets converted to
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200209 # a pure str object.
210 class StrSubclass(str):
211 pass
212 P = self.cls
213 p = P(*(StrSubclass(x) for x in args))
214 self.assertEqual(p, P(*args))
215 for part in p.parts:
216 self.assertIs(type(part), str)
217
218 def test_str_subclass_common(self):
219 self._check_str_subclass('')
220 self._check_str_subclass('.')
221 self._check_str_subclass('a')
222 self._check_str_subclass('a/b.txt')
223 self._check_str_subclass('/a/b.txt')
224
Antoine Pitrou31119e42013-11-22 17:38:12 +0100225 def test_join_common(self):
226 P = self.cls
227 p = P('a/b')
228 pp = p.joinpath('c')
229 self.assertEqual(pp, P('a/b/c'))
230 self.assertIs(type(pp), type(p))
231 pp = p.joinpath('c', 'd')
232 self.assertEqual(pp, P('a/b/c/d'))
233 pp = p.joinpath(P('c'))
234 self.assertEqual(pp, P('a/b/c'))
235 pp = p.joinpath('/c')
236 self.assertEqual(pp, P('/c'))
237
238 def test_div_common(self):
239 # Basically the same as joinpath()
240 P = self.cls
241 p = P('a/b')
242 pp = p / 'c'
243 self.assertEqual(pp, P('a/b/c'))
244 self.assertIs(type(pp), type(p))
245 pp = p / 'c/d'
246 self.assertEqual(pp, P('a/b/c/d'))
247 pp = p / 'c' / 'd'
248 self.assertEqual(pp, P('a/b/c/d'))
249 pp = 'c' / p / 'd'
250 self.assertEqual(pp, P('c/a/b/d'))
251 pp = p / P('c')
252 self.assertEqual(pp, P('a/b/c'))
253 pp = p/ '/c'
254 self.assertEqual(pp, P('/c'))
255
256 def _check_str(self, expected, args):
257 p = self.cls(*args)
258 self.assertEqual(str(p), expected.replace('/', self.sep))
259
260 def test_str_common(self):
261 # Canonicalized paths roundtrip
262 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
263 self._check_str(pathstr, (pathstr,))
264 # Special case for the empty path
265 self._check_str('.', ('',))
266 # Other tests for str() are in test_equivalences()
267
268 def test_as_posix_common(self):
269 P = self.cls
270 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
271 self.assertEqual(P(pathstr).as_posix(), pathstr)
272 # Other tests for as_posix() are in test_equivalences()
273
274 def test_as_bytes_common(self):
275 sep = os.fsencode(self.sep)
276 P = self.cls
277 self.assertEqual(bytes(P('a/b')), b'a' + sep + b'b')
278
279 def test_as_uri_common(self):
280 P = self.cls
281 with self.assertRaises(ValueError):
282 P('a').as_uri()
283 with self.assertRaises(ValueError):
284 P().as_uri()
285
286 def test_repr_common(self):
287 for pathstr in ('a', 'a/b', 'a/b/c', '/', '/a/b', '/a/b/c'):
288 p = self.cls(pathstr)
289 clsname = p.__class__.__name__
290 r = repr(p)
291 # The repr() is in the form ClassName("forward-slashes path")
292 self.assertTrue(r.startswith(clsname + '('), r)
293 self.assertTrue(r.endswith(')'), r)
294 inner = r[len(clsname) + 1 : -1]
295 self.assertEqual(eval(inner), p.as_posix())
296 # The repr() roundtrips
297 q = eval(r, pathlib.__dict__)
298 self.assertIs(q.__class__, p.__class__)
299 self.assertEqual(q, p)
300 self.assertEqual(repr(q), r)
301
302 def test_eq_common(self):
303 P = self.cls
304 self.assertEqual(P('a/b'), P('a/b'))
305 self.assertEqual(P('a/b'), P('a', 'b'))
306 self.assertNotEqual(P('a/b'), P('a'))
307 self.assertNotEqual(P('a/b'), P('/a/b'))
308 self.assertNotEqual(P('a/b'), P())
309 self.assertNotEqual(P('/a/b'), P('/'))
310 self.assertNotEqual(P(), P('/'))
311 self.assertNotEqual(P(), "")
312 self.assertNotEqual(P(), {})
313 self.assertNotEqual(P(), int)
314
315 def test_match_common(self):
316 P = self.cls
317 self.assertRaises(ValueError, P('a').match, '')
318 self.assertRaises(ValueError, P('a').match, '.')
319 # Simple relative pattern
320 self.assertTrue(P('b.py').match('b.py'))
321 self.assertTrue(P('a/b.py').match('b.py'))
322 self.assertTrue(P('/a/b.py').match('b.py'))
323 self.assertFalse(P('a.py').match('b.py'))
324 self.assertFalse(P('b/py').match('b.py'))
325 self.assertFalse(P('/a.py').match('b.py'))
326 self.assertFalse(P('b.py/c').match('b.py'))
327 # Wilcard relative pattern
328 self.assertTrue(P('b.py').match('*.py'))
329 self.assertTrue(P('a/b.py').match('*.py'))
330 self.assertTrue(P('/a/b.py').match('*.py'))
331 self.assertFalse(P('b.pyc').match('*.py'))
332 self.assertFalse(P('b./py').match('*.py'))
333 self.assertFalse(P('b.py/c').match('*.py'))
334 # Multi-part relative pattern
335 self.assertTrue(P('ab/c.py').match('a*/*.py'))
336 self.assertTrue(P('/d/ab/c.py').match('a*/*.py'))
337 self.assertFalse(P('a.py').match('a*/*.py'))
338 self.assertFalse(P('/dab/c.py').match('a*/*.py'))
339 self.assertFalse(P('ab/c.py/d').match('a*/*.py'))
340 # Absolute pattern
341 self.assertTrue(P('/b.py').match('/*.py'))
342 self.assertFalse(P('b.py').match('/*.py'))
343 self.assertFalse(P('a/b.py').match('/*.py'))
344 self.assertFalse(P('/a/b.py').match('/*.py'))
345 # Multi-part absolute pattern
346 self.assertTrue(P('/a/b.py').match('/a/*.py'))
347 self.assertFalse(P('/ab.py').match('/a/*.py'))
348 self.assertFalse(P('/a/b/c.py').match('/a/*.py'))
349
350 def test_ordering_common(self):
351 # Ordering is tuple-alike
352 def assertLess(a, b):
353 self.assertLess(a, b)
354 self.assertGreater(b, a)
355 P = self.cls
356 a = P('a')
357 b = P('a/b')
358 c = P('abc')
359 d = P('b')
360 assertLess(a, b)
361 assertLess(a, c)
362 assertLess(a, d)
363 assertLess(b, c)
364 assertLess(c, d)
365 P = self.cls
366 a = P('/a')
367 b = P('/a/b')
368 c = P('/abc')
369 d = P('/b')
370 assertLess(a, b)
371 assertLess(a, c)
372 assertLess(a, d)
373 assertLess(b, c)
374 assertLess(c, d)
375 with self.assertRaises(TypeError):
376 P() < {}
377
378 def test_parts_common(self):
379 # `parts` returns a tuple
380 sep = self.sep
381 P = self.cls
382 p = P('a/b')
383 parts = p.parts
384 self.assertEqual(parts, ('a', 'b'))
385 # The object gets reused
386 self.assertIs(parts, p.parts)
387 # When the path is absolute, the anchor is a separate part
388 p = P('/a/b')
389 parts = p.parts
390 self.assertEqual(parts, (sep, 'a', 'b'))
391
Brett Cannon568be632016-06-10 12:20:49 -0700392 def test_fspath_common(self):
393 P = self.cls
394 p = P('a/b')
395 self._check_str(p.__fspath__(), ('a/b',))
396 self._check_str(os.fspath(p), ('a/b',))
397
Antoine Pitrou31119e42013-11-22 17:38:12 +0100398 def test_equivalences(self):
399 for k, tuples in self.equivalences.items():
400 canon = k.replace('/', self.sep)
401 posix = k.replace(self.sep, '/')
402 if canon != posix:
403 tuples = tuples + [
404 tuple(part.replace('/', self.sep) for part in t)
405 for t in tuples
406 ]
407 tuples.append((posix, ))
408 pcanon = self.cls(canon)
409 for t in tuples:
410 p = self.cls(*t)
411 self.assertEqual(p, pcanon, "failed with args {}".format(t))
412 self.assertEqual(hash(p), hash(pcanon))
413 self.assertEqual(str(p), canon)
414 self.assertEqual(p.as_posix(), posix)
415
416 def test_parent_common(self):
417 # Relative
418 P = self.cls
419 p = P('a/b/c')
420 self.assertEqual(p.parent, P('a/b'))
421 self.assertEqual(p.parent.parent, P('a'))
422 self.assertEqual(p.parent.parent.parent, P())
423 self.assertEqual(p.parent.parent.parent.parent, P())
424 # Anchored
425 p = P('/a/b/c')
426 self.assertEqual(p.parent, P('/a/b'))
427 self.assertEqual(p.parent.parent, P('/a'))
428 self.assertEqual(p.parent.parent.parent, P('/'))
429 self.assertEqual(p.parent.parent.parent.parent, P('/'))
430
431 def test_parents_common(self):
432 # Relative
433 P = self.cls
434 p = P('a/b/c')
435 par = p.parents
436 self.assertEqual(len(par), 3)
437 self.assertEqual(par[0], P('a/b'))
438 self.assertEqual(par[1], P('a'))
439 self.assertEqual(par[2], P('.'))
440 self.assertEqual(list(par), [P('a/b'), P('a'), P('.')])
441 with self.assertRaises(IndexError):
442 par[-1]
443 with self.assertRaises(IndexError):
444 par[3]
445 with self.assertRaises(TypeError):
446 par[0] = p
447 # Anchored
448 p = P('/a/b/c')
449 par = p.parents
450 self.assertEqual(len(par), 3)
451 self.assertEqual(par[0], P('/a/b'))
452 self.assertEqual(par[1], P('/a'))
453 self.assertEqual(par[2], P('/'))
454 self.assertEqual(list(par), [P('/a/b'), P('/a'), P('/')])
455 with self.assertRaises(IndexError):
456 par[3]
457
458 def test_drive_common(self):
459 P = self.cls
460 self.assertEqual(P('a/b').drive, '')
461 self.assertEqual(P('/a/b').drive, '')
462 self.assertEqual(P('').drive, '')
463
464 def test_root_common(self):
465 P = self.cls
466 sep = self.sep
467 self.assertEqual(P('').root, '')
468 self.assertEqual(P('a/b').root, '')
469 self.assertEqual(P('/').root, sep)
470 self.assertEqual(P('/a/b').root, sep)
471
472 def test_anchor_common(self):
473 P = self.cls
474 sep = self.sep
475 self.assertEqual(P('').anchor, '')
476 self.assertEqual(P('a/b').anchor, '')
477 self.assertEqual(P('/').anchor, sep)
478 self.assertEqual(P('/a/b').anchor, sep)
479
480 def test_name_common(self):
481 P = self.cls
482 self.assertEqual(P('').name, '')
483 self.assertEqual(P('.').name, '')
484 self.assertEqual(P('/').name, '')
485 self.assertEqual(P('a/b').name, 'b')
486 self.assertEqual(P('/a/b').name, 'b')
487 self.assertEqual(P('/a/b/.').name, 'b')
488 self.assertEqual(P('a/b.py').name, 'b.py')
489 self.assertEqual(P('/a/b.py').name, 'b.py')
490
491 def test_suffix_common(self):
492 P = self.cls
493 self.assertEqual(P('').suffix, '')
494 self.assertEqual(P('.').suffix, '')
495 self.assertEqual(P('..').suffix, '')
496 self.assertEqual(P('/').suffix, '')
497 self.assertEqual(P('a/b').suffix, '')
498 self.assertEqual(P('/a/b').suffix, '')
499 self.assertEqual(P('/a/b/.').suffix, '')
500 self.assertEqual(P('a/b.py').suffix, '.py')
501 self.assertEqual(P('/a/b.py').suffix, '.py')
502 self.assertEqual(P('a/.hgrc').suffix, '')
503 self.assertEqual(P('/a/.hgrc').suffix, '')
504 self.assertEqual(P('a/.hg.rc').suffix, '.rc')
505 self.assertEqual(P('/a/.hg.rc').suffix, '.rc')
506 self.assertEqual(P('a/b.tar.gz').suffix, '.gz')
507 self.assertEqual(P('/a/b.tar.gz').suffix, '.gz')
508 self.assertEqual(P('a/Some name. Ending with a dot.').suffix, '')
509 self.assertEqual(P('/a/Some name. Ending with a dot.').suffix, '')
510
511 def test_suffixes_common(self):
512 P = self.cls
513 self.assertEqual(P('').suffixes, [])
514 self.assertEqual(P('.').suffixes, [])
515 self.assertEqual(P('/').suffixes, [])
516 self.assertEqual(P('a/b').suffixes, [])
517 self.assertEqual(P('/a/b').suffixes, [])
518 self.assertEqual(P('/a/b/.').suffixes, [])
519 self.assertEqual(P('a/b.py').suffixes, ['.py'])
520 self.assertEqual(P('/a/b.py').suffixes, ['.py'])
521 self.assertEqual(P('a/.hgrc').suffixes, [])
522 self.assertEqual(P('/a/.hgrc').suffixes, [])
523 self.assertEqual(P('a/.hg.rc').suffixes, ['.rc'])
524 self.assertEqual(P('/a/.hg.rc').suffixes, ['.rc'])
525 self.assertEqual(P('a/b.tar.gz').suffixes, ['.tar', '.gz'])
526 self.assertEqual(P('/a/b.tar.gz').suffixes, ['.tar', '.gz'])
527 self.assertEqual(P('a/Some name. Ending with a dot.').suffixes, [])
528 self.assertEqual(P('/a/Some name. Ending with a dot.').suffixes, [])
529
530 def test_stem_common(self):
531 P = self.cls
532 self.assertEqual(P('').stem, '')
533 self.assertEqual(P('.').stem, '')
534 self.assertEqual(P('..').stem, '..')
535 self.assertEqual(P('/').stem, '')
536 self.assertEqual(P('a/b').stem, 'b')
537 self.assertEqual(P('a/b.py').stem, 'b')
538 self.assertEqual(P('a/.hgrc').stem, '.hgrc')
539 self.assertEqual(P('a/.hg.rc').stem, '.hg')
540 self.assertEqual(P('a/b.tar.gz').stem, 'b.tar')
541 self.assertEqual(P('a/Some name. Ending with a dot.').stem,
542 'Some name. Ending with a dot.')
543
544 def test_with_name_common(self):
545 P = self.cls
546 self.assertEqual(P('a/b').with_name('d.xml'), P('a/d.xml'))
547 self.assertEqual(P('/a/b').with_name('d.xml'), P('/a/d.xml'))
548 self.assertEqual(P('a/b.py').with_name('d.xml'), P('a/d.xml'))
549 self.assertEqual(P('/a/b.py').with_name('d.xml'), P('/a/d.xml'))
550 self.assertEqual(P('a/Dot ending.').with_name('d.xml'), P('a/d.xml'))
551 self.assertEqual(P('/a/Dot ending.').with_name('d.xml'), P('/a/d.xml'))
552 self.assertRaises(ValueError, P('').with_name, 'd.xml')
553 self.assertRaises(ValueError, P('.').with_name, 'd.xml')
554 self.assertRaises(ValueError, P('/').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400555 self.assertRaises(ValueError, P('a/b').with_name, '')
556 self.assertRaises(ValueError, P('a/b').with_name, '/c')
557 self.assertRaises(ValueError, P('a/b').with_name, 'c/')
558 self.assertRaises(ValueError, P('a/b').with_name, 'c/d')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100559
560 def test_with_suffix_common(self):
561 P = self.cls
562 self.assertEqual(P('a/b').with_suffix('.gz'), P('a/b.gz'))
563 self.assertEqual(P('/a/b').with_suffix('.gz'), P('/a/b.gz'))
564 self.assertEqual(P('a/b.py').with_suffix('.gz'), P('a/b.gz'))
565 self.assertEqual(P('/a/b.py').with_suffix('.gz'), P('/a/b.gz'))
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400566 # Stripping suffix
567 self.assertEqual(P('a/b.py').with_suffix(''), P('a/b'))
568 self.assertEqual(P('/a/b').with_suffix(''), P('/a/b'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100569 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +0100570 self.assertRaises(ValueError, P('').with_suffix, '.gz')
571 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
572 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100573 # Invalid suffix
574 self.assertRaises(ValueError, P('a/b').with_suffix, 'gz')
575 self.assertRaises(ValueError, P('a/b').with_suffix, '/')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400576 self.assertRaises(ValueError, P('a/b').with_suffix, '.')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100577 self.assertRaises(ValueError, P('a/b').with_suffix, '/.gz')
578 self.assertRaises(ValueError, P('a/b').with_suffix, 'c/d')
579 self.assertRaises(ValueError, P('a/b').with_suffix, '.c/.d')
Antoine Pitroue50dafc2014-07-06 21:37:15 -0400580 self.assertRaises(ValueError, P('a/b').with_suffix, './.d')
581 self.assertRaises(ValueError, P('a/b').with_suffix, '.d/.')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100582
583 def test_relative_to_common(self):
584 P = self.cls
585 p = P('a/b')
586 self.assertRaises(TypeError, p.relative_to)
Antoine Pitrou156b3612013-12-28 19:49:04 +0100587 self.assertRaises(TypeError, p.relative_to, b'a')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100588 self.assertEqual(p.relative_to(P()), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100589 self.assertEqual(p.relative_to(''), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100590 self.assertEqual(p.relative_to(P('a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100591 self.assertEqual(p.relative_to('a'), P('b'))
592 self.assertEqual(p.relative_to('a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100593 self.assertEqual(p.relative_to(P('a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100594 self.assertEqual(p.relative_to('a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100595 # With several args
596 self.assertEqual(p.relative_to('a', 'b'), P())
597 # Unrelated paths
598 self.assertRaises(ValueError, p.relative_to, P('c'))
599 self.assertRaises(ValueError, p.relative_to, P('a/b/c'))
600 self.assertRaises(ValueError, p.relative_to, P('a/c'))
601 self.assertRaises(ValueError, p.relative_to, P('/a'))
602 p = P('/a/b')
603 self.assertEqual(p.relative_to(P('/')), P('a/b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100604 self.assertEqual(p.relative_to('/'), P('a/b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100605 self.assertEqual(p.relative_to(P('/a')), P('b'))
Antoine Pitrou156b3612013-12-28 19:49:04 +0100606 self.assertEqual(p.relative_to('/a'), P('b'))
607 self.assertEqual(p.relative_to('/a/'), P('b'))
Antoine Pitrou31119e42013-11-22 17:38:12 +0100608 self.assertEqual(p.relative_to(P('/a/b')), P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100609 self.assertEqual(p.relative_to('/a/b'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +0100610 # Unrelated paths
611 self.assertRaises(ValueError, p.relative_to, P('/c'))
612 self.assertRaises(ValueError, p.relative_to, P('/a/b/c'))
613 self.assertRaises(ValueError, p.relative_to, P('/a/c'))
614 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +0100615 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100616 self.assertRaises(ValueError, p.relative_to, P('a'))
617
618 def test_pickling_common(self):
619 P = self.cls
620 p = P('/a/b')
621 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
622 dumped = pickle.dumps(p, proto)
623 pp = pickle.loads(dumped)
624 self.assertIs(pp.__class__, p.__class__)
625 self.assertEqual(pp, p)
626 self.assertEqual(hash(pp), hash(p))
627 self.assertEqual(str(pp), str(p))
628
629
630class PurePosixPathTest(_BasePurePathTest, unittest.TestCase):
631 cls = pathlib.PurePosixPath
632
633 def test_root(self):
634 P = self.cls
635 self.assertEqual(P('/a/b').root, '/')
636 self.assertEqual(P('///a/b').root, '/')
637 # POSIX special case for two leading slashes
638 self.assertEqual(P('//a/b').root, '//')
639
640 def test_eq(self):
641 P = self.cls
642 self.assertNotEqual(P('a/b'), P('A/b'))
643 self.assertEqual(P('/a'), P('///a'))
644 self.assertNotEqual(P('/a'), P('//a'))
645
646 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100647 P = self.cls
648 self.assertEqual(P('/').as_uri(), 'file:///')
649 self.assertEqual(P('/a/b.c').as_uri(), 'file:///a/b.c')
650 self.assertEqual(P('/a/b%#c').as_uri(), 'file:///a/b%25%23c')
Antoine Pitrou29eac422013-11-22 17:57:03 +0100651
652 def test_as_uri_non_ascii(self):
653 from urllib.parse import quote_from_bytes
654 P = self.cls
655 try:
656 os.fsencode('\xe9')
657 except UnicodeEncodeError:
658 self.skipTest("\\xe9 cannot be encoded to the filesystem encoding")
Antoine Pitrou31119e42013-11-22 17:38:12 +0100659 self.assertEqual(P('/a/b\xe9').as_uri(),
660 'file:///a/b' + quote_from_bytes(os.fsencode('\xe9')))
661
662 def test_match(self):
663 P = self.cls
664 self.assertFalse(P('A.py').match('a.PY'))
665
666 def test_is_absolute(self):
667 P = self.cls
668 self.assertFalse(P().is_absolute())
669 self.assertFalse(P('a').is_absolute())
670 self.assertFalse(P('a/b/').is_absolute())
671 self.assertTrue(P('/').is_absolute())
672 self.assertTrue(P('/a').is_absolute())
673 self.assertTrue(P('/a/b/').is_absolute())
674 self.assertTrue(P('//a').is_absolute())
675 self.assertTrue(P('//a/b').is_absolute())
676
677 def test_is_reserved(self):
678 P = self.cls
679 self.assertIs(False, P('').is_reserved())
680 self.assertIs(False, P('/').is_reserved())
681 self.assertIs(False, P('/foo/bar').is_reserved())
682 self.assertIs(False, P('/dev/con/PRN/NUL').is_reserved())
683
684 def test_join(self):
685 P = self.cls
686 p = P('//a')
687 pp = p.joinpath('b')
688 self.assertEqual(pp, P('//a/b'))
689 pp = P('/a').joinpath('//c')
690 self.assertEqual(pp, P('//c'))
691 pp = P('//a').joinpath('/c')
692 self.assertEqual(pp, P('/c'))
693
694 def test_div(self):
695 # Basically the same as joinpath()
696 P = self.cls
697 p = P('//a')
698 pp = p / 'b'
699 self.assertEqual(pp, P('//a/b'))
700 pp = P('/a') / '//c'
701 self.assertEqual(pp, P('//c'))
702 pp = P('//a') / '/c'
703 self.assertEqual(pp, P('/c'))
704
705
706class PureWindowsPathTest(_BasePurePathTest, unittest.TestCase):
707 cls = pathlib.PureWindowsPath
708
709 equivalences = _BasePurePathTest.equivalences.copy()
710 equivalences.update({
711 'c:a': [ ('c:', 'a'), ('c:', 'a/'), ('/', 'c:', 'a') ],
712 'c:/a': [
713 ('c:/', 'a'), ('c:', '/', 'a'), ('c:', '/a'),
714 ('/z', 'c:/', 'a'), ('//x/y', 'c:/', 'a'),
715 ],
716 '//a/b/': [ ('//a/b',) ],
717 '//a/b/c': [
718 ('//a/b', 'c'), ('//a/b/', 'c'),
719 ],
720 })
721
722 def test_str(self):
723 p = self.cls('a/b/c')
724 self.assertEqual(str(p), 'a\\b\\c')
725 p = self.cls('c:/a/b/c')
726 self.assertEqual(str(p), 'c:\\a\\b\\c')
727 p = self.cls('//a/b')
728 self.assertEqual(str(p), '\\\\a\\b\\')
729 p = self.cls('//a/b/c')
730 self.assertEqual(str(p), '\\\\a\\b\\c')
731 p = self.cls('//a/b/c/d')
732 self.assertEqual(str(p), '\\\\a\\b\\c\\d')
733
Antoine Pitroucb5ec772014-04-23 00:34:15 +0200734 def test_str_subclass(self):
735 self._check_str_subclass('c:')
736 self._check_str_subclass('c:a')
737 self._check_str_subclass('c:a\\b.txt')
738 self._check_str_subclass('c:\\')
739 self._check_str_subclass('c:\\a')
740 self._check_str_subclass('c:\\a\\b.txt')
741 self._check_str_subclass('\\\\some\\share')
742 self._check_str_subclass('\\\\some\\share\\a')
743 self._check_str_subclass('\\\\some\\share\\a\\b.txt')
744
Antoine Pitrou31119e42013-11-22 17:38:12 +0100745 def test_eq(self):
746 P = self.cls
747 self.assertEqual(P('c:a/b'), P('c:a/b'))
748 self.assertEqual(P('c:a/b'), P('c:', 'a', 'b'))
749 self.assertNotEqual(P('c:a/b'), P('d:a/b'))
750 self.assertNotEqual(P('c:a/b'), P('c:/a/b'))
751 self.assertNotEqual(P('/a/b'), P('c:/a/b'))
752 # Case-insensitivity
753 self.assertEqual(P('a/B'), P('A/b'))
754 self.assertEqual(P('C:a/B'), P('c:A/b'))
755 self.assertEqual(P('//Some/SHARE/a/B'), P('//somE/share/A/b'))
756
757 def test_as_uri(self):
Antoine Pitrou31119e42013-11-22 17:38:12 +0100758 P = self.cls
759 with self.assertRaises(ValueError):
760 P('/a/b').as_uri()
761 with self.assertRaises(ValueError):
762 P('c:a/b').as_uri()
763 self.assertEqual(P('c:/').as_uri(), 'file:///c:/')
764 self.assertEqual(P('c:/a/b.c').as_uri(), 'file:///c:/a/b.c')
765 self.assertEqual(P('c:/a/b%#c').as_uri(), 'file:///c:/a/b%25%23c')
766 self.assertEqual(P('c:/a/b\xe9').as_uri(), 'file:///c:/a/b%C3%A9')
767 self.assertEqual(P('//some/share/').as_uri(), 'file://some/share/')
768 self.assertEqual(P('//some/share/a/b.c').as_uri(),
769 'file://some/share/a/b.c')
770 self.assertEqual(P('//some/share/a/b%#c\xe9').as_uri(),
771 'file://some/share/a/b%25%23c%C3%A9')
772
773 def test_match_common(self):
774 P = self.cls
775 # Absolute patterns
776 self.assertTrue(P('c:/b.py').match('/*.py'))
777 self.assertTrue(P('c:/b.py').match('c:*.py'))
778 self.assertTrue(P('c:/b.py').match('c:/*.py'))
779 self.assertFalse(P('d:/b.py').match('c:/*.py')) # wrong drive
780 self.assertFalse(P('b.py').match('/*.py'))
781 self.assertFalse(P('b.py').match('c:*.py'))
782 self.assertFalse(P('b.py').match('c:/*.py'))
783 self.assertFalse(P('c:b.py').match('/*.py'))
784 self.assertFalse(P('c:b.py').match('c:/*.py'))
785 self.assertFalse(P('/b.py').match('c:*.py'))
786 self.assertFalse(P('/b.py').match('c:/*.py'))
787 # UNC patterns
788 self.assertTrue(P('//some/share/a.py').match('/*.py'))
789 self.assertTrue(P('//some/share/a.py').match('//some/share/*.py'))
790 self.assertFalse(P('//other/share/a.py').match('//some/share/*.py'))
791 self.assertFalse(P('//some/share/a/b.py').match('//some/share/*.py'))
792 # Case-insensitivity
793 self.assertTrue(P('B.py').match('b.PY'))
794 self.assertTrue(P('c:/a/B.Py').match('C:/A/*.pY'))
795 self.assertTrue(P('//Some/Share/B.Py').match('//somE/sharE/*.pY'))
796
797 def test_ordering_common(self):
798 # Case-insensitivity
799 def assertOrderedEqual(a, b):
800 self.assertLessEqual(a, b)
801 self.assertGreaterEqual(b, a)
802 P = self.cls
803 p = P('c:A/b')
804 q = P('C:a/B')
805 assertOrderedEqual(p, q)
806 self.assertFalse(p < q)
807 self.assertFalse(p > q)
808 p = P('//some/Share/A/b')
809 q = P('//Some/SHARE/a/B')
810 assertOrderedEqual(p, q)
811 self.assertFalse(p < q)
812 self.assertFalse(p > q)
813
814 def test_parts(self):
815 P = self.cls
816 p = P('c:a/b')
817 parts = p.parts
818 self.assertEqual(parts, ('c:', 'a', 'b'))
819 p = P('c:/a/b')
820 parts = p.parts
821 self.assertEqual(parts, ('c:\\', 'a', 'b'))
822 p = P('//a/b/c/d')
823 parts = p.parts
824 self.assertEqual(parts, ('\\\\a\\b\\', 'c', 'd'))
825
826 def test_parent(self):
827 # Anchored
828 P = self.cls
829 p = P('z:a/b/c')
830 self.assertEqual(p.parent, P('z:a/b'))
831 self.assertEqual(p.parent.parent, P('z:a'))
832 self.assertEqual(p.parent.parent.parent, P('z:'))
833 self.assertEqual(p.parent.parent.parent.parent, P('z:'))
834 p = P('z:/a/b/c')
835 self.assertEqual(p.parent, P('z:/a/b'))
836 self.assertEqual(p.parent.parent, P('z:/a'))
837 self.assertEqual(p.parent.parent.parent, P('z:/'))
838 self.assertEqual(p.parent.parent.parent.parent, P('z:/'))
839 p = P('//a/b/c/d')
840 self.assertEqual(p.parent, P('//a/b/c'))
841 self.assertEqual(p.parent.parent, P('//a/b'))
842 self.assertEqual(p.parent.parent.parent, P('//a/b'))
843
844 def test_parents(self):
845 # Anchored
846 P = self.cls
847 p = P('z:a/b/')
848 par = p.parents
849 self.assertEqual(len(par), 2)
850 self.assertEqual(par[0], P('z:a'))
851 self.assertEqual(par[1], P('z:'))
852 self.assertEqual(list(par), [P('z:a'), P('z:')])
853 with self.assertRaises(IndexError):
854 par[2]
855 p = P('z:/a/b/')
856 par = p.parents
857 self.assertEqual(len(par), 2)
858 self.assertEqual(par[0], P('z:/a'))
859 self.assertEqual(par[1], P('z:/'))
860 self.assertEqual(list(par), [P('z:/a'), P('z:/')])
861 with self.assertRaises(IndexError):
862 par[2]
863 p = P('//a/b/c/d')
864 par = p.parents
865 self.assertEqual(len(par), 2)
866 self.assertEqual(par[0], P('//a/b/c'))
867 self.assertEqual(par[1], P('//a/b'))
868 self.assertEqual(list(par), [P('//a/b/c'), P('//a/b')])
869 with self.assertRaises(IndexError):
870 par[2]
871
872 def test_drive(self):
873 P = self.cls
874 self.assertEqual(P('c:').drive, 'c:')
875 self.assertEqual(P('c:a/b').drive, 'c:')
876 self.assertEqual(P('c:/').drive, 'c:')
877 self.assertEqual(P('c:/a/b/').drive, 'c:')
878 self.assertEqual(P('//a/b').drive, '\\\\a\\b')
879 self.assertEqual(P('//a/b/').drive, '\\\\a\\b')
880 self.assertEqual(P('//a/b/c/d').drive, '\\\\a\\b')
881
882 def test_root(self):
883 P = self.cls
884 self.assertEqual(P('c:').root, '')
885 self.assertEqual(P('c:a/b').root, '')
886 self.assertEqual(P('c:/').root, '\\')
887 self.assertEqual(P('c:/a/b/').root, '\\')
888 self.assertEqual(P('//a/b').root, '\\')
889 self.assertEqual(P('//a/b/').root, '\\')
890 self.assertEqual(P('//a/b/c/d').root, '\\')
891
892 def test_anchor(self):
893 P = self.cls
894 self.assertEqual(P('c:').anchor, 'c:')
895 self.assertEqual(P('c:a/b').anchor, 'c:')
896 self.assertEqual(P('c:/').anchor, 'c:\\')
897 self.assertEqual(P('c:/a/b/').anchor, 'c:\\')
898 self.assertEqual(P('//a/b').anchor, '\\\\a\\b\\')
899 self.assertEqual(P('//a/b/').anchor, '\\\\a\\b\\')
900 self.assertEqual(P('//a/b/c/d').anchor, '\\\\a\\b\\')
901
902 def test_name(self):
903 P = self.cls
904 self.assertEqual(P('c:').name, '')
905 self.assertEqual(P('c:/').name, '')
906 self.assertEqual(P('c:a/b').name, 'b')
907 self.assertEqual(P('c:/a/b').name, 'b')
908 self.assertEqual(P('c:a/b.py').name, 'b.py')
909 self.assertEqual(P('c:/a/b.py').name, 'b.py')
910 self.assertEqual(P('//My.py/Share.php').name, '')
911 self.assertEqual(P('//My.py/Share.php/a/b').name, 'b')
912
913 def test_suffix(self):
914 P = self.cls
915 self.assertEqual(P('c:').suffix, '')
916 self.assertEqual(P('c:/').suffix, '')
917 self.assertEqual(P('c:a/b').suffix, '')
918 self.assertEqual(P('c:/a/b').suffix, '')
919 self.assertEqual(P('c:a/b.py').suffix, '.py')
920 self.assertEqual(P('c:/a/b.py').suffix, '.py')
921 self.assertEqual(P('c:a/.hgrc').suffix, '')
922 self.assertEqual(P('c:/a/.hgrc').suffix, '')
923 self.assertEqual(P('c:a/.hg.rc').suffix, '.rc')
924 self.assertEqual(P('c:/a/.hg.rc').suffix, '.rc')
925 self.assertEqual(P('c:a/b.tar.gz').suffix, '.gz')
926 self.assertEqual(P('c:/a/b.tar.gz').suffix, '.gz')
927 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffix, '')
928 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffix, '')
929 self.assertEqual(P('//My.py/Share.php').suffix, '')
930 self.assertEqual(P('//My.py/Share.php/a/b').suffix, '')
931
932 def test_suffixes(self):
933 P = self.cls
934 self.assertEqual(P('c:').suffixes, [])
935 self.assertEqual(P('c:/').suffixes, [])
936 self.assertEqual(P('c:a/b').suffixes, [])
937 self.assertEqual(P('c:/a/b').suffixes, [])
938 self.assertEqual(P('c:a/b.py').suffixes, ['.py'])
939 self.assertEqual(P('c:/a/b.py').suffixes, ['.py'])
940 self.assertEqual(P('c:a/.hgrc').suffixes, [])
941 self.assertEqual(P('c:/a/.hgrc').suffixes, [])
942 self.assertEqual(P('c:a/.hg.rc').suffixes, ['.rc'])
943 self.assertEqual(P('c:/a/.hg.rc').suffixes, ['.rc'])
944 self.assertEqual(P('c:a/b.tar.gz').suffixes, ['.tar', '.gz'])
945 self.assertEqual(P('c:/a/b.tar.gz').suffixes, ['.tar', '.gz'])
946 self.assertEqual(P('//My.py/Share.php').suffixes, [])
947 self.assertEqual(P('//My.py/Share.php/a/b').suffixes, [])
948 self.assertEqual(P('c:a/Some name. Ending with a dot.').suffixes, [])
949 self.assertEqual(P('c:/a/Some name. Ending with a dot.').suffixes, [])
950
951 def test_stem(self):
952 P = self.cls
953 self.assertEqual(P('c:').stem, '')
954 self.assertEqual(P('c:.').stem, '')
955 self.assertEqual(P('c:..').stem, '..')
956 self.assertEqual(P('c:/').stem, '')
957 self.assertEqual(P('c:a/b').stem, 'b')
958 self.assertEqual(P('c:a/b.py').stem, 'b')
959 self.assertEqual(P('c:a/.hgrc').stem, '.hgrc')
960 self.assertEqual(P('c:a/.hg.rc').stem, '.hg')
961 self.assertEqual(P('c:a/b.tar.gz').stem, 'b.tar')
962 self.assertEqual(P('c:a/Some name. Ending with a dot.').stem,
963 'Some name. Ending with a dot.')
964
965 def test_with_name(self):
966 P = self.cls
967 self.assertEqual(P('c:a/b').with_name('d.xml'), P('c:a/d.xml'))
968 self.assertEqual(P('c:/a/b').with_name('d.xml'), P('c:/a/d.xml'))
969 self.assertEqual(P('c:a/Dot ending.').with_name('d.xml'), P('c:a/d.xml'))
970 self.assertEqual(P('c:/a/Dot ending.').with_name('d.xml'), P('c:/a/d.xml'))
971 self.assertRaises(ValueError, P('c:').with_name, 'd.xml')
972 self.assertRaises(ValueError, P('c:/').with_name, 'd.xml')
973 self.assertRaises(ValueError, P('//My/Share').with_name, 'd.xml')
Antoine Pitrou7084e732014-07-06 21:31:12 -0400974 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:')
975 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:e')
976 self.assertRaises(ValueError, P('c:a/b').with_name, 'd:/e')
977 self.assertRaises(ValueError, P('c:a/b').with_name, '//My/Share')
Antoine Pitrou31119e42013-11-22 17:38:12 +0100978
979 def test_with_suffix(self):
980 P = self.cls
981 self.assertEqual(P('c:a/b').with_suffix('.gz'), P('c:a/b.gz'))
982 self.assertEqual(P('c:/a/b').with_suffix('.gz'), P('c:/a/b.gz'))
983 self.assertEqual(P('c:a/b.py').with_suffix('.gz'), P('c:a/b.gz'))
984 self.assertEqual(P('c:/a/b.py').with_suffix('.gz'), P('c:/a/b.gz'))
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100985 # Path doesn't have a "filename" component
Antoine Pitrou31119e42013-11-22 17:38:12 +0100986 self.assertRaises(ValueError, P('').with_suffix, '.gz')
987 self.assertRaises(ValueError, P('.').with_suffix, '.gz')
988 self.assertRaises(ValueError, P('/').with_suffix, '.gz')
989 self.assertRaises(ValueError, P('//My/Share').with_suffix, '.gz')
Antoine Pitrou1b02da92014-01-03 00:07:17 +0100990 # Invalid suffix
991 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'gz')
992 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/')
993 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\')
994 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:')
995 self.assertRaises(ValueError, P('c:a/b').with_suffix, '/.gz')
996 self.assertRaises(ValueError, P('c:a/b').with_suffix, '\\.gz')
997 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c:.gz')
998 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c/d')
999 self.assertRaises(ValueError, P('c:a/b').with_suffix, 'c\\d')
1000 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c/d')
1001 self.assertRaises(ValueError, P('c:a/b').with_suffix, '.c\\d')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001002
1003 def test_relative_to(self):
1004 P = self.cls
Antoine Pitrou156b3612013-12-28 19:49:04 +01001005 p = P('C:Foo/Bar')
1006 self.assertEqual(p.relative_to(P('c:')), P('Foo/Bar'))
1007 self.assertEqual(p.relative_to('c:'), P('Foo/Bar'))
1008 self.assertEqual(p.relative_to(P('c:foO')), P('Bar'))
1009 self.assertEqual(p.relative_to('c:foO'), P('Bar'))
1010 self.assertEqual(p.relative_to('c:foO/'), P('Bar'))
1011 self.assertEqual(p.relative_to(P('c:foO/baR')), P())
1012 self.assertEqual(p.relative_to('c:foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001013 # Unrelated paths
1014 self.assertRaises(ValueError, p.relative_to, P())
Antoine Pitrou156b3612013-12-28 19:49:04 +01001015 self.assertRaises(ValueError, p.relative_to, '')
Antoine Pitrou31119e42013-11-22 17:38:12 +01001016 self.assertRaises(ValueError, p.relative_to, P('d:'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001017 self.assertRaises(ValueError, p.relative_to, P('/'))
1018 self.assertRaises(ValueError, p.relative_to, P('Foo'))
1019 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1020 self.assertRaises(ValueError, p.relative_to, P('C:/Foo'))
1021 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Bar/Baz'))
1022 self.assertRaises(ValueError, p.relative_to, P('C:Foo/Baz'))
1023 p = P('C:/Foo/Bar')
1024 self.assertEqual(p.relative_to(P('c:')), P('/Foo/Bar'))
1025 self.assertEqual(p.relative_to('c:'), P('/Foo/Bar'))
1026 self.assertEqual(str(p.relative_to(P('c:'))), '\\Foo\\Bar')
1027 self.assertEqual(str(p.relative_to('c:')), '\\Foo\\Bar')
1028 self.assertEqual(p.relative_to(P('c:/')), P('Foo/Bar'))
1029 self.assertEqual(p.relative_to('c:/'), P('Foo/Bar'))
1030 self.assertEqual(p.relative_to(P('c:/foO')), P('Bar'))
1031 self.assertEqual(p.relative_to('c:/foO'), P('Bar'))
1032 self.assertEqual(p.relative_to('c:/foO/'), P('Bar'))
1033 self.assertEqual(p.relative_to(P('c:/foO/baR')), P())
1034 self.assertEqual(p.relative_to('c:/foO/baR'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001035 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001036 self.assertRaises(ValueError, p.relative_to, P('C:/Baz'))
1037 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Bar/Baz'))
1038 self.assertRaises(ValueError, p.relative_to, P('C:/Foo/Baz'))
1039 self.assertRaises(ValueError, p.relative_to, P('C:Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001040 self.assertRaises(ValueError, p.relative_to, P('d:'))
1041 self.assertRaises(ValueError, p.relative_to, P('d:/'))
Antoine Pitrou156b3612013-12-28 19:49:04 +01001042 self.assertRaises(ValueError, p.relative_to, P('/'))
1043 self.assertRaises(ValueError, p.relative_to, P('/Foo'))
1044 self.assertRaises(ValueError, p.relative_to, P('//C/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001045 # UNC paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001046 p = P('//Server/Share/Foo/Bar')
1047 self.assertEqual(p.relative_to(P('//sErver/sHare')), P('Foo/Bar'))
1048 self.assertEqual(p.relative_to('//sErver/sHare'), P('Foo/Bar'))
1049 self.assertEqual(p.relative_to('//sErver/sHare/'), P('Foo/Bar'))
1050 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo')), P('Bar'))
1051 self.assertEqual(p.relative_to('//sErver/sHare/Foo'), P('Bar'))
1052 self.assertEqual(p.relative_to('//sErver/sHare/Foo/'), P('Bar'))
1053 self.assertEqual(p.relative_to(P('//sErver/sHare/Foo/Bar')), P())
1054 self.assertEqual(p.relative_to('//sErver/sHare/Foo/Bar'), P())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001055 # Unrelated paths
Antoine Pitrou156b3612013-12-28 19:49:04 +01001056 self.assertRaises(ValueError, p.relative_to, P('/Server/Share/Foo'))
1057 self.assertRaises(ValueError, p.relative_to, P('c:/Server/Share/Foo'))
1058 self.assertRaises(ValueError, p.relative_to, P('//z/Share/Foo'))
1059 self.assertRaises(ValueError, p.relative_to, P('//Server/z/Foo'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001060
1061 def test_is_absolute(self):
1062 P = self.cls
1063 # Under NT, only paths with both a drive and a root are absolute
1064 self.assertFalse(P().is_absolute())
1065 self.assertFalse(P('a').is_absolute())
1066 self.assertFalse(P('a/b/').is_absolute())
1067 self.assertFalse(P('/').is_absolute())
1068 self.assertFalse(P('/a').is_absolute())
1069 self.assertFalse(P('/a/b/').is_absolute())
1070 self.assertFalse(P('c:').is_absolute())
1071 self.assertFalse(P('c:a').is_absolute())
1072 self.assertFalse(P('c:a/b/').is_absolute())
1073 self.assertTrue(P('c:/').is_absolute())
1074 self.assertTrue(P('c:/a').is_absolute())
1075 self.assertTrue(P('c:/a/b/').is_absolute())
1076 # UNC paths are absolute by definition
1077 self.assertTrue(P('//a/b').is_absolute())
1078 self.assertTrue(P('//a/b/').is_absolute())
1079 self.assertTrue(P('//a/b/c').is_absolute())
1080 self.assertTrue(P('//a/b/c/d').is_absolute())
1081
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001082 def test_join(self):
1083 P = self.cls
1084 p = P('C:/a/b')
1085 pp = p.joinpath('x/y')
1086 self.assertEqual(pp, P('C:/a/b/x/y'))
1087 pp = p.joinpath('/x/y')
1088 self.assertEqual(pp, P('C:/x/y'))
1089 # Joining with a different drive => the first path is ignored, even
1090 # if the second path is relative.
1091 pp = p.joinpath('D:x/y')
1092 self.assertEqual(pp, P('D:x/y'))
1093 pp = p.joinpath('D:/x/y')
1094 self.assertEqual(pp, P('D:/x/y'))
1095 pp = p.joinpath('//host/share/x/y')
1096 self.assertEqual(pp, P('//host/share/x/y'))
1097 # Joining with the same drive => the first path is appended to if
1098 # the second path is relative.
1099 pp = p.joinpath('c:x/y')
1100 self.assertEqual(pp, P('C:/a/b/x/y'))
1101 pp = p.joinpath('c:/x/y')
1102 self.assertEqual(pp, P('C:/x/y'))
1103
1104 def test_div(self):
1105 # Basically the same as joinpath()
1106 P = self.cls
1107 p = P('C:/a/b')
1108 self.assertEqual(p / 'x/y', P('C:/a/b/x/y'))
1109 self.assertEqual(p / 'x' / 'y', P('C:/a/b/x/y'))
1110 self.assertEqual(p / '/x/y', P('C:/x/y'))
1111 self.assertEqual(p / '/x' / 'y', P('C:/x/y'))
1112 # Joining with a different drive => the first path is ignored, even
1113 # if the second path is relative.
1114 self.assertEqual(p / 'D:x/y', P('D:x/y'))
1115 self.assertEqual(p / 'D:' / 'x/y', P('D:x/y'))
1116 self.assertEqual(p / 'D:/x/y', P('D:/x/y'))
1117 self.assertEqual(p / 'D:' / '/x/y', P('D:/x/y'))
1118 self.assertEqual(p / '//host/share/x/y', P('//host/share/x/y'))
1119 # Joining with the same drive => the first path is appended to if
1120 # the second path is relative.
Serhiy Storchaka010ff582013-12-06 17:25:51 +02001121 self.assertEqual(p / 'c:x/y', P('C:/a/b/x/y'))
1122 self.assertEqual(p / 'c:/x/y', P('C:/x/y'))
Serhiy Storchakaa9939022013-12-06 17:14:12 +02001123
Antoine Pitrou31119e42013-11-22 17:38:12 +01001124 def test_is_reserved(self):
1125 P = self.cls
1126 self.assertIs(False, P('').is_reserved())
1127 self.assertIs(False, P('/').is_reserved())
1128 self.assertIs(False, P('/foo/bar').is_reserved())
1129 self.assertIs(True, P('con').is_reserved())
1130 self.assertIs(True, P('NUL').is_reserved())
1131 self.assertIs(True, P('NUL.txt').is_reserved())
1132 self.assertIs(True, P('com1').is_reserved())
1133 self.assertIs(True, P('com9.bar').is_reserved())
1134 self.assertIs(False, P('bar.com9').is_reserved())
1135 self.assertIs(True, P('lpt1').is_reserved())
1136 self.assertIs(True, P('lpt9.bar').is_reserved())
1137 self.assertIs(False, P('bar.lpt9').is_reserved())
1138 # Only the last component matters
1139 self.assertIs(False, P('c:/NUL/con/baz').is_reserved())
1140 # UNC paths are never reserved
1141 self.assertIs(False, P('//my/share/nul/con/aux').is_reserved())
1142
Antoine Pitrou31119e42013-11-22 17:38:12 +01001143class PurePathTest(_BasePurePathTest, unittest.TestCase):
1144 cls = pathlib.PurePath
1145
1146 def test_concrete_class(self):
1147 p = self.cls('a')
1148 self.assertIs(type(p),
1149 pathlib.PureWindowsPath if os.name == 'nt' else pathlib.PurePosixPath)
1150
1151 def test_different_flavours_unequal(self):
1152 p = pathlib.PurePosixPath('a')
1153 q = pathlib.PureWindowsPath('a')
1154 self.assertNotEqual(p, q)
1155
1156 def test_different_flavours_unordered(self):
1157 p = pathlib.PurePosixPath('a')
1158 q = pathlib.PureWindowsPath('a')
1159 with self.assertRaises(TypeError):
1160 p < q
1161 with self.assertRaises(TypeError):
1162 p <= q
1163 with self.assertRaises(TypeError):
1164 p > q
1165 with self.assertRaises(TypeError):
1166 p >= q
1167
1168
1169#
1170# Tests for the concrete classes
1171#
1172
1173# Make sure any symbolic links in the base test path are resolved
1174BASE = os.path.realpath(TESTFN)
1175join = lambda *x: os.path.join(BASE, *x)
1176rel_join = lambda *x: os.path.join(TESTFN, *x)
1177
1178def symlink_skip_reason():
1179 if not pathlib.supports_symlinks:
1180 return "no system support for symlinks"
1181 try:
1182 os.symlink(__file__, BASE)
1183 except OSError as e:
1184 return str(e)
1185 else:
1186 support.unlink(BASE)
1187 return None
1188
1189symlink_skip_reason = symlink_skip_reason()
1190
1191only_nt = unittest.skipIf(os.name != 'nt',
1192 'test requires a Windows-compatible system')
1193only_posix = unittest.skipIf(os.name == 'nt',
1194 'test requires a POSIX-compatible system')
1195with_symlinks = unittest.skipIf(symlink_skip_reason, symlink_skip_reason)
1196
1197
1198@only_posix
1199class PosixPathAsPureTest(PurePosixPathTest):
1200 cls = pathlib.PosixPath
1201
1202@only_nt
1203class WindowsPathAsPureTest(PureWindowsPathTest):
1204 cls = pathlib.WindowsPath
1205
Victor Stinnerd7569632016-03-11 22:53:00 +01001206 def test_owner(self):
1207 P = self.cls
1208 with self.assertRaises(NotImplementedError):
1209 P('c:/').owner()
1210
1211 def test_group(self):
1212 P = self.cls
1213 with self.assertRaises(NotImplementedError):
1214 P('c:/').group()
1215
Antoine Pitrou31119e42013-11-22 17:38:12 +01001216
1217class _BasePathTest(object):
1218 """Tests for the FS-accessing functionalities of the Path classes."""
1219
1220 # (BASE)
1221 # |
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001222 # |-- brokenLink -> non-existing
1223 # |-- dirA
1224 # | `-- linkC -> ../dirB
1225 # |-- dirB
1226 # | |-- fileB
1227 # | `-- linkD -> ../dirB
1228 # |-- dirC
1229 # | |-- dirD
1230 # | | `-- fileD
1231 # | `-- fileC
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001232 # |-- dirE # No permissions
Antoine Pitrou31119e42013-11-22 17:38:12 +01001233 # |-- fileA
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001234 # |-- linkA -> fileA
1235 # `-- linkB -> dirB
Antoine Pitrou31119e42013-11-22 17:38:12 +01001236 #
1237
1238 def setUp(self):
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001239 def cleanup():
1240 os.chmod(join('dirE'), 0o777)
1241 support.rmtree(BASE)
1242 self.addCleanup(cleanup)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001243 os.mkdir(BASE)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001244 os.mkdir(join('dirA'))
1245 os.mkdir(join('dirB'))
1246 os.mkdir(join('dirC'))
1247 os.mkdir(join('dirC', 'dirD'))
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001248 os.mkdir(join('dirE'))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001249 with open(join('fileA'), 'wb') as f:
1250 f.write(b"this is file A\n")
1251 with open(join('dirB', 'fileB'), 'wb') as f:
1252 f.write(b"this is file B\n")
1253 with open(join('dirC', 'fileC'), 'wb') as f:
1254 f.write(b"this is file C\n")
1255 with open(join('dirC', 'dirD', 'fileD'), 'wb') as f:
1256 f.write(b"this is file D\n")
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001257 os.chmod(join('dirE'), 0)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001258 if not symlink_skip_reason:
Antoine Pitrou31119e42013-11-22 17:38:12 +01001259 # Relative symlinks
1260 os.symlink('fileA', join('linkA'))
1261 os.symlink('non-existing', join('brokenLink'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001262 self.dirlink('dirB', join('linkB'))
1263 self.dirlink(os.path.join('..', 'dirB'), join('dirA', 'linkC'))
Guido van Rossum69bfb152016-01-06 10:31:33 -08001264 # This one goes upwards, creating a loop
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001265 self.dirlink(os.path.join('..', 'dirB'), join('dirB', 'linkD'))
1266
1267 if os.name == 'nt':
1268 # Workaround for http://bugs.python.org/issue13772
1269 def dirlink(self, src, dest):
1270 os.symlink(src, dest, target_is_directory=True)
1271 else:
1272 def dirlink(self, src, dest):
1273 os.symlink(src, dest)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001274
1275 def assertSame(self, path_a, path_b):
1276 self.assertTrue(os.path.samefile(str(path_a), str(path_b)),
1277 "%r and %r don't point to the same file" %
1278 (path_a, path_b))
1279
1280 def assertFileNotFound(self, func, *args, **kwargs):
1281 with self.assertRaises(FileNotFoundError) as cm:
1282 func(*args, **kwargs)
1283 self.assertEqual(cm.exception.errno, errno.ENOENT)
1284
1285 def _test_cwd(self, p):
1286 q = self.cls(os.getcwd())
1287 self.assertEqual(p, q)
1288 self.assertEqual(str(p), str(q))
1289 self.assertIs(type(p), type(q))
1290 self.assertTrue(p.is_absolute())
1291
1292 def test_cwd(self):
1293 p = self.cls.cwd()
1294 self._test_cwd(p)
1295
Antoine Pitrou17cba7d2015-01-12 21:03:41 +01001296 def _test_home(self, p):
1297 q = self.cls(os.path.expanduser('~'))
1298 self.assertEqual(p, q)
1299 self.assertEqual(str(p), str(q))
1300 self.assertIs(type(p), type(q))
1301 self.assertTrue(p.is_absolute())
1302
1303 def test_home(self):
1304 p = self.cls.home()
1305 self._test_home(p)
1306
Antoine Pitrou43e3d942014-05-13 10:50:15 +02001307 def test_samefile(self):
1308 fileA_path = os.path.join(BASE, 'fileA')
1309 fileB_path = os.path.join(BASE, 'dirB', 'fileB')
1310 p = self.cls(fileA_path)
1311 pp = self.cls(fileA_path)
1312 q = self.cls(fileB_path)
1313 self.assertTrue(p.samefile(fileA_path))
1314 self.assertTrue(p.samefile(pp))
1315 self.assertFalse(p.samefile(fileB_path))
1316 self.assertFalse(p.samefile(q))
1317 # Test the non-existent file case
1318 non_existent = os.path.join(BASE, 'foo')
1319 r = self.cls(non_existent)
1320 self.assertRaises(FileNotFoundError, p.samefile, r)
1321 self.assertRaises(FileNotFoundError, p.samefile, non_existent)
1322 self.assertRaises(FileNotFoundError, r.samefile, p)
1323 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1324 self.assertRaises(FileNotFoundError, r.samefile, r)
1325 self.assertRaises(FileNotFoundError, r.samefile, non_existent)
1326
Antoine Pitrou31119e42013-11-22 17:38:12 +01001327 def test_empty_path(self):
1328 # The empty path points to '.'
1329 p = self.cls('')
1330 self.assertEqual(p.stat(), os.stat('.'))
1331
Antoine Pitrou8477ed62014-12-30 20:54:45 +01001332 def test_expanduser_common(self):
1333 P = self.cls
1334 p = P('~')
1335 self.assertEqual(p.expanduser(), P(os.path.expanduser('~')))
1336 p = P('foo')
1337 self.assertEqual(p.expanduser(), p)
1338 p = P('/~')
1339 self.assertEqual(p.expanduser(), p)
1340 p = P('../~')
1341 self.assertEqual(p.expanduser(), p)
1342 p = P(P('').absolute().anchor) / '~'
1343 self.assertEqual(p.expanduser(), p)
1344
Antoine Pitrou31119e42013-11-22 17:38:12 +01001345 def test_exists(self):
1346 P = self.cls
1347 p = P(BASE)
1348 self.assertIs(True, p.exists())
1349 self.assertIs(True, (p / 'dirA').exists())
1350 self.assertIs(True, (p / 'fileA').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001351 self.assertIs(False, (p / 'fileA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001352 if not symlink_skip_reason:
1353 self.assertIs(True, (p / 'linkA').exists())
1354 self.assertIs(True, (p / 'linkB').exists())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001355 self.assertIs(True, (p / 'linkB' / 'fileB').exists())
1356 self.assertIs(False, (p / 'linkA' / 'bah').exists())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001357 self.assertIs(False, (p / 'foo').exists())
1358 self.assertIs(False, P('/xyzzy').exists())
1359
1360 def test_open_common(self):
1361 p = self.cls(BASE)
1362 with (p / 'fileA').open('r') as f:
1363 self.assertIsInstance(f, io.TextIOBase)
1364 self.assertEqual(f.read(), "this is file A\n")
1365 with (p / 'fileA').open('rb') as f:
1366 self.assertIsInstance(f, io.BufferedIOBase)
1367 self.assertEqual(f.read().strip(), b"this is file A")
1368 with (p / 'fileA').open('rb', buffering=0) as f:
1369 self.assertIsInstance(f, io.RawIOBase)
1370 self.assertEqual(f.read().strip(), b"this is file A")
1371
Georg Brandlea683982014-10-01 19:12:33 +02001372 def test_read_write_bytes(self):
1373 p = self.cls(BASE)
1374 (p / 'fileA').write_bytes(b'abcdefg')
1375 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1376 # check that trying to write str does not truncate the file
1377 self.assertRaises(TypeError, (p / 'fileA').write_bytes, 'somestr')
1378 self.assertEqual((p / 'fileA').read_bytes(), b'abcdefg')
1379
1380 def test_read_write_text(self):
1381 p = self.cls(BASE)
1382 (p / 'fileA').write_text('äbcdefg', encoding='latin-1')
1383 self.assertEqual((p / 'fileA').read_text(
1384 encoding='utf-8', errors='ignore'), 'bcdefg')
1385 # check that trying to write bytes does not truncate the file
1386 self.assertRaises(TypeError, (p / 'fileA').write_text, b'somebytes')
1387 self.assertEqual((p / 'fileA').read_text(encoding='latin-1'), 'äbcdefg')
1388
Antoine Pitrou31119e42013-11-22 17:38:12 +01001389 def test_iterdir(self):
1390 P = self.cls
1391 p = P(BASE)
1392 it = p.iterdir()
1393 paths = set(it)
Guido van Rossum6c2d33a2016-01-06 09:42:07 -08001394 expected = ['dirA', 'dirB', 'dirC', 'dirE', 'fileA']
Antoine Pitrou31119e42013-11-22 17:38:12 +01001395 if not symlink_skip_reason:
1396 expected += ['linkA', 'linkB', 'brokenLink']
1397 self.assertEqual(paths, { P(BASE, q) for q in expected })
1398
1399 @with_symlinks
1400 def test_iterdir_symlink(self):
1401 # __iter__ on a symlink to a directory
1402 P = self.cls
1403 p = P(BASE, 'linkB')
1404 paths = set(p.iterdir())
1405 expected = { P(BASE, 'linkB', q) for q in ['fileB', 'linkD'] }
1406 self.assertEqual(paths, expected)
1407
1408 def test_iterdir_nodir(self):
1409 # __iter__ on something that is not a directory
1410 p = self.cls(BASE, 'fileA')
1411 with self.assertRaises(OSError) as cm:
1412 next(p.iterdir())
1413 # ENOENT or EINVAL under Windows, ENOTDIR otherwise
1414 # (see issue #12802)
1415 self.assertIn(cm.exception.errno, (errno.ENOTDIR,
1416 errno.ENOENT, errno.EINVAL))
1417
1418 def test_glob_common(self):
1419 def _check(glob, expected):
1420 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1421 P = self.cls
1422 p = P(BASE)
1423 it = p.glob("fileA")
1424 self.assertIsInstance(it, collections.Iterator)
1425 _check(it, ["fileA"])
1426 _check(p.glob("fileB"), [])
1427 _check(p.glob("dir*/file*"), ["dirB/fileB", "dirC/fileC"])
1428 if symlink_skip_reason:
1429 _check(p.glob("*A"), ['dirA', 'fileA'])
1430 else:
1431 _check(p.glob("*A"), ['dirA', 'fileA', 'linkA'])
1432 if symlink_skip_reason:
1433 _check(p.glob("*B/*"), ['dirB/fileB'])
1434 else:
1435 _check(p.glob("*B/*"), ['dirB/fileB', 'dirB/linkD',
1436 'linkB/fileB', 'linkB/linkD'])
1437 if symlink_skip_reason:
1438 _check(p.glob("*/fileB"), ['dirB/fileB'])
1439 else:
1440 _check(p.glob("*/fileB"), ['dirB/fileB', 'linkB/fileB'])
1441
1442 def test_rglob_common(self):
1443 def _check(glob, expected):
1444 self.assertEqual(set(glob), { P(BASE, q) for q in expected })
1445 P = self.cls
1446 p = P(BASE)
1447 it = p.rglob("fileA")
1448 self.assertIsInstance(it, collections.Iterator)
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001449 _check(it, ["fileA"])
1450 _check(p.rglob("fileB"), ["dirB/fileB"])
1451 _check(p.rglob("*/fileA"), [])
Guido van Rossum9c39b672016-01-07 13:12:34 -08001452 if symlink_skip_reason:
1453 _check(p.rglob("*/fileB"), ["dirB/fileB"])
1454 else:
1455 _check(p.rglob("*/fileB"), ["dirB/fileB", "dirB/linkD/fileB",
1456 "linkB/fileB", "dirA/linkC/fileB"])
Guido van Rossumbc9fdda2016-01-07 10:56:36 -08001457 _check(p.rglob("file*"), ["fileA", "dirB/fileB",
1458 "dirC/fileC", "dirC/dirD/fileD"])
Antoine Pitrou31119e42013-11-22 17:38:12 +01001459 p = P(BASE, "dirC")
1460 _check(p.rglob("file*"), ["dirC/fileC", "dirC/dirD/fileD"])
1461 _check(p.rglob("*/*"), ["dirC/dirD/fileD"])
1462
Guido van Rossum69bfb152016-01-06 10:31:33 -08001463 @with_symlinks
1464 def test_rglob_symlink_loop(self):
1465 # Don't get fooled by symlink loops (Issue #26012)
1466 P = self.cls
1467 p = P(BASE)
1468 given = set(p.rglob('*'))
1469 expect = {'brokenLink',
1470 'dirA', 'dirA/linkC',
1471 'dirB', 'dirB/fileB', 'dirB/linkD',
1472 'dirC', 'dirC/dirD', 'dirC/dirD/fileD', 'dirC/fileC',
1473 'dirE',
1474 'fileA',
1475 'linkA',
1476 'linkB',
1477 }
1478 self.assertEqual(given, {p / x for x in expect})
1479
Antoine Pitrou31119e42013-11-22 17:38:12 +01001480 def test_glob_dotdot(self):
1481 # ".." is not special in globs
1482 P = self.cls
1483 p = P(BASE)
1484 self.assertEqual(set(p.glob("..")), { P(BASE, "..") })
1485 self.assertEqual(set(p.glob("dirA/../file*")), { P(BASE, "dirA/../fileA") })
1486 self.assertEqual(set(p.glob("../xyzzy")), set())
1487
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001488
1489 def _check_resolve(self, p, expected):
Antoine Pitrou31119e42013-11-22 17:38:12 +01001490 q = p.resolve()
1491 self.assertEqual(q, expected)
1492
Ezio Melottiac1e7f62015-12-28 23:50:19 +02001493 # this can be used to check both relative and absolute resolutions
1494 _check_resolve_relative = _check_resolve_absolute = _check_resolve
Antoine Pitrou31119e42013-11-22 17:38:12 +01001495
1496 @with_symlinks
1497 def test_resolve_common(self):
1498 P = self.cls
1499 p = P(BASE, 'foo')
1500 with self.assertRaises(OSError) as cm:
1501 p.resolve()
1502 self.assertEqual(cm.exception.errno, errno.ENOENT)
1503 # These are all relative symlinks
1504 p = P(BASE, 'dirB', 'fileB')
1505 self._check_resolve_relative(p, p)
1506 p = P(BASE, 'linkA')
1507 self._check_resolve_relative(p, P(BASE, 'fileA'))
1508 p = P(BASE, 'dirA', 'linkC', 'fileB')
1509 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1510 p = P(BASE, 'dirB', 'linkD', 'fileB')
1511 self._check_resolve_relative(p, P(BASE, 'dirB', 'fileB'))
1512 # Now create absolute symlinks
1513 d = tempfile.mkdtemp(suffix='-dirD')
Victor Stinnerec864692014-07-21 19:19:05 +02001514 self.addCleanup(support.rmtree, d)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001515 os.symlink(os.path.join(d), join('dirA', 'linkX'))
1516 os.symlink(join('dirB'), os.path.join(d, 'linkY'))
1517 p = P(BASE, 'dirA', 'linkX', 'linkY', 'fileB')
1518 self._check_resolve_absolute(p, P(BASE, 'dirB', 'fileB'))
1519
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001520 @with_symlinks
1521 def test_resolve_dot(self):
1522 # See https://bitbucket.org/pitrou/pathlib/issue/9/pathresolve-fails-on-complex-symlinks
1523 p = self.cls(BASE)
1524 self.dirlink('.', join('0'))
Antoine Pitroucc157512013-12-03 17:13:13 +01001525 self.dirlink(os.path.join('0', '0'), join('1'))
1526 self.dirlink(os.path.join('1', '1'), join('2'))
Antoine Pitrou51af82c2013-12-03 11:01:08 +01001527 q = p / '2'
1528 self.assertEqual(q.resolve(), p)
1529
Antoine Pitrou31119e42013-11-22 17:38:12 +01001530 def test_with(self):
1531 p = self.cls(BASE)
1532 it = p.iterdir()
1533 it2 = p.iterdir()
1534 next(it2)
1535 with p:
1536 pass
1537 # I/O operation on closed path
1538 self.assertRaises(ValueError, next, it)
1539 self.assertRaises(ValueError, next, it2)
1540 self.assertRaises(ValueError, p.open)
1541 self.assertRaises(ValueError, p.resolve)
1542 self.assertRaises(ValueError, p.absolute)
1543 self.assertRaises(ValueError, p.__enter__)
1544
1545 def test_chmod(self):
1546 p = self.cls(BASE) / 'fileA'
1547 mode = p.stat().st_mode
1548 # Clear writable bit
1549 new_mode = mode & ~0o222
1550 p.chmod(new_mode)
1551 self.assertEqual(p.stat().st_mode, new_mode)
1552 # Set writable bit
1553 new_mode = mode | 0o222
1554 p.chmod(new_mode)
1555 self.assertEqual(p.stat().st_mode, new_mode)
1556
1557 # XXX also need a test for lchmod
1558
1559 def test_stat(self):
1560 p = self.cls(BASE) / 'fileA'
1561 st = p.stat()
1562 self.assertEqual(p.stat(), st)
1563 # Change file mode by flipping write bit
1564 p.chmod(st.st_mode ^ 0o222)
1565 self.addCleanup(p.chmod, st.st_mode)
1566 self.assertNotEqual(p.stat(), st)
1567
1568 @with_symlinks
1569 def test_lstat(self):
1570 p = self.cls(BASE)/ 'linkA'
1571 st = p.stat()
1572 self.assertNotEqual(st, p.lstat())
1573
1574 def test_lstat_nosymlink(self):
1575 p = self.cls(BASE) / 'fileA'
1576 st = p.stat()
1577 self.assertEqual(st, p.lstat())
1578
1579 @unittest.skipUnless(pwd, "the pwd module is needed for this test")
1580 def test_owner(self):
1581 p = self.cls(BASE) / 'fileA'
1582 uid = p.stat().st_uid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001583 try:
1584 name = pwd.getpwuid(uid).pw_name
1585 except KeyError:
1586 self.skipTest(
1587 "user %d doesn't have an entry in the system database" % uid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001588 self.assertEqual(name, p.owner())
1589
1590 @unittest.skipUnless(grp, "the grp module is needed for this test")
1591 def test_group(self):
1592 p = self.cls(BASE) / 'fileA'
1593 gid = p.stat().st_gid
Antoine Pitrou2cf4b0f2013-11-25 19:51:53 +01001594 try:
1595 name = grp.getgrgid(gid).gr_name
1596 except KeyError:
1597 self.skipTest(
1598 "group %d doesn't have an entry in the system database" % gid)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001599 self.assertEqual(name, p.group())
1600
1601 def test_unlink(self):
1602 p = self.cls(BASE) / 'fileA'
1603 p.unlink()
1604 self.assertFileNotFound(p.stat)
1605 self.assertFileNotFound(p.unlink)
1606
1607 def test_rmdir(self):
1608 p = self.cls(BASE) / 'dirA'
1609 for q in p.iterdir():
1610 q.unlink()
1611 p.rmdir()
1612 self.assertFileNotFound(p.stat)
1613 self.assertFileNotFound(p.unlink)
1614
1615 def test_rename(self):
1616 P = self.cls(BASE)
1617 p = P / 'fileA'
1618 size = p.stat().st_size
1619 # Renaming to another path
1620 q = P / 'dirA' / 'fileAA'
1621 p.rename(q)
1622 self.assertEqual(q.stat().st_size, size)
1623 self.assertFileNotFound(p.stat)
1624 # Renaming to a str of a relative path
1625 r = rel_join('fileAAA')
1626 q.rename(r)
1627 self.assertEqual(os.stat(r).st_size, size)
1628 self.assertFileNotFound(q.stat)
1629
1630 def test_replace(self):
1631 P = self.cls(BASE)
1632 p = P / 'fileA'
1633 size = p.stat().st_size
1634 # Replacing a non-existing path
1635 q = P / 'dirA' / 'fileAA'
1636 p.replace(q)
1637 self.assertEqual(q.stat().st_size, size)
1638 self.assertFileNotFound(p.stat)
1639 # Replacing another (existing) path
1640 r = rel_join('dirB', 'fileB')
1641 q.replace(r)
1642 self.assertEqual(os.stat(r).st_size, size)
1643 self.assertFileNotFound(q.stat)
1644
1645 def test_touch_common(self):
1646 P = self.cls(BASE)
1647 p = P / 'newfileA'
1648 self.assertFalse(p.exists())
1649 p.touch()
1650 self.assertTrue(p.exists())
Antoine Pitrou0f575642013-11-22 23:20:08 +01001651 st = p.stat()
1652 old_mtime = st.st_mtime
1653 old_mtime_ns = st.st_mtime_ns
Antoine Pitrou31119e42013-11-22 17:38:12 +01001654 # Rewind the mtime sufficiently far in the past to work around
1655 # filesystem-specific timestamp granularity.
1656 os.utime(str(p), (old_mtime - 10, old_mtime - 10))
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001657 # The file mtime should be refreshed by calling touch() again
Antoine Pitrou31119e42013-11-22 17:38:12 +01001658 p.touch()
Antoine Pitrou0f575642013-11-22 23:20:08 +01001659 st = p.stat()
Antoine Pitrou2cf39172013-11-23 15:25:59 +01001660 self.assertGreaterEqual(st.st_mtime_ns, old_mtime_ns)
1661 self.assertGreaterEqual(st.st_mtime, old_mtime)
Antoine Pitroubb6694d2013-11-23 01:32:53 +01001662 # Now with exist_ok=False
Antoine Pitrou31119e42013-11-22 17:38:12 +01001663 p = P / 'newfileB'
1664 self.assertFalse(p.exists())
1665 p.touch(mode=0o700, exist_ok=False)
1666 self.assertTrue(p.exists())
1667 self.assertRaises(OSError, p.touch, exist_ok=False)
1668
Antoine Pitrou8b784932013-11-23 14:52:39 +01001669 def test_touch_nochange(self):
1670 P = self.cls(BASE)
1671 p = P / 'fileA'
1672 p.touch()
1673 with p.open('rb') as f:
1674 self.assertEqual(f.read().strip(), b"this is file A")
1675
Antoine Pitrou31119e42013-11-22 17:38:12 +01001676 def test_mkdir(self):
1677 P = self.cls(BASE)
1678 p = P / 'newdirA'
1679 self.assertFalse(p.exists())
1680 p.mkdir()
1681 self.assertTrue(p.exists())
1682 self.assertTrue(p.is_dir())
1683 with self.assertRaises(OSError) as cm:
1684 p.mkdir()
1685 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001686
1687 def test_mkdir_parents(self):
1688 # Creating a chain of directories
1689 p = self.cls(BASE, 'newdirB', 'newdirC')
1690 self.assertFalse(p.exists())
1691 with self.assertRaises(OSError) as cm:
1692 p.mkdir()
1693 self.assertEqual(cm.exception.errno, errno.ENOENT)
1694 p.mkdir(parents=True)
1695 self.assertTrue(p.exists())
1696 self.assertTrue(p.is_dir())
1697 with self.assertRaises(OSError) as cm:
1698 p.mkdir(parents=True)
1699 self.assertEqual(cm.exception.errno, errno.EEXIST)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001700 # test `mode` arg
1701 mode = stat.S_IMODE(p.stat().st_mode) # default mode
1702 p = self.cls(BASE, 'newdirD', 'newdirE')
1703 p.mkdir(0o555, parents=True)
1704 self.assertTrue(p.exists())
1705 self.assertTrue(p.is_dir())
1706 if os.name != 'nt':
1707 # the directory's permissions follow the mode argument
Gregory P. Smithb599c612014-01-20 01:10:33 -08001708 self.assertEqual(stat.S_IMODE(p.stat().st_mode), 0o7555 & mode)
Antoine Pitrou0048c982013-12-16 20:22:37 +01001709 # the parent's permissions follow the default process settings
1710 self.assertEqual(stat.S_IMODE(p.parent.stat().st_mode), mode)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001711
Barry Warsaw7c549c42014-08-05 11:28:12 -04001712 def test_mkdir_exist_ok(self):
1713 p = self.cls(BASE, 'dirB')
1714 st_ctime_first = p.stat().st_ctime
1715 self.assertTrue(p.exists())
1716 self.assertTrue(p.is_dir())
1717 with self.assertRaises(FileExistsError) as cm:
1718 p.mkdir()
1719 self.assertEqual(cm.exception.errno, errno.EEXIST)
1720 p.mkdir(exist_ok=True)
1721 self.assertTrue(p.exists())
1722 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1723
1724 def test_mkdir_exist_ok_with_parent(self):
1725 p = self.cls(BASE, 'dirC')
1726 self.assertTrue(p.exists())
1727 with self.assertRaises(FileExistsError) as cm:
1728 p.mkdir()
1729 self.assertEqual(cm.exception.errno, errno.EEXIST)
1730 p = p / 'newdirC'
1731 p.mkdir(parents=True)
1732 st_ctime_first = p.stat().st_ctime
1733 self.assertTrue(p.exists())
1734 with self.assertRaises(FileExistsError) as cm:
1735 p.mkdir(parents=True)
1736 self.assertEqual(cm.exception.errno, errno.EEXIST)
1737 p.mkdir(parents=True, exist_ok=True)
1738 self.assertTrue(p.exists())
1739 self.assertEqual(p.stat().st_ctime, st_ctime_first)
1740
1741 def test_mkdir_with_child_file(self):
1742 p = self.cls(BASE, 'dirB', 'fileB')
1743 self.assertTrue(p.exists())
1744 # An exception is raised when the last path component is an existing
1745 # regular file, regardless of whether exist_ok is true or not.
1746 with self.assertRaises(FileExistsError) as cm:
1747 p.mkdir(parents=True)
1748 self.assertEqual(cm.exception.errno, errno.EEXIST)
1749 with self.assertRaises(FileExistsError) as cm:
1750 p.mkdir(parents=True, exist_ok=True)
1751 self.assertEqual(cm.exception.errno, errno.EEXIST)
1752
1753 def test_mkdir_no_parents_file(self):
1754 p = self.cls(BASE, 'fileA')
1755 self.assertTrue(p.exists())
1756 # An exception is raised when the last path component is an existing
1757 # regular file, regardless of whether exist_ok is true or not.
1758 with self.assertRaises(FileExistsError) as cm:
1759 p.mkdir()
1760 self.assertEqual(cm.exception.errno, errno.EEXIST)
1761 with self.assertRaises(FileExistsError) as cm:
1762 p.mkdir(exist_ok=True)
1763 self.assertEqual(cm.exception.errno, errno.EEXIST)
1764
Antoine Pitrou31119e42013-11-22 17:38:12 +01001765 @with_symlinks
1766 def test_symlink_to(self):
1767 P = self.cls(BASE)
1768 target = P / 'fileA'
1769 # Symlinking a path target
1770 link = P / 'dirA' / 'linkAA'
1771 link.symlink_to(target)
1772 self.assertEqual(link.stat(), target.stat())
1773 self.assertNotEqual(link.lstat(), target.stat())
1774 # Symlinking a str target
1775 link = P / 'dirA' / 'linkAAA'
1776 link.symlink_to(str(target))
1777 self.assertEqual(link.stat(), target.stat())
1778 self.assertNotEqual(link.lstat(), target.stat())
1779 self.assertFalse(link.is_dir())
1780 # Symlinking to a directory
1781 target = P / 'dirB'
1782 link = P / 'dirA' / 'linkAAAA'
1783 link.symlink_to(target, target_is_directory=True)
1784 self.assertEqual(link.stat(), target.stat())
1785 self.assertNotEqual(link.lstat(), target.stat())
1786 self.assertTrue(link.is_dir())
1787 self.assertTrue(list(link.iterdir()))
1788
1789 def test_is_dir(self):
1790 P = self.cls(BASE)
1791 self.assertTrue((P / 'dirA').is_dir())
1792 self.assertFalse((P / 'fileA').is_dir())
1793 self.assertFalse((P / 'non-existing').is_dir())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001794 self.assertFalse((P / 'fileA' / 'bah').is_dir())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001795 if not symlink_skip_reason:
1796 self.assertFalse((P / 'linkA').is_dir())
1797 self.assertTrue((P / 'linkB').is_dir())
1798 self.assertFalse((P/ 'brokenLink').is_dir())
1799
1800 def test_is_file(self):
1801 P = self.cls(BASE)
1802 self.assertTrue((P / 'fileA').is_file())
1803 self.assertFalse((P / 'dirA').is_file())
1804 self.assertFalse((P / 'non-existing').is_file())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001805 self.assertFalse((P / 'fileA' / 'bah').is_file())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001806 if not symlink_skip_reason:
1807 self.assertTrue((P / 'linkA').is_file())
1808 self.assertFalse((P / 'linkB').is_file())
1809 self.assertFalse((P/ 'brokenLink').is_file())
1810
1811 def test_is_symlink(self):
1812 P = self.cls(BASE)
1813 self.assertFalse((P / 'fileA').is_symlink())
1814 self.assertFalse((P / 'dirA').is_symlink())
1815 self.assertFalse((P / 'non-existing').is_symlink())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001816 self.assertFalse((P / 'fileA' / 'bah').is_symlink())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001817 if not symlink_skip_reason:
1818 self.assertTrue((P / 'linkA').is_symlink())
1819 self.assertTrue((P / 'linkB').is_symlink())
1820 self.assertTrue((P/ 'brokenLink').is_symlink())
1821
1822 def test_is_fifo_false(self):
1823 P = self.cls(BASE)
1824 self.assertFalse((P / 'fileA').is_fifo())
1825 self.assertFalse((P / 'dirA').is_fifo())
1826 self.assertFalse((P / 'non-existing').is_fifo())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001827 self.assertFalse((P / 'fileA' / 'bah').is_fifo())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001828
1829 @unittest.skipUnless(hasattr(os, "mkfifo"), "os.mkfifo() required")
1830 def test_is_fifo_true(self):
1831 P = self.cls(BASE, 'myfifo')
1832 os.mkfifo(str(P))
1833 self.assertTrue(P.is_fifo())
1834 self.assertFalse(P.is_socket())
1835 self.assertFalse(P.is_file())
1836
1837 def test_is_socket_false(self):
1838 P = self.cls(BASE)
1839 self.assertFalse((P / 'fileA').is_socket())
1840 self.assertFalse((P / 'dirA').is_socket())
1841 self.assertFalse((P / 'non-existing').is_socket())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001842 self.assertFalse((P / 'fileA' / 'bah').is_socket())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001843
1844 @unittest.skipUnless(hasattr(socket, "AF_UNIX"), "Unix sockets required")
1845 def test_is_socket_true(self):
1846 P = self.cls(BASE, 'mysock')
Antoine Pitrou330ce592013-11-22 18:05:06 +01001847 sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
Antoine Pitrou31119e42013-11-22 17:38:12 +01001848 self.addCleanup(sock.close)
Antoine Pitrou330ce592013-11-22 18:05:06 +01001849 try:
1850 sock.bind(str(P))
1851 except OSError as e:
1852 if "AF_UNIX path too long" in str(e):
1853 self.skipTest("cannot bind Unix socket: " + str(e))
Antoine Pitrou31119e42013-11-22 17:38:12 +01001854 self.assertTrue(P.is_socket())
1855 self.assertFalse(P.is_fifo())
1856 self.assertFalse(P.is_file())
1857
1858 def test_is_block_device_false(self):
1859 P = self.cls(BASE)
1860 self.assertFalse((P / 'fileA').is_block_device())
1861 self.assertFalse((P / 'dirA').is_block_device())
1862 self.assertFalse((P / 'non-existing').is_block_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001863 self.assertFalse((P / 'fileA' / 'bah').is_block_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001864
1865 def test_is_char_device_false(self):
1866 P = self.cls(BASE)
1867 self.assertFalse((P / 'fileA').is_char_device())
1868 self.assertFalse((P / 'dirA').is_char_device())
1869 self.assertFalse((P / 'non-existing').is_char_device())
Antoine Pitrou2b2852b2014-10-30 23:14:03 +01001870 self.assertFalse((P / 'fileA' / 'bah').is_char_device())
Antoine Pitrou31119e42013-11-22 17:38:12 +01001871
1872 def test_is_char_device_true(self):
1873 # Under Unix, /dev/null should generally be a char device
1874 P = self.cls('/dev/null')
1875 if not P.exists():
1876 self.skipTest("/dev/null required")
1877 self.assertTrue(P.is_char_device())
1878 self.assertFalse(P.is_block_device())
1879 self.assertFalse(P.is_file())
1880
1881 def test_pickling_common(self):
1882 p = self.cls(BASE, 'fileA')
1883 for proto in range(0, pickle.HIGHEST_PROTOCOL + 1):
1884 dumped = pickle.dumps(p, proto)
1885 pp = pickle.loads(dumped)
1886 self.assertEqual(pp.stat(), p.stat())
1887
1888 def test_parts_interning(self):
1889 P = self.cls
1890 p = P('/usr/bin/foo')
1891 q = P('/usr/local/bin')
1892 # 'usr'
1893 self.assertIs(p.parts[1], q.parts[1])
1894 # 'bin'
1895 self.assertIs(p.parts[2], q.parts[3])
1896
Antoine Pitrouc274fd22013-12-16 19:57:41 +01001897 def _check_complex_symlinks(self, link0_target):
1898 # Test solving a non-looping chain of symlinks (issue #19887)
1899 P = self.cls(BASE)
1900 self.dirlink(os.path.join('link0', 'link0'), join('link1'))
1901 self.dirlink(os.path.join('link1', 'link1'), join('link2'))
1902 self.dirlink(os.path.join('link2', 'link2'), join('link3'))
1903 self.dirlink(link0_target, join('link0'))
1904
1905 # Resolve absolute paths
1906 p = (P / 'link0').resolve()
1907 self.assertEqual(p, P)
1908 self.assertEqual(str(p), BASE)
1909 p = (P / 'link1').resolve()
1910 self.assertEqual(p, P)
1911 self.assertEqual(str(p), BASE)
1912 p = (P / 'link2').resolve()
1913 self.assertEqual(p, P)
1914 self.assertEqual(str(p), BASE)
1915 p = (P / 'link3').resolve()
1916 self.assertEqual(p, P)
1917 self.assertEqual(str(p), BASE)
1918
1919 # Resolve relative paths
1920 old_path = os.getcwd()
1921 os.chdir(BASE)
1922 try:
1923 p = self.cls('link0').resolve()
1924 self.assertEqual(p, P)
1925 self.assertEqual(str(p), BASE)
1926 p = self.cls('link1').resolve()
1927 self.assertEqual(p, P)
1928 self.assertEqual(str(p), BASE)
1929 p = self.cls('link2').resolve()
1930 self.assertEqual(p, P)
1931 self.assertEqual(str(p), BASE)
1932 p = self.cls('link3').resolve()
1933 self.assertEqual(p, P)
1934 self.assertEqual(str(p), BASE)
1935 finally:
1936 os.chdir(old_path)
1937
1938 @with_symlinks
1939 def test_complex_symlinks_absolute(self):
1940 self._check_complex_symlinks(BASE)
1941
1942 @with_symlinks
1943 def test_complex_symlinks_relative(self):
1944 self._check_complex_symlinks('.')
1945
1946 @with_symlinks
1947 def test_complex_symlinks_relative_dot_dot(self):
1948 self._check_complex_symlinks(os.path.join('dirA', '..'))
1949
Antoine Pitrou31119e42013-11-22 17:38:12 +01001950
1951class PathTest(_BasePathTest, unittest.TestCase):
1952 cls = pathlib.Path
1953
1954 def test_concrete_class(self):
1955 p = self.cls('a')
1956 self.assertIs(type(p),
1957 pathlib.WindowsPath if os.name == 'nt' else pathlib.PosixPath)
1958
1959 def test_unsupported_flavour(self):
1960 if os.name == 'nt':
1961 self.assertRaises(NotImplementedError, pathlib.PosixPath)
1962 else:
1963 self.assertRaises(NotImplementedError, pathlib.WindowsPath)
1964
Berker Peksag4a208e42016-01-30 17:50:48 +02001965 def test_glob_empty_pattern(self):
1966 p = self.cls()
1967 with self.assertRaisesRegex(ValueError, 'Unacceptable pattern'):
1968 list(p.glob(''))
1969
Antoine Pitrou31119e42013-11-22 17:38:12 +01001970
1971@only_posix
1972class PosixPathTest(_BasePathTest, unittest.TestCase):
1973 cls = pathlib.PosixPath
1974
1975 def _check_symlink_loop(self, *args):
1976 path = self.cls(*args)
1977 with self.assertRaises(RuntimeError):
1978 print(path.resolve())
1979
1980 def test_open_mode(self):
1981 old_mask = os.umask(0)
1982 self.addCleanup(os.umask, old_mask)
1983 p = self.cls(BASE)
1984 with (p / 'new_file').open('wb'):
1985 pass
1986 st = os.stat(join('new_file'))
1987 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
1988 os.umask(0o022)
1989 with (p / 'other_new_file').open('wb'):
1990 pass
1991 st = os.stat(join('other_new_file'))
1992 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
1993
1994 def test_touch_mode(self):
1995 old_mask = os.umask(0)
1996 self.addCleanup(os.umask, old_mask)
1997 p = self.cls(BASE)
1998 (p / 'new_file').touch()
1999 st = os.stat(join('new_file'))
2000 self.assertEqual(stat.S_IMODE(st.st_mode), 0o666)
2001 os.umask(0o022)
2002 (p / 'other_new_file').touch()
2003 st = os.stat(join('other_new_file'))
2004 self.assertEqual(stat.S_IMODE(st.st_mode), 0o644)
2005 (p / 'masked_new_file').touch(mode=0o750)
2006 st = os.stat(join('masked_new_file'))
2007 self.assertEqual(stat.S_IMODE(st.st_mode), 0o750)
2008
2009 @with_symlinks
2010 def test_resolve_loop(self):
2011 # Loop detection for broken symlinks under POSIX
Antoine Pitrou31119e42013-11-22 17:38:12 +01002012 # Loops with relative symlinks
2013 os.symlink('linkX/inside', join('linkX'))
2014 self._check_symlink_loop(BASE, 'linkX')
2015 os.symlink('linkY', join('linkY'))
2016 self._check_symlink_loop(BASE, 'linkY')
2017 os.symlink('linkZ/../linkZ', join('linkZ'))
2018 self._check_symlink_loop(BASE, 'linkZ')
2019 # Loops with absolute symlinks
2020 os.symlink(join('linkU/inside'), join('linkU'))
2021 self._check_symlink_loop(BASE, 'linkU')
2022 os.symlink(join('linkV'), join('linkV'))
2023 self._check_symlink_loop(BASE, 'linkV')
2024 os.symlink(join('linkW/../linkW'), join('linkW'))
2025 self._check_symlink_loop(BASE, 'linkW')
2026
2027 def test_glob(self):
2028 P = self.cls
2029 p = P(BASE)
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002030 given = set(p.glob("FILEa"))
2031 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2032 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002033 self.assertEqual(set(p.glob("FILEa*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002034
2035 def test_rglob(self):
2036 P = self.cls
2037 p = P(BASE, "dirC")
Brett Cannonfe77f4e2013-11-22 16:14:10 -05002038 given = set(p.rglob("FILEd"))
2039 expect = set() if not support.fs_is_case_insensitive(BASE) else given
2040 self.assertEqual(given, expect)
Antoine Pitrou2dd38fb2013-11-22 22:26:01 +01002041 self.assertEqual(set(p.rglob("FILEd*")), set())
Antoine Pitrou31119e42013-11-22 17:38:12 +01002042
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002043 def test_expanduser(self):
2044 P = self.cls
2045 support.import_module('pwd')
2046 import pwd
2047 pwdent = pwd.getpwuid(os.getuid())
2048 username = pwdent.pw_name
Serhiy Storchakaa3fd0b22016-05-03 21:17:03 +03002049 userhome = pwdent.pw_dir.rstrip('/') or '/'
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002050 # find arbitrary different user (if exists)
2051 for pwdent in pwd.getpwall():
2052 othername = pwdent.pw_name
2053 otherhome = pwdent.pw_dir.rstrip('/')
Victor Stinnere9694392015-01-10 09:00:20 +01002054 if othername != username and otherhome:
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002055 break
2056
2057 p1 = P('~/Documents')
2058 p2 = P('~' + username + '/Documents')
2059 p3 = P('~' + othername + '/Documents')
2060 p4 = P('../~' + username + '/Documents')
2061 p5 = P('/~' + username + '/Documents')
2062 p6 = P('')
2063 p7 = P('~fakeuser/Documents')
2064
2065 with support.EnvironmentVarGuard() as env:
2066 env.pop('HOME', None)
2067
2068 self.assertEqual(p1.expanduser(), P(userhome) / 'Documents')
2069 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2070 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2071 self.assertEqual(p4.expanduser(), p4)
2072 self.assertEqual(p5.expanduser(), p5)
2073 self.assertEqual(p6.expanduser(), p6)
2074 self.assertRaises(RuntimeError, p7.expanduser)
2075
2076 env['HOME'] = '/tmp'
2077 self.assertEqual(p1.expanduser(), P('/tmp/Documents'))
2078 self.assertEqual(p2.expanduser(), P(userhome) / 'Documents')
2079 self.assertEqual(p3.expanduser(), P(otherhome) / 'Documents')
2080 self.assertEqual(p4.expanduser(), p4)
2081 self.assertEqual(p5.expanduser(), p5)
2082 self.assertEqual(p6.expanduser(), p6)
2083 self.assertRaises(RuntimeError, p7.expanduser)
2084
Antoine Pitrou31119e42013-11-22 17:38:12 +01002085
2086@only_nt
2087class WindowsPathTest(_BasePathTest, unittest.TestCase):
2088 cls = pathlib.WindowsPath
2089
2090 def test_glob(self):
2091 P = self.cls
2092 p = P(BASE)
2093 self.assertEqual(set(p.glob("FILEa")), { P(BASE, "fileA") })
2094
2095 def test_rglob(self):
2096 P = self.cls
2097 p = P(BASE, "dirC")
2098 self.assertEqual(set(p.rglob("FILEd")), { P(BASE, "dirC/dirD/fileD") })
2099
Antoine Pitrou8477ed62014-12-30 20:54:45 +01002100 def test_expanduser(self):
2101 P = self.cls
2102 with support.EnvironmentVarGuard() as env:
2103 env.pop('HOME', None)
2104 env.pop('USERPROFILE', None)
2105 env.pop('HOMEPATH', None)
2106 env.pop('HOMEDRIVE', None)
2107 env['USERNAME'] = 'alice'
2108
2109 # test that the path returns unchanged
2110 p1 = P('~/My Documents')
2111 p2 = P('~alice/My Documents')
2112 p3 = P('~bob/My Documents')
2113 p4 = P('/~/My Documents')
2114 p5 = P('d:~/My Documents')
2115 p6 = P('')
2116 self.assertRaises(RuntimeError, p1.expanduser)
2117 self.assertRaises(RuntimeError, p2.expanduser)
2118 self.assertRaises(RuntimeError, p3.expanduser)
2119 self.assertEqual(p4.expanduser(), p4)
2120 self.assertEqual(p5.expanduser(), p5)
2121 self.assertEqual(p6.expanduser(), p6)
2122
2123 def check():
2124 env.pop('USERNAME', None)
2125 self.assertEqual(p1.expanduser(),
2126 P('C:/Users/alice/My Documents'))
2127 self.assertRaises(KeyError, p2.expanduser)
2128 env['USERNAME'] = 'alice'
2129 self.assertEqual(p2.expanduser(),
2130 P('C:/Users/alice/My Documents'))
2131 self.assertEqual(p3.expanduser(),
2132 P('C:/Users/bob/My Documents'))
2133 self.assertEqual(p4.expanduser(), p4)
2134 self.assertEqual(p5.expanduser(), p5)
2135 self.assertEqual(p6.expanduser(), p6)
2136
2137 # test the first lookup key in the env vars
2138 env['HOME'] = 'C:\\Users\\alice'
2139 check()
2140
2141 # test that HOMEPATH is available instead
2142 env.pop('HOME', None)
2143 env['HOMEPATH'] = 'C:\\Users\\alice'
2144 check()
2145
2146 env['HOMEDRIVE'] = 'C:\\'
2147 env['HOMEPATH'] = 'Users\\alice'
2148 check()
2149
2150 env.pop('HOMEDRIVE', None)
2151 env.pop('HOMEPATH', None)
2152 env['USERPROFILE'] = 'C:\\Users\\alice'
2153 check()
2154
Antoine Pitrou31119e42013-11-22 17:38:12 +01002155
2156if __name__ == "__main__":
2157 unittest.main()